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