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