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