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