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