lavc: Drop deprecated emu edge functionality
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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  * Libav 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 Libav; 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/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
41
42 #include "version.h"
43
44 /**
45  * @defgroup libavc Encoding/Decoding Library
46  * @{
47  *
48  * @defgroup lavc_decoding Decoding
49  * @{
50  * @}
51  *
52  * @defgroup lavc_encoding Encoding
53  * @{
54  * @}
55  *
56  * @defgroup lavc_codec Codecs
57  * @{
58  * @defgroup lavc_codec_native Native Codecs
59  * @{
60  * @}
61  * @defgroup lavc_codec_wrappers External library wrappers
62  * @{
63  * @}
64  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
65  * @{
66  * @}
67  * @}
68  * @defgroup lavc_internal Internal
69  * @{
70  * @}
71  * @}
72  */
73
74 /**
75  * @ingroup libavc
76  * @defgroup lavc_encdec send/receive encoding and decoding API overview
77  * @{
78  *
79  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
80  * avcodec_receive_packet() functions provide an encode/decode API, which
81  * decouples input and output.
82  *
83  * The API is very similar for encoding/decoding and audio/video, and works as
84  * follows:
85  * - Set up and open the AVCodecContext as usual.
86  * - Send valid input:
87  *   - For decoding, call avcodec_send_packet() to give the decoder raw
88  *     compressed data in an AVPacket.
89  *   - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
90  *     containing uncompressed audio or video.
91  *   In both cases, it is recommended that AVPackets and AVFrames are
92  *   refcounted, or libavcodec might have to copy the input data. (libavformat
93  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
94  *   refcounted AVFrames.)
95  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
96  *   functions and process their output:
97  *   - For decoding, call avcodec_receive_frame(). On success, it will return
98  *     an AVFrame containing uncompressed audio or video data.
99  *   - For encoding, call avcodec_receive_packet(). On success, it will return
100  *     an AVPacket with a compressed frame.
101  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
102  *   AVERROR(EAGAIN) return value means that new input data is required to
103  *   return new output. In this case, continue with sending input. For each
104  *   input frame/packet, the codec will typically return 1 output frame/packet,
105  *   but it can also be 0 or more than 1.
106  *
107  * At the beginning of decoding or encoding, the codec might accept multiple
108  * input frames/packets without returning a frame, until its internal buffers
109  * are filled. This situation is handled transparently if you follow the steps
110  * outlined above.
111  *
112  * In theory, sending input can result in EAGAIN - this should happen only if
113  * not all output was received. You can use this to structure alternative decode
114  * or encode loops other than the one suggested above. For example, you could
115  * try sending new input on each iteration, and try to receive output if that
116  * returns EAGAIN.
117  *
118  * End of stream situations. These require "flushing" (aka draining) the codec,
119  * as the codec might buffer multiple frames or packets internally for
120  * performance or out of necessity (consider B-frames).
121  * This is handled as follows:
122  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
123  *   or avcodec_send_frame() (encoding) functions. This will enter draining
124  *   mode.
125  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
126  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
127  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
128  * - Before decoding can be resumed again, the codec has to be reset with
129  *   avcodec_flush_buffers().
130  *
131  * Using the API as outlined above is highly recommended. But it is also
132  * possible to call functions outside of this rigid schema. For example, you can
133  * call avcodec_send_packet() repeatedly without calling
134  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
135  * until the codec's internal buffer has been filled up (which is typically of
136  * size 1 per output frame, after initial input), and then reject input with
137  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
138  * read at least some output.
139  *
140  * Not all codecs will follow a rigid and predictable dataflow; the only
141  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
142  * one end implies that a receive/send call on the other end will succeed. In
143  * general, no codec will permit unlimited buffering of input or output.
144  *
145  * This API replaces the following legacy functions:
146  * - avcodec_decode_video2() and avcodec_decode_audio4():
147  *   Use avcodec_send_packet() to feed input to the decoder, then use
148  *   avcodec_receive_frame() to receive decoded frames after each packet.
149  *   Unlike with the old video decoding API, multiple frames might result from
150  *   a packet. For audio, splitting the input packet into frames by partially
151  *   decoding packets becomes transparent to the API user. You never need to
152  *   feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
153  *   no data was read from the packet).
154  *   Additionally, sending a flush/draining packet is required only once.
155  * - avcodec_encode_video2()/avcodec_encode_audio2():
156  *   Use avcodec_send_frame() to feed input to the encoder, then use
157  *   avcodec_receive_packet() to receive encoded packets.
158  *   Providing user-allocated buffers for avcodec_receive_packet() is not
159  *   possible.
160  * - The new API does not handle subtitles yet.
161  *
162  * Mixing new and old function calls on the same AVCodecContext is not allowed,
163  * and will result in arbitrary behavior.
164  *
165  * Some codecs might require using the new API; using the old API will return
166  * an error when calling it. All codecs support the new API.
167  *
168  * A codec is not allowed to return EAGAIN for both sending and receiving. This
169  * would be an invalid state, which could put the codec user into an endless
170  * loop. The API has no concept of time either: it cannot happen that trying to
171  * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
172  * later accepts the packet (with no other receive/flush API calls involved).
173  * The API is a strict state machine, and the passage of time is not supposed
174  * to influence it. Some timing-dependent behavior might still be deemed
175  * acceptable in certain cases. But it must never result in both send/receive
176  * returning EAGAIN at the same time at any point. It must also absolutely be
177  * avoided that the current state is "unstable" and can "flip-flop" between
178  * the send/receive APIs allowing progress. For example, it's not allowed that
179  * the codec randomly decides that it actually wants to consume a packet now
180  * instead of returning a frame, after it just returned EAGAIN on an
181  * avcodec_send_packet() call.
182  * @}
183  */
184
185 /**
186  * @defgroup lavc_core Core functions/structures.
187  * @ingroup libavc
188  *
189  * Basic definitions, functions for querying libavcodec capabilities,
190  * allocating core structures, etc.
191  * @{
192  */
193
194
195 /**
196  * Identify the syntax and semantics of the bitstream.
197  * The principle is roughly:
198  * Two decoders with the same ID can decode the same streams.
199  * Two encoders with the same ID can encode compatible streams.
200  * There may be slight deviations from the principle due to implementation
201  * details.
202  *
203  * If you add a codec ID to this list, add it so that
204  * 1. no value of a existing codec ID changes (that would break ABI),
205  * 2. it is as close as possible to similar codecs.
206  *
207  * After adding new codec IDs, do not forget to add an entry to the codec
208  * descriptor list and bump libavcodec minor version.
209  */
210 enum AVCodecID {
211     AV_CODEC_ID_NONE,
212
213     /* video codecs */
214     AV_CODEC_ID_MPEG1VIDEO,
215     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
216     AV_CODEC_ID_H261,
217     AV_CODEC_ID_H263,
218     AV_CODEC_ID_RV10,
219     AV_CODEC_ID_RV20,
220     AV_CODEC_ID_MJPEG,
221     AV_CODEC_ID_MJPEGB,
222     AV_CODEC_ID_LJPEG,
223     AV_CODEC_ID_SP5X,
224     AV_CODEC_ID_JPEGLS,
225     AV_CODEC_ID_MPEG4,
226     AV_CODEC_ID_RAWVIDEO,
227     AV_CODEC_ID_MSMPEG4V1,
228     AV_CODEC_ID_MSMPEG4V2,
229     AV_CODEC_ID_MSMPEG4V3,
230     AV_CODEC_ID_WMV1,
231     AV_CODEC_ID_WMV2,
232     AV_CODEC_ID_H263P,
233     AV_CODEC_ID_H263I,
234     AV_CODEC_ID_FLV1,
235     AV_CODEC_ID_SVQ1,
236     AV_CODEC_ID_SVQ3,
237     AV_CODEC_ID_DVVIDEO,
238     AV_CODEC_ID_HUFFYUV,
239     AV_CODEC_ID_CYUV,
240     AV_CODEC_ID_H264,
241     AV_CODEC_ID_INDEO3,
242     AV_CODEC_ID_VP3,
243     AV_CODEC_ID_THEORA,
244     AV_CODEC_ID_ASV1,
245     AV_CODEC_ID_ASV2,
246     AV_CODEC_ID_FFV1,
247     AV_CODEC_ID_4XM,
248     AV_CODEC_ID_VCR1,
249     AV_CODEC_ID_CLJR,
250     AV_CODEC_ID_MDEC,
251     AV_CODEC_ID_ROQ,
252     AV_CODEC_ID_INTERPLAY_VIDEO,
253     AV_CODEC_ID_XAN_WC3,
254     AV_CODEC_ID_XAN_WC4,
255     AV_CODEC_ID_RPZA,
256     AV_CODEC_ID_CINEPAK,
257     AV_CODEC_ID_WS_VQA,
258     AV_CODEC_ID_MSRLE,
259     AV_CODEC_ID_MSVIDEO1,
260     AV_CODEC_ID_IDCIN,
261     AV_CODEC_ID_8BPS,
262     AV_CODEC_ID_SMC,
263     AV_CODEC_ID_FLIC,
264     AV_CODEC_ID_TRUEMOTION1,
265     AV_CODEC_ID_VMDVIDEO,
266     AV_CODEC_ID_MSZH,
267     AV_CODEC_ID_ZLIB,
268     AV_CODEC_ID_QTRLE,
269     AV_CODEC_ID_TSCC,
270     AV_CODEC_ID_ULTI,
271     AV_CODEC_ID_QDRAW,
272     AV_CODEC_ID_VIXL,
273     AV_CODEC_ID_QPEG,
274     AV_CODEC_ID_PNG,
275     AV_CODEC_ID_PPM,
276     AV_CODEC_ID_PBM,
277     AV_CODEC_ID_PGM,
278     AV_CODEC_ID_PGMYUV,
279     AV_CODEC_ID_PAM,
280     AV_CODEC_ID_FFVHUFF,
281     AV_CODEC_ID_RV30,
282     AV_CODEC_ID_RV40,
283     AV_CODEC_ID_VC1,
284     AV_CODEC_ID_WMV3,
285     AV_CODEC_ID_LOCO,
286     AV_CODEC_ID_WNV1,
287     AV_CODEC_ID_AASC,
288     AV_CODEC_ID_INDEO2,
289     AV_CODEC_ID_FRAPS,
290     AV_CODEC_ID_TRUEMOTION2,
291     AV_CODEC_ID_BMP,
292     AV_CODEC_ID_CSCD,
293     AV_CODEC_ID_MMVIDEO,
294     AV_CODEC_ID_ZMBV,
295     AV_CODEC_ID_AVS,
296     AV_CODEC_ID_SMACKVIDEO,
297     AV_CODEC_ID_NUV,
298     AV_CODEC_ID_KMVC,
299     AV_CODEC_ID_FLASHSV,
300     AV_CODEC_ID_CAVS,
301     AV_CODEC_ID_JPEG2000,
302     AV_CODEC_ID_VMNC,
303     AV_CODEC_ID_VP5,
304     AV_CODEC_ID_VP6,
305     AV_CODEC_ID_VP6F,
306     AV_CODEC_ID_TARGA,
307     AV_CODEC_ID_DSICINVIDEO,
308     AV_CODEC_ID_TIERTEXSEQVIDEO,
309     AV_CODEC_ID_TIFF,
310     AV_CODEC_ID_GIF,
311     AV_CODEC_ID_DXA,
312     AV_CODEC_ID_DNXHD,
313     AV_CODEC_ID_THP,
314     AV_CODEC_ID_SGI,
315     AV_CODEC_ID_C93,
316     AV_CODEC_ID_BETHSOFTVID,
317     AV_CODEC_ID_PTX,
318     AV_CODEC_ID_TXD,
319     AV_CODEC_ID_VP6A,
320     AV_CODEC_ID_AMV,
321     AV_CODEC_ID_VB,
322     AV_CODEC_ID_PCX,
323     AV_CODEC_ID_SUNRAST,
324     AV_CODEC_ID_INDEO4,
325     AV_CODEC_ID_INDEO5,
326     AV_CODEC_ID_MIMIC,
327     AV_CODEC_ID_RL2,
328     AV_CODEC_ID_ESCAPE124,
329     AV_CODEC_ID_DIRAC,
330     AV_CODEC_ID_BFI,
331     AV_CODEC_ID_CMV,
332     AV_CODEC_ID_MOTIONPIXELS,
333     AV_CODEC_ID_TGV,
334     AV_CODEC_ID_TGQ,
335     AV_CODEC_ID_TQI,
336     AV_CODEC_ID_AURA,
337     AV_CODEC_ID_AURA2,
338     AV_CODEC_ID_V210X,
339     AV_CODEC_ID_TMV,
340     AV_CODEC_ID_V210,
341     AV_CODEC_ID_DPX,
342     AV_CODEC_ID_MAD,
343     AV_CODEC_ID_FRWU,
344     AV_CODEC_ID_FLASHSV2,
345     AV_CODEC_ID_CDGRAPHICS,
346     AV_CODEC_ID_R210,
347     AV_CODEC_ID_ANM,
348     AV_CODEC_ID_BINKVIDEO,
349     AV_CODEC_ID_IFF_ILBM,
350     AV_CODEC_ID_IFF_BYTERUN1,
351     AV_CODEC_ID_KGV1,
352     AV_CODEC_ID_YOP,
353     AV_CODEC_ID_VP8,
354     AV_CODEC_ID_PICTOR,
355     AV_CODEC_ID_ANSI,
356     AV_CODEC_ID_A64_MULTI,
357     AV_CODEC_ID_A64_MULTI5,
358     AV_CODEC_ID_R10K,
359     AV_CODEC_ID_MXPEG,
360     AV_CODEC_ID_LAGARITH,
361     AV_CODEC_ID_PRORES,
362     AV_CODEC_ID_JV,
363     AV_CODEC_ID_DFA,
364     AV_CODEC_ID_WMV3IMAGE,
365     AV_CODEC_ID_VC1IMAGE,
366     AV_CODEC_ID_UTVIDEO,
367     AV_CODEC_ID_BMV_VIDEO,
368     AV_CODEC_ID_VBLE,
369     AV_CODEC_ID_DXTORY,
370     AV_CODEC_ID_V410,
371     AV_CODEC_ID_XWD,
372     AV_CODEC_ID_CDXL,
373     AV_CODEC_ID_XBM,
374     AV_CODEC_ID_ZEROCODEC,
375     AV_CODEC_ID_MSS1,
376     AV_CODEC_ID_MSA1,
377     AV_CODEC_ID_TSCC2,
378     AV_CODEC_ID_MTS2,
379     AV_CODEC_ID_CLLC,
380     AV_CODEC_ID_MSS2,
381     AV_CODEC_ID_VP9,
382     AV_CODEC_ID_AIC,
383     AV_CODEC_ID_ESCAPE130,
384     AV_CODEC_ID_G2M,
385     AV_CODEC_ID_WEBP,
386     AV_CODEC_ID_HNM4_VIDEO,
387     AV_CODEC_ID_HEVC,
388     AV_CODEC_ID_FIC,
389     AV_CODEC_ID_ALIAS_PIX,
390     AV_CODEC_ID_BRENDER_PIX,
391     AV_CODEC_ID_PAF_VIDEO,
392     AV_CODEC_ID_EXR,
393     AV_CODEC_ID_VP7,
394     AV_CODEC_ID_SANM,
395     AV_CODEC_ID_SGIRLE,
396     AV_CODEC_ID_MVC1,
397     AV_CODEC_ID_MVC2,
398     AV_CODEC_ID_HQX,
399     AV_CODEC_ID_TDSC,
400     AV_CODEC_ID_HQ_HQA,
401     AV_CODEC_ID_HAP,
402     AV_CODEC_ID_DDS,
403     AV_CODEC_ID_DXV,
404     AV_CODEC_ID_SCREENPRESSO,
405     AV_CODEC_ID_RSCC,
406     AV_CODEC_ID_MAGICYUV,
407     AV_CODEC_ID_TRUEMOTION2RT,
408     AV_CODEC_ID_AV1,
409     AV_CODEC_ID_PIXLET,
410     AV_CODEC_ID_CFHD,
411
412     /* various PCM "codecs" */
413     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
414     AV_CODEC_ID_PCM_S16LE = 0x10000,
415     AV_CODEC_ID_PCM_S16BE,
416     AV_CODEC_ID_PCM_U16LE,
417     AV_CODEC_ID_PCM_U16BE,
418     AV_CODEC_ID_PCM_S8,
419     AV_CODEC_ID_PCM_U8,
420     AV_CODEC_ID_PCM_MULAW,
421     AV_CODEC_ID_PCM_ALAW,
422     AV_CODEC_ID_PCM_S32LE,
423     AV_CODEC_ID_PCM_S32BE,
424     AV_CODEC_ID_PCM_U32LE,
425     AV_CODEC_ID_PCM_U32BE,
426     AV_CODEC_ID_PCM_S24LE,
427     AV_CODEC_ID_PCM_S24BE,
428     AV_CODEC_ID_PCM_U24LE,
429     AV_CODEC_ID_PCM_U24BE,
430     AV_CODEC_ID_PCM_S24DAUD,
431     AV_CODEC_ID_PCM_ZORK,
432     AV_CODEC_ID_PCM_S16LE_PLANAR,
433     AV_CODEC_ID_PCM_DVD,
434     AV_CODEC_ID_PCM_F32BE,
435     AV_CODEC_ID_PCM_F32LE,
436     AV_CODEC_ID_PCM_F64BE,
437     AV_CODEC_ID_PCM_F64LE,
438     AV_CODEC_ID_PCM_BLURAY,
439     AV_CODEC_ID_PCM_LXF,
440     AV_CODEC_ID_S302M,
441     AV_CODEC_ID_PCM_S8_PLANAR,
442     AV_CODEC_ID_PCM_S24LE_PLANAR,
443     AV_CODEC_ID_PCM_S32LE_PLANAR,
444     AV_CODEC_ID_PCM_S16BE_PLANAR,
445
446     /* various ADPCM codecs */
447     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
448     AV_CODEC_ID_ADPCM_IMA_WAV,
449     AV_CODEC_ID_ADPCM_IMA_DK3,
450     AV_CODEC_ID_ADPCM_IMA_DK4,
451     AV_CODEC_ID_ADPCM_IMA_WS,
452     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
453     AV_CODEC_ID_ADPCM_MS,
454     AV_CODEC_ID_ADPCM_4XM,
455     AV_CODEC_ID_ADPCM_XA,
456     AV_CODEC_ID_ADPCM_ADX,
457     AV_CODEC_ID_ADPCM_EA,
458     AV_CODEC_ID_ADPCM_G726,
459     AV_CODEC_ID_ADPCM_CT,
460     AV_CODEC_ID_ADPCM_SWF,
461     AV_CODEC_ID_ADPCM_YAMAHA,
462     AV_CODEC_ID_ADPCM_SBPRO_4,
463     AV_CODEC_ID_ADPCM_SBPRO_3,
464     AV_CODEC_ID_ADPCM_SBPRO_2,
465     AV_CODEC_ID_ADPCM_THP,
466     AV_CODEC_ID_ADPCM_IMA_AMV,
467     AV_CODEC_ID_ADPCM_EA_R1,
468     AV_CODEC_ID_ADPCM_EA_R3,
469     AV_CODEC_ID_ADPCM_EA_R2,
470     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
471     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
472     AV_CODEC_ID_ADPCM_EA_XAS,
473     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
474     AV_CODEC_ID_ADPCM_IMA_ISS,
475     AV_CODEC_ID_ADPCM_G722,
476     AV_CODEC_ID_ADPCM_IMA_APC,
477     AV_CODEC_ID_ADPCM_VIMA,
478
479     /* AMR */
480     AV_CODEC_ID_AMR_NB = 0x12000,
481     AV_CODEC_ID_AMR_WB,
482
483     /* RealAudio codecs*/
484     AV_CODEC_ID_RA_144 = 0x13000,
485     AV_CODEC_ID_RA_288,
486
487     /* various DPCM codecs */
488     AV_CODEC_ID_ROQ_DPCM = 0x14000,
489     AV_CODEC_ID_INTERPLAY_DPCM,
490     AV_CODEC_ID_XAN_DPCM,
491     AV_CODEC_ID_SOL_DPCM,
492
493     /* audio codecs */
494     AV_CODEC_ID_MP2 = 0x15000,
495     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
496     AV_CODEC_ID_AAC,
497     AV_CODEC_ID_AC3,
498     AV_CODEC_ID_DTS,
499     AV_CODEC_ID_VORBIS,
500     AV_CODEC_ID_DVAUDIO,
501     AV_CODEC_ID_WMAV1,
502     AV_CODEC_ID_WMAV2,
503     AV_CODEC_ID_MACE3,
504     AV_CODEC_ID_MACE6,
505     AV_CODEC_ID_VMDAUDIO,
506     AV_CODEC_ID_FLAC,
507     AV_CODEC_ID_MP3ADU,
508     AV_CODEC_ID_MP3ON4,
509     AV_CODEC_ID_SHORTEN,
510     AV_CODEC_ID_ALAC,
511     AV_CODEC_ID_WESTWOOD_SND1,
512     AV_CODEC_ID_GSM, ///< as in Berlin toast format
513     AV_CODEC_ID_QDM2,
514     AV_CODEC_ID_COOK,
515     AV_CODEC_ID_TRUESPEECH,
516     AV_CODEC_ID_TTA,
517     AV_CODEC_ID_SMACKAUDIO,
518     AV_CODEC_ID_QCELP,
519     AV_CODEC_ID_WAVPACK,
520     AV_CODEC_ID_DSICINAUDIO,
521     AV_CODEC_ID_IMC,
522     AV_CODEC_ID_MUSEPACK7,
523     AV_CODEC_ID_MLP,
524     AV_CODEC_ID_GSM_MS, /* as found in WAV */
525     AV_CODEC_ID_ATRAC3,
526     AV_CODEC_ID_APE,
527     AV_CODEC_ID_NELLYMOSER,
528     AV_CODEC_ID_MUSEPACK8,
529     AV_CODEC_ID_SPEEX,
530     AV_CODEC_ID_WMAVOICE,
531     AV_CODEC_ID_WMAPRO,
532     AV_CODEC_ID_WMALOSSLESS,
533     AV_CODEC_ID_ATRAC3P,
534     AV_CODEC_ID_EAC3,
535     AV_CODEC_ID_SIPR,
536     AV_CODEC_ID_MP1,
537     AV_CODEC_ID_TWINVQ,
538     AV_CODEC_ID_TRUEHD,
539     AV_CODEC_ID_MP4ALS,
540     AV_CODEC_ID_ATRAC1,
541     AV_CODEC_ID_BINKAUDIO_RDFT,
542     AV_CODEC_ID_BINKAUDIO_DCT,
543     AV_CODEC_ID_AAC_LATM,
544     AV_CODEC_ID_QDMC,
545     AV_CODEC_ID_CELT,
546     AV_CODEC_ID_G723_1,
547     AV_CODEC_ID_G729,
548     AV_CODEC_ID_8SVX_EXP,
549     AV_CODEC_ID_8SVX_FIB,
550     AV_CODEC_ID_BMV_AUDIO,
551     AV_CODEC_ID_RALF,
552     AV_CODEC_ID_IAC,
553     AV_CODEC_ID_ILBC,
554     AV_CODEC_ID_OPUS,
555     AV_CODEC_ID_COMFORT_NOISE,
556     AV_CODEC_ID_TAK,
557     AV_CODEC_ID_METASOUND,
558     AV_CODEC_ID_PAF_AUDIO,
559     AV_CODEC_ID_ON2AVC,
560     AV_CODEC_ID_DSS_SP,
561
562     /* subtitle codecs */
563     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
564     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
565     AV_CODEC_ID_DVB_SUBTITLE,
566     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
567     AV_CODEC_ID_XSUB,
568     AV_CODEC_ID_SSA,
569     AV_CODEC_ID_MOV_TEXT,
570     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
571     AV_CODEC_ID_DVB_TELETEXT,
572     AV_CODEC_ID_SRT,
573
574     /* other specific kind of codecs (generally used for attachments) */
575     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
576     AV_CODEC_ID_TTF = 0x18000,
577
578     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
579
580     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
581                                 * stream (only used by libavformat) */
582     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
583                                 * stream (only used by libavformat) */
584     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
585     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
586 };
587
588 /**
589  * This struct describes the properties of a single codec described by an
590  * AVCodecID.
591  * @see avcodec_descriptor_get()
592  */
593 typedef struct AVCodecDescriptor {
594     enum AVCodecID     id;
595     enum AVMediaType type;
596     /**
597      * Name of the codec described by this descriptor. It is non-empty and
598      * unique for each codec descriptor. It should contain alphanumeric
599      * characters and '_' only.
600      */
601     const char      *name;
602     /**
603      * A more descriptive name for this codec. May be NULL.
604      */
605     const char *long_name;
606     /**
607      * Codec properties, a combination of AV_CODEC_PROP_* flags.
608      */
609     int             props;
610     /**
611      * If non-NULL, an array of profiles recognized for this codec.
612      * Terminated with FF_PROFILE_UNKNOWN.
613      */
614     const struct AVProfile *profiles;
615 } AVCodecDescriptor;
616
617 /**
618  * Codec uses only intra compression.
619  * Video codecs only.
620  */
621 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
622 /**
623  * Codec supports lossy compression. Audio and video codecs only.
624  * @note a codec may support both lossy and lossless
625  * compression modes
626  */
627 #define AV_CODEC_PROP_LOSSY         (1 << 1)
628 /**
629  * Codec supports lossless compression. Audio and video codecs only.
630  */
631 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
632 /**
633  * Codec supports frame reordering. That is, the coded order (the order in which
634  * the encoded packets are output by the encoders / stored / input to the
635  * decoders) may be different from the presentation order of the corresponding
636  * frames.
637  *
638  * For codecs that do not have this property set, PTS and DTS should always be
639  * equal.
640  */
641 #define AV_CODEC_PROP_REORDER       (1 << 3)
642
643 /**
644  * @ingroup lavc_decoding
645  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
646  * This is mainly needed because some optimized bitstream readers read
647  * 32 or 64 bit at once and could read over the end.<br>
648  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
649  * MPEG bitstreams could cause overread and segfault.
650  */
651 #define AV_INPUT_BUFFER_PADDING_SIZE 8
652
653 /**
654  * @ingroup lavc_encoding
655  * minimum encoding buffer size
656  * Used to avoid some checks during header writing.
657  */
658 #define AV_INPUT_BUFFER_MIN_SIZE 16384
659
660 #if FF_API_WITHOUT_PREFIX
661 /**
662  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
663  */
664 #define FF_INPUT_BUFFER_PADDING_SIZE 8
665
666 /**
667  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
668  */
669 #define FF_MIN_BUFFER_SIZE 16384
670 #endif /* FF_API_WITHOUT_PREFIX */
671
672 /**
673  * @ingroup lavc_encoding
674  * motion estimation type.
675  * @deprecated use codec private option instead
676  */
677 #if FF_API_MOTION_EST
678 enum Motion_Est_ID {
679     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
680     ME_FULL,
681     ME_LOG,
682     ME_PHODS,
683     ME_EPZS,        ///< enhanced predictive zonal search
684     ME_X1,          ///< reserved for experiments
685     ME_HEX,         ///< hexagon based search
686     ME_UMH,         ///< uneven multi-hexagon search
687     ME_TESA,        ///< transformed exhaustive search algorithm
688 };
689 #endif
690
691 /**
692  * @ingroup lavc_decoding
693  */
694 enum AVDiscard{
695     /* We leave some space between them for extensions (drop some
696      * keyframes for intra-only or drop just some bidir frames). */
697     AVDISCARD_NONE    =-16, ///< discard nothing
698     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
699     AVDISCARD_NONREF  =  8, ///< discard all non reference
700     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
701     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
702     AVDISCARD_ALL     = 48, ///< discard all
703 };
704
705 enum AVAudioServiceType {
706     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
707     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
708     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
709     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
710     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
711     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
712     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
713     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
714     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
715     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
716 };
717
718 /**
719  * @ingroup lavc_encoding
720  */
721 typedef struct RcOverride{
722     int start_frame;
723     int end_frame;
724     int qscale; // If this is 0 then quality_factor will be used instead.
725     float quality_factor;
726 } RcOverride;
727
728 /* encoding support
729    These flags can be passed in AVCodecContext.flags before initialization.
730    Note: Not everything is supported yet.
731 */
732
733 /**
734  * Allow decoders to produce frames with data planes that are not aligned
735  * to CPU requirements (e.g. due to cropping).
736  */
737 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
738 /**
739  * Use fixed qscale.
740  */
741 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
742 /**
743  * 4 MV per MB allowed / advanced prediction for H.263.
744  */
745 #define AV_CODEC_FLAG_4MV             (1 <<  2)
746 /**
747  * Output even those frames that might be corrupted.
748  */
749 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
750 /**
751  * Use qpel MC.
752  */
753 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
754 /**
755  * Use internal 2pass ratecontrol in first pass mode.
756  */
757 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
758 /**
759  * Use internal 2pass ratecontrol in second pass mode.
760  */
761 #define AV_CODEC_FLAG_PASS2           (1 << 10)
762 /**
763  * loop filter.
764  */
765 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
766 /**
767  * Only decode/encode grayscale.
768  */
769 #define AV_CODEC_FLAG_GRAY            (1 << 13)
770 /**
771  * error[?] variables will be set during encoding.
772  */
773 #define AV_CODEC_FLAG_PSNR            (1 << 15)
774 /**
775  * Input bitstream might be truncated at a random location
776  * instead of only at frame boundaries.
777  */
778 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
779 /**
780  * Use interlaced DCT.
781  */
782 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
783 /**
784  * Force low delay.
785  */
786 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
787 /**
788  * Place global headers in extradata instead of every keyframe.
789  */
790 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
791 /**
792  * Use only bitexact stuff (except (I)DCT).
793  */
794 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
795 /* Fx : Flag for H.263+ extra options */
796 /**
797  * H.263 advanced intra coding / MPEG-4 AC prediction
798  */
799 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
800 /**
801  * interlaced motion estimation
802  */
803 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
804 #define AV_CODEC_FLAG_CLOSED_GOP      (1 << 31)
805
806 /**
807  * Allow non spec compliant speedup tricks.
808  */
809 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
810 /**
811  * Skip bitstream encoding.
812  */
813 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
814 /**
815  * Place global headers at every keyframe instead of in extradata.
816  */
817 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
818 /**
819  * Input bitstream might be truncated at a packet boundaries
820  * instead of only at frame boundaries.
821  */
822 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
823 /**
824  * Discard cropping information from SPS.
825  */
826 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
827
828 /* Unsupported options :
829  *              Syntax Arithmetic coding (SAC)
830  *              Reference Picture Selection
831  *              Independent Segment Decoding */
832 /* /Fx */
833 /* codec capabilities */
834
835 /**
836  * Decoder can use draw_horiz_band callback.
837  */
838 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
839 /**
840  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
841  * If not set, it might not use get_buffer() at all or use operations that
842  * assume the buffer was allocated by avcodec_default_get_buffer.
843  */
844 #define AV_CODEC_CAP_DR1                 (1 <<  1)
845 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
846 /**
847  * Encoder or decoder requires flushing with NULL input at the end in order to
848  * give the complete and correct output.
849  *
850  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
851  *       with NULL data. The user can still send NULL data to the public encode
852  *       or decode function, but libavcodec will not pass it along to the codec
853  *       unless this flag is set.
854  *
855  * Decoders:
856  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
857  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
858  * returns frames.
859  *
860  * Encoders:
861  * The encoder needs to be fed with NULL data at the end of encoding until the
862  * encoder no longer returns data.
863  *
864  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
865  *       flag also means that the encoder must set the pts and duration for
866  *       each output packet. If this flag is not set, the pts and duration will
867  *       be determined by libavcodec from the input frame.
868  */
869 #define AV_CODEC_CAP_DELAY               (1 <<  5)
870 /**
871  * Codec can be fed a final frame with a smaller size.
872  * This can be used to prevent truncation of the last audio samples.
873  */
874 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
875 /**
876  * Codec can output multiple frames per AVPacket
877  * Normally demuxers return one frame at a time, demuxers which do not do
878  * are connected to a parser to split what they return into proper frames.
879  * This flag is reserved to the very rare category of codecs which have a
880  * bitstream that cannot be split into frames without timeconsuming
881  * operations like full decoding. Demuxers carrying such bitstreams thus
882  * may return multiple frames in a packet. This has many disadvantages like
883  * prohibiting stream copy in many cases thus it should only be considered
884  * as a last resort.
885  */
886 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
887 /**
888  * Codec is experimental and is thus avoided in favor of non experimental
889  * encoders
890  */
891 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
892 /**
893  * Codec should fill in channel configuration and samplerate instead of container
894  */
895 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
896 /**
897  * Codec supports frame-level multithreading.
898  */
899 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
900 /**
901  * Codec supports slice-based (or partition-based) multithreading.
902  */
903 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
904 /**
905  * Codec supports changed parameters at any point.
906  */
907 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
908 /**
909  * Codec supports avctx->thread_count == 0 (auto).
910  */
911 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
912 /**
913  * Audio encoder supports receiving a different number of samples in each call.
914  */
915 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
916
917 #if FF_API_WITHOUT_PREFIX
918 /**
919  * Allow decoders to produce frames with data planes that are not aligned
920  * to CPU requirements (e.g. due to cropping).
921  */
922 #define CODEC_FLAG_UNALIGNED 0x0001
923 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
924 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
925 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
926 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
927 #if FF_API_GMC
928 /**
929  * @deprecated use the "gmc" private option of the libxvid encoder
930  */
931 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
932 #endif
933 #if FF_API_MV0
934 /**
935  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
936  * mpegvideo encoders
937  */
938 #define CODEC_FLAG_MV0    0x0040
939 #endif
940 #if FF_API_INPUT_PRESERVED
941 /**
942  * @deprecated passing reference-counted frames to the encoders replaces this
943  * flag
944  */
945 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
946 #endif
947 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
948 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
949 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
950 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
951 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
952                                                   location instead of only at frame boundaries. */
953 #if FF_API_NORMALIZE_AQP
954 /**
955  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
956  * mpegvideo encoders
957  */
958 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
959 #endif
960 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
961 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
962 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
963 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
964 /* Fx : Flag for H.263+ extra options */
965 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
966 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
967 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
968 #define CODEC_FLAG_CLOSED_GOP     0x80000000
969 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
970 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
971 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
972 #define CODEC_FLAG2_IGNORE_CROP   0x00010000 ///< Discard cropping information from SPS.
973
974 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
975
976 /* Unsupported options :
977  *              Syntax Arithmetic coding (SAC)
978  *              Reference Picture Selection
979  *              Independent Segment Decoding */
980 /* /Fx */
981 /* codec capabilities */
982
983 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
984 /**
985  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
986  * If not set, it might not use get_buffer() at all or use operations that
987  * assume the buffer was allocated by avcodec_default_get_buffer.
988  */
989 #define CODEC_CAP_DR1             0x0002
990 #define CODEC_CAP_TRUNCATED       0x0008
991 /**
992  * Encoder or decoder requires flushing with NULL input at the end in order to
993  * give the complete and correct output.
994  *
995  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
996  *       with NULL data. The user can still send NULL data to the public encode
997  *       or decode function, but libavcodec will not pass it along to the codec
998  *       unless this flag is set.
999  *
1000  * Decoders:
1001  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1002  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1003  * returns frames.
1004  *
1005  * Encoders:
1006  * The encoder needs to be fed with NULL data at the end of encoding until the
1007  * encoder no longer returns data.
1008  *
1009  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1010  *       flag also means that the encoder must set the pts and duration for
1011  *       each output packet. If this flag is not set, the pts and duration will
1012  *       be determined by libavcodec from the input frame.
1013  */
1014 #define CODEC_CAP_DELAY           0x0020
1015 /**
1016  * Codec can be fed a final frame with a smaller size.
1017  * This can be used to prevent truncation of the last audio samples.
1018  */
1019 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
1020 /**
1021  * Codec can output multiple frames per AVPacket
1022  * Normally demuxers return one frame at a time, demuxers which do not do
1023  * are connected to a parser to split what they return into proper frames.
1024  * This flag is reserved to the very rare category of codecs which have a
1025  * bitstream that cannot be split into frames without timeconsuming
1026  * operations like full decoding. Demuxers carrying such bitstreams thus
1027  * may return multiple frames in a packet. This has many disadvantages like
1028  * prohibiting stream copy in many cases thus it should only be considered
1029  * as a last resort.
1030  */
1031 #define CODEC_CAP_SUBFRAMES        0x0100
1032 /**
1033  * Codec is experimental and is thus avoided in favor of non experimental
1034  * encoders
1035  */
1036 #define CODEC_CAP_EXPERIMENTAL     0x0200
1037 /**
1038  * Codec should fill in channel configuration and samplerate instead of container
1039  */
1040 #define CODEC_CAP_CHANNEL_CONF     0x0400
1041 /**
1042  * Codec supports frame-level multithreading.
1043  */
1044 #define CODEC_CAP_FRAME_THREADS    0x1000
1045 /**
1046  * Codec supports slice-based (or partition-based) multithreading.
1047  */
1048 #define CODEC_CAP_SLICE_THREADS    0x2000
1049 /**
1050  * Codec supports changed parameters at any point.
1051  */
1052 #define CODEC_CAP_PARAM_CHANGE     0x4000
1053 /**
1054  * Codec supports avctx->thread_count == 0 (auto).
1055  */
1056 #define CODEC_CAP_AUTO_THREADS     0x8000
1057 /**
1058  * Audio encoder supports receiving a different number of samples in each call.
1059  */
1060 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
1061 #endif /* FF_API_WITHOUT_PREFIX */
1062
1063 /**
1064  * Pan Scan area.
1065  * This specifies the area which should be displayed.
1066  * Note there may be multiple such areas for one frame.
1067  */
1068 typedef struct AVPanScan{
1069     /**
1070      * id
1071      * - encoding: Set by user.
1072      * - decoding: Set by libavcodec.
1073      */
1074     int id;
1075
1076     /**
1077      * width and height in 1/16 pel
1078      * - encoding: Set by user.
1079      * - decoding: Set by libavcodec.
1080      */
1081     int width;
1082     int height;
1083
1084     /**
1085      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1086      * - encoding: Set by user.
1087      * - decoding: Set by libavcodec.
1088      */
1089     int16_t position[3][2];
1090 }AVPanScan;
1091
1092 /**
1093  * This structure describes the bitrate properties of an encoded bitstream. It
1094  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1095  * parameters for H.264/HEVC.
1096  */
1097 typedef struct AVCPBProperties {
1098     /**
1099      * Maximum bitrate of the stream, in bits per second.
1100      * Zero if unknown or unspecified.
1101      */
1102     int max_bitrate;
1103     /**
1104      * Minimum bitrate of the stream, in bits per second.
1105      * Zero if unknown or unspecified.
1106      */
1107     int min_bitrate;
1108     /**
1109      * Average bitrate of the stream, in bits per second.
1110      * Zero if unknown or unspecified.
1111      */
1112     int avg_bitrate;
1113
1114     /**
1115      * The size of the buffer to which the ratecontrol is applied, in bits.
1116      * Zero if unknown or unspecified.
1117      */
1118     int buffer_size;
1119
1120     /**
1121      * The delay between the time the packet this structure is associated with
1122      * is received and the time when it should be decoded, in periods of a 27MHz
1123      * clock.
1124      *
1125      * UINT64_MAX when unknown or unspecified.
1126      */
1127     uint64_t vbv_delay;
1128 } AVCPBProperties;
1129
1130 /**
1131  * The decoder will keep a reference to the frame and may reuse it later.
1132  */
1133 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1134
1135 /**
1136  * @defgroup lavc_packet AVPacket
1137  *
1138  * Types and functions for working with AVPacket.
1139  * @{
1140  */
1141 enum AVPacketSideDataType {
1142     /**
1143      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1144      * bytes worth of palette. This side data signals that a new palette is
1145      * present.
1146      */
1147     AV_PKT_DATA_PALETTE,
1148
1149     /**
1150      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1151      * that the extradata buffer was changed and the receiving side should
1152      * act upon it appropriately. The new extradata is embedded in the side
1153      * data buffer and should be immediately used for processing the current
1154      * frame or packet.
1155      */
1156     AV_PKT_DATA_NEW_EXTRADATA,
1157
1158     /**
1159      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1160      * @code
1161      * u32le param_flags
1162      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1163      *     s32le channel_count
1164      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1165      *     u64le channel_layout
1166      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1167      *     s32le sample_rate
1168      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1169      *     s32le width
1170      *     s32le height
1171      * @endcode
1172      */
1173     AV_PKT_DATA_PARAM_CHANGE,
1174
1175     /**
1176      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1177      * structures with info about macroblocks relevant to splitting the
1178      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1179      * That is, it does not necessarily contain info about all macroblocks,
1180      * as long as the distance between macroblocks in the info is smaller
1181      * than the target payload size.
1182      * Each MB info structure is 12 bytes, and is laid out as follows:
1183      * @code
1184      * u32le bit offset from the start of the packet
1185      * u8    current quantizer at the start of the macroblock
1186      * u8    GOB number
1187      * u16le macroblock address within the GOB
1188      * u8    horizontal MV predictor
1189      * u8    vertical MV predictor
1190      * u8    horizontal MV predictor for block number 3
1191      * u8    vertical MV predictor for block number 3
1192      * @endcode
1193      */
1194     AV_PKT_DATA_H263_MB_INFO,
1195
1196     /**
1197      * This side data should be associated with an audio stream and contains
1198      * ReplayGain information in form of the AVReplayGain struct.
1199      */
1200     AV_PKT_DATA_REPLAYGAIN,
1201
1202     /**
1203      * This side data contains a 3x3 transformation matrix describing an affine
1204      * transformation that needs to be applied to the decoded video frames for
1205      * correct presentation.
1206      *
1207      * See libavutil/display.h for a detailed description of the data.
1208      */
1209     AV_PKT_DATA_DISPLAYMATRIX,
1210
1211     /**
1212      * This side data should be associated with a video stream and contains
1213      * Stereoscopic 3D information in form of the AVStereo3D struct.
1214      */
1215     AV_PKT_DATA_STEREO3D,
1216
1217     /**
1218      * This side data should be associated with an audio stream and corresponds
1219      * to enum AVAudioServiceType.
1220      */
1221     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1222
1223     /**
1224      * This side data contains an integer value representing the quality
1225      * factor of the compressed frame. Allowed range is between 1 (good)
1226      * and FF_LAMBDA_MAX (bad).
1227      */
1228     AV_PKT_DATA_QUALITY_FACTOR,
1229
1230     /**
1231      * This side data contains an integer value representing the stream index
1232      * of a "fallback" track.  A fallback track indicates an alternate
1233      * track to use when the current track can not be decoded for some reason.
1234      * e.g. no decoder available for codec.
1235      */
1236     AV_PKT_DATA_FALLBACK_TRACK,
1237
1238     /**
1239      * This side data corresponds to the AVCPBProperties struct.
1240      */
1241     AV_PKT_DATA_CPB_PROPERTIES,
1242
1243     /**
1244      * This side data should be associated with a video stream and corresponds
1245      * to the AVSphericalMapping structure.
1246      */
1247     AV_PKT_DATA_SPHERICAL,
1248 };
1249
1250 typedef struct AVPacketSideData {
1251     uint8_t *data;
1252     int      size;
1253     enum AVPacketSideDataType type;
1254 } AVPacketSideData;
1255
1256 /**
1257  * This structure stores compressed data. It is typically exported by demuxers
1258  * and then passed as input to decoders, or received as output from encoders and
1259  * then passed to muxers.
1260  *
1261  * For video, it should typically contain one compressed frame. For audio it may
1262  * contain several compressed frames. Encoders are allowed to output empty
1263  * packets, with no compressed data, containing only side data
1264  * (e.g. to update some stream parameters at the end of encoding).
1265  *
1266  * AVPacket is one of the few structs in Libav, whose size is a part of public
1267  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1268  * without libavcodec and libavformat major bump.
1269  *
1270  * The semantics of data ownership depends on the buf field.
1271  * If it is set, the packet data is dynamically allocated and is
1272  * valid indefinitely until a call to av_packet_unref() reduces the
1273  * reference count to 0.
1274  *
1275  * If the buf field is not set av_packet_ref() would make a copy instead
1276  * of increasing the reference count.
1277  *
1278  * The side data is always allocated with av_malloc(), copied by
1279  * av_packet_ref() and freed by av_packet_unref().
1280  *
1281  * @see av_packet_ref
1282  * @see av_packet_unref
1283  */
1284 typedef struct AVPacket {
1285     /**
1286      * A reference to the reference-counted buffer where the packet data is
1287      * stored.
1288      * May be NULL, then the packet data is not reference-counted.
1289      */
1290     AVBufferRef *buf;
1291     /**
1292      * Presentation timestamp in AVStream->time_base units; the time at which
1293      * the decompressed packet will be presented to the user.
1294      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1295      * pts MUST be larger or equal to dts as presentation cannot happen before
1296      * decompression, unless one wants to view hex dumps. Some formats misuse
1297      * the terms dts and pts/cts to mean something different. Such timestamps
1298      * must be converted to true pts/dts before they are stored in AVPacket.
1299      */
1300     int64_t pts;
1301     /**
1302      * Decompression timestamp in AVStream->time_base units; the time at which
1303      * the packet is decompressed.
1304      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1305      */
1306     int64_t dts;
1307     uint8_t *data;
1308     int   size;
1309     int   stream_index;
1310     /**
1311      * A combination of AV_PKT_FLAG values
1312      */
1313     int   flags;
1314     /**
1315      * Additional packet data that can be provided by the container.
1316      * Packet can contain several types of side information.
1317      */
1318     AVPacketSideData *side_data;
1319     int side_data_elems;
1320
1321     /**
1322      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1323      * Equals next_pts - this_pts in presentation order.
1324      */
1325     int64_t duration;
1326
1327     int64_t pos;                            ///< byte position in stream, -1 if unknown
1328
1329 #if FF_API_CONVERGENCE_DURATION
1330     /**
1331      * @deprecated Same as the duration field, but as int64_t. This was required
1332      * for Matroska subtitles, whose duration values could overflow when the
1333      * duration field was still an int.
1334      */
1335     attribute_deprecated
1336     int64_t convergence_duration;
1337 #endif
1338 } AVPacket;
1339 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1340 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1341
1342 enum AVSideDataParamChangeFlags {
1343     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1344     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1345     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1346     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1347 };
1348 /**
1349  * @}
1350  */
1351
1352 struct AVCodecInternal;
1353
1354 enum AVFieldOrder {
1355     AV_FIELD_UNKNOWN,
1356     AV_FIELD_PROGRESSIVE,
1357     AV_FIELD_TT,          //< Top coded_first, top displayed first
1358     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1359     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1360     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1361 };
1362
1363 /**
1364  * main external API structure.
1365  * New fields can be added to the end with minor version bumps.
1366  * Removal, reordering and changes to existing fields require a major
1367  * version bump.
1368  * sizeof(AVCodecContext) must not be used outside libav*.
1369  */
1370 typedef struct AVCodecContext {
1371     /**
1372      * information on struct for av_log
1373      * - set by avcodec_alloc_context3
1374      */
1375     const AVClass *av_class;
1376     int log_level_offset;
1377
1378     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1379     const struct AVCodec  *codec;
1380 #if FF_API_CODEC_NAME
1381     /**
1382      * @deprecated this field is not used for anything in libavcodec
1383      */
1384     attribute_deprecated
1385     char             codec_name[32];
1386 #endif
1387     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1388
1389     /**
1390      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1391      * This is used to work around some encoder bugs.
1392      * A demuxer should set this to what is stored in the field used to identify the codec.
1393      * If there are multiple such fields in a container then the demuxer should choose the one
1394      * which maximizes the information about the used codec.
1395      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1396      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1397      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1398      * first.
1399      * - encoding: Set by user, if not then the default based on codec_id will be used.
1400      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1401      */
1402     unsigned int codec_tag;
1403
1404 #if FF_API_STREAM_CODEC_TAG
1405     /**
1406      * @deprecated this field is unused
1407      */
1408     attribute_deprecated
1409     unsigned int stream_codec_tag;
1410 #endif
1411
1412     void *priv_data;
1413
1414     /**
1415      * Private context used for internal data.
1416      *
1417      * Unlike priv_data, this is not codec-specific. It is used in general
1418      * libavcodec functions.
1419      */
1420     struct AVCodecInternal *internal;
1421
1422     /**
1423      * Private data of the user, can be used to carry app specific stuff.
1424      * - encoding: Set by user.
1425      * - decoding: Set by user.
1426      */
1427     void *opaque;
1428
1429     /**
1430      * the average bitrate
1431      * - encoding: Set by user; unused for constant quantizer encoding.
1432      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1433      */
1434     int bit_rate;
1435
1436     /**
1437      * number of bits the bitstream is allowed to diverge from the reference.
1438      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1439      * - encoding: Set by user; unused for constant quantizer encoding.
1440      * - decoding: unused
1441      */
1442     int bit_rate_tolerance;
1443
1444     /**
1445      * Global quality for codecs which cannot change it per frame.
1446      * This should be proportional to MPEG-1/2/4 qscale.
1447      * - encoding: Set by user.
1448      * - decoding: unused
1449      */
1450     int global_quality;
1451
1452     /**
1453      * - encoding: Set by user.
1454      * - decoding: unused
1455      */
1456     int compression_level;
1457 #define FF_COMPRESSION_DEFAULT -1
1458
1459     /**
1460      * AV_CODEC_FLAG_*.
1461      * - encoding: Set by user.
1462      * - decoding: Set by user.
1463      */
1464     int flags;
1465
1466     /**
1467      * AV_CODEC_FLAG2_*
1468      * - encoding: Set by user.
1469      * - decoding: Set by user.
1470      */
1471     int flags2;
1472
1473     /**
1474      * some codecs need / can use extradata like Huffman tables.
1475      * MJPEG: Huffman tables
1476      * rv10: additional flags
1477      * MPEG-4: global headers (they can be in the bitstream or here)
1478      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1479      * than extradata_size to avoid problems if it is read with the bitstream reader.
1480      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1481      * - encoding: Set/allocated/freed by libavcodec.
1482      * - decoding: Set/allocated/freed by user.
1483      */
1484     uint8_t *extradata;
1485     int extradata_size;
1486
1487     /**
1488      * This is the fundamental unit of time (in seconds) in terms
1489      * of which frame timestamps are represented. For fixed-fps content,
1490      * timebase should be 1/framerate and timestamp increments should be
1491      * identically 1.
1492      * - encoding: MUST be set by user.
1493      * - decoding: the use of this field for decoding is deprecated.
1494      *             Use framerate instead.
1495      */
1496     AVRational time_base;
1497
1498     /**
1499      * For some codecs, the time base is closer to the field rate than the frame rate.
1500      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1501      * if no telecine is used ...
1502      *
1503      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1504      */
1505     int ticks_per_frame;
1506
1507     /**
1508      * Codec delay.
1509      *
1510      * Video:
1511      *   Number of frames the decoded output will be delayed relative to the
1512      *   encoded input.
1513      *
1514      * Audio:
1515      *   For encoding, this field is unused (see initial_padding).
1516      *
1517      *   For decoding, this is the number of samples the decoder needs to
1518      *   output before the decoder's output is valid. When seeking, you should
1519      *   start decoding this many samples prior to your desired seek point.
1520      *
1521      * - encoding: Set by libavcodec.
1522      * - decoding: Set by libavcodec.
1523      */
1524     int delay;
1525
1526
1527     /* video only */
1528     /**
1529      * picture width / height.
1530      *
1531      * @note Those fields may not match the values of the last
1532      * AVFrame output by avcodec_decode_video2 due frame
1533      * reordering.
1534      *
1535      * - encoding: MUST be set by user.
1536      * - decoding: May be set by the user before opening the decoder if known e.g.
1537      *             from the container. Some decoders will require the dimensions
1538      *             to be set by the caller. During decoding, the decoder may
1539      *             overwrite those values as required while parsing the data.
1540      */
1541     int width, height;
1542
1543     /**
1544      * Bitstream width / height, may be different from width/height e.g. when
1545      * the decoded frame is cropped before being output.
1546      *
1547      * @note Those field may not match the value of the last
1548      * AVFrame output by avcodec_receive_frame() due frame
1549      * reordering.
1550      *
1551      * - encoding: unused
1552      * - decoding: May be set by the user before opening the decoder if known
1553      *             e.g. from the container. During decoding, the decoder may
1554      *             overwrite those values as required while parsing the data.
1555      */
1556     int coded_width, coded_height;
1557
1558     /**
1559      * the number of pictures in a group of pictures, or 0 for intra_only
1560      * - encoding: Set by user.
1561      * - decoding: unused
1562      */
1563     int gop_size;
1564
1565     /**
1566      * Pixel format, see AV_PIX_FMT_xxx.
1567      * May be set by the demuxer if known from headers.
1568      * May be overridden by the decoder if it knows better.
1569      *
1570      * @note This field may not match the value of the last
1571      * AVFrame output by avcodec_receive_frame() due frame
1572      * reordering.
1573      *
1574      * - encoding: Set by user.
1575      * - decoding: Set by user if known, overridden by libavcodec while
1576      *             parsing the data.
1577      */
1578     enum AVPixelFormat pix_fmt;
1579
1580 #if FF_API_MOTION_EST
1581     /**
1582      * This option does nothing
1583      * @deprecated use codec private options instead
1584      */
1585     attribute_deprecated int me_method;
1586 #endif
1587
1588     /**
1589      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1590      * decoder to draw a horizontal band. It improves cache usage. Not
1591      * all codecs can do that. You must check the codec capabilities
1592      * beforehand.
1593      * When multithreading is used, it may be called from multiple threads
1594      * at the same time; threads might draw different parts of the same AVFrame,
1595      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1596      * in order.
1597      * The function is also used by hardware acceleration APIs.
1598      * It is called at least once during frame decoding to pass
1599      * the data needed for hardware render.
1600      * In that mode instead of pixel data, AVFrame points to
1601      * a structure specific to the acceleration API. The application
1602      * reads the structure and can change some fields to indicate progress
1603      * or mark state.
1604      * - encoding: unused
1605      * - decoding: Set by user.
1606      * @param height the height of the slice
1607      * @param y the y position of the slice
1608      * @param type 1->top field, 2->bottom field, 3->frame
1609      * @param offset offset into the AVFrame.data from which the slice should be read
1610      */
1611     void (*draw_horiz_band)(struct AVCodecContext *s,
1612                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1613                             int y, int type, int height);
1614
1615     /**
1616      * callback to negotiate the pixelFormat
1617      * @param fmt is the list of formats which are supported by the codec,
1618      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1619      * The first is always the native one.
1620      * @note The callback may be called again immediately if initialization for
1621      * the selected (hardware-accelerated) pixel format failed.
1622      * @warning Behavior is undefined if the callback returns a value not
1623      * in the fmt list of formats.
1624      * @return the chosen format
1625      * - encoding: unused
1626      * - decoding: Set by user, if not set the native format will be chosen.
1627      */
1628     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1629
1630     /**
1631      * maximum number of B-frames between non-B-frames
1632      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1633      * - encoding: Set by user.
1634      * - decoding: unused
1635      */
1636     int max_b_frames;
1637
1638     /**
1639      * qscale factor between IP and B-frames
1640      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1641      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1642      * - encoding: Set by user.
1643      * - decoding: unused
1644      */
1645     float b_quant_factor;
1646
1647 #if FF_API_RC_STRATEGY
1648     /** @deprecated use codec private option instead */
1649     attribute_deprecated int rc_strategy;
1650 #define FF_RC_STRATEGY_XVID 1
1651 #endif
1652
1653 #if FF_API_PRIVATE_OPT
1654     /** @deprecated use encoder private options instead */
1655     attribute_deprecated
1656     int b_frame_strategy;
1657 #endif
1658
1659     /**
1660      * qscale offset between IP and B-frames
1661      * - encoding: Set by user.
1662      * - decoding: unused
1663      */
1664     float b_quant_offset;
1665
1666     /**
1667      * Size of the frame reordering buffer in the decoder.
1668      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1669      * - encoding: Set by libavcodec.
1670      * - decoding: Set by libavcodec.
1671      */
1672     int has_b_frames;
1673
1674 #if FF_API_PRIVATE_OPT
1675     /** @deprecated use encoder private options instead */
1676     attribute_deprecated
1677     int mpeg_quant;
1678 #endif
1679
1680     /**
1681      * qscale factor between P- and I-frames
1682      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1683      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1684      * - encoding: Set by user.
1685      * - decoding: unused
1686      */
1687     float i_quant_factor;
1688
1689     /**
1690      * qscale offset between P and I-frames
1691      * - encoding: Set by user.
1692      * - decoding: unused
1693      */
1694     float i_quant_offset;
1695
1696     /**
1697      * luminance masking (0-> disabled)
1698      * - encoding: Set by user.
1699      * - decoding: unused
1700      */
1701     float lumi_masking;
1702
1703     /**
1704      * temporary complexity masking (0-> disabled)
1705      * - encoding: Set by user.
1706      * - decoding: unused
1707      */
1708     float temporal_cplx_masking;
1709
1710     /**
1711      * spatial complexity masking (0-> disabled)
1712      * - encoding: Set by user.
1713      * - decoding: unused
1714      */
1715     float spatial_cplx_masking;
1716
1717     /**
1718      * p block masking (0-> disabled)
1719      * - encoding: Set by user.
1720      * - decoding: unused
1721      */
1722     float p_masking;
1723
1724     /**
1725      * darkness masking (0-> disabled)
1726      * - encoding: Set by user.
1727      * - decoding: unused
1728      */
1729     float dark_masking;
1730
1731     /**
1732      * slice count
1733      * - encoding: Set by libavcodec.
1734      * - decoding: Set by user (or 0).
1735      */
1736     int slice_count;
1737
1738 #if FF_API_PRIVATE_OPT
1739     /** @deprecated use encoder private options instead */
1740     attribute_deprecated
1741      int prediction_method;
1742 #define FF_PRED_LEFT   0
1743 #define FF_PRED_PLANE  1
1744 #define FF_PRED_MEDIAN 2
1745 #endif
1746
1747     /**
1748      * slice offsets in the frame in bytes
1749      * - encoding: Set/allocated by libavcodec.
1750      * - decoding: Set/allocated by user (or NULL).
1751      */
1752     int *slice_offset;
1753
1754     /**
1755      * sample aspect ratio (0 if unknown)
1756      * That is the width of a pixel divided by the height of the pixel.
1757      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1758      * - encoding: Set by user.
1759      * - decoding: Set by libavcodec.
1760      */
1761     AVRational sample_aspect_ratio;
1762
1763     /**
1764      * motion estimation comparison function
1765      * - encoding: Set by user.
1766      * - decoding: unused
1767      */
1768     int me_cmp;
1769     /**
1770      * subpixel motion estimation comparison function
1771      * - encoding: Set by user.
1772      * - decoding: unused
1773      */
1774     int me_sub_cmp;
1775     /**
1776      * macroblock comparison function (not supported yet)
1777      * - encoding: Set by user.
1778      * - decoding: unused
1779      */
1780     int mb_cmp;
1781     /**
1782      * interlaced DCT comparison function
1783      * - encoding: Set by user.
1784      * - decoding: unused
1785      */
1786     int ildct_cmp;
1787 #define FF_CMP_SAD    0
1788 #define FF_CMP_SSE    1
1789 #define FF_CMP_SATD   2
1790 #define FF_CMP_DCT    3
1791 #define FF_CMP_PSNR   4
1792 #define FF_CMP_BIT    5
1793 #define FF_CMP_RD     6
1794 #define FF_CMP_ZERO   7
1795 #define FF_CMP_VSAD   8
1796 #define FF_CMP_VSSE   9
1797 #define FF_CMP_NSSE   10
1798 #define FF_CMP_DCTMAX 13
1799 #define FF_CMP_DCT264 14
1800 #define FF_CMP_CHROMA 256
1801
1802     /**
1803      * ME diamond size & shape
1804      * - encoding: Set by user.
1805      * - decoding: unused
1806      */
1807     int dia_size;
1808
1809     /**
1810      * amount of previous MV predictors (2a+1 x 2a+1 square)
1811      * - encoding: Set by user.
1812      * - decoding: unused
1813      */
1814     int last_predictor_count;
1815
1816 #if FF_API_PRIVATE_OPT
1817     /** @deprecated use encoder private options instead */
1818     attribute_deprecated
1819     int pre_me;
1820 #endif
1821
1822     /**
1823      * motion estimation prepass comparison function
1824      * - encoding: Set by user.
1825      * - decoding: unused
1826      */
1827     int me_pre_cmp;
1828
1829     /**
1830      * ME prepass diamond size & shape
1831      * - encoding: Set by user.
1832      * - decoding: unused
1833      */
1834     int pre_dia_size;
1835
1836     /**
1837      * subpel ME quality
1838      * - encoding: Set by user.
1839      * - decoding: unused
1840      */
1841     int me_subpel_quality;
1842
1843 #if FF_API_AFD
1844     /**
1845      * DTG active format information (additional aspect ratio
1846      * information only used in DVB MPEG-2 transport streams)
1847      * 0 if not set.
1848      *
1849      * - encoding: unused
1850      * - decoding: Set by decoder.
1851      * @deprecated Deprecated in favor of AVSideData
1852      */
1853     attribute_deprecated int dtg_active_format;
1854 #define FF_DTG_AFD_SAME         8
1855 #define FF_DTG_AFD_4_3          9
1856 #define FF_DTG_AFD_16_9         10
1857 #define FF_DTG_AFD_14_9         11
1858 #define FF_DTG_AFD_4_3_SP_14_9  13
1859 #define FF_DTG_AFD_16_9_SP_14_9 14
1860 #define FF_DTG_AFD_SP_4_3       15
1861 #endif /* FF_API_AFD */
1862
1863     /**
1864      * maximum motion estimation search range in subpel units
1865      * If 0 then no limit.
1866      *
1867      * - encoding: Set by user.
1868      * - decoding: unused
1869      */
1870     int me_range;
1871
1872 #if FF_API_QUANT_BIAS
1873     /**
1874      * @deprecated use encoder private option instead
1875      */
1876     attribute_deprecated int intra_quant_bias;
1877 #define FF_DEFAULT_QUANT_BIAS 999999
1878
1879     /**
1880      * @deprecated use encoder private option instead
1881      */
1882     attribute_deprecated int inter_quant_bias;
1883 #endif
1884
1885     /**
1886      * slice flags
1887      * - encoding: unused
1888      * - decoding: Set by user.
1889      */
1890     int slice_flags;
1891 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1892 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1893 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1894
1895     /**
1896      * macroblock decision mode
1897      * - encoding: Set by user.
1898      * - decoding: unused
1899      */
1900     int mb_decision;
1901 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1902 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1903 #define FF_MB_DECISION_RD     2        ///< rate distortion
1904
1905     /**
1906      * custom intra quantization matrix
1907      * - encoding: Set by user, can be NULL.
1908      * - decoding: Set by libavcodec.
1909      */
1910     uint16_t *intra_matrix;
1911
1912     /**
1913      * custom inter quantization matrix
1914      * - encoding: Set by user, can be NULL.
1915      * - decoding: Set by libavcodec.
1916      */
1917     uint16_t *inter_matrix;
1918
1919 #if FF_API_PRIVATE_OPT
1920     /** @deprecated use encoder private options instead */
1921     attribute_deprecated
1922     int scenechange_threshold;
1923
1924     /** @deprecated use encoder private options instead */
1925     attribute_deprecated
1926     int noise_reduction;
1927 #endif
1928
1929 #if FF_API_MPV_OPT
1930     /**
1931      * @deprecated this field is unused
1932      */
1933     attribute_deprecated
1934     int me_threshold;
1935
1936     /**
1937      * @deprecated this field is unused
1938      */
1939     attribute_deprecated
1940     int mb_threshold;
1941 #endif
1942
1943     /**
1944      * precision of the intra DC coefficient - 8
1945      * - encoding: Set by user.
1946      * - decoding: unused
1947      */
1948     int intra_dc_precision;
1949
1950     /**
1951      * Number of macroblock rows at the top which are skipped.
1952      * - encoding: unused
1953      * - decoding: Set by user.
1954      */
1955     int skip_top;
1956
1957     /**
1958      * Number of macroblock rows at the bottom which are skipped.
1959      * - encoding: unused
1960      * - decoding: Set by user.
1961      */
1962     int skip_bottom;
1963
1964 #if FF_API_MPV_OPT
1965     /**
1966      * @deprecated use encoder private options instead
1967      */
1968     attribute_deprecated
1969     float border_masking;
1970 #endif
1971
1972     /**
1973      * minimum MB Lagrange multiplier
1974      * - encoding: Set by user.
1975      * - decoding: unused
1976      */
1977     int mb_lmin;
1978
1979     /**
1980      * maximum MB Lagrange multiplier
1981      * - encoding: Set by user.
1982      * - decoding: unused
1983      */
1984     int mb_lmax;
1985
1986 #if FF_API_PRIVATE_OPT
1987     /**
1988      * @deprecated use encoder private options instead
1989      */
1990     attribute_deprecated
1991     int me_penalty_compensation;
1992 #endif
1993
1994     /**
1995      * - encoding: Set by user.
1996      * - decoding: unused
1997      */
1998     int bidir_refine;
1999
2000 #if FF_API_PRIVATE_OPT
2001     /** @deprecated use encoder private options instead */
2002     attribute_deprecated
2003     int brd_scale;
2004 #endif
2005
2006     /**
2007      * minimum GOP size
2008      * - encoding: Set by user.
2009      * - decoding: unused
2010      */
2011     int keyint_min;
2012
2013     /**
2014      * number of reference frames
2015      * - encoding: Set by user.
2016      * - decoding: Set by lavc.
2017      */
2018     int refs;
2019
2020 #if FF_API_PRIVATE_OPT
2021     /** @deprecated use encoder private options instead */
2022     attribute_deprecated
2023     int chromaoffset;
2024 #endif
2025
2026 #if FF_API_UNUSED_MEMBERS
2027     /**
2028      * Multiplied by qscale for each frame and added to scene_change_score.
2029      * - encoding: Set by user.
2030      * - decoding: unused
2031      */
2032     attribute_deprecated int scenechange_factor;
2033 #endif
2034
2035     /**
2036      * Note: Value depends upon the compare function used for fullpel ME.
2037      * - encoding: Set by user.
2038      * - decoding: unused
2039      */
2040     int mv0_threshold;
2041
2042 #if FF_API_PRIVATE_OPT
2043     /** @deprecated use encoder private options instead */
2044     attribute_deprecated
2045     int b_sensitivity;
2046 #endif
2047
2048     /**
2049      * Chromaticity coordinates of the source primaries.
2050      * - encoding: Set by user
2051      * - decoding: Set by libavcodec
2052      */
2053     enum AVColorPrimaries color_primaries;
2054
2055     /**
2056      * Color Transfer Characteristic.
2057      * - encoding: Set by user
2058      * - decoding: Set by libavcodec
2059      */
2060     enum AVColorTransferCharacteristic color_trc;
2061
2062     /**
2063      * YUV colorspace type.
2064      * - encoding: Set by user
2065      * - decoding: Set by libavcodec
2066      */
2067     enum AVColorSpace colorspace;
2068
2069     /**
2070      * MPEG vs JPEG YUV range.
2071      * - encoding: Set by user
2072      * - decoding: Set by libavcodec
2073      */
2074     enum AVColorRange color_range;
2075
2076     /**
2077      * This defines the location of chroma samples.
2078      * - encoding: Set by user
2079      * - decoding: Set by libavcodec
2080      */
2081     enum AVChromaLocation chroma_sample_location;
2082
2083     /**
2084      * Number of slices.
2085      * Indicates number of picture subdivisions. Used for parallelized
2086      * decoding.
2087      * - encoding: Set by user
2088      * - decoding: unused
2089      */
2090     int slices;
2091
2092     /** Field order
2093      * - encoding: set by libavcodec
2094      * - decoding: Set by libavcodec
2095      */
2096     enum AVFieldOrder field_order;
2097
2098     /* audio only */
2099     int sample_rate; ///< samples per second
2100     int channels;    ///< number of audio channels
2101
2102     /**
2103      * audio sample format
2104      * - encoding: Set by user.
2105      * - decoding: Set by libavcodec.
2106      */
2107     enum AVSampleFormat sample_fmt;  ///< sample format
2108
2109     /* The following data should not be initialized. */
2110     /**
2111      * Number of samples per channel in an audio frame.
2112      *
2113      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2114      *   except the last must contain exactly frame_size samples per channel.
2115      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2116      *   frame size is not restricted.
2117      * - decoding: may be set by some decoders to indicate constant frame size
2118      */
2119     int frame_size;
2120
2121     /**
2122      * Frame counter, set by libavcodec.
2123      *
2124      * - decoding: total number of frames returned from the decoder so far.
2125      * - encoding: total number of frames passed to the encoder so far.
2126      *
2127      *   @note the counter is not incremented if encoding/decoding resulted in
2128      *   an error.
2129      */
2130     int frame_number;
2131
2132     /**
2133      * number of bytes per packet if constant and known or 0
2134      * Used by some WAV based audio codecs.
2135      */
2136     int block_align;
2137
2138     /**
2139      * Audio cutoff bandwidth (0 means "automatic")
2140      * - encoding: Set by user.
2141      * - decoding: unused
2142      */
2143     int cutoff;
2144
2145     /**
2146      * Audio channel layout.
2147      * - encoding: set by user.
2148      * - decoding: set by libavcodec.
2149      */
2150     uint64_t channel_layout;
2151
2152     /**
2153      * Request decoder to use this channel layout if it can (0 for default)
2154      * - encoding: unused
2155      * - decoding: Set by user.
2156      */
2157     uint64_t request_channel_layout;
2158
2159     /**
2160      * Type of service that the audio stream conveys.
2161      * - encoding: Set by user.
2162      * - decoding: Set by libavcodec.
2163      */
2164     enum AVAudioServiceType audio_service_type;
2165
2166     /**
2167      * Used to request a sample format from the decoder.
2168      * - encoding: unused.
2169      * - decoding: Set by user.
2170      */
2171     enum AVSampleFormat request_sample_fmt;
2172
2173     /**
2174      * This callback is called at the beginning of each frame to get data
2175      * buffer(s) for it. There may be one contiguous buffer for all the data or
2176      * there may be a buffer per each data plane or anything in between. What
2177      * this means is, you may set however many entries in buf[] you feel necessary.
2178      * Each buffer must be reference-counted using the AVBuffer API (see description
2179      * of buf[] below).
2180      *
2181      * The following fields will be set in the frame before this callback is
2182      * called:
2183      * - format
2184      * - width, height (video only)
2185      * - sample_rate, channel_layout, nb_samples (audio only)
2186      * Their values may differ from the corresponding values in
2187      * AVCodecContext. This callback must use the frame values, not the codec
2188      * context values, to calculate the required buffer size.
2189      *
2190      * This callback must fill the following fields in the frame:
2191      * - data[]
2192      * - linesize[]
2193      * - extended_data:
2194      *   * if the data is planar audio with more than 8 channels, then this
2195      *     callback must allocate and fill extended_data to contain all pointers
2196      *     to all data planes. data[] must hold as many pointers as it can.
2197      *     extended_data must be allocated with av_malloc() and will be freed in
2198      *     av_frame_unref().
2199      *   * otherwise extended_data must point to data
2200      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2201      *   the frame's data and extended_data pointers must be contained in these. That
2202      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2203      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2204      *   and av_buffer_ref().
2205      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2206      *   this callback and filled with the extra buffers if there are more
2207      *   buffers than buf[] can hold. extended_buf will be freed in
2208      *   av_frame_unref().
2209      *
2210      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2211      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2212      * some other means.
2213      *
2214      * Each data plane must be aligned to the maximum required by the target
2215      * CPU.
2216      *
2217      * @see avcodec_default_get_buffer2()
2218      *
2219      * Video:
2220      *
2221      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2222      * (read and/or written to if it is writable) later by libavcodec.
2223      *
2224      * avcodec_align_dimensions2() should be used to find the required width and
2225      * height, as they normally need to be rounded up to the next multiple of 16.
2226      *
2227      * If frame multithreading is used and thread_safe_callbacks is set,
2228      * this callback may be called from a different thread, but not from more
2229      * than one at once. Does not need to be reentrant.
2230      *
2231      * @see avcodec_align_dimensions2()
2232      *
2233      * Audio:
2234      *
2235      * Decoders request a buffer of a particular size by setting
2236      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2237      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2238      * to a smaller value in the output frame.
2239      *
2240      * As a convenience, av_samples_get_buffer_size() and
2241      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2242      * functions to find the required data size and to fill data pointers and
2243      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2244      * since all planes must be the same size.
2245      *
2246      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2247      *
2248      * - encoding: unused
2249      * - decoding: Set by libavcodec, user can override.
2250      */
2251     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2252
2253     /**
2254      * If non-zero, the decoded audio and video frames returned from
2255      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2256      * and are valid indefinitely. The caller must free them with
2257      * av_frame_unref() when they are not needed anymore.
2258      * Otherwise, the decoded frames must not be freed by the caller and are
2259      * only valid until the next decode call.
2260      *
2261      * This is always automatically enabled if avcodec_receive_frame() is used.
2262      *
2263      * - encoding: unused
2264      * - decoding: set by the caller before avcodec_open2().
2265      */
2266     attribute_deprecated int refcounted_frames;
2267
2268     /* - encoding parameters */
2269     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2270     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2271
2272     /**
2273      * minimum quantizer
2274      * - encoding: Set by user.
2275      * - decoding: unused
2276      */
2277     int qmin;
2278
2279     /**
2280      * maximum quantizer
2281      * - encoding: Set by user.
2282      * - decoding: unused
2283      */
2284     int qmax;
2285
2286     /**
2287      * maximum quantizer difference between frames
2288      * - encoding: Set by user.
2289      * - decoding: unused
2290      */
2291     int max_qdiff;
2292
2293 #if FF_API_MPV_OPT
2294     /**
2295      * @deprecated use encoder private options instead
2296      */
2297     attribute_deprecated
2298     float rc_qsquish;
2299
2300     attribute_deprecated
2301     float rc_qmod_amp;
2302     attribute_deprecated
2303     int rc_qmod_freq;
2304 #endif
2305
2306     /**
2307      * decoder bitstream buffer size
2308      * - encoding: Set by user.
2309      * - decoding: unused
2310      */
2311     int rc_buffer_size;
2312
2313     /**
2314      * ratecontrol override, see RcOverride
2315      * - encoding: Allocated/set/freed by user.
2316      * - decoding: unused
2317      */
2318     int rc_override_count;
2319     RcOverride *rc_override;
2320
2321 #if FF_API_MPV_OPT
2322     /**
2323      * @deprecated use encoder private options instead
2324      */
2325     attribute_deprecated
2326     const char *rc_eq;
2327 #endif
2328
2329     /**
2330      * maximum bitrate
2331      * - encoding: Set by user.
2332      * - decoding: unused
2333      */
2334     int rc_max_rate;
2335
2336     /**
2337      * minimum bitrate
2338      * - encoding: Set by user.
2339      * - decoding: unused
2340      */
2341     int rc_min_rate;
2342
2343 #if FF_API_MPV_OPT
2344     /**
2345      * @deprecated use encoder private options instead
2346      */
2347     attribute_deprecated
2348     float rc_buffer_aggressivity;
2349
2350     attribute_deprecated
2351     float rc_initial_cplx;
2352 #endif
2353
2354     /**
2355      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2356      * - encoding: Set by user.
2357      * - decoding: unused.
2358      */
2359     float rc_max_available_vbv_use;
2360
2361     /**
2362      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2363      * - encoding: Set by user.
2364      * - decoding: unused.
2365      */
2366     float rc_min_vbv_overflow_use;
2367
2368     /**
2369      * Number of bits which should be loaded into the rc buffer before decoding starts.
2370      * - encoding: Set by user.
2371      * - decoding: unused
2372      */
2373     int rc_initial_buffer_occupancy;
2374
2375 #if FF_API_CODER_TYPE
2376 #define FF_CODER_TYPE_VLC       0
2377 #define FF_CODER_TYPE_AC        1
2378 #define FF_CODER_TYPE_RAW       2
2379 #define FF_CODER_TYPE_RLE       3
2380 #if FF_API_UNUSED_MEMBERS
2381 #define FF_CODER_TYPE_DEFLATE   4
2382 #endif /* FF_API_UNUSED_MEMBERS */
2383     /**
2384      * @deprecated use encoder private options instead
2385      */
2386     attribute_deprecated
2387     int coder_type;
2388 #endif /* FF_API_CODER_TYPE */
2389
2390 #if FF_API_PRIVATE_OPT
2391     /** @deprecated use encoder private options instead */
2392     attribute_deprecated
2393     int context_model;
2394 #endif
2395
2396 #if FF_API_MPV_OPT
2397     /**
2398      * @deprecated use encoder private options instead
2399      */
2400     attribute_deprecated
2401     int lmin;
2402
2403     /**
2404      * @deprecated use encoder private options instead
2405      */
2406     attribute_deprecated
2407     int lmax;
2408 #endif
2409
2410 #if FF_API_PRIVATE_OPT
2411     /** @deprecated use encoder private options instead */
2412     attribute_deprecated
2413     int frame_skip_threshold;
2414
2415     /** @deprecated use encoder private options instead */
2416     attribute_deprecated
2417     int frame_skip_factor;
2418
2419     /** @deprecated use encoder private options instead */
2420     attribute_deprecated
2421     int frame_skip_exp;
2422
2423     /** @deprecated use encoder private options instead */
2424     attribute_deprecated
2425     int frame_skip_cmp;
2426 #endif /* FF_API_PRIVATE_OPT */
2427
2428     /**
2429      * trellis RD quantization
2430      * - encoding: Set by user.
2431      * - decoding: unused
2432      */
2433     int trellis;
2434
2435 #if FF_API_PRIVATE_OPT
2436     /** @deprecated use encoder private options instead */
2437     attribute_deprecated
2438     int min_prediction_order;
2439
2440     /** @deprecated use encoder private options instead */
2441     attribute_deprecated
2442     int max_prediction_order;
2443
2444     /** @deprecated use encoder private options instead */
2445     attribute_deprecated
2446     int64_t timecode_frame_start;
2447 #endif
2448
2449 #if FF_API_RTP_CALLBACK
2450     /**
2451      * @deprecated unused
2452      */
2453     /* The RTP callback: This function is called    */
2454     /* every time the encoder has a packet to send. */
2455     /* It depends on the encoder if the data starts */
2456     /* with a Start Code (it should). H.263 does.   */
2457     /* mb_nb contains the number of macroblocks     */
2458     /* encoded in the RTP payload.                  */
2459     attribute_deprecated
2460     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2461 #endif
2462
2463 #if FF_API_PRIVATE_OPT
2464     /** @deprecated use encoder private options instead */
2465     attribute_deprecated
2466     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2467                             /* do its best to deliver a chunk with size     */
2468                             /* below rtp_payload_size, the chunk will start */
2469                             /* with a start code on some codecs like H.263. */
2470                             /* This doesn't take account of any particular  */
2471                             /* headers inside the transmitted RTP payload.  */
2472 #endif
2473
2474 #if FF_API_STAT_BITS
2475     /* statistics, used for 2-pass encoding */
2476     attribute_deprecated
2477     int mv_bits;
2478     attribute_deprecated
2479     int header_bits;
2480     attribute_deprecated
2481     int i_tex_bits;
2482     attribute_deprecated
2483     int p_tex_bits;
2484     attribute_deprecated
2485     int i_count;
2486     attribute_deprecated
2487     int p_count;
2488     attribute_deprecated
2489     int skip_count;
2490     attribute_deprecated
2491     int misc_bits;
2492
2493     /** @deprecated this field is unused */
2494     attribute_deprecated
2495     int frame_bits;
2496 #endif
2497
2498     /**
2499      * pass1 encoding statistics output buffer
2500      * - encoding: Set by libavcodec.
2501      * - decoding: unused
2502      */
2503     char *stats_out;
2504
2505     /**
2506      * pass2 encoding statistics input buffer
2507      * Concatenated stuff from stats_out of pass1 should be placed here.
2508      * - encoding: Allocated/set/freed by user.
2509      * - decoding: unused
2510      */
2511     char *stats_in;
2512
2513     /**
2514      * Work around bugs in encoders which sometimes cannot be detected automatically.
2515      * - encoding: Set by user
2516      * - decoding: Set by user
2517      */
2518     int workaround_bugs;
2519 #define FF_BUG_AUTODETECT       1  ///< autodetection
2520 #define FF_BUG_XVID_ILACE       4
2521 #define FF_BUG_UMP4             8
2522 #define FF_BUG_NO_PADDING       16
2523 #define FF_BUG_AMV              32
2524 #define FF_BUG_QPEL_CHROMA      64
2525 #define FF_BUG_STD_QPEL         128
2526 #define FF_BUG_QPEL_CHROMA2     256
2527 #define FF_BUG_DIRECT_BLOCKSIZE 512
2528 #define FF_BUG_EDGE             1024
2529 #define FF_BUG_HPEL_CHROMA      2048
2530 #define FF_BUG_DC_CLIP          4096
2531 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2532 #define FF_BUG_TRUNCATED       16384
2533
2534     /**
2535      * strictly follow the standard (MPEG-4, ...).
2536      * - encoding: Set by user.
2537      * - decoding: Set by user.
2538      * Setting this to STRICT or higher means the encoder and decoder will
2539      * generally do stupid things, whereas setting it to unofficial or lower
2540      * will mean the encoder might produce output that is not supported by all
2541      * spec-compliant decoders. Decoders don't differentiate between normal,
2542      * unofficial and experimental (that is, they always try to decode things
2543      * when they can) unless they are explicitly asked to behave stupidly
2544      * (=strictly conform to the specs)
2545      */
2546     int strict_std_compliance;
2547 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2548 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2549 #define FF_COMPLIANCE_NORMAL        0
2550 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2551 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2552
2553     /**
2554      * error concealment flags
2555      * - encoding: unused
2556      * - decoding: Set by user.
2557      */
2558     int error_concealment;
2559 #define FF_EC_GUESS_MVS   1
2560 #define FF_EC_DEBLOCK     2
2561
2562     /**
2563      * debug
2564      * - encoding: Set by user.
2565      * - decoding: Set by user.
2566      */
2567     int debug;
2568 #define FF_DEBUG_PICT_INFO   1
2569 #define FF_DEBUG_RC          2
2570 #define FF_DEBUG_BITSTREAM   4
2571 #define FF_DEBUG_MB_TYPE     8
2572 #define FF_DEBUG_QP          16
2573 #define FF_DEBUG_DCT_COEFF   0x00000040
2574 #define FF_DEBUG_SKIP        0x00000080
2575 #define FF_DEBUG_STARTCODE   0x00000100
2576 #if FF_API_UNUSED_MEMBERS
2577 #define FF_DEBUG_PTS         0x00000200
2578 #endif /* FF_API_UNUSED_MEMBERS */
2579 #define FF_DEBUG_ER          0x00000400
2580 #define FF_DEBUG_MMCO        0x00000800
2581 #define FF_DEBUG_BUGS        0x00001000
2582 #define FF_DEBUG_BUFFERS     0x00008000
2583 #define FF_DEBUG_THREADS     0x00010000
2584
2585     /**
2586      * Error recognition; may misdetect some more or less valid parts as errors.
2587      * - encoding: unused
2588      * - decoding: Set by user.
2589      */
2590     int err_recognition;
2591
2592 /**
2593  * Verify checksums embedded in the bitstream (could be of either encoded or
2594  * decoded data, depending on the codec) and print an error message on mismatch.
2595  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2596  * decoder returning an error.
2597  */
2598 #define AV_EF_CRCCHECK  (1<<0)
2599 #define AV_EF_BITSTREAM (1<<1)
2600 #define AV_EF_BUFFER    (1<<2)
2601 #define AV_EF_EXPLODE   (1<<3)
2602
2603     /**
2604      * opaque 64-bit number (generally a PTS) that will be reordered and
2605      * output in AVFrame.reordered_opaque
2606      * - encoding: unused
2607      * - decoding: Set by user.
2608      */
2609     int64_t reordered_opaque;
2610
2611     /**
2612      * Hardware accelerator in use
2613      * - encoding: unused.
2614      * - decoding: Set by libavcodec
2615      */
2616     struct AVHWAccel *hwaccel;
2617
2618     /**
2619      * Hardware accelerator context.
2620      * For some hardware accelerators, a global context needs to be
2621      * provided by the user. In that case, this holds display-dependent
2622      * data Libav cannot instantiate itself. Please refer to the
2623      * Libav HW accelerator documentation to know how to fill this
2624      * is. e.g. for VA API, this is a struct vaapi_context.
2625      * - encoding: unused
2626      * - decoding: Set by user
2627      */
2628     void *hwaccel_context;
2629
2630     /**
2631      * error
2632      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2633      * - decoding: unused
2634      */
2635     uint64_t error[AV_NUM_DATA_POINTERS];
2636
2637     /**
2638      * DCT algorithm, see FF_DCT_* below
2639      * - encoding: Set by user.
2640      * - decoding: unused
2641      */
2642     int dct_algo;
2643 #define FF_DCT_AUTO    0
2644 #define FF_DCT_FASTINT 1
2645 #define FF_DCT_INT     2
2646 #define FF_DCT_MMX     3
2647 #define FF_DCT_ALTIVEC 5
2648 #define FF_DCT_FAAN    6
2649
2650     /**
2651      * IDCT algorithm, see FF_IDCT_* below.
2652      * - encoding: Set by user.
2653      * - decoding: Set by user.
2654      */
2655     int idct_algo;
2656 #define FF_IDCT_AUTO          0
2657 #define FF_IDCT_INT           1
2658 #define FF_IDCT_SIMPLE        2
2659 #define FF_IDCT_SIMPLEMMX     3
2660 #define FF_IDCT_ARM           7
2661 #define FF_IDCT_ALTIVEC       8
2662 #define FF_IDCT_SIMPLEARM     10
2663 #if FF_API_UNUSED_MEMBERS
2664 #define FF_IDCT_IPP           13
2665 #endif /* FF_API_UNUSED_MEMBERS */
2666 #define FF_IDCT_XVID          14
2667 #define FF_IDCT_SIMPLEARMV5TE 16
2668 #define FF_IDCT_SIMPLEARMV6   17
2669 #define FF_IDCT_FAAN          20
2670 #define FF_IDCT_SIMPLENEON    22
2671
2672     /**
2673      * bits per sample/pixel from the demuxer (needed for huffyuv).
2674      * - encoding: Set by libavcodec.
2675      * - decoding: Set by user.
2676      */
2677      int bits_per_coded_sample;
2678
2679     /**
2680      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2681      * - encoding: set by user.
2682      * - decoding: set by libavcodec.
2683      */
2684     int bits_per_raw_sample;
2685
2686 #if FF_API_CODED_FRAME
2687     /**
2688      * the picture in the bitstream
2689      * - encoding: Set by libavcodec.
2690      * - decoding: unused
2691      *
2692      * @deprecated use the quality factor packet side data instead
2693      */
2694     attribute_deprecated AVFrame *coded_frame;
2695 #endif
2696
2697     /**
2698      * thread count
2699      * is used to decide how many independent tasks should be passed to execute()
2700      * - encoding: Set by user.
2701      * - decoding: Set by user.
2702      */
2703     int thread_count;
2704
2705     /**
2706      * Which multithreading methods to use.
2707      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2708      * so clients which cannot provide future frames should not use it.
2709      *
2710      * - encoding: Set by user, otherwise the default is used.
2711      * - decoding: Set by user, otherwise the default is used.
2712      */
2713     int thread_type;
2714 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2715 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2716
2717     /**
2718      * Which multithreading methods are in use by the codec.
2719      * - encoding: Set by libavcodec.
2720      * - decoding: Set by libavcodec.
2721      */
2722     int active_thread_type;
2723
2724     /**
2725      * Set by the client if its custom get_buffer() callback can be called
2726      * synchronously from another thread, which allows faster multithreaded decoding.
2727      * draw_horiz_band() will be called from other threads regardless of this setting.
2728      * Ignored if the default get_buffer() is used.
2729      * - encoding: Set by user.
2730      * - decoding: Set by user.
2731      */
2732     int thread_safe_callbacks;
2733
2734     /**
2735      * The codec may call this to execute several independent things.
2736      * It will return only after finishing all tasks.
2737      * The user may replace this with some multithreaded implementation,
2738      * the default implementation will execute the parts serially.
2739      * @param count the number of things to execute
2740      * - encoding: Set by libavcodec, user can override.
2741      * - decoding: Set by libavcodec, user can override.
2742      */
2743     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2744
2745     /**
2746      * The codec may call this to execute several independent things.
2747      * It will return only after finishing all tasks.
2748      * The user may replace this with some multithreaded implementation,
2749      * the default implementation will execute the parts serially.
2750      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2751      * @param c context passed also to func
2752      * @param count the number of things to execute
2753      * @param arg2 argument passed unchanged to func
2754      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2755      * @param func function that will be called count times, with jobnr from 0 to count-1.
2756      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2757      *             two instances of func executing at the same time will have the same threadnr.
2758      * @return always 0 currently, but code should handle a future improvement where when any call to func
2759      *         returns < 0 no further calls to func may be done and < 0 is returned.
2760      * - encoding: Set by libavcodec, user can override.
2761      * - decoding: Set by libavcodec, user can override.
2762      */
2763     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2764
2765     /**
2766      * noise vs. sse weight for the nsse comparison function
2767      * - encoding: Set by user.
2768      * - decoding: unused
2769      */
2770      int nsse_weight;
2771
2772     /**
2773      * profile
2774      * - encoding: Set by user.
2775      * - decoding: Set by libavcodec.
2776      */
2777      int profile;
2778 #define FF_PROFILE_UNKNOWN -99
2779 #define FF_PROFILE_RESERVED -100
2780
2781 #define FF_PROFILE_AAC_MAIN 0
2782 #define FF_PROFILE_AAC_LOW  1
2783 #define FF_PROFILE_AAC_SSR  2
2784 #define FF_PROFILE_AAC_LTP  3
2785 #define FF_PROFILE_AAC_HE   4
2786 #define FF_PROFILE_AAC_HE_V2 28
2787 #define FF_PROFILE_AAC_LD   22
2788 #define FF_PROFILE_AAC_ELD  38
2789 #define FF_PROFILE_MPEG2_AAC_LOW 128
2790 #define FF_PROFILE_MPEG2_AAC_HE  131
2791
2792 #define FF_PROFILE_DTS         20
2793 #define FF_PROFILE_DTS_ES      30
2794 #define FF_PROFILE_DTS_96_24   40
2795 #define FF_PROFILE_DTS_HD_HRA  50
2796 #define FF_PROFILE_DTS_HD_MA   60
2797 #define FF_PROFILE_DTS_EXPRESS 70
2798
2799 #define FF_PROFILE_MPEG2_422    0
2800 #define FF_PROFILE_MPEG2_HIGH   1
2801 #define FF_PROFILE_MPEG2_SS     2
2802 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2803 #define FF_PROFILE_MPEG2_MAIN   4
2804 #define FF_PROFILE_MPEG2_SIMPLE 5
2805
2806 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2807 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2808
2809 #define FF_PROFILE_H264_BASELINE             66
2810 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2811 #define FF_PROFILE_H264_MAIN                 77
2812 #define FF_PROFILE_H264_EXTENDED             88
2813 #define FF_PROFILE_H264_HIGH                 100
2814 #define FF_PROFILE_H264_HIGH_10              110
2815 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2816 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2817 #define FF_PROFILE_H264_HIGH_422             122
2818 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2819 #define FF_PROFILE_H264_STEREO_HIGH          128
2820 #define FF_PROFILE_H264_HIGH_444             144
2821 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2822 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2823 #define FF_PROFILE_H264_CAVLC_444            44
2824
2825 #define FF_PROFILE_VC1_SIMPLE   0
2826 #define FF_PROFILE_VC1_MAIN     1
2827 #define FF_PROFILE_VC1_COMPLEX  2
2828 #define FF_PROFILE_VC1_ADVANCED 3
2829
2830 #define FF_PROFILE_MPEG4_SIMPLE                     0
2831 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2832 #define FF_PROFILE_MPEG4_CORE                       2
2833 #define FF_PROFILE_MPEG4_MAIN                       3
2834 #define FF_PROFILE_MPEG4_N_BIT                      4
2835 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2836 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2837 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2838 #define FF_PROFILE_MPEG4_HYBRID                     8
2839 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2840 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2841 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2842 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2843 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2844 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2845 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2846
2847 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2848 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2849 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2850 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2851 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2852
2853 #define FF_PROFILE_VP9_0                            0
2854 #define FF_PROFILE_VP9_1                            1
2855 #define FF_PROFILE_VP9_2                            2
2856 #define FF_PROFILE_VP9_3                            3
2857
2858 #define FF_PROFILE_HEVC_MAIN                        1
2859 #define FF_PROFILE_HEVC_MAIN_10                     2
2860 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2861 #define FF_PROFILE_HEVC_REXT                        4
2862
2863     /**
2864      * level
2865      * - encoding: Set by user.
2866      * - decoding: Set by libavcodec.
2867      */
2868      int level;
2869 #define FF_LEVEL_UNKNOWN -99
2870
2871     /**
2872      * - encoding: unused
2873      * - decoding: Set by user.
2874      */
2875     enum AVDiscard skip_loop_filter;
2876
2877     /**
2878      * - encoding: unused
2879      * - decoding: Set by user.
2880      */
2881     enum AVDiscard skip_idct;
2882
2883     /**
2884      * - encoding: unused
2885      * - decoding: Set by user.
2886      */
2887     enum AVDiscard skip_frame;
2888
2889     /**
2890      * Header containing style information for text subtitles.
2891      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2892      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2893      * the Format line following. It shouldn't include any Dialogue line.
2894      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2895      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2896      */
2897     uint8_t *subtitle_header;
2898     int subtitle_header_size;
2899
2900 #if FF_API_VBV_DELAY
2901     /**
2902      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2903      * Used for compliant TS muxing.
2904      * - encoding: Set by libavcodec.
2905      * - decoding: unused.
2906      * @deprecated this value is now exported as a part of
2907      * AV_PKT_DATA_CPB_PROPERTIES packet side data
2908      */
2909     attribute_deprecated
2910     uint64_t vbv_delay;
2911 #endif
2912
2913 #if FF_API_SIDEDATA_ONLY_PKT
2914     /**
2915      * Encoding only and set by default. Allow encoders to output packets
2916      * that do not contain any encoded data, only side data.
2917      *
2918      * Some encoders need to output such packets, e.g. to update some stream
2919      * parameters at the end of encoding.
2920      *
2921      * @deprecated this field disables the default behaviour and
2922      *             it is kept only for compatibility.
2923      */
2924     attribute_deprecated
2925     int side_data_only_packets;
2926 #endif
2927
2928     /**
2929      * Audio only. The number of "priming" samples (padding) inserted by the
2930      * encoder at the beginning of the audio. I.e. this number of leading
2931      * decoded samples must be discarded by the caller to get the original audio
2932      * without leading padding.
2933      *
2934      * - decoding: unused
2935      * - encoding: Set by libavcodec. The timestamps on the output packets are
2936      *             adjusted by the encoder so that they always refer to the
2937      *             first sample of the data actually contained in the packet,
2938      *             including any added padding.  E.g. if the timebase is
2939      *             1/samplerate and the timestamp of the first input sample is
2940      *             0, the timestamp of the first output packet will be
2941      *             -initial_padding.
2942      */
2943     int initial_padding;
2944
2945     /*
2946      * - decoding: For codecs that store a framerate value in the compressed
2947      *             bitstream, the decoder may export it here. { 0, 1} when
2948      *             unknown.
2949      * - encoding: May be used to signal the framerate of CFR content to an
2950      *             encoder.
2951      */
2952     AVRational framerate;
2953
2954     /**
2955      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2956      * - encoding: unused.
2957      * - decoding: Set by libavcodec before calling get_format()
2958      */
2959     enum AVPixelFormat sw_pix_fmt;
2960
2961     /**
2962      * Additional data associated with the entire coded stream.
2963      *
2964      * - decoding: unused
2965      * - encoding: may be set by libavcodec after avcodec_open2().
2966      */
2967     AVPacketSideData *coded_side_data;
2968     int            nb_coded_side_data;
2969
2970     /**
2971      * A reference to the AVHWFramesContext describing the input (for encoding)
2972      * or output (decoding) frames. The reference is set by the caller and
2973      * afterwards owned (and freed) by libavcodec - it should never be read by
2974      * the caller after being set.
2975      *
2976      * - decoding: This field should be set by the caller from the get_format()
2977      *             callback. The previous reference (if any) will always be
2978      *             unreffed by libavcodec before the get_format() call.
2979      *
2980      *             If the default get_buffer2() is used with a hwaccel pixel
2981      *             format, then this AVHWFramesContext will be used for
2982      *             allocating the frame buffers.
2983      *
2984      * - encoding: For hardware encoders configured to use a hwaccel pixel
2985      *             format, this field should be set by the caller to a reference
2986      *             to the AVHWFramesContext describing input frames.
2987      *             AVHWFramesContext.format must be equal to
2988      *             AVCodecContext.pix_fmt.
2989      *
2990      *             This field should be set before avcodec_open2() is called.
2991      */
2992     AVBufferRef *hw_frames_ctx;
2993
2994     /**
2995      * Video decoding only. Certain video codecs support cropping, meaning that
2996      * only a sub-rectangle of the decoded frame is intended for display.  This
2997      * option controls how cropping is handled by libavcodec.
2998      *
2999      * When set to 1 (the default), libavcodec will apply cropping internally.
3000      * I.e. it will modify the output frame width/height fields and offset the
3001      * data pointers (only by as much as possible while preserving alignment, or
3002      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3003      * the frames output by the decoder refer only to the cropped area. The
3004      * crop_* fields of the output frames will be zero.
3005      *
3006      * When set to 0, the width/height fields of the output frames will be set
3007      * to the coded dimensions and the crop_* fields will describe the cropping
3008      * rectangle. Applying the cropping is left to the caller.
3009      *
3010      * @warning When hardware acceleration with opaque output frames is used,
3011      * libavcodec is unable to apply cropping from the top/left border.
3012      *
3013      * @note when this option is set to zero, the width/height fields of the
3014      * AVCodecContext and output AVFrames have different meanings. The codec
3015      * context fields store display dimensions (with the coded dimensions in
3016      * coded_width/height), while the frame fields store the coded dimensions
3017      * (with the display dimensions being determined by the crop_* fields).
3018      */
3019     int apply_cropping;
3020
3021     /**
3022      * A reference to the AVHWDeviceContext describing the device which will
3023      * be used by a hardware encoder/decoder.  The reference is set by the
3024      * caller and afterwards owned (and freed) by libavcodec.
3025      *
3026      * This should be used if either the codec device does not require
3027      * hardware frames or any that are used are to be allocated internally by
3028      * libavcodec.  If the user wishes to supply any of the frames used as
3029      * encoder input or decoder output then hw_frames_ctx should be used
3030      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3031      * field will be ignored while decoding the associated stream segment, but
3032      * may again be used on a following one after another get_format() call.
3033      *
3034      * For both encoders and decoders this field should be set before
3035      * avcodec_open2() is called and must not be written to thereafter.
3036      *
3037      * Note that some decoders may require this field to be set initially in
3038      * order to support hw_frames_ctx at all - in that case, all frames
3039      * contexts used must be created on the same device.
3040      */
3041     AVBufferRef *hw_device_ctx;
3042
3043     /**
3044      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3045      * decoding (if active).
3046      * - encoding: unused
3047      * - decoding: Set by user (either before avcodec_open2(), or in the
3048      *             AVCodecContext.get_format callback)
3049      */
3050     int hwaccel_flags;
3051 } AVCodecContext;
3052
3053 /**
3054  * AVProfile.
3055  */
3056 typedef struct AVProfile {
3057     int profile;
3058     const char *name; ///< short name for the profile
3059 } AVProfile;
3060
3061 typedef struct AVCodecDefault AVCodecDefault;
3062
3063 struct AVSubtitle;
3064
3065 /**
3066  * AVCodec.
3067  */
3068 typedef struct AVCodec {
3069     /**
3070      * Name of the codec implementation.
3071      * The name is globally unique among encoders and among decoders (but an
3072      * encoder and a decoder can share the same name).
3073      * This is the primary way to find a codec from the user perspective.
3074      */
3075     const char *name;
3076     /**
3077      * Descriptive name for the codec, meant to be more human readable than name.
3078      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3079      */
3080     const char *long_name;
3081     enum AVMediaType type;
3082     enum AVCodecID id;
3083     /**
3084      * Codec capabilities.
3085      * see AV_CODEC_CAP_*
3086      */
3087     int capabilities;
3088     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3089     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3090     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3091     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3092     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3093     const AVClass *priv_class;              ///< AVClass for the private context
3094     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3095
3096     /*****************************************************************
3097      * No fields below this line are part of the public API. They
3098      * may not be used outside of libavcodec and can be changed and
3099      * removed at will.
3100      * New public fields should be added right above.
3101      *****************************************************************
3102      */
3103     int priv_data_size;
3104     struct AVCodec *next;
3105     /**
3106      * @name Frame-level threading support functions
3107      * @{
3108      */
3109     /**
3110      * If defined, called on thread contexts when they are created.
3111      * If the codec allocates writable tables in init(), re-allocate them here.
3112      * priv_data will be set to a copy of the original.
3113      */
3114     int (*init_thread_copy)(AVCodecContext *);
3115     /**
3116      * Copy necessary context variables from a previous thread context to the current one.
3117      * If not defined, the next thread will start automatically; otherwise, the codec
3118      * must call ff_thread_finish_setup().
3119      *
3120      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3121      */
3122     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3123     /** @} */
3124
3125     /**
3126      * Private codec-specific defaults.
3127      */
3128     const AVCodecDefault *defaults;
3129
3130     /**
3131      * Initialize codec static data, called from avcodec_register().
3132      */
3133     void (*init_static_data)(struct AVCodec *codec);
3134
3135     int (*init)(AVCodecContext *);
3136     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3137                       const struct AVSubtitle *sub);
3138     /**
3139      * Encode data to an AVPacket.
3140      *
3141      * @param      avctx          codec context
3142      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3143      * @param[in]  frame          AVFrame containing the raw data to be encoded
3144      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3145      *                            non-empty packet was returned in avpkt.
3146      * @return 0 on success, negative error code on failure
3147      */
3148     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3149                    int *got_packet_ptr);
3150     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3151     int (*close)(AVCodecContext *);
3152     /**
3153      * Encode API with decoupled packet/frame dataflow. The API is the
3154      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3155      * that:
3156      * - never called if the codec is closed or the wrong type,
3157      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3158      * - only one drain frame is ever passed down,
3159      */
3160     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3161     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3162
3163     /**
3164      * Decode API with decoupled packet/frame dataflow. This function is called
3165      * to get one output frame. It should call ff_decode_get_packet() to obtain
3166      * input data.
3167      */
3168     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3169     /**
3170      * Flush buffers.
3171      * Will be called when seeking
3172      */
3173     void (*flush)(AVCodecContext *);
3174     /**
3175      * Internal codec capabilities.
3176      * See FF_CODEC_CAP_* in internal.h
3177      */
3178     int caps_internal;
3179
3180     /**
3181      * Decoding only, a comma-separated list of bitstream filters to apply to
3182      * packets before decoding.
3183      */
3184     const char *bsfs;
3185 } AVCodec;
3186
3187 /**
3188  * @defgroup lavc_hwaccel AVHWAccel
3189  * @{
3190  */
3191 typedef struct AVHWAccel {
3192     /**
3193      * Name of the hardware accelerated codec.
3194      * The name is globally unique among encoders and among decoders (but an
3195      * encoder and a decoder can share the same name).
3196      */
3197     const char *name;
3198
3199     /**
3200      * Type of codec implemented by the hardware accelerator.
3201      *
3202      * See AVMEDIA_TYPE_xxx
3203      */
3204     enum AVMediaType type;
3205
3206     /**
3207      * Codec implemented by the hardware accelerator.
3208      *
3209      * See AV_CODEC_ID_xxx
3210      */
3211     enum AVCodecID id;
3212
3213     /**
3214      * Supported pixel format.
3215      *
3216      * Only hardware accelerated formats are supported here.
3217      */
3218     enum AVPixelFormat pix_fmt;
3219
3220     /**
3221      * Hardware accelerated codec capabilities.
3222      * see FF_HWACCEL_CODEC_CAP_*
3223      */
3224     int capabilities;
3225
3226     /*****************************************************************
3227      * No fields below this line are part of the public API. They
3228      * may not be used outside of libavcodec and can be changed and
3229      * removed at will.
3230      * New public fields should be added right above.
3231      *****************************************************************
3232      */
3233     struct AVHWAccel *next;
3234
3235     /**
3236      * Allocate a custom buffer
3237      */
3238     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3239
3240     /**
3241      * Called at the beginning of each frame or field picture.
3242      *
3243      * Meaningful frame information (codec specific) is guaranteed to
3244      * be parsed at this point. This function is mandatory.
3245      *
3246      * Note that buf can be NULL along with buf_size set to 0.
3247      * Otherwise, this means the whole frame is available at this point.
3248      *
3249      * @param avctx the codec context
3250      * @param buf the frame data buffer base
3251      * @param buf_size the size of the frame in bytes
3252      * @return zero if successful, a negative value otherwise
3253      */
3254     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3255
3256     /**
3257      * Callback for each slice.
3258      *
3259      * Meaningful slice information (codec specific) is guaranteed to
3260      * be parsed at this point. This function is mandatory.
3261      *
3262      * @param avctx the codec context
3263      * @param buf the slice data buffer base
3264      * @param buf_size the size of the slice in bytes
3265      * @return zero if successful, a negative value otherwise
3266      */
3267     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3268
3269     /**
3270      * Called at the end of each frame or field picture.
3271      *
3272      * The whole picture is parsed at this point and can now be sent
3273      * to the hardware accelerator. This function is mandatory.
3274      *
3275      * @param avctx the codec context
3276      * @return zero if successful, a negative value otherwise
3277      */
3278     int (*end_frame)(AVCodecContext *avctx);
3279
3280     /**
3281      * Size of per-frame hardware accelerator private data.
3282      *
3283      * Private data is allocated with av_mallocz() before
3284      * AVCodecContext.get_buffer() and deallocated after
3285      * AVCodecContext.release_buffer().
3286      */
3287     int frame_priv_data_size;
3288
3289     /**
3290      * Initialize the hwaccel private data.
3291      *
3292      * This will be called from ff_get_format(), after hwaccel and
3293      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3294      * is allocated.
3295      */
3296     int (*init)(AVCodecContext *avctx);
3297
3298     /**
3299      * Uninitialize the hwaccel private data.
3300      *
3301      * This will be called from get_format() or avcodec_close(), after hwaccel
3302      * and hwaccel_context are already uninitialized.
3303      */
3304     int (*uninit)(AVCodecContext *avctx);
3305
3306     /**
3307      * Size of the private data to allocate in
3308      * AVCodecInternal.hwaccel_priv_data.
3309      */
3310     int priv_data_size;
3311
3312     /**
3313      * Internal hwaccel capabilities.
3314      */
3315     int caps_internal;
3316 } AVHWAccel;
3317
3318 /**
3319  * Hardware acceleration should be used for decoding even if the codec level
3320  * used is unknown or higher than the maximum supported level reported by the
3321  * hardware driver.
3322  */
3323 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3324
3325 /**
3326  * Hardware acceleration can output YUV pixel formats with a different chroma
3327  * sampling than 4:2:0 and/or other than 8 bits per component.
3328  */
3329 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3330
3331 /**
3332  * @}
3333  */
3334
3335 #if FF_API_AVPICTURE
3336 /**
3337  * @defgroup lavc_picture AVPicture
3338  *
3339  * Functions for working with AVPicture
3340  * @{
3341  */
3342
3343 /**
3344  * four components are given, that's all.
3345  * the last component is alpha
3346  * @deprecated Use the imgutils functions
3347  */
3348 typedef struct AVPicture {
3349     attribute_deprecated
3350     uint8_t *data[AV_NUM_DATA_POINTERS];
3351     attribute_deprecated
3352     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3353 } AVPicture;
3354
3355 /**
3356  * @}
3357  */
3358 #endif
3359
3360 #define AVPALETTE_SIZE 1024
3361 #define AVPALETTE_COUNT 256
3362
3363 enum AVSubtitleType {
3364     SUBTITLE_NONE,
3365
3366     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3367
3368     /**
3369      * Plain text, the text field must be set by the decoder and is
3370      * authoritative. ass and pict fields may contain approximations.
3371      */
3372     SUBTITLE_TEXT,
3373
3374     /**
3375      * Formatted text, the ass field must be set by the decoder and is
3376      * authoritative. pict and text fields may contain approximations.
3377      */
3378     SUBTITLE_ASS,
3379 };
3380
3381 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3382
3383 typedef struct AVSubtitleRect {
3384     int x;         ///< top left corner  of pict, undefined when pict is not set
3385     int y;         ///< top left corner  of pict, undefined when pict is not set
3386     int w;         ///< width            of pict, undefined when pict is not set
3387     int h;         ///< height           of pict, undefined when pict is not set
3388     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3389
3390 #if FF_API_AVPICTURE
3391     /**
3392      * @deprecated unused
3393      */
3394     attribute_deprecated
3395     AVPicture pict;
3396 #endif
3397     /**
3398      * data+linesize for the bitmap of this subtitle.
3399      * Can be set for text/ass as well once they are rendered.
3400      */
3401     uint8_t *data[4];
3402     int linesize[4];
3403
3404     enum AVSubtitleType type;
3405
3406     char *text;                     ///< 0 terminated plain UTF-8 text
3407
3408     /**
3409      * 0 terminated ASS/SSA compatible event line.
3410      * The presentation of this is unaffected by the other values in this
3411      * struct.
3412      */
3413     char *ass;
3414     int flags;
3415 } AVSubtitleRect;
3416
3417 typedef struct AVSubtitle {
3418     uint16_t format; /* 0 = graphics */
3419     uint32_t start_display_time; /* relative to packet pts, in ms */
3420     uint32_t end_display_time; /* relative to packet pts, in ms */
3421     unsigned num_rects;
3422     AVSubtitleRect **rects;
3423     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3424 } AVSubtitle;
3425
3426 /**
3427  * This struct describes the properties of an encoded stream.
3428  *
3429  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3430  * be allocated with avcodec_parameters_alloc() and freed with
3431  * avcodec_parameters_free().
3432  */
3433 typedef struct AVCodecParameters {
3434     /**
3435      * General type of the encoded data.
3436      */
3437     enum AVMediaType codec_type;
3438     /**
3439      * Specific type of the encoded data (the codec used).
3440      */
3441     enum AVCodecID   codec_id;
3442     /**
3443      * Additional information about the codec (corresponds to the AVI FOURCC).
3444      */
3445     uint32_t         codec_tag;
3446
3447     /**
3448      * Extra binary data needed for initializing the decoder, codec-dependent.
3449      *
3450      * Must be allocated with av_malloc() and will be freed by
3451      * avcodec_parameters_free(). The allocated size of extradata must be at
3452      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3453      * bytes zeroed.
3454      */
3455     uint8_t *extradata;
3456     /**
3457      * Size of the extradata content in bytes.
3458      */
3459     int      extradata_size;
3460
3461     /**
3462      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3463      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3464      */
3465     int format;
3466
3467     /**
3468      * The average bitrate of the encoded data (in bits per second).
3469      */
3470     int bit_rate;
3471
3472     int bits_per_coded_sample;
3473
3474     /**
3475      * Codec-specific bitstream restrictions that the stream conforms to.
3476      */
3477     int profile;
3478     int level;
3479
3480     /**
3481      * Video only. The dimensions of the video frame in pixels.
3482      */
3483     int width;
3484     int height;
3485
3486     /**
3487      * Video only. The aspect ratio (width / height) which a single pixel
3488      * should have when displayed.
3489      *
3490      * When the aspect ratio is unknown / undefined, the numerator should be
3491      * set to 0 (the denominator may have any value).
3492      */
3493     AVRational sample_aspect_ratio;
3494
3495     /**
3496      * Video only. The order of the fields in interlaced video.
3497      */
3498     enum AVFieldOrder                  field_order;
3499
3500     /**
3501      * Video only. Additional colorspace characteristics.
3502      */
3503     enum AVColorRange                  color_range;
3504     enum AVColorPrimaries              color_primaries;
3505     enum AVColorTransferCharacteristic color_trc;
3506     enum AVColorSpace                  color_space;
3507     enum AVChromaLocation              chroma_location;
3508
3509     /**
3510      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3511      * unknown or unspecified, otherwise the number of bits set must be equal to
3512      * the channels field.
3513      */
3514     uint64_t channel_layout;
3515     /**
3516      * Audio only. The number of audio channels.
3517      */
3518     int      channels;
3519     /**
3520      * Audio only. The number of audio samples per second.
3521      */
3522     int      sample_rate;
3523     /**
3524      * Audio only. The number of bytes per coded audio frame, required by some
3525      * formats.
3526      *
3527      * Corresponds to nBlockAlign in WAVEFORMATEX.
3528      */
3529     int      block_align;
3530
3531     /**
3532      * Audio only. The amount of padding (in samples) inserted by the encoder at
3533      * the beginning of the audio. I.e. this number of leading decoded samples
3534      * must be discarded by the caller to get the original audio without leading
3535      * padding.
3536      */
3537     int initial_padding;
3538     /**
3539      * Audio only. The amount of padding (in samples) appended by the encoder to
3540      * the end of the audio. I.e. this number of decoded samples must be
3541      * discarded by the caller from the end of the stream to get the original
3542      * audio without any trailing padding.
3543      */
3544     int trailing_padding;
3545 } AVCodecParameters;
3546
3547 /**
3548  * If c is NULL, returns the first registered codec,
3549  * if c is non-NULL, returns the next registered codec after c,
3550  * or NULL if c is the last one.
3551  */
3552 AVCodec *av_codec_next(const AVCodec *c);
3553
3554 /**
3555  * Return the LIBAVCODEC_VERSION_INT constant.
3556  */
3557 unsigned avcodec_version(void);
3558
3559 /**
3560  * Return the libavcodec build-time configuration.
3561  */
3562 const char *avcodec_configuration(void);
3563
3564 /**
3565  * Return the libavcodec license.
3566  */
3567 const char *avcodec_license(void);
3568
3569 /**
3570  * Register the codec codec and initialize libavcodec.
3571  *
3572  * @warning either this function or avcodec_register_all() must be called
3573  * before any other libavcodec functions.
3574  *
3575  * @see avcodec_register_all()
3576  */
3577 void avcodec_register(AVCodec *codec);
3578
3579 /**
3580  * Register all the codecs, parsers and bitstream filters which were enabled at
3581  * configuration time. If you do not call this function you can select exactly
3582  * which formats you want to support, by using the individual registration
3583  * functions.
3584  *
3585  * @see avcodec_register
3586  * @see av_register_codec_parser
3587  * @see av_register_bitstream_filter
3588  */
3589 void avcodec_register_all(void);
3590
3591 /**
3592  * Allocate an AVCodecContext and set its fields to default values. The
3593  * resulting struct should be freed with avcodec_free_context().
3594  *
3595  * @param codec if non-NULL, allocate private data and initialize defaults
3596  *              for the given codec. It is illegal to then call avcodec_open2()
3597  *              with a different codec.
3598  *              If NULL, then the codec-specific defaults won't be initialized,
3599  *              which may result in suboptimal default settings (this is
3600  *              important mainly for encoders, e.g. libx264).
3601  *
3602  * @return An AVCodecContext filled with default values or NULL on failure.
3603  */
3604 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3605
3606 /**
3607  * Free the codec context and everything associated with it and write NULL to
3608  * the provided pointer.
3609  */
3610 void avcodec_free_context(AVCodecContext **avctx);
3611
3612 #if FF_API_GET_CONTEXT_DEFAULTS
3613 /**
3614  * @deprecated This function should not be used, as closing and opening a codec
3615  * context multiple time is not supported. A new codec context should be
3616  * allocated for each new use.
3617  */
3618 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3619 #endif
3620
3621 /**
3622  * Get the AVClass for AVCodecContext. It can be used in combination with
3623  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3624  *
3625  * @see av_opt_find().
3626  */
3627 const AVClass *avcodec_get_class(void);
3628
3629 #if FF_API_COPY_CONTEXT
3630 /**
3631  * Copy the settings of the source AVCodecContext into the destination
3632  * AVCodecContext. The resulting destination codec context will be
3633  * unopened, i.e. you are required to call avcodec_open2() before you
3634  * can use this AVCodecContext to decode/encode video/audio data.
3635  *
3636  * @param dest target codec context, should be initialized with
3637  *             avcodec_alloc_context3(), but otherwise uninitialized
3638  * @param src source codec context
3639  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3640  *
3641  * @deprecated The semantics of this function are ill-defined and it should not
3642  * be used. If you need to transfer the stream parameters from one codec context
3643  * to another, use an intermediate AVCodecParameters instance and the
3644  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3645  * functions.
3646  */
3647 attribute_deprecated
3648 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3649 #endif
3650
3651 /**
3652  * Allocate a new AVCodecParameters and set its fields to default values
3653  * (unknown/invalid/0). The returned struct must be freed with
3654  * avcodec_parameters_free().
3655  */
3656 AVCodecParameters *avcodec_parameters_alloc(void);
3657
3658 /**
3659  * Free an AVCodecParameters instance and everything associated with it and
3660  * write NULL to the supplied pointer.
3661  */
3662 void avcodec_parameters_free(AVCodecParameters **par);
3663
3664 /**
3665  * Copy the contents of src to dst. Any allocated fields in dst are freed and
3666  * replaced with newly allocated duplicates of the corresponding fields in src.
3667  *
3668  * @return >= 0 on success, a negative AVERROR code on failure.
3669  */
3670 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3671
3672 /**
3673  * Fill the parameters struct based on the values from the supplied codec
3674  * context. Any allocated fields in par are freed and replaced with duplicates
3675  * of the corresponding fields in codec.
3676  *
3677  * @return >= 0 on success, a negative AVERROR code on failure
3678  */
3679 int avcodec_parameters_from_context(AVCodecParameters *par,
3680                                     const AVCodecContext *codec);
3681
3682 /**
3683  * Fill the codec context based on the values from the supplied codec
3684  * parameters. Any allocated fields in codec that have a corresponding field in
3685  * par are freed and replaced with duplicates of the corresponding field in par.
3686  * Fields in codec that do not have a counterpart in par are not touched.
3687  *
3688  * @return >= 0 on success, a negative AVERROR code on failure.
3689  */
3690 int avcodec_parameters_to_context(AVCodecContext *codec,
3691                                   const AVCodecParameters *par);
3692
3693 /**
3694  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3695  * function the context has to be allocated with avcodec_alloc_context3().
3696  *
3697  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3698  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3699  * retrieving a codec.
3700  *
3701  * @warning This function is not thread safe!
3702  *
3703  * @note Always call this function before using decoding routines (such as
3704  * @ref avcodec_receive_frame()).
3705  *
3706  * @code
3707  * avcodec_register_all();
3708  * av_dict_set(&opts, "b", "2.5M", 0);
3709  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3710  * if (!codec)
3711  *     exit(1);
3712  *
3713  * context = avcodec_alloc_context3(codec);
3714  *
3715  * if (avcodec_open2(context, codec, opts) < 0)
3716  *     exit(1);
3717  * @endcode
3718  *
3719  * @param avctx The context to initialize.
3720  * @param codec The codec to open this context for. If a non-NULL codec has been
3721  *              previously passed to avcodec_alloc_context3() or
3722  *              for this context, then this parameter MUST be either NULL or
3723  *              equal to the previously passed codec.
3724  * @param options A dictionary filled with AVCodecContext and codec-private options.
3725  *                On return this object will be filled with options that were not found.
3726  *
3727  * @return zero on success, a negative value on error
3728  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3729  *      av_dict_set(), av_opt_find().
3730  */
3731 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3732
3733 /**
3734  * Close a given AVCodecContext and free all the data associated with it
3735  * (but not the AVCodecContext itself).
3736  *
3737  * Calling this function on an AVCodecContext that hasn't been opened will free
3738  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3739  * codec. Subsequent calls will do nothing.
3740  *
3741  * @note Do not use this function. Use avcodec_free_context() to destroy a
3742  * codec context (either open or closed). Opening and closing a codec context
3743  * multiple times is not supported anymore -- use multiple codec contexts
3744  * instead.
3745  */
3746 int avcodec_close(AVCodecContext *avctx);
3747
3748 /**
3749  * Free all allocated data in the given subtitle struct.
3750  *
3751  * @param sub AVSubtitle to free.
3752  */
3753 void avsubtitle_free(AVSubtitle *sub);
3754
3755 /**
3756  * @}
3757  */
3758
3759 /**
3760  * @addtogroup lavc_packet
3761  * @{
3762  */
3763
3764 /**
3765  * Allocate an AVPacket and set its fields to default values.  The resulting
3766  * struct must be freed using av_packet_free().
3767  *
3768  * @return An AVPacket filled with default values or NULL on failure.
3769  *
3770  * @note this only allocates the AVPacket itself, not the data buffers. Those
3771  * must be allocated through other means such as av_new_packet.
3772  *
3773  * @see av_new_packet
3774  */
3775 AVPacket *av_packet_alloc(void);
3776
3777 /**
3778  * Create a new packet that references the same data as src.
3779  *
3780  * This is a shortcut for av_packet_alloc()+av_packet_ref().
3781  *
3782  * @return newly created AVPacket on success, NULL on error.
3783  *
3784  * @see av_packet_alloc
3785  * @see av_packet_ref
3786  */
3787 AVPacket *av_packet_clone(const AVPacket *src);
3788
3789 /**
3790  * Free the packet, if the packet is reference counted, it will be
3791  * unreferenced first.
3792  *
3793  * @param pkt packet to be freed. The pointer will be set to NULL.
3794  * @note passing NULL is a no-op.
3795  */
3796 void av_packet_free(AVPacket **pkt);
3797
3798 /**
3799  * Initialize optional fields of a packet with default values.
3800  *
3801  * Note, this does not touch the data and size members, which have to be
3802  * initialized separately.
3803  *
3804  * @param pkt packet
3805  */
3806 void av_init_packet(AVPacket *pkt);
3807
3808 /**
3809  * Allocate the payload of a packet and initialize its fields with
3810  * default values.
3811  *
3812  * @param pkt packet
3813  * @param size wanted payload size
3814  * @return 0 if OK, AVERROR_xxx otherwise
3815  */
3816 int av_new_packet(AVPacket *pkt, int size);
3817
3818 /**
3819  * Reduce packet size, correctly zeroing padding