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