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