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