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