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