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