]> git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h
avcodec: Drop deprecated VIMA codecid
[ffmpeg] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
23
24 /**
25  * @file
26  * @ingroup libavc
27  * Libavcodec external API header
28  */
29
30 #include <errno.h>
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/log.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/rational.h"
42
43 #include "version.h"
44
45 /**
46  * @defgroup libavc libavcodec
47  * Encoding/Decoding Library
48  *
49  * @{
50  *
51  * @defgroup lavc_decoding Decoding
52  * @{
53  * @}
54  *
55  * @defgroup lavc_encoding Encoding
56  * @{
57  * @}
58  *
59  * @defgroup lavc_codec Codecs
60  * @{
61  * @defgroup lavc_codec_native Native Codecs
62  * @{
63  * @}
64  * @defgroup lavc_codec_wrappers External library wrappers
65  * @{
66  * @}
67  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
68  * @{
69  * @}
70  * @}
71  * @defgroup lavc_internal Internal
72  * @{
73  * @}
74  * @}
75  */
76
77 /**
78  * @ingroup libavc
79  * @defgroup lavc_encdec send/receive encoding and decoding API overview
80  * @{
81  *
82  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
83  * avcodec_receive_packet() functions provide an encode/decode API, which
84  * decouples input and output.
85  *
86  * The API is very similar for encoding/decoding and audio/video, and works as
87  * follows:
88  * - Set up and open the AVCodecContext as usual.
89  * - Send valid input:
90  *   - For decoding, call avcodec_send_packet() to give the decoder raw
91  *     compressed data in an AVPacket.
92  *   - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
93  *     containing uncompressed audio or video.
94  *   In both cases, it is recommended that AVPackets and AVFrames are
95  *   refcounted, or libavcodec might have to copy the input data. (libavformat
96  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
97  *   refcounted AVFrames.)
98  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
99  *   functions and process their output:
100  *   - For decoding, call avcodec_receive_frame(). On success, it will return
101  *     an AVFrame containing uncompressed audio or video data.
102  *   - For encoding, call avcodec_receive_packet(). On success, it will return
103  *     an AVPacket with a compressed frame.
104  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
105  *   AVERROR(EAGAIN) return value means that new input data is required to
106  *   return new output. In this case, continue with sending input. For each
107  *   input frame/packet, the codec will typically return 1 output frame/packet,
108  *   but it can also be 0 or more than 1.
109  *
110  * At the beginning of decoding or encoding, the codec might accept multiple
111  * input frames/packets without returning a frame, until its internal buffers
112  * are filled. This situation is handled transparently if you follow the steps
113  * outlined above.
114  *
115  * In theory, sending input can result in EAGAIN - this should happen only if
116  * not all output was received. You can use this to structure alternative decode
117  * or encode loops other than the one suggested above. For example, you could
118  * try sending new input on each iteration, and try to receive output if that
119  * returns EAGAIN.
120  *
121  * End of stream situations. These require "flushing" (aka draining) the codec,
122  * as the codec might buffer multiple frames or packets internally for
123  * performance or out of necessity (consider B-frames).
124  * This is handled as follows:
125  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
126  *   or avcodec_send_frame() (encoding) functions. This will enter draining
127  *   mode.
128  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
129  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
130  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
131  * - Before decoding can be resumed again, the codec has to be reset with
132  *   avcodec_flush_buffers().
133  *
134  * Using the API as outlined above is highly recommended. But it is also
135  * possible to call functions outside of this rigid schema. For example, you can
136  * call avcodec_send_packet() repeatedly without calling
137  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
138  * until the codec's internal buffer has been filled up (which is typically of
139  * size 1 per output frame, after initial input), and then reject input with
140  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
141  * read at least some output.
142  *
143  * Not all codecs will follow a rigid and predictable dataflow; the only
144  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
145  * one end implies that a receive/send call on the other end will succeed, or
146  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
147  * permit unlimited buffering of input or output.
148  *
149  * This API replaces the following legacy functions:
150  * - avcodec_decode_video2() and avcodec_decode_audio4():
151  *   Use avcodec_send_packet() to feed input to the decoder, then use
152  *   avcodec_receive_frame() to receive decoded frames after each packet.
153  *   Unlike with the old video decoding API, multiple frames might result from
154  *   a packet. For audio, splitting the input packet into frames by partially
155  *   decoding packets becomes transparent to the API user. You never need to
156  *   feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
157  *   no data was read from the packet).
158  *   Additionally, sending a flush/draining packet is required only once.
159  * - avcodec_encode_video2()/avcodec_encode_audio2():
160  *   Use avcodec_send_frame() to feed input to the encoder, then use
161  *   avcodec_receive_packet() to receive encoded packets.
162  *   Providing user-allocated buffers for avcodec_receive_packet() is not
163  *   possible.
164  * - The new API does not handle subtitles yet.
165  *
166  * Mixing new and old function calls on the same AVCodecContext is not allowed,
167  * and will result in undefined behavior.
168  *
169  * Some codecs might require using the new API; using the old API will return
170  * an error when calling it. All codecs support the new API.
171  *
172  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
173  * would be an invalid state, which could put the codec user into an endless
174  * loop. The API has no concept of time either: it cannot happen that trying to
175  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
176  * later accepts the packet (with no other receive/flush API calls involved).
177  * The API is a strict state machine, and the passage of time is not supposed
178  * to influence it. Some timing-dependent behavior might still be deemed
179  * acceptable in certain cases. But it must never result in both send/receive
180  * returning EAGAIN at the same time at any point. It must also absolutely be
181  * avoided that the current state is "unstable" and can "flip-flop" between
182  * the send/receive APIs allowing progress. For example, it's not allowed that
183  * the codec randomly decides that it actually wants to consume a packet now
184  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
185  * avcodec_send_packet() call.
186  * @}
187  */
188
189 /**
190  * @defgroup lavc_core Core functions/structures.
191  * @ingroup libavc
192  *
193  * Basic definitions, functions for querying libavcodec capabilities,
194  * allocating core structures, etc.
195  * @{
196  */
197
198
199 /**
200  * Identify the syntax and semantics of the bitstream.
201  * The principle is roughly:
202  * Two decoders with the same ID can decode the same streams.
203  * Two encoders with the same ID can encode compatible streams.
204  * There may be slight deviations from the principle due to implementation
205  * details.
206  *
207  * If you add a codec ID to this list, add it so that
208  * 1. no value of an existing codec ID changes (that would break ABI),
209  * 2. it is as close as possible to similar codecs
210  *
211  * After adding new codec IDs, do not forget to add an entry to the codec
212  * descriptor list and bump libavcodec minor version.
213  */
214 enum AVCodecID {
215     AV_CODEC_ID_NONE,
216
217     /* video codecs */
218     AV_CODEC_ID_MPEG1VIDEO,
219     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
220 #if FF_API_XVMC
221     AV_CODEC_ID_MPEG2VIDEO_XVMC,
222 #endif /* FF_API_XVMC */
223     AV_CODEC_ID_H261,
224     AV_CODEC_ID_H263,
225     AV_CODEC_ID_RV10,
226     AV_CODEC_ID_RV20,
227     AV_CODEC_ID_MJPEG,
228     AV_CODEC_ID_MJPEGB,
229     AV_CODEC_ID_LJPEG,
230     AV_CODEC_ID_SP5X,
231     AV_CODEC_ID_JPEGLS,
232     AV_CODEC_ID_MPEG4,
233     AV_CODEC_ID_RAWVIDEO,
234     AV_CODEC_ID_MSMPEG4V1,
235     AV_CODEC_ID_MSMPEG4V2,
236     AV_CODEC_ID_MSMPEG4V3,
237     AV_CODEC_ID_WMV1,
238     AV_CODEC_ID_WMV2,
239     AV_CODEC_ID_H263P,
240     AV_CODEC_ID_H263I,
241     AV_CODEC_ID_FLV1,
242     AV_CODEC_ID_SVQ1,
243     AV_CODEC_ID_SVQ3,
244     AV_CODEC_ID_DVVIDEO,
245     AV_CODEC_ID_HUFFYUV,
246     AV_CODEC_ID_CYUV,
247     AV_CODEC_ID_H264,
248     AV_CODEC_ID_INDEO3,
249     AV_CODEC_ID_VP3,
250     AV_CODEC_ID_THEORA,
251     AV_CODEC_ID_ASV1,
252     AV_CODEC_ID_ASV2,
253     AV_CODEC_ID_FFV1,
254     AV_CODEC_ID_4XM,
255     AV_CODEC_ID_VCR1,
256     AV_CODEC_ID_CLJR,
257     AV_CODEC_ID_MDEC,
258     AV_CODEC_ID_ROQ,
259     AV_CODEC_ID_INTERPLAY_VIDEO,
260     AV_CODEC_ID_XAN_WC3,
261     AV_CODEC_ID_XAN_WC4,
262     AV_CODEC_ID_RPZA,
263     AV_CODEC_ID_CINEPAK,
264     AV_CODEC_ID_WS_VQA,
265     AV_CODEC_ID_MSRLE,
266     AV_CODEC_ID_MSVIDEO1,
267     AV_CODEC_ID_IDCIN,
268     AV_CODEC_ID_8BPS,
269     AV_CODEC_ID_SMC,
270     AV_CODEC_ID_FLIC,
271     AV_CODEC_ID_TRUEMOTION1,
272     AV_CODEC_ID_VMDVIDEO,
273     AV_CODEC_ID_MSZH,
274     AV_CODEC_ID_ZLIB,
275     AV_CODEC_ID_QTRLE,
276     AV_CODEC_ID_TSCC,
277     AV_CODEC_ID_ULTI,
278     AV_CODEC_ID_QDRAW,
279     AV_CODEC_ID_VIXL,
280     AV_CODEC_ID_QPEG,
281     AV_CODEC_ID_PNG,
282     AV_CODEC_ID_PPM,
283     AV_CODEC_ID_PBM,
284     AV_CODEC_ID_PGM,
285     AV_CODEC_ID_PGMYUV,
286     AV_CODEC_ID_PAM,
287     AV_CODEC_ID_FFVHUFF,
288     AV_CODEC_ID_RV30,
289     AV_CODEC_ID_RV40,
290     AV_CODEC_ID_VC1,
291     AV_CODEC_ID_WMV3,
292     AV_CODEC_ID_LOCO,
293     AV_CODEC_ID_WNV1,
294     AV_CODEC_ID_AASC,
295     AV_CODEC_ID_INDEO2,
296     AV_CODEC_ID_FRAPS,
297     AV_CODEC_ID_TRUEMOTION2,
298     AV_CODEC_ID_BMP,
299     AV_CODEC_ID_CSCD,
300     AV_CODEC_ID_MMVIDEO,
301     AV_CODEC_ID_ZMBV,
302     AV_CODEC_ID_AVS,
303     AV_CODEC_ID_SMACKVIDEO,
304     AV_CODEC_ID_NUV,
305     AV_CODEC_ID_KMVC,
306     AV_CODEC_ID_FLASHSV,
307     AV_CODEC_ID_CAVS,
308     AV_CODEC_ID_JPEG2000,
309     AV_CODEC_ID_VMNC,
310     AV_CODEC_ID_VP5,
311     AV_CODEC_ID_VP6,
312     AV_CODEC_ID_VP6F,
313     AV_CODEC_ID_TARGA,
314     AV_CODEC_ID_DSICINVIDEO,
315     AV_CODEC_ID_TIERTEXSEQVIDEO,
316     AV_CODEC_ID_TIFF,
317     AV_CODEC_ID_GIF,
318     AV_CODEC_ID_DXA,
319     AV_CODEC_ID_DNXHD,
320     AV_CODEC_ID_THP,
321     AV_CODEC_ID_SGI,
322     AV_CODEC_ID_C93,
323     AV_CODEC_ID_BETHSOFTVID,
324     AV_CODEC_ID_PTX,
325     AV_CODEC_ID_TXD,
326     AV_CODEC_ID_VP6A,
327     AV_CODEC_ID_AMV,
328     AV_CODEC_ID_VB,
329     AV_CODEC_ID_PCX,
330     AV_CODEC_ID_SUNRAST,
331     AV_CODEC_ID_INDEO4,
332     AV_CODEC_ID_INDEO5,
333     AV_CODEC_ID_MIMIC,
334     AV_CODEC_ID_RL2,
335     AV_CODEC_ID_ESCAPE124,
336     AV_CODEC_ID_DIRAC,
337     AV_CODEC_ID_BFI,
338     AV_CODEC_ID_CMV,
339     AV_CODEC_ID_MOTIONPIXELS,
340     AV_CODEC_ID_TGV,
341     AV_CODEC_ID_TGQ,
342     AV_CODEC_ID_TQI,
343     AV_CODEC_ID_AURA,
344     AV_CODEC_ID_AURA2,
345     AV_CODEC_ID_V210X,
346     AV_CODEC_ID_TMV,
347     AV_CODEC_ID_V210,
348     AV_CODEC_ID_DPX,
349     AV_CODEC_ID_MAD,
350     AV_CODEC_ID_FRWU,
351     AV_CODEC_ID_FLASHSV2,
352     AV_CODEC_ID_CDGRAPHICS,
353     AV_CODEC_ID_R210,
354     AV_CODEC_ID_ANM,
355     AV_CODEC_ID_BINKVIDEO,
356     AV_CODEC_ID_IFF_ILBM,
357 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
358     AV_CODEC_ID_KGV1,
359     AV_CODEC_ID_YOP,
360     AV_CODEC_ID_VP8,
361     AV_CODEC_ID_PICTOR,
362     AV_CODEC_ID_ANSI,
363     AV_CODEC_ID_A64_MULTI,
364     AV_CODEC_ID_A64_MULTI5,
365     AV_CODEC_ID_R10K,
366     AV_CODEC_ID_MXPEG,
367     AV_CODEC_ID_LAGARITH,
368     AV_CODEC_ID_PRORES,
369     AV_CODEC_ID_JV,
370     AV_CODEC_ID_DFA,
371     AV_CODEC_ID_WMV3IMAGE,
372     AV_CODEC_ID_VC1IMAGE,
373     AV_CODEC_ID_UTVIDEO,
374     AV_CODEC_ID_BMV_VIDEO,
375     AV_CODEC_ID_VBLE,
376     AV_CODEC_ID_DXTORY,
377     AV_CODEC_ID_V410,
378     AV_CODEC_ID_XWD,
379     AV_CODEC_ID_CDXL,
380     AV_CODEC_ID_XBM,
381     AV_CODEC_ID_ZEROCODEC,
382     AV_CODEC_ID_MSS1,
383     AV_CODEC_ID_MSA1,
384     AV_CODEC_ID_TSCC2,
385     AV_CODEC_ID_MTS2,
386     AV_CODEC_ID_CLLC,
387     AV_CODEC_ID_MSS2,
388     AV_CODEC_ID_VP9,
389     AV_CODEC_ID_AIC,
390     AV_CODEC_ID_ESCAPE130,
391     AV_CODEC_ID_G2M,
392     AV_CODEC_ID_WEBP,
393     AV_CODEC_ID_HNM4_VIDEO,
394     AV_CODEC_ID_HEVC,
395 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
396     AV_CODEC_ID_FIC,
397     AV_CODEC_ID_ALIAS_PIX,
398     AV_CODEC_ID_BRENDER_PIX,
399     AV_CODEC_ID_PAF_VIDEO,
400     AV_CODEC_ID_EXR,
401     AV_CODEC_ID_VP7,
402     AV_CODEC_ID_SANM,
403     AV_CODEC_ID_SGIRLE,
404     AV_CODEC_ID_MVC1,
405     AV_CODEC_ID_MVC2,
406     AV_CODEC_ID_HQX,
407     AV_CODEC_ID_TDSC,
408     AV_CODEC_ID_HQ_HQA,
409     AV_CODEC_ID_HAP,
410     AV_CODEC_ID_DDS,
411     AV_CODEC_ID_DXV,
412     AV_CODEC_ID_SCREENPRESSO,
413     AV_CODEC_ID_RSCC,
414
415     AV_CODEC_ID_Y41P = 0x8000,
416     AV_CODEC_ID_AVRP,
417     AV_CODEC_ID_012V,
418     AV_CODEC_ID_AVUI,
419     AV_CODEC_ID_AYUV,
420     AV_CODEC_ID_TARGA_Y216,
421     AV_CODEC_ID_V308,
422     AV_CODEC_ID_V408,
423     AV_CODEC_ID_YUV4,
424     AV_CODEC_ID_AVRN,
425     AV_CODEC_ID_CPIA,
426     AV_CODEC_ID_XFACE,
427     AV_CODEC_ID_SNOW,
428     AV_CODEC_ID_SMVJPEG,
429     AV_CODEC_ID_APNG,
430     AV_CODEC_ID_DAALA,
431     AV_CODEC_ID_CFHD,
432     AV_CODEC_ID_TRUEMOTION2RT,
433     AV_CODEC_ID_M101,
434     AV_CODEC_ID_MAGICYUV,
435     AV_CODEC_ID_SHEERVIDEO,
436     AV_CODEC_ID_YLC,
437     AV_CODEC_ID_PSD,
438     AV_CODEC_ID_PIXLET,
439     AV_CODEC_ID_SPEEDHQ,
440     AV_CODEC_ID_FMVC,
441     AV_CODEC_ID_SCPR,
442     AV_CODEC_ID_CLEARVIDEO,
443     AV_CODEC_ID_XPM,
444     AV_CODEC_ID_AV1,
445     AV_CODEC_ID_BITPACKED,
446     AV_CODEC_ID_MSCC,
447     AV_CODEC_ID_SRGC,
448     AV_CODEC_ID_SVG,
449     AV_CODEC_ID_GDV,
450     AV_CODEC_ID_FITS,
451
452     /* various PCM "codecs" */
453     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
454     AV_CODEC_ID_PCM_S16LE = 0x10000,
455     AV_CODEC_ID_PCM_S16BE,
456     AV_CODEC_ID_PCM_U16LE,
457     AV_CODEC_ID_PCM_U16BE,
458     AV_CODEC_ID_PCM_S8,
459     AV_CODEC_ID_PCM_U8,
460     AV_CODEC_ID_PCM_MULAW,
461     AV_CODEC_ID_PCM_ALAW,
462     AV_CODEC_ID_PCM_S32LE,
463     AV_CODEC_ID_PCM_S32BE,
464     AV_CODEC_ID_PCM_U32LE,
465     AV_CODEC_ID_PCM_U32BE,
466     AV_CODEC_ID_PCM_S24LE,
467     AV_CODEC_ID_PCM_S24BE,
468     AV_CODEC_ID_PCM_U24LE,
469     AV_CODEC_ID_PCM_U24BE,
470     AV_CODEC_ID_PCM_S24DAUD,
471     AV_CODEC_ID_PCM_ZORK,
472     AV_CODEC_ID_PCM_S16LE_PLANAR,
473     AV_CODEC_ID_PCM_DVD,
474     AV_CODEC_ID_PCM_F32BE,
475     AV_CODEC_ID_PCM_F32LE,
476     AV_CODEC_ID_PCM_F64BE,
477     AV_CODEC_ID_PCM_F64LE,
478     AV_CODEC_ID_PCM_BLURAY,
479     AV_CODEC_ID_PCM_LXF,
480     AV_CODEC_ID_S302M,
481     AV_CODEC_ID_PCM_S8_PLANAR,
482     AV_CODEC_ID_PCM_S24LE_PLANAR,
483     AV_CODEC_ID_PCM_S32LE_PLANAR,
484     AV_CODEC_ID_PCM_S16BE_PLANAR,
485
486     AV_CODEC_ID_PCM_S64LE = 0x10800,
487     AV_CODEC_ID_PCM_S64BE,
488     AV_CODEC_ID_PCM_F16LE,
489     AV_CODEC_ID_PCM_F24LE,
490
491     /* various ADPCM codecs */
492     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
493     AV_CODEC_ID_ADPCM_IMA_WAV,
494     AV_CODEC_ID_ADPCM_IMA_DK3,
495     AV_CODEC_ID_ADPCM_IMA_DK4,
496     AV_CODEC_ID_ADPCM_IMA_WS,
497     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
498     AV_CODEC_ID_ADPCM_MS,
499     AV_CODEC_ID_ADPCM_4XM,
500     AV_CODEC_ID_ADPCM_XA,
501     AV_CODEC_ID_ADPCM_ADX,
502     AV_CODEC_ID_ADPCM_EA,
503     AV_CODEC_ID_ADPCM_G726,
504     AV_CODEC_ID_ADPCM_CT,
505     AV_CODEC_ID_ADPCM_SWF,
506     AV_CODEC_ID_ADPCM_YAMAHA,
507     AV_CODEC_ID_ADPCM_SBPRO_4,
508     AV_CODEC_ID_ADPCM_SBPRO_3,
509     AV_CODEC_ID_ADPCM_SBPRO_2,
510     AV_CODEC_ID_ADPCM_THP,
511     AV_CODEC_ID_ADPCM_IMA_AMV,
512     AV_CODEC_ID_ADPCM_EA_R1,
513     AV_CODEC_ID_ADPCM_EA_R3,
514     AV_CODEC_ID_ADPCM_EA_R2,
515     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
516     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
517     AV_CODEC_ID_ADPCM_EA_XAS,
518     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
519     AV_CODEC_ID_ADPCM_IMA_ISS,
520     AV_CODEC_ID_ADPCM_G722,
521     AV_CODEC_ID_ADPCM_IMA_APC,
522     AV_CODEC_ID_ADPCM_VIMA,
523
524     AV_CODEC_ID_ADPCM_AFC = 0x11800,
525     AV_CODEC_ID_ADPCM_IMA_OKI,
526     AV_CODEC_ID_ADPCM_DTK,
527     AV_CODEC_ID_ADPCM_IMA_RAD,
528     AV_CODEC_ID_ADPCM_G726LE,
529     AV_CODEC_ID_ADPCM_THP_LE,
530     AV_CODEC_ID_ADPCM_PSX,
531     AV_CODEC_ID_ADPCM_AICA,
532     AV_CODEC_ID_ADPCM_IMA_DAT4,
533     AV_CODEC_ID_ADPCM_MTAF,
534
535     /* AMR */
536     AV_CODEC_ID_AMR_NB = 0x12000,
537     AV_CODEC_ID_AMR_WB,
538
539     /* RealAudio codecs*/
540     AV_CODEC_ID_RA_144 = 0x13000,
541     AV_CODEC_ID_RA_288,
542
543     /* various DPCM codecs */
544     AV_CODEC_ID_ROQ_DPCM = 0x14000,
545     AV_CODEC_ID_INTERPLAY_DPCM,
546     AV_CODEC_ID_XAN_DPCM,
547     AV_CODEC_ID_SOL_DPCM,
548
549     AV_CODEC_ID_SDX2_DPCM = 0x14800,
550     AV_CODEC_ID_GREMLIN_DPCM,
551
552     /* audio codecs */
553     AV_CODEC_ID_MP2 = 0x15000,
554     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
555     AV_CODEC_ID_AAC,
556     AV_CODEC_ID_AC3,
557     AV_CODEC_ID_DTS,
558     AV_CODEC_ID_VORBIS,
559     AV_CODEC_ID_DVAUDIO,
560     AV_CODEC_ID_WMAV1,
561     AV_CODEC_ID_WMAV2,
562     AV_CODEC_ID_MACE3,
563     AV_CODEC_ID_MACE6,
564     AV_CODEC_ID_VMDAUDIO,
565     AV_CODEC_ID_FLAC,
566     AV_CODEC_ID_MP3ADU,
567     AV_CODEC_ID_MP3ON4,
568     AV_CODEC_ID_SHORTEN,
569     AV_CODEC_ID_ALAC,
570     AV_CODEC_ID_WESTWOOD_SND1,
571     AV_CODEC_ID_GSM, ///< as in Berlin toast format
572     AV_CODEC_ID_QDM2,
573     AV_CODEC_ID_COOK,
574     AV_CODEC_ID_TRUESPEECH,
575     AV_CODEC_ID_TTA,
576     AV_CODEC_ID_SMACKAUDIO,
577     AV_CODEC_ID_QCELP,
578     AV_CODEC_ID_WAVPACK,
579     AV_CODEC_ID_DSICINAUDIO,
580     AV_CODEC_ID_IMC,
581     AV_CODEC_ID_MUSEPACK7,
582     AV_CODEC_ID_MLP,
583     AV_CODEC_ID_GSM_MS, /* as found in WAV */
584     AV_CODEC_ID_ATRAC3,
585 #if FF_API_VOXWARE
586     AV_CODEC_ID_VOXWARE,
587 #endif
588     AV_CODEC_ID_APE,
589     AV_CODEC_ID_NELLYMOSER,
590     AV_CODEC_ID_MUSEPACK8,
591     AV_CODEC_ID_SPEEX,
592     AV_CODEC_ID_WMAVOICE,
593     AV_CODEC_ID_WMAPRO,
594     AV_CODEC_ID_WMALOSSLESS,
595     AV_CODEC_ID_ATRAC3P,
596     AV_CODEC_ID_EAC3,
597     AV_CODEC_ID_SIPR,
598     AV_CODEC_ID_MP1,
599     AV_CODEC_ID_TWINVQ,
600     AV_CODEC_ID_TRUEHD,
601     AV_CODEC_ID_MP4ALS,
602     AV_CODEC_ID_ATRAC1,
603     AV_CODEC_ID_BINKAUDIO_RDFT,
604     AV_CODEC_ID_BINKAUDIO_DCT,
605     AV_CODEC_ID_AAC_LATM,
606     AV_CODEC_ID_QDMC,
607     AV_CODEC_ID_CELT,
608     AV_CODEC_ID_G723_1,
609     AV_CODEC_ID_G729,
610     AV_CODEC_ID_8SVX_EXP,
611     AV_CODEC_ID_8SVX_FIB,
612     AV_CODEC_ID_BMV_AUDIO,
613     AV_CODEC_ID_RALF,
614     AV_CODEC_ID_IAC,
615     AV_CODEC_ID_ILBC,
616     AV_CODEC_ID_OPUS,
617     AV_CODEC_ID_COMFORT_NOISE,
618     AV_CODEC_ID_TAK,
619     AV_CODEC_ID_METASOUND,
620     AV_CODEC_ID_PAF_AUDIO,
621     AV_CODEC_ID_ON2AVC,
622     AV_CODEC_ID_DSS_SP,
623
624     AV_CODEC_ID_FFWAVESYNTH = 0x15800,
625     AV_CODEC_ID_SONIC,
626     AV_CODEC_ID_SONIC_LS,
627     AV_CODEC_ID_EVRC,
628     AV_CODEC_ID_SMV,
629     AV_CODEC_ID_DSD_LSBF,
630     AV_CODEC_ID_DSD_MSBF,
631     AV_CODEC_ID_DSD_LSBF_PLANAR,
632     AV_CODEC_ID_DSD_MSBF_PLANAR,
633     AV_CODEC_ID_4GV,
634     AV_CODEC_ID_INTERPLAY_ACM,
635     AV_CODEC_ID_XMA1,
636     AV_CODEC_ID_XMA2,
637     AV_CODEC_ID_DST,
638     AV_CODEC_ID_ATRAC3AL,
639     AV_CODEC_ID_ATRAC3PAL,
640     AV_CODEC_ID_DOLBY_E,
641
642     /* subtitle codecs */
643     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
644     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
645     AV_CODEC_ID_DVB_SUBTITLE,
646     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
647     AV_CODEC_ID_XSUB,
648     AV_CODEC_ID_SSA,
649     AV_CODEC_ID_MOV_TEXT,
650     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
651     AV_CODEC_ID_DVB_TELETEXT,
652     AV_CODEC_ID_SRT,
653
654     AV_CODEC_ID_MICRODVD   = 0x17800,
655     AV_CODEC_ID_EIA_608,
656     AV_CODEC_ID_JACOSUB,
657     AV_CODEC_ID_SAMI,
658     AV_CODEC_ID_REALTEXT,
659     AV_CODEC_ID_STL,
660     AV_CODEC_ID_SUBVIEWER1,
661     AV_CODEC_ID_SUBVIEWER,
662     AV_CODEC_ID_SUBRIP,
663     AV_CODEC_ID_WEBVTT,
664     AV_CODEC_ID_MPL2,
665     AV_CODEC_ID_VPLAYER,
666     AV_CODEC_ID_PJS,
667     AV_CODEC_ID_ASS,
668     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
669
670     /* other specific kind of codecs (generally used for attachments) */
671     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
672     AV_CODEC_ID_TTF = 0x18000,
673
674     AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
675     AV_CODEC_ID_BINTEXT    = 0x18800,
676     AV_CODEC_ID_XBIN,
677     AV_CODEC_ID_IDF,
678     AV_CODEC_ID_OTF,
679     AV_CODEC_ID_SMPTE_KLV,
680     AV_CODEC_ID_DVD_NAV,
681     AV_CODEC_ID_TIMED_ID3,
682     AV_CODEC_ID_BIN_DATA,
683
684
685     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
686
687     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
688                                 * stream (only used by libavformat) */
689     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
690                                 * stream (only used by libavformat) */
691     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
692     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
693 };
694
695 /**
696  * This struct describes the properties of a single codec described by an
697  * AVCodecID.
698  * @see avcodec_descriptor_get()
699  */
700 typedef struct AVCodecDescriptor {
701     enum AVCodecID     id;
702     enum AVMediaType type;
703     /**
704      * Name of the codec described by this descriptor. It is non-empty and
705      * unique for each codec descriptor. It should contain alphanumeric
706      * characters and '_' only.
707      */
708     const char      *name;
709     /**
710      * A more descriptive name for this codec. May be NULL.
711      */
712     const char *long_name;
713     /**
714      * Codec properties, a combination of AV_CODEC_PROP_* flags.
715      */
716     int             props;
717     /**
718      * MIME type(s) associated with the codec.
719      * May be NULL; if not, a NULL-terminated array of MIME types.
720      * The first item is always non-NULL and is the preferred MIME type.
721      */
722     const char *const *mime_types;
723     /**
724      * If non-NULL, an array of profiles recognized for this codec.
725      * Terminated with FF_PROFILE_UNKNOWN.
726      */
727     const struct AVProfile *profiles;
728 } AVCodecDescriptor;
729
730 /**
731  * Codec uses only intra compression.
732  * Video and audio codecs only.
733  */
734 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
735 /**
736  * Codec supports lossy compression. Audio and video codecs only.
737  * @note a codec may support both lossy and lossless
738  * compression modes
739  */
740 #define AV_CODEC_PROP_LOSSY         (1 << 1)
741 /**
742  * Codec supports lossless compression. Audio and video codecs only.
743  */
744 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
745 /**
746  * Codec supports frame reordering. That is, the coded order (the order in which
747  * the encoded packets are output by the encoders / stored / input to the
748  * decoders) may be different from the presentation order of the corresponding
749  * frames.
750  *
751  * For codecs that do not have this property set, PTS and DTS should always be
752  * equal.
753  */
754 #define AV_CODEC_PROP_REORDER       (1 << 3)
755 /**
756  * Subtitle codec is bitmap based
757  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
758  */
759 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
760 /**
761  * Subtitle codec is text based.
762  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
763  */
764 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
765
766 /**
767  * @ingroup lavc_decoding
768  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
769  * This is mainly needed because some optimized bitstream readers read
770  * 32 or 64 bit at once and could read over the end.<br>
771  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
772  * MPEG bitstreams could cause overread and segfault.
773  */
774 #define AV_INPUT_BUFFER_PADDING_SIZE 32
775
776 /**
777  * @ingroup lavc_encoding
778  * minimum encoding buffer size
779  * Used to avoid some checks during header writing.
780  */
781 #define AV_INPUT_BUFFER_MIN_SIZE 16384
782
783 #if FF_API_WITHOUT_PREFIX
784 /**
785  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
786  */
787 #define FF_INPUT_BUFFER_PADDING_SIZE 32
788
789 /**
790  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
791  */
792 #define FF_MIN_BUFFER_SIZE 16384
793 #endif /* FF_API_WITHOUT_PREFIX */
794
795 /**
796  * @ingroup lavc_encoding
797  * motion estimation type.
798  * @deprecated use codec private option instead
799  */
800 #if FF_API_MOTION_EST
801 enum Motion_Est_ID {
802     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
803     ME_FULL,
804     ME_LOG,
805     ME_PHODS,
806     ME_EPZS,        ///< enhanced predictive zonal search
807     ME_X1,          ///< reserved for experiments
808     ME_HEX,         ///< hexagon based search
809     ME_UMH,         ///< uneven multi-hexagon search
810     ME_TESA,        ///< transformed exhaustive search algorithm
811     ME_ITER=50,     ///< iterative search
812 };
813 #endif
814
815 /**
816  * @ingroup lavc_decoding
817  */
818 enum AVDiscard{
819     /* We leave some space between them for extensions (drop some
820      * keyframes for intra-only or drop just some bidir frames). */
821     AVDISCARD_NONE    =-16, ///< discard nothing
822     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
823     AVDISCARD_NONREF  =  8, ///< discard all non reference
824     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
825     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
826     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
827     AVDISCARD_ALL     = 48, ///< discard all
828 };
829
830 enum AVAudioServiceType {
831     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
832     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
833     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
834     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
835     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
836     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
837     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
838     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
839     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
840     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
841 };
842
843 /**
844  * @ingroup lavc_encoding
845  */
846 typedef struct RcOverride{
847     int start_frame;
848     int end_frame;
849     int qscale; // If this is 0 then quality_factor will be used instead.
850     float quality_factor;
851 } RcOverride;
852
853 #if FF_API_MAX_BFRAMES
854 /**
855  * @deprecated there is no libavcodec-wide limit on the number of B-frames
856  */
857 #define FF_MAX_B_FRAMES 16
858 #endif
859
860 /* encoding support
861    These flags can be passed in AVCodecContext.flags before initialization.
862    Note: Not everything is supported yet.
863 */
864
865 /**
866  * Allow decoders to produce frames with data planes that are not aligned
867  * to CPU requirements (e.g. due to cropping).
868  */
869 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
870 /**
871  * Use fixed qscale.
872  */
873 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
874 /**
875  * 4 MV per MB allowed / advanced prediction for H.263.
876  */
877 #define AV_CODEC_FLAG_4MV             (1 <<  2)
878 /**
879  * Output even those frames that might be corrupted.
880  */
881 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
882 /**
883  * Use qpel MC.
884  */
885 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
886 /**
887  * Use internal 2pass ratecontrol in first pass mode.
888  */
889 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
890 /**
891  * Use internal 2pass ratecontrol in second pass mode.
892  */
893 #define AV_CODEC_FLAG_PASS2           (1 << 10)
894 /**
895  * loop filter.
896  */
897 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
898 /**
899  * Only decode/encode grayscale.
900  */
901 #define AV_CODEC_FLAG_GRAY            (1 << 13)
902 /**
903  * error[?] variables will be set during encoding.
904  */
905 #define AV_CODEC_FLAG_PSNR            (1 << 15)
906 /**
907  * Input bitstream might be truncated at a random location
908  * instead of only at frame boundaries.
909  */
910 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
911 /**
912  * Use interlaced DCT.
913  */
914 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
915 /**
916  * Force low delay.
917  */
918 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
919 /**
920  * Place global headers in extradata instead of every keyframe.
921  */
922 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
923 /**
924  * Use only bitexact stuff (except (I)DCT).
925  */
926 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
927 /* Fx : Flag for H.263+ extra options */
928 /**
929  * H.263 advanced intra coding / MPEG-4 AC prediction
930  */
931 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
932 /**
933  * interlaced motion estimation
934  */
935 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
936 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
937
938 /**
939  * Allow non spec compliant speedup tricks.
940  */
941 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
942 /**
943  * Skip bitstream encoding.
944  */
945 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
946 /**
947  * Place global headers at every keyframe instead of in extradata.
948  */
949 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
950
951 /**
952  * timecode is in drop frame format. DEPRECATED!!!!
953  */
954 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
955
956 /**
957  * Input bitstream might be truncated at a packet boundaries
958  * instead of only at frame boundaries.
959  */
960 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
961 /**
962  * Discard cropping information from SPS.
963  */
964 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
965
966 /**
967  * Show all frames before the first keyframe
968  */
969 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
970 /**
971  * Export motion vectors through frame side data
972  */
973 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
974 /**
975  * Do not skip samples and export skip information as frame side data
976  */
977 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
978 /**
979  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
980  */
981 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
982
983 /* Unsupported options :
984  *              Syntax Arithmetic coding (SAC)
985  *              Reference Picture Selection
986  *              Independent Segment Decoding */
987 /* /Fx */
988 /* codec capabilities */
989
990 /**
991  * Decoder can use draw_horiz_band callback.
992  */
993 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
994 /**
995  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
996  * If not set, it might not use get_buffer() at all or use operations that
997  * assume the buffer was allocated by avcodec_default_get_buffer.
998  */
999 #define AV_CODEC_CAP_DR1                 (1 <<  1)
1000 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
1001 /**
1002  * Encoder or decoder requires flushing with NULL input at the end in order to
1003  * give the complete and correct output.
1004  *
1005  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1006  *       with NULL data. The user can still send NULL data to the public encode
1007  *       or decode function, but libavcodec will not pass it along to the codec
1008  *       unless this flag is set.
1009  *
1010  * Decoders:
1011  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1012  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1013  * returns frames.
1014  *
1015  * Encoders:
1016  * The encoder needs to be fed with NULL data at the end of encoding until the
1017  * encoder no longer returns data.
1018  *
1019  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1020  *       flag also means that the encoder must set the pts and duration for
1021  *       each output packet. If this flag is not set, the pts and duration will
1022  *       be determined by libavcodec from the input frame.
1023  */
1024 #define AV_CODEC_CAP_DELAY               (1 <<  5)
1025 /**
1026  * Codec can be fed a final frame with a smaller size.
1027  * This can be used to prevent truncation of the last audio samples.
1028  */
1029 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
1030
1031 /**
1032  * Codec can output multiple frames per AVPacket
1033  * Normally demuxers return one frame at a time, demuxers which do not do
1034  * are connected to a parser to split what they return into proper frames.
1035  * This flag is reserved to the very rare category of codecs which have a
1036  * bitstream that cannot be split into frames without timeconsuming
1037  * operations like full decoding. Demuxers carrying such bitstreams thus
1038  * may return multiple frames in a packet. This has many disadvantages like
1039  * prohibiting stream copy in many cases thus it should only be considered
1040  * as a last resort.
1041  */
1042 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1043 /**
1044  * Codec is experimental and is thus avoided in favor of non experimental
1045  * encoders
1046  */
1047 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1048 /**
1049  * Codec should fill in channel configuration and samplerate instead of container
1050  */
1051 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1052 /**
1053  * Codec supports frame-level multithreading.
1054  */
1055 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1056 /**
1057  * Codec supports slice-based (or partition-based) multithreading.
1058  */
1059 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1060 /**
1061  * Codec supports changed parameters at any point.
1062  */
1063 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1064 /**
1065  * Codec supports avctx->thread_count == 0 (auto).
1066  */
1067 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1068 /**
1069  * Audio encoder supports receiving a different number of samples in each call.
1070  */
1071 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1072 /**
1073  * Decoder is not a preferred choice for probing.
1074  * This indicates that the decoder is not a good choice for probing.
1075  * It could for example be an expensive to spin up hardware decoder,
1076  * or it could simply not provide a lot of useful information about
1077  * the stream.
1078  * A decoder marked with this flag should only be used as last resort
1079  * choice for probing.
1080  */
1081 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
1082 /**
1083  * Codec is intra only.
1084  */
1085 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1086 /**
1087  * Codec is lossless.
1088  */
1089 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1090
1091
1092 #if FF_API_WITHOUT_PREFIX
1093 /**
1094  * Allow decoders to produce frames with data planes that are not aligned
1095  * to CPU requirements (e.g. due to cropping).
1096  */
1097 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1098 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1099 #define CODEC_FLAG_4MV    AV_CODEC_FLAG_4MV
1100 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1101 #define CODEC_FLAG_QPEL   AV_CODEC_FLAG_QPEL
1102 #if FF_API_GMC
1103 /**
1104  * @deprecated use the "gmc" private option of the libxvid encoder
1105  */
1106 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
1107 #endif
1108 #if FF_API_MV0
1109 /**
1110  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1111  * mpegvideo encoders
1112  */
1113 #define CODEC_FLAG_MV0    0x0040
1114 #endif
1115 #if FF_API_INPUT_PRESERVED
1116 /**
1117  * @deprecated passing reference-counted frames to the encoders replaces this
1118  * flag
1119  */
1120 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1121 #endif
1122 #define CODEC_FLAG_PASS1           AV_CODEC_FLAG_PASS1
1123 #define CODEC_FLAG_PASS2           AV_CODEC_FLAG_PASS2
1124 #define CODEC_FLAG_GRAY            AV_CODEC_FLAG_GRAY
1125 #if FF_API_EMU_EDGE
1126 /**
1127  * @deprecated edges are not used/required anymore. I.e. this flag is now always
1128  * set.
1129  */
1130 #define CODEC_FLAG_EMU_EDGE        0x4000
1131 #endif
1132 #define CODEC_FLAG_PSNR            AV_CODEC_FLAG_PSNR
1133 #define CODEC_FLAG_TRUNCATED       AV_CODEC_FLAG_TRUNCATED
1134
1135 #if FF_API_NORMALIZE_AQP
1136 /**
1137  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1138  * mpegvideo encoders
1139  */
1140 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
1141 #endif
1142 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1143 #define CODEC_FLAG_LOW_DELAY      AV_CODEC_FLAG_LOW_DELAY
1144 #define CODEC_FLAG_GLOBAL_HEADER  AV_CODEC_FLAG_GLOBAL_HEADER
1145 #define CODEC_FLAG_BITEXACT       AV_CODEC_FLAG_BITEXACT
1146 #define CODEC_FLAG_AC_PRED        AV_CODEC_FLAG_AC_PRED
1147 #define CODEC_FLAG_LOOP_FILTER    AV_CODEC_FLAG_LOOP_FILTER
1148 #define CODEC_FLAG_INTERLACED_ME  AV_CODEC_FLAG_INTERLACED_ME
1149 #define CODEC_FLAG_CLOSED_GOP     AV_CODEC_FLAG_CLOSED_GOP
1150 #define CODEC_FLAG2_FAST          AV_CODEC_FLAG2_FAST
1151 #define CODEC_FLAG2_NO_OUTPUT     AV_CODEC_FLAG2_NO_OUTPUT
1152 #define CODEC_FLAG2_LOCAL_HEADER  AV_CODEC_FLAG2_LOCAL_HEADER
1153 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1154 #define CODEC_FLAG2_IGNORE_CROP   AV_CODEC_FLAG2_IGNORE_CROP
1155
1156 #define CODEC_FLAG2_CHUNKS        AV_CODEC_FLAG2_CHUNKS
1157 #define CODEC_FLAG2_SHOW_ALL      AV_CODEC_FLAG2_SHOW_ALL
1158 #define CODEC_FLAG2_EXPORT_MVS    AV_CODEC_FLAG2_EXPORT_MVS
1159 #define CODEC_FLAG2_SKIP_MANUAL   AV_CODEC_FLAG2_SKIP_MANUAL
1160
1161 /* Unsupported options :
1162  *              Syntax Arithmetic coding (SAC)
1163  *              Reference Picture Selection
1164  *              Independent Segment Decoding */
1165 /* /Fx */
1166 /* codec capabilities */
1167
1168 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1169 /**
1170  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1171  * If not set, it might not use get_buffer() at all or use operations that
1172  * assume the buffer was allocated by avcodec_default_get_buffer.
1173  */
1174 #define CODEC_CAP_DR1             AV_CODEC_CAP_DR1
1175 #define CODEC_CAP_TRUNCATED       AV_CODEC_CAP_TRUNCATED
1176 #if FF_API_XVMC
1177 /* Codec can export data for HW decoding. This flag indicates that
1178  * the codec would call get_format() with list that might contain HW accelerated
1179  * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1180  * including raw image format.
1181  * The application can use the passed context to determine bitstream version,
1182  * chroma format, resolution etc.
1183  */
1184 #define CODEC_CAP_HWACCEL         0x0010
1185 #endif /* FF_API_XVMC */
1186 /**
1187  * Encoder or decoder requires flushing with NULL input at the end in order to
1188  * give the complete and correct output.
1189  *
1190  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1191  *       with NULL data. The user can still send NULL data to the public encode
1192  *       or decode function, but libavcodec will not pass it along to the codec
1193  *       unless this flag is set.
1194  *
1195  * Decoders:
1196  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1197  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1198  * returns frames.
1199  *
1200  * Encoders:
1201  * The encoder needs to be fed with NULL data at the end of encoding until the
1202  * encoder no longer returns data.
1203  *
1204  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1205  *       flag also means that the encoder must set the pts and duration for
1206  *       each output packet. If this flag is not set, the pts and duration will
1207  *       be determined by libavcodec from the input frame.
1208  */
1209 #define CODEC_CAP_DELAY           AV_CODEC_CAP_DELAY
1210 /**
1211  * Codec can be fed a final frame with a smaller size.
1212  * This can be used to prevent truncation of the last audio samples.
1213  */
1214 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1215
1216 /**
1217  * Codec can output multiple frames per AVPacket
1218  * Normally demuxers return one frame at a time, demuxers which do not do
1219  * are connected to a parser to split what they return into proper frames.
1220  * This flag is reserved to the very rare category of codecs which have a
1221  * bitstream that cannot be split into frames without timeconsuming
1222  * operations like full decoding. Demuxers carrying such bitstreams thus
1223  * may return multiple frames in a packet. This has many disadvantages like
1224  * prohibiting stream copy in many cases thus it should only be considered
1225  * as a last resort.
1226  */
1227 #define CODEC_CAP_SUBFRAMES        AV_CODEC_CAP_SUBFRAMES
1228 /**
1229  * Codec is experimental and is thus avoided in favor of non experimental
1230  * encoders
1231  */
1232 #define CODEC_CAP_EXPERIMENTAL     AV_CODEC_CAP_EXPERIMENTAL
1233 /**
1234  * Codec should fill in channel configuration and samplerate instead of container
1235  */
1236 #define CODEC_CAP_CHANNEL_CONF     AV_CODEC_CAP_CHANNEL_CONF
1237 #if FF_API_NEG_LINESIZES
1238 /**
1239  * @deprecated no codecs use this capability
1240  */
1241 #define CODEC_CAP_NEG_LINESIZES    0x0800
1242 #endif
1243 /**
1244  * Codec supports frame-level multithreading.
1245  */
1246 #define CODEC_CAP_FRAME_THREADS    AV_CODEC_CAP_FRAME_THREADS
1247 /**
1248  * Codec supports slice-based (or partition-based) multithreading.
1249  */
1250 #define CODEC_CAP_SLICE_THREADS    AV_CODEC_CAP_SLICE_THREADS
1251 /**
1252  * Codec supports changed parameters at any point.
1253  */
1254 #define CODEC_CAP_PARAM_CHANGE     AV_CODEC_CAP_PARAM_CHANGE
1255 /**
1256  * Codec supports avctx->thread_count == 0 (auto).
1257  */
1258 #define CODEC_CAP_AUTO_THREADS     AV_CODEC_CAP_AUTO_THREADS
1259 /**
1260  * Audio encoder supports receiving a different number of samples in each call.
1261  */
1262 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1263 /**
1264  * Codec is intra only.
1265  */
1266 #define CODEC_CAP_INTRA_ONLY       AV_CODEC_CAP_INTRA_ONLY
1267 /**
1268  * Codec is lossless.
1269  */
1270 #define CODEC_CAP_LOSSLESS         AV_CODEC_CAP_LOSSLESS
1271
1272 /**
1273  * HWAccel is experimental and is thus avoided in favor of non experimental
1274  * codecs
1275  */
1276 #define HWACCEL_CODEC_CAP_EXPERIMENTAL     0x0200
1277 #endif /* FF_API_WITHOUT_PREFIX */
1278
1279 #if FF_API_MB_TYPE
1280 //The following defines may change, don't expect compatibility if you use them.
1281 #define MB_TYPE_INTRA4x4   0x0001
1282 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1283 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1284 #define MB_TYPE_16x16      0x0008
1285 #define MB_TYPE_16x8       0x0010
1286 #define MB_TYPE_8x16       0x0020
1287 #define MB_TYPE_8x8        0x0040
1288 #define MB_TYPE_INTERLACED 0x0080
1289 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1290 #define MB_TYPE_ACPRED     0x0200
1291 #define MB_TYPE_GMC        0x0400
1292 #define MB_TYPE_SKIP       0x0800
1293 #define MB_TYPE_P0L0       0x1000
1294 #define MB_TYPE_P1L0       0x2000
1295 #define MB_TYPE_P0L1       0x4000
1296 #define MB_TYPE_P1L1       0x8000
1297 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1298 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1299 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1300 #define MB_TYPE_QUANT      0x00010000
1301 #define MB_TYPE_CBP        0x00020000
1302 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1303 #endif
1304
1305 /**
1306  * Pan Scan area.
1307  * This specifies the area which should be displayed.
1308  * Note there may be multiple such areas for one frame.
1309  */
1310 typedef struct AVPanScan{
1311     /**
1312      * id
1313      * - encoding: Set by user.
1314      * - decoding: Set by libavcodec.
1315      */
1316     int id;
1317
1318     /**
1319      * width and height in 1/16 pel
1320      * - encoding: Set by user.
1321      * - decoding: Set by libavcodec.
1322      */
1323     int width;
1324     int height;
1325
1326     /**
1327      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1328      * - encoding: Set by user.
1329      * - decoding: Set by libavcodec.
1330      */
1331     int16_t position[3][2];
1332 }AVPanScan;
1333
1334 /**
1335  * This structure describes the bitrate properties of an encoded bitstream. It
1336  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1337  * parameters for H.264/HEVC.
1338  */
1339 typedef struct AVCPBProperties {
1340     /**
1341      * Maximum bitrate of the stream, in bits per second.
1342      * Zero if unknown or unspecified.
1343      */
1344     int max_bitrate;
1345     /**
1346      * Minimum bitrate of the stream, in bits per second.
1347      * Zero if unknown or unspecified.
1348      */
1349     int min_bitrate;
1350     /**
1351      * Average bitrate of the stream, in bits per second.
1352      * Zero if unknown or unspecified.
1353      */
1354     int avg_bitrate;
1355
1356     /**
1357      * The size of the buffer to which the ratecontrol is applied, in bits.
1358      * Zero if unknown or unspecified.
1359      */
1360     int buffer_size;
1361
1362     /**
1363      * The delay between the time the packet this structure is associated with
1364      * is received and the time when it should be decoded, in periods of a 27MHz
1365      * clock.
1366      *
1367      * UINT64_MAX when unknown or unspecified.
1368      */
1369     uint64_t vbv_delay;
1370 } AVCPBProperties;
1371
1372 #if FF_API_QSCALE_TYPE
1373 #define FF_QSCALE_TYPE_MPEG1 0
1374 #define FF_QSCALE_TYPE_MPEG2 1
1375 #define FF_QSCALE_TYPE_H264  2
1376 #define FF_QSCALE_TYPE_VP56  3
1377 #endif
1378
1379 /**
1380  * The decoder will keep a reference to the frame and may reuse it later.
1381  */
1382 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1383
1384 /**
1385  * @defgroup lavc_packet AVPacket
1386  *
1387  * Types and functions for working with AVPacket.
1388  * @{
1389  */
1390 enum AVPacketSideDataType {
1391     /**
1392      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1393      * bytes worth of palette. This side data signals that a new palette is
1394      * present.
1395      */
1396     AV_PKT_DATA_PALETTE,
1397
1398     /**
1399      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1400      * that the extradata buffer was changed and the receiving side should
1401      * act upon it appropriately. The new extradata is embedded in the side
1402      * data buffer and should be immediately used for processing the current
1403      * frame or packet.
1404      */
1405     AV_PKT_DATA_NEW_EXTRADATA,
1406
1407     /**
1408      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1409      * @code
1410      * u32le param_flags
1411      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1412      *     s32le channel_count
1413      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1414      *     u64le channel_layout
1415      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1416      *     s32le sample_rate
1417      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1418      *     s32le width
1419      *     s32le height
1420      * @endcode
1421      */
1422     AV_PKT_DATA_PARAM_CHANGE,
1423
1424     /**
1425      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1426      * structures with info about macroblocks relevant to splitting the
1427      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1428      * That is, it does not necessarily contain info about all macroblocks,
1429      * as long as the distance between macroblocks in the info is smaller
1430      * than the target payload size.
1431      * Each MB info structure is 12 bytes, and is laid out as follows:
1432      * @code
1433      * u32le bit offset from the start of the packet
1434      * u8    current quantizer at the start of the macroblock
1435      * u8    GOB number
1436      * u16le macroblock address within the GOB
1437      * u8    horizontal MV predictor
1438      * u8    vertical MV predictor
1439      * u8    horizontal MV predictor for block number 3
1440      * u8    vertical MV predictor for block number 3
1441      * @endcode
1442      */
1443     AV_PKT_DATA_H263_MB_INFO,
1444
1445     /**
1446      * This side data should be associated with an audio stream and contains
1447      * ReplayGain information in form of the AVReplayGain struct.
1448      */
1449     AV_PKT_DATA_REPLAYGAIN,
1450
1451     /**
1452      * This side data contains a 3x3 transformation matrix describing an affine
1453      * transformation that needs to be applied to the decoded video frames for
1454      * correct presentation.
1455      *
1456      * See libavutil/display.h for a detailed description of the data.
1457      */
1458     AV_PKT_DATA_DISPLAYMATRIX,
1459
1460     /**
1461      * This side data should be associated with a video stream and contains
1462      * Stereoscopic 3D information in form of the AVStereo3D struct.
1463      */
1464     AV_PKT_DATA_STEREO3D,
1465
1466     /**
1467      * This side data should be associated with an audio stream and corresponds
1468      * to enum AVAudioServiceType.
1469      */
1470     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1471
1472     /**
1473      * This side data contains quality related information from the encoder.
1474      * @code
1475      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1476      * u8    picture type
1477      * u8    error count
1478      * u16   reserved
1479      * u64le[error count] sum of squared differences between encoder in and output
1480      * @endcode
1481      */
1482     AV_PKT_DATA_QUALITY_STATS,
1483
1484     /**
1485      * This side data contains an integer value representing the stream index
1486      * of a "fallback" track.  A fallback track indicates an alternate
1487      * track to use when the current track can not be decoded for some reason.
1488      * e.g. no decoder available for codec.
1489      */
1490     AV_PKT_DATA_FALLBACK_TRACK,
1491
1492     /**
1493      * This side data corresponds to the AVCPBProperties struct.
1494      */
1495     AV_PKT_DATA_CPB_PROPERTIES,
1496
1497     /**
1498      * Recommmends skipping the specified number of samples
1499      * @code
1500      * u32le number of samples to skip from start of this packet
1501      * u32le number of samples to skip from end of this packet
1502      * u8    reason for start skip
1503      * u8    reason for end   skip (0=padding silence, 1=convergence)
1504      * @endcode
1505      */
1506     AV_PKT_DATA_SKIP_SAMPLES=70,
1507
1508     /**
1509      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1510      * the packet may contain "dual mono" audio specific to Japanese DTV
1511      * and if it is true, recommends only the selected channel to be used.
1512      * @code
1513      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1514      * @endcode
1515      */
1516     AV_PKT_DATA_JP_DUALMONO,
1517
1518     /**
1519      * A list of zero terminated key/value strings. There is no end marker for
1520      * the list, so it is required to rely on the side data size to stop.
1521      */
1522     AV_PKT_DATA_STRINGS_METADATA,
1523
1524     /**
1525      * Subtitle event position
1526      * @code
1527      * u32le x1
1528      * u32le y1
1529      * u32le x2
1530      * u32le y2
1531      * @endcode
1532      */
1533     AV_PKT_DATA_SUBTITLE_POSITION,
1534
1535     /**
1536      * Data found in BlockAdditional element of matroska container. There is
1537      * no end marker for the data, so it is required to rely on the side data
1538      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1539      * by data.
1540      */
1541     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1542
1543     /**
1544      * The optional first identifier line of a WebVTT cue.
1545      */
1546     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1547
1548     /**
1549      * The optional settings (rendering instructions) that immediately
1550      * follow the timestamp specifier of a WebVTT cue.
1551      */
1552     AV_PKT_DATA_WEBVTT_SETTINGS,
1553
1554     /**
1555      * A list of zero terminated key/value strings. There is no end marker for
1556      * the list, so it is required to rely on the side data size to stop. This
1557      * side data includes updated metadata which appeared in the stream.
1558      */
1559     AV_PKT_DATA_METADATA_UPDATE,
1560
1561     /**
1562      * MPEGTS stream ID, this is required to pass the stream ID
1563      * information from the demuxer to the corresponding muxer.
1564      */
1565     AV_PKT_DATA_MPEGTS_STREAM_ID,
1566
1567     /**
1568      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1569      * should be associated with a video stream and contains data in the form
1570      * of the AVMasteringDisplayMetadata struct.
1571      */
1572     AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1573
1574     /**
1575      * This side data should be associated with a video stream and corresponds
1576      * to the AVSphericalMapping structure.
1577      */
1578     AV_PKT_DATA_SPHERICAL,
1579
1580     /**
1581      * Content light level (based on CTA-861.3). This metadata should be
1582      * associated with a video stream and contains data in the form of the
1583      * AVContentLightMetadata struct.
1584      */
1585     AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1586
1587     /**
1588      * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1589      * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1590      * The number of bytes of CC data is AVPacketSideData.size.
1591      */
1592     AV_PKT_DATA_A53_CC,
1593
1594     /**
1595      * The number of side data elements (in fact a bit more than it).
1596      * This is not part of the public API/ABI in the sense that it may
1597      * change when new side data types are added.
1598      * This must stay the last enum value.
1599      * If its value becomes huge, some code using it
1600      * needs to be updated as it assumes it to be smaller than other limits.
1601      */
1602     AV_PKT_DATA_NB
1603 };
1604
1605 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1606
1607 typedef struct AVPacketSideData {
1608     uint8_t *data;
1609     int      size;
1610     enum AVPacketSideDataType type;
1611 } AVPacketSideData;
1612
1613 /**
1614  * This structure stores compressed data. It is typically exported by demuxers
1615  * and then passed as input to decoders, or received as output from encoders and
1616  * then passed to muxers.
1617  *
1618  * For video, it should typically contain one compressed frame. For audio it may
1619  * contain several compressed frames. Encoders are allowed to output empty
1620  * packets, with no compressed data, containing only side data
1621  * (e.g. to update some stream parameters at the end of encoding).
1622  *
1623  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1624  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1625  * without libavcodec and libavformat major bump.
1626  *
1627  * The semantics of data ownership depends on the buf field.
1628  * If it is set, the packet data is dynamically allocated and is
1629  * valid indefinitely until a call to av_packet_unref() reduces the
1630  * reference count to 0.
1631  *
1632  * If the buf field is not set av_packet_ref() would make a copy instead
1633  * of increasing the reference count.
1634  *
1635  * The side data is always allocated with av_malloc(), copied by
1636  * av_packet_ref() and freed by av_packet_unref().
1637  *
1638  * @see av_packet_ref
1639  * @see av_packet_unref
1640  */
1641 typedef struct AVPacket {
1642     /**
1643      * A reference to the reference-counted buffer where the packet data is
1644      * stored.
1645      * May be NULL, then the packet data is not reference-counted.
1646      */
1647     AVBufferRef *buf;
1648     /**
1649      * Presentation timestamp in AVStream->time_base units; the time at which
1650      * the decompressed packet will be presented to the user.
1651      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1652      * pts MUST be larger or equal to dts as presentation cannot happen before
1653      * decompression, unless one wants to view hex dumps. Some formats misuse
1654      * the terms dts and pts/cts to mean something different. Such timestamps
1655      * must be converted to true pts/dts before they are stored in AVPacket.
1656      */
1657     int64_t pts;
1658     /**
1659      * Decompression timestamp in AVStream->time_base units; the time at which
1660      * the packet is decompressed.
1661      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1662      */
1663     int64_t dts;
1664     uint8_t *data;
1665     int   size;
1666     int   stream_index;
1667     /**
1668      * A combination of AV_PKT_FLAG values
1669      */
1670     int   flags;
1671     /**
1672      * Additional packet data that can be provided by the container.
1673      * Packet can contain several types of side information.
1674      */
1675     AVPacketSideData *side_data;
1676     int side_data_elems;
1677
1678     /**
1679      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1680      * Equals next_pts - this_pts in presentation order.
1681      */
1682     int64_t duration;
1683
1684     int64_t pos;                            ///< byte position in stream, -1 if unknown
1685
1686 #if FF_API_CONVERGENCE_DURATION
1687     /**
1688      * @deprecated Same as the duration field, but as int64_t. This was required
1689      * for Matroska subtitles, whose duration values could overflow when the
1690      * duration field was still an int.
1691      */
1692     attribute_deprecated
1693     int64_t convergence_duration;
1694 #endif
1695 } AVPacket;
1696 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1697 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1698 /**
1699  * Flag is used to discard packets which are required to maintain valid
1700  * decoder state but are not required for output and should be dropped
1701  * after decoding.
1702  **/
1703 #define AV_PKT_FLAG_DISCARD   0x0004
1704 /**
1705  * The packet comes from a trusted source.
1706  *
1707  * Otherwise-unsafe constructs such as arbitrary pointers to data
1708  * outside the packet may be followed.
1709  */
1710 #define AV_PKT_FLAG_TRUSTED   0x0008
1711
1712 enum AVSideDataParamChangeFlags {
1713     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1714     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1715     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1716     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1717 };
1718 /**
1719  * @}
1720  */
1721
1722 struct AVCodecInternal;
1723
1724 enum AVFieldOrder {
1725     AV_FIELD_UNKNOWN,
1726     AV_FIELD_PROGRESSIVE,
1727     AV_FIELD_TT,          //< Top coded_first, top displayed first
1728     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1729     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1730     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1731 };
1732
1733 /**
1734  * main external API structure.
1735  * New fields can be added to the end with minor version bumps.
1736  * Removal, reordering and changes to existing fields require a major
1737  * version bump.
1738  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1739  * applications.
1740  * The name string for AVOptions options matches the associated command line
1741  * parameter name and can be found in libavcodec/options_table.h
1742  * The AVOption/command line parameter names differ in some cases from the C
1743  * structure field names for historic reasons or brevity.
1744  * sizeof(AVCodecContext) must not be used outside libav*.
1745  */
1746 typedef struct AVCodecContext {
1747     /**
1748      * information on struct for av_log
1749      * - set by avcodec_alloc_context3
1750      */
1751     const AVClass *av_class;
1752     int log_level_offset;
1753
1754     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1755     const struct AVCodec  *codec;
1756 #if FF_API_CODEC_NAME
1757     /**
1758      * @deprecated this field is not used for anything in libavcodec
1759      */
1760     attribute_deprecated
1761     char             codec_name[32];
1762 #endif
1763     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1764
1765     /**
1766      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1767      * This is used to work around some encoder bugs.
1768      * A demuxer should set this to what is stored in the field used to identify the codec.
1769      * If there are multiple such fields in a container then the demuxer should choose the one
1770      * which maximizes the information about the used codec.
1771      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1772      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1773      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1774      * first.
1775      * - encoding: Set by user, if not then the default based on codec_id will be used.
1776      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1777      */
1778     unsigned int codec_tag;
1779
1780 #if FF_API_STREAM_CODEC_TAG
1781     /**
1782      * @deprecated this field is unused
1783      */
1784     attribute_deprecated
1785     unsigned int stream_codec_tag;
1786 #endif
1787
1788     void *priv_data;
1789
1790     /**
1791      * Private context used for internal data.
1792      *
1793      * Unlike priv_data, this is not codec-specific. It is used in general
1794      * libavcodec functions.
1795      */
1796     struct AVCodecInternal *internal;
1797
1798     /**
1799      * Private data of the user, can be used to carry app specific stuff.
1800      * - encoding: Set by user.
1801      * - decoding: Set by user.
1802      */
1803     void *opaque;
1804
1805     /**
1806      * the average bitrate
1807      * - encoding: Set by user; unused for constant quantizer encoding.
1808      * - decoding: Set by user, may be overwritten by libavcodec
1809      *             if this info is available in the stream
1810      */
1811     int64_t bit_rate;
1812
1813     /**
1814      * number of bits the bitstream is allowed to diverge from the reference.
1815      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1816      * - encoding: Set by user; unused for constant quantizer encoding.
1817      * - decoding: unused
1818      */
1819     int bit_rate_tolerance;
1820
1821     /**
1822      * Global quality for codecs which cannot change it per frame.
1823      * This should be proportional to MPEG-1/2/4 qscale.
1824      * - encoding: Set by user.
1825      * - decoding: unused
1826      */
1827     int global_quality;
1828
1829     /**
1830      * - encoding: Set by user.
1831      * - decoding: unused
1832      */
1833     int compression_level;
1834 #define FF_COMPRESSION_DEFAULT -1
1835
1836     /**
1837      * AV_CODEC_FLAG_*.
1838      * - encoding: Set by user.
1839      * - decoding: Set by user.
1840      */
1841     int flags;
1842
1843     /**
1844      * AV_CODEC_FLAG2_*
1845      * - encoding: Set by user.
1846      * - decoding: Set by user.
1847      */
1848     int flags2;
1849
1850     /**
1851      * some codecs need / can use extradata like Huffman tables.
1852      * MJPEG: Huffman tables
1853      * rv10: additional flags
1854      * MPEG-4: global headers (they can be in the bitstream or here)
1855      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1856      * than extradata_size to avoid problems if it is read with the bitstream reader.
1857      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1858      * - encoding: Set/allocated/freed by libavcodec.
1859      * - decoding: Set/allocated/freed by user.
1860      */
1861     uint8_t *extradata;
1862     int extradata_size;
1863
1864     /**
1865      * This is the fundamental unit of time (in seconds) in terms
1866      * of which frame timestamps are represented. For fixed-fps content,
1867      * timebase should be 1/framerate and timestamp increments should be
1868      * identically 1.
1869      * This often, but not always is the inverse of the frame rate or field rate
1870      * for video. 1/time_base is not the average frame rate if the frame rate is not
1871      * constant.
1872      *
1873      * Like containers, elementary streams also can store timestamps, 1/time_base
1874      * is the unit in which these timestamps are specified.
1875      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1876      * vop_time_increment_resolution and fixed_vop_rate
1877      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1878      *
1879      * - encoding: MUST be set by user.
1880      * - decoding: the use of this field for decoding is deprecated.
1881      *             Use framerate instead.
1882      */
1883     AVRational time_base;
1884
1885     /**
1886      * For some codecs, the time base is closer to the field rate than the frame rate.
1887      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1888      * if no telecine is used ...
1889      *
1890      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1891      */
1892     int ticks_per_frame;
1893
1894     /**
1895      * Codec delay.
1896      *
1897      * Encoding: Number of frames delay there will be from the encoder input to
1898      *           the decoder output. (we assume the decoder matches the spec)
1899      * Decoding: Number of frames delay in addition to what a standard decoder
1900      *           as specified in the spec would produce.
1901      *
1902      * Video:
1903      *   Number of frames the decoded output will be delayed relative to the
1904      *   encoded input.
1905      *
1906      * Audio:
1907      *   For encoding, this field is unused (see initial_padding).
1908      *
1909      *   For decoding, this is the number of samples the decoder needs to
1910      *   output before the decoder's output is valid. When seeking, you should
1911      *   start decoding this many samples prior to your desired seek point.
1912      *
1913      * - encoding: Set by libavcodec.
1914      * - decoding: Set by libavcodec.
1915      */
1916     int delay;
1917
1918
1919     /* video only */
1920     /**
1921      * picture width / height.
1922      *
1923      * @note Those fields may not match the values of the last
1924      * AVFrame output by avcodec_decode_video2 due frame
1925      * reordering.
1926      *
1927      * - encoding: MUST be set by user.
1928      * - decoding: May be set by the user before opening the decoder if known e.g.
1929      *             from the container. Some decoders will require the dimensions
1930      *             to be set by the caller. During decoding, the decoder may
1931      *             overwrite those values as required while parsing the data.
1932      */
1933     int width, height;
1934
1935     /**
1936      * Bitstream width / height, may be different from width/height e.g. when
1937      * the decoded frame is cropped before being output or lowres is enabled.
1938      *
1939      * @note Those field may not match the value of the last
1940      * AVFrame output by avcodec_receive_frame() due frame
1941      * reordering.
1942      *
1943      * - encoding: unused
1944      * - decoding: May be set by the user before opening the decoder if known
1945      *             e.g. from the container. During decoding, the decoder may
1946      *             overwrite those values as required while parsing the data.
1947      */
1948     int coded_width, coded_height;
1949
1950 #if FF_API_ASPECT_EXTENDED
1951 #define FF_ASPECT_EXTENDED 15
1952 #endif
1953
1954     /**
1955      * the number of pictures in a group of pictures, or 0 for intra_only
1956      * - encoding: Set by user.
1957      * - decoding: unused
1958      */
1959     int gop_size;
1960
1961     /**
1962      * Pixel format, see AV_PIX_FMT_xxx.
1963      * May be set by the demuxer if known from headers.
1964      * May be overridden by the decoder if it knows better.
1965      *
1966      * @note This field may not match the value of the last
1967      * AVFrame output by avcodec_receive_frame() due frame
1968      * reordering.
1969      *
1970      * - encoding: Set by user.
1971      * - decoding: Set by user if known, overridden by libavcodec while
1972      *             parsing the data.
1973      */
1974     enum AVPixelFormat pix_fmt;
1975
1976 #if FF_API_MOTION_EST
1977     /**
1978      * This option does nothing
1979      * @deprecated use codec private options instead
1980      */
1981     attribute_deprecated int me_method;
1982 #endif
1983
1984     /**
1985      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1986      * decoder to draw a horizontal band. It improves cache usage. Not
1987      * all codecs can do that. You must check the codec capabilities
1988      * beforehand.
1989      * When multithreading is used, it may be called from multiple threads
1990      * at the same time; threads might draw different parts of the same AVFrame,
1991      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1992      * in order.
1993      * The function is also used by hardware acceleration APIs.
1994      * It is called at least once during frame decoding to pass
1995      * the data needed for hardware render.
1996      * In that mode instead of pixel data, AVFrame points to
1997      * a structure specific to the acceleration API. The application
1998      * reads the structure and can change some fields to indicate progress
1999      * or mark state.
2000      * - encoding: unused
2001      * - decoding: Set by user.
2002      * @param height the height of the slice
2003      * @param y the y position of the slice
2004      * @param type 1->top field, 2->bottom field, 3->frame
2005      * @param offset offset into the AVFrame.data from which the slice should be read
2006      */
2007     void (*draw_horiz_band)(struct AVCodecContext *s,
2008                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2009                             int y, int type, int height);
2010
2011     /**
2012      * callback to negotiate the pixelFormat
2013      * @param fmt is the list of formats which are supported by the codec,
2014      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2015      * The first is always the native one.
2016      * @note The callback may be called again immediately if initialization for
2017      * the selected (hardware-accelerated) pixel format failed.
2018      * @warning Behavior is undefined if the callback returns a value not
2019      * in the fmt list of formats.
2020      * @return the chosen format
2021      * - encoding: unused
2022      * - decoding: Set by user, if not set the native format will be chosen.
2023      */
2024     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2025
2026     /**
2027      * maximum number of B-frames between non-B-frames
2028      * Note: The output will be delayed by max_b_frames+1 relative to the input.
2029      * - encoding: Set by user.
2030      * - decoding: unused
2031      */
2032     int max_b_frames;
2033
2034     /**
2035      * qscale factor between IP and B-frames
2036      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2037      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2038      * - encoding: Set by user.
2039      * - decoding: unused
2040      */
2041     float b_quant_factor;
2042
2043 #if FF_API_RC_STRATEGY
2044     /** @deprecated use codec private option instead */
2045     attribute_deprecated int rc_strategy;
2046 #define FF_RC_STRATEGY_XVID 1
2047 #endif
2048
2049 #if FF_API_PRIVATE_OPT
2050     /** @deprecated use encoder private options instead */
2051     attribute_deprecated
2052     int b_frame_strategy;
2053 #endif
2054
2055     /**
2056      * qscale offset between IP and B-frames
2057      * - encoding: Set by user.
2058      * - decoding: unused
2059      */
2060     float b_quant_offset;
2061
2062     /**
2063      * Size of the frame reordering buffer in the decoder.
2064      * For MPEG-2 it is 1 IPB or 0 low delay IP.
2065      * - encoding: Set by libavcodec.
2066      * - decoding: Set by libavcodec.
2067      */
2068     int has_b_frames;
2069
2070 #if FF_API_PRIVATE_OPT
2071     /** @deprecated use encoder private options instead */
2072     attribute_deprecated
2073     int mpeg_quant;
2074 #endif
2075
2076     /**
2077      * qscale factor between P- and I-frames
2078      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2079      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2080      * - encoding: Set by user.
2081      * - decoding: unused
2082      */
2083     float i_quant_factor;
2084
2085     /**
2086      * qscale offset between P and I-frames
2087      * - encoding: Set by user.
2088      * - decoding: unused
2089      */
2090     float i_quant_offset;
2091
2092     /**
2093      * luminance masking (0-> disabled)
2094      * - encoding: Set by user.
2095      * - decoding: unused
2096      */
2097     float lumi_masking;
2098
2099     /**
2100      * temporary complexity masking (0-> disabled)
2101      * - encoding: Set by user.
2102      * - decoding: unused
2103      */
2104     float temporal_cplx_masking;
2105
2106     /**
2107      * spatial complexity masking (0-> disabled)
2108      * - encoding: Set by user.
2109      * - decoding: unused
2110      */
2111     float spatial_cplx_masking;
2112
2113     /**
2114      * p block masking (0-> disabled)
2115      * - encoding: Set by user.
2116      * - decoding: unused
2117      */
2118     float p_masking;
2119
2120     /**
2121      * darkness masking (0-> disabled)
2122      * - encoding: Set by user.
2123      * - decoding: unused
2124      */
2125     float dark_masking;
2126
2127     /**
2128      * slice count
2129      * - encoding: Set by libavcodec.
2130      * - decoding: Set by user (or 0).
2131      */
2132     int slice_count;
2133
2134 #if FF_API_PRIVATE_OPT
2135     /** @deprecated use encoder private options instead */
2136     attribute_deprecated
2137      int prediction_method;
2138 #define FF_PRED_LEFT   0
2139 #define FF_PRED_PLANE  1
2140 #define FF_PRED_MEDIAN 2
2141 #endif
2142
2143     /**
2144      * slice offsets in the frame in bytes
2145      * - encoding: Set/allocated by libavcodec.
2146      * - decoding: Set/allocated by user (or NULL).
2147      */
2148     int *slice_offset;
2149
2150     /**
2151      * sample aspect ratio (0 if unknown)
2152      * That is the width of a pixel divided by the height of the pixel.
2153      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2154      * - encoding: Set by user.
2155      * - decoding: Set by libavcodec.
2156      */
2157     AVRational sample_aspect_ratio;
2158
2159     /**
2160      * motion estimation comparison function
2161      * - encoding: Set by user.
2162      * - decoding: unused
2163      */
2164     int me_cmp;
2165     /**
2166      * subpixel motion estimation comparison function
2167      * - encoding: Set by user.
2168      * - decoding: unused
2169      */
2170     int me_sub_cmp;
2171     /**
2172      * macroblock comparison function (not supported yet)
2173      * - encoding: Set by user.
2174      * - decoding: unused
2175      */
2176     int mb_cmp;
2177     /**
2178      * interlaced DCT comparison function
2179      * - encoding: Set by user.
2180      * - decoding: unused
2181      */
2182     int ildct_cmp;
2183 #define FF_CMP_SAD          0
2184 #define FF_CMP_SSE          1
2185 #define FF_CMP_SATD         2
2186 #define FF_CMP_DCT          3
2187 #define FF_CMP_PSNR         4
2188 #define FF_CMP_BIT          5
2189 #define FF_CMP_RD           6
2190 #define FF_CMP_ZERO         7
2191 #define FF_CMP_VSAD         8
2192 #define FF_CMP_VSSE         9
2193 #define FF_CMP_NSSE         10
2194 #define FF_CMP_W53          11
2195 #define FF_CMP_W97          12
2196 #define FF_CMP_DCTMAX       13
2197 #define FF_CMP_DCT264       14
2198 #define FF_CMP_MEDIAN_SAD   15
2199 #define FF_CMP_CHROMA       256
2200
2201     /**
2202      * ME diamond size & shape
2203      * - encoding: Set by user.
2204      * - decoding: unused
2205      */
2206     int dia_size;
2207
2208     /**
2209      * amount of previous MV predictors (2a+1 x 2a+1 square)
2210      * - encoding: Set by user.
2211      * - decoding: unused
2212      */
2213     int last_predictor_count;
2214
2215 #if FF_API_PRIVATE_OPT
2216     /** @deprecated use encoder private options instead */
2217     attribute_deprecated
2218     int pre_me;
2219 #endif
2220
2221     /**
2222      * motion estimation prepass comparison function
2223      * - encoding: Set by user.
2224      * - decoding: unused
2225      */
2226     int me_pre_cmp;
2227
2228     /**
2229      * ME prepass diamond size & shape
2230      * - encoding: Set by user.
2231      * - decoding: unused
2232      */
2233     int pre_dia_size;
2234
2235     /**
2236      * subpel ME quality
2237      * - encoding: Set by user.
2238      * - decoding: unused
2239      */
2240     int me_subpel_quality;
2241
2242 #if FF_API_AFD
2243     /**
2244      * DTG active format information (additional aspect ratio
2245      * information only used in DVB MPEG-2 transport streams)
2246      * 0 if not set.
2247      *
2248      * - encoding: unused
2249      * - decoding: Set by decoder.
2250      * @deprecated Deprecated in favor of AVSideData
2251      */
2252     attribute_deprecated int dtg_active_format;
2253 #define FF_DTG_AFD_SAME         8
2254 #define FF_DTG_AFD_4_3          9
2255 #define FF_DTG_AFD_16_9         10
2256 #define FF_DTG_AFD_14_9         11
2257 #define FF_DTG_AFD_4_3_SP_14_9  13
2258 #define FF_DTG_AFD_16_9_SP_14_9 14
2259 #define FF_DTG_AFD_SP_4_3       15
2260 #endif /* FF_API_AFD */
2261
2262     /**
2263      * maximum motion estimation search range in subpel units
2264      * If 0 then no limit.
2265      *
2266      * - encoding: Set by user.
2267      * - decoding: unused
2268      */
2269     int me_range;
2270
2271 #if FF_API_QUANT_BIAS
2272     /**
2273      * @deprecated use encoder private option instead
2274      */
2275     attribute_deprecated int intra_quant_bias;
2276 #define FF_DEFAULT_QUANT_BIAS 999999
2277
2278     /**
2279      * @deprecated use encoder private option instead
2280      */
2281     attribute_deprecated int inter_quant_bias;
2282 #endif
2283
2284     /**
2285      * slice flags
2286      * - encoding: unused
2287      * - decoding: Set by user.
2288      */
2289     int slice_flags;
2290 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2291 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2292 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2293
2294 #if FF_API_XVMC
2295     /**
2296      * XVideo Motion Acceleration
2297      * - encoding: forbidden
2298      * - decoding: set by decoder
2299      * @deprecated XvMC doesn't need it anymore.
2300      */
2301     attribute_deprecated int xvmc_acceleration;
2302 #endif /* FF_API_XVMC */
2303
2304     /**
2305      * macroblock decision mode
2306      * - encoding: Set by user.
2307      * - decoding: unused
2308      */
2309     int mb_decision;
2310 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2311 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2312 #define FF_MB_DECISION_RD     2        ///< rate distortion
2313
2314     /**
2315      * custom intra quantization matrix
2316      * - encoding: Set by user, can be NULL.
2317      * - decoding: Set by libavcodec.
2318      */
2319     uint16_t *intra_matrix;
2320
2321     /**
2322      * custom inter quantization matrix
2323      * - encoding: Set by user, can be NULL.
2324      * - decoding: Set by libavcodec.
2325      */
2326     uint16_t *inter_matrix;
2327
2328 #if FF_API_PRIVATE_OPT
2329     /** @deprecated use encoder private options instead */
2330     attribute_deprecated
2331     int scenechange_threshold;
2332
2333     /** @deprecated use encoder private options instead */
2334     attribute_deprecated
2335     int noise_reduction;
2336 #endif
2337
2338 #if FF_API_MPV_OPT
2339     /**
2340      * @deprecated this field is unused
2341      */
2342     attribute_deprecated
2343     int me_threshold;
2344
2345     /**
2346      * @deprecated this field is unused
2347      */
2348     attribute_deprecated
2349     int mb_threshold;
2350 #endif
2351
2352     /**
2353      * precision of the intra DC coefficient - 8
2354      * - encoding: Set by user.
2355      * - decoding: Set by libavcodec
2356      */
2357     int intra_dc_precision;
2358
2359     /**
2360      * Number of macroblock rows at the top which are skipped.
2361      * - encoding: unused
2362      * - decoding: Set by user.
2363      */
2364     int skip_top;
2365
2366     /**
2367      * Number of macroblock rows at the bottom which are skipped.
2368      * - encoding: unused
2369      * - decoding: Set by user.
2370      */
2371     int skip_bottom;
2372
2373 #if FF_API_MPV_OPT
2374     /**
2375      * @deprecated use encoder private options instead
2376      */
2377     attribute_deprecated
2378     float border_masking;
2379 #endif
2380
2381     /**
2382      * minimum MB Lagrange multiplier
2383      * - encoding: Set by user.
2384      * - decoding: unused
2385      */
2386     int mb_lmin;
2387
2388     /**
2389      * maximum MB Lagrange multiplier
2390      * - encoding: Set by user.
2391      * - decoding: unused
2392      */
2393     int mb_lmax;
2394
2395 #if FF_API_PRIVATE_OPT
2396     /**
2397      * @deprecated use encoder private options instead
2398      */
2399     attribute_deprecated
2400     int me_penalty_compensation;
2401 #endif
2402
2403     /**
2404      * - encoding: Set by user.
2405      * - decoding: unused
2406      */
2407     int bidir_refine;
2408
2409 #if FF_API_PRIVATE_OPT
2410     /** @deprecated use encoder private options instead */
2411     attribute_deprecated
2412     int brd_scale;
2413 #endif
2414
2415     /**
2416      * minimum GOP size
2417      * - encoding: Set by user.
2418      * - decoding: unused
2419      */
2420     int keyint_min;
2421
2422     /**
2423      * number of reference frames
2424      * - encoding: Set by user.
2425      * - decoding: Set by lavc.
2426      */
2427     int refs;
2428
2429 #if FF_API_PRIVATE_OPT
2430     /** @deprecated use encoder private options instead */
2431     attribute_deprecated
2432     int chromaoffset;
2433 #endif
2434
2435 #if FF_API_UNUSED_MEMBERS
2436     /**
2437      * Multiplied by qscale for each frame and added to scene_change_score.
2438      * - encoding: Set by user.
2439      * - decoding: unused
2440      */
2441     attribute_deprecated int scenechange_factor;
2442 #endif
2443
2444     /**
2445      * Note: Value depends upon the compare function used for fullpel ME.
2446      * - encoding: Set by user.
2447      * - decoding: unused
2448      */
2449     int mv0_threshold;
2450
2451 #if FF_API_PRIVATE_OPT
2452     /** @deprecated use encoder private options instead */
2453     attribute_deprecated
2454     int b_sensitivity;
2455 #endif
2456
2457     /**
2458      * Chromaticity coordinates of the source primaries.
2459      * - encoding: Set by user
2460      * - decoding: Set by libavcodec
2461      */
2462     enum AVColorPrimaries color_primaries;
2463
2464     /**
2465      * Color Transfer Characteristic.
2466      * - encoding: Set by user
2467      * - decoding: Set by libavcodec
2468      */
2469     enum AVColorTransferCharacteristic color_trc;
2470
2471     /**
2472      * YUV colorspace type.
2473      * - encoding: Set by user
2474      * - decoding: Set by libavcodec
2475      */
2476     enum AVColorSpace colorspace;
2477
2478     /**
2479      * MPEG vs JPEG YUV range.
2480      * - encoding: Set by user
2481      * - decoding: Set by libavcodec
2482      */
2483     enum AVColorRange color_range;
2484
2485     /**
2486      * This defines the location of chroma samples.
2487      * - encoding: Set by user
2488      * - decoding: Set by libavcodec
2489      */
2490     enum AVChromaLocation chroma_sample_location;
2491
2492     /**
2493      * Number of slices.
2494      * Indicates number of picture subdivisions. Used for parallelized
2495      * decoding.
2496      * - encoding: Set by user
2497      * - decoding: unused
2498      */
2499     int slices;
2500
2501     /** Field order
2502      * - encoding: set by libavcodec
2503      * - decoding: Set by user.
2504      */
2505     enum AVFieldOrder field_order;
2506
2507     /* audio only */
2508     int sample_rate; ///< samples per second
2509     int channels;    ///< number of audio channels
2510
2511     /**
2512      * audio sample format
2513      * - encoding: Set by user.
2514      * - decoding: Set by libavcodec.
2515      */
2516     enum AVSampleFormat sample_fmt;  ///< sample format
2517
2518     /* The following data should not be initialized. */
2519     /**
2520      * Number of samples per channel in an audio frame.
2521      *
2522      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2523      *   except the last must contain exactly frame_size samples per channel.
2524      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2525      *   frame size is not restricted.
2526      * - decoding: may be set by some decoders to indicate constant frame size
2527      */
2528     int frame_size;
2529
2530     /**
2531      * Frame counter, set by libavcodec.
2532      *
2533      * - decoding: total number of frames returned from the decoder so far.
2534      * - encoding: total number of frames passed to the encoder so far.
2535      *
2536      *   @note the counter is not incremented if encoding/decoding resulted in
2537      *   an error.
2538      */
2539     int frame_number;
2540
2541     /**
2542      * number of bytes per packet if constant and known or 0
2543      * Used by some WAV based audio codecs.
2544      */
2545     int block_align;
2546
2547     /**
2548      * Audio cutoff bandwidth (0 means "automatic")
2549      * - encoding: Set by user.
2550      * - decoding: unused
2551      */
2552     int cutoff;
2553
2554     /**
2555      * Audio channel layout.
2556      * - encoding: set by user.
2557      * - decoding: set by user, may be overwritten by libavcodec.
2558      */
2559     uint64_t channel_layout;
2560
2561     /**
2562      * Request decoder to use this channel layout if it can (0 for default)
2563      * - encoding: unused
2564      * - decoding: Set by user.
2565      */
2566     uint64_t request_channel_layout;
2567
2568     /**
2569      * Type of service that the audio stream conveys.
2570      * - encoding: Set by user.
2571      * - decoding: Set by libavcodec.
2572      */
2573     enum AVAudioServiceType audio_service_type;
2574
2575     /**
2576      * desired sample format
2577      * - encoding: Not used.
2578      * - decoding: Set by user.
2579      * Decoder will decode to this format if it can.
2580      */
2581     enum AVSampleFormat request_sample_fmt;
2582
2583     /**
2584      * This callback is called at the beginning of each frame to get data
2585      * buffer(s) for it. There may be one contiguous buffer for all the data or
2586      * there may be a buffer per each data plane or anything in between. What
2587      * this means is, you may set however many entries in buf[] you feel necessary.
2588      * Each buffer must be reference-counted using the AVBuffer API (see description
2589      * of buf[] below).
2590      *
2591      * The following fields will be set in the frame before this callback is
2592      * called:
2593      * - format
2594      * - width, height (video only)
2595      * - sample_rate, channel_layout, nb_samples (audio only)
2596      * Their values may differ from the corresponding values in
2597      * AVCodecContext. This callback must use the frame values, not the codec
2598      * context values, to calculate the required buffer size.
2599      *
2600      * This callback must fill the following fields in the frame:
2601      * - data[]
2602      * - linesize[]
2603      * - extended_data:
2604      *   * if the data is planar audio with more than 8 channels, then this
2605      *     callback must allocate and fill extended_data to contain all pointers
2606      *     to all data planes. data[] must hold as many pointers as it can.
2607      *     extended_data must be allocated with av_malloc() and will be freed in
2608      *     av_frame_unref().
2609      *   * otherwise extended_data must point to data
2610      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2611      *   the frame's data and extended_data pointers must be contained in these. That
2612      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2613      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2614      *   and av_buffer_ref().
2615      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2616      *   this callback and filled with the extra buffers if there are more
2617      *   buffers than buf[] can hold. extended_buf will be freed in
2618      *   av_frame_unref().
2619      *
2620      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2621      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2622      * some other means.
2623      *
2624      * Each data plane must be aligned to the maximum required by the target
2625      * CPU.
2626      *
2627      * @see avcodec_default_get_buffer2()
2628      *
2629      * Video:
2630      *
2631      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2632      * (read and/or written to if it is writable) later by libavcodec.
2633      *
2634      * avcodec_align_dimensions2() should be used to find the required width and
2635      * height, as they normally need to be rounded up to the next multiple of 16.
2636      *
2637      * Some decoders do not support linesizes changing between frames.
2638      *
2639      * If frame multithreading is used and thread_safe_callbacks is set,
2640      * this callback may be called from a different thread, but not from more
2641      * than one at once. Does not need to be reentrant.
2642      *
2643      * @see avcodec_align_dimensions2()
2644      *
2645      * Audio:
2646      *
2647      * Decoders request a buffer of a particular size by setting
2648      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2649      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2650      * to a smaller value in the output frame.
2651      *
2652      * As a convenience, av_samples_get_buffer_size() and
2653      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2654      * functions to find the required data size and to fill data pointers and
2655      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2656      * since all planes must be the same size.
2657      *
2658      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2659      *
2660      * - encoding: unused
2661      * - decoding: Set by libavcodec, user can override.
2662      */
2663     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2664
2665     /**
2666      * If non-zero, the decoded audio and video frames returned from
2667      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2668      * and are valid indefinitely. The caller must free them with
2669      * av_frame_unref() when they are not needed anymore.
2670      * Otherwise, the decoded frames must not be freed by the caller and are
2671      * only valid until the next decode call.
2672      *
2673      * This is always automatically enabled if avcodec_receive_frame() is used.
2674      *
2675      * - encoding: unused
2676      * - decoding: set by the caller before avcodec_open2().
2677      */
2678     attribute_deprecated
2679     int refcounted_frames;
2680
2681     /* - encoding parameters */
2682     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2683     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2684
2685     /**
2686      * minimum quantizer
2687      * - encoding: Set by user.
2688      * - decoding: unused
2689      */
2690     int qmin;
2691
2692     /**
2693      * maximum quantizer
2694      * - encoding: Set by user.
2695      * - decoding: unused
2696      */
2697     int qmax;
2698
2699     /**
2700      * maximum quantizer difference between frames
2701      * - encoding: Set by user.
2702      * - decoding: unused
2703      */
2704     int max_qdiff;
2705
2706 #if FF_API_MPV_OPT
2707     /**
2708      * @deprecated use encoder private options instead
2709      */
2710     attribute_deprecated
2711     float rc_qsquish;
2712
2713     attribute_deprecated
2714     float rc_qmod_amp;
2715     attribute_deprecated
2716     int rc_qmod_freq;
2717 #endif
2718
2719     /**
2720      * decoder bitstream buffer size
2721      * - encoding: Set by user.
2722      * - decoding: unused
2723      */
2724     int rc_buffer_size;
2725
2726     /**
2727      * ratecontrol override, see RcOverride
2728      * - encoding: Allocated/set/freed by user.
2729      * - decoding: unused
2730      */
2731     int rc_override_count;
2732     RcOverride *rc_override;
2733
2734 #if FF_API_MPV_OPT
2735     /**
2736      * @deprecated use encoder private options instead
2737      */
2738     attribute_deprecated
2739     const char *rc_eq;
2740 #endif
2741
2742     /**
2743      * maximum bitrate
2744      * - encoding: Set by user.
2745      * - decoding: Set by user, may be overwritten by libavcodec.
2746      */
2747     int64_t rc_max_rate;
2748
2749     /**
2750      * minimum bitrate
2751      * - encoding: Set by user.
2752      * - decoding: unused
2753      */
2754     int64_t rc_min_rate;
2755
2756 #if FF_API_MPV_OPT
2757     /**
2758      * @deprecated use encoder private options instead
2759      */
2760     attribute_deprecated
2761     float rc_buffer_aggressivity;
2762
2763     attribute_deprecated
2764     float rc_initial_cplx;
2765 #endif
2766
2767     /**
2768      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2769      * - encoding: Set by user.
2770      * - decoding: unused.
2771      */
2772     float rc_max_available_vbv_use;
2773
2774     /**
2775      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2776      * - encoding: Set by user.
2777      * - decoding: unused.
2778      */
2779     float rc_min_vbv_overflow_use;
2780
2781     /**
2782      * Number of bits which should be loaded into the rc buffer before decoding starts.
2783      * - encoding: Set by user.
2784      * - decoding: unused
2785      */
2786     int rc_initial_buffer_occupancy;
2787
2788 #if FF_API_CODER_TYPE
2789 #define FF_CODER_TYPE_VLC       0
2790 #define FF_CODER_TYPE_AC        1
2791 #define FF_CODER_TYPE_RAW       2
2792 #define FF_CODER_TYPE_RLE       3
2793 #if FF_API_UNUSED_MEMBERS
2794 #define FF_CODER_TYPE_DEFLATE   4
2795 #endif /* FF_API_UNUSED_MEMBERS */
2796     /**
2797      * @deprecated use encoder private options instead
2798      */
2799     attribute_deprecated
2800     int coder_type;
2801 #endif /* FF_API_CODER_TYPE */
2802
2803 #if FF_API_PRIVATE_OPT
2804     /** @deprecated use encoder private options instead */
2805     attribute_deprecated
2806     int context_model;
2807 #endif
2808
2809 #if FF_API_MPV_OPT
2810     /**
2811      * @deprecated use encoder private options instead
2812      */
2813     attribute_deprecated
2814     int lmin;
2815
2816     /**
2817      * @deprecated use encoder private options instead
2818      */
2819     attribute_deprecated
2820     int lmax;
2821 #endif
2822
2823 #if FF_API_PRIVATE_OPT
2824     /** @deprecated use encoder private options instead */
2825     attribute_deprecated
2826     int frame_skip_threshold;
2827
2828     /** @deprecated use encoder private options instead */
2829     attribute_deprecated
2830     int frame_skip_factor;
2831
2832     /** @deprecated use encoder private options instead */
2833     attribute_deprecated
2834     int frame_skip_exp;
2835
2836     /** @deprecated use encoder private options instead */
2837     attribute_deprecated
2838     int frame_skip_cmp;
2839 #endif /* FF_API_PRIVATE_OPT */
2840
2841     /**
2842      * trellis RD quantization
2843      * - encoding: Set by user.
2844      * - decoding: unused
2845      */
2846     int trellis;
2847
2848 #if FF_API_PRIVATE_OPT
2849     /** @deprecated use encoder private options instead */
2850     attribute_deprecated
2851     int min_prediction_order;
2852
2853     /** @deprecated use encoder private options instead */
2854     attribute_deprecated
2855     int max_prediction_order;
2856
2857     /** @deprecated use encoder private options instead */
2858     attribute_deprecated
2859     int64_t timecode_frame_start;
2860 #endif
2861
2862 #if FF_API_RTP_CALLBACK
2863     /**
2864      * @deprecated unused
2865      */
2866     /* The RTP callback: This function is called    */
2867     /* every time the encoder has a packet to send. */
2868     /* It depends on the encoder if the data starts */
2869     /* with a Start Code (it should). H.263 does.   */
2870     /* mb_nb contains the number of macroblocks     */
2871     /* encoded in the RTP payload.                  */
2872     attribute_deprecated
2873     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2874 #endif
2875
2876 #if FF_API_PRIVATE_OPT
2877     /** @deprecated use encoder private options instead */
2878     attribute_deprecated
2879     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2880                             /* do its best to deliver a chunk with size     */
2881                             /* below rtp_payload_size, the chunk will start */
2882                             /* with a start code on some codecs like H.263. */
2883                             /* This doesn't take account of any particular  */
2884                             /* headers inside the transmitted RTP payload.  */
2885 #endif
2886
2887 #if FF_API_STAT_BITS
2888     /* statistics, used for 2-pass encoding */
2889     attribute_deprecated
2890     int mv_bits;
2891     attribute_deprecated
2892     int header_bits;
2893     attribute_deprecated
2894     int i_tex_bits;
2895     attribute_deprecated
2896     int p_tex_bits;
2897     attribute_deprecated
2898     int i_count;
2899     attribute_deprecated
2900     int p_count;
2901     attribute_deprecated
2902     int skip_count;
2903     attribute_deprecated
2904     int misc_bits;
2905
2906     /** @deprecated this field is unused */
2907     attribute_deprecated
2908     int frame_bits;
2909 #endif
2910
2911     /**
2912      * pass1 encoding statistics output buffer
2913      * - encoding: Set by libavcodec.
2914      * - decoding: unused
2915      */
2916     char *stats_out;
2917
2918     /**
2919      * pass2 encoding statistics input buffer
2920      * Concatenated stuff from stats_out of pass1 should be placed here.
2921      * - encoding: Allocated/set/freed by user.
2922      * - decoding: unused
2923      */
2924     char *stats_in;
2925
2926     /**
2927      * Work around bugs in encoders which sometimes cannot be detected automatically.
2928      * - encoding: Set by user
2929      * - decoding: Set by user
2930      */
2931     int workaround_bugs;
2932 #define FF_BUG_AUTODETECT       1  ///< autodetection
2933 #if FF_API_OLD_MSMPEG4
2934 #define FF_BUG_OLD_MSMPEG4      2
2935 #endif
2936 #define FF_BUG_XVID_ILACE       4
2937 #define FF_BUG_UMP4             8
2938 #define FF_BUG_NO_PADDING       16
2939 #define FF_BUG_AMV              32
2940 #if FF_API_AC_VLC
2941 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2942 #endif
2943 #define FF_BUG_QPEL_CHROMA      64
2944 #define FF_BUG_STD_QPEL         128
2945 #define FF_BUG_QPEL_CHROMA2     256
2946 #define FF_BUG_DIRECT_BLOCKSIZE 512
2947 #define FF_BUG_EDGE             1024
2948 #define FF_BUG_HPEL_CHROMA      2048
2949 #define FF_BUG_DC_CLIP          4096
2950 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2951 #define FF_BUG_TRUNCATED       16384
2952 #define FF_BUG_IEDGE           32768
2953
2954     /**
2955      * strictly follow the standard (MPEG-4, ...).
2956      * - encoding: Set by user.
2957      * - decoding: Set by user.
2958      * Setting this to STRICT or higher means the encoder and decoder will
2959      * generally do stupid things, whereas setting it to unofficial or lower
2960      * will mean the encoder might produce output that is not supported by all
2961      * spec-compliant decoders. Decoders don't differentiate between normal,
2962      * unofficial and experimental (that is, they always try to decode things
2963      * when they can) unless they are explicitly asked to behave stupidly
2964      * (=strictly conform to the specs)
2965      */
2966     int strict_std_compliance;
2967 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2968 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2969 #define FF_COMPLIANCE_NORMAL        0
2970 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2971 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2972
2973     /**
2974      * error concealment flags
2975      * - encoding: unused
2976      * - decoding: Set by user.
2977      */
2978     int error_concealment;
2979 #define FF_EC_GUESS_MVS   1
2980 #define FF_EC_DEBLOCK     2
2981 #define FF_EC_FAVOR_INTER 256
2982
2983     /**
2984      * debug
2985      * - encoding: Set by user.
2986      * - decoding: Set by user.
2987      */
2988     int debug;
2989 #define FF_DEBUG_PICT_INFO   1
2990 #define FF_DEBUG_RC          2
2991 #define FF_DEBUG_BITSTREAM   4
2992 #define FF_DEBUG_MB_TYPE     8
2993 #define FF_DEBUG_QP          16
2994 #if FF_API_DEBUG_MV
2995 /**
2996  * @deprecated this option does nothing
2997  */
2998 #define FF_DEBUG_MV          32
2999 #endif
3000 #define FF_DEBUG_DCT_COEFF   0x00000040
3001 #define FF_DEBUG_SKIP        0x00000080
3002 #define FF_DEBUG_STARTCODE   0x00000100
3003 #if FF_API_UNUSED_MEMBERS
3004 #define FF_DEBUG_PTS         0x00000200
3005 #endif /* FF_API_UNUSED_MEMBERS */
3006 #define FF_DEBUG_ER          0x00000400
3007 #define FF_DEBUG_MMCO        0x00000800
3008 #define FF_DEBUG_BUGS        0x00001000
3009 #if FF_API_DEBUG_MV
3010 #define FF_DEBUG_VIS_QP      0x00002000
3011 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3012 #endif
3013 #define FF_DEBUG_BUFFERS     0x00008000
3014 #define FF_DEBUG_THREADS     0x00010000
3015 #define FF_DEBUG_GREEN_MD    0x00800000
3016 #define FF_DEBUG_NOMC        0x01000000
3017
3018 #if FF_API_DEBUG_MV
3019     /**
3020      * debug
3021      * - encoding: Set by user.
3022      * - decoding: Set by user.
3023      */
3024     int debug_mv;
3025 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
3026 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
3027 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3028 #endif
3029
3030     /**
3031      * Error recognition; may misdetect some more or less valid parts as errors.
3032      * - encoding: unused
3033      * - decoding: Set by user.
3034      */
3035     int err_recognition;
3036
3037 /**
3038  * Verify checksums embedded in the bitstream (could be of either encoded or
3039  * decoded data, depending on the codec) and print an error message on mismatch.
3040  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3041  * decoder returning an error.
3042  */
3043 #define AV_EF_CRCCHECK  (1<<0)
3044 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
3045 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
3046 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
3047
3048 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
3049 #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
3050 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
3051 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
3052
3053
3054     /**
3055      * opaque 64-bit number (generally a PTS) that will be reordered and
3056      * output in AVFrame.reordered_opaque
3057      * - encoding: unused
3058      * - decoding: Set by user.
3059      */
3060     int64_t reordered_opaque;
3061
3062     /**
3063      * Hardware accelerator in use
3064      * - encoding: unused.
3065      * - decoding: Set by libavcodec
3066      */
3067     struct AVHWAccel *hwaccel;
3068
3069     /**
3070      * Hardware accelerator context.
3071      * For some hardware accelerators, a global context needs to be
3072      * provided by the user. In that case, this holds display-dependent
3073      * data FFmpeg cannot instantiate itself. Please refer to the
3074      * FFmpeg HW accelerator documentation to know how to fill this
3075      * is. e.g. for VA API, this is a struct vaapi_context.
3076      * - encoding: unused
3077      * - decoding: Set by user
3078      */
3079     void *hwaccel_context;
3080
3081     /**
3082      * error
3083      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3084      * - decoding: unused
3085      */
3086     uint64_t error[AV_NUM_DATA_POINTERS];
3087
3088     /**
3089      * DCT algorithm, see FF_DCT_* below
3090      * - encoding: Set by user.
3091      * - decoding: unused
3092      */
3093     int dct_algo;
3094 #define FF_DCT_AUTO    0
3095 #define FF_DCT_FASTINT 1
3096 #define FF_DCT_INT     2
3097 #define FF_DCT_MMX     3
3098 #define FF_DCT_ALTIVEC 5
3099 #define FF_DCT_FAAN    6
3100
3101     /**
3102      * IDCT algorithm, see FF_IDCT_* below.
3103      * - encoding: Set by user.
3104      * - decoding: Set by user.
3105      */
3106     int idct_algo;
3107 #define FF_IDCT_AUTO          0
3108 #define FF_IDCT_INT           1
3109 #define FF_IDCT_SIMPLE        2
3110 #define FF_IDCT_SIMPLEMMX     3
3111 #define FF_IDCT_ARM           7
3112 #define FF_IDCT_ALTIVEC       8
3113 #if FF_API_ARCH_SH4
3114 #define FF_IDCT_SH4           9
3115 #endif
3116 #define FF_IDCT_SIMPLEARM     10
3117 #if FF_API_UNUSED_MEMBERS
3118 #define FF_IDCT_IPP           13
3119 #endif /* FF_API_UNUSED_MEMBERS */
3120 #define FF_IDCT_XVID          14
3121 #if FF_API_IDCT_XVIDMMX
3122 #define FF_IDCT_XVIDMMX       14
3123 #endif /* FF_API_IDCT_XVIDMMX */
3124 #define FF_IDCT_SIMPLEARMV5TE 16
3125 #define FF_IDCT_SIMPLEARMV6   17
3126 #if FF_API_ARCH_SPARC
3127 #define FF_IDCT_SIMPLEVIS     18
3128 #endif
3129 #define FF_IDCT_FAAN          20
3130 #define FF_IDCT_SIMPLENEON    22
3131 #if FF_API_ARCH_ALPHA
3132 #define FF_IDCT_SIMPLEALPHA   23
3133 #endif
3134 #define FF_IDCT_NONE          24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
3135 #define FF_IDCT_SIMPLEAUTO    128
3136
3137     /**
3138      * bits per sample/pixel from the demuxer (needed for huffyuv).
3139      * - encoding: Set by libavcodec.
3140      * - decoding: Set by user.
3141      */
3142      int bits_per_coded_sample;
3143
3144     /**
3145      * Bits per sample/pixel of internal libavcodec pixel/sample format.
3146      * - encoding: set by user.
3147      * - decoding: set by libavcodec.
3148      */
3149     int bits_per_raw_sample;
3150
3151 #if FF_API_LOWRES
3152     /**
3153      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3154      * - encoding: unused
3155      * - decoding: Set by user.
3156      */
3157      int lowres;
3158 #endif
3159
3160 #if FF_API_CODED_FRAME
3161     /**
3162      * the picture in the bitstream
3163      * - encoding: Set by libavcodec.
3164      * - decoding: unused
3165      *
3166      * @deprecated use the quality factor packet side data instead
3167      */
3168     attribute_deprecated AVFrame *coded_frame;
3169 #endif
3170
3171     /**
3172      * thread count
3173      * is used to decide how many independent tasks should be passed to execute()
3174      * - encoding: Set by user.
3175      * - decoding: Set by user.
3176      */
3177     int thread_count;
3178
3179     /**
3180      * Which multithreading methods to use.
3181      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3182      * so clients which cannot provide future frames should not use it.
3183      *
3184      * - encoding: Set by user, otherwise the default is used.
3185      * - decoding: Set by user, otherwise the default is used.
3186      */
3187     int thread_type;
3188 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
3189 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
3190
3191     /**
3192      * Which multithreading methods are in use by the codec.
3193      * - encoding: Set by libavcodec.
3194      * - decoding: Set by libavcodec.
3195      */
3196     int active_thread_type;
3197
3198     /**
3199      * Set by the client if its custom get_buffer() callback can be called
3200      * synchronously from another thread, which allows faster multithreaded decoding.
3201      * draw_horiz_band() will be called from other threads regardless of this setting.
3202      * Ignored if the default get_buffer() is used.
3203      * - encoding: Set by user.
3204      * - decoding: Set by user.
3205      */
3206     int thread_safe_callbacks;
3207
3208     /**
3209      * The codec may call this to execute several independent things.
3210      * It will return only after finishing all tasks.
3211      * The user may replace this with some multithreaded implementation,
3212      * the default implementation will execute the parts serially.
3213      * @param count the number of things to execute
3214      * - encoding: Set by libavcodec, user can override.
3215      * - decoding: Set by libavcodec, user can override.
3216      */
3217     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3218
3219     /**
3220      * The codec may call this to execute several independent things.
3221      * It will return only after finishing all tasks.
3222      * The user may replace this with some multithreaded implementation,
3223      * the default implementation will execute the parts serially.
3224      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3225      * @param c context passed also to func
3226      * @param count the number of things to execute
3227      * @param arg2 argument passed unchanged to func
3228      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3229      * @param func function that will be called count times, with jobnr from 0 to count-1.
3230      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3231      *             two instances of func executing at the same time will have the same threadnr.
3232      * @return always 0 currently, but code should handle a future improvement where when any call to func
3233      *         returns < 0 no further calls to func may be done and < 0 is returned.
3234      * - encoding: Set by libavcodec, user can override.
3235      * - decoding: Set by libavcodec, user can override.
3236      */
3237     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3238
3239     /**
3240      * noise vs. sse weight for the nsse comparison function
3241      * - encoding: Set by user.
3242      * - decoding: unused
3243      */
3244      int nsse_weight;
3245
3246     /**
3247      * profile
3248      * - encoding: Set by user.
3249      * - decoding: Set by libavcodec.
3250      */
3251      int profile;
3252 #define FF_PROFILE_UNKNOWN -99
3253 #define FF_PROFILE_RESERVED -100
3254
3255 #define FF_PROFILE_AAC_MAIN 0
3256 #define FF_PROFILE_AAC_LOW  1
3257 #define FF_PROFILE_AAC_SSR  2
3258 #define FF_PROFILE_AAC_LTP  3
3259 #define FF_PROFILE_AAC_HE   4
3260 #define FF_PROFILE_AAC_HE_V2 28
3261 #define FF_PROFILE_AAC_LD   22
3262 #define FF_PROFILE_AAC_ELD  38
3263 #define FF_PROFILE_MPEG2_AAC_LOW 128
3264 #define FF_PROFILE_MPEG2_AAC_HE  131
3265
3266 #define FF_PROFILE_DNXHD         0
3267 #define FF_PROFILE_DNXHR_LB      1
3268 #define FF_PROFILE_DNXHR_SQ      2
3269 #define FF_PROFILE_DNXHR_HQ      3
3270 #define FF_PROFILE_DNXHR_HQX     4
3271 #define FF_PROFILE_DNXHR_444     5
3272
3273 #define FF_PROFILE_DTS         20
3274 #define FF_PROFILE_DTS_ES      30
3275 #define FF_PROFILE_DTS_96_24   40
3276 #define FF_PROFILE_DTS_HD_HRA  50
3277 #define FF_PROFILE_DTS_HD_MA   60
3278 #define FF_PROFILE_DTS_EXPRESS 70
3279
3280 #define FF_PROFILE_MPEG2_422    0
3281 #define FF_PROFILE_MPEG2_HIGH   1
3282 #define FF_PROFILE_MPEG2_SS     2
3283 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3284 #define FF_PROFILE_MPEG2_MAIN   4
3285 #define FF_PROFILE_MPEG2_SIMPLE 5
3286
3287 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3288 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3289
3290 #define FF_PROFILE_H264_BASELINE             66
3291 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3292 #define FF_PROFILE_H264_MAIN                 77
3293 #define FF_PROFILE_H264_EXTENDED             88
3294 #define FF_PROFILE_H264_HIGH                 100
3295 #define FF_PROFILE_H264_HIGH_10              110
3296 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3297 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
3298 #define FF_PROFILE_H264_HIGH_422             122
3299 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3300 #define FF_PROFILE_H264_STEREO_HIGH          128
3301 #define FF_PROFILE_H264_HIGH_444             144
3302 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3303 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3304 #define FF_PROFILE_H264_CAVLC_444            44
3305
3306 #define FF_PROFILE_VC1_SIMPLE   0
3307 #define FF_PROFILE_VC1_MAIN     1
3308 #define FF_PROFILE_VC1_COMPLEX  2
3309 #define FF_PROFILE_VC1_ADVANCED 3
3310
3311 #define FF_PROFILE_MPEG4_SIMPLE                     0
3312 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3313 #define FF_PROFILE_MPEG4_CORE                       2
3314 #define FF_PROFILE_MPEG4_MAIN                       3
3315 #define FF_PROFILE_MPEG4_N_BIT                      4
3316 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3317 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3318 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3319 #define FF_PROFILE_MPEG4_HYBRID                     8
3320 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3321 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3322 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3323 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3324 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3325 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3326 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3327
3328 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
3329 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
3330 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
3331 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3332 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3333
3334 #define FF_PROFILE_VP9_0                            0
3335 #define FF_PROFILE_VP9_1                            1
3336 #define FF_PROFILE_VP9_2                            2
3337 #define FF_PROFILE_VP9_3                            3
3338
3339 #define FF_PROFILE_HEVC_MAIN                        1
3340 #define FF_PROFILE_HEVC_MAIN_10                     2
3341 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3342 #define FF_PROFILE_HEVC_REXT                        4
3343
3344     /**
3345      * level
3346      * - encoding: Set by user.
3347      * - decoding: Set by libavcodec.
3348      */
3349      int level;
3350 #define FF_LEVEL_UNKNOWN -99
3351
3352     /**
3353      * Skip loop filtering for selected frames.
3354      * - encoding: unused
3355      * - decoding: Set by user.
3356      */
3357     enum AVDiscard skip_loop_filter;
3358
3359     /**
3360      * Skip IDCT/dequantization for selected frames.
3361      * - encoding: unused
3362      * - decoding: Set by user.
3363      */
3364     enum AVDiscard skip_idct;
3365
3366     /**
3367      * Skip decoding for selected frames.
3368      * - encoding: unused
3369      * - decoding: Set by user.
3370      */
3371     enum AVDiscard skip_frame;
3372
3373     /**
3374      * Header containing style information for text subtitles.
3375      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3376      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3377      * the Format line following. It shouldn't include any Dialogue line.
3378      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3379      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3380      */
3381     uint8_t *subtitle_header;
3382     int subtitle_header_size;
3383
3384 #if FF_API_ERROR_RATE
3385     /**
3386      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3387      * encoders
3388      */
3389     attribute_deprecated
3390     int error_rate;
3391 #endif
3392
3393 #if FF_API_VBV_DELAY
3394     /**
3395      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3396      * Used for compliant TS muxing.
3397      * - encoding: Set by libavcodec.
3398      * - decoding: unused.
3399      * @deprecated this value is now exported as a part of
3400      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3401      */
3402     attribute_deprecated
3403     uint64_t vbv_delay;
3404 #endif
3405
3406 #if FF_API_SIDEDATA_ONLY_PKT
3407     /**
3408      * Encoding only and set by default. Allow encoders to output packets
3409      * that do not contain any encoded data, only side data.
3410      *
3411      * Some encoders need to output such packets, e.g. to update some stream
3412      * parameters at the end of encoding.
3413      *
3414      * @deprecated this field disables the default behaviour and
3415      *             it is kept only for compatibility.
3416      */
3417     attribute_deprecated
3418     int side_data_only_packets;
3419 #endif
3420
3421     /**
3422      * Audio only. The number of "priming" samples (padding) inserted by the
3423      * encoder at the beginning of the audio. I.e. this number of leading
3424      * decoded samples must be discarded by the caller to get the original audio
3425      * without leading padding.
3426      *
3427      * - decoding: unused
3428      * - encoding: Set by libavcodec. The timestamps on the output packets are
3429      *             adjusted by the encoder so that they always refer to the
3430      *             first sample of the data actually contained in the packet,
3431      *             including any added padding.  E.g. if the timebase is
3432      *             1/samplerate and the timestamp of the first input sample is
3433      *             0, the timestamp of the first output packet will be
3434      *             -initial_padding.
3435      */
3436     int initial_padding;
3437
3438     /**
3439      * - decoding: For codecs that store a framerate value in the compressed
3440      *             bitstream, the decoder may export it here. { 0, 1} when
3441      *             unknown.
3442      * - encoding: May be used to signal the framerate of CFR content to an
3443      *             encoder.
3444      */
3445     AVRational framerate;
3446
3447     /**
3448      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3449      * - encoding: unused.
3450      * - decoding: Set by libavcodec before calling get_format()
3451      */
3452     enum AVPixelFormat sw_pix_fmt;
3453
3454     /**
3455      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3456      * - encoding unused.
3457      * - decoding set by user.
3458      */
3459     AVRational pkt_timebase;
3460
3461     /**
3462      * AVCodecDescriptor
3463      * - encoding: unused.
3464      * - decoding: set by libavcodec.
3465      */
3466     const AVCodecDescriptor *codec_descriptor;
3467
3468 #if !FF_API_LOWRES
3469     /**
3470      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3471      * - encoding: unused
3472      * - decoding: Set by user.
3473      */
3474      int lowres;
3475 #endif
3476
3477     /**
3478      * Current statistics for PTS correction.
3479      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3480      * - encoding: unused
3481      */
3482     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3483     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3484     int64_t pts_correction_last_pts;       /// PTS of the last frame
3485     int64_t pts_correction_last_dts;       /// DTS of the last frame
3486
3487     /**
3488      * Character encoding of the input subtitles file.
3489      * - decoding: set by user
3490      * - encoding: unused
3491      */
3492     char *sub_charenc;
3493
3494     /**
3495      * Subtitles character encoding mode. Formats or codecs might be adjusting
3496      * this setting (if they are doing the conversion themselves for instance).
3497      * - decoding: set by libavcodec
3498      * - encoding: unused
3499      */
3500     int sub_charenc_mode;
3501 #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)
3502 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3503 #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
3504
3505     /**
3506      * Skip processing alpha if supported by codec.
3507      * Note that if the format uses pre-multiplied alpha (common with VP6,
3508      * and recommended due to better video quality/compression)
3509      * the image will look as if alpha-blended onto a black background.
3510      * However for formats that do not use pre-multiplied alpha
3511      * there might be serious artefacts (though e.g. libswscale currently
3512      * assumes pre-multiplied alpha anyway).
3513      *
3514      * - decoding: set by user
3515      * - encoding: unused
3516      */
3517     int skip_alpha;
3518
3519     /**
3520      * Number of samples to skip after a discontinuity
3521      * - decoding: unused
3522      * - encoding: set by libavcodec
3523      */
3524     int seek_preroll;
3525
3526 #if !FF_API_DEBUG_MV
3527     /**
3528      * debug motion vectors
3529      * - encoding: Set by user.
3530      * - decoding: Set by user.
3531      */
3532     int debug_mv;
3533 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3534 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3535 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3536 #endif
3537
3538     /**
3539      * custom intra quantization matrix
3540      * - encoding: Set by user, can be NULL.
3541      * - decoding: unused.
3542      */
3543     uint16_t *chroma_intra_matrix;
3544
3545     /**
3546      * dump format separator.
3547      * can be ", " or "\n      " or anything else
3548      * - encoding: Set by user.
3549      * - decoding: Set by user.
3550      */
3551     uint8_t *dump_separator;
3552
3553     /**
3554      * ',' separated list of allowed decoders.
3555      * If NULL then all are allowed
3556      * - encoding: unused
3557      * - decoding: set by user
3558      */
3559     char *codec_whitelist;
3560
3561     /**
3562      * Properties of the stream that gets decoded
3563      * - encoding: unused
3564      * - decoding: set by libavcodec
3565      */
3566     unsigned properties;
3567 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3568 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3569
3570     /**
3571      * Additional data associated with the entire coded stream.
3572      *
3573      * - decoding: unused
3574      * - encoding: may be set by libavcodec after avcodec_open2().
3575      */
3576     AVPacketSideData *coded_side_data;
3577     int            nb_coded_side_data;
3578
3579     /**
3580      * A reference to the AVHWFramesContext describing the input (for encoding)
3581      * or output (decoding) frames. The reference is set by the caller and
3582      * afterwards owned (and freed) by libavcodec - it should never be read by
3583      * the caller after being set.
3584      *
3585      * - decoding: This field should be set by the caller from the get_format()
3586      *             callback. The previous reference (if any) will always be
3587      *             unreffed by libavcodec before the get_format() call.
3588      *
3589      *             If the default get_buffer2() is used with a hwaccel pixel
3590      *             format, then this AVHWFramesContext will be used for
3591      *             allocating the frame buffers.
3592      *
3593      * - encoding: For hardware encoders configured to use a hwaccel pixel
3594      *             format, this field should be set by the caller to a reference
3595      *             to the AVHWFramesContext describing input frames.
3596      *             AVHWFramesContext.format must be equal to
3597      *             AVCodecContext.pix_fmt.
3598      *
3599      *             This field should be set before avcodec_open2() is called.
3600      */
3601     AVBufferRef *hw_frames_ctx;
3602
3603     /**
3604      * Control the form of AVSubtitle.rects[N]->ass
3605      * - decoding: set by user
3606      * - encoding: unused
3607      */
3608     int sub_text_format;
3609 #define FF_SUB_TEXT_FMT_ASS              0
3610 #if FF_API_ASS_TIMING
3611 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3612 #endif
3613
3614     /**
3615      * Audio only. The amount of padding (in samples) appended by the encoder to
3616      * the end of the audio. I.e. this number of decoded samples must be
3617      * discarded by the caller from the end of the stream to get the original
3618      * audio without any trailing padding.
3619      *
3620      * - decoding: unused
3621      * - encoding: unused
3622      */
3623     int trailing_padding;
3624
3625     /**
3626      * The number of pixels per image to maximally accept.
3627      *
3628      * - decoding: set by user
3629      * - encoding: set by user
3630      */
3631     int64_t max_pixels;
3632
3633     /**
3634      * A reference to the AVHWDeviceContext describing the device which will
3635      * be used by a hardware encoder/decoder.  The reference is set by the
3636      * caller and afterwards owned (and freed) by libavcodec.
3637      *
3638      * This should be used if either the codec device does not require
3639      * hardware frames or any that are used are to be allocated internally by
3640      * libavcodec.  If the user wishes to supply any of the frames used as
3641      * encoder input or decoder output then hw_frames_ctx should be used
3642      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3643      * field will be ignored while decoding the associated stream segment, but
3644      * may again be used on a following one after another get_format() call.
3645      *
3646      * For both encoders and decoders this field should be set before
3647      * avcodec_open2() is called and must not be written to thereafter.
3648      *
3649      * Note that some decoders may require this field to be set initially in
3650      * order to support hw_frames_ctx at all - in that case, all frames
3651      * contexts used must be created on the same device.
3652      */
3653     AVBufferRef *hw_device_ctx;
3654
3655     /**
3656      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3657      * decoding (if active).
3658      * - encoding: unused
3659      * - decoding: Set by user (either before avcodec_open2(), or in the
3660      *             AVCodecContext.get_format callback)
3661      */
3662     int hwaccel_flags;
3663
3664     /**
3665      * Video decoding only. Certain video codecs support cropping, meaning that
3666      * only a sub-rectangle of the decoded frame is intended for display.  This
3667      * option controls how cropping is handled by libavcodec.
3668      *
3669      * When set to 1 (the default), libavcodec will apply cropping internally.
3670      * I.e. it will modify the output frame width/height fields and offset the
3671      * data pointers (only by as much as possible while preserving alignment, or
3672      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3673      * the frames output by the decoder refer only to the cropped area. The
3674      * crop_* fields of the output frames will be zero.
3675      *
3676      * When set to 0, the width/height fields of the output frames will be set
3677      * to the coded dimensions and the crop_* fields will describe the cropping
3678      * rectangle. Applying the cropping is left to the caller.
3679      *
3680      * @warning When hardware acceleration with opaque output frames is used,
3681      * libavcodec is unable to apply cropping from the top/left border.
3682      *
3683      * @note when this option is set to zero, the width/height fields of the
3684      * AVCodecContext and output AVFrames have different meanings. The codec
3685      * context fields store display dimensions (with the coded dimensions in
3686      * coded_width/height), while the frame fields store the coded dimensions
3687      * (with the display dimensions being determined by the crop_* fields).
3688      */
3689     int apply_cropping;
3690 } AVCodecContext;
3691
3692 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3693 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3694
3695 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3696 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3697
3698 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3699
3700 int  av_codec_get_lowres(const AVCodecContext *avctx);
3701 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3702
3703 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3704 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3705
3706 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3707 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3708
3709 /**
3710  * AVProfile.
3711  */
3712 typedef struct AVProfile {
3713     int profile;
3714     const char *name; ///< short name for the profile
3715 } AVProfile;
3716
3717 typedef struct AVCodecDefault AVCodecDefault;
3718
3719 struct AVSubtitle;
3720
3721 /**
3722  * AVCodec.
3723  */
3724 typedef struct AVCodec {
3725     /**
3726      * Name of the codec implementation.
3727      * The name is globally unique among encoders and among decoders (but an
3728      * encoder and a decoder can share the same name).
3729      * This is the primary way to find a codec from the user perspective.
3730      */
3731     const char *name;
3732     /**
3733      * Descriptive name for the codec, meant to be more human readable than name.
3734      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3735      */
3736     const char *long_name;
3737     enum AVMediaType type;
3738     enum AVCodecID id;
3739     /**
3740      * Codec capabilities.
3741      * see AV_CODEC_CAP_*
3742      */
3743     int capabilities;
3744     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3745     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3746     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3747     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3748     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3749     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3750     const AVClass *priv_class;              ///< AVClass for the private context
3751     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3752
3753     /*****************************************************************
3754      * No fields below this line are part of the public API. They
3755      * may not be used outside of libavcodec and can be changed and
3756      * removed at will.
3757      * New public fields should be added right above.
3758      *****************************************************************
3759      */
3760     int priv_data_size;
3761     struct AVCodec *next;
3762     /**
3763      * @name Frame-level threading support functions
3764      * @{
3765      */
3766     /**
3767      * If defined, called on thread contexts when they are created.
3768      * If the codec allocates writable tables in init(), re-allocate them here.
3769      * priv_data will be set to a copy of the original.
3770      */
3771     int (*init_thread_copy)(AVCodecContext *);
3772     /**
3773      * Copy necessary context variables from a previous thread context to the current one.
3774      * If not defined, the next thread will start automatically; otherwise, the codec
3775      * must call ff_thread_finish_setup().
3776      *
3777      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3778      */
3779     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3780     /** @} */
3781
3782     /**
3783      * Private codec-specific defaults.
3784      */
3785     const AVCodecDefault *defaults;
3786
3787     /**
3788      * Initialize codec static data, called from avcodec_register().
3789      */
3790     void (*init_static_data)(struct AVCodec *codec);
3791
3792     int (*init)(AVCodecContext *);
3793     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3794                       const struct AVSubtitle *sub);
3795     /**
3796      * Encode data to an AVPacket.
3797      *
3798      * @param      avctx          codec context
3799      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3800      * @param[in]  frame          AVFrame containing the raw data to be encoded
3801      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3802      *                            non-empty packet was returned in avpkt.
3803      * @return 0 on success, negative error code on failure
3804      */
3805     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3806                    int *got_packet_ptr);
3807     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3808     int (*close)(AVCodecContext *);
3809     /**
3810      * Encode API with decoupled packet/frame dataflow. The API is the
3811      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3812      * that:
3813      * - never called if the codec is closed or the wrong type,
3814      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3815      * - only one drain frame is ever passed down,
3816      */
3817     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3818     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3819
3820     /**
3821      * Decode API with decoupled packet/frame dataflow. This function is called
3822      * to get one output frame. It should call ff_decode_get_packet() to obtain
3823      * input data.
3824      */
3825     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3826     /**
3827      * Flush buffers.
3828      * Will be called when seeking
3829      */
3830     void (*flush)(AVCodecContext *);
3831     /**
3832      * Internal codec capabilities.
3833      * See FF_CODEC_CAP_* in internal.h
3834      */
3835     int caps_internal;
3836
3837     /**
3838      * Decoding only, a comma-separated list of bitstream filters to apply to
3839      * packets before decoding.
3840      */
3841     const char *bsfs;
3842 } AVCodec;
3843
3844 int av_codec_get_max_lowres(const AVCodec *codec);
3845
3846 struct MpegEncContext;
3847
3848 /**
3849  * @defgroup lavc_hwaccel AVHWAccel
3850  * @{
3851  */
3852 typedef struct AVHWAccel {
3853     /**
3854      * Name of the hardware accelerated codec.
3855      * The name is globally unique among encoders and among decoders (but an
3856      * encoder and a decoder can share the same name).
3857      */
3858     const char *name;
3859
3860     /**
3861      * Type of codec implemented by the hardware accelerator.
3862      *
3863      * See AVMEDIA_TYPE_xxx
3864      */
3865     enum AVMediaType type;
3866
3867     /**
3868      * Codec implemented by the hardware accelerator.
3869      *
3870      * See AV_CODEC_ID_xxx
3871      */
3872     enum AVCodecID id;
3873
3874     /**
3875      * Supported pixel format.
3876      *
3877      * Only hardware accelerated formats are supported here.
3878      */
3879     enum AVPixelFormat pix_fmt;
3880
3881     /**
3882      * Hardware accelerated codec capabilities.
3883      * see AV_HWACCEL_CODEC_CAP_*
3884      */
3885     int capabilities;
3886
3887     /*****************************************************************
3888      * No fields below this line are part of the public API. They
3889      * may not be used outside of libavcodec and can be changed and
3890      * removed at will.
3891      * New public fields should be added right above.
3892      *****************************************************************
3893      */
3894     struct AVHWAccel *next;
3895
3896     /**
3897      * Allocate a custom buffer
3898      */
3899     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3900
3901     /**
3902      * Called at the beginning of each frame or field picture.
3903      *
3904      * Meaningful frame information (codec specific) is guaranteed to
3905      * be parsed at this point. This function is mandatory.
3906      *
3907      * Note that buf can be NULL along with buf_size set to 0.
3908      * Otherwise, this means the whole frame is available at this point.
3909      *
3910      * @param avctx the codec context
3911      * @param buf the frame data buffer base
3912      * @param buf_size the size of the frame in bytes
3913      * @return zero if successful, a negative value otherwise
3914      */
3915     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3916
3917     /**
3918      * Callback for each slice.
3919      *
3920      * Meaningful slice information (codec specific) is guaranteed to
3921      * be parsed at this point. This function is mandatory.
3922      * The only exception is XvMC, that works on MB level.
3923      *
3924      * @param avctx the codec context
3925      * @param buf the slice data buffer base
3926      * @param buf_size the size of the slice in bytes
3927      * @return zero if successful, a negative value otherwise
3928      */
3929     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3930
3931     /**
3932      * Called at the end of each frame or field picture.
3933      *
3934      * The whole picture is parsed at this point and can now be sent
3935      * to the hardware accelerator. This function is mandatory.
3936      *
3937      * @param avctx the codec context
3938      * @return zero if successful, a negative value otherwise
3939      */
3940     int (*end_frame)(AVCodecContext *avctx);
3941
3942     /**
3943      * Size of per-frame hardware accelerator private data.
3944      *
3945      * Private data is allocated with av_mallocz() before
3946      * AVCodecContext.get_buffer() and deallocated after
3947      * AVCodecContext.release_buffer().
3948      */
3949     int frame_priv_data_size;
3950
3951     /**
3952      * Called for every Macroblock in a slice.
3953      *
3954      * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3955      * Instead of decoding to raw picture, MB parameters are
3956      * stored in an array provided by the video driver.
3957      *
3958      * @param s the mpeg context
3959      */
3960     void (*decode_mb)(struct MpegEncContext *s);
3961
3962     /**
3963      * Initialize the hwaccel private data.
3964      *
3965      * This will be called from ff_get_format(), after hwaccel and
3966      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3967      * is allocated.
3968      */
3969     int (*init)(AVCodecContext *avctx);
3970
3971     /**
3972      * Uninitialize the hwaccel private data.
3973      *
3974      * This will be called from get_format() or avcodec_close(), after hwaccel
3975      * and hwaccel_context are already uninitialized.
3976      */
3977     int (*uninit)(AVCodecContext *avctx);
3978
3979     /**
3980      * Size of the private data to allocate in
3981      * AVCodecInternal.hwaccel_priv_data.
3982      */
3983     int priv_data_size;
3984
3985     /**
3986      * Internal hwaccel capabilities.
3987      */
3988     int caps_internal;
3989 } AVHWAccel;
3990
3991 /**
3992  * HWAccel is experimental and is thus avoided in favor of non experimental
3993  * codecs
3994  */
3995 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3996
3997 /**
3998  * Hardware acceleration should be used for decoding even if the codec level
3999  * used is unknown or higher than the maximum supported level reported by the
4000  * hardware driver.
4001  *
4002  * It's generally a good idea to pass this flag unless you have a specific
4003  * reason not to, as hardware tends to under-report supported levels.
4004  */
4005 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
4006
4007 /**
4008  * Hardware acceleration can output YUV pixel formats with a different chroma
4009  * sampling than 4:2:0 and/or other than 8 bits per component.
4010  */
4011 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4012
4013 /**
4014  * Hardware acceleration should still be attempted for decoding when the
4015  * codec profile does not match the reported capabilities of the hardware.
4016  *
4017  * For example, this can be used to try to decode baseline profile H.264
4018  * streams in hardware - it will often succeed, because many streams marked
4019  * as baseline profile actually conform to constrained baseline profile.
4020  *
4021  * @warning If the stream is actually not supported then the behaviour is
4022  *          undefined, and may include returning entirely incorrect output
4023  *          while indicating success.
4024  */
4025 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4026
4027 /**
4028  * @}
4029  */
4030
4031 #if FF_API_AVPICTURE
4032 /**
4033  * @defgroup lavc_picture AVPicture
4034  *
4035  * Functions for working with AVPicture
4036  * @{
4037  */
4038
4039 /**
4040  * Picture data structure.
4041  *
4042  * Up to four components can be stored into it, the last component is
4043  * alpha.
4044  * @deprecated use AVFrame or imgutils functions instead
4045  */
4046 typedef struct AVPicture {
4047     attribute_deprecated
4048     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
4049     attribute_deprecated
4050     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
4051 } AVPicture;
4052
4053 /**
4054  * @}
4055  */
4056 #endif
4057
4058 enum AVSubtitleType {
4059     SUBTITLE_NONE,
4060
4061     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
4062
4063     /**
4064      * Plain text, the text field must be set by the decoder and is
4065      * authoritative. ass and pict fields may contain approximations.
4066      */
4067     SUBTITLE_TEXT,
4068
4069     /**
4070      * Formatted text, the ass field must be set by the decoder and is
4071      * authoritative. pict and text fields may contain approximations.
4072      */
4073     SUBTITLE_ASS,
4074 };
4075
4076 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4077
4078 typedef struct AVSubtitleRect {
4079     int x;         ///< top left corner  of pict, undefined when pict is not set
4080     int y;         ///< top left corner  of pict, undefined when pict is not set
4081     int w;         ///< width            of pict, undefined when pict is not set
4082     int h;         ///< height           of pict, undefined when pict is not set
4083     int nb_colors; ///< number of colors in pict, undefined when pict is not set
4084
4085 #if FF_API_AVPICTURE
4086     /**
4087      * @deprecated unused
4088      */
4089     attribute_deprecated
4090     AVPicture pict;
4091 #endif
4092     /**
4093      * data+linesize for the bitmap of this subtitle.
4094      * Can be set for text/ass as well once they are rendered.
4095      */
4096     uint8_t *data[4];
4097     int linesize[4];
4098
4099     enum AVSubtitleType type;
4100
4101     char *text;                     ///< 0 terminated plain UTF-8 text
4102
4103     /**
4104      * 0 terminated ASS/SSA compatible event line.
4105      * The presentation of this is unaffected by the other values in this
4106      * struct.
4107      */
4108     char *ass;
4109
4110     int flags;
4111 } AVSubtitleRect;
4112
4113 typedef struct AVSubtitle {
4114     uint16_t format; /* 0 = graphics */
4115     uint32_t start_display_time; /* relative to packet pts, in ms */
4116     uint32_t end_display_time; /* relative to packet pts, in ms */
4117     unsigned num_rects;
4118     AVSubtitleRect **rects;
4119     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
4120 } AVSubtitle;
4121
4122 /**
4123  * This struct describes the properties of an encoded stream.
4124  *
4125  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4126  * be allocated with avcodec_parameters_alloc() and freed with
4127  * avcodec_parameters_free().
4128  */
4129 typedef struct AVCodecParameters {
4130     /**
4131      * General type of the encoded data.
4132      */
4133     enum AVMediaType codec_type;
4134     /**
4135      * Specific type of the encoded data (the codec used).
4136      */
4137     enum AVCodecID   codec_id;
4138     /**
4139      * Additional information about the codec (corresponds to the AVI FOURCC).
4140      */
4141     uint32_t         codec_tag;
4142
4143     /**
4144      * Extra binary data needed for initializing the decoder, codec-dependent.
4145      *
4146      * Must be allocated with av_malloc() and will be freed by
4147      * avcodec_parameters_free(). The allocated size of extradata must be at
4148      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4149      * bytes zeroed.
4150      */
4151     uint8_t *extradata;
4152     /**
4153      * Size of the extradata content in bytes.
4154      */
4155     int      extradata_size;
4156
4157     /**
4158      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4159      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4160      */
4161     int format;
4162
4163     /**
4164      * The average bitrate of the encoded data (in bits per second).
4165      */
4166     int64_t bit_rate;
4167
4168     /**
4169      * The number of bits per sample in the codedwords.
4170      *
4171      * This is basically the bitrate per sample. It is mandatory for a bunch of
4172      * formats to actually decode them. It's the number of bits for one sample in
4173      * the actual coded bitstream.
4174      *
4175      * This could be for example 4 for ADPCM
4176      * For PCM formats this matches bits_per_raw_sample
4177      * Can be 0
4178      */
4179     int bits_per_coded_sample;
4180
4181     /**
4182      * This is the number of valid bits in each output sample. If the
4183      * sample format has more bits, the least significant bits are additional
4184      * padding bits, which are always 0. Use right shifts to reduce the sample
4185      * to its actual size. For example, audio formats with 24 bit samples will
4186      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4187      * To get the original sample use "(int32_t)sample >> 8"."
4188      *
4189      * For ADPCM this might be 12 or 16 or similar
4190      * Can be 0
4191      */
4192     int bits_per_raw_sample;
4193
4194     /**
4195      * Codec-specific bitstream restrictions that the stream conforms to.
4196      */
4197     int profile;
4198     int level;
4199
4200     /**
4201      * Video only. The dimensions of the video frame in pixels.
4202      */
4203     int width;
4204     int height;
4205
4206     /**
4207      * Video only. The aspect ratio (width / height) which a single pixel
4208      * should have when displayed.
4209      *
4210      * When the aspect ratio is unknown / undefined, the numerator should be
4211      * set to 0 (the denominator may have any value).
4212      */
4213     AVRational sample_aspect_ratio;
4214
4215     /**
4216      * Video only. The order of the fields in interlaced video.
4217      */
4218     enum AVFieldOrder                  field_order;
4219
4220     /**
4221      * Video only. Additional colorspace characteristics.
4222      */
4223     enum AVColorRange                  color_range;
4224     enum AVColorPrimaries              color_primaries;
4225     enum AVColorTransferCharacteristic color_trc;
4226     enum AVColorSpace                  color_space;
4227     enum AVChromaLocation              chroma_location;
4228
4229     /**
4230      * Video only. Number of delayed frames.
4231      */
4232     int video_delay;
4233
4234     /**
4235      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4236      * unknown or unspecified, otherwise the number of bits set must be equal to
4237      * the channels field.
4238      */
4239     uint64_t channel_layout;
4240     /**
4241      * Audio only. The number of audio channels.
4242      */
4243     int      channels;
4244     /**
4245      * Audio only. The number of audio samples per second.
4246      */
4247     int      sample_rate;
4248     /**
4249      * Audio only. The number of bytes per coded audio frame, required by some
4250      * formats.
4251      *
4252      * Corresponds to nBlockAlign in WAVEFORMATEX.
4253      */
4254     int      block_align;
4255     /**
4256      * Audio only. Audio frame size, if known. Required by some formats to be static.
4257      */
4258     int      frame_size;
4259
4260     /**
4261      * Audio only. The amount of padding (in samples) inserted by the encoder at
4262      * the beginning of the audio. I.e. this number of leading decoded samples
4263      * must be discarded by the caller to get the original audio without leading
4264      * padding.
4265      */
4266     int initial_padding;
4267     /**
4268      * Audio only. The amount of padding (in samples) appended by the encoder to
4269      * the end of the audio. I.e. this number of decoded samples must be
4270      * discarded by the caller from the end of the stream to get the original
4271      * audio without any trailing padding.
4272      */
4273     int trailing_padding;
4274     /**
4275      * Audio only. Number of samples to skip after a discontinuity.
4276      */
4277     int seek_preroll;
4278 } AVCodecParameters;
4279
4280 /**
4281  * If c is NULL, returns the first registered codec,
4282  * if c is non-NULL, returns the next registered codec after c,
4283  * or NULL if c is the last one.
4284  */
4285 AVCodec *av_codec_next(const AVCodec *c);
4286
4287 /**
4288  * Return the LIBAVCODEC_VERSION_INT constant.
4289  */
4290 unsigned avcodec_version(void);
4291
4292 /**
4293  * Return the libavcodec build-time configuration.
4294  */
4295 const char *avcodec_configuration(void);
4296
4297 /**
4298  * Return the libavcodec license.
4299  */
4300 const char *avcodec_license(void);
4301
4302 /**
4303  * Register the codec codec and initialize libavcodec.
4304  *
4305  * @warning either this function or avcodec_register_all() must be called
4306  * before any other libavcodec functions.
4307  *
4308  * @see avcodec_register_all()
4309  */
4310 void avcodec_register(AVCodec *codec);
4311
4312 /**
4313  * Register all the codecs, parsers and bitstream filters which were enabled at
4314  * configuration time. If you do not call this function you can select exactly
4315  * which formats you want to support, by using the individual registration
4316  * functions.
4317  *
4318  * @see avcodec_register
4319  * @see av_register_codec_parser
4320  * @see av_register_bitstream_filter
4321  */
4322 void avcodec_register_all(void);
4323
4324 /**
4325  * Allocate an AVCodecContext and set its fields to default values. The
4326  * resulting struct should be freed with avcodec_free_context().
4327  *
4328  * @param codec if non-NULL, allocate private data and initialize defaults
4329  *              for the given codec. It is illegal to then call avcodec_open2()
4330  *              with a different codec.
4331  *              If NULL, then the codec-specific defaults won't be initialized,
4332  *              which may result in suboptimal default settings (this is
4333  *              important mainly for encoders, e.g. libx264).
4334  *
4335  * @return An AVCodecContext filled with default values or NULL on failure.
4336  */
4337 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4338
4339 /**
4340  * Free the codec context and everything associated with it and write NULL to
4341  * the provided pointer.
4342  */
4343 void avcodec_free_context(AVCodecContext **avctx);
4344
4345 #if FF_API_GET_CONTEXT_DEFAULTS
4346 /**
4347  * @deprecated This function should not be used, as closing and opening a codec
4348  * context multiple time is not supported. A new codec context should be
4349  * allocated for each new use.
4350  */
4351 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4352 #endif
4353
4354 /**
4355  * Get the AVClass for AVCodecContext. It can be used in combination with
4356  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4357  *
4358  * @see av_opt_find().
4359  */
4360 const AVClass *avcodec_get_class(void);
4361
4362 #if FF_API_COPY_CONTEXT
4363 /**
4364  * Get the AVClass for AVFrame. It can be used in combination with
4365  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4366  *
4367  * @see av_opt_find().
4368  */
4369 const AVClass *avcodec_get_frame_class(void);
4370
4371 /**
4372  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4373  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4374  *
4375  * @see av_opt_find().
4376  */
4377 const AVClass *avcodec_get_subtitle_rect_class(void);
4378
4379 /**
4380  * Copy the settings of the source AVCodecContext into the destination
4381  * AVCodecContext. The resulting destination codec context will be
4382  * unopened, i.e. you are required to call avcodec_open2() before you
4383  * can use this AVCodecContext to decode/encode video/audio data.
4384  *
4385  * @param dest target codec context, should be initialized with
4386  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
4387  * @param src source codec context
4388  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4389  *
4390  * @deprecated The semantics of this function are ill-defined and it should not
4391  * be used. If you need to transfer the stream parameters from one codec context
4392  * to another, use an intermediate AVCodecParameters instance and the
4393  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4394  * functions.
4395  */
4396 attribute_deprecated
4397 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4398 #endif
4399
4400 /**
4401  * Allocate a new AVCodecParameters and set its fields to default values
4402  * (unknown/invalid/0). The returned struct must be freed with
4403  * avcodec_parameters_free().
4404  */
4405 AVCodecParameters *avcodec_parameters_alloc(void);
4406
4407 /**
4408  * Free an AVCodecParameters instance and everything associated with it and
4409  * write NULL to the supplied pointer.
4410  */
4411 void avcodec_parameters_free(AVCodecParameters **par);
4412
4413 /**
4414  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4415  * replaced with newly allocated duplicates of the corresponding fields in src.
4416  *
4417  * @return >= 0 on success, a negative AVERROR code on failure.
4418  */
4419 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4420
4421 /**
4422  * Fill the parameters struct based on the values from the supplied codec
4423  * context. Any allocated fields in par are freed and replaced with duplicates
4424  * of the corresponding fields in codec.
4425  *
4426  * @return >= 0 on success, a negative AVERROR code on failure
4427  */
4428 int avcodec_parameters_from_context(AVCodecParameters *par,
4429                                     const AVCodecContext *codec);
4430
4431 /**
4432  * Fill the codec context based on the values from the supplied codec
4433  * parameters. Any allocated fields in codec that have a corresponding field in
4434  * par are freed and replaced with duplicates of the corresponding field in par.
4435  * Fields in codec that do not have a counterpart in par are not touched.
4436  *
4437  * @return >= 0 on success, a negative AVERROR code on failure.
4438  */
4439 int avcodec_parameters_to_context(AVCodecContext *codec,
4440                                   const AVCodecParameters *par);
4441
4442 /**
4443  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4444  * function the context has to be allocated with avcodec_alloc_context3().
4445  *
4446  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4447  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4448  * retrieving a codec.
4449  *
4450  * @warning This function is not thread safe!
4451  *
4452  * @note Always call this function before using decoding routines (such as
4453  * @ref avcodec_receive_frame()).
4454  *
4455  * @code
4456  * avcodec_register_all();
4457  * av_dict_set(&opts, "b", "2.5M", 0);
4458  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4459  * if (!codec)
4460  *     exit(1);
4461  *
4462  * context = avcodec_alloc_context3(codec);
4463  *
4464  * if (avcodec_open2(context, codec, opts) < 0)
4465  *     exit(1);
4466  * @endcode
4467  *
4468  * @param avctx The context to initialize.
4469  * @param codec The codec to open this context for. If a non-NULL codec has been
4470  *              previously passed to avcodec_alloc_context3() or
4471  *              for this context, then this parameter MUST be either NULL or
4472  *              equal to the previously passed codec.
4473  * @param options A dictionary filled with AVCodecContext and codec-private options.
4474  *                On return this object will be filled with options that were not found.
4475  *
4476  * @return zero on success, a negative value on error
4477  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4478  *      av_dict_set(), av_opt_find().
4479  */
4480 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4481
4482 /**
4483  * Close a given AVCodecContext and free all the data associated with it
4484  * (but not the AVCodecContext itself).
4485  *
4486  * Calling this function on an AVCodecContext that hasn't been opened will free
4487  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4488  * codec. Subsequent calls will do nothing.
4489  *
4490  * @note Do not use this function. Use avcodec_free_context() to destroy a
4491  * codec context (either open or closed). Opening and closing a codec context
4492  * multiple times is not supported anymore -- use multiple codec contexts
4493  * instead.
4494  */
4495 int avcodec_close(AVCodecContext *avctx);
4496
4497 /**
4498  * Free all allocated data in the given subtitle struct.
4499  *
4500  * @param sub AVSubtitle to free.
4501  */
4502 void avsubtitle_free(AVSubtitle *sub);
4503
4504 /**
4505  * @}
4506  */
4507
4508 /**
4509  * @addtogroup lavc_packet
4510  * @{
4511  */
4512
4513 /**
4514  * Allocate an AVPacket and set its fields to default values.  The resulting
4515  * struct must be freed using av_packet_free().
4516  *
4517  * @return An AVPacket filled with default values or NULL on failure.
4518  *
4519  * @note this only allocates the AVPacket itself, not the data buffers. Those
4520  * must be allocated through other means such as av_new_packet.
4521  *
4522  * @see av_new_packet
4523  */
4524 AVPacket *av_packet_alloc(void);
4525
4526 /**
4527  * Create a new packet that references the same data as src.
4528  *
4529  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4530  *
4531  * @return newly created AVPacket on success, NULL on error.
4532  *
4533  * @see av_packet_alloc
4534  * @see av_packet_ref
4535  */
4536 AVPacket *av_packet_clone(const AVPacket *src);
4537
4538 /**
4539  * Free the packet, if the packet is reference counted, it will be
4540  * unreferenced first.
4541  *
4542  * @param pkt packet to be freed. The pointer will be set to NULL.
4543  * @note passing NULL is a no-op.
4544  */
4545 void av_packet_free(AVPacket **pkt);
4546
4547 /**
4548  * Initialize optional fields of a packet with default values.
4549  *
4550  * Note, this does not touch the data and size members, which have to be
4551  * initialized separately.
4552  *
4553  * @param pkt packet
4554  */
4555 void av_init_packet(AVPacket *pkt);
4556
4557 /**
4558  * Allocate the payload of a packet and initialize its fields with
4559  * default values.
4560  *
4561  * @param pkt packet
4562  * @param size wanted payload size
4563  * @return 0 if OK, AVERROR_xxx otherwise
4564  */
4565 int av_new_packet(AVPacket *pkt, int size);
4566
4567 /**
4568  * Reduce packet size, correctly zeroing padding
4569  *
4570  * @param pkt packet
4571  * @param size new size
4572  */
4573 void av_shrink_packet(AVPacket *pkt, int size);
4574
4575 /**
4576  * Increase packet size, correctly zeroing padding
4577  *
4578  * @param pkt packet
4579  * @param grow_by number of bytes by which to increase the size of the packet
4580  */
4581 int av_grow_packet(AVPacket *pkt, int grow_by);
4582
4583 /**
4584  * Initialize a reference-counted packet from av_malloc()ed data.
4585  *
4586  * @param pkt packet to be initialized. This function will set the data, size,
4587  *        buf and destruct fields, all others are left untouched.
4588  * @param data Data allocated by av_malloc() to be used as packet data. If this
4589  *        function returns successfully, the data is owned by the underlying AVBuffer.
4590  *        The caller may not access the data through other means.
4591  * @param size size of data in bytes, without the padding. I.e. the full buffer
4592  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4593  *
4594  * @return 0 on success, a negative AVERROR on error
4595  */
4596 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4597
4598 #if FF_API_AVPACKET_OLD_API
4599 /**
4600  * @warning This is a hack - the packet memory allocation stuff is broken. The
4601  * packet is allocated if it was not really allocated.
4602  *
4603  * @deprecated Use av_packet_ref
4604  */
4605 attribute_deprecated
4606 int av_dup_packet(AVPacket *pkt);
4607 /**
4608  * Copy packet, including contents
4609  *
4610  * @return 0 on success, negative AVERROR on fail
4611  *
4612  * @deprecated Use av_packet_ref
4613  */
4614 attribute_deprecated
4615 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4616
4617 /**
4618  * Copy packet side data
4619  *
4620  * @return 0 on success, negative AVERROR on fail
4621  *
4622  * @deprecated Use av_packet_copy_props
4623  */
4624 attribute_deprecated
4625 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4626
4627 /**
4628  * Free a packet.
4629  *
4630  * @deprecated Use av_packet_unref
4631  *
4632  * @param pkt packet to free
4633  */
4634 attribute_deprecated
4635 void av_free_packet(AVPacket *pkt);
4636 #endif
4637 /**
4638  * Allocate new information of a packet.
4639  *
4640  * @param pkt packet
4641  * @param type side information type
4642  * @param size side information size
4643  * @return pointer to fresh allocated data or NULL otherwise
4644  */
4645 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4646                                  int size);
4647
4648 /**
4649  * Wrap an existing array as a packet side data.
4650  *
4651  * @param pkt packet
4652  * @param type side information type
4653  * @param data the side data array. It must be allocated with the av_malloc()
4654  *             family of functions. The ownership of the data is transferred to
4655  *             pkt.
4656  * @param size side information size
4657  * @return a non-negative number on success, a negative AVERROR code on
4658  *         failure. On failure, the packet is unchanged and the data remains
4659  *         owned by the caller.
4660  */
4661 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4662                             uint8_t *data, size_t size);
4663
4664 /**
4665  * Shrink the already allocated side data buffer
4666  *
4667  * @param pkt packet
4668  * @param type side information type
4669  * @param size new side information size
4670  * @return 0 on success, < 0 on failure
4671  */
4672 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4673                                int size);
4674
4675 /**
4676  * Get side information from packet.
4677  *
4678  * @param pkt packet
4679  * @param type desired side information type
4680  * @param size pointer for side information size to store (optional)
4681  * @return pointer to data if present or NULL otherwise
4682  */
4683 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4684                                  int *size);
4685
4686 #if FF_API_MERGE_SD_API
4687 attribute_deprecated
4688 int av_packet_merge_side_data(AVPacket *pkt);
4689
4690 attribute_deprecated
4691 int av_packet_split_side_data(AVPacket *pkt);
4692 #endif
4693
4694 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4695
4696 /**
4697  * Pack a dictionary for use in side_data.
4698  *
4699  * @param dict The dictionary to pack.
4700  * @param size pointer to store the size of the returned data
4701  * @return pointer to data if successful, NULL otherwise
4702  */
4703 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4704 /**
4705  * Unpack a dictionary from side_data.
4706  *
4707  * @param data data from side_data
4708  * @param size size of the data
4709  * @param dict the metadata storage dictionary
4710  * @return 0 on success, < 0 on failure
4711  */
4712 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4713
4714
4715 /**
4716  * Convenience function to free all the side data stored.
4717  * All the other fields stay untouched.
4718  *
4719  * @param pkt packet
4720  */
4721 void av_packet_free_side_data(AVPacket *pkt);
4722
4723 /**
4724  * Setup a new reference to the data described by a given packet
4725  *
4726  * If src is reference-counted, setup dst as a new reference to the
4727  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4728  * data from src into it.
4729  *
4730  * All the other fields are copied from src.
4731  *
4732  * @see av_packet_unref
4733  *
4734  * @param dst Destination packet
4735  * @param src Source packet
4736  *
4737  * @return 0 on success, a negative AVERROR on error.
4738  */
4739 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4740
4741 /**
4742  * Wipe the packet.
4743  *
4744  * Unreference the buffer referenced by the packet and reset the
4745  * remaining packet fields to their default values.
4746  *
4747  * @param pkt The packet to be unreferenced.
4748  */
4749 void av_packet_unref(AVPacket *pkt);
4750
4751 /**
4752  * Move every field in src to dst and reset src.
4753  *
4754  * @see av_packet_unref
4755  *
4756  * @param src Source packet, will be reset
4757  * @param dst Destination packet
4758  */
4759 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4760
4761 /**
4762  * Copy only "properties" fields from src to dst.
4763  *
4764  * Properties for the purpose of this function are all the fields
4765  * beside those related to the packet data (buf, data, size)
4766  *
4767  * @param dst Destination packet
4768  * @param src Source packet
4769  *
4770  * @return 0 on success AVERROR on failure.
4771  */
4772 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4773
4774 /**
4775  * Convert valid timing fields (timestamps / durations) in a packet from one
4776  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4777  * ignored.
4778  *
4779  * @param pkt packet on which the conversion will be performed
4780  * @param tb_src source timebase, in which the timing fields in pkt are
4781  *               expressed
4782  * @param tb_dst destination timebase, to which the timing fields will be
4783  *               converted
4784  */
4785 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4786
4787 /**
4788  * @}
4789  */
4790
4791 /**
4792  * @addtogroup lavc_decoding
4793  * @{
4794  */
4795
4796 /**
4797  * Find a registered decoder with a matching codec ID.
4798  *
4799  * @param id AVCodecID of the requested decoder
4800  * @return A decoder if one was found, NULL otherwise.
4801  */
4802 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4803
4804 /**
4805  * Find a registered decoder with the specified name.
4806  *
4807  * @param name name of the requested decoder
4808  * @return A decoder if one was found, NULL otherwise.
4809  */
4810 AVCodec *avcodec_find_decoder_by_name(const char *name);
4811
4812 /**
4813  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4814  * it can be called by custom get_buffer2() implementations for decoders without
4815  * AV_CODEC_CAP_DR1 set.
4816  */
4817 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4818
4819 #if FF_API_EMU_EDGE
4820 /**
4821  * Return the amount of padding in pixels which the get_buffer callback must
4822  * provide around the edge of the image for codecs which do not have the
4823  * CODEC_FLAG_EMU_EDGE flag.
4824  *
4825  * @return Required padding in pixels.
4826  *
4827  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4828  * needed
4829  */
4830 attribute_deprecated
4831 unsigned avcodec_get_edge_width(void);
4832 #endif
4833
4834 /**
4835  * Modify width and height values so that they will result in a memory
4836  * buffer that is acceptable for the codec if you do not use any horizontal
4837  * padding.
4838  *
4839  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4840  */
4841 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4842
4843 /**
4844  * Modify width and height values so that they will result in a memory
4845  * buffer that is acceptable for the codec if you also ensure that all
4846  * line sizes are a multiple of the respective linesize_align[i].
4847  *
4848  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4849  */
4850 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4851                                int linesize_align[AV_NUM_DATA_POINTERS]);
4852
4853 /**
4854  * Converts AVChromaLocation to swscale x/y chroma position.
4855  *
4856  * The positions represent the chroma (0,0) position in a coordinates system
4857  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4858  *
4859  * @param xpos  horizontal chroma sample position
4860  * @param ypos  vertical   chroma sample position
4861  */
4862 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4863
4864 /**
4865  * Converts swscale x/y chroma position to AVChromaLocation.
4866  *
4867  * The positions represent the chroma (0,0) position in a coordinates system
4868  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4869  *
4870  * @param xpos  horizontal chroma sample position
4871  * @param ypos  vertical   chroma sample position
4872  */
4873 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4874
4875 /**
4876  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4877  *
4878  * Some decoders may support multiple frames in a single AVPacket. Such
4879  * decoders would then just decode the first frame and the return value would be
4880  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4881  * called again with an AVPacket containing the remaining data in order to
4882  * decode the second frame, etc...  Even if no frames are returned, the packet
4883  * needs to be fed to the decoder with remaining data until it is completely
4884  * consumed or an error occurs.
4885  *
4886  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4887  * and output. This means that for some packets they will not immediately
4888  * produce decoded output and need to be flushed at the end of decoding to get
4889  * all the decoded data. Flushing is done by calling this function with packets
4890  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4891  * returning samples. It is safe to flush even those decoders that are not
4892  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4893  *
4894  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4895  *          larger than the actual read bytes because some optimized bitstream
4896  *          readers read 32 or 64 bits at once and could read over the end.
4897  *
4898  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4899  * before packets may be fed to the decoder.
4900  *
4901  * @param      avctx the codec context
4902  * @param[out] frame The AVFrame in which to store decoded audio samples.
4903  *                   The decoder will allocate a buffer for the decoded frame by
4904  *                   calling the AVCodecContext.get_buffer2() callback.
4905  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
4906  *                   reference counted and the returned reference belongs to the
4907  *                   caller. The caller must release the frame using av_frame_unref()
4908  *                   when the frame is no longer needed. The caller may safely write
4909  *                   to the frame if av_frame_is_writable() returns 1.
4910  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
4911  *                   reference belongs to the decoder and is valid only until the
4912  *                   next call to this function or until closing or flushing the
4913  *                   decoder. The caller may not write to it.
4914  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4915  *                           non-zero. Note that this field being set to zero
4916  *                           does not mean that an error has occurred. For
4917  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
4918  *                           call is guaranteed to produce a frame.
4919  * @param[in]  avpkt The input AVPacket containing the input buffer.
4920  *                   At least avpkt->data and avpkt->size should be set. Some
4921  *                   decoders might also require additional fields to be set.
4922  * @return A negative error code is returned if an error occurred during
4923  *         decoding, otherwise the number of bytes consumed from the input
4924  *         AVPacket is returned.
4925  *
4926 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4927  */
4928 attribute_deprecated
4929 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4930                           int *got_frame_ptr, const AVPacket *avpkt);
4931
4932 /**
4933  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4934  * Some decoders may support multiple frames in a single AVPacket, such
4935  * decoders would then just decode the first frame.
4936  *
4937  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4938  * the actual read bytes because some optimized bitstream readers read 32 or 64
4939  * bits at once and could read over the end.
4940  *
4941  * @warning The end of the input buffer buf should be set to 0 to ensure that
4942  * no overreading happens for damaged MPEG streams.
4943  *
4944  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4945  * between input and output, these need to be fed with avpkt->data=NULL,
4946  * avpkt->size=0 at the end to return the remaining frames.
4947  *
4948  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4949  * before packets may be fed to the decoder.
4950  *
4951  * @param avctx the codec context
4952  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4953  *             Use av_frame_alloc() to get an AVFrame. The codec will
4954  *             allocate memory for the actual bitmap by calling the
4955  *             AVCodecContext.get_buffer2() callback.
4956  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
4957  *             reference counted and the returned reference belongs to the
4958  *             caller. The caller must release the frame using av_frame_unref()
4959  *             when the frame is no longer needed. The caller may safely write
4960  *             to the frame if av_frame_is_writable() returns 1.
4961  *             When AVCodecContext.refcounted_frames is set to 0, the returned
4962  *             reference belongs to the decoder and is valid only until the
4963  *             next call to this function or until closing or flushing the
4964  *             decoder. The caller may not write to it.
4965  *
4966  * @param[in] avpkt The input AVPacket containing the input buffer.
4967  *            You can create such packet with av_init_packet() and by then setting
4968  *            data and size, some decoders might in addition need other fields like
4969  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4970  *            fields possible.
4971  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4972  * @return On error a negative value is returned, otherwise the number of bytes
4973  * used or zero if no frame could be decompressed.
4974  *
4975  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4976  */
4977 attribute_deprecated
4978 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4979                          int *got_picture_ptr,
4980                          const AVPacket *avpkt);
4981
4982 /**
4983  * Decode a subtitle message.
4984  * Return a negative value on error, otherwise return the number of bytes used.
4985  * If no subtitle could be decompressed, got_sub_ptr is zero.
4986  * Otherwise, the subtitle is stored in *sub.
4987  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4988  * simplicity, because the performance difference is expect to be negligible
4989  * and reusing a get_buffer written for video codecs would probably perform badly
4990  * due to a potentially very different allocation pattern.
4991  *
4992  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4993  * and output. This means that for some packets they will not immediately
4994  * produce decoded output and need to be flushed at the end of decoding to get
4995  * all the decoded data. Flushing is done by calling this function with packets
4996  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4997  * returning subtitles. It is safe to flush even those decoders that are not
4998  * marked with AV_CODEC_CAP_DELAY, then no subtitles will be returned.
4999  *
5000  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5001  * before packets may be fed to the decoder.
5002  *
5003  * @param avctx the codec context
5004  * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
5005  *                 must be freed with avsubtitle_free if *got_sub_ptr is set.
5006  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
5007  * @param[in] avpkt The input AVPacket containing the input buffer.
5008  */
5009 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
5010                             int *got_sub_ptr,
5011                             AVPacket *avpkt);
5012
5013 /**
5014  * Supply raw packet data as input to a decoder.
5015  *
5016  * Internally, this call will copy relevant AVCodecContext fields, which can
5017  * influence decoding per-packet, and apply them when the packet is actually
5018  * decoded. (For example AVCodecContext.skip_frame, which might direct the
5019  * decoder to drop the frame contained by the packet sent with this function.)
5020  *
5021  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
5022  *          larger than the actual read bytes because some optimized bitstream
5023  *          readers read 32 or 64 bits at once and could read over the end.
5024  *
5025  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
5026  *          on the same AVCodecContext. It will return unexpected results now
5027  *          or in future libavcodec versions.
5028  *
5029  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
5030  *       before packets may be fed to the decoder.
5031  *
5032  * @param avctx codec context
5033  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
5034  *                  frame, or several complete audio frames.
5035  *                  Ownership of the packet remains with the caller, and the
5036  *                  decoder will not write to the packet. The decoder may create
5037  *                  a reference to the packet data (or copy it if the packet is
5038  *                  not reference-counted).
5039  *                  Unlike with older APIs, the packet is always fully consumed,
5040  *                  and if it contains multiple frames (e.g. some audio codecs),
5041  *                  will require you to call avcodec_receive_frame() multiple
5042  *                  times afterwards before you can send a new packet.
5043  *                  It can be NULL (or an AVPacket with data set to NULL and
5044  *                  size set to 0); in this case, it is considered a flush
5045  *                  packet, which signals the end of the stream. Sending the
5046  *                  first flush packet will return success. Subsequent ones are
5047  *                  unnecessary and will return AVERROR_EOF. If the decoder
5048  *                  still has frames buffered, it will return them after sending
5049  *                  a flush packet.
5050  *
5051  * @return 0 on success, otherwise negative error code:
5052  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
5053  *                         must read output with avcodec_receive_frame() (once
5054  *                         all output is read, the packet should be resent, and
5055  *                         the call will not fail with EAGAIN).
5056  *      AVERROR_EOF:       the decoder has been flushed, and no new packets can
5057  *                         be sent to it (also returned if more than 1 flush
5058  *                         packet is sent)
5059  *      AVERROR(EINVAL):   codec not opened, it is an encoder, or requires flush
5060  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
5061  *      other errors: legitimate decoding errors
5062  */
5063 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
5064
5065 /**
5066  * Return decoded output data from a decoder.
5067  *
5068  * @param avctx codec context
5069  * @param frame This will be set to a reference-counted video or audio
5070  *              frame (depending on the decoder type) allocated by the
5071  *              decoder. Note that the function will always call
5072  *              av_frame_unref(frame) before doing anything else.
5073  *
5074  * @return
5075  *      0:                 success, a frame was returned
5076  *      AVERROR(EAGAIN):   output is not available in this state - user must try
5077  *                         to send new input
5078  *      AVERROR_EOF:       the decoder has been fully flushed, and there will be
5079  *                         no more output frames
5080  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
5081  *      other negative values: legitimate decoding errors
5082  */
5083 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
5084
5085 /**
5086  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
5087  * to retrieve buffered output packets.
5088  *
5089  * @param avctx     codec context
5090  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
5091  *                  Ownership of the frame remains with the caller, and the
5092  *                  encoder will not write to the frame. The encoder may create
5093  *                  a reference to the frame data (or copy it if the frame is
5094  *                  not reference-counted).
5095  *                  It can be NULL, in which case it is considered a flush
5096  *                  packet.  This signals the end of the stream. If the encoder
5097  *                  still has packets buffered, it will return them after this
5098  *                  call. Once flushing mode has been entered, additional flush
5099  *                  packets are ignored, and sending frames will return
5100  *                  AVERROR_EOF.
5101  *
5102  *                  For audio:
5103  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5104  *                  can have any number of samples.
5105  *                  If it is not set, frame->nb_samples must be equal to
5106  *                  avctx->frame_size for all frames except the last.
5107  *                  The final frame may be smaller than avctx->frame_size.
5108  * @return 0 on success, otherwise negative error code:
5109  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
5110  *                         must read output with avcodec_receive_packet() (once
5111  *                         all output is read, the packet should be resent, and
5112  *                         the call will not fail with EAGAIN).
5113  *      AVERROR_EOF:       the encoder has been flushed, and no new frames can
5114  *                         be sent to it
5115  *      AVERROR(EINVAL):   codec not opened, refcounted_frames not set, it is a
5116  *                         decoder, or requires flush
5117  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
5118  *      other errors: legitimate decoding errors
5119  */
5120 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
5121
5122 /**
5123  * Read encoded data from the encoder.
5124  *
5125  * @param avctx codec context
5126  * @param avpkt This will be set to a reference-counted packet allocated by the
5127  *              encoder. Note that the function will always call
5128  *              av_frame_unref(frame) before doing anything else.
5129  * @return 0 on success, otherwise negative error code:
5130  *      AVERROR(EAGAIN):   output is not available in the current state - user
5131  *                         must try to send input
5132  *      AVERROR_EOF:       the encoder has been fully flushed, and there will be
5133  *                         no more output packets
5134  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
5135  *      other errors: legitimate decoding errors
5136  */
5137 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
5138
5139
5140 /**
5141  * @defgroup lavc_parsing Frame parsing
5142  * @{
5143  */
5144
5145 enum AVPictureStructure {
5146     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
5147     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
5148     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
5149     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
5150 };
5151
5152 typedef struct AVCodecParserContext {
5153     void *priv_data;
5154     struct AVCodecParser *parser;
5155     int64_t frame_offset; /* offset of the current frame */
5156     int64_t cur_offset; /* current offset
5157                            (incremented by each av_parser_parse()) */
5158     int64_t next_frame_offset; /* offset of the next frame */
5159     /* video info */
5160     int pict_type; /* XXX: Put it back in AVCodecContext. */
5161     /**
5162      * This field is used for proper frame duration computation in lavf.
5163      * It signals, how much longer the frame duration of the current frame
5164      * is compared to normal frame duration.
5165      *
5166      * frame_duration = (1 + repeat_pict) * time_base
5167      *
5168      * It is used by codecs like H.264 to display telecined material.
5169      */
5170     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
5171     int64_t pts;     /* pts of the current frame */
5172     int64_t dts;     /* dts of the current frame */
5173
5174     /* private data */
5175     int64_t last_pts;
5176     int64_t last_dts;
5177     int fetch_timestamp;
5178
5179 #define AV_PARSER_PTS_NB 4
5180     int cur_frame_start_index;
5181     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
5182     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
5183     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
5184
5185     int flags;
5186 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
5187 #define PARSER_FLAG_ONCE                      0x0002
5188 /// Set if the parser has a valid file offset
5189 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
5190 #define PARSER_FLAG_USE_CODEC_TS              0x1000
5191
5192     int64_t offset;      ///< byte offset from starting packet start
5193     int64_t cur_frame_end[AV_PARSER_PTS_NB];
5194
5195     /**
5196      * Set by parser to 1 for key frames and 0 for non-key frames.
5197      * It is initialized to -1, so if the parser doesn't set this flag,
5198      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
5199      * will be used.
5200      */
5201     int key_frame;
5202
5203 #if FF_API_CONVERGENCE_DURATION
5204     /**
5205      * @deprecated unused
5206      */
5207     attribute_deprecated
5208     int64_t convergence_duration;
5209 #endif
5210
5211     // Timestamp generation support:
5212     /**
5213      * Synchronization point for start of timestamp generation.
5214      *
5215      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5216      * (default).
5217      *
5218      * For example, this corresponds to presence of H.264 buffering period
5219      * SEI message.
5220      */
5221     int dts_sync_point;
5222
5223     /**
5224      * Offset of the current timestamp against last timestamp sync point in
5225      * units of AVCodecContext.time_base.
5226      *
5227      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5228      * contain a valid timestamp offset.
5229      *
5230      * Note that the timestamp of sync point has usually a nonzero
5231      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5232      * the next frame after timestamp sync point will be usually 1.
5233      *
5234      * For example, this corresponds to H.264 cpb_removal_delay.
5235      */
5236     int dts_ref_dts_delta;
5237
5238     /**
5239      * Presentation delay of current frame in units of AVCodecContext.time_base.
5240      *
5241      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5242      * contain valid non-negative timestamp delta (presentation time of a frame
5243      * must not lie in the past).
5244      *
5245      * This delay represents the difference between decoding and presentation
5246      * time of the frame.
5247      *
5248      * For example, this corresponds to H.264 dpb_output_delay.
5249      */
5250     int pts_dts_delta;
5251
5252     /**
5253      * Position of the packet in file.
5254      *
5255      * Analogous to cur_frame_pts/dts
5256      */
5257     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5258
5259     /**
5260      * Byte position of currently parsed frame in stream.
5261      */
5262     int64_t pos;
5263
5264     /**
5265      * Previous frame byte position.
5266      */
5267     int64_t last_pos;
5268
5269     /**
5270      * Duration of the current frame.
5271      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5272      * For all other types, this is in units of AVCodecContext.time_base.
5273      */
5274     int duration;
5275
5276     enum AVFieldOrder field_order;
5277
5278     /**
5279      * Indicate whether a picture is coded as a frame, top field or bottom field.
5280      *
5281      * For example, H.264 field_pic_flag equal to 0 corresponds to
5282      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5283      * equal to 1 and bottom_field_flag equal to 0 corresponds to
5284      * AV_PICTURE_STRUCTURE_TOP_FIELD.
5285      */
5286     enum AVPictureStructure picture_structure;
5287
5288     /**
5289      * Picture number incremented in presentation or output order.
5290      * This field may be reinitialized at the first picture of a new sequence.
5291      *
5292      * For example, this corresponds to H.264 PicOrderCnt.
5293      */
5294     int output_picture_number;
5295
5296     /**
5297      * Dimensions of the decoded video intended for presentation.
5298      */
5299     int width;
5300     int height;
5301
5302     /**
5303      * Dimensions of the coded video.
5304      */
5305     int coded_width;
5306     int coded_height;
5307
5308     /**
5309      * The format of the coded data, corresponds to enum AVPixelFormat for video
5310      * and for enum AVSampleFormat for audio.
5311      *
5312      * Note that a decoder can have considerable freedom in how exactly it
5313      * decodes the data, so the format reported here might be different from the
5314      * one returned by a decoder.
5315      */
5316     int format;
5317 } AVCodecParserContext;
5318
5319 typedef struct AVCodecParser {
5320     int codec_ids[5]; /* several codec IDs are permitted */
5321     int priv_data_size;
5322     int (*parser_init)(AVCodecParserContext *s);
5323     /* This callback never returns an error, a negative value means that
5324      * the frame start was in a previous packet. */
5325     int (*parser_parse)(AVCodecParserContext *s,
5326                         AVCodecContext *avctx,
5327                         const uint8_t **poutbuf, int *poutbuf_size,
5328                         const uint8_t *buf, int buf_size);
5329     void (*parser_close)(AVCodecParserContext *s);
5330     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5331     struct AVCodecParser *next;
5332 } AVCodecParser;
5333
5334 AVCodecParser *av_parser_next(const AVCodecParser *c);
5335
5336 void av_register_codec_parser(AVCodecParser *parser);
5337 AVCodecParserContext *av_parser_init(int codec_id);
5338
5339 /**
5340  * Parse a packet.
5341  *
5342  * @param s             parser context.
5343  * @param avctx         codec context.
5344  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
5345  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
5346  * @param buf           input buffer.
5347  * @param buf_size      buffer size in bytes without the padding. I.e. the full buffer
5348                         size is assumed to be buf_size + AV_INPUT_BUFFER_PADDING_SIZE.
5349                         To signal EOF, this should be 0 (so that the last frame
5350                         can be output).
5351  * @param pts           input presentation timestamp.
5352  * @param dts           input decoding timestamp.
5353  * @param pos           input byte position in stream.
5354  * @return the number of bytes of the input bitstream used.
5355  *
5356  * Example:
5357  * @code
5358  *   while(in_len){
5359  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5360  *                                        in_data, in_len,
5361  *                                        pts, dts, pos);
5362  *       in_data += len;
5363  *       in_len  -= len;
5364  *
5365  *       if(size)
5366  *          decode_frame(data, size);
5367  *   }
5368  * @endcode
5369  */
5370 int av_parser_parse2(AVCodecParserContext *s,
5371                      AVCodecContext *avctx,
5372                      uint8_t **poutbuf, int *poutbuf_size,
5373                      const uint8_t *buf, int buf_size,
5374                      int64_t pts, int64_t dts,
5375                      int64_t pos);
5376
5377 /**
5378  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5379  * @deprecated use AVBitStreamFilter
5380  */
5381 int av_parser_change(AVCodecParserContext *s,
5382                      AVCodecContext *avctx,
5383                      uint8_t **poutbuf, int *poutbuf_size,
5384                      const uint8_t *buf, int buf_size, int keyframe);
5385 void av_parser_close(AVCodecParserContext *s);
5386
5387 /**
5388  * @}
5389  * @}
5390  */
5391
5392 /**
5393  * @addtogroup lavc_encoding
5394  * @{
5395  */
5396
5397 /**
5398  * Find a registered encoder with a matching codec ID.
5399  *
5400  * @param id AVCodecID of the requested encoder
5401  * @return An encoder if one was found, NULL otherwise.
5402  */
5403 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5404
5405 /**
5406  * Find a registered encoder with the specified name.
5407  *
5408  * @param name name of the requested encoder
5409  * @return An encoder if one was found, NULL otherwise.
5410  */
5411 AVCodec *avcodec_find_encoder_by_name(const char *name);
5412
5413 /**
5414  * Encode a frame of audio.
5415  *
5416  * Takes input samples from frame and writes the next output packet, if
5417  * available, to avpkt. The output packet does not necessarily contain data for
5418  * the most recent frame, as encoders can delay, split, and combine input frames
5419  * internally as needed.
5420  *
5421  * @param avctx     codec context
5422  * @param avpkt     output AVPacket.
5423  *                  The user can supply an output buffer by setting
5424  *                  avpkt->data and avpkt->size prior to calling the
5425  *                  function, but if the size of the user-provided data is not
5426  *                  large enough, encoding will fail. If avpkt->data and
5427  *                  avpkt->size are set, avpkt->destruct must also be set. All
5428  *                  other AVPacket fields will be reset by the encoder using
5429  *                  av_init_packet(). If avpkt->data is NULL, the encoder will
5430  *                  allocate it. The encoder will set avpkt->size to the size
5431  *                  of the output packet.
5432  *
5433  *                  If this function fails or produces no output, avpkt will be
5434  *                  freed using av_packet_unref().
5435  * @param[in] frame AVFrame containing the raw audio data to be encoded.
5436  *                  May be NULL when flushing an encoder that has the
5437  *                  AV_CODEC_CAP_DELAY capability set.
5438  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5439  *                  can have any number of samples.
5440  *                  If it is not set, frame->nb_samples must be equal to
5441  *                  avctx->frame_size for all frames except the last.
5442  *                  The final frame may be smaller than avctx->frame_size.
5443  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5444  *                            output packet is non-empty, and to 0 if it is
5445  *                            empty. If the function returns an error, the
5446  *                            packet can be assumed to be invalid, and the
5447  *                            value of got_packet_ptr is undefined and should
5448  *                            not be used.
5449  * @return          0 on success, negative error code on failure
5450  *
5451  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5452  */
5453 attribute_deprecated
5454 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5455                           const AVFrame *frame, int *got_packet_ptr);
5456
5457 /**
5458  * Encode a frame of video.
5459  *
5460  * Takes input raw video data from frame and writes the next output packet, if
5461  * available, to avpkt. The output packet does not necessarily contain data for
5462  * the most recent frame, as encoders can delay and reorder input frames
5463  * internally as needed.
5464  *
5465  * @param avctx     codec context
5466  * @param avpkt     output AVPacket.
5467  *                  The user can supply an output buffer by setting
5468  *                  avpkt->data and avpkt->size prior to calling the
5469  *                  function, but if the size of the user-provided data is not
5470  *                  large enough, encoding will fail. All other AVPacket fields
5471  *                  will be reset by the encoder using av_init_packet(). If
5472  *                  avpkt->data is NULL, the encoder will allocate it.
5473  *                  The encoder will set avpkt->size to the size of the
5474  *                  output packet. The returned data (if any) belongs to the
5475  *                  caller, he is responsible for freeing it.
5476  *
5477  *                  If this function fails or produces no output, avpkt will be
5478  *                  freed using av_packet_unref().
5479  * @param[in] frame AVFrame containing the raw video data to be encoded.
5480  *                  May be NULL when flushing an encoder that has the
5481  *                  AV_CODEC_CAP_DELAY capability set.
5482  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5483  *                            output packet is non-empty, and to 0 if it is
5484  *                            empty. If the function returns an error, the
5485  *                            packet can be assumed to be invalid, and the
5486  *                            value of got_packet_ptr is undefined and should
5487  *                            not be used.
5488  * @return          0 on success, negative error code on failure
5489  *
5490  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5491  */
5492 attribute_deprecated
5493 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5494                           const AVFrame *frame, int *got_packet_ptr);
5495
5496 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5497                             const AVSubtitle *sub);
5498
5499
5500 /**
5501  * @}
5502  */
5503
5504 #if FF_API_AVPICTURE
5505 /**
5506  * @addtogroup lavc_picture
5507  * @{
5508  */
5509
5510 /**
5511  * @deprecated unused
5512  */
5513 attribute_deprecated
5514 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5515
5516 /**
5517  * @deprecated unused
5518  */
5519 attribute_deprecated
5520 void avpicture_free(AVPicture *picture);
5521
5522 /**
5523  * @deprecated use av_image_fill_arrays() instead.
5524  */
5525 attribute_deprecated
5526 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5527                    enum AVPixelFormat pix_fmt, int width, int height);
5528
5529 /**
5530  * @deprecated use av_image_copy_to_buffer() instead.
5531  */
5532 attribute_deprecated
5533 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5534                      int width, int height,
5535                      unsigned char *dest, int dest_size);
5536
5537 /**
5538  * @deprecated use av_image_get_buffer_size() instead.
5539  */
5540 attribute_deprecated
5541 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5542
5543 /**
5544  * @deprecated av_image_copy() instead.
5545  */
5546 attribute_deprecated
5547 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5548                      enum AVPixelFormat pix_fmt, int width, int height);
5549
5550 /**
5551  * @deprecated unused
5552  */
5553 attribute_deprecated
5554 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5555                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
5556
5557 /**
5558  * @deprecated unused
5559  */
5560 attribute_deprecated
5561 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5562             int padtop, int padbottom, int padleft, int padright, int *color);
5563
5564 /**
5565  * @}
5566  */
5567 #endif
5568
5569 /**
5570  * @defgroup lavc_misc Utility functions
5571  * @ingroup libavc
5572  *
5573  * Miscellaneous utility functions related to both encoding and decoding
5574  * (or neither).
5575  * @{
5576  */
5577
5578 /**
5579  * @defgroup lavc_misc_pixfmt Pixel formats
5580  *
5581  * Functions for working with pixel formats.
5582  * @{
5583  */
5584
5585 #if FF_API_GETCHROMA
5586 /**
5587  * @deprecated Use av_pix_fmt_get_chroma_sub_sample
5588  */
5589
5590 attribute_deprecated
5591 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5592 #endif
5593
5594 /**
5595  * Return a value representing the fourCC code associated to the
5596  * pixel format pix_fmt, or 0 if no associated fourCC code can be
5597  * found.
5598  */
5599 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5600
5601 /**
5602  * @deprecated see av_get_pix_fmt_loss()
5603  */
5604 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5605                              int has_alpha);
5606
5607 /**
5608  * Find the best pixel format to convert to given a certain source pixel
5609  * format.  When converting from one pixel format to another, information loss
5610  * may occur.  For example, when converting from RGB24 to GRAY, the color
5611  * information will be lost. Similarly, other losses occur when converting from
5612  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5613  * the given pixel formats should be used to suffer the least amount of loss.
5614  * The pixel formats from which it chooses one, are determined by the
5615  * pix_fmt_list parameter.
5616  *
5617  *
5618  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5619  * @param[in] src_pix_fmt source pixel format
5620  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5621  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5622  * @return The best pixel format to convert to or -1 if none was found.
5623  */
5624 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5625                                             enum AVPixelFormat src_pix_fmt,
5626                                             int has_alpha, int *loss_ptr);
5627
5628 /**
5629  * @deprecated see av_find_best_pix_fmt_of_2()
5630  */
5631 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5632                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5633
5634 attribute_deprecated
5635 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5636                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5637
5638 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5639
5640 /**
5641  * @}
5642  */
5643
5644 #if FF_API_SET_DIMENSIONS
5645 /**
5646  * @deprecated this function is not supposed to be used from outside of lavc
5647  */
5648 attribute_deprecated
5649 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5650 #endif
5651
5652 #if FF_API_TAG_STRING
5653 /**
5654  * Put a string representing the codec tag codec_tag in buf.
5655  *
5656  * @param buf       buffer to place codec tag in
5657  * @param buf_size size in bytes of buf
5658  * @param codec_tag codec tag to assign
5659  * @return the length of the string that would have been generated if
5660  * enough space had been available, excluding the trailing null
5661  *
5662  * @deprecated see av_fourcc_make_string() and av_fourcc2str().
5663  */
5664 attribute_deprecated
5665 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5666 #endif
5667
5668 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5669
5670 /**
5671  * Return a name for the specified profile, if available.
5672  *
5673  * @param codec the codec that is searched for the given profile
5674  * @param profile the profile value for which a name is requested
5675  * @return A name for the profile if found, NULL otherwise.
5676  */
5677 const char *av_get_profile_name(const AVCodec *codec, int profile);
5678
5679 /**
5680  * Return a name for the specified profile, if available.
5681  *
5682  * @param codec_id the ID of the codec to which the requested profile belongs
5683  * @param profile the profile value for which a name is requested
5684  * @return A name for the profile if found, NULL otherwise.
5685  *
5686  * @note unlike av_get_profile_name(), which searches a list of profiles
5687  *       supported by a specific decoder or encoder implementation, this
5688  *       function searches the list of profiles from the AVCodecDescriptor
5689  */
5690 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5691
5692 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5693 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5694 //FIXME func typedef
5695
5696 /**
5697  * Fill AVFrame audio data and linesize pointers.
5698  *
5699  * The buffer buf must be a preallocated buffer with a size big enough
5700  * to contain the specified samples amount. The filled AVFrame data
5701  * pointers will point to this buffer.
5702  *
5703  * AVFrame extended_data channel pointers are allocated if necessary for
5704  * planar audio.
5705  *
5706  * @param frame       the AVFrame
5707  *                    frame->nb_samples must be set prior to calling the
5708  *                    function. This function fills in frame->data,
5709  *                    frame->extended_data, frame->linesize[0].
5710  * @param nb_channels channel count
5711  * @param sample_fmt  sample format
5712  * @param buf         buffer to use for frame data
5713  * @param buf_size    size of buffer
5714  * @param align       plane size sample alignment (0 = default)
5715  * @return            >=0 on success, negative error code on failure
5716  * @todo return the size in bytes required to store the samples in
5717  * case of success, at the next libavutil bump
5718  */
5719 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5720                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
5721                              int buf_size, int align);
5722
5723 /**
5724  * Reset the internal decoder state / flush internal buffers. Should be called
5725  * e.g. when seeking or when switching to a different stream.
5726  *
5727  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5728  * this invalidates the frames previously returned from the decoder. When
5729  * refcounted frames are used, the decoder just releases any references it might
5730  * keep internally, but the caller's reference remains valid.
5731  */
5732 void avcodec_flush_buffers(AVCodecContext *avctx);
5733
5734 /**
5735  * Return codec bits per sample.
5736  *
5737  * @param[in] codec_id the codec
5738  * @return Number of bits per sample or zero if unknown for the given codec.
5739  */
5740 int av_get_bits_per_sample(enum AVCodecID codec_id);
5741
5742 /**
5743  * Return the PCM codec associated with a sample format.
5744  * @param be  endianness, 0 for little, 1 for big,
5745  *            -1 (or anything else) for native
5746  * @return  AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5747  */
5748 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5749
5750 /**
5751  * Return codec bits per sample.
5752  * Only return non-zero if the bits per sample is exactly correct, not an
5753  * approximation.
5754  *
5755  * @param[in] codec_id the codec
5756  * @return Number of bits per sample or zero if unknown for the given codec.
5757  */
5758 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5759
5760 /**
5761  * Return audio frame duration.
5762  *
5763  * @param avctx        codec context
5764  * @param frame_bytes  size of the frame, or 0 if unknown
5765  * @return             frame duration, in samples, if known. 0 if not able to
5766  *                     determine.
5767  */
5768 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5769
5770 /**
5771  * This function is the same as av_get_audio_frame_duration(), except it works
5772  * with AVCodecParameters instead of an AVCodecContext.
5773  */
5774 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5775
5776 #if FF_API_OLD_BSF
5777 typedef struct AVBitStreamFilterContext {
5778     void *priv_data;
5779     const struct AVBitStreamFilter *filter;
5780     AVCodecParserContext *parser;
5781     struct AVBitStreamFilterContext *next;
5782     /**
5783      * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5784      * Not for access by library users.
5785      */
5786     char *args;
5787 } AVBitStreamFilterContext;
5788 #endif
5789
5790 typedef struct AVBSFInternal AVBSFInternal;
5791
5792 /**
5793  * The bitstream filter state.
5794  *
5795  * This struct must be allocated with av_bsf_alloc() and freed with
5796  * av_bsf_free().
5797  *
5798  * The fields in the struct will only be changed (by the caller or by the
5799  * filter) as described in their documentation, and are to be considered
5800  * immutable otherwise.
5801  */
5802 typedef struct AVBSFContext {
5803     /**
5804      * A class for logging and AVOptions
5805      */
5806     const AVClass *av_class;
5807
5808     /**
5809      * The bitstream filter this context is an instance of.
5810      */
5811     const struct AVBitStreamFilter *filter;
5812
5813     /**
5814      * Opaque libavcodec internal data. Must not be touched by the caller in any
5815      * way.
5816      */
5817     AVBSFInternal *internal;
5818
5819     /**
5820      * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5821      * this is an AVOptions-enabled struct.
5822      */
5823     void *priv_data;
5824
5825     /**
5826      * Parameters of the input stream. This field is allocated in
5827      * av_bsf_alloc(), it needs to be filled by the caller before
5828      * av_bsf_init().
5829      */
5830     AVCodecParameters *par_in;
5831
5832     /**
5833      * Parameters of the output stream. This field is allocated in
5834      * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5835      */
5836     AVCodecParameters *par_out;
5837
5838     /**
5839      * The timebase used for the timestamps of the input packets. Set by the
5840      * caller before av_bsf_init().
5841      */
5842     AVRational time_base_in;
5843
5844     /**
5845      * The timebase used for the timestamps of the output packets. Set by the
5846      * filter in av_bsf_init().
5847      */
5848     AVRational time_base_out;
5849 } AVBSFContext;
5850
5851 typedef struct AVBitStreamFilter {
5852     const char *name;
5853
5854     /**
5855      * A list of codec ids supported by the filter, terminated by
5856      * AV_CODEC_ID_NONE.
5857      * May be NULL, in that case the bitstream filter works with any codec id.
5858      */
5859     const enum AVCodecID *codec_ids;
5860
5861     /**
5862      * A class for the private data, used to declare bitstream filter private
5863      * AVOptions. This field is NULL for bitstream filters that do not declare
5864      * any options.
5865      *
5866      * If this field is non-NULL, the first member of the filter private data
5867      * must be a pointer to AVClass, which will be set by libavcodec generic
5868      * code to this class.
5869      */
5870     const AVClass *priv_class;
5871
5872     /*****************************************************************
5873      * No fields below this line are part of the public API. They
5874      * may not be used outside of libavcodec and can be changed and
5875      * removed at will.
5876      * New public fields should be added right above.
5877      *****************************************************************
5878      */
5879
5880     int priv_data_size;
5881     int (*init)(AVBSFContext *ctx);
5882     int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5883     void (*close)(AVBSFContext *ctx);
5884 } AVBitStreamFilter;
5885
5886 #if FF_API_OLD_BSF
5887 /**
5888  * Register a bitstream filter.
5889  *
5890  * The filter will be accessible to the application code through
5891  * av_bitstream_filter_next() or can be directly initialized with
5892  * av_bitstream_filter_init().
5893  *
5894  * @see avcodec_register_all()
5895  */
5896 attribute_deprecated
5897 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5898
5899 /**
5900  * Create and initialize a bitstream filter context given a bitstream
5901  * filter name.
5902  *
5903  * The returned context must be freed with av_bitstream_filter_close().
5904  *
5905  * @param name    the name of the bitstream filter
5906  * @return a bitstream filter context if a matching filter was found
5907  * and successfully initialized, NULL otherwise
5908  */
5909 attribute_deprecated
5910 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5911
5912 /**
5913  * Filter bitstream.
5914  *
5915  * This function filters the buffer buf with size buf_size, and places the
5916  * filtered buffer in the buffer pointed to by poutbuf.
5917  *
5918  * The output buffer must be freed by the caller.
5919  *
5920  * @param bsfc            bitstream filter context created by av_bitstream_filter_init()
5921  * @param avctx           AVCodecContext accessed by the filter, may be NULL.
5922  *                        If specified, this must point to the encoder context of the
5923  *                        output stream the packet is sent to.
5924  * @param args            arguments which specify the filter configuration, may be NULL
5925  * @param poutbuf         pointer which is updated to point to the filtered buffer
5926  * @param poutbuf_size    pointer which is updated to the filtered buffer size in bytes
5927  * @param buf             buffer containing the data to filter
5928  * @param buf_size        size in bytes of buf
5929  * @param keyframe        set to non-zero if the buffer to filter corresponds to a key-frame packet data
5930  * @return >= 0 in case of success, or a negative error code in case of failure
5931  *
5932  * If the return value is positive, an output buffer is allocated and
5933  * is available in *poutbuf, and is distinct from the input buffer.
5934  *
5935  * If the return value is 0, the output buffer is not allocated and
5936  * should be considered identical to the input buffer, or in case
5937  * *poutbuf was set it points to the input buffer (not necessarily to
5938  * its starting address). A special case is if *poutbuf was set to NULL and
5939  * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5940  */
5941 attribute_deprecated
5942 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5943                                AVCodecContext *avctx, const char *args,
5944                                uint8_t **poutbuf, int *poutbuf_size,
5945                                const uint8_t *buf, int buf_size, int keyframe);
5946
5947 /**
5948  * Release bitstream filter context.
5949  *
5950  * @param bsf the bitstream filter context created with
5951  * av_bitstream_filter_init(), can be NULL
5952  */
5953 attribute_deprecated
5954 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5955
5956 /**
5957  * If f is NULL, return the first registered bitstream filter,
5958  * if f is non-NULL, return the next registered bitstream filter
5959  * after f, or NULL if f is the last one.
5960  *
5961  * This function can be used to iterate over all registered bitstream
5962  * filters.
5963  */
5964 attribute_deprecated
5965 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5966 #endif
5967
5968 /**
5969  * @return a bitstream filter with the specified name or NULL if no such
5970  *         bitstream filter exists.
5971  */
5972 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5973
5974 /**
5975  * Iterate over all registered bitstream filters.
5976  *
5977  * @param opaque a pointer where libavcodec will store the iteration state. Must
5978  *               point to NULL to start the iteration.
5979  *
5980  * @return the next registered bitstream filter or NULL when the iteration is
5981  *         finished
5982  */
5983 const AVBitStreamFilter *av_bsf_next(void **opaque);
5984
5985 /**
5986  * Allocate a context for a given bitstream filter. The caller must fill in the
5987  * context parameters as described in the documentation and then call
5988  * av_bsf_init() before sending any data to the filter.
5989  *
5990  * @param filter the filter for which to allocate an instance.
5991  * @param ctx a pointer into which the pointer to the newly-allocated context
5992  *            will be written. It must be freed with av_bsf_free() after the
5993  *            filtering is done.
5994  *
5995  * @return 0 on success, a negative AVERROR code on failure
5996  */
5997 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5998
5999 /**
6000  * Prepare the filter for use, after all the parameters and options have been
6001  * set.
6002  */
6003 int av_bsf_init(AVBSFContext *ctx);
6004
6005 /**
6006  * Submit a packet for filtering.
6007  *
6008  * After sending each packet, the filter must be completely drained by calling
6009  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
6010  * AVERROR_EOF.
6011  *
6012  * @param pkt the packet to filter. The bitstream filter will take ownership of
6013  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
6014  * This parameter may be NULL, which signals the end of the stream (i.e. no more
6015  * packets will be sent). That will cause the filter to output any packets it
6016  * may have buffered internally.
6017  *
6018  * @return 0 on success, a negative AVERROR on error.
6019  */
6020 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
6021
6022 /**
6023  * Retrieve a filtered packet.
6024  *
6025  * @param[out] pkt this struct will be filled with the contents of the filtered
6026  *                 packet. It is owned by the caller and must be freed using
6027  *                 av_packet_unref() when it is no longer needed.
6028  *                 This parameter should be "clean" (i.e. freshly allocated
6029  *                 with av_packet_alloc() or unreffed with av_packet_unref())
6030  *                 when this function is called. If this function returns
6031  *                 successfully, the contents of pkt will be completely
6032  *                 overwritten by the returned data. On failure, pkt is not
6033  *                 touched.
6034  *
6035  * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
6036  * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
6037  * will be no further output from the filter. Another negative AVERROR value if
6038  * an error occurs.
6039  *
6040  * @note one input packet may result in several output packets, so after sending
6041  * a packet with av_bsf_send_packet(), this function needs to be called
6042  * repeatedly until it stops returning 0. It is also possible for a filter to
6043  * output fewer packets than were sent to it, so this function may return
6044  * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
6045  */
6046 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
6047
6048 /**
6049  * Free a bitstream filter context and everything associated with it; write NULL
6050  * into the supplied pointer.
6051  */
6052 void av_bsf_free(AVBSFContext **ctx);
6053
6054 /**
6055  * Get the AVClass for AVBSFContext. It can be used in combination with
6056  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
6057  *
6058  * @see av_opt_find().
6059  */
6060 const AVClass *av_bsf_get_class(void);
6061
6062 /**
6063  * Structure for chain/list of bitstream filters.
6064  * Empty list can be allocated by av_bsf_list_alloc().
6065  */
6066 typedef struct AVBSFList AVBSFList;
6067
6068 /**
6069  * Allocate empty list of bitstream filters.
6070  * The list must be later freed by av_bsf_list_free()
6071  * or finalized by av_bsf_list_finalize().
6072  *
6073  * @return Pointer to @ref AVBSFList on success, NULL in case of failure
6074  */
6075 AVBSFList *av_bsf_list_alloc(void);
6076
6077 /**
6078  * Free list of bitstream filters.
6079  *
6080  * @param lst Pointer to pointer returned by av_bsf_list_alloc()
6081  */
6082 void av_bsf_list_free(AVBSFList **lst);
6083
6084 /**
6085  * Append bitstream filter to the list of bitstream filters.
6086  *
6087  * @param lst List to append to
6088  * @param bsf Filter context to be appended
6089  *
6090  * @return >=0 on success, negative AVERROR in case of failure
6091  */
6092 int av_bsf_list_append(AVBSFList *lst, AVBSFContext *bsf);
6093
6094 /**
6095  * Construct new bitstream filter context given it's name and options
6096  * and append it to the list of bitstream filters.
6097  *
6098  * @param lst      List to append to
6099  * @param bsf_name Name of the bitstream filter
6100  * @param options  Options for the bitstream filter, can be set to NULL
6101  *
6102  * @return >=0 on success, negative AVERROR in case of failure
6103  */
6104 int av_bsf_list_append2(AVBSFList *lst, const char * bsf_name, AVDictionary **options);
6105 /**
6106  * Finalize list of bitstream filters.
6107  *
6108  * This function will transform @ref AVBSFList to single @ref AVBSFContext,
6109  * so the whole chain of bitstream filters can be treated as single filter
6110  * freshly allocated by av_bsf_alloc().
6111  * If the call is successful, @ref AVBSFList structure is freed and lst
6112  * will be set to NULL. In case of failure, caller is responsible for
6113  * freeing the structure by av_bsf_list_free()
6114  *
6115  * @param      lst Filter list structure to be transformed
6116  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6117  *                 representing the chain of bitstream filters
6118  *
6119  * @return >=0 on success, negative AVERROR in case of failure
6120  */
6121 int av_bsf_list_finalize(AVBSFList **lst, AVBSFContext **bsf);
6122
6123 /**
6124  * Parse string describing list of bitstream filters and create single
6125  * @ref AVBSFContext describing the whole chain of bitstream filters.
6126  * Resulting @ref AVBSFContext can be treated as any other @ref AVBSFContext freshly
6127  * allocated by av_bsf_alloc().
6128  *
6129  * @param      str String describing chain of bitstream filters in format
6130  *                 `bsf1[=opt1=val1:opt2=val2][,bsf2]`
6131  * @param[out] bsf Pointer to be set to newly created @ref AVBSFContext structure
6132  *                 representing the chain of bitstream filters
6133  *
6134  * @return >=0 on success, negative AVERROR in case of failure
6135  */
6136 int av_bsf_list_parse_str(const char *str, AVBSFContext **bsf);
6137
6138 /**
6139  * Get null/pass-through bitstream filter.
6140  *
6141  * @param[out] bsf Pointer to be set to new instance of pass-through bitstream filter
6142  *
6143  * @return
6144  */
6145 int av_bsf_get_null_filter(AVBSFContext **bsf);
6146
6147 /* memory */
6148
6149 /**
6150  * Same behaviour av_fast_malloc but the buffer has additional
6151  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
6152  *
6153  * In addition the whole buffer will initially and after resizes
6154  * be 0-initialized so that no uninitialized data will ever appear.
6155  */
6156 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
6157
6158 /**
6159  * Same behaviour av_fast_padded_malloc except that buffer will always
6160  * be 0-initialized after call.
6161  */
6162 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
6163
6164 /**
6165  * Encode extradata length to a buffer. Used by xiph codecs.
6166  *
6167  * @param s buffer to write to; must be at least (v/255+1) bytes long
6168  * @param v size of extradata in bytes
6169  * @return number of bytes written to the buffer.
6170  */
6171 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
6172
6173 /**
6174  * Register the hardware accelerator hwaccel.
6175  */
6176 void av_register_hwaccel(AVHWAccel *hwaccel);
6177
6178 /**
6179  * If hwaccel is NULL, returns the first registered hardware accelerator,
6180  * if hwaccel is non-NULL, returns the next registered hardware accelerator
6181  * after hwaccel, or NULL if hwaccel is the last one.
6182  */
6183 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6184
6185
6186 /**
6187  * Lock operation used by lockmgr
6188  */
6189 enum AVLockOp {
6190   AV_LOCK_CREATE,  ///< Create a mutex
6191   AV_LOCK_OBTAIN,  ///< Lock the mutex
6192   AV_LOCK_RELEASE, ///< Unlock the mutex
6193   AV_LOCK_DESTROY, ///< Free mutex resources
6194 };
6195
6196 /**
6197  * Register a user provided lock manager supporting the operations
6198  * specified by AVLockOp. The "mutex" argument to the function points
6199  * to a (void *) where the lockmgr should store/get a pointer to a user
6200  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6201  * value left by the last call for all other ops. If the lock manager is
6202  * unable to perform the op then it should leave the mutex in the same
6203  * state as when it was called and return a non-zero value. However,
6204  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6205  * have been successfully destroyed. If av_lockmgr_register succeeds
6206  * it will return a non-negative value, if it fails it will return a
6207  * negative value and destroy all mutex and unregister all callbacks.
6208  * av_lockmgr_register is not thread-safe, it must be called from a
6209  * single thread before any calls which make use of locking are used.
6210  *
6211  * @param cb User defined callback. av_lockmgr_register invokes calls
6212  *           to this callback and the previously registered callback.
6213  *           The callback will be used to create more than one mutex
6214  *           each of which must be backed by its own underlying locking
6215  *           mechanism (i.e. do not use a single static object to
6216  *           implement your lock manager). If cb is set to NULL the
6217  *           lockmgr will be unregistered.
6218  */
6219 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6220
6221 /**
6222  * Get the type of the given codec.
6223  */
6224 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6225
6226 /**
6227  * Get the name of a codec.
6228  * @return  a static string identifying the codec; never NULL
6229  */
6230 const char *avcodec_get_name(enum AVCodecID id);
6231
6232 /**
6233  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6234  * with no corresponding avcodec_close()), 0 otherwise.
6235  */
6236 int avcodec_is_open(AVCodecContext *s);
6237
6238 /**
6239  * @return a non-zero number if codec is an encoder, zero otherwise
6240  */
6241 int av_codec_is_encoder(const AVCodec *codec);
6242
6243 /**
6244  * @return a non-zero number if codec is a decoder, zero otherwise
6245  */
6246 int av_codec_is_decoder(const AVCodec *codec);
6247
6248 /**
6249  * @return descriptor for given codec ID or NULL if no descriptor exists.
6250  */
6251 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6252
6253 /**
6254  * Iterate over all codec descriptors known to libavcodec.
6255  *
6256  * @param prev previous descriptor. NULL to get the first descriptor.
6257  *
6258  * @return next descriptor or NULL after the last descriptor
6259  */
6260 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6261
6262 /**
6263  * @return codec descriptor with the given name or NULL if no such descriptor
6264  *         exists.
6265  */
6266 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6267
6268 /**
6269  * Allocate a CPB properties structure and initialize its fields to default
6270  * values.
6271  *
6272  * @param size if non-NULL, the size of the allocated struct will be written
6273  *             here. This is useful for embedding it in side data.
6274  *
6275  * @return the newly allocated struct or NULL on failure
6276  */
6277 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6278
6279 /**
6280  * @}
6281  */
6282
6283 #endif /* AVCODEC_AVCODEC_H */