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