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