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