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