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