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