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