lavc: Drop deprecated avctx codec name
[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 /**
661  * @ingroup lavc_encoding
662  * motion estimation type.
663  * @deprecated use codec private option instead
664  */
665 #if FF_API_MOTION_EST
666 enum Motion_Est_ID {
667     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
668     ME_FULL,
669     ME_LOG,
670     ME_PHODS,
671     ME_EPZS,        ///< enhanced predictive zonal search
672     ME_X1,          ///< reserved for experiments
673     ME_HEX,         ///< hexagon based search
674     ME_UMH,         ///< uneven multi-hexagon search
675     ME_TESA,        ///< transformed exhaustive search algorithm
676 };
677 #endif
678
679 /**
680  * @ingroup lavc_decoding
681  */
682 enum AVDiscard{
683     /* We leave some space between them for extensions (drop some
684      * keyframes for intra-only or drop just some bidir frames). */
685     AVDISCARD_NONE    =-16, ///< discard nothing
686     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
687     AVDISCARD_NONREF  =  8, ///< discard all non reference
688     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
689     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
690     AVDISCARD_ALL     = 48, ///< discard all
691 };
692
693 enum AVAudioServiceType {
694     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
695     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
696     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
697     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
698     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
699     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
700     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
701     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
702     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
703     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
704 };
705
706 /**
707  * @ingroup lavc_encoding
708  */
709 typedef struct RcOverride{
710     int start_frame;
711     int end_frame;
712     int qscale; // If this is 0 then quality_factor will be used instead.
713     float quality_factor;
714 } RcOverride;
715
716 /* encoding support
717    These flags can be passed in AVCodecContext.flags before initialization.
718    Note: Not everything is supported yet.
719 */
720
721 /**
722  * Allow decoders to produce frames with data planes that are not aligned
723  * to CPU requirements (e.g. due to cropping).
724  */
725 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
726 /**
727  * Use fixed qscale.
728  */
729 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
730 /**
731  * 4 MV per MB allowed / advanced prediction for H.263.
732  */
733 #define AV_CODEC_FLAG_4MV             (1 <<  2)
734 /**
735  * Output even those frames that might be corrupted.
736  */
737 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
738 /**
739  * Use qpel MC.
740  */
741 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
742 /**
743  * Use internal 2pass ratecontrol in first pass mode.
744  */
745 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
746 /**
747  * Use internal 2pass ratecontrol in second pass mode.
748  */
749 #define AV_CODEC_FLAG_PASS2           (1 << 10)
750 /**
751  * loop filter.
752  */
753 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
754 /**
755  * Only decode/encode grayscale.
756  */
757 #define AV_CODEC_FLAG_GRAY            (1 << 13)
758 /**
759  * error[?] variables will be set during encoding.
760  */
761 #define AV_CODEC_FLAG_PSNR            (1 << 15)
762 /**
763  * Input bitstream might be truncated at a random location
764  * instead of only at frame boundaries.
765  */
766 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
767 /**
768  * Use interlaced DCT.
769  */
770 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
771 /**
772  * Force low delay.
773  */
774 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
775 /**
776  * Place global headers in extradata instead of every keyframe.
777  */
778 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
779 /**
780  * Use only bitexact stuff (except (I)DCT).
781  */
782 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
783 /* Fx : Flag for H.263+ extra options */
784 /**
785  * H.263 advanced intra coding / MPEG-4 AC prediction
786  */
787 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
788 /**
789  * interlaced motion estimation
790  */
791 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
792 #define AV_CODEC_FLAG_CLOSED_GOP      (1 << 31)
793
794 /**
795  * Allow non spec compliant speedup tricks.
796  */
797 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
798 /**
799  * Skip bitstream encoding.
800  */
801 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
802 /**
803  * Place global headers at every keyframe instead of in extradata.
804  */
805 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
806 /**
807  * Input bitstream might be truncated at a packet boundaries
808  * instead of only at frame boundaries.
809  */
810 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
811 /**
812  * Discard cropping information from SPS.
813  */
814 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
815
816 /* Unsupported options :
817  *              Syntax Arithmetic coding (SAC)
818  *              Reference Picture Selection
819  *              Independent Segment Decoding */
820 /* /Fx */
821 /* codec capabilities */
822
823 /**
824  * Decoder can use draw_horiz_band callback.
825  */
826 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
827 /**
828  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
829  * If not set, it might not use get_buffer() at all or use operations that
830  * assume the buffer was allocated by avcodec_default_get_buffer.
831  */
832 #define AV_CODEC_CAP_DR1                 (1 <<  1)
833 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
834 /**
835  * Encoder or decoder requires flushing with NULL input at the end in order to
836  * give the complete and correct output.
837  *
838  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
839  *       with NULL data. The user can still send NULL data to the public encode
840  *       or decode function, but libavcodec will not pass it along to the codec
841  *       unless this flag is set.
842  *
843  * Decoders:
844  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
845  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
846  * returns frames.
847  *
848  * Encoders:
849  * The encoder needs to be fed with NULL data at the end of encoding until the
850  * encoder no longer returns data.
851  *
852  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
853  *       flag also means that the encoder must set the pts and duration for
854  *       each output packet. If this flag is not set, the pts and duration will
855  *       be determined by libavcodec from the input frame.
856  */
857 #define AV_CODEC_CAP_DELAY               (1 <<  5)
858 /**
859  * Codec can be fed a final frame with a smaller size.
860  * This can be used to prevent truncation of the last audio samples.
861  */
862 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
863 /**
864  * Codec can output multiple frames per AVPacket
865  * Normally demuxers return one frame at a time, demuxers which do not do
866  * are connected to a parser to split what they return into proper frames.
867  * This flag is reserved to the very rare category of codecs which have a
868  * bitstream that cannot be split into frames without timeconsuming
869  * operations like full decoding. Demuxers carrying such bitstreams thus
870  * may return multiple frames in a packet. This has many disadvantages like
871  * prohibiting stream copy in many cases thus it should only be considered
872  * as a last resort.
873  */
874 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
875 /**
876  * Codec is experimental and is thus avoided in favor of non experimental
877  * encoders
878  */
879 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
880 /**
881  * Codec should fill in channel configuration and samplerate instead of container
882  */
883 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
884 /**
885  * Codec supports frame-level multithreading.
886  */
887 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
888 /**
889  * Codec supports slice-based (or partition-based) multithreading.
890  */
891 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
892 /**
893  * Codec supports changed parameters at any point.
894  */
895 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
896 /**
897  * Codec supports avctx->thread_count == 0 (auto).
898  */
899 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
900 /**
901  * Audio encoder supports receiving a different number of samples in each call.
902  */
903 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
904
905 /**
906  * Pan Scan area.
907  * This specifies the area which should be displayed.
908  * Note there may be multiple such areas for one frame.
909  */
910 typedef struct AVPanScan{
911     /**
912      * id
913      * - encoding: Set by user.
914      * - decoding: Set by libavcodec.
915      */
916     int id;
917
918     /**
919      * width and height in 1/16 pel
920      * - encoding: Set by user.
921      * - decoding: Set by libavcodec.
922      */
923     int width;
924     int height;
925
926     /**
927      * position of the top left corner in 1/16 pel for up to 3 fields/frames
928      * - encoding: Set by user.
929      * - decoding: Set by libavcodec.
930      */
931     int16_t position[3][2];
932 }AVPanScan;
933
934 /**
935  * This structure describes the bitrate properties of an encoded bitstream. It
936  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
937  * parameters for H.264/HEVC.
938  */
939 typedef struct AVCPBProperties {
940     /**
941      * Maximum bitrate of the stream, in bits per second.
942      * Zero if unknown or unspecified.
943      */
944     int max_bitrate;
945     /**
946      * Minimum bitrate of the stream, in bits per second.
947      * Zero if unknown or unspecified.
948      */
949     int min_bitrate;
950     /**
951      * Average bitrate of the stream, in bits per second.
952      * Zero if unknown or unspecified.
953      */
954     int avg_bitrate;
955
956     /**
957      * The size of the buffer to which the ratecontrol is applied, in bits.
958      * Zero if unknown or unspecified.
959      */
960     int buffer_size;
961
962     /**
963      * The delay between the time the packet this structure is associated with
964      * is received and the time when it should be decoded, in periods of a 27MHz
965      * clock.
966      *
967      * UINT64_MAX when unknown or unspecified.
968      */
969     uint64_t vbv_delay;
970 } AVCPBProperties;
971
972 /**
973  * The decoder will keep a reference to the frame and may reuse it later.
974  */
975 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
976
977 /**
978  * @defgroup lavc_packet AVPacket
979  *
980  * Types and functions for working with AVPacket.
981  * @{
982  */
983 enum AVPacketSideDataType {
984     /**
985      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
986      * bytes worth of palette. This side data signals that a new palette is
987      * present.
988      */
989     AV_PKT_DATA_PALETTE,
990
991     /**
992      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
993      * that the extradata buffer was changed and the receiving side should
994      * act upon it appropriately. The new extradata is embedded in the side
995      * data buffer and should be immediately used for processing the current
996      * frame or packet.
997      */
998     AV_PKT_DATA_NEW_EXTRADATA,
999
1000     /**
1001      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1002      * @code
1003      * u32le param_flags
1004      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1005      *     s32le channel_count
1006      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1007      *     u64le channel_layout
1008      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1009      *     s32le sample_rate
1010      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1011      *     s32le width
1012      *     s32le height
1013      * @endcode
1014      */
1015     AV_PKT_DATA_PARAM_CHANGE,
1016
1017     /**
1018      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1019      * structures with info about macroblocks relevant to splitting the
1020      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1021      * That is, it does not necessarily contain info about all macroblocks,
1022      * as long as the distance between macroblocks in the info is smaller
1023      * than the target payload size.
1024      * Each MB info structure is 12 bytes, and is laid out as follows:
1025      * @code
1026      * u32le bit offset from the start of the packet
1027      * u8    current quantizer at the start of the macroblock
1028      * u8    GOB number
1029      * u16le macroblock address within the GOB
1030      * u8    horizontal MV predictor
1031      * u8    vertical MV predictor
1032      * u8    horizontal MV predictor for block number 3
1033      * u8    vertical MV predictor for block number 3
1034      * @endcode
1035      */
1036     AV_PKT_DATA_H263_MB_INFO,
1037
1038     /**
1039      * This side data should be associated with an audio stream and contains
1040      * ReplayGain information in form of the AVReplayGain struct.
1041      */
1042     AV_PKT_DATA_REPLAYGAIN,
1043
1044     /**
1045      * This side data contains a 3x3 transformation matrix describing an affine
1046      * transformation that needs to be applied to the decoded video frames for
1047      * correct presentation.
1048      *
1049      * See libavutil/display.h for a detailed description of the data.
1050      */
1051     AV_PKT_DATA_DISPLAYMATRIX,
1052
1053     /**
1054      * This side data should be associated with a video stream and contains
1055      * Stereoscopic 3D information in form of the AVStereo3D struct.
1056      */
1057     AV_PKT_DATA_STEREO3D,
1058
1059     /**
1060      * This side data should be associated with an audio stream and corresponds
1061      * to enum AVAudioServiceType.
1062      */
1063     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1064
1065     /**
1066      * This side data contains an integer value representing the quality
1067      * factor of the compressed frame. Allowed range is between 1 (good)
1068      * and FF_LAMBDA_MAX (bad).
1069      */
1070     AV_PKT_DATA_QUALITY_FACTOR,
1071
1072     /**
1073      * This side data contains an integer value representing the stream index
1074      * of a "fallback" track.  A fallback track indicates an alternate
1075      * track to use when the current track can not be decoded for some reason.
1076      * e.g. no decoder available for codec.
1077      */
1078     AV_PKT_DATA_FALLBACK_TRACK,
1079
1080     /**
1081      * This side data corresponds to the AVCPBProperties struct.
1082      */
1083     AV_PKT_DATA_CPB_PROPERTIES,
1084
1085     /**
1086      * This side data should be associated with a video stream and corresponds
1087      * to the AVSphericalMapping structure.
1088      */
1089     AV_PKT_DATA_SPHERICAL,
1090 };
1091
1092 typedef struct AVPacketSideData {
1093     uint8_t *data;
1094     int      size;
1095     enum AVPacketSideDataType type;
1096 } AVPacketSideData;
1097
1098 /**
1099  * This structure stores compressed data. It is typically exported by demuxers
1100  * and then passed as input to decoders, or received as output from encoders and
1101  * then passed to muxers.
1102  *
1103  * For video, it should typically contain one compressed frame. For audio it may
1104  * contain several compressed frames. Encoders are allowed to output empty
1105  * packets, with no compressed data, containing only side data
1106  * (e.g. to update some stream parameters at the end of encoding).
1107  *
1108  * AVPacket is one of the few structs in Libav, whose size is a part of public
1109  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1110  * without libavcodec and libavformat major bump.
1111  *
1112  * The semantics of data ownership depends on the buf field.
1113  * If it is set, the packet data is dynamically allocated and is
1114  * valid indefinitely until a call to av_packet_unref() reduces the
1115  * reference count to 0.
1116  *
1117  * If the buf field is not set av_packet_ref() would make a copy instead
1118  * of increasing the reference count.
1119  *
1120  * The side data is always allocated with av_malloc(), copied by
1121  * av_packet_ref() and freed by av_packet_unref().
1122  *
1123  * @see av_packet_ref
1124  * @see av_packet_unref
1125  */
1126 typedef struct AVPacket {
1127     /**
1128      * A reference to the reference-counted buffer where the packet data is
1129      * stored.
1130      * May be NULL, then the packet data is not reference-counted.
1131      */
1132     AVBufferRef *buf;
1133     /**
1134      * Presentation timestamp in AVStream->time_base units; the time at which
1135      * the decompressed packet will be presented to the user.
1136      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1137      * pts MUST be larger or equal to dts as presentation cannot happen before
1138      * decompression, unless one wants to view hex dumps. Some formats misuse
1139      * the terms dts and pts/cts to mean something different. Such timestamps
1140      * must be converted to true pts/dts before they are stored in AVPacket.
1141      */
1142     int64_t pts;
1143     /**
1144      * Decompression timestamp in AVStream->time_base units; the time at which
1145      * the packet is decompressed.
1146      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1147      */
1148     int64_t dts;
1149     uint8_t *data;
1150     int   size;
1151     int   stream_index;
1152     /**
1153      * A combination of AV_PKT_FLAG values
1154      */
1155     int   flags;
1156     /**
1157      * Additional packet data that can be provided by the container.
1158      * Packet can contain several types of side information.
1159      */
1160     AVPacketSideData *side_data;
1161     int side_data_elems;
1162
1163     /**
1164      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1165      * Equals next_pts - this_pts in presentation order.
1166      */
1167     int64_t duration;
1168
1169     int64_t pos;                            ///< byte position in stream, -1 if unknown
1170
1171 #if FF_API_CONVERGENCE_DURATION
1172     /**
1173      * @deprecated Same as the duration field, but as int64_t. This was required
1174      * for Matroska subtitles, whose duration values could overflow when the
1175      * duration field was still an int.
1176      */
1177     attribute_deprecated
1178     int64_t convergence_duration;
1179 #endif
1180 } AVPacket;
1181 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1182 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1183
1184 enum AVSideDataParamChangeFlags {
1185     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1186     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1187     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1188     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1189 };
1190 /**
1191  * @}
1192  */
1193
1194 struct AVCodecInternal;
1195
1196 enum AVFieldOrder {
1197     AV_FIELD_UNKNOWN,
1198     AV_FIELD_PROGRESSIVE,
1199     AV_FIELD_TT,          //< Top coded_first, top displayed first
1200     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1201     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1202     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1203 };
1204
1205 /**
1206  * main external API structure.
1207  * New fields can be added to the end with minor version bumps.
1208  * Removal, reordering and changes to existing fields require a major
1209  * version bump.
1210  * sizeof(AVCodecContext) must not be used outside libav*.
1211  */
1212 typedef struct AVCodecContext {
1213     /**
1214      * information on struct for av_log
1215      * - set by avcodec_alloc_context3
1216      */
1217     const AVClass *av_class;
1218     int log_level_offset;
1219
1220     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1221     const struct AVCodec  *codec;
1222     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1223
1224     /**
1225      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1226      * This is used to work around some encoder bugs.
1227      * A demuxer should set this to what is stored in the field used to identify the codec.
1228      * If there are multiple such fields in a container then the demuxer should choose the one
1229      * which maximizes the information about the used codec.
1230      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1231      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1232      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1233      * first.
1234      * - encoding: Set by user, if not then the default based on codec_id will be used.
1235      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1236      */
1237     unsigned int codec_tag;
1238
1239 #if FF_API_STREAM_CODEC_TAG
1240     /**
1241      * @deprecated this field is unused
1242      */
1243     attribute_deprecated
1244     unsigned int stream_codec_tag;
1245 #endif
1246
1247     void *priv_data;
1248
1249     /**
1250      * Private context used for internal data.
1251      *
1252      * Unlike priv_data, this is not codec-specific. It is used in general
1253      * libavcodec functions.
1254      */
1255     struct AVCodecInternal *internal;
1256
1257     /**
1258      * Private data of the user, can be used to carry app specific stuff.
1259      * - encoding: Set by user.
1260      * - decoding: Set by user.
1261      */
1262     void *opaque;
1263
1264     /**
1265      * the average bitrate
1266      * - encoding: Set by user; unused for constant quantizer encoding.
1267      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1268      */
1269     int bit_rate;
1270
1271     /**
1272      * number of bits the bitstream is allowed to diverge from the reference.
1273      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1274      * - encoding: Set by user; unused for constant quantizer encoding.
1275      * - decoding: unused
1276      */
1277     int bit_rate_tolerance;
1278
1279     /**
1280      * Global quality for codecs which cannot change it per frame.
1281      * This should be proportional to MPEG-1/2/4 qscale.
1282      * - encoding: Set by user.
1283      * - decoding: unused
1284      */
1285     int global_quality;
1286
1287     /**
1288      * - encoding: Set by user.
1289      * - decoding: unused
1290      */
1291     int compression_level;
1292 #define FF_COMPRESSION_DEFAULT -1
1293
1294     /**
1295      * AV_CODEC_FLAG_*.
1296      * - encoding: Set by user.
1297      * - decoding: Set by user.
1298      */
1299     int flags;
1300
1301     /**
1302      * AV_CODEC_FLAG2_*
1303      * - encoding: Set by user.
1304      * - decoding: Set by user.
1305      */
1306     int flags2;
1307
1308     /**
1309      * some codecs need / can use extradata like Huffman tables.
1310      * MJPEG: Huffman tables
1311      * rv10: additional flags
1312      * MPEG-4: global headers (they can be in the bitstream or here)
1313      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1314      * than extradata_size to avoid problems if it is read with the bitstream reader.
1315      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1316      * - encoding: Set/allocated/freed by libavcodec.
1317      * - decoding: Set/allocated/freed by user.
1318      */
1319     uint8_t *extradata;
1320     int extradata_size;
1321
1322     /**
1323      * This is the fundamental unit of time (in seconds) in terms
1324      * of which frame timestamps are represented. For fixed-fps content,
1325      * timebase should be 1/framerate and timestamp increments should be
1326      * identically 1.
1327      * - encoding: MUST be set by user.
1328      * - decoding: the use of this field for decoding is deprecated.
1329      *             Use framerate instead.
1330      */
1331     AVRational time_base;
1332
1333     /**
1334      * For some codecs, the time base is closer to the field rate than the frame rate.
1335      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1336      * if no telecine is used ...
1337      *
1338      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1339      */
1340     int ticks_per_frame;
1341
1342     /**
1343      * Codec delay.
1344      *
1345      * Video:
1346      *   Number of frames the decoded output will be delayed relative to the
1347      *   encoded input.
1348      *
1349      * Audio:
1350      *   For encoding, this field is unused (see initial_padding).
1351      *
1352      *   For decoding, this is the number of samples the decoder needs to
1353      *   output before the decoder's output is valid. When seeking, you should
1354      *   start decoding this many samples prior to your desired seek point.
1355      *
1356      * - encoding: Set by libavcodec.
1357      * - decoding: Set by libavcodec.
1358      */
1359     int delay;
1360
1361
1362     /* video only */
1363     /**
1364      * picture width / height.
1365      *
1366      * @note Those fields may not match the values of the last
1367      * AVFrame output by avcodec_decode_video2 due frame
1368      * reordering.
1369      *
1370      * - encoding: MUST be set by user.
1371      * - decoding: May be set by the user before opening the decoder if known e.g.
1372      *             from the container. Some decoders will require the dimensions
1373      *             to be set by the caller. During decoding, the decoder may
1374      *             overwrite those values as required while parsing the data.
1375      */
1376     int width, height;
1377
1378     /**
1379      * Bitstream width / height, may be different from width/height e.g. when
1380      * the decoded frame is cropped before being output.
1381      *
1382      * @note Those field may not match the value of the last
1383      * AVFrame output by avcodec_receive_frame() due frame
1384      * reordering.
1385      *
1386      * - encoding: unused
1387      * - decoding: May be set by the user before opening the decoder if known
1388      *             e.g. from the container. During decoding, the decoder may
1389      *             overwrite those values as required while parsing the data.
1390      */
1391     int coded_width, coded_height;
1392
1393     /**
1394      * the number of pictures in a group of pictures, or 0 for intra_only
1395      * - encoding: Set by user.
1396      * - decoding: unused
1397      */
1398     int gop_size;
1399
1400     /**
1401      * Pixel format, see AV_PIX_FMT_xxx.
1402      * May be set by the demuxer if known from headers.
1403      * May be overridden by the decoder if it knows better.
1404      *
1405      * @note This field may not match the value of the last
1406      * AVFrame output by avcodec_receive_frame() due frame
1407      * reordering.
1408      *
1409      * - encoding: Set by user.
1410      * - decoding: Set by user if known, overridden by libavcodec while
1411      *             parsing the data.
1412      */
1413     enum AVPixelFormat pix_fmt;
1414
1415 #if FF_API_MOTION_EST
1416     /**
1417      * This option does nothing
1418      * @deprecated use codec private options instead
1419      */
1420     attribute_deprecated int me_method;
1421 #endif
1422
1423     /**
1424      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1425      * decoder to draw a horizontal band. It improves cache usage. Not
1426      * all codecs can do that. You must check the codec capabilities
1427      * beforehand.
1428      * When multithreading is used, it may be called from multiple threads
1429      * at the same time; threads might draw different parts of the same AVFrame,
1430      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1431      * in order.
1432      * The function is also used by hardware acceleration APIs.
1433      * It is called at least once during frame decoding to pass
1434      * the data needed for hardware render.
1435      * In that mode instead of pixel data, AVFrame points to
1436      * a structure specific to the acceleration API. The application
1437      * reads the structure and can change some fields to indicate progress
1438      * or mark state.
1439      * - encoding: unused
1440      * - decoding: Set by user.
1441      * @param height the height of the slice
1442      * @param y the y position of the slice
1443      * @param type 1->top field, 2->bottom field, 3->frame
1444      * @param offset offset into the AVFrame.data from which the slice should be read
1445      */
1446     void (*draw_horiz_band)(struct AVCodecContext *s,
1447                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1448                             int y, int type, int height);
1449
1450     /**
1451      * callback to negotiate the pixelFormat
1452      * @param fmt is the list of formats which are supported by the codec,
1453      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1454      * The first is always the native one.
1455      * @note The callback may be called again immediately if initialization for
1456      * the selected (hardware-accelerated) pixel format failed.
1457      * @warning Behavior is undefined if the callback returns a value not
1458      * in the fmt list of formats.
1459      * @return the chosen format
1460      * - encoding: unused
1461      * - decoding: Set by user, if not set the native format will be chosen.
1462      */
1463     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1464
1465     /**
1466      * maximum number of B-frames between non-B-frames
1467      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1468      * - encoding: Set by user.
1469      * - decoding: unused
1470      */
1471     int max_b_frames;
1472
1473     /**
1474      * qscale factor between IP and B-frames
1475      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1476      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1477      * - encoding: Set by user.
1478      * - decoding: unused
1479      */
1480     float b_quant_factor;
1481
1482 #if FF_API_RC_STRATEGY
1483     /** @deprecated use codec private option instead */
1484     attribute_deprecated int rc_strategy;
1485 #define FF_RC_STRATEGY_XVID 1
1486 #endif
1487
1488 #if FF_API_PRIVATE_OPT
1489     /** @deprecated use encoder private options instead */
1490     attribute_deprecated
1491     int b_frame_strategy;
1492 #endif
1493
1494     /**
1495      * qscale offset between IP and B-frames
1496      * - encoding: Set by user.
1497      * - decoding: unused
1498      */
1499     float b_quant_offset;
1500
1501     /**
1502      * Size of the frame reordering buffer in the decoder.
1503      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1504      * - encoding: Set by libavcodec.
1505      * - decoding: Set by libavcodec.
1506      */
1507     int has_b_frames;
1508
1509 #if FF_API_PRIVATE_OPT
1510     /** @deprecated use encoder private options instead */
1511     attribute_deprecated
1512     int mpeg_quant;
1513 #endif
1514
1515     /**
1516      * qscale factor between P- and I-frames
1517      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1518      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1519      * - encoding: Set by user.
1520      * - decoding: unused
1521      */
1522     float i_quant_factor;
1523
1524     /**
1525      * qscale offset between P and I-frames
1526      * - encoding: Set by user.
1527      * - decoding: unused
1528      */
1529     float i_quant_offset;
1530
1531     /**
1532      * luminance masking (0-> disabled)
1533      * - encoding: Set by user.
1534      * - decoding: unused
1535      */
1536     float lumi_masking;
1537
1538     /**
1539      * temporary complexity masking (0-> disabled)
1540      * - encoding: Set by user.
1541      * - decoding: unused
1542      */
1543     float temporal_cplx_masking;
1544
1545     /**
1546      * spatial complexity masking (0-> disabled)
1547      * - encoding: Set by user.
1548      * - decoding: unused
1549      */
1550     float spatial_cplx_masking;
1551
1552     /**
1553      * p block masking (0-> disabled)
1554      * - encoding: Set by user.
1555      * - decoding: unused
1556      */
1557     float p_masking;
1558
1559     /**
1560      * darkness masking (0-> disabled)
1561      * - encoding: Set by user.
1562      * - decoding: unused
1563      */
1564     float dark_masking;
1565
1566     /**
1567      * slice count
1568      * - encoding: Set by libavcodec.
1569      * - decoding: Set by user (or 0).
1570      */
1571     int slice_count;
1572
1573 #if FF_API_PRIVATE_OPT
1574     /** @deprecated use encoder private options instead */
1575     attribute_deprecated
1576      int prediction_method;
1577 #define FF_PRED_LEFT   0
1578 #define FF_PRED_PLANE  1
1579 #define FF_PRED_MEDIAN 2
1580 #endif
1581
1582     /**
1583      * slice offsets in the frame in bytes
1584      * - encoding: Set/allocated by libavcodec.
1585      * - decoding: Set/allocated by user (or NULL).
1586      */
1587     int *slice_offset;
1588
1589     /**
1590      * sample aspect ratio (0 if unknown)
1591      * That is the width of a pixel divided by the height of the pixel.
1592      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1593      * - encoding: Set by user.
1594      * - decoding: Set by libavcodec.
1595      */
1596     AVRational sample_aspect_ratio;
1597
1598     /**
1599      * motion estimation comparison function
1600      * - encoding: Set by user.
1601      * - decoding: unused
1602      */
1603     int me_cmp;
1604     /**
1605      * subpixel motion estimation comparison function
1606      * - encoding: Set by user.
1607      * - decoding: unused
1608      */
1609     int me_sub_cmp;
1610     /**
1611      * macroblock comparison function (not supported yet)
1612      * - encoding: Set by user.
1613      * - decoding: unused
1614      */
1615     int mb_cmp;
1616     /**
1617      * interlaced DCT comparison function
1618      * - encoding: Set by user.
1619      * - decoding: unused
1620      */
1621     int ildct_cmp;
1622 #define FF_CMP_SAD    0
1623 #define FF_CMP_SSE    1
1624 #define FF_CMP_SATD   2
1625 #define FF_CMP_DCT    3
1626 #define FF_CMP_PSNR   4
1627 #define FF_CMP_BIT    5
1628 #define FF_CMP_RD     6
1629 #define FF_CMP_ZERO   7
1630 #define FF_CMP_VSAD   8
1631 #define FF_CMP_VSSE   9
1632 #define FF_CMP_NSSE   10
1633 #define FF_CMP_DCTMAX 13
1634 #define FF_CMP_DCT264 14
1635 #define FF_CMP_CHROMA 256
1636
1637     /**
1638      * ME diamond size & shape
1639      * - encoding: Set by user.
1640      * - decoding: unused
1641      */
1642     int dia_size;
1643
1644     /**
1645      * amount of previous MV predictors (2a+1 x 2a+1 square)
1646      * - encoding: Set by user.
1647      * - decoding: unused
1648      */
1649     int last_predictor_count;
1650
1651 #if FF_API_PRIVATE_OPT
1652     /** @deprecated use encoder private options instead */
1653     attribute_deprecated
1654     int pre_me;
1655 #endif
1656
1657     /**
1658      * motion estimation prepass comparison function
1659      * - encoding: Set by user.
1660      * - decoding: unused
1661      */
1662     int me_pre_cmp;
1663
1664     /**
1665      * ME prepass diamond size & shape
1666      * - encoding: Set by user.
1667      * - decoding: unused
1668      */
1669     int pre_dia_size;
1670
1671     /**
1672      * subpel ME quality
1673      * - encoding: Set by user.
1674      * - decoding: unused
1675      */
1676     int me_subpel_quality;
1677
1678 #if FF_API_AFD
1679     /**
1680      * DTG active format information (additional aspect ratio
1681      * information only used in DVB MPEG-2 transport streams)
1682      * 0 if not set.
1683      *
1684      * - encoding: unused
1685      * - decoding: Set by decoder.
1686      * @deprecated Deprecated in favor of AVSideData
1687      */
1688     attribute_deprecated int dtg_active_format;
1689 #define FF_DTG_AFD_SAME         8
1690 #define FF_DTG_AFD_4_3          9
1691 #define FF_DTG_AFD_16_9         10
1692 #define FF_DTG_AFD_14_9         11
1693 #define FF_DTG_AFD_4_3_SP_14_9  13
1694 #define FF_DTG_AFD_16_9_SP_14_9 14
1695 #define FF_DTG_AFD_SP_4_3       15
1696 #endif /* FF_API_AFD */
1697
1698     /**
1699      * maximum motion estimation search range in subpel units
1700      * If 0 then no limit.
1701      *
1702      * - encoding: Set by user.
1703      * - decoding: unused
1704      */
1705     int me_range;
1706
1707 #if FF_API_QUANT_BIAS
1708     /**
1709      * @deprecated use encoder private option instead
1710      */
1711     attribute_deprecated int intra_quant_bias;
1712 #define FF_DEFAULT_QUANT_BIAS 999999
1713
1714     /**
1715      * @deprecated use encoder private option instead
1716      */
1717     attribute_deprecated int inter_quant_bias;
1718 #endif
1719
1720     /**
1721      * slice flags
1722      * - encoding: unused
1723      * - decoding: Set by user.
1724      */
1725     int slice_flags;
1726 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1727 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1728 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1729
1730     /**
1731      * macroblock decision mode
1732      * - encoding: Set by user.
1733      * - decoding: unused
1734      */
1735     int mb_decision;
1736 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1737 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1738 #define FF_MB_DECISION_RD     2        ///< rate distortion
1739
1740     /**
1741      * custom intra quantization matrix
1742      * - encoding: Set by user, can be NULL.
1743      * - decoding: Set by libavcodec.
1744      */
1745     uint16_t *intra_matrix;
1746
1747     /**
1748      * custom inter quantization matrix
1749      * - encoding: Set by user, can be NULL.
1750      * - decoding: Set by libavcodec.
1751      */
1752     uint16_t *inter_matrix;
1753
1754 #if FF_API_PRIVATE_OPT
1755     /** @deprecated use encoder private options instead */
1756     attribute_deprecated
1757     int scenechange_threshold;
1758
1759     /** @deprecated use encoder private options instead */
1760     attribute_deprecated
1761     int noise_reduction;
1762 #endif
1763
1764 #if FF_API_MPV_OPT
1765     /**
1766      * @deprecated this field is unused
1767      */
1768     attribute_deprecated
1769     int me_threshold;
1770
1771     /**
1772      * @deprecated this field is unused
1773      */
1774     attribute_deprecated
1775     int mb_threshold;
1776 #endif
1777
1778     /**
1779      * precision of the intra DC coefficient - 8
1780      * - encoding: Set by user.
1781      * - decoding: unused
1782      */
1783     int intra_dc_precision;
1784
1785     /**
1786      * Number of macroblock rows at the top which are skipped.
1787      * - encoding: unused
1788      * - decoding: Set by user.
1789      */
1790     int skip_top;
1791
1792     /**
1793      * Number of macroblock rows at the bottom which are skipped.
1794      * - encoding: unused
1795      * - decoding: Set by user.
1796      */
1797     int skip_bottom;
1798
1799 #if FF_API_MPV_OPT
1800     /**
1801      * @deprecated use encoder private options instead
1802      */
1803     attribute_deprecated
1804     float border_masking;
1805 #endif
1806
1807     /**
1808      * minimum MB Lagrange multiplier
1809      * - encoding: Set by user.
1810      * - decoding: unused
1811      */
1812     int mb_lmin;
1813
1814     /**
1815      * maximum MB Lagrange multiplier
1816      * - encoding: Set by user.
1817      * - decoding: unused
1818      */
1819     int mb_lmax;
1820
1821 #if FF_API_PRIVATE_OPT
1822     /**
1823      * @deprecated use encoder private options instead
1824      */
1825     attribute_deprecated
1826     int me_penalty_compensation;
1827 #endif
1828
1829     /**
1830      * - encoding: Set by user.
1831      * - decoding: unused
1832      */
1833     int bidir_refine;
1834
1835 #if FF_API_PRIVATE_OPT
1836     /** @deprecated use encoder private options instead */
1837     attribute_deprecated
1838     int brd_scale;
1839 #endif
1840
1841     /**
1842      * minimum GOP size
1843      * - encoding: Set by user.
1844      * - decoding: unused
1845      */
1846     int keyint_min;
1847
1848     /**
1849      * number of reference frames
1850      * - encoding: Set by user.
1851      * - decoding: Set by lavc.
1852      */
1853     int refs;
1854
1855 #if FF_API_PRIVATE_OPT
1856     /** @deprecated use encoder private options instead */
1857     attribute_deprecated
1858     int chromaoffset;
1859 #endif
1860
1861     /**
1862      * Note: Value depends upon the compare function used for fullpel ME.
1863      * - encoding: Set by user.
1864      * - decoding: unused
1865      */
1866     int mv0_threshold;
1867
1868 #if FF_API_PRIVATE_OPT
1869     /** @deprecated use encoder private options instead */
1870     attribute_deprecated
1871     int b_sensitivity;
1872 #endif
1873
1874     /**
1875      * Chromaticity coordinates of the source primaries.
1876      * - encoding: Set by user
1877      * - decoding: Set by libavcodec
1878      */
1879     enum AVColorPrimaries color_primaries;
1880
1881     /**
1882      * Color Transfer Characteristic.
1883      * - encoding: Set by user
1884      * - decoding: Set by libavcodec
1885      */
1886     enum AVColorTransferCharacteristic color_trc;
1887
1888     /**
1889      * YUV colorspace type.
1890      * - encoding: Set by user
1891      * - decoding: Set by libavcodec
1892      */
1893     enum AVColorSpace colorspace;
1894
1895     /**
1896      * MPEG vs JPEG YUV range.
1897      * - encoding: Set by user
1898      * - decoding: Set by libavcodec
1899      */
1900     enum AVColorRange color_range;
1901
1902     /**
1903      * This defines the location of chroma samples.
1904      * - encoding: Set by user
1905      * - decoding: Set by libavcodec
1906      */
1907     enum AVChromaLocation chroma_sample_location;
1908
1909     /**
1910      * Number of slices.
1911      * Indicates number of picture subdivisions. Used for parallelized
1912      * decoding.
1913      * - encoding: Set by user
1914      * - decoding: unused
1915      */
1916     int slices;
1917
1918     /** Field order
1919      * - encoding: set by libavcodec
1920      * - decoding: Set by libavcodec
1921      */
1922     enum AVFieldOrder field_order;
1923
1924     /* audio only */
1925     int sample_rate; ///< samples per second
1926     int channels;    ///< number of audio channels
1927
1928     /**
1929      * audio sample format
1930      * - encoding: Set by user.
1931      * - decoding: Set by libavcodec.
1932      */
1933     enum AVSampleFormat sample_fmt;  ///< sample format
1934
1935     /* The following data should not be initialized. */
1936     /**
1937      * Number of samples per channel in an audio frame.
1938      *
1939      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1940      *   except the last must contain exactly frame_size samples per channel.
1941      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1942      *   frame size is not restricted.
1943      * - decoding: may be set by some decoders to indicate constant frame size
1944      */
1945     int frame_size;
1946
1947     /**
1948      * Frame counter, set by libavcodec.
1949      *
1950      * - decoding: total number of frames returned from the decoder so far.
1951      * - encoding: total number of frames passed to the encoder so far.
1952      *
1953      *   @note the counter is not incremented if encoding/decoding resulted in
1954      *   an error.
1955      */
1956     int frame_number;
1957
1958     /**
1959      * number of bytes per packet if constant and known or 0
1960      * Used by some WAV based audio codecs.
1961      */
1962     int block_align;
1963
1964     /**
1965      * Audio cutoff bandwidth (0 means "automatic")
1966      * - encoding: Set by user.
1967      * - decoding: unused
1968      */
1969     int cutoff;
1970
1971     /**
1972      * Audio channel layout.
1973      * - encoding: set by user.
1974      * - decoding: set by libavcodec.
1975      */
1976     uint64_t channel_layout;
1977
1978     /**
1979      * Request decoder to use this channel layout if it can (0 for default)
1980      * - encoding: unused
1981      * - decoding: Set by user.
1982      */
1983     uint64_t request_channel_layout;
1984
1985     /**
1986      * Type of service that the audio stream conveys.
1987      * - encoding: Set by user.
1988      * - decoding: Set by libavcodec.
1989      */
1990     enum AVAudioServiceType audio_service_type;
1991
1992     /**
1993      * Used to request a sample format from the decoder.
1994      * - encoding: unused.
1995      * - decoding: Set by user.
1996      */
1997     enum AVSampleFormat request_sample_fmt;
1998
1999     /**
2000      * This callback is called at the beginning of each frame to get data
2001      * buffer(s) for it. There may be one contiguous buffer for all the data or
2002      * there may be a buffer per each data plane or anything in between. What
2003      * this means is, you may set however many entries in buf[] you feel necessary.
2004      * Each buffer must be reference-counted using the AVBuffer API (see description
2005      * of buf[] below).
2006      *
2007      * The following fields will be set in the frame before this callback is
2008      * called:
2009      * - format
2010      * - width, height (video only)
2011      * - sample_rate, channel_layout, nb_samples (audio only)
2012      * Their values may differ from the corresponding values in
2013      * AVCodecContext. This callback must use the frame values, not the codec
2014      * context values, to calculate the required buffer size.
2015      *
2016      * This callback must fill the following fields in the frame:
2017      * - data[]
2018      * - linesize[]
2019      * - extended_data:
2020      *   * if the data is planar audio with more than 8 channels, then this
2021      *     callback must allocate and fill extended_data to contain all pointers
2022      *     to all data planes. data[] must hold as many pointers as it can.
2023      *     extended_data must be allocated with av_malloc() and will be freed in
2024      *     av_frame_unref().
2025      *   * otherwise extended_data must point to data
2026      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2027      *   the frame's data and extended_data pointers must be contained in these. That
2028      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2029      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2030      *   and av_buffer_ref().
2031      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2032      *   this callback and filled with the extra buffers if there are more
2033      *   buffers than buf[] can hold. extended_buf will be freed in
2034      *   av_frame_unref().
2035      *
2036      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2037      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2038      * some other means.
2039      *
2040      * Each data plane must be aligned to the maximum required by the target
2041      * CPU.
2042      *
2043      * @see avcodec_default_get_buffer2()
2044      *
2045      * Video:
2046      *
2047      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2048      * (read and/or written to if it is writable) later by libavcodec.
2049      *
2050      * avcodec_align_dimensions2() should be used to find the required width and
2051      * height, as they normally need to be rounded up to the next multiple of 16.
2052      *
2053      * If frame multithreading is used and thread_safe_callbacks is set,
2054      * this callback may be called from a different thread, but not from more
2055      * than one at once. Does not need to be reentrant.
2056      *
2057      * @see avcodec_align_dimensions2()
2058      *
2059      * Audio:
2060      *
2061      * Decoders request a buffer of a particular size by setting
2062      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2063      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2064      * to a smaller value in the output frame.
2065      *
2066      * As a convenience, av_samples_get_buffer_size() and
2067      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2068      * functions to find the required data size and to fill data pointers and
2069      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2070      * since all planes must be the same size.
2071      *
2072      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2073      *
2074      * - encoding: unused
2075      * - decoding: Set by libavcodec, user can override.
2076      */
2077     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2078
2079     /**
2080      * If non-zero, the decoded audio and video frames returned from
2081      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2082      * and are valid indefinitely. The caller must free them with
2083      * av_frame_unref() when they are not needed anymore.
2084      * Otherwise, the decoded frames must not be freed by the caller and are
2085      * only valid until the next decode call.
2086      *
2087      * This is always automatically enabled if avcodec_receive_frame() is used.
2088      *
2089      * - encoding: unused
2090      * - decoding: set by the caller before avcodec_open2().
2091      */
2092     attribute_deprecated int refcounted_frames;
2093
2094     /* - encoding parameters */
2095     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2096     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2097
2098     /**
2099      * minimum quantizer
2100      * - encoding: Set by user.
2101      * - decoding: unused
2102      */
2103     int qmin;
2104
2105     /**
2106      * maximum quantizer
2107      * - encoding: Set by user.
2108      * - decoding: unused
2109      */
2110     int qmax;
2111
2112     /**
2113      * maximum quantizer difference between frames
2114      * - encoding: Set by user.
2115      * - decoding: unused
2116      */
2117     int max_qdiff;
2118
2119 #if FF_API_MPV_OPT
2120     /**
2121      * @deprecated use encoder private options instead
2122      */
2123     attribute_deprecated
2124     float rc_qsquish;
2125
2126     attribute_deprecated
2127     float rc_qmod_amp;
2128     attribute_deprecated
2129     int rc_qmod_freq;
2130 #endif
2131
2132     /**
2133      * decoder bitstream buffer size
2134      * - encoding: Set by user.
2135      * - decoding: unused
2136      */
2137     int rc_buffer_size;
2138
2139     /**
2140      * ratecontrol override, see RcOverride
2141      * - encoding: Allocated/set/freed by user.
2142      * - decoding: unused
2143      */
2144     int rc_override_count;
2145     RcOverride *rc_override;
2146
2147 #if FF_API_MPV_OPT
2148     /**
2149      * @deprecated use encoder private options instead
2150      */
2151     attribute_deprecated
2152     const char *rc_eq;
2153 #endif
2154
2155     /**
2156      * maximum bitrate
2157      * - encoding: Set by user.
2158      * - decoding: unused
2159      */
2160     int rc_max_rate;
2161
2162     /**
2163      * minimum bitrate
2164      * - encoding: Set by user.
2165      * - decoding: unused
2166      */
2167     int rc_min_rate;
2168
2169 #if FF_API_MPV_OPT
2170     /**
2171      * @deprecated use encoder private options instead
2172      */
2173     attribute_deprecated
2174     float rc_buffer_aggressivity;
2175
2176     attribute_deprecated
2177     float rc_initial_cplx;
2178 #endif
2179
2180     /**
2181      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2182      * - encoding: Set by user.
2183      * - decoding: unused.
2184      */
2185     float rc_max_available_vbv_use;
2186
2187     /**
2188      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2189      * - encoding: Set by user.
2190      * - decoding: unused.
2191      */
2192     float rc_min_vbv_overflow_use;
2193
2194     /**
2195      * Number of bits which should be loaded into the rc buffer before decoding starts.
2196      * - encoding: Set by user.
2197      * - decoding: unused
2198      */
2199     int rc_initial_buffer_occupancy;
2200
2201 #if FF_API_CODER_TYPE
2202 #define FF_CODER_TYPE_VLC       0
2203 #define FF_CODER_TYPE_AC        1
2204 #define FF_CODER_TYPE_RAW       2
2205 #define FF_CODER_TYPE_RLE       3
2206     /**
2207      * @deprecated use encoder private options instead
2208      */
2209     attribute_deprecated
2210     int coder_type;
2211 #endif /* FF_API_CODER_TYPE */
2212
2213 #if FF_API_PRIVATE_OPT
2214     /** @deprecated use encoder private options instead */
2215     attribute_deprecated
2216     int context_model;
2217 #endif
2218
2219 #if FF_API_MPV_OPT
2220     /**
2221      * @deprecated use encoder private options instead
2222      */
2223     attribute_deprecated
2224     int lmin;
2225
2226     /**
2227      * @deprecated use encoder private options instead
2228      */
2229     attribute_deprecated
2230     int lmax;
2231 #endif
2232
2233 #if FF_API_PRIVATE_OPT
2234     /** @deprecated use encoder private options instead */
2235     attribute_deprecated
2236     int frame_skip_threshold;
2237
2238     /** @deprecated use encoder private options instead */
2239     attribute_deprecated
2240     int frame_skip_factor;
2241
2242     /** @deprecated use encoder private options instead */
2243     attribute_deprecated
2244     int frame_skip_exp;
2245
2246     /** @deprecated use encoder private options instead */
2247     attribute_deprecated
2248     int frame_skip_cmp;
2249 #endif /* FF_API_PRIVATE_OPT */
2250
2251     /**
2252      * trellis RD quantization
2253      * - encoding: Set by user.
2254      * - decoding: unused
2255      */
2256     int trellis;
2257
2258 #if FF_API_PRIVATE_OPT
2259     /** @deprecated use encoder private options instead */
2260     attribute_deprecated
2261     int min_prediction_order;
2262
2263     /** @deprecated use encoder private options instead */
2264     attribute_deprecated
2265     int max_prediction_order;
2266
2267     /** @deprecated use encoder private options instead */
2268     attribute_deprecated
2269     int64_t timecode_frame_start;
2270 #endif
2271
2272 #if FF_API_RTP_CALLBACK
2273     /**
2274      * @deprecated unused
2275      */
2276     /* The RTP callback: This function is called    */
2277     /* every time the encoder has a packet to send. */
2278     /* It depends on the encoder if the data starts */
2279     /* with a Start Code (it should). H.263 does.   */
2280     /* mb_nb contains the number of macroblocks     */
2281     /* encoded in the RTP payload.                  */
2282     attribute_deprecated
2283     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2284 #endif
2285
2286 #if FF_API_PRIVATE_OPT
2287     /** @deprecated use encoder private options instead */
2288     attribute_deprecated
2289     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2290                             /* do its best to deliver a chunk with size     */
2291                             /* below rtp_payload_size, the chunk will start */
2292                             /* with a start code on some codecs like H.263. */
2293                             /* This doesn't take account of any particular  */
2294                             /* headers inside the transmitted RTP payload.  */
2295 #endif
2296
2297 #if FF_API_STAT_BITS
2298     /* statistics, used for 2-pass encoding */
2299     attribute_deprecated
2300     int mv_bits;
2301     attribute_deprecated
2302     int header_bits;
2303     attribute_deprecated
2304     int i_tex_bits;
2305     attribute_deprecated
2306     int p_tex_bits;
2307     attribute_deprecated
2308     int i_count;
2309     attribute_deprecated
2310     int p_count;
2311     attribute_deprecated
2312     int skip_count;
2313     attribute_deprecated
2314     int misc_bits;
2315
2316     /** @deprecated this field is unused */
2317     attribute_deprecated
2318     int frame_bits;
2319 #endif
2320
2321     /**
2322      * pass1 encoding statistics output buffer
2323      * - encoding: Set by libavcodec.
2324      * - decoding: unused
2325      */
2326     char *stats_out;
2327
2328     /**
2329      * pass2 encoding statistics input buffer
2330      * Concatenated stuff from stats_out of pass1 should be placed here.
2331      * - encoding: Allocated/set/freed by user.
2332      * - decoding: unused
2333      */
2334     char *stats_in;
2335
2336     /**
2337      * Work around bugs in encoders which sometimes cannot be detected automatically.
2338      * - encoding: Set by user
2339      * - decoding: Set by user
2340      */
2341     int workaround_bugs;
2342 #define FF_BUG_AUTODETECT       1  ///< autodetection
2343 #define FF_BUG_XVID_ILACE       4
2344 #define FF_BUG_UMP4             8
2345 #define FF_BUG_NO_PADDING       16
2346 #define FF_BUG_AMV              32
2347 #define FF_BUG_QPEL_CHROMA      64
2348 #define FF_BUG_STD_QPEL         128
2349 #define FF_BUG_QPEL_CHROMA2     256
2350 #define FF_BUG_DIRECT_BLOCKSIZE 512
2351 #define FF_BUG_EDGE             1024
2352 #define FF_BUG_HPEL_CHROMA      2048
2353 #define FF_BUG_DC_CLIP          4096
2354 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2355 #define FF_BUG_TRUNCATED       16384
2356
2357     /**
2358      * strictly follow the standard (MPEG-4, ...).
2359      * - encoding: Set by user.
2360      * - decoding: Set by user.
2361      * Setting this to STRICT or higher means the encoder and decoder will
2362      * generally do stupid things, whereas setting it to unofficial or lower
2363      * will mean the encoder might produce output that is not supported by all
2364      * spec-compliant decoders. Decoders don't differentiate between normal,
2365      * unofficial and experimental (that is, they always try to decode things
2366      * when they can) unless they are explicitly asked to behave stupidly
2367      * (=strictly conform to the specs)
2368      */
2369     int strict_std_compliance;
2370 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2371 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2372 #define FF_COMPLIANCE_NORMAL        0
2373 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2374 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2375
2376     /**
2377      * error concealment flags
2378      * - encoding: unused
2379      * - decoding: Set by user.
2380      */
2381     int error_concealment;
2382 #define FF_EC_GUESS_MVS   1
2383 #define FF_EC_DEBLOCK     2
2384
2385     /**
2386      * debug
2387      * - encoding: Set by user.
2388      * - decoding: Set by user.
2389      */
2390     int debug;
2391 #define FF_DEBUG_PICT_INFO   1
2392 #define FF_DEBUG_RC          2
2393 #define FF_DEBUG_BITSTREAM   4
2394 #define FF_DEBUG_MB_TYPE     8
2395 #define FF_DEBUG_QP          16
2396 #define FF_DEBUG_DCT_COEFF   0x00000040
2397 #define FF_DEBUG_SKIP        0x00000080
2398 #define FF_DEBUG_STARTCODE   0x00000100
2399 #define FF_DEBUG_ER          0x00000400
2400 #define FF_DEBUG_MMCO        0x00000800
2401 #define FF_DEBUG_BUGS        0x00001000
2402 #define FF_DEBUG_BUFFERS     0x00008000
2403 #define FF_DEBUG_THREADS     0x00010000
2404
2405     /**
2406      * Error recognition; may misdetect some more or less valid parts as errors.
2407      * - encoding: unused
2408      * - decoding: Set by user.
2409      */
2410     int err_recognition;
2411
2412 /**
2413  * Verify checksums embedded in the bitstream (could be of either encoded or
2414  * decoded data, depending on the codec) and print an error message on mismatch.
2415  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2416  * decoder returning an error.
2417  */
2418 #define AV_EF_CRCCHECK  (1<<0)
2419 #define AV_EF_BITSTREAM (1<<1)
2420 #define AV_EF_BUFFER    (1<<2)
2421 #define AV_EF_EXPLODE   (1<<3)
2422
2423     /**
2424      * opaque 64-bit number (generally a PTS) that will be reordered and
2425      * output in AVFrame.reordered_opaque
2426      * - encoding: unused
2427      * - decoding: Set by user.
2428      */
2429     int64_t reordered_opaque;
2430
2431     /**
2432      * Hardware accelerator in use
2433      * - encoding: unused.
2434      * - decoding: Set by libavcodec
2435      */
2436     struct AVHWAccel *hwaccel;
2437
2438     /**
2439      * Hardware accelerator context.
2440      * For some hardware accelerators, a global context needs to be
2441      * provided by the user. In that case, this holds display-dependent
2442      * data Libav cannot instantiate itself. Please refer to the
2443      * Libav HW accelerator documentation to know how to fill this
2444      * is. e.g. for VA API, this is a struct vaapi_context.
2445      * - encoding: unused
2446      * - decoding: Set by user
2447      */
2448     void *hwaccel_context;
2449
2450     /**
2451      * error
2452      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2453      * - decoding: unused
2454      */
2455     uint64_t error[AV_NUM_DATA_POINTERS];
2456
2457     /**
2458      * DCT algorithm, see FF_DCT_* below
2459      * - encoding: Set by user.
2460      * - decoding: unused
2461      */
2462     int dct_algo;
2463 #define FF_DCT_AUTO    0
2464 #define FF_DCT_FASTINT 1
2465 #define FF_DCT_INT     2
2466 #define FF_DCT_MMX     3
2467 #define FF_DCT_ALTIVEC 5
2468 #define FF_DCT_FAAN    6
2469
2470     /**
2471      * IDCT algorithm, see FF_IDCT_* below.
2472      * - encoding: Set by user.
2473      * - decoding: Set by user.
2474      */
2475     int idct_algo;
2476 #define FF_IDCT_AUTO          0
2477 #define FF_IDCT_INT           1
2478 #define FF_IDCT_SIMPLE        2
2479 #define FF_IDCT_SIMPLEMMX     3
2480 #define FF_IDCT_ARM           7
2481 #define FF_IDCT_ALTIVEC       8
2482 #define FF_IDCT_SIMPLEARM     10
2483 #define FF_IDCT_XVID          14
2484 #define FF_IDCT_SIMPLEARMV5TE 16
2485 #define FF_IDCT_SIMPLEARMV6   17
2486 #define FF_IDCT_FAAN          20
2487 #define FF_IDCT_SIMPLENEON    22
2488
2489     /**
2490      * bits per sample/pixel from the demuxer (needed for huffyuv).
2491      * - encoding: Set by libavcodec.
2492      * - decoding: Set by user.
2493      */
2494      int bits_per_coded_sample;
2495
2496     /**
2497      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2498      * - encoding: set by user.
2499      * - decoding: set by libavcodec.
2500      */
2501     int bits_per_raw_sample;
2502
2503 #if FF_API_CODED_FRAME
2504     /**
2505      * the picture in the bitstream
2506      * - encoding: Set by libavcodec.
2507      * - decoding: unused
2508      *
2509      * @deprecated use the quality factor packet side data instead
2510      */
2511     attribute_deprecated AVFrame *coded_frame;
2512 #endif
2513
2514     /**
2515      * thread count
2516      * is used to decide how many independent tasks should be passed to execute()
2517      * - encoding: Set by user.
2518      * - decoding: Set by user.
2519      */
2520     int thread_count;
2521
2522     /**
2523      * Which multithreading methods to use.
2524      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2525      * so clients which cannot provide future frames should not use it.
2526      *
2527      * - encoding: Set by user, otherwise the default is used.
2528      * - decoding: Set by user, otherwise the default is used.
2529      */
2530     int thread_type;
2531 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2532 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2533
2534     /**
2535      * Which multithreading methods are in use by the codec.
2536      * - encoding: Set by libavcodec.
2537      * - decoding: Set by libavcodec.
2538      */
2539     int active_thread_type;
2540
2541     /**
2542      * Set by the client if its custom get_buffer() callback can be called
2543      * synchronously from another thread, which allows faster multithreaded decoding.
2544      * draw_horiz_band() will be called from other threads regardless of this setting.
2545      * Ignored if the default get_buffer() is used.
2546      * - encoding: Set by user.
2547      * - decoding: Set by user.
2548      */
2549     int thread_safe_callbacks;
2550
2551     /**
2552      * The codec may call this to execute several independent things.
2553      * It will return only after finishing all tasks.
2554      * The user may replace this with some multithreaded implementation,
2555      * the default implementation will execute the parts serially.
2556      * @param count the number of things to execute
2557      * - encoding: Set by libavcodec, user can override.
2558      * - decoding: Set by libavcodec, user can override.
2559      */
2560     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2561
2562     /**
2563      * The codec may call this to execute several independent things.
2564      * It will return only after finishing all tasks.
2565      * The user may replace this with some multithreaded implementation,
2566      * the default implementation will execute the parts serially.
2567      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2568      * @param c context passed also to func
2569      * @param count the number of things to execute
2570      * @param arg2 argument passed unchanged to func
2571      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2572      * @param func function that will be called count times, with jobnr from 0 to count-1.
2573      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2574      *             two instances of func executing at the same time will have the same threadnr.
2575      * @return always 0 currently, but code should handle a future improvement where when any call to func
2576      *         returns < 0 no further calls to func may be done and < 0 is returned.
2577      * - encoding: Set by libavcodec, user can override.
2578      * - decoding: Set by libavcodec, user can override.
2579      */
2580     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2581
2582     /**
2583      * noise vs. sse weight for the nsse comparison function
2584      * - encoding: Set by user.
2585      * - decoding: unused
2586      */
2587      int nsse_weight;
2588
2589     /**
2590      * profile
2591      * - encoding: Set by user.
2592      * - decoding: Set by libavcodec.
2593      */
2594      int profile;
2595 #define FF_PROFILE_UNKNOWN -99
2596 #define FF_PROFILE_RESERVED -100
2597
2598 #define FF_PROFILE_AAC_MAIN 0
2599 #define FF_PROFILE_AAC_LOW  1
2600 #define FF_PROFILE_AAC_SSR  2
2601 #define FF_PROFILE_AAC_LTP  3
2602 #define FF_PROFILE_AAC_HE   4
2603 #define FF_PROFILE_AAC_HE_V2 28
2604 #define FF_PROFILE_AAC_LD   22
2605 #define FF_PROFILE_AAC_ELD  38
2606 #define FF_PROFILE_MPEG2_AAC_LOW 128
2607 #define FF_PROFILE_MPEG2_AAC_HE  131
2608
2609 #define FF_PROFILE_DTS         20
2610 #define FF_PROFILE_DTS_ES      30
2611 #define FF_PROFILE_DTS_96_24   40
2612 #define FF_PROFILE_DTS_HD_HRA  50
2613 #define FF_PROFILE_DTS_HD_MA   60
2614 #define FF_PROFILE_DTS_EXPRESS 70
2615
2616 #define FF_PROFILE_MPEG2_422    0
2617 #define FF_PROFILE_MPEG2_HIGH   1
2618 #define FF_PROFILE_MPEG2_SS     2
2619 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2620 #define FF_PROFILE_MPEG2_MAIN   4
2621 #define FF_PROFILE_MPEG2_SIMPLE 5
2622
2623 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2624 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2625
2626 #define FF_PROFILE_H264_BASELINE             66
2627 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2628 #define FF_PROFILE_H264_MAIN                 77
2629 #define FF_PROFILE_H264_EXTENDED             88
2630 #define FF_PROFILE_H264_HIGH                 100
2631 #define FF_PROFILE_H264_HIGH_10              110
2632 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2633 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2634 #define FF_PROFILE_H264_HIGH_422             122
2635 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2636 #define FF_PROFILE_H264_STEREO_HIGH          128
2637 #define FF_PROFILE_H264_HIGH_444             144
2638 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2639 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2640 #define FF_PROFILE_H264_CAVLC_444            44
2641
2642 #define FF_PROFILE_VC1_SIMPLE   0
2643 #define FF_PROFILE_VC1_MAIN     1
2644 #define FF_PROFILE_VC1_COMPLEX  2
2645 #define FF_PROFILE_VC1_ADVANCED 3
2646
2647 #define FF_PROFILE_MPEG4_SIMPLE                     0
2648 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2649 #define FF_PROFILE_MPEG4_CORE                       2
2650 #define FF_PROFILE_MPEG4_MAIN                       3
2651 #define FF_PROFILE_MPEG4_N_BIT                      4
2652 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2653 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2654 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2655 #define FF_PROFILE_MPEG4_HYBRID                     8
2656 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2657 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2658 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2659 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2660 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2661 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2662 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2663
2664 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2665 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2666 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2667 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2668 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2669
2670 #define FF_PROFILE_VP9_0                            0
2671 #define FF_PROFILE_VP9_1                            1
2672 #define FF_PROFILE_VP9_2                            2
2673 #define FF_PROFILE_VP9_3                            3
2674
2675 #define FF_PROFILE_HEVC_MAIN                        1
2676 #define FF_PROFILE_HEVC_MAIN_10                     2
2677 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2678 #define FF_PROFILE_HEVC_REXT                        4
2679
2680     /**
2681      * level
2682      * - encoding: Set by user.
2683      * - decoding: Set by libavcodec.
2684      */
2685      int level;
2686 #define FF_LEVEL_UNKNOWN -99
2687
2688     /**
2689      * - encoding: unused
2690      * - decoding: Set by user.
2691      */
2692     enum AVDiscard skip_loop_filter;
2693
2694     /**
2695      * - encoding: unused
2696      * - decoding: Set by user.
2697      */
2698     enum AVDiscard skip_idct;
2699
2700     /**
2701      * - encoding: unused
2702      * - decoding: Set by user.
2703      */
2704     enum AVDiscard skip_frame;
2705
2706     /**
2707      * Header containing style information for text subtitles.
2708      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2709      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2710      * the Format line following. It shouldn't include any Dialogue line.
2711      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2712      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2713      */
2714     uint8_t *subtitle_header;
2715     int subtitle_header_size;
2716
2717 #if FF_API_VBV_DELAY
2718     /**
2719      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2720      * Used for compliant TS muxing.
2721      * - encoding: Set by libavcodec.
2722      * - decoding: unused.
2723      * @deprecated this value is now exported as a part of
2724      * AV_PKT_DATA_CPB_PROPERTIES packet side data
2725      */
2726     attribute_deprecated
2727     uint64_t vbv_delay;
2728 #endif
2729
2730 #if FF_API_SIDEDATA_ONLY_PKT
2731     /**
2732      * Encoding only and set by default. Allow encoders to output packets
2733      * that do not contain any encoded data, only side data.
2734      *
2735      * Some encoders need to output such packets, e.g. to update some stream
2736      * parameters at the end of encoding.
2737      *
2738      * @deprecated this field disables the default behaviour and
2739      *             it is kept only for compatibility.
2740      */
2741     attribute_deprecated
2742     int side_data_only_packets;
2743 #endif
2744
2745     /**
2746      * Audio only. The number of "priming" samples (padding) inserted by the
2747      * encoder at the beginning of the audio. I.e. this number of leading
2748      * decoded samples must be discarded by the caller to get the original audio
2749      * without leading padding.
2750      *
2751      * - decoding: unused
2752      * - encoding: Set by libavcodec. The timestamps on the output packets are
2753      *             adjusted by the encoder so that they always refer to the
2754      *             first sample of the data actually contained in the packet,
2755      *             including any added padding.  E.g. if the timebase is
2756      *             1/samplerate and the timestamp of the first input sample is
2757      *             0, the timestamp of the first output packet will be
2758      *             -initial_padding.
2759      */
2760     int initial_padding;
2761
2762     /*
2763      * - decoding: For codecs that store a framerate value in the compressed
2764      *             bitstream, the decoder may export it here. { 0, 1} when
2765      *             unknown.
2766      * - encoding: May be used to signal the framerate of CFR content to an
2767      *             encoder.
2768      */
2769     AVRational framerate;
2770
2771     /**
2772      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2773      * - encoding: unused.
2774      * - decoding: Set by libavcodec before calling get_format()
2775      */
2776     enum AVPixelFormat sw_pix_fmt;
2777
2778     /**
2779      * Additional data associated with the entire coded stream.
2780      *
2781      * - decoding: unused
2782      * - encoding: may be set by libavcodec after avcodec_open2().
2783      */
2784     AVPacketSideData *coded_side_data;
2785     int            nb_coded_side_data;
2786
2787     /**
2788      * A reference to the AVHWFramesContext describing the input (for encoding)
2789      * or output (decoding) frames. The reference is set by the caller and
2790      * afterwards owned (and freed) by libavcodec - it should never be read by
2791      * the caller after being set.
2792      *
2793      * - decoding: This field should be set by the caller from the get_format()
2794      *             callback. The previous reference (if any) will always be
2795      *             unreffed by libavcodec before the get_format() call.
2796      *
2797      *             If the default get_buffer2() is used with a hwaccel pixel
2798      *             format, then this AVHWFramesContext will be used for
2799      *             allocating the frame buffers.
2800      *
2801      * - encoding: For hardware encoders configured to use a hwaccel pixel
2802      *             format, this field should be set by the caller to a reference
2803      *             to the AVHWFramesContext describing input frames.
2804      *             AVHWFramesContext.format must be equal to
2805      *             AVCodecContext.pix_fmt.
2806      *
2807      *             This field should be set before avcodec_open2() is called.
2808      */
2809     AVBufferRef *hw_frames_ctx;
2810
2811     /**
2812      * Video decoding only. Certain video codecs support cropping, meaning that
2813      * only a sub-rectangle of the decoded frame is intended for display.  This
2814      * option controls how cropping is handled by libavcodec.
2815      *
2816      * When set to 1 (the default), libavcodec will apply cropping internally.
2817      * I.e. it will modify the output frame width/height fields and offset the
2818      * data pointers (only by as much as possible while preserving alignment, or
2819      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
2820      * the frames output by the decoder refer only to the cropped area. The
2821      * crop_* fields of the output frames will be zero.
2822      *
2823      * When set to 0, the width/height fields of the output frames will be set
2824      * to the coded dimensions and the crop_* fields will describe the cropping
2825      * rectangle. Applying the cropping is left to the caller.
2826      *
2827      * @warning When hardware acceleration with opaque output frames is used,
2828      * libavcodec is unable to apply cropping from the top/left border.
2829      *
2830      * @note when this option is set to zero, the width/height fields of the
2831      * AVCodecContext and output AVFrames have different meanings. The codec
2832      * context fields store display dimensions (with the coded dimensions in
2833      * coded_width/height), while the frame fields store the coded dimensions
2834      * (with the display dimensions being determined by the crop_* fields).
2835      */
2836     int apply_cropping;
2837
2838     /**
2839      * A reference to the AVHWDeviceContext describing the device which will
2840      * be used by a hardware encoder/decoder.  The reference is set by the
2841      * caller and afterwards owned (and freed) by libavcodec.
2842      *
2843      * This should be used if either the codec device does not require
2844      * hardware frames or any that are used are to be allocated internally by
2845      * libavcodec.  If the user wishes to supply any of the frames used as
2846      * encoder input or decoder output then hw_frames_ctx should be used
2847      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
2848      * field will be ignored while decoding the associated stream segment, but
2849      * may again be used on a following one after another get_format() call.
2850      *
2851      * For both encoders and decoders this field should be set before
2852      * avcodec_open2() is called and must not be written to thereafter.
2853      *
2854      * Note that some decoders may require this field to be set initially in
2855      * order to support hw_frames_ctx at all - in that case, all frames
2856      * contexts used must be created on the same device.
2857      */
2858     AVBufferRef *hw_device_ctx;
2859
2860     /**
2861      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
2862      * decoding (if active).
2863      * - encoding: unused
2864      * - decoding: Set by user (either before avcodec_open2(), or in the
2865      *             AVCodecContext.get_format callback)
2866      */
2867     int hwaccel_flags;
2868 } AVCodecContext;
2869
2870 /**
2871  * AVProfile.
2872  */
2873 typedef struct AVProfile {
2874     int profile;
2875     const char *name; ///< short name for the profile
2876 } AVProfile;
2877
2878 typedef struct AVCodecDefault AVCodecDefault;
2879
2880 struct AVSubtitle;
2881
2882 /**
2883  * AVCodec.
2884  */
2885 typedef struct AVCodec {
2886     /**
2887      * Name of the codec implementation.
2888      * The name is globally unique among encoders and among decoders (but an
2889      * encoder and a decoder can share the same name).
2890      * This is the primary way to find a codec from the user perspective.
2891      */
2892     const char *name;
2893     /**
2894      * Descriptive name for the codec, meant to be more human readable than name.
2895      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2896      */
2897     const char *long_name;
2898     enum AVMediaType type;
2899     enum AVCodecID id;
2900     /**
2901      * Codec capabilities.
2902      * see AV_CODEC_CAP_*
2903      */
2904     int capabilities;
2905     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2906     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2907     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2908     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2909     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2910     const AVClass *priv_class;              ///< AVClass for the private context
2911     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2912
2913     /*****************************************************************
2914      * No fields below this line are part of the public API. They
2915      * may not be used outside of libavcodec and can be changed and
2916      * removed at will.
2917      * New public fields should be added right above.
2918      *****************************************************************
2919      */
2920     int priv_data_size;
2921     struct AVCodec *next;
2922     /**
2923      * @name Frame-level threading support functions
2924      * @{
2925      */
2926     /**
2927      * If defined, called on thread contexts when they are created.
2928      * If the codec allocates writable tables in init(), re-allocate them here.
2929      * priv_data will be set to a copy of the original.
2930      */
2931     int (*init_thread_copy)(AVCodecContext *);
2932     /**
2933      * Copy necessary context variables from a previous thread context to the current one.
2934      * If not defined, the next thread will start automatically; otherwise, the codec
2935      * must call ff_thread_finish_setup().
2936      *
2937      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2938      */
2939     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2940     /** @} */
2941
2942     /**
2943      * Private codec-specific defaults.
2944      */
2945     const AVCodecDefault *defaults;
2946
2947     /**
2948      * Initialize codec static data, called from avcodec_register().
2949      */
2950     void (*init_static_data)(struct AVCodec *codec);
2951
2952     int (*init)(AVCodecContext *);
2953     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2954                       const struct AVSubtitle *sub);
2955     /**
2956      * Encode data to an AVPacket.
2957      *
2958      * @param      avctx          codec context
2959      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2960      * @param[in]  frame          AVFrame containing the raw data to be encoded
2961      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2962      *                            non-empty packet was returned in avpkt.
2963      * @return 0 on success, negative error code on failure
2964      */
2965     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2966                    int *got_packet_ptr);
2967     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2968     int (*close)(AVCodecContext *);
2969     /**
2970      * Encode API with decoupled packet/frame dataflow. The API is the
2971      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
2972      * that:
2973      * - never called if the codec is closed or the wrong type,
2974      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
2975      * - only one drain frame is ever passed down,
2976      */
2977     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
2978     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
2979
2980     /**
2981      * Decode API with decoupled packet/frame dataflow. This function is called
2982      * to get one output frame. It should call ff_decode_get_packet() to obtain
2983      * input data.
2984      */
2985     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
2986     /**
2987      * Flush buffers.
2988      * Will be called when seeking
2989      */
2990     void (*flush)(AVCodecContext *);
2991     /**
2992      * Internal codec capabilities.
2993      * See FF_CODEC_CAP_* in internal.h
2994      */
2995     int caps_internal;
2996
2997     /**
2998      * Decoding only, a comma-separated list of bitstream filters to apply to
2999      * packets before decoding.
3000      */
3001     const char *bsfs;
3002 } AVCodec;
3003
3004 /**
3005  * @defgroup lavc_hwaccel AVHWAccel
3006  * @{
3007  */
3008 typedef struct AVHWAccel {
3009     /**
3010      * Name of the hardware accelerated codec.
3011      * The name is globally unique among encoders and among decoders (but an
3012      * encoder and a decoder can share the same name).
3013      */
3014     const char *name;
3015
3016     /**
3017      * Type of codec implemented by the hardware accelerator.
3018      *
3019      * See AVMEDIA_TYPE_xxx
3020      */
3021     enum AVMediaType type;
3022
3023     /**
3024      * Codec implemented by the hardware accelerator.
3025      *
3026      * See AV_CODEC_ID_xxx
3027      */
3028     enum AVCodecID id;
3029
3030     /**
3031      * Supported pixel format.
3032      *
3033      * Only hardware accelerated formats are supported here.
3034      */
3035     enum AVPixelFormat pix_fmt;
3036
3037     /**
3038      * Hardware accelerated codec capabilities.
3039      * see FF_HWACCEL_CODEC_CAP_*
3040      */
3041     int capabilities;
3042
3043     /*****************************************************************
3044      * No fields below this line are part of the public API. They
3045      * may not be used outside of libavcodec and can be changed and
3046      * removed at will.
3047      * New public fields should be added right above.
3048      *****************************************************************
3049      */
3050     struct AVHWAccel *next;
3051
3052     /**
3053      * Allocate a custom buffer
3054      */
3055     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3056
3057     /**
3058      * Called at the beginning of each frame or field picture.
3059      *
3060      * Meaningful frame information (codec specific) is guaranteed to
3061      * be parsed at this point. This function is mandatory.
3062      *
3063      * Note that buf can be NULL along with buf_size set to 0.
3064      * Otherwise, this means the whole frame is available at this point.
3065      *
3066      * @param avctx the codec context
3067      * @param buf the frame data buffer base
3068      * @param buf_size the size of the frame in bytes
3069      * @return zero if successful, a negative value otherwise
3070      */
3071     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3072
3073     /**
3074      * Callback for each slice.
3075      *
3076      * Meaningful slice information (codec specific) is guaranteed to
3077      * be parsed at this point. This function is mandatory.
3078      *
3079      * @param avctx the codec context
3080      * @param buf the slice data buffer base
3081      * @param buf_size the size of the slice in bytes
3082      * @return zero if successful, a negative value otherwise
3083      */
3084     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3085
3086     /**
3087      * Called at the end of each frame or field picture.
3088      *
3089      * The whole picture is parsed at this point and can now be sent
3090      * to the hardware accelerator. This function is mandatory.
3091      *
3092      * @param avctx the codec context
3093      * @return zero if successful, a negative value otherwise
3094      */
3095     int (*end_frame)(AVCodecContext *avctx);
3096
3097     /**
3098      * Size of per-frame hardware accelerator private data.
3099      *
3100      * Private data is allocated with av_mallocz() before
3101      * AVCodecContext.get_buffer() and deallocated after
3102      * AVCodecContext.release_buffer().
3103      */
3104     int frame_priv_data_size;
3105
3106     /**
3107      * Initialize the hwaccel private data.
3108      *
3109      * This will be called from ff_get_format(), after hwaccel and
3110      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3111      * is allocated.
3112      */
3113     int (*init)(AVCodecContext *avctx);
3114
3115     /**
3116      * Uninitialize the hwaccel private data.
3117      *
3118      * This will be called from get_format() or avcodec_close(), after hwaccel
3119      * and hwaccel_context are already uninitialized.
3120      */
3121     int (*uninit)(AVCodecContext *avctx);
3122
3123     /**
3124      * Size of the private data to allocate in
3125      * AVCodecInternal.hwaccel_priv_data.
3126      */
3127     int priv_data_size;
3128
3129     /**
3130      * Internal hwaccel capabilities.
3131      */
3132     int caps_internal;
3133 } AVHWAccel;
3134
3135 /**
3136  * Hardware acceleration should be used for decoding even if the codec level
3137  * used is unknown or higher than the maximum supported level reported by the
3138  * hardware driver.
3139  */
3140 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3141
3142 /**
3143  * Hardware acceleration can output YUV pixel formats with a different chroma
3144  * sampling than 4:2:0 and/or other than 8 bits per component.
3145  */
3146 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3147
3148 /**
3149  * @}
3150  */
3151
3152 #if FF_API_AVPICTURE
3153 /**
3154  * @defgroup lavc_picture AVPicture
3155  *
3156  * Functions for working with AVPicture
3157  * @{
3158  */
3159
3160 /**
3161  * four components are given, that's all.
3162  * the last component is alpha
3163  * @deprecated Use the imgutils functions
3164  */
3165 typedef struct AVPicture {
3166     attribute_deprecated
3167     uint8_t *data[AV_NUM_DATA_POINTERS];
3168     attribute_deprecated
3169     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3170 } AVPicture;
3171
3172 /**
3173  * @}
3174  */
3175 #endif
3176
3177 #define AVPALETTE_SIZE 1024
3178 #define AVPALETTE_COUNT 256
3179
3180 enum AVSubtitleType {
3181     SUBTITLE_NONE,
3182
3183     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3184
3185     /**
3186      * Plain text, the text field must be set by the decoder and is
3187      * authoritative. ass and pict fields may contain approximations.
3188      */
3189     SUBTITLE_TEXT,
3190
3191     /**
3192      * Formatted text, the ass field must be set by the decoder and is
3193      * authoritative. pict and text fields may contain approximations.
3194      */
3195     SUBTITLE_ASS,
3196 };
3197
3198 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3199
3200 typedef struct AVSubtitleRect {
3201     int x;         ///< top left corner  of pict, undefined when pict is not set
3202     int y;         ///< top left corner  of pict, undefined when pict is not set
3203     int w;         ///< width            of pict, undefined when pict is not set
3204     int h;         ///< height           of pict, undefined when pict is not set
3205     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3206
3207 #if FF_API_AVPICTURE
3208     /**
3209      * @deprecated unused
3210      */
3211     attribute_deprecated
3212     AVPicture pict;
3213 #endif
3214     /**
3215      * data+linesize for the bitmap of this subtitle.
3216      * Can be set for text/ass as well once they are rendered.
3217      */
3218     uint8_t *data[4];
3219     int linesize[4];
3220
3221     enum AVSubtitleType type;
3222
3223     char *text;                     ///< 0 terminated plain UTF-8 text
3224
3225     /**
3226      * 0 terminated ASS/SSA compatible event line.
3227      * The presentation of this is unaffected by the other values in this
3228      * struct.
3229      */
3230     char *ass;
3231     int flags;
3232 } AVSubtitleRect;
3233
3234 typedef struct AVSubtitle {
3235     uint16_t format; /* 0 = graphics */
3236     uint32_t start_display_time; /* relative to packet pts, in ms */
3237     uint32_t end_display_time; /* relative to packet pts, in ms */
3238     unsigned num_rects;
3239     AVSubtitleRect **rects;
3240     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3241 } AVSubtitle;
3242
3243 /**
3244  * This struct describes the properties of an encoded stream.
3245  *
3246  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3247  * be allocated with avcodec_parameters_alloc() and freed with
3248  * avcodec_parameters_free().
3249  */
3250 typedef struct AVCodecParameters {
3251     /**
3252      * General type of the encoded data.
3253      */
3254     enum AVMediaType codec_type;
3255     /**
3256      * Specific type of the encoded data (the codec used).
3257      */
3258     enum AVCodecID   codec_id;
3259     /**
3260      * Additional information about the codec (corresponds to the AVI FOURCC).
3261      */
3262     uint32_t         codec_tag;
3263
3264     /**
3265      * Extra binary data needed for initializing the decoder, codec-dependent.
3266      *
3267      * Must be allocated with av_malloc() and will be freed by
3268      * avcodec_parameters_free(). The allocated size of extradata must be at
3269      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3270      * bytes zeroed.
3271      */
3272     uint8_t *extradata;
3273     /**
3274      * Size of the extradata content in bytes.
3275      */
3276     int      extradata_size;
3277
3278     /**
3279      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3280      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3281      */
3282     int format;
3283
3284     /**
3285      * The average bitrate of the encoded data (in bits per second).
3286      */
3287     int bit_rate;
3288
3289     int bits_per_coded_sample;
3290
3291     /**
3292      * Codec-specific bitstream restrictions that the stream conforms to.
3293      */
3294     int profile;
3295     int level;
3296
3297     /**
3298      * Video only. The dimensions of the video frame in pixels.
3299      */
3300     int width;
3301     int height;
3302
3303     /**
3304      * Video only. The aspect ratio (width / height) which a single pixel
3305      * should have when displayed.
3306      *
3307      * When the aspect ratio is unknown / undefined, the numerator should be
3308      * set to 0 (the denominator may have any value).
3309      */
3310     AVRational sample_aspect_ratio;
3311
3312     /**
3313      * Video only. The order of the fields in interlaced video.
3314      */
3315     enum AVFieldOrder                  field_order;
3316
3317     /**
3318      * Video only. Additional colorspace characteristics.
3319      */
3320     enum AVColorRange                  color_range;
3321     enum AVColorPrimaries              color_primaries;
3322     enum AVColorTransferCharacteristic color_trc;
3323     enum AVColorSpace                  color_space;
3324     enum AVChromaLocation              chroma_location;
3325
3326     /**
3327      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3328      * unknown or unspecified, otherwise the number of bits set must be equal to
3329      * the channels field.
3330      */
3331     uint64_t channel_layout;
3332     /**
3333      * Audio only. The number of audio channels.
3334      */
3335     int      channels;
3336     /**
3337      * Audio only. The number of audio samples per second.
3338      */
3339     int      sample_rate;
3340     /**
3341      * Audio only. The number of bytes per coded audio frame, required by some
3342      * formats.
3343      *
3344      * Corresponds to nBlockAlign in WAVEFORMATEX.
3345      */
3346     int      block_align;
3347
3348     /**
3349      * Audio only. The amount of padding (in samples) inserted by the encoder at
3350      * the beginning of the audio. I.e. this number of leading decoded samples
3351      * must be discarded by the caller to get the original audio without leading
3352      * padding.
3353      */
3354     int initial_padding;
3355     /**
3356      * Audio only. The amount of padding (in samples) appended by the encoder to
3357      * the end of the audio. I.e. this number of decoded samples must be
3358      * discarded by the caller from the end of the stream to get the original
3359      * audio without any trailing padding.
3360      */
3361     int trailing_padding;
3362 } AVCodecParameters;
3363
3364 /**
3365  * If c is NULL, returns the first registered codec,
3366  * if c is non-NULL, returns the next registered codec after c,
3367  * or NULL if c is the last one.
3368  */
3369 AVCodec *av_codec_next(const AVCodec *c);
3370
3371 /**
3372  * Return the LIBAVCODEC_VERSION_INT constant.
3373  */
3374 unsigned avcodec_version(void);
3375
3376 /**
3377  * Return the libavcodec build-time configuration.
3378  */
3379 const char *avcodec_configuration(void);
3380
3381 /**
3382  * Return the libavcodec license.
3383  */
3384 const char *avcodec_license(void);
3385
3386 /**
3387  * Register the codec codec and initialize libavcodec.
3388  *
3389  * @warning either this function or avcodec_register_all() must be called
3390  * before any other libavcodec functions.
3391  *
3392  * @see avcodec_register_all()
3393  */
3394 void avcodec_register(AVCodec *codec);
3395
3396 /**
3397  * Register all the codecs, parsers and bitstream filters which were enabled at
3398  * configuration time. If you do not call this function you can select exactly
3399  * which formats you want to support, by using the individual registration
3400  * functions.
3401  *
3402  * @see avcodec_register
3403  * @see av_register_codec_parser
3404  * @see av_register_bitstream_filter
3405  */
3406 void avcodec_register_all(void);
3407
3408 /**
3409  * Allocate an AVCodecContext and set its fields to default values. The
3410  * resulting struct should be freed with avcodec_free_context().
3411  *
3412  * @param codec if non-NULL, allocate private data and initialize defaults
3413  *              for the given codec. It is illegal to then call avcodec_open2()
3414  *              with a different codec.
3415  *              If NULL, then the codec-specific defaults won't be initialized,
3416  *              which may result in suboptimal default settings (this is
3417  *              important mainly for encoders, e.g. libx264).
3418  *
3419  * @return An AVCodecContext filled with default values or NULL on failure.
3420  */
3421 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3422
3423 /**
3424  * Free the codec context and everything associated with it and write NULL to
3425  * the provided pointer.
3426  */
3427 void avcodec_free_context(AVCodecContext **avctx);
3428
3429 #if FF_API_GET_CONTEXT_DEFAULTS
3430 /**
3431  * @deprecated This function should not be used, as closing and opening a codec
3432  * context multiple time is not supported. A new codec context should be
3433  * allocated for each new use.
3434  */
3435 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3436 #endif
3437
3438 /**
3439  * Get the AVClass for AVCodecContext. It can be used in combination with
3440  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3441  *
3442  * @see av_opt_find().
3443  */
3444 const AVClass *avcodec_get_class(void);
3445
3446 #if FF_API_COPY_CONTEXT
3447 /**
3448  * Copy the settings of the source AVCodecContext into the destination
3449  * AVCodecContext. The resulting destination codec context will be
3450  * unopened, i.e. you are required to call avcodec_open2() before you
3451  * can use this AVCodecContext to decode/encode video/audio data.
3452  *
3453  * @param dest target codec context, should be initialized with
3454  *             avcodec_alloc_context3(), but otherwise uninitialized
3455  * @param src source codec context
3456  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3457  *
3458  * @deprecated The semantics of this function are ill-defined and it should not
3459  * be used. If you need to transfer the stream parameters from one codec context
3460  * to another, use an intermediate AVCodecParameters instance and the
3461  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3462  * functions.
3463  */
3464 attribute_deprecated
3465 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3466 #endif
3467
3468 /**
3469  * Allocate a new AVCodecParameters and set its fields to default values
3470  * (unknown/invalid/0). The returned struct must be freed with
3471  * avcodec_parameters_free().
3472  */
3473 AVCodecParameters *avcodec_parameters_alloc(void);
3474
3475 /**
3476  * Free an AVCodecParameters instance and everything associated with it and
3477  * write NULL to the supplied pointer.
3478  */
3479 void avcodec_parameters_free(AVCodecParameters **par);
3480
3481 /**
3482  * Copy the contents of src to dst. Any allocated fields in dst are freed and
3483  * replaced with newly allocated duplicates of the corresponding fields in src.
3484  *
3485  * @return >= 0 on success, a negative AVERROR code on failure.
3486  */
3487 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3488
3489 /**
3490  * Fill the parameters struct based on the values from the supplied codec
3491  * context. Any allocated fields in par are freed and replaced with duplicates
3492  * of the corresponding fields in codec.
3493  *
3494  * @return >= 0 on success, a negative AVERROR code on failure
3495  */
3496 int avcodec_parameters_from_context(AVCodecParameters *par,
3497                                     const AVCodecContext *codec);
3498
3499 /**
3500  * Fill the codec context based on the values from the supplied codec
3501  * parameters. Any allocated fields in codec that have a corresponding field in
3502  * par are freed and replaced with duplicates of the corresponding field in par.
3503  * Fields in codec that do not have a counterpart in par are not touched.
3504  *
3505  * @return >= 0 on success, a negative AVERROR code on failure.
3506  */
3507 int avcodec_parameters_to_context(AVCodecContext *codec,
3508                                   const AVCodecParameters *par);
3509
3510 /**
3511  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3512  * function the context has to be allocated with avcodec_alloc_context3().
3513  *
3514  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3515  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3516  * retrieving a codec.
3517  *
3518  * @warning This function is not thread safe!
3519  *
3520  * @note Always call this function before using decoding routines (such as
3521  * @ref avcodec_receive_frame()).
3522  *
3523  * @code
3524  * avcodec_register_all();
3525  * av_dict_set(&opts, "b", "2.5M", 0);
3526  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3527  * if (!codec)
3528  *     exit(1);
3529  *
3530  * context = avcodec_alloc_context3(codec);
3531  *
3532  * if (avcodec_open2(context, codec, opts) < 0)
3533  *     exit(1);
3534  * @endcode
3535  *
3536  * @param avctx The context to initialize.
3537  * @param codec The codec to open this context for. If a non-NULL codec has been
3538  *              previously passed to avcodec_alloc_context3() or
3539  *              for this context, then this parameter MUST be either NULL or
3540  *              equal to the previously passed codec.
3541  * @param options A dictionary filled with AVCodecContext and codec-private options.
3542  *                On return this object will be filled with options that were not found.
3543  *
3544  * @return zero on success, a negative value on error
3545  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3546  *      av_dict_set(), av_opt_find().
3547  */
3548 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3549
3550 /**
3551  * Close a given AVCodecContext and free all the data associated with it
3552  * (but not the AVCodecContext itself).
3553  *
3554  * Calling this function on an AVCodecContext that hasn't been opened will free
3555  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3556  * codec. Subsequent calls will do nothing.
3557  *
3558  * @note Do not use this function. Use avcodec_free_context() to destroy a
3559  * codec context (either open or closed). Opening and closing a codec context
3560  * multiple times is not supported anymore -- use multiple codec contexts
3561  * instead.
3562  */
3563 int avcodec_close(AVCodecContext *avctx);
3564
3565 /**
3566  * Free all allocated data in the given subtitle struct.
3567  *
3568  * @param sub AVSubtitle to free.
3569  */
3570 void avsubtitle_free(AVSubtitle *sub);
3571
3572 /**
3573  * @}
3574  */
3575
3576 /**
3577  * @addtogroup lavc_packet
3578  * @{
3579  */
3580
3581 /**
3582  * Allocate an AVPacket and set its fields to default values.  The resulting
3583  * struct must be freed using av_packet_free().
3584  *
3585  * @return An AVPacket filled with default values or NULL on failure.
3586  *
3587  * @note this only allocates the AVPacket itself, not the data buffers. Those
3588  * must be allocated through other means such as av_new_packet.
3589  *
3590  * @see av_new_packet
3591  */
3592 AVPacket *av_packet_alloc(void);
3593
3594 /**
3595  * Create a new packet that references the same data as src.
3596  *
3597  * This is a shortcut for av_packet_alloc()+av_packet_ref().
3598  *
3599  * @return newly created AVPacket on success, NULL on error.
3600  *
3601  * @see av_packet_alloc
3602  * @see av_packet_ref
3603  */
3604 AVPacket *av_packet_clone(const AVPacket *src);
3605
3606 /**
3607  * Free the packet, if the packet is reference counted, it will be
3608  * unreferenced first.
3609  *
3610  * @param pkt packet to be freed. The pointer will be set to NULL.
3611  * @note passing NULL is a no-op.
3612  */
3613 void av_packet_free(AVPacket **pkt);
3614
3615 /**
3616  * Initialize optional fields of a packet with default values.
3617  *
3618  * Note, this does not touch the data and size members, which have to be
3619  * initialized separately.
3620  *
3621  * @param pkt packet
3622  */
3623 void av_init_packet(AVPacket *pkt);
3624
3625 /**
3626  * Allocate the payload of a packet and initialize its fields with
3627  * default values.
3628  *
3629  * @param pkt packet
3630  * @param size wanted payload size
3631  * @return 0 if OK, AVERROR_xxx otherwise
3632  */
3633 int av_new_packet(AVPacket *pkt, int size);
3634
3635 /**
3636  * Reduce packet size, correctly zeroing padding
3637  *
3638  * @param pkt packet
3639  * @param size new size
3640  */
3641 void av_shrink_packet(AVPacket *pkt, int size);
3642
3643 /**
3644  * Increase packet size, correctly zeroing padding
3645  *
3646  * @param pkt packet
3647  * @param grow_by number of bytes by which to increase the size of the packet
3648  */
3649 int av_grow_packet(AVPacket *pkt, int grow_by);
3650
3651 /**
3652  * Initialize a reference-counted packet from av_malloc()ed data.
3653  *
3654  * @param pkt packet to be initialized. This function will set the data, size,
3655  *        buf and destruct fields, all others are left untouched.
3656  * @param data Data allocated by av_malloc() to be used as packet data. If this
3657  *        function returns successfully, the data is owned by the underlying AVBuffer.
3658  *        The caller may not access the data through other means.
3659  * @param size size of data in bytes, without the padding. I.e. the full buffer
3660  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3661  *
3662  * @return 0 on success, a negative AVERROR on error
3663  */
3664 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3665
3666 #if FF_API_AVPACKET_OLD_API
3667 /**
3668  * @warning This is a hack - the packet memory allocation stuff is broken. The
3669  * packet is allocated if it was not really allocated.
3670  *
3671  * @deprecated Use av_packet_ref
3672  */
3673 attribute_deprecated
3674 int av_dup_packet(AVPacket *pkt);
3675 /**
3676  * Free a packet.
3677  *
3678  * @deprecated Use av_packet_unref
3679  *
3680  * @param pkt packet to free
3681  */
3682 attribute_deprecated
3683 void av_free_packet(AVPacket *pkt);
3684 #endif
3685 /**
3686  * Allocate new information of a packet.
3687  *
3688  * @param pkt packet
3689  * @param type side information type
3690  * @param size side information size
3691  * @return pointer to fresh allocated data or NULL otherwise
3692  */
3693 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3694                                  int size);
3695
3696 /**
3697  * Wrap an existing array as a packet side data.
3698  *
3699  * @param pkt packet
3700  * @param type side information type
3701  * @param data the side data array. It must be allocated with the av_malloc()
3702  *             family of functions. The ownership of the data is transferred to
3703  *             pkt.
3704  * @param size side information size
3705  * @return a non-negative number on success, a negative AVERROR code on
3706  *         failure. On failure, the packet is unchanged and the data remains
3707  *         owned by the caller.
3708  */
3709 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3710                             uint8_t *data, size_t size);
3711
3712 /**
3713  * Shrink the already allocated side data buffer
3714  *
3715  * @param pkt packet
3716  * @param type side information type
3717  * @param size new side information size
3718  * @return 0 on success, < 0 on failure
3719  */
3720 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3721                                int size);
3722
3723 /**
3724  * Get side information from packet.
3725  *
3726  * @param pkt packet
3727  * @param type desired side information type
3728  * @param size pointer for side information size to store (optional)
3729  * @return pointer to data if present or NULL otherwise
3730  */
3731 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3732                                  int *size);
3733
3734 /**
3735  * Convenience function to free all the side data stored.
3736  * All the other fields stay untouched.
3737  *
3738  * @param pkt packet
3739  */
3740 void av_packet_free_side_data(AVPacket *pkt);
3741
3742 /**
3743  * Setup a new reference to the data described by a given packet
3744  *
3745  * If src is reference-counted, setup dst as a new reference to the
3746  * buffer in src. Otherwise allocate a new buffer in dst and copy the
3747  * data from src into it.
3748  *
3749  * All the other fields are copied from src.
3750  *
3751  * @see av_packet_unref
3752  *
3753  * @param dst Destination packet
3754  * @param src Source packet
3755  *
3756  * @return 0 on success, a negative AVERROR on error.
3757  */
3758 int av_packet_ref(AVPacket *dst, const AVPacket *src);
3759
3760 /**
3761  * Wipe the packet.
3762  *
3763  * Unreference the buffer referenced by the packet and reset the
3764  * remaining packet fields to their default values.
3765  *
3766  * @param pkt The packet to be unreferenced.
3767  */
3768 void av_packet_unref(AVPacket *pkt);
3769
3770 /**
3771  * Move every field in src to dst and reset src.
3772  *
3773  * @see av_packet_unref
3774  *
3775  * @param src Source packet, will be reset
3776  * @param dst Destination packet
3777  */
3778 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3779
3780 /**
3781  * Copy only "properties" fields from src to dst.
3782  *
3783  * Properties for the purpose of this function are all the fields
3784  * beside those related to the packet data (buf, data, size)
3785  *
3786  * @param dst Destination packet
3787  * @param src Source packet
3788  *
3789  * @return 0 on success AVERROR on failure.
3790  */
3791 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3792
3793 /**
3794  * Convert valid timing fields (timestamps / durations) in a packet from one
3795  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3796  * ignored.
3797  *
3798  * @param pkt packet on which the conversion will be performed
3799  * @param tb_src source timebase, in which the timing fields in pkt are
3800  *               expressed
3801  * @param tb_dst destination timebase, to which the timing fields will be
3802  *               converted
3803  */
3804 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3805
3806 /**
3807  * @}
3808  */
3809
3810 /**
3811  * @addtogroup lavc_decoding
3812  * @{
3813  */
3814
3815 /**
3816  * Find a registered decoder with a matching codec ID.
3817  *
3818  * @param id AVCodecID of the requested decoder
3819  * @return A decoder if one was found, NULL otherwise.
3820  */
3821 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3822
3823 /**
3824  * Find a registered decoder with the specified name.
3825  *
3826  * @param name name of the requested decoder
3827  * @return A decoder if one was found, NULL otherwise.
3828  */
3829 AVCodec *avcodec_find_decoder_by_name(const char *name);
3830
3831 /**
3832  * The default callback for AVCodecContext.get_buffer2(). It is made public so
3833  * it can be called by custom get_buffer2() implementations for decoders without
3834  * AV_CODEC_CAP_DR1 set.
3835  */
3836 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3837
3838 /**
3839  * Modify width and height values so that they will result in a memory
3840  * buffer that is acceptable for the codec if you do not use any horizontal
3841  * padding.
3842  *
3843  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3844  */
3845 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3846
3847 /**
3848  * Modify width and height values so that they will result in a memory
3849  * buffer that is acceptable for the codec if you also ensure that all
3850  * line sizes are a multiple of the respective linesize_align[i].
3851  *
3852  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
3853  */
3854 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3855                                int linesize_align[AV_NUM_DATA_POINTERS]);
3856
3857 /**
3858  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3859  *
3860  * Some decoders may support multiple frames in a single AVPacket. Such
3861  * decoders would then just decode the first frame and the return value would be
3862  * less than the packet size. In this case, avcodec_decode_audio4 has to be
3863  * called again with an AVPacket containing the remaining data in order to
3864  * decode the second frame, etc...  Even if no frames are returned, the packet
3865  * needs to be fed to the decoder with remaining data until it is completely
3866  * consumed or an error occurs.
3867  *
3868  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
3869  * and output. This means that for some packets they will not immediately
3870  * produce decoded output and need to be flushed at the end of decoding to get
3871  * all the decoded data. Flushing is done by calling this function with packets
3872  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3873  * returning samples. It is safe to flush even those decoders that are not
3874  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
3875  *
3876  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3877  *          larger than the actual read bytes because some optimized bitstream
3878  *          readers read 32 or 64 bits at once and could read over the end.
3879  *
3880  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3881  * before packets may be fed to the decoder.
3882  *
3883  * @param      avctx the codec context
3884  * @param[out] frame The AVFrame in which to store decoded audio samples.
3885  *                   The decoder will allocate a buffer for the decoded frame by
3886  *                   calling the AVCodecContext.get_buffer2() callback.
3887  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
3888  *                   reference counted and the returned reference belongs to the
3889  *                   caller. The caller must release the frame using av_frame_unref()
3890  *                   when the frame is no longer needed. The caller may safely write
3891  *                   to the frame if av_frame_is_writable() returns 1.
3892  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
3893  *                   reference belongs to the decoder and is valid only until the
3894  *                   next call to this function or until closing or flushing the
3895  *                   decoder. The caller may not write to it.
3896  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3897  *                           non-zero. Note that this field being set to zero
3898  *                           does not mean that an error has occurred. For
3899  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
3900  *                           call is guaranteed to produce a frame.
3901  * @param[in]  avpkt The input AVPacket containing the input buffer.
3902  *                   At least avpkt->data and avpkt->size should be set. Some
3903  *                   decoders might also require additional fields to be set.
3904  * @return A negative error code is returned if an error occurred during
3905  *         decoding, otherwise the number of bytes consumed from the input
3906  *         AVPacket is returned.
3907  *
3908 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3909  */
3910 attribute_deprecated
3911 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3912                           int *got_frame_ptr, AVPacket *avpkt);
3913
3914 /**
3915  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3916  * Some decoders may support multiple frames in a single AVPacket, such
3917  * decoders would then just decode the first frame.
3918  *
3919  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
3920  * the actual read bytes because some optimized bitstream readers read 32 or 64
3921  * bits at once and could read over the end.
3922  *
3923  * @warning The end of the input buffer buf should be set to 0 to ensure that
3924  * no overreading happens for damaged MPEG streams.
3925  *
3926  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
3927  * between input and output, these need to be fed with avpkt->data=NULL,
3928  * avpkt->size=0 at the end to return the remaining frames.
3929  *
3930  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3931  * before packets may be fed to the decoder.
3932  *
3933  * @param avctx the codec context
3934  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3935  *             Use av_frame_alloc() to get an AVFrame. The codec will
3936  *             allocate memory for the actual bitmap by calling the
3937  *             AVCodecContext.get_buffer2() callback.
3938  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
3939  *             reference counted and the returned reference belongs to the
3940  *             caller. The caller must release the frame using av_frame_unref()
3941  *             when the frame is no longer needed. The caller may safely write
3942  *             to the frame if av_frame_is_writable() returns 1.
3943  *             When AVCodecContext.refcounted_frames is set to 0, the returned
3944  *             reference belongs to the decoder and is valid only until the
3945  *             next call to this function or until closing or flushing the
3946  *             decoder. The caller may not write to it.
3947  *
3948  * @param[in] avpkt The input AVPacket containing the input buffer.
3949  *            You can create such packet with av_init_packet() and by then setting
3950  *            data and size, some decoders might in addition need other fields like
3951  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3952  *            fields possible.
3953  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3954  * @return On error a negative value is returned, otherwise the number of bytes
3955  * used or zero if no frame could be decompressed.
3956  *
3957  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
3958  */
3959 attribute_deprecated
3960 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3961                          int *got_picture_ptr,
3962                          AVPacket *avpkt);
3963
3964 /**
3965  * Decode a subtitle message.
3966  * Return a negative value on error, otherwise return the number of bytes used.
3967  * If no subtitle could be decompressed, got_sub_ptr is zero.
3968  * Otherwise, the subtitle is stored in *sub.
3969  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3970  * simplicity, because the performance difference is expect to be negligible
3971  * and reusing a get_buffer written for video codecs would probably perform badly
3972  * due to a potentially very different allocation pattern.
3973  *
3974  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3975  * before packets may be fed to the decoder.
3976  *
3977  * @param avctx the codec context
3978  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3979                    freed with avsubtitle_free if *got_sub_ptr is set.
3980  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3981  * @param[in] avpkt The input AVPacket containing the input buffer.
3982  */
3983 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3984                             int *got_sub_ptr,
3985                             AVPacket *avpkt);
3986
3987 /**
3988  * Supply raw packet data as input to a decoder.
3989  *
3990  * Internally, this call will copy relevant AVCodecContext fields, which can
3991  * influence decoding per-packet, and apply them when the packet is actually
3992  * decoded. (For example AVCodecContext.skip_frame, which might direct the
3993  * decoder to drop the frame contained by the packet sent with this function.)
3994  *
3995  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
3996  *          larger than the actual read bytes because some optimized bitstream
3997  *          readers read 32 or 64 bits at once and could read over the end.
3998  *
3999  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4000  *          on the same AVCodecContext. It will return unexpected results now
4001  *          or in future libavcodec versions.
4002  *
4003  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4004  *       before packets may be fed to the decoder.
4005  *
4006  * @param avctx codec context
4007  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4008  *                  frame, or several complete audio frames.
4009  *                  Ownership of the packet remains with the caller, and the
4010  *                  decoder will not write to the packet. The decoder may create
4011  *                  a reference to the packet data (or copy it if the packet is
4012  *                  not reference-counted).
4013  *                  Unlike with older APIs, the packet is always fully consumed,
4014  *                  and if it contains multiple frames (e.g. some audio codecs),
4015  *                  will require you to call avcodec_receive_frame() multiple
4016  *                  times afterwards before you can send a new packet.
4017  *                  It can be NULL (or an AVPacket with data set to NULL and
4018  *                  size set to 0); in this case, it is considered a flush
4019  *                  packet, which signals the end of the stream. Sending the
4020  *                  first flush packet will return success. Subsequent ones are
4021  *                  unnecessary and will return AVERROR_EOF. If the decoder
4022  *                  still has frames buffered, it will return them after sending
4023  *                  a flush packet.
4024  *
4025  * @return 0 on success, otherwise negative error code:
4026  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
4027  *                         must read output with avcodec_receive_frame() (once
4028  *                         all output is read, the packet should be resent, and
4029  *                         the call will not fail with EAGAIN).
4030  *      AVERROR_EOF:       the decoder has been flushed, and no new packets can
4031  *                         be sent to it (also returned if more than 1 flush
4032  *                         packet is sent)
4033  *      AVERROR(EINVAL):   codec not opened, it is an encoder, or requires flush
4034  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4035  *      other errors: legitimate decoding errors
4036  */
4037 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4038
4039 /**
4040  * Return decoded output data from a decoder.
4041  *
4042  * @param avctx codec context
4043  * @param frame This will be set to a reference-counted video or audio
4044  *              frame (depending on the decoder type) allocated by the
4045  *              decoder. Note that the function will always call
4046  *              av_frame_unref(frame) before doing anything else.
4047  *
4048  * @return
4049  *      0:                 success, a frame was returned
4050  *      AVERROR(EAGAIN):   output is not available in this state - user must try
4051  *                         to send new input
4052  *      AVERROR_EOF:       the decoder has been fully flushed, and there will be
4053  *                         no more output frames
4054  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4055  *      other negative values: legitimate decoding errors
4056  */
4057 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4058
4059 /**
4060  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4061  * to retrieve buffered output packets.
4062  *
4063  * @param avctx     codec context
4064  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4065  *                  Ownership of the frame remains with the caller, and the
4066  *                  encoder will not write to the frame. The encoder may create
4067  *                  a reference to the frame data (or copy it if the frame is
4068  *                  not reference-counted).
4069  *                  It can be NULL, in which case it is considered a flush
4070  *                  packet.  This signals the end of the stream. If the encoder
4071  *                  still has packets buffered, it will return them after this
4072  *                  call. Once flushing mode has been entered, additional flush
4073  *                  packets are ignored, and sending frames will return
4074  *                  AVERROR_EOF.
4075  *
4076  *                  For audio:
4077  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4078  *                  can have any number of samples.
4079  *                  If it is not set, frame->nb_samples must be equal to
4080  *                  avctx->frame_size for all frames except the last.
4081  *                  The final frame may be smaller than avctx->frame_size.
4082  * @return 0 on success, otherwise negative error code:
4083  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
4084  *                         must read output with avcodec_receive_packet() (once
4085  *                         all output is read, the packet should be resent, and
4086  *                         the call will not fail with EAGAIN).
4087  *      AVERROR_EOF:       the encoder has been flushed, and no new frames can
4088  *                         be sent to it
4089  *      AVERROR(EINVAL):   codec not opened, refcounted_frames not set, it is a
4090  *                         decoder, or requires flush
4091  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4092  *      other errors: legitimate decoding errors
4093  */
4094 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4095
4096 /**
4097  * Read encoded data from the encoder.
4098  *
4099  * @param avctx codec context
4100  * @param avpkt This will be set to a reference-counted packet allocated by the
4101  *              encoder. Note that the function will always call
4102  *              av_frame_unref(frame) before doing anything else.
4103  * @return 0 on success, otherwise negative error code:
4104  *      AVERROR(EAGAIN):   output is not available in the current state - user
4105  *                         must try to send input
4106  *      AVERROR_EOF:       the encoder has been fully flushed, and there will be
4107  *                         no more output packets
4108  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4109  *      other errors: legitimate decoding errors
4110  */
4111 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4112
4113
4114 /**
4115  * @defgroup lavc_parsing Frame parsing
4116  * @{
4117  */
4118
4119 enum AVPictureStructure {
4120     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
4121     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
4122     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4123     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
4124 };
4125
4126 typedef struct AVCodecParserContext {
4127     void *priv_data;
4128     struct AVCodecParser *parser;
4129     int64_t frame_offset; /* offset of the current frame */
4130     int64_t cur_offset; /* current offset
4131                            (incremented by each av_parser_parse()) */
4132     int64_t next_frame_offset; /* offset of the next frame */
4133     /* video info */
4134     int pict_type; /* XXX: Put it back in AVCodecContext. */
4135     /**
4136      * This field is used for proper frame duration computation in lavf.
4137      * It signals, how much longer the frame duration of the current frame
4138      * is compared to normal frame duration.
4139      *
4140      * frame_duration = (1 + repeat_pict) * time_base
4141      *
4142      * It is used by codecs like H.264 to display telecined material.
4143      */
4144     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4145     int64_t pts;     /* pts of the current frame */
4146     int64_t dts;     /* dts of the current frame */
4147
4148     /* private data */
4149     int64_t last_pts;
4150     int64_t last_dts;
4151     int fetch_timestamp;
4152
4153 #define AV_PARSER_PTS_NB 4
4154     int cur_frame_start_index;
4155     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4156     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4157     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4158
4159     int flags;
4160 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4161 #define PARSER_FLAG_ONCE                      0x0002
4162 /// Set if the parser has a valid file offset
4163 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4164
4165     int64_t offset;      ///< byte offset from starting packet start
4166     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4167
4168     /**
4169      * Set by parser to 1 for key frames and 0 for non-key frames.
4170      * It is initialized to -1, so if the parser doesn't set this flag,
4171      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4172      * will be used.
4173      */
4174     int key_frame;
4175
4176 #if FF_API_CONVERGENCE_DURATION
4177     /**
4178      * @deprecated unused
4179      */
4180     attribute_deprecated
4181     int64_t convergence_duration;
4182 #endif
4183
4184     // Timestamp generation support:
4185     /**
4186      * Synchronization point for start of timestamp generation.
4187      *
4188      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4189      * (default).
4190      *
4191      * For example, this corresponds to presence of H.264 buffering period
4192      * SEI message.
4193      */
4194     int dts_sync_point;
4195
4196     /**
4197      * Offset of the current timestamp against last timestamp sync point in
4198      * units of AVCodecContext.time_base.
4199      *
4200      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4201      * contain a valid timestamp offset.
4202      *
4203      * Note that the timestamp of sync point has usually a nonzero
4204      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4205      * the next frame after timestamp sync point will be usually 1.
4206      *
4207      * For example, this corresponds to H.264 cpb_removal_delay.
4208      */
4209     int dts_ref_dts_delta;
4210
4211     /**
4212      * Presentation delay of current frame in units of AVCodecContext.time_base.
4213      *
4214      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4215      * contain valid non-negative timestamp delta (presentation time of a frame
4216      * must not lie in the past).
4217      *
4218      * This delay represents the difference between decoding and presentation
4219      * time of the frame.
4220      *
4221      * For example, this corresponds to H.264 dpb_output_delay.
4222      */
4223     int pts_dts_delta;
4224
4225     /**
4226      * Position of the packet in file.
4227      *
4228      * Analogous to cur_frame_pts/dts
4229      */
4230     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4231
4232     /**
4233      * Byte position of currently parsed frame in stream.
4234      */
4235     int64_t pos;
4236
4237     /**
4238      * Previous frame byte position.
4239      */
4240     int64_t last_pos;
4241
4242     /**
4243      * Duration of the current frame.
4244      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4245      * For all other types, this is in units of AVCodecContext.time_base.
4246      */
4247     int duration;
4248
4249     enum AVFieldOrder field_order;
4250
4251     /**
4252      * Indicate whether a picture is coded as a frame, top field or bottom field.
4253      *
4254      * For example, H.264 field_pic_flag equal to 0 corresponds to
4255      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4256      * equal to 1 and bottom_field_flag equal to 0 corresponds to
4257      * AV_PICTURE_STRUCTURE_TOP_FIELD.
4258      */
4259     enum AVPictureStructure picture_structure;
4260
4261     /**
4262      * Picture number incremented in presentation or output order.
4263      * This field may be reinitialized at the first picture of a new sequence.
4264      *
4265      * For example, this corresponds to H.264 PicOrderCnt.
4266      */
4267     int output_picture_number;
4268
4269     /**
4270      * Dimensions of the decoded video intended for presentation.
4271      */
4272     int width;
4273     int height;
4274
4275     /**
4276      * Dimensions of the coded video.
4277      */
4278     int coded_width;
4279     int coded_height;
4280
4281     /**
4282      * The format of the coded data, corresponds to enum AVPixelFormat for video
4283      * and for enum AVSampleFormat for audio.
4284      *
4285      * Note that a decoder can have considerable freedom in how exactly it
4286      * decodes the data, so the format reported here might be different from the
4287      * one returned by a decoder.
4288      */
4289     int format;
4290 } AVCodecParserContext;
4291
4292 typedef struct AVCodecParser {
4293     int codec_ids[5]; /* several codec IDs are permitted */
4294     int priv_data_size;
4295     int (*parser_init)(AVCodecParserContext *s);
4296     /* This callback never returns an error, a negative value means that
4297      * the frame start was in a previous packet. */
4298     int (*parser_parse)(AVCodecParserContext *s,
4299                         AVCodecContext *avctx,
4300                         const uint8_t **poutbuf, int *poutbuf_size,
4301                         const uint8_t *buf, int buf_size);
4302     void (*parser_close)(AVCodecParserContext *s);
4303     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4304     struct AVCodecParser *next;
4305 } AVCodecParser;
4306
4307 AVCodecParser *av_parser_next(const AVCodecParser *c);
4308
4309 void av_register_codec_parser(AVCodecParser *parser);
4310 AVCodecParserContext *av_parser_init(int codec_id);
4311
4312 /**
4313  * Parse a packet.
4314  *
4315  * @param s             parser context.
4316  * @param avctx         codec context.
4317  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4318  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4319  * @param buf           input buffer.
4320  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4321  * @param pts           input presentation timestamp.
4322  * @param dts           input decoding timestamp.
4323  * @param pos           input byte position in stream.
4324  * @return the number of bytes of the input bitstream used.
4325  *
4326  * Example:
4327  * @code
4328  *   while(in_len){
4329  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4330  *                                        in_data, in_len,
4331  *                                        pts, dts, pos);
4332  *       in_data += len;
4333  *       in_len  -= len;
4334  *
4335  *       if(size)
4336  *          decode_frame(data, size);
4337  *   }
4338  * @endcode
4339  */
4340 int av_parser_parse2(AVCodecParserContext *s,
4341                      AVCodecContext *avctx,
4342                      uint8_t **poutbuf, int *poutbuf_size,
4343                      const uint8_t *buf, int buf_size,
4344                      int64_t pts, int64_t dts,
4345                      int64_t pos);
4346
4347 /**
4348  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4349  * @deprecated use AVBitstreamFilter
4350  */
4351 int av_parser_change(AVCodecParserContext *s,
4352                      AVCodecContext *avctx,
4353                      uint8_t **poutbuf, int *poutbuf_size,
4354                      const uint8_t *buf, int buf_size, int keyframe);
4355 void av_parser_close(AVCodecParserContext *s);
4356
4357 /**
4358  * @}
4359  * @}
4360  */
4361
4362 /**
4363  * @addtogroup lavc_encoding
4364  * @{
4365  */
4366
4367 /**
4368  * Find a registered encoder with a matching codec ID.
4369  *
4370  * @param id AVCodecID of the requested encoder
4371  * @return An encoder if one was found, NULL otherwise.
4372  */
4373 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4374
4375 /**
4376  * Find a registered encoder with the specified name.
4377  *
4378  * @param name name of the requested encoder
4379  * @return An encoder if one was found, NULL otherwise.
4380  */
4381 AVCodec *avcodec_find_encoder_by_name(const char *name);
4382
4383 /**
4384  * Encode a frame of audio.
4385  *
4386  * Takes input samples from frame and writes the next output packet, if
4387  * available, to avpkt. The output packet does not necessarily contain data for
4388  * the most recent frame, as encoders can delay, split, and combine input frames
4389  * internally as needed.
4390  *
4391  * @param avctx     codec context
4392  * @param avpkt     output AVPacket.
4393  *                  The user can supply an output buffer by setting
4394  *                  avpkt->data and avpkt->size prior to calling the
4395  *                  function, but if the size of the user-provided data is not
4396  *                  large enough, encoding will fail. All other AVPacket fields
4397  *                  will be reset by the encoder using av_init_packet(). If
4398  *                  avpkt->data is NULL, the encoder will allocate it.
4399  *                  The encoder will set avpkt->size to the size of the
4400  *                  output packet.
4401  *
4402  *                  If this function fails or produces no output, avpkt will be
4403  *                  freed using av_packet_unref().
4404  * @param[in] frame AVFrame containing the raw audio data to be encoded.
4405  *                  May be NULL when flushing an encoder that has the
4406  *                  AV_CODEC_CAP_DELAY capability set.
4407  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4408  *                  can have any number of samples.
4409  *                  If it is not set, frame->nb_samples must be equal to
4410  *                  avctx->frame_size for all frames except the last.
4411  *                  The final frame may be smaller than avctx->frame_size.
4412  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4413  *                            output packet is non-empty, and to 0 if it is
4414  *                            empty. If the function returns an error, the
4415  *                            packet can be assumed to be invalid, and the
4416  *                            value of got_packet_ptr is undefined and should
4417  *                            not be used.
4418  * @return          0 on success, negative error code on failure
4419  *
4420  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4421  */
4422 attribute_deprecated
4423 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4424                           const AVFrame *frame, int *got_packet_ptr);
4425
4426 /**
4427  * Encode a frame of video.
4428  *
4429  * Takes input raw video data from frame and writes the next output packet, if
4430  * available, to avpkt. The output packet does not necessarily contain data for
4431  * the most recent frame, as encoders can delay and reorder input frames
4432  * internally as needed.
4433  *
4434  * @param avctx     codec context
4435  * @param avpkt     output AVPacket.
4436  *                  The user can supply an output buffer by setting
4437  *                  avpkt->data and avpkt->size prior to calling the
4438  *                  function, but if the size of the user-provided data is not
4439  *                  large enough, encoding will fail. All other AVPacket fields
4440  *                  will be reset by the encoder using av_init_packet(). If
4441  *                  avpkt->data is NULL, the encoder will allocate it.
4442  *                  The encoder will set avpkt->size to the size of the
4443  *                  output packet. The returned data (if any) belongs to the
4444  *                  caller, he is responsible for freeing it.
4445  *
4446  *                  If this function fails or produces no output, avpkt will be
4447  *                  freed using av_packet_unref().
4448  * @param[in] frame AVFrame containing the raw video data to be encoded.
4449  *                  May be NULL when flushing an encoder that has the
4450  *              &