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