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