]> git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h
Merge commit '8281cd5cb80582d668ce0848e0e035b383f161f6'
[ffmpeg] / 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 Encoding/Decoding Library
47  * @{
48  *
49  * @defgroup lavc_decoding Decoding
50  * @{
51  * @}
52  *
53  * @defgroup lavc_encoding Encoding
54  * @{
55  * @}
56  *
57  * @defgroup lavc_codec Codecs
58  * @{
59  * @defgroup lavc_codec_native Native Codecs
60  * @{
61  * @}
62  * @defgroup lavc_codec_wrappers External library wrappers
63  * @{
64  * @}
65  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
66  * @{
67  * @}
68  * @}
69  * @defgroup lavc_internal Internal
70  * @{
71  * @}
72  * @}
73  */
74
75 /**
76  * @ingroup libavc
77  * @defgroup lavc_encdec send/receive encoding and decoding API overview
78  * @{
79  *
80  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
81  * avcodec_receive_packet() functions provide an encode/decode API, which
82  * decouples input and output.
83  *
84  * The API is very similar for encoding/decoding and audio/video, and works as
85  * follows:
86  * - Set up and open the AVCodecContext as usual.
87  * - Send valid input:
88  *   - For decoding, call avcodec_send_packet() to give the decoder raw
89  *     compressed data in an AVPacket.
90  *   - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
91  *     containing uncompressed audio or video.
92  *   In both cases, it is recommended that AVPackets and AVFrames are
93  *   refcounted, or libavcodec might have to copy the input data. (libavformat
94  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
95  *   refcounted AVFrames.)
96  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
97  *   functions and process their output:
98  *   - For decoding, call avcodec_receive_frame(). On success, it will return
99  *     an AVFrame containing uncompressed audio or video data.
100  *   - For encoding, call avcodec_receive_packet(). On success, it will return
101  *     an AVPacket with a compressed frame.
102  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
103  *   AVERROR(EAGAIN) return value means that new input data is required to
104  *   return new output. In this case, continue with sending input. For each
105  *   input frame/packet, the codec will typically return 1 output frame/packet,
106  *   but it can also be 0 or more than 1.
107  *
108  * At the beginning of decoding or encoding, the codec might accept multiple
109  * input frames/packets without returning a frame, until its internal buffers
110  * are filled. This situation is handled transparently if you follow the steps
111  * outlined above.
112  *
113  * End of stream situations. These require "flushing" (aka draining) the codec,
114  * as the codec might buffer multiple frames or packets internally for
115  * performance or out of necessity (consider B-frames).
116  * This is handled as follows:
117  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
118  *   or avcodec_send_frame() (encoding) functions. This will enter draining
119  *   mode.
120  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
121  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
122  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
123  * - Before decoding can be resumed again, the codec has to be reset with
124  *   avcodec_flush_buffers().
125  *
126  * Using the API as outlined above is highly recommended. But it is also
127  * possible to call functions outside of this rigid schema. For example, you can
128  * call avcodec_send_packet() repeatedly without calling
129  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
130  * until the codec's internal buffer has been filled up (which is typically of
131  * size 1 per output frame, after initial input), and then reject input with
132  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
133  * read at least some output.
134  *
135  * Not all codecs will follow a rigid and predictable dataflow; the only
136  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
137  * one end implies that a receive/send call on the other end will succeed. In
138  * general, no codec will permit unlimited buffering of input or output.
139  *
140  * This API replaces the following legacy functions:
141  * - avcodec_decode_video2() and avcodec_decode_audio4():
142  *   Use avcodec_send_packet() to feed input to the decoder, then use
143  *   avcodec_receive_frame() to receive decoded frames after each packet.
144  *   Unlike with the old video decoding API, multiple frames might result from
145  *   a packet. For audio, splitting the input packet into frames by partially
146  *   decoding packets becomes transparent to the API user. You never need to
147  *   feed an AVPacket to the API twice.
148  *   Additionally, sending a flush/draining packet is required only once.
149  * - avcodec_encode_video2()/avcodec_encode_audio2():
150  *   Use avcodec_send_frame() to feed input to the encoder, then use
151  *   avcodec_receive_packet() to receive encoded packets.
152  *   Providing user-allocated buffers for avcodec_receive_packet() is not
153  *   possible.
154  * - The new API does not handle subtitles yet.
155  *
156  * Mixing new and old function calls on the same AVCodecContext is not allowed,
157  * and will result in undefined behavior.
158  *
159  * Some codecs might require using the new API; using the old API will return
160  * an error when calling it.
161  * @}
162  */
163
164 /**
165  * @defgroup lavc_core Core functions/structures.
166  * @ingroup libavc
167  *
168  * Basic definitions, functions for querying libavcodec capabilities,
169  * allocating core structures, etc.
170  * @{
171  */
172
173
174 /**
175  * Identify the syntax and semantics of the bitstream.
176  * The principle is roughly:
177  * Two decoders with the same ID can decode the same streams.
178  * Two encoders with the same ID can encode compatible streams.
179  * There may be slight deviations from the principle due to implementation
180  * details.
181  *
182  * If you add a codec ID to this list, add it so that
183  * 1. no value of an existing codec ID changes (that would break ABI),
184  * 2. it is as close as possible to similar codecs
185  *
186  * After adding new codec IDs, do not forget to add an entry to the codec
187  * descriptor list and bump libavcodec minor version.
188  */
189 enum AVCodecID {
190     AV_CODEC_ID_NONE,
191
192     /* video codecs */
193     AV_CODEC_ID_MPEG1VIDEO,
194     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
195 #if FF_API_XVMC
196     AV_CODEC_ID_MPEG2VIDEO_XVMC,
197 #endif /* FF_API_XVMC */
198     AV_CODEC_ID_H261,
199     AV_CODEC_ID_H263,
200     AV_CODEC_ID_RV10,
201     AV_CODEC_ID_RV20,
202     AV_CODEC_ID_MJPEG,
203     AV_CODEC_ID_MJPEGB,
204     AV_CODEC_ID_LJPEG,
205     AV_CODEC_ID_SP5X,
206     AV_CODEC_ID_JPEGLS,
207     AV_CODEC_ID_MPEG4,
208     AV_CODEC_ID_RAWVIDEO,
209     AV_CODEC_ID_MSMPEG4V1,
210     AV_CODEC_ID_MSMPEG4V2,
211     AV_CODEC_ID_MSMPEG4V3,
212     AV_CODEC_ID_WMV1,
213     AV_CODEC_ID_WMV2,
214     AV_CODEC_ID_H263P,
215     AV_CODEC_ID_H263I,
216     AV_CODEC_ID_FLV1,
217     AV_CODEC_ID_SVQ1,
218     AV_CODEC_ID_SVQ3,
219     AV_CODEC_ID_DVVIDEO,
220     AV_CODEC_ID_HUFFYUV,
221     AV_CODEC_ID_CYUV,
222     AV_CODEC_ID_H264,
223     AV_CODEC_ID_INDEO3,
224     AV_CODEC_ID_VP3,
225     AV_CODEC_ID_THEORA,
226     AV_CODEC_ID_ASV1,
227     AV_CODEC_ID_ASV2,
228     AV_CODEC_ID_FFV1,
229     AV_CODEC_ID_4XM,
230     AV_CODEC_ID_VCR1,
231     AV_CODEC_ID_CLJR,
232     AV_CODEC_ID_MDEC,
233     AV_CODEC_ID_ROQ,
234     AV_CODEC_ID_INTERPLAY_VIDEO,
235     AV_CODEC_ID_XAN_WC3,
236     AV_CODEC_ID_XAN_WC4,
237     AV_CODEC_ID_RPZA,
238     AV_CODEC_ID_CINEPAK,
239     AV_CODEC_ID_WS_VQA,
240     AV_CODEC_ID_MSRLE,
241     AV_CODEC_ID_MSVIDEO1,
242     AV_CODEC_ID_IDCIN,
243     AV_CODEC_ID_8BPS,
244     AV_CODEC_ID_SMC,
245     AV_CODEC_ID_FLIC,
246     AV_CODEC_ID_TRUEMOTION1,
247     AV_CODEC_ID_VMDVIDEO,
248     AV_CODEC_ID_MSZH,
249     AV_CODEC_ID_ZLIB,
250     AV_CODEC_ID_QTRLE,
251     AV_CODEC_ID_TSCC,
252     AV_CODEC_ID_ULTI,
253     AV_CODEC_ID_QDRAW,
254     AV_CODEC_ID_VIXL,
255     AV_CODEC_ID_QPEG,
256     AV_CODEC_ID_PNG,
257     AV_CODEC_ID_PPM,
258     AV_CODEC_ID_PBM,
259     AV_CODEC_ID_PGM,
260     AV_CODEC_ID_PGMYUV,
261     AV_CODEC_ID_PAM,
262     AV_CODEC_ID_FFVHUFF,
263     AV_CODEC_ID_RV30,
264     AV_CODEC_ID_RV40,
265     AV_CODEC_ID_VC1,
266     AV_CODEC_ID_WMV3,
267     AV_CODEC_ID_LOCO,
268     AV_CODEC_ID_WNV1,
269     AV_CODEC_ID_AASC,
270     AV_CODEC_ID_INDEO2,
271     AV_CODEC_ID_FRAPS,
272     AV_CODEC_ID_TRUEMOTION2,
273     AV_CODEC_ID_BMP,
274     AV_CODEC_ID_CSCD,
275     AV_CODEC_ID_MMVIDEO,
276     AV_CODEC_ID_ZMBV,
277     AV_CODEC_ID_AVS,
278     AV_CODEC_ID_SMACKVIDEO,
279     AV_CODEC_ID_NUV,
280     AV_CODEC_ID_KMVC,
281     AV_CODEC_ID_FLASHSV,
282     AV_CODEC_ID_CAVS,
283     AV_CODEC_ID_JPEG2000,
284     AV_CODEC_ID_VMNC,
285     AV_CODEC_ID_VP5,
286     AV_CODEC_ID_VP6,
287     AV_CODEC_ID_VP6F,
288     AV_CODEC_ID_TARGA,
289     AV_CODEC_ID_DSICINVIDEO,
290     AV_CODEC_ID_TIERTEXSEQVIDEO,
291     AV_CODEC_ID_TIFF,
292     AV_CODEC_ID_GIF,
293     AV_CODEC_ID_DXA,
294     AV_CODEC_ID_DNXHD,
295     AV_CODEC_ID_THP,
296     AV_CODEC_ID_SGI,
297     AV_CODEC_ID_C93,
298     AV_CODEC_ID_BETHSOFTVID,
299     AV_CODEC_ID_PTX,
300     AV_CODEC_ID_TXD,
301     AV_CODEC_ID_VP6A,
302     AV_CODEC_ID_AMV,
303     AV_CODEC_ID_VB,
304     AV_CODEC_ID_PCX,
305     AV_CODEC_ID_SUNRAST,
306     AV_CODEC_ID_INDEO4,
307     AV_CODEC_ID_INDEO5,
308     AV_CODEC_ID_MIMIC,
309     AV_CODEC_ID_RL2,
310     AV_CODEC_ID_ESCAPE124,
311     AV_CODEC_ID_DIRAC,
312     AV_CODEC_ID_BFI,
313     AV_CODEC_ID_CMV,
314     AV_CODEC_ID_MOTIONPIXELS,
315     AV_CODEC_ID_TGV,
316     AV_CODEC_ID_TGQ,
317     AV_CODEC_ID_TQI,
318     AV_CODEC_ID_AURA,
319     AV_CODEC_ID_AURA2,
320     AV_CODEC_ID_V210X,
321     AV_CODEC_ID_TMV,
322     AV_CODEC_ID_V210,
323     AV_CODEC_ID_DPX,
324     AV_CODEC_ID_MAD,
325     AV_CODEC_ID_FRWU,
326     AV_CODEC_ID_FLASHSV2,
327     AV_CODEC_ID_CDGRAPHICS,
328     AV_CODEC_ID_R210,
329     AV_CODEC_ID_ANM,
330     AV_CODEC_ID_BINKVIDEO,
331     AV_CODEC_ID_IFF_ILBM,
332 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
333     AV_CODEC_ID_KGV1,
334     AV_CODEC_ID_YOP,
335     AV_CODEC_ID_VP8,
336     AV_CODEC_ID_PICTOR,
337     AV_CODEC_ID_ANSI,
338     AV_CODEC_ID_A64_MULTI,
339     AV_CODEC_ID_A64_MULTI5,
340     AV_CODEC_ID_R10K,
341     AV_CODEC_ID_MXPEG,
342     AV_CODEC_ID_LAGARITH,
343     AV_CODEC_ID_PRORES,
344     AV_CODEC_ID_JV,
345     AV_CODEC_ID_DFA,
346     AV_CODEC_ID_WMV3IMAGE,
347     AV_CODEC_ID_VC1IMAGE,
348     AV_CODEC_ID_UTVIDEO,
349     AV_CODEC_ID_BMV_VIDEO,
350     AV_CODEC_ID_VBLE,
351     AV_CODEC_ID_DXTORY,
352     AV_CODEC_ID_V410,
353     AV_CODEC_ID_XWD,
354     AV_CODEC_ID_CDXL,
355     AV_CODEC_ID_XBM,
356     AV_CODEC_ID_ZEROCODEC,
357     AV_CODEC_ID_MSS1,
358     AV_CODEC_ID_MSA1,
359     AV_CODEC_ID_TSCC2,
360     AV_CODEC_ID_MTS2,
361     AV_CODEC_ID_CLLC,
362     AV_CODEC_ID_MSS2,
363     AV_CODEC_ID_VP9,
364     AV_CODEC_ID_AIC,
365     AV_CODEC_ID_ESCAPE130,
366     AV_CODEC_ID_G2M,
367     AV_CODEC_ID_WEBP,
368     AV_CODEC_ID_HNM4_VIDEO,
369     AV_CODEC_ID_HEVC,
370 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
371     AV_CODEC_ID_FIC,
372     AV_CODEC_ID_ALIAS_PIX,
373     AV_CODEC_ID_BRENDER_PIX,
374     AV_CODEC_ID_PAF_VIDEO,
375     AV_CODEC_ID_EXR,
376     AV_CODEC_ID_VP7,
377     AV_CODEC_ID_SANM,
378     AV_CODEC_ID_SGIRLE,
379     AV_CODEC_ID_MVC1,
380     AV_CODEC_ID_MVC2,
381     AV_CODEC_ID_HQX,
382     AV_CODEC_ID_TDSC,
383     AV_CODEC_ID_HQ_HQA,
384     AV_CODEC_ID_HAP,
385     AV_CODEC_ID_DDS,
386     AV_CODEC_ID_DXV,
387     AV_CODEC_ID_SCREENPRESSO,
388     AV_CODEC_ID_RSCC,
389
390     AV_CODEC_ID_Y41P = 0x8000,
391     AV_CODEC_ID_AVRP,
392     AV_CODEC_ID_012V,
393     AV_CODEC_ID_AVUI,
394     AV_CODEC_ID_AYUV,
395     AV_CODEC_ID_TARGA_Y216,
396     AV_CODEC_ID_V308,
397     AV_CODEC_ID_V408,
398     AV_CODEC_ID_YUV4,
399     AV_CODEC_ID_AVRN,
400     AV_CODEC_ID_CPIA,
401     AV_CODEC_ID_XFACE,
402     AV_CODEC_ID_SNOW,
403     AV_CODEC_ID_SMVJPEG,
404     AV_CODEC_ID_APNG,
405     AV_CODEC_ID_DAALA,
406     AV_CODEC_ID_CFHD,
407     AV_CODEC_ID_TRUEMOTION2RT,
408     AV_CODEC_ID_M101,
409     AV_CODEC_ID_MAGICYUV,
410     AV_CODEC_ID_SHEERVIDEO,
411     AV_CODEC_ID_YLC,
412
413     /* various PCM "codecs" */
414     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
415     AV_CODEC_ID_PCM_S16LE = 0x10000,
416     AV_CODEC_ID_PCM_S16BE,
417     AV_CODEC_ID_PCM_U16LE,
418     AV_CODEC_ID_PCM_U16BE,
419     AV_CODEC_ID_PCM_S8,
420     AV_CODEC_ID_PCM_U8,
421     AV_CODEC_ID_PCM_MULAW,
422     AV_CODEC_ID_PCM_ALAW,
423     AV_CODEC_ID_PCM_S32LE,
424     AV_CODEC_ID_PCM_S32BE,
425     AV_CODEC_ID_PCM_U32LE,
426     AV_CODEC_ID_PCM_U32BE,
427     AV_CODEC_ID_PCM_S24LE,
428     AV_CODEC_ID_PCM_S24BE,
429     AV_CODEC_ID_PCM_U24LE,
430     AV_CODEC_ID_PCM_U24BE,
431     AV_CODEC_ID_PCM_S24DAUD,
432     AV_CODEC_ID_PCM_ZORK,
433     AV_CODEC_ID_PCM_S16LE_PLANAR,
434     AV_CODEC_ID_PCM_DVD,
435     AV_CODEC_ID_PCM_F32BE,
436     AV_CODEC_ID_PCM_F32LE,
437     AV_CODEC_ID_PCM_F64BE,
438     AV_CODEC_ID_PCM_F64LE,
439     AV_CODEC_ID_PCM_BLURAY,
440     AV_CODEC_ID_PCM_LXF,
441     AV_CODEC_ID_S302M,
442     AV_CODEC_ID_PCM_S8_PLANAR,
443     AV_CODEC_ID_PCM_S24LE_PLANAR,
444     AV_CODEC_ID_PCM_S32LE_PLANAR,
445     AV_CODEC_ID_PCM_S16BE_PLANAR,
446     /* new PCM "codecs" should be added right below this line starting with
447      * an explicit value of for example 0x10800
448      */
449
450     /* various ADPCM codecs */
451     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
452     AV_CODEC_ID_ADPCM_IMA_WAV,
453     AV_CODEC_ID_ADPCM_IMA_DK3,
454     AV_CODEC_ID_ADPCM_IMA_DK4,
455     AV_CODEC_ID_ADPCM_IMA_WS,
456     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
457     AV_CODEC_ID_ADPCM_MS,
458     AV_CODEC_ID_ADPCM_4XM,
459     AV_CODEC_ID_ADPCM_XA,
460     AV_CODEC_ID_ADPCM_ADX,
461     AV_CODEC_ID_ADPCM_EA,
462     AV_CODEC_ID_ADPCM_G726,
463     AV_CODEC_ID_ADPCM_CT,
464     AV_CODEC_ID_ADPCM_SWF,
465     AV_CODEC_ID_ADPCM_YAMAHA,
466     AV_CODEC_ID_ADPCM_SBPRO_4,
467     AV_CODEC_ID_ADPCM_SBPRO_3,
468     AV_CODEC_ID_ADPCM_SBPRO_2,
469     AV_CODEC_ID_ADPCM_THP,
470     AV_CODEC_ID_ADPCM_IMA_AMV,
471     AV_CODEC_ID_ADPCM_EA_R1,
472     AV_CODEC_ID_ADPCM_EA_R3,
473     AV_CODEC_ID_ADPCM_EA_R2,
474     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
475     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
476     AV_CODEC_ID_ADPCM_EA_XAS,
477     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
478     AV_CODEC_ID_ADPCM_IMA_ISS,
479     AV_CODEC_ID_ADPCM_G722,
480     AV_CODEC_ID_ADPCM_IMA_APC,
481     AV_CODEC_ID_ADPCM_VIMA,
482 #if FF_API_VIMA_DECODER
483     AV_CODEC_ID_VIMA = AV_CODEC_ID_ADPCM_VIMA,
484 #endif
485
486     AV_CODEC_ID_ADPCM_AFC = 0x11800,
487     AV_CODEC_ID_ADPCM_IMA_OKI,
488     AV_CODEC_ID_ADPCM_DTK,
489     AV_CODEC_ID_ADPCM_IMA_RAD,
490     AV_CODEC_ID_ADPCM_G726LE,
491     AV_CODEC_ID_ADPCM_THP_LE,
492     AV_CODEC_ID_ADPCM_PSX,
493     AV_CODEC_ID_ADPCM_AICA,
494     AV_CODEC_ID_ADPCM_IMA_DAT4,
495     AV_CODEC_ID_ADPCM_MTAF,
496
497     /* AMR */
498     AV_CODEC_ID_AMR_NB = 0x12000,
499     AV_CODEC_ID_AMR_WB,
500
501     /* RealAudio codecs*/
502     AV_CODEC_ID_RA_144 = 0x13000,
503     AV_CODEC_ID_RA_288,
504
505     /* various DPCM codecs */
506     AV_CODEC_ID_ROQ_DPCM = 0x14000,
507     AV_CODEC_ID_INTERPLAY_DPCM,
508     AV_CODEC_ID_XAN_DPCM,
509     AV_CODEC_ID_SOL_DPCM,
510
511     AV_CODEC_ID_SDX2_DPCM = 0x14800,
512
513     /* audio codecs */
514     AV_CODEC_ID_MP2 = 0x15000,
515     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
516     AV_CODEC_ID_AAC,
517     AV_CODEC_ID_AC3,
518     AV_CODEC_ID_DTS,
519     AV_CODEC_ID_VORBIS,
520     AV_CODEC_ID_DVAUDIO,
521     AV_CODEC_ID_WMAV1,
522     AV_CODEC_ID_WMAV2,
523     AV_CODEC_ID_MACE3,
524     AV_CODEC_ID_MACE6,
525     AV_CODEC_ID_VMDAUDIO,
526     AV_CODEC_ID_FLAC,
527     AV_CODEC_ID_MP3ADU,
528     AV_CODEC_ID_MP3ON4,
529     AV_CODEC_ID_SHORTEN,
530     AV_CODEC_ID_ALAC,
531     AV_CODEC_ID_WESTWOOD_SND1,
532     AV_CODEC_ID_GSM, ///< as in Berlin toast format
533     AV_CODEC_ID_QDM2,
534     AV_CODEC_ID_COOK,
535     AV_CODEC_ID_TRUESPEECH,
536     AV_CODEC_ID_TTA,
537     AV_CODEC_ID_SMACKAUDIO,
538     AV_CODEC_ID_QCELP,
539     AV_CODEC_ID_WAVPACK,
540     AV_CODEC_ID_DSICINAUDIO,
541     AV_CODEC_ID_IMC,
542     AV_CODEC_ID_MUSEPACK7,
543     AV_CODEC_ID_MLP,
544     AV_CODEC_ID_GSM_MS, /* as found in WAV */
545     AV_CODEC_ID_ATRAC3,
546 #if FF_API_VOXWARE
547     AV_CODEC_ID_VOXWARE,
548 #endif
549     AV_CODEC_ID_APE,
550     AV_CODEC_ID_NELLYMOSER,
551     AV_CODEC_ID_MUSEPACK8,
552     AV_CODEC_ID_SPEEX,
553     AV_CODEC_ID_WMAVOICE,
554     AV_CODEC_ID_WMAPRO,
555     AV_CODEC_ID_WMALOSSLESS,
556     AV_CODEC_ID_ATRAC3P,
557     AV_CODEC_ID_EAC3,
558     AV_CODEC_ID_SIPR,
559     AV_CODEC_ID_MP1,
560     AV_CODEC_ID_TWINVQ,
561     AV_CODEC_ID_TRUEHD,
562     AV_CODEC_ID_MP4ALS,
563     AV_CODEC_ID_ATRAC1,
564     AV_CODEC_ID_BINKAUDIO_RDFT,
565     AV_CODEC_ID_BINKAUDIO_DCT,
566     AV_CODEC_ID_AAC_LATM,
567     AV_CODEC_ID_QDMC,
568     AV_CODEC_ID_CELT,
569     AV_CODEC_ID_G723_1,
570     AV_CODEC_ID_G729,
571     AV_CODEC_ID_8SVX_EXP,
572     AV_CODEC_ID_8SVX_FIB,
573     AV_CODEC_ID_BMV_AUDIO,
574     AV_CODEC_ID_RALF,
575     AV_CODEC_ID_IAC,
576     AV_CODEC_ID_ILBC,
577     AV_CODEC_ID_OPUS,
578     AV_CODEC_ID_COMFORT_NOISE,
579     AV_CODEC_ID_TAK,
580     AV_CODEC_ID_METASOUND,
581     AV_CODEC_ID_PAF_AUDIO,
582     AV_CODEC_ID_ON2AVC,
583     AV_CODEC_ID_DSS_SP,
584
585     AV_CODEC_ID_FFWAVESYNTH = 0x15800,
586     AV_CODEC_ID_SONIC,
587     AV_CODEC_ID_SONIC_LS,
588     AV_CODEC_ID_EVRC,
589     AV_CODEC_ID_SMV,
590     AV_CODEC_ID_DSD_LSBF,
591     AV_CODEC_ID_DSD_MSBF,
592     AV_CODEC_ID_DSD_LSBF_PLANAR,
593     AV_CODEC_ID_DSD_MSBF_PLANAR,
594     AV_CODEC_ID_4GV,
595     AV_CODEC_ID_INTERPLAY_ACM,
596     AV_CODEC_ID_XMA1,
597     AV_CODEC_ID_XMA2,
598     AV_CODEC_ID_DST,
599
600     /* subtitle codecs */
601     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
602     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
603     AV_CODEC_ID_DVB_SUBTITLE,
604     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
605     AV_CODEC_ID_XSUB,
606     AV_CODEC_ID_SSA,
607     AV_CODEC_ID_MOV_TEXT,
608     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
609     AV_CODEC_ID_DVB_TELETEXT,
610     AV_CODEC_ID_SRT,
611
612     AV_CODEC_ID_MICRODVD   = 0x17800,
613     AV_CODEC_ID_EIA_608,
614     AV_CODEC_ID_JACOSUB,
615     AV_CODEC_ID_SAMI,
616     AV_CODEC_ID_REALTEXT,
617     AV_CODEC_ID_STL,
618     AV_CODEC_ID_SUBVIEWER1,
619     AV_CODEC_ID_SUBVIEWER,
620     AV_CODEC_ID_SUBRIP,
621     AV_CODEC_ID_WEBVTT,
622     AV_CODEC_ID_MPL2,
623     AV_CODEC_ID_VPLAYER,
624     AV_CODEC_ID_PJS,
625     AV_CODEC_ID_ASS,
626     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
627
628     /* other specific kind of codecs (generally used for attachments) */
629     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
630     AV_CODEC_ID_TTF = 0x18000,
631
632     AV_CODEC_ID_BINTEXT    = 0x18800,
633     AV_CODEC_ID_XBIN,
634     AV_CODEC_ID_IDF,
635     AV_CODEC_ID_OTF,
636     AV_CODEC_ID_SMPTE_KLV,
637     AV_CODEC_ID_DVD_NAV,
638     AV_CODEC_ID_TIMED_ID3,
639     AV_CODEC_ID_BIN_DATA,
640
641
642     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
643
644     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
645                                 * stream (only used by libavformat) */
646     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
647                                 * stream (only used by libavformat) */
648     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
649     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
650 };
651
652 /**
653  * This struct describes the properties of a single codec described by an
654  * AVCodecID.
655  * @see avcodec_descriptor_get()
656  */
657 typedef struct AVCodecDescriptor {
658     enum AVCodecID     id;
659     enum AVMediaType type;
660     /**
661      * Name of the codec described by this descriptor. It is non-empty and
662      * unique for each codec descriptor. It should contain alphanumeric
663      * characters and '_' only.
664      */
665     const char      *name;
666     /**
667      * A more descriptive name for this codec. May be NULL.
668      */
669     const char *long_name;
670     /**
671      * Codec properties, a combination of AV_CODEC_PROP_* flags.
672      */
673     int             props;
674     /**
675      * MIME type(s) associated with the codec.
676      * May be NULL; if not, a NULL-terminated array of MIME types.
677      * The first item is always non-NULL and is the preferred MIME type.
678      */
679     const char *const *mime_types;
680     /**
681      * If non-NULL, an array of profiles recognized for this codec.
682      * Terminated with FF_PROFILE_UNKNOWN.
683      */
684     const struct AVProfile *profiles;
685 } AVCodecDescriptor;
686
687 /**
688  * Codec uses only intra compression.
689  * Video codecs only.
690  */
691 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
692 /**
693  * Codec supports lossy compression. Audio and video codecs only.
694  * @note a codec may support both lossy and lossless
695  * compression modes
696  */
697 #define AV_CODEC_PROP_LOSSY         (1 << 1)
698 /**
699  * Codec supports lossless compression. Audio and video codecs only.
700  */
701 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
702 /**
703  * Codec supports frame reordering. That is, the coded order (the order in which
704  * the encoded packets are output by the encoders / stored / input to the
705  * decoders) may be different from the presentation order of the corresponding
706  * frames.
707  *
708  * For codecs that do not have this property set, PTS and DTS should always be
709  * equal.
710  */
711 #define AV_CODEC_PROP_REORDER       (1 << 3)
712 /**
713  * Subtitle codec is bitmap based
714  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
715  */
716 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
717 /**
718  * Subtitle codec is text based.
719  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
720  */
721 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
722
723 /**
724  * @ingroup lavc_decoding
725  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
726  * This is mainly needed because some optimized bitstream readers read
727  * 32 or 64 bit at once and could read over the end.<br>
728  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
729  * MPEG bitstreams could cause overread and segfault.
730  */
731 #define AV_INPUT_BUFFER_PADDING_SIZE 32
732
733 /**
734  * @ingroup lavc_encoding
735  * minimum encoding buffer size
736  * Used to avoid some checks during header writing.
737  */
738 #define AV_INPUT_BUFFER_MIN_SIZE 16384
739
740 #if FF_API_WITHOUT_PREFIX
741 /**
742  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
743  */
744 #define FF_INPUT_BUFFER_PADDING_SIZE 32
745
746 /**
747  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
748  */
749 #define FF_MIN_BUFFER_SIZE 16384
750 #endif /* FF_API_WITHOUT_PREFIX */
751
752 /**
753  * @ingroup lavc_encoding
754  * motion estimation type.
755  * @deprecated use codec private option instead
756  */
757 #if FF_API_MOTION_EST
758 enum Motion_Est_ID {
759     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
760     ME_FULL,
761     ME_LOG,
762     ME_PHODS,
763     ME_EPZS,        ///< enhanced predictive zonal search
764     ME_X1,          ///< reserved for experiments
765     ME_HEX,         ///< hexagon based search
766     ME_UMH,         ///< uneven multi-hexagon search
767     ME_TESA,        ///< transformed exhaustive search algorithm
768     ME_ITER=50,     ///< iterative search
769 };
770 #endif
771
772 /**
773  * @ingroup lavc_decoding
774  */
775 enum AVDiscard{
776     /* We leave some space between them for extensions (drop some
777      * keyframes for intra-only or drop just some bidir frames). */
778     AVDISCARD_NONE    =-16, ///< discard nothing
779     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
780     AVDISCARD_NONREF  =  8, ///< discard all non reference
781     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
782     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
783     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
784     AVDISCARD_ALL     = 48, ///< discard all
785 };
786
787 enum AVAudioServiceType {
788     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
789     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
790     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
791     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
792     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
793     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
794     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
795     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
796     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
797     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
798 };
799
800 /**
801  * @ingroup lavc_encoding
802  */
803 typedef struct RcOverride{
804     int start_frame;
805     int end_frame;
806     int qscale; // If this is 0 then quality_factor will be used instead.
807     float quality_factor;
808 } RcOverride;
809
810 #if FF_API_MAX_BFRAMES
811 /**
812  * @deprecated there is no libavcodec-wide limit on the number of B-frames
813  */
814 #define FF_MAX_B_FRAMES 16
815 #endif
816
817 /* encoding support
818    These flags can be passed in AVCodecContext.flags before initialization.
819    Note: Not everything is supported yet.
820 */
821
822 /**
823  * Allow decoders to produce frames with data planes that are not aligned
824  * to CPU requirements (e.g. due to cropping).
825  */
826 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
827 /**
828  * Use fixed qscale.
829  */
830 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
831 /**
832  * 4 MV per MB allowed / advanced prediction for H.263.
833  */
834 #define AV_CODEC_FLAG_4MV             (1 <<  2)
835 /**
836  * Output even those frames that might be corrupted.
837  */
838 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
839 /**
840  * Use qpel MC.
841  */
842 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
843 /**
844  * Use internal 2pass ratecontrol in first pass mode.
845  */
846 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
847 /**
848  * Use internal 2pass ratecontrol in second pass mode.
849  */
850 #define AV_CODEC_FLAG_PASS2           (1 << 10)
851 /**
852  * loop filter.
853  */
854 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
855 /**
856  * Only decode/encode grayscale.
857  */
858 #define AV_CODEC_FLAG_GRAY            (1 << 13)
859 /**
860  * error[?] variables will be set during encoding.
861  */
862 #define AV_CODEC_FLAG_PSNR            (1 << 15)
863 /**
864  * Input bitstream might be truncated at a random location
865  * instead of only at frame boundaries.
866  */
867 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
868 /**
869  * Use interlaced DCT.
870  */
871 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
872 /**
873  * Force low delay.
874  */
875 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
876 /**
877  * Place global headers in extradata instead of every keyframe.
878  */
879 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
880 /**
881  * Use only bitexact stuff (except (I)DCT).
882  */
883 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
884 /* Fx : Flag for H.263+ extra options */
885 /**
886  * H.263 advanced intra coding / MPEG-4 AC prediction
887  */
888 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
889 /**
890  * interlaced motion estimation
891  */
892 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
893 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
894
895 /**
896  * Allow non spec compliant speedup tricks.
897  */
898 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
899 /**
900  * Skip bitstream encoding.
901  */
902 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
903 /**
904  * Place global headers at every keyframe instead of in extradata.
905  */
906 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
907
908 /**
909  * timecode is in drop frame format. DEPRECATED!!!!
910  */
911 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
912
913 /**
914  * Input bitstream might be truncated at a packet boundaries
915  * instead of only at frame boundaries.
916  */
917 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
918 /**
919  * Discard cropping information from SPS.
920  */
921 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
922
923 /**
924  * Show all frames before the first keyframe
925  */
926 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
927 /**
928  * Export motion vectors through frame side data
929  */
930 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
931 /**
932  * Do not skip samples and export skip information as frame side data
933  */
934 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
935 /**
936  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
937  */
938 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
939
940 /* Unsupported options :
941  *              Syntax Arithmetic coding (SAC)
942  *              Reference Picture Selection
943  *              Independent Segment Decoding */
944 /* /Fx */
945 /* codec capabilities */
946
947 /**
948  * Decoder can use draw_horiz_band callback.
949  */
950 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
951 /**
952  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
953  * If not set, it might not use get_buffer() at all or use operations that
954  * assume the buffer was allocated by avcodec_default_get_buffer.
955  */
956 #define AV_CODEC_CAP_DR1                 (1 <<  1)
957 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
958 /**
959  * Encoder or decoder requires flushing with NULL input at the end in order to
960  * give the complete and correct output.
961  *
962  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
963  *       with NULL data. The user can still send NULL data to the public encode
964  *       or decode function, but libavcodec will not pass it along to the codec
965  *       unless this flag is set.
966  *
967  * Decoders:
968  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
969  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
970  * returns frames.
971  *
972  * Encoders:
973  * The encoder needs to be fed with NULL data at the end of encoding until the
974  * encoder no longer returns data.
975  *
976  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
977  *       flag also means that the encoder must set the pts and duration for
978  *       each output packet. If this flag is not set, the pts and duration will
979  *       be determined by libavcodec from the input frame.
980  */
981 #define AV_CODEC_CAP_DELAY               (1 <<  5)
982 /**
983  * Codec can be fed a final frame with a smaller size.
984  * This can be used to prevent truncation of the last audio samples.
985  */
986 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
987
988 #if FF_API_CAP_VDPAU
989 /**
990  * Codec can export data for HW decoding (VDPAU).
991  */
992 #define AV_CODEC_CAP_HWACCEL_VDPAU       (1 <<  7)
993 #endif
994
995 /**
996  * Codec can output multiple frames per AVPacket
997  * Normally demuxers return one frame at a time, demuxers which do not do
998  * are connected to a parser to split what they return into proper frames.
999  * This flag is reserved to the very rare category of codecs which have a
1000  * bitstream that cannot be split into frames without timeconsuming
1001  * operations like full decoding. Demuxers carrying such bitstreams thus
1002  * may return multiple frames in a packet. This has many disadvantages like
1003  * prohibiting stream copy in many cases thus it should only be considered
1004  * as a last resort.
1005  */
1006 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1007 /**
1008  * Codec is experimental and is thus avoided in favor of non experimental
1009  * encoders
1010  */
1011 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1012 /**
1013  * Codec should fill in channel configuration and samplerate instead of container
1014  */
1015 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1016 /**
1017  * Codec supports frame-level multithreading.
1018  */
1019 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1020 /**
1021  * Codec supports slice-based (or partition-based) multithreading.
1022  */
1023 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1024 /**
1025  * Codec supports changed parameters at any point.
1026  */
1027 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1028 /**
1029  * Codec supports avctx->thread_count == 0 (auto).
1030  */
1031 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1032 /**
1033  * Audio encoder supports receiving a different number of samples in each call.
1034  */
1035 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1036 /**
1037  * Codec is intra only.
1038  */
1039 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1040 /**
1041  * Codec is lossless.
1042  */
1043 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1044
1045
1046 #if FF_API_WITHOUT_PREFIX
1047 /**
1048  * Allow decoders to produce frames with data planes that are not aligned
1049  * to CPU requirements (e.g. due to cropping).
1050  */
1051 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1052 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1053 #define CODEC_FLAG_4MV    AV_CODEC_FLAG_4MV
1054 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1055 #define CODEC_FLAG_QPEL   AV_CODEC_FLAG_QPEL
1056 #if FF_API_GMC
1057 /**
1058  * @deprecated use the "gmc" private option of the libxvid encoder
1059  */
1060 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
1061 #endif
1062 #if FF_API_MV0
1063 /**
1064  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1065  * mpegvideo encoders
1066  */
1067 #define CODEC_FLAG_MV0    0x0040
1068 #endif
1069 #if FF_API_INPUT_PRESERVED
1070 /**
1071  * @deprecated passing reference-counted frames to the encoders replaces this
1072  * flag
1073  */
1074 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1075 #endif
1076 #define CODEC_FLAG_PASS1           AV_CODEC_FLAG_PASS1
1077 #define CODEC_FLAG_PASS2           AV_CODEC_FLAG_PASS2
1078 #define CODEC_FLAG_GRAY            AV_CODEC_FLAG_GRAY
1079 #if FF_API_EMU_EDGE
1080 /**
1081  * @deprecated edges are not used/required anymore. I.e. this flag is now always
1082  * set.
1083  */
1084 #define CODEC_FLAG_EMU_EDGE        0x4000
1085 #endif
1086 #define CODEC_FLAG_PSNR            AV_CODEC_FLAG_PSNR
1087 #define CODEC_FLAG_TRUNCATED       AV_CODEC_FLAG_TRUNCATED
1088
1089 #if FF_API_NORMALIZE_AQP
1090 /**
1091  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1092  * mpegvideo encoders
1093  */
1094 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
1095 #endif
1096 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1097 #define CODEC_FLAG_LOW_DELAY      AV_CODEC_FLAG_LOW_DELAY
1098 #define CODEC_FLAG_GLOBAL_HEADER  AV_CODEC_FLAG_GLOBAL_HEADER
1099 #define CODEC_FLAG_BITEXACT       AV_CODEC_FLAG_BITEXACT
1100 #define CODEC_FLAG_AC_PRED        AV_CODEC_FLAG_AC_PRED
1101 #define CODEC_FLAG_LOOP_FILTER    AV_CODEC_FLAG_LOOP_FILTER
1102 #define CODEC_FLAG_INTERLACED_ME  AV_CODEC_FLAG_INTERLACED_ME
1103 #define CODEC_FLAG_CLOSED_GOP     AV_CODEC_FLAG_CLOSED_GOP
1104 #define CODEC_FLAG2_FAST          AV_CODEC_FLAG2_FAST
1105 #define CODEC_FLAG2_NO_OUTPUT     AV_CODEC_FLAG2_NO_OUTPUT
1106 #define CODEC_FLAG2_LOCAL_HEADER  AV_CODEC_FLAG2_LOCAL_HEADER
1107 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1108 #define CODEC_FLAG2_IGNORE_CROP   AV_CODEC_FLAG2_IGNORE_CROP
1109
1110 #define CODEC_FLAG2_CHUNKS        AV_CODEC_FLAG2_CHUNKS
1111 #define CODEC_FLAG2_SHOW_ALL      AV_CODEC_FLAG2_SHOW_ALL
1112 #define CODEC_FLAG2_EXPORT_MVS    AV_CODEC_FLAG2_EXPORT_MVS
1113 #define CODEC_FLAG2_SKIP_MANUAL   AV_CODEC_FLAG2_SKIP_MANUAL
1114
1115 /* Unsupported options :
1116  *              Syntax Arithmetic coding (SAC)
1117  *              Reference Picture Selection
1118  *              Independent Segment Decoding */
1119 /* /Fx */
1120 /* codec capabilities */
1121
1122 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1123 /**
1124  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1125  * If not set, it might not use get_buffer() at all or use operations that
1126  * assume the buffer was allocated by avcodec_default_get_buffer.
1127  */
1128 #define CODEC_CAP_DR1             AV_CODEC_CAP_DR1
1129 #define CODEC_CAP_TRUNCATED       AV_CODEC_CAP_TRUNCATED
1130 #if FF_API_XVMC
1131 /* Codec can export data for HW decoding. This flag indicates that
1132  * the codec would call get_format() with list that might contain HW accelerated
1133  * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1134  * including raw image format.
1135  * The application can use the passed context to determine bitstream version,
1136  * chroma format, resolution etc.
1137  */
1138 #define CODEC_CAP_HWACCEL         0x0010
1139 #endif /* FF_API_XVMC */
1140 /**
1141  * Encoder or decoder requires flushing with NULL input at the end in order to
1142  * give the complete and correct output.
1143  *
1144  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1145  *       with NULL data. The user can still send NULL data to the public encode
1146  *       or decode function, but libavcodec will not pass it along to the codec
1147  *       unless this flag is set.
1148  *
1149  * Decoders:
1150  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1151  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1152  * returns frames.
1153  *
1154  * Encoders:
1155  * The encoder needs to be fed with NULL data at the end of encoding until the
1156  * encoder no longer returns data.
1157  *
1158  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1159  *       flag also means that the encoder must set the pts and duration for
1160  *       each output packet. If this flag is not set, the pts and duration will
1161  *       be determined by libavcodec from the input frame.
1162  */
1163 #define CODEC_CAP_DELAY           AV_CODEC_CAP_DELAY
1164 /**
1165  * Codec can be fed a final frame with a smaller size.
1166  * This can be used to prevent truncation of the last audio samples.
1167  */
1168 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1169 #if FF_API_CAP_VDPAU
1170 /**
1171  * Codec can export data for HW decoding (VDPAU).
1172  */
1173 #define CODEC_CAP_HWACCEL_VDPAU    AV_CODEC_CAP_HWACCEL_VDPAU
1174 #endif
1175 /**
1176  * Codec can output multiple frames per AVPacket
1177  * Normally demuxers return one frame at a time, demuxers which do not do
1178  * are connected to a parser to split what they return into proper frames.
1179  * This flag is reserved to the very rare category of codecs which have a
1180  * bitstream that cannot be split into frames without timeconsuming
1181  * operations like full decoding. Demuxers carrying such bitstreams thus
1182  * may return multiple frames in a packet. This has many disadvantages like
1183  * prohibiting stream copy in many cases thus it should only be considered
1184  * as a last resort.
1185  */
1186 #define CODEC_CAP_SUBFRAMES        AV_CODEC_CAP_SUBFRAMES
1187 /**
1188  * Codec is experimental and is thus avoided in favor of non experimental
1189  * encoders
1190  */
1191 #define CODEC_CAP_EXPERIMENTAL     AV_CODEC_CAP_EXPERIMENTAL
1192 /**
1193  * Codec should fill in channel configuration and samplerate instead of container
1194  */
1195 #define CODEC_CAP_CHANNEL_CONF     AV_CODEC_CAP_CHANNEL_CONF
1196 #if FF_API_NEG_LINESIZES
1197 /**
1198  * @deprecated no codecs use this capability
1199  */
1200 #define CODEC_CAP_NEG_LINESIZES    0x0800
1201 #endif
1202 /**
1203  * Codec supports frame-level multithreading.
1204  */
1205 #define CODEC_CAP_FRAME_THREADS    AV_CODEC_CAP_FRAME_THREADS
1206 /**
1207  * Codec supports slice-based (or partition-based) multithreading.
1208  */
1209 #define CODEC_CAP_SLICE_THREADS    AV_CODEC_CAP_SLICE_THREADS
1210 /**
1211  * Codec supports changed parameters at any point.
1212  */
1213 #define CODEC_CAP_PARAM_CHANGE     AV_CODEC_CAP_PARAM_CHANGE
1214 /**
1215  * Codec supports avctx->thread_count == 0 (auto).
1216  */
1217 #define CODEC_CAP_AUTO_THREADS     AV_CODEC_CAP_AUTO_THREADS
1218 /**
1219  * Audio encoder supports receiving a different number of samples in each call.
1220  */
1221 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1222 /**
1223  * Codec is intra only.
1224  */
1225 #define CODEC_CAP_INTRA_ONLY       AV_CODEC_CAP_INTRA_ONLY
1226 /**
1227  * Codec is lossless.
1228  */
1229 #define CODEC_CAP_LOSSLESS         AV_CODEC_CAP_LOSSLESS
1230
1231 /**
1232  * HWAccel is experimental and is thus avoided in favor of non experimental
1233  * codecs
1234  */
1235 #define HWACCEL_CODEC_CAP_EXPERIMENTAL     0x0200
1236 #endif /* FF_API_WITHOUT_PREFIX */
1237
1238 #if FF_API_MB_TYPE
1239 //The following defines may change, don't expect compatibility if you use them.
1240 #define MB_TYPE_INTRA4x4   0x0001
1241 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1242 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1243 #define MB_TYPE_16x16      0x0008
1244 #define MB_TYPE_16x8       0x0010
1245 #define MB_TYPE_8x16       0x0020
1246 #define MB_TYPE_8x8        0x0040
1247 #define MB_TYPE_INTERLACED 0x0080
1248 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1249 #define MB_TYPE_ACPRED     0x0200
1250 #define MB_TYPE_GMC        0x0400
1251 #define MB_TYPE_SKIP       0x0800
1252 #define MB_TYPE_P0L0       0x1000
1253 #define MB_TYPE_P1L0       0x2000
1254 #define MB_TYPE_P0L1       0x4000
1255 #define MB_TYPE_P1L1       0x8000
1256 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1257 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1258 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1259 #define MB_TYPE_QUANT      0x00010000
1260 #define MB_TYPE_CBP        0x00020000
1261 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1262 #endif
1263
1264 /**
1265  * Pan Scan area.
1266  * This specifies the area which should be displayed.
1267  * Note there may be multiple such areas for one frame.
1268  */
1269 typedef struct AVPanScan{
1270     /**
1271      * id
1272      * - encoding: Set by user.
1273      * - decoding: Set by libavcodec.
1274      */
1275     int id;
1276
1277     /**
1278      * width and height in 1/16 pel
1279      * - encoding: Set by user.
1280      * - decoding: Set by libavcodec.
1281      */
1282     int width;
1283     int height;
1284
1285     /**
1286      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1287      * - encoding: Set by user.
1288      * - decoding: Set by libavcodec.
1289      */
1290     int16_t position[3][2];
1291 }AVPanScan;
1292
1293 /**
1294  * This structure describes the bitrate properties of an encoded bitstream. It
1295  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1296  * parameters for H.264/HEVC.
1297  */
1298 typedef struct AVCPBProperties {
1299     /**
1300      * Maximum bitrate of the stream, in bits per second.
1301      * Zero if unknown or unspecified.
1302      */
1303     int max_bitrate;
1304     /**
1305      * Minimum bitrate of the stream, in bits per second.
1306      * Zero if unknown or unspecified.
1307      */
1308     int min_bitrate;
1309     /**
1310      * Average bitrate of the stream, in bits per second.
1311      * Zero if unknown or unspecified.
1312      */
1313     int avg_bitrate;
1314
1315     /**
1316      * The size of the buffer to which the ratecontrol is applied, in bits.
1317      * Zero if unknown or unspecified.
1318      */
1319     int buffer_size;
1320
1321     /**
1322      * The delay between the time the packet this structure is associated with
1323      * is received and the time when it should be decoded, in periods of a 27MHz
1324      * clock.
1325      *
1326      * UINT64_MAX when unknown or unspecified.
1327      */
1328     uint64_t vbv_delay;
1329 } AVCPBProperties;
1330
1331 #if FF_API_QSCALE_TYPE
1332 #define FF_QSCALE_TYPE_MPEG1 0
1333 #define FF_QSCALE_TYPE_MPEG2 1
1334 #define FF_QSCALE_TYPE_H264  2
1335 #define FF_QSCALE_TYPE_VP56  3
1336 #endif
1337
1338 /**
1339  * The decoder will keep a reference to the frame and may reuse it later.
1340  */
1341 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1342
1343 /**
1344  * @defgroup lavc_packet AVPacket
1345  *
1346  * Types and functions for working with AVPacket.
1347  * @{
1348  */
1349 enum AVPacketSideDataType {
1350     AV_PKT_DATA_PALETTE,
1351
1352     /**
1353      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1354      * that the extradata buffer was changed and the receiving side should
1355      * act upon it appropriately. The new extradata is embedded in the side
1356      * data buffer and should be immediately used for processing the current
1357      * frame or packet.
1358      */
1359     AV_PKT_DATA_NEW_EXTRADATA,
1360
1361     /**
1362      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1363      * @code
1364      * u32le param_flags
1365      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1366      *     s32le channel_count
1367      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1368      *     u64le channel_layout
1369      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1370      *     s32le sample_rate
1371      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1372      *     s32le width
1373      *     s32le height
1374      * @endcode
1375      */
1376     AV_PKT_DATA_PARAM_CHANGE,
1377
1378     /**
1379      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1380      * structures with info about macroblocks relevant to splitting the
1381      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1382      * That is, it does not necessarily contain info about all macroblocks,
1383      * as long as the distance between macroblocks in the info is smaller
1384      * than the target payload size.
1385      * Each MB info structure is 12 bytes, and is laid out as follows:
1386      * @code
1387      * u32le bit offset from the start of the packet
1388      * u8    current quantizer at the start of the macroblock
1389      * u8    GOB number
1390      * u16le macroblock address within the GOB
1391      * u8    horizontal MV predictor
1392      * u8    vertical MV predictor
1393      * u8    horizontal MV predictor for block number 3
1394      * u8    vertical MV predictor for block number 3
1395      * @endcode
1396      */
1397     AV_PKT_DATA_H263_MB_INFO,
1398
1399     /**
1400      * This side data should be associated with an audio stream and contains
1401      * ReplayGain information in form of the AVReplayGain struct.
1402      */
1403     AV_PKT_DATA_REPLAYGAIN,
1404
1405     /**
1406      * This side data contains a 3x3 transformation matrix describing an affine
1407      * transformation that needs to be applied to the decoded video frames for
1408      * correct presentation.
1409      *
1410      * See libavutil/display.h for a detailed description of the data.
1411      */
1412     AV_PKT_DATA_DISPLAYMATRIX,
1413
1414     /**
1415      * This side data should be associated with a video stream and contains
1416      * Stereoscopic 3D information in form of the AVStereo3D struct.
1417      */
1418     AV_PKT_DATA_STEREO3D,
1419
1420     /**
1421      * This side data should be associated with an audio stream and corresponds
1422      * to enum AVAudioServiceType.
1423      */
1424     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1425
1426     /**
1427      * This side data contains quality related information from the encoder.
1428      * @code
1429      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1430      * u8    picture type
1431      * u8    error count
1432      * u16   reserved
1433      * u64le[error count] sum of squared differences between encoder in and output
1434      * @endcode
1435      */
1436     AV_PKT_DATA_QUALITY_STATS,
1437
1438     /**
1439      * This side data contains an integer value representing the stream index
1440      * of a "fallback" track.  A fallback track indicates an alternate
1441      * track to use when the current track can not be decoded for some reason.
1442      * e.g. no decoder available for codec.
1443      */
1444     AV_PKT_DATA_FALLBACK_TRACK,
1445
1446     /**
1447      * This side data corresponds to the AVCPBProperties struct.
1448      */
1449     AV_PKT_DATA_CPB_PROPERTIES,
1450
1451     /**
1452      * Recommmends skipping the specified number of samples
1453      * @code
1454      * u32le number of samples to skip from start of this packet
1455      * u32le number of samples to skip from end of this packet
1456      * u8    reason for start skip
1457      * u8    reason for end   skip (0=padding silence, 1=convergence)
1458      * @endcode
1459      */
1460     AV_PKT_DATA_SKIP_SAMPLES=70,
1461
1462     /**
1463      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1464      * the packet may contain "dual mono" audio specific to Japanese DTV
1465      * and if it is true, recommends only the selected channel to be used.
1466      * @code
1467      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1468      * @endcode
1469      */
1470     AV_PKT_DATA_JP_DUALMONO,
1471
1472     /**
1473      * A list of zero terminated key/value strings. There is no end marker for
1474      * the list, so it is required to rely on the side data size to stop.
1475      */
1476     AV_PKT_DATA_STRINGS_METADATA,
1477
1478     /**
1479      * Subtitle event position
1480      * @code
1481      * u32le x1
1482      * u32le y1
1483      * u32le x2
1484      * u32le y2
1485      * @endcode
1486      */
1487     AV_PKT_DATA_SUBTITLE_POSITION,
1488
1489     /**
1490      * Data found in BlockAdditional element of matroska container. There is
1491      * no end marker for the data, so it is required to rely on the side data
1492      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1493      * by data.
1494      */
1495     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1496
1497     /**
1498      * The optional first identifier line of a WebVTT cue.
1499      */
1500     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1501
1502     /**
1503      * The optional settings (rendering instructions) that immediately
1504      * follow the timestamp specifier of a WebVTT cue.
1505      */
1506     AV_PKT_DATA_WEBVTT_SETTINGS,
1507
1508     /**
1509      * A list of zero terminated key/value strings. There is no end marker for
1510      * the list, so it is required to rely on the side data size to stop. This
1511      * side data includes updated metadata which appeared in the stream.
1512      */
1513     AV_PKT_DATA_METADATA_UPDATE,
1514
1515     /**
1516      * MPEGTS stream ID, this is required to pass the stream ID
1517      * information from the demuxer to the corresponding muxer.
1518      */
1519     AV_PKT_DATA_MPEGTS_STREAM_ID,
1520
1521     /**
1522      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1523      * should be associated with a video stream and containts data in the form
1524      * of the AVMasteringDisplayMetadata struct.
1525      */
1526     AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1527 };
1528
1529 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1530
1531 typedef struct AVPacketSideData {
1532     uint8_t *data;
1533     int      size;
1534     enum AVPacketSideDataType type;
1535 } AVPacketSideData;
1536
1537 /**
1538  * This structure stores compressed data. It is typically exported by demuxers
1539  * and then passed as input to decoders, or received as output from encoders and
1540  * then passed to muxers.
1541  *
1542  * For video, it should typically contain one compressed frame. For audio it may
1543  * contain several compressed frames. Encoders are allowed to output empty
1544  * packets, with no compressed data, containing only side data
1545  * (e.g. to update some stream parameters at the end of encoding).
1546  *
1547  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1548  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1549  * without libavcodec and libavformat major bump.
1550  *
1551  * The semantics of data ownership depends on the buf field.
1552  * If it is set, the packet data is dynamically allocated and is
1553  * valid indefinitely until a call to av_packet_unref() reduces the
1554  * reference count to 0.
1555  *
1556  * If the buf field is not set av_packet_ref() would make a copy instead
1557  * of increasing the reference count.
1558  *
1559  * The side data is always allocated with av_malloc(), copied by
1560  * av_packet_ref() and freed by av_packet_unref().
1561  *
1562  * @see av_packet_ref
1563  * @see av_packet_unref
1564  */
1565 typedef struct AVPacket {
1566     /**
1567      * A reference to the reference-counted buffer where the packet data is
1568      * stored.
1569      * May be NULL, then the packet data is not reference-counted.
1570      */
1571     AVBufferRef *buf;
1572     /**
1573      * Presentation timestamp in AVStream->time_base units; the time at which
1574      * the decompressed packet will be presented to the user.
1575      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1576      * pts MUST be larger or equal to dts as presentation cannot happen before
1577      * decompression, unless one wants to view hex dumps. Some formats misuse
1578      * the terms dts and pts/cts to mean something different. Such timestamps
1579      * must be converted to true pts/dts before they are stored in AVPacket.
1580      */
1581     int64_t pts;
1582     /**
1583      * Decompression timestamp in AVStream->time_base units; the time at which
1584      * the packet is decompressed.
1585      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1586      */
1587     int64_t dts;
1588     uint8_t *data;
1589     int   size;
1590     int   stream_index;
1591     /**
1592      * A combination of AV_PKT_FLAG values
1593      */
1594     int   flags;
1595     /**
1596      * Additional packet data that can be provided by the container.
1597      * Packet can contain several types of side information.
1598      */
1599     AVPacketSideData *side_data;
1600     int side_data_elems;
1601
1602     /**
1603      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1604      * Equals next_pts - this_pts in presentation order.
1605      */
1606     int64_t duration;
1607
1608     int64_t pos;                            ///< byte position in stream, -1 if unknown
1609
1610 #if FF_API_CONVERGENCE_DURATION
1611     /**
1612      * @deprecated Same as the duration field, but as int64_t. This was required
1613      * for Matroska subtitles, whose duration values could overflow when the
1614      * duration field was still an int.
1615      */
1616     attribute_deprecated
1617     int64_t convergence_duration;
1618 #endif
1619 } AVPacket;
1620 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1621 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1622
1623 enum AVSideDataParamChangeFlags {
1624     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1625     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1626     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1627     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1628 };
1629 /**
1630  * @}
1631  */
1632
1633 struct AVCodecInternal;
1634
1635 enum AVFieldOrder {
1636     AV_FIELD_UNKNOWN,
1637     AV_FIELD_PROGRESSIVE,
1638     AV_FIELD_TT,          //< Top coded_first, top displayed first
1639     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1640     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1641     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1642 };
1643
1644 /**
1645  * main external API structure.
1646  * New fields can be added to the end with minor version bumps.
1647  * Removal, reordering and changes to existing fields require a major
1648  * version bump.
1649  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1650  * applications.
1651  * The name string for AVOptions options matches the associated command line
1652  * parameter name and can be found in libavcodec/options_table.h
1653  * The AVOption/command line parameter names differ in some cases from the C
1654  * structure field names for historic reasons or brevity.
1655  * sizeof(AVCodecContext) must not be used outside libav*.
1656  */
1657 typedef struct AVCodecContext {
1658     /**
1659      * information on struct for av_log
1660      * - set by avcodec_alloc_context3
1661      */
1662     const AVClass *av_class;
1663     int log_level_offset;
1664
1665     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1666     const struct AVCodec  *codec;
1667 #if FF_API_CODEC_NAME
1668     /**
1669      * @deprecated this field is not used for anything in libavcodec
1670      */
1671     attribute_deprecated
1672     char             codec_name[32];
1673 #endif
1674     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1675
1676     /**
1677      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1678      * This is used to work around some encoder bugs.
1679      * A demuxer should set this to what is stored in the field used to identify the codec.
1680      * If there are multiple such fields in a container then the demuxer should choose the one
1681      * which maximizes the information about the used codec.
1682      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1683      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1684      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1685      * first.
1686      * - encoding: Set by user, if not then the default based on codec_id will be used.
1687      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1688      */
1689     unsigned int codec_tag;
1690
1691 #if FF_API_STREAM_CODEC_TAG
1692     /**
1693      * @deprecated this field is unused
1694      */
1695     attribute_deprecated
1696     unsigned int stream_codec_tag;
1697 #endif
1698
1699     void *priv_data;
1700
1701     /**
1702      * Private context used for internal data.
1703      *
1704      * Unlike priv_data, this is not codec-specific. It is used in general
1705      * libavcodec functions.
1706      */
1707     struct AVCodecInternal *internal;
1708
1709     /**
1710      * Private data of the user, can be used to carry app specific stuff.
1711      * - encoding: Set by user.
1712      * - decoding: Set by user.
1713      */
1714     void *opaque;
1715
1716     /**
1717      * the average bitrate
1718      * - encoding: Set by user; unused for constant quantizer encoding.
1719      * - decoding: Set by user, may be overwritten by libavcodec
1720      *             if this info is available in the stream
1721      */
1722     int64_t bit_rate;
1723
1724     /**
1725      * number of bits the bitstream is allowed to diverge from the reference.
1726      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1727      * - encoding: Set by user; unused for constant quantizer encoding.
1728      * - decoding: unused
1729      */
1730     int bit_rate_tolerance;
1731
1732     /**
1733      * Global quality for codecs which cannot change it per frame.
1734      * This should be proportional to MPEG-1/2/4 qscale.
1735      * - encoding: Set by user.
1736      * - decoding: unused
1737      */
1738     int global_quality;
1739
1740     /**
1741      * - encoding: Set by user.
1742      * - decoding: unused
1743      */
1744     int compression_level;
1745 #define FF_COMPRESSION_DEFAULT -1
1746
1747     /**
1748      * AV_CODEC_FLAG_*.
1749      * - encoding: Set by user.
1750      * - decoding: Set by user.
1751      */
1752     int flags;
1753
1754     /**
1755      * AV_CODEC_FLAG2_*
1756      * - encoding: Set by user.
1757      * - decoding: Set by user.
1758      */
1759     int flags2;
1760
1761     /**
1762      * some codecs need / can use extradata like Huffman tables.
1763      * MJPEG: Huffman tables
1764      * rv10: additional flags
1765      * MPEG-4: global headers (they can be in the bitstream or here)
1766      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1767      * than extradata_size to avoid problems if it is read with the bitstream reader.
1768      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1769      * - encoding: Set/allocated/freed by libavcodec.
1770      * - decoding: Set/allocated/freed by user.
1771      */
1772     uint8_t *extradata;
1773     int extradata_size;
1774
1775     /**
1776      * This is the fundamental unit of time (in seconds) in terms
1777      * of which frame timestamps are represented. For fixed-fps content,
1778      * timebase should be 1/framerate and timestamp increments should be
1779      * identically 1.
1780      * This often, but not always is the inverse of the frame rate or field rate
1781      * for video. 1/time_base is not the average frame rate if the frame rate is not
1782      * constant.
1783      *
1784      * Like containers, elementary streams also can store timestamps, 1/time_base
1785      * is the unit in which these timestamps are specified.
1786      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1787      * vop_time_increment_resolution and fixed_vop_rate
1788      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1789      *
1790      * - encoding: MUST be set by user.
1791      * - decoding: the use of this field for decoding is deprecated.
1792      *             Use framerate instead.
1793      */
1794     AVRational time_base;
1795
1796     /**
1797      * For some codecs, the time base is closer to the field rate than the frame rate.
1798      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1799      * if no telecine is used ...
1800      *
1801      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1802      */
1803     int ticks_per_frame;
1804
1805     /**
1806      * Codec delay.
1807      *
1808      * Encoding: Number of frames delay there will be from the encoder input to
1809      *           the decoder output. (we assume the decoder matches the spec)
1810      * Decoding: Number of frames delay in addition to what a standard decoder
1811      *           as specified in the spec would produce.
1812      *
1813      * Video:
1814      *   Number of frames the decoded output will be delayed relative to the
1815      *   encoded input.
1816      *
1817      * Audio:
1818      *   For encoding, this field is unused (see initial_padding).
1819      *
1820      *   For decoding, this is the number of samples the decoder needs to
1821      *   output before the decoder's output is valid. When seeking, you should
1822      *   start decoding this many samples prior to your desired seek point.
1823      *
1824      * - encoding: Set by libavcodec.
1825      * - decoding: Set by libavcodec.
1826      */
1827     int delay;
1828
1829
1830     /* video only */
1831     /**
1832      * picture width / height.
1833      *
1834      * @note Those fields may not match the values of the last
1835      * AVFrame output by avcodec_decode_video2 due frame
1836      * reordering.
1837      *
1838      * - encoding: MUST be set by user.
1839      * - decoding: May be set by the user before opening the decoder if known e.g.
1840      *             from the container. Some decoders will require the dimensions
1841      *             to be set by the caller. During decoding, the decoder may
1842      *             overwrite those values as required while parsing the data.
1843      */
1844     int width, height;
1845
1846     /**
1847      * Bitstream width / height, may be different from width/height e.g. when
1848      * the decoded frame is cropped before being output or lowres is enabled.
1849      *
1850      * @note Those field may not match the value of the last
1851      * AVFrame output by avcodec_receive_frame() due frame
1852      * reordering.
1853      *
1854      * - encoding: unused
1855      * - decoding: May be set by the user before opening the decoder if known
1856      *             e.g. from the container. During decoding, the decoder may
1857      *             overwrite those values as required while parsing the data.
1858      */
1859     int coded_width, coded_height;
1860
1861 #if FF_API_ASPECT_EXTENDED
1862 #define FF_ASPECT_EXTENDED 15
1863 #endif
1864
1865     /**
1866      * the number of pictures in a group of pictures, or 0 for intra_only
1867      * - encoding: Set by user.
1868      * - decoding: unused
1869      */
1870     int gop_size;
1871
1872     /**
1873      * Pixel format, see AV_PIX_FMT_xxx.
1874      * May be set by the demuxer if known from headers.
1875      * May be overridden by the decoder if it knows better.
1876      *
1877      * @note This field may not match the value of the last
1878      * AVFrame output by avcodec_receive_frame() due frame
1879      * reordering.
1880      *
1881      * - encoding: Set by user.
1882      * - decoding: Set by user if known, overridden by libavcodec while
1883      *             parsing the data.
1884      */
1885     enum AVPixelFormat pix_fmt;
1886
1887 #if FF_API_MOTION_EST
1888     /**
1889      * This option does nothing
1890      * @deprecated use codec private options instead
1891      */
1892     attribute_deprecated int me_method;
1893 #endif
1894
1895     /**
1896      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1897      * decoder to draw a horizontal band. It improves cache usage. Not
1898      * all codecs can do that. You must check the codec capabilities
1899      * beforehand.
1900      * When multithreading is used, it may be called from multiple threads
1901      * at the same time; threads might draw different parts of the same AVFrame,
1902      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1903      * in order.
1904      * The function is also used by hardware acceleration APIs.
1905      * It is called at least once during frame decoding to pass
1906      * the data needed for hardware render.
1907      * In that mode instead of pixel data, AVFrame points to
1908      * a structure specific to the acceleration API. The application
1909      * reads the structure and can change some fields to indicate progress
1910      * or mark state.
1911      * - encoding: unused
1912      * - decoding: Set by user.
1913      * @param height the height of the slice
1914      * @param y the y position of the slice
1915      * @param type 1->top field, 2->bottom field, 3->frame
1916      * @param offset offset into the AVFrame.data from which the slice should be read
1917      */
1918     void (*draw_horiz_band)(struct AVCodecContext *s,
1919                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1920                             int y, int type, int height);
1921
1922     /**
1923      * callback to negotiate the pixelFormat
1924      * @param fmt is the list of formats which are supported by the codec,
1925      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1926      * The first is always the native one.
1927      * @note The callback may be called again immediately if initialization for
1928      * the selected (hardware-accelerated) pixel format failed.
1929      * @warning Behavior is undefined if the callback returns a value not
1930      * in the fmt list of formats.
1931      * @return the chosen format
1932      * - encoding: unused
1933      * - decoding: Set by user, if not set the native format will be chosen.
1934      */
1935     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1936
1937     /**
1938      * maximum number of B-frames between non-B-frames
1939      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1940      * - encoding: Set by user.
1941      * - decoding: unused
1942      */
1943     int max_b_frames;
1944
1945     /**
1946      * qscale factor between IP and B-frames
1947      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1948      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     float b_quant_factor;
1953
1954 #if FF_API_RC_STRATEGY
1955     /** @deprecated use codec private option instead */
1956     attribute_deprecated int rc_strategy;
1957 #define FF_RC_STRATEGY_XVID 1
1958 #endif
1959
1960 #if FF_API_PRIVATE_OPT
1961     /** @deprecated use encoder private options instead */
1962     attribute_deprecated
1963     int b_frame_strategy;
1964 #endif
1965
1966     /**
1967      * qscale offset between IP and B-frames
1968      * - encoding: Set by user.
1969      * - decoding: unused
1970      */
1971     float b_quant_offset;
1972
1973     /**
1974      * Size of the frame reordering buffer in the decoder.
1975      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1976      * - encoding: Set by libavcodec.
1977      * - decoding: Set by libavcodec.
1978      */
1979     int has_b_frames;
1980
1981 #if FF_API_PRIVATE_OPT
1982     /** @deprecated use encoder private options instead */
1983     attribute_deprecated
1984     int mpeg_quant;
1985 #endif
1986
1987     /**
1988      * qscale factor between P- and I-frames
1989      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1990      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1991      * - encoding: Set by user.
1992      * - decoding: unused
1993      */
1994     float i_quant_factor;
1995
1996     /**
1997      * qscale offset between P and I-frames
1998      * - encoding: Set by user.
1999      * - decoding: unused
2000      */
2001     float i_quant_offset;
2002
2003     /**
2004      * luminance masking (0-> disabled)
2005      * - encoding: Set by user.
2006      * - decoding: unused
2007      */
2008     float lumi_masking;
2009
2010     /**
2011      * temporary complexity masking (0-> disabled)
2012      * - encoding: Set by user.
2013      * - decoding: unused
2014      */
2015     float temporal_cplx_masking;
2016
2017     /**
2018      * spatial complexity masking (0-> disabled)
2019      * - encoding: Set by user.
2020      * - decoding: unused
2021      */
2022     float spatial_cplx_masking;
2023
2024     /**
2025      * p block masking (0-> disabled)
2026      * - encoding: Set by user.
2027      * - decoding: unused
2028      */
2029     float p_masking;
2030
2031     /**
2032      * darkness masking (0-> disabled)
2033      * - encoding: Set by user.
2034      * - decoding: unused
2035      */
2036     float dark_masking;
2037
2038     /**
2039      * slice count
2040      * - encoding: Set by libavcodec.
2041      * - decoding: Set by user (or 0).
2042      */
2043     int slice_count;
2044
2045 #if FF_API_PRIVATE_OPT
2046     /** @deprecated use encoder private options instead */
2047     attribute_deprecated
2048      int prediction_method;
2049 #define FF_PRED_LEFT   0
2050 #define FF_PRED_PLANE  1
2051 #define FF_PRED_MEDIAN 2
2052 #endif
2053
2054     /**
2055      * slice offsets in the frame in bytes
2056      * - encoding: Set/allocated by libavcodec.
2057      * - decoding: Set/allocated by user (or NULL).
2058      */
2059     int *slice_offset;
2060
2061     /**
2062      * sample aspect ratio (0 if unknown)
2063      * That is the width of a pixel divided by the height of the pixel.
2064      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2065      * - encoding: Set by user.
2066      * - decoding: Set by libavcodec.
2067      */
2068     AVRational sample_aspect_ratio;
2069
2070     /**
2071      * motion estimation comparison function
2072      * - encoding: Set by user.
2073      * - decoding: unused
2074      */
2075     int me_cmp;
2076     /**
2077      * subpixel motion estimation comparison function
2078      * - encoding: Set by user.
2079      * - decoding: unused
2080      */
2081     int me_sub_cmp;
2082     /**
2083      * macroblock comparison function (not supported yet)
2084      * - encoding: Set by user.
2085      * - decoding: unused
2086      */
2087     int mb_cmp;
2088     /**
2089      * interlaced DCT comparison function
2090      * - encoding: Set by user.
2091      * - decoding: unused
2092      */
2093     int ildct_cmp;
2094 #define FF_CMP_SAD    0
2095 #define FF_CMP_SSE    1
2096 #define FF_CMP_SATD   2
2097 #define FF_CMP_DCT    3
2098 #define FF_CMP_PSNR   4
2099 #define FF_CMP_BIT    5
2100 #define FF_CMP_RD     6
2101 #define FF_CMP_ZERO   7
2102 #define FF_CMP_VSAD   8
2103 #define FF_CMP_VSSE   9
2104 #define FF_CMP_NSSE   10
2105 #define FF_CMP_W53    11
2106 #define FF_CMP_W97    12
2107 #define FF_CMP_DCTMAX 13
2108 #define FF_CMP_DCT264 14
2109 #define FF_CMP_CHROMA 256
2110
2111     /**
2112      * ME diamond size & shape
2113      * - encoding: Set by user.
2114      * - decoding: unused
2115      */
2116     int dia_size;
2117
2118     /**
2119      * amount of previous MV predictors (2a+1 x 2a+1 square)
2120      * - encoding: Set by user.
2121      * - decoding: unused
2122      */
2123     int last_predictor_count;
2124
2125 #if FF_API_PRIVATE_OPT
2126     /** @deprecated use encoder private options instead */
2127     attribute_deprecated
2128     int pre_me;
2129 #endif
2130
2131     /**
2132      * motion estimation prepass comparison function
2133      * - encoding: Set by user.
2134      * - decoding: unused
2135      */
2136     int me_pre_cmp;
2137
2138     /**
2139      * ME prepass diamond size & shape
2140      * - encoding: Set by user.
2141      * - decoding: unused
2142      */
2143     int pre_dia_size;
2144
2145     /**
2146      * subpel ME quality
2147      * - encoding: Set by user.
2148      * - decoding: unused
2149      */
2150     int me_subpel_quality;
2151
2152 #if FF_API_AFD
2153     /**
2154      * DTG active format information (additional aspect ratio
2155      * information only used in DVB MPEG-2 transport streams)
2156      * 0 if not set.
2157      *
2158      * - encoding: unused
2159      * - decoding: Set by decoder.
2160      * @deprecated Deprecated in favor of AVSideData
2161      */
2162     attribute_deprecated int dtg_active_format;
2163 #define FF_DTG_AFD_SAME         8
2164 #define FF_DTG_AFD_4_3          9
2165 #define FF_DTG_AFD_16_9         10
2166 #define FF_DTG_AFD_14_9         11
2167 #define FF_DTG_AFD_4_3_SP_14_9  13
2168 #define FF_DTG_AFD_16_9_SP_14_9 14
2169 #define FF_DTG_AFD_SP_4_3       15
2170 #endif /* FF_API_AFD */
2171
2172     /**
2173      * maximum motion estimation search range in subpel units
2174      * If 0 then no limit.
2175      *
2176      * - encoding: Set by user.
2177      * - decoding: unused
2178      */
2179     int me_range;
2180
2181 #if FF_API_QUANT_BIAS
2182     /**
2183      * @deprecated use encoder private option instead
2184      */
2185     attribute_deprecated int intra_quant_bias;
2186 #define FF_DEFAULT_QUANT_BIAS 999999
2187
2188     /**
2189      * @deprecated use encoder private option instead
2190      */
2191     attribute_deprecated int inter_quant_bias;
2192 #endif
2193
2194     /**
2195      * slice flags
2196      * - encoding: unused
2197      * - decoding: Set by user.
2198      */
2199     int slice_flags;
2200 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2201 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2202 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2203
2204 #if FF_API_XVMC
2205     /**
2206      * XVideo Motion Acceleration
2207      * - encoding: forbidden
2208      * - decoding: set by decoder
2209      * @deprecated XvMC doesn't need it anymore.
2210      */
2211     attribute_deprecated int xvmc_acceleration;
2212 #endif /* FF_API_XVMC */
2213
2214     /**
2215      * macroblock decision mode
2216      * - encoding: Set by user.
2217      * - decoding: unused
2218      */
2219     int mb_decision;
2220 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2221 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2222 #define FF_MB_DECISION_RD     2        ///< rate distortion
2223
2224     /**
2225      * custom intra quantization matrix
2226      * - encoding: Set by user, can be NULL.
2227      * - decoding: Set by libavcodec.
2228      */
2229     uint16_t *intra_matrix;
2230
2231     /**
2232      * custom inter quantization matrix
2233      * - encoding: Set by user, can be NULL.
2234      * - decoding: Set by libavcodec.
2235      */
2236     uint16_t *inter_matrix;
2237
2238 #if FF_API_PRIVATE_OPT
2239     /** @deprecated use encoder private options instead */
2240     attribute_deprecated
2241     int scenechange_threshold;
2242
2243     /** @deprecated use encoder private options instead */
2244     attribute_deprecated
2245     int noise_reduction;
2246 #endif
2247
2248 #if FF_API_MPV_OPT
2249     /**
2250      * @deprecated this field is unused
2251      */
2252     attribute_deprecated
2253     int me_threshold;
2254
2255     /**
2256      * @deprecated this field is unused
2257      */
2258     attribute_deprecated
2259     int mb_threshold;
2260 #endif
2261
2262     /**
2263      * precision of the intra DC coefficient - 8
2264      * - encoding: Set by user.
2265      * - decoding: Set by libavcodec
2266      */
2267     int intra_dc_precision;
2268
2269     /**
2270      * Number of macroblock rows at the top which are skipped.
2271      * - encoding: unused
2272      * - decoding: Set by user.
2273      */
2274     int skip_top;
2275
2276     /**
2277      * Number of macroblock rows at the bottom which are skipped.
2278      * - encoding: unused
2279      * - decoding: Set by user.
2280      */
2281     int skip_bottom;
2282
2283 #if FF_API_MPV_OPT
2284     /**
2285      * @deprecated use encoder private options instead
2286      */
2287     attribute_deprecated
2288     float border_masking;
2289 #endif
2290
2291     /**
2292      * minimum MB Lagrange multiplier
2293      * - encoding: Set by user.
2294      * - decoding: unused
2295      */
2296     int mb_lmin;
2297
2298     /**
2299      * maximum MB Lagrange multiplier
2300      * - encoding: Set by user.
2301      * - decoding: unused
2302      */
2303     int mb_lmax;
2304
2305 #if FF_API_PRIVATE_OPT
2306     /**
2307      * @deprecated use encoder private options instead
2308      */
2309     attribute_deprecated
2310     int me_penalty_compensation;
2311 #endif
2312
2313     /**
2314      * - encoding: Set by user.
2315      * - decoding: unused
2316      */
2317     int bidir_refine;
2318
2319 #if FF_API_PRIVATE_OPT
2320     /** @deprecated use encoder private options instead */
2321     attribute_deprecated
2322     int brd_scale;
2323 #endif
2324
2325     /**
2326      * minimum GOP size
2327      * - encoding: Set by user.
2328      * - decoding: unused
2329      */
2330     int keyint_min;
2331
2332     /**
2333      * number of reference frames
2334      * - encoding: Set by user.
2335      * - decoding: Set by lavc.
2336      */
2337     int refs;
2338
2339 #if FF_API_PRIVATE_OPT
2340     /** @deprecated use encoder private options instead */
2341     attribute_deprecated
2342     int chromaoffset;
2343 #endif
2344
2345 #if FF_API_UNUSED_MEMBERS
2346     /**
2347      * Multiplied by qscale for each frame and added to scene_change_score.
2348      * - encoding: Set by user.
2349      * - decoding: unused
2350      */
2351     attribute_deprecated int scenechange_factor;
2352 #endif
2353
2354     /**
2355      * Note: Value depends upon the compare function used for fullpel ME.
2356      * - encoding: Set by user.
2357      * - decoding: unused
2358      */
2359     int mv0_threshold;
2360
2361 #if FF_API_PRIVATE_OPT
2362     /** @deprecated use encoder private options instead */
2363     attribute_deprecated
2364     int b_sensitivity;
2365 #endif
2366
2367     /**
2368      * Chromaticity coordinates of the source primaries.
2369      * - encoding: Set by user
2370      * - decoding: Set by libavcodec
2371      */
2372     enum AVColorPrimaries color_primaries;
2373
2374     /**
2375      * Color Transfer Characteristic.
2376      * - encoding: Set by user
2377      * - decoding: Set by libavcodec
2378      */
2379     enum AVColorTransferCharacteristic color_trc;
2380
2381     /**
2382      * YUV colorspace type.
2383      * - encoding: Set by user
2384      * - decoding: Set by libavcodec
2385      */
2386     enum AVColorSpace colorspace;
2387
2388     /**
2389      * MPEG vs JPEG YUV range.
2390      * - encoding: Set by user
2391      * - decoding: Set by libavcodec
2392      */
2393     enum AVColorRange color_range;
2394
2395     /**
2396      * This defines the location of chroma samples.
2397      * - encoding: Set by user
2398      * - decoding: Set by libavcodec
2399      */
2400     enum AVChromaLocation chroma_sample_location;
2401
2402     /**
2403      * Number of slices.
2404      * Indicates number of picture subdivisions. Used for parallelized
2405      * decoding.
2406      * - encoding: Set by user
2407      * - decoding: unused
2408      */
2409     int slices;
2410
2411     /** Field order
2412      * - encoding: set by libavcodec
2413      * - decoding: Set by user.
2414      */
2415     enum AVFieldOrder field_order;
2416
2417     /* audio only */
2418     int sample_rate; ///< samples per second
2419     int channels;    ///< number of audio channels
2420
2421     /**
2422      * audio sample format
2423      * - encoding: Set by user.
2424      * - decoding: Set by libavcodec.
2425      */
2426     enum AVSampleFormat sample_fmt;  ///< sample format
2427
2428     /* The following data should not be initialized. */
2429     /**
2430      * Number of samples per channel in an audio frame.
2431      *
2432      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2433      *   except the last must contain exactly frame_size samples per channel.
2434      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2435      *   frame size is not restricted.
2436      * - decoding: may be set by some decoders to indicate constant frame size
2437      */
2438     int frame_size;
2439
2440     /**
2441      * Frame counter, set by libavcodec.
2442      *
2443      * - decoding: total number of frames returned from the decoder so far.
2444      * - encoding: total number of frames passed to the encoder so far.
2445      *
2446      *   @note the counter is not incremented if encoding/decoding resulted in
2447      *   an error.
2448      */
2449     int frame_number;
2450
2451     /**
2452      * number of bytes per packet if constant and known or 0
2453      * Used by some WAV based audio codecs.
2454      */
2455     int block_align;
2456
2457     /**
2458      * Audio cutoff bandwidth (0 means "automatic")
2459      * - encoding: Set by user.
2460      * - decoding: unused
2461      */
2462     int cutoff;
2463
2464     /**
2465      * Audio channel layout.
2466      * - encoding: set by user.
2467      * - decoding: set by user, may be overwritten by libavcodec.
2468      */
2469     uint64_t channel_layout;
2470
2471     /**
2472      * Request decoder to use this channel layout if it can (0 for default)
2473      * - encoding: unused
2474      * - decoding: Set by user.
2475      */
2476     uint64_t request_channel_layout;
2477
2478     /**
2479      * Type of service that the audio stream conveys.
2480      * - encoding: Set by user.
2481      * - decoding: Set by libavcodec.
2482      */
2483     enum AVAudioServiceType audio_service_type;
2484
2485     /**
2486      * desired sample format
2487      * - encoding: Not used.
2488      * - decoding: Set by user.
2489      * Decoder will decode to this format if it can.
2490      */
2491     enum AVSampleFormat request_sample_fmt;
2492
2493     /**
2494      * This callback is called at the beginning of each frame to get data
2495      * buffer(s) for it. There may be one contiguous buffer for all the data or
2496      * there may be a buffer per each data plane or anything in between. What
2497      * this means is, you may set however many entries in buf[] you feel necessary.
2498      * Each buffer must be reference-counted using the AVBuffer API (see description
2499      * of buf[] below).
2500      *
2501      * The following fields will be set in the frame before this callback is
2502      * called:
2503      * - format
2504      * - width, height (video only)
2505      * - sample_rate, channel_layout, nb_samples (audio only)
2506      * Their values may differ from the corresponding values in
2507      * AVCodecContext. This callback must use the frame values, not the codec
2508      * context values, to calculate the required buffer size.
2509      *
2510      * This callback must fill the following fields in the frame:
2511      * - data[]
2512      * - linesize[]
2513      * - extended_data:
2514      *   * if the data is planar audio with more than 8 channels, then this
2515      *     callback must allocate and fill extended_data to contain all pointers
2516      *     to all data planes. data[] must hold as many pointers as it can.
2517      *     extended_data must be allocated with av_malloc() and will be freed in
2518      *     av_frame_unref().
2519      *   * otherwise extended_data must point to data
2520      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2521      *   the frame's data and extended_data pointers must be contained in these. That
2522      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2523      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2524      *   and av_buffer_ref().
2525      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2526      *   this callback and filled with the extra buffers if there are more
2527      *   buffers than buf[] can hold. extended_buf will be freed in
2528      *   av_frame_unref().
2529      *
2530      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2531      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2532      * some other means.
2533      *
2534      * Each data plane must be aligned to the maximum required by the target
2535      * CPU.
2536      *
2537      * @see avcodec_default_get_buffer2()
2538      *
2539      * Video:
2540      *
2541      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2542      * (read and/or written to if it is writable) later by libavcodec.
2543      *
2544      * avcodec_align_dimensions2() should be used to find the required width and
2545      * height, as they normally need to be rounded up to the next multiple of 16.
2546      *
2547      * Some decoders do not support linesizes changing between frames.
2548      *
2549      * If frame multithreading is used and thread_safe_callbacks is set,
2550      * this callback may be called from a different thread, but not from more
2551      * than one at once. Does not need to be reentrant.
2552      *
2553      * @see avcodec_align_dimensions2()
2554      *
2555      * Audio:
2556      *
2557      * Decoders request a buffer of a particular size by setting
2558      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2559      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2560      * to a smaller value in the output frame.
2561      *
2562      * As a convenience, av_samples_get_buffer_size() and
2563      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2564      * functions to find the required data size and to fill data pointers and
2565      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2566      * since all planes must be the same size.
2567      *
2568      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2569      *
2570      * - encoding: unused
2571      * - decoding: Set by libavcodec, user can override.
2572      */
2573     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2574
2575     /**
2576      * If non-zero, the decoded audio and video frames returned from
2577      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2578      * and are valid indefinitely. The caller must free them with
2579      * av_frame_unref() when they are not needed anymore.
2580      * Otherwise, the decoded frames must not be freed by the caller and are
2581      * only valid until the next decode call.
2582      *
2583      * This is always automatically enabled if avcodec_receive_frame() is used.
2584      *
2585      * - encoding: unused
2586      * - decoding: set by the caller before avcodec_open2().
2587      */
2588     int refcounted_frames;
2589
2590     /* - encoding parameters */
2591     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2592     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2593
2594     /**
2595      * minimum quantizer
2596      * - encoding: Set by user.
2597      * - decoding: unused
2598      */
2599     int qmin;
2600
2601     /**
2602      * maximum quantizer
2603      * - encoding: Set by user.
2604      * - decoding: unused
2605      */
2606     int qmax;
2607
2608     /**
2609      * maximum quantizer difference between frames
2610      * - encoding: Set by user.
2611      * - decoding: unused
2612      */
2613     int max_qdiff;
2614
2615 #if FF_API_MPV_OPT
2616     /**
2617      * @deprecated use encoder private options instead
2618      */
2619     attribute_deprecated
2620     float rc_qsquish;
2621
2622     attribute_deprecated
2623     float rc_qmod_amp;
2624     attribute_deprecated
2625     int rc_qmod_freq;
2626 #endif
2627
2628     /**
2629      * decoder bitstream buffer size
2630      * - encoding: Set by user.
2631      * - decoding: unused
2632      */
2633     int rc_buffer_size;
2634
2635     /**
2636      * ratecontrol override, see RcOverride
2637      * - encoding: Allocated/set/freed by user.
2638      * - decoding: unused
2639      */
2640     int rc_override_count;
2641     RcOverride *rc_override;
2642
2643 #if FF_API_MPV_OPT
2644     /**
2645      * @deprecated use encoder private options instead
2646      */
2647     attribute_deprecated
2648     const char *rc_eq;
2649 #endif
2650
2651     /**
2652      * maximum bitrate
2653      * - encoding: Set by user.
2654      * - decoding: Set by user, may be overwritten by libavcodec.
2655      */
2656     int64_t rc_max_rate;
2657
2658     /**
2659      * minimum bitrate
2660      * - encoding: Set by user.
2661      * - decoding: unused
2662      */
2663     int64_t rc_min_rate;
2664
2665 #if FF_API_MPV_OPT
2666     /**
2667      * @deprecated use encoder private options instead
2668      */
2669     attribute_deprecated
2670     float rc_buffer_aggressivity;
2671
2672     attribute_deprecated
2673     float rc_initial_cplx;
2674 #endif
2675
2676     /**
2677      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2678      * - encoding: Set by user.
2679      * - decoding: unused.
2680      */
2681     float rc_max_available_vbv_use;
2682
2683     /**
2684      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2685      * - encoding: Set by user.
2686      * - decoding: unused.
2687      */
2688     float rc_min_vbv_overflow_use;
2689
2690     /**
2691      * Number of bits which should be loaded into the rc buffer before decoding starts.
2692      * - encoding: Set by user.
2693      * - decoding: unused
2694      */
2695     int rc_initial_buffer_occupancy;
2696
2697 #if FF_API_CODER_TYPE
2698 #define FF_CODER_TYPE_VLC       0
2699 #define FF_CODER_TYPE_AC        1
2700 #define FF_CODER_TYPE_RAW       2
2701 #define FF_CODER_TYPE_RLE       3
2702 #if FF_API_UNUSED_MEMBERS
2703 #define FF_CODER_TYPE_DEFLATE   4
2704 #endif /* FF_API_UNUSED_MEMBERS */
2705     /**
2706      * @deprecated use encoder private options instead
2707      */
2708     attribute_deprecated
2709     int coder_type;
2710 #endif /* FF_API_CODER_TYPE */
2711
2712 #if FF_API_PRIVATE_OPT
2713     /** @deprecated use encoder private options instead */
2714     attribute_deprecated
2715     int context_model;
2716 #endif
2717
2718 #if FF_API_MPV_OPT
2719     /**
2720      * @deprecated use encoder private options instead
2721      */
2722     attribute_deprecated
2723     int lmin;
2724
2725     /**
2726      * @deprecated use encoder private options instead
2727      */
2728     attribute_deprecated
2729     int lmax;
2730 #endif
2731
2732 #if FF_API_PRIVATE_OPT
2733     /** @deprecated use encoder private options instead */
2734     attribute_deprecated
2735     int frame_skip_threshold;
2736
2737     /** @deprecated use encoder private options instead */
2738     attribute_deprecated
2739     int frame_skip_factor;
2740
2741     /** @deprecated use encoder private options instead */
2742     attribute_deprecated
2743     int frame_skip_exp;
2744
2745     /** @deprecated use encoder private options instead */
2746     attribute_deprecated
2747     int frame_skip_cmp;
2748 #endif /* FF_API_PRIVATE_OPT */
2749
2750     /**
2751      * trellis RD quantization
2752      * - encoding: Set by user.
2753      * - decoding: unused
2754      */
2755     int trellis;
2756
2757 #if FF_API_PRIVATE_OPT
2758     /** @deprecated use encoder private options instead */
2759     attribute_deprecated
2760     int min_prediction_order;
2761
2762     /** @deprecated use encoder private options instead */
2763     attribute_deprecated
2764     int max_prediction_order;
2765
2766     /** @deprecated use encoder private options instead */
2767     attribute_deprecated
2768     int64_t timecode_frame_start;
2769 #endif
2770
2771 #if FF_API_RTP_CALLBACK
2772     /**
2773      * @deprecated unused
2774      */
2775     /* The RTP callback: This function is called    */
2776     /* every time the encoder has a packet to send. */
2777     /* It depends on the encoder if the data starts */
2778     /* with a Start Code (it should). H.263 does.   */
2779     /* mb_nb contains the number of macroblocks     */
2780     /* encoded in the RTP payload.                  */
2781     attribute_deprecated
2782     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2783 #endif
2784
2785 #if FF_API_PRIVATE_OPT
2786     /** @deprecated use encoder private options instead */
2787     attribute_deprecated
2788     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2789                             /* do its best to deliver a chunk with size     */
2790                             /* below rtp_payload_size, the chunk will start */
2791                             /* with a start code on some codecs like H.263. */
2792                             /* This doesn't take account of any particular  */
2793                             /* headers inside the transmitted RTP payload.  */
2794 #endif
2795
2796 #if FF_API_STAT_BITS
2797     /* statistics, used for 2-pass encoding */
2798     attribute_deprecated
2799     int mv_bits;
2800     attribute_deprecated
2801     int header_bits;
2802     attribute_deprecated
2803     int i_tex_bits;
2804     attribute_deprecated
2805     int p_tex_bits;
2806     attribute_deprecated
2807     int i_count;
2808     attribute_deprecated
2809     int p_count;
2810     attribute_deprecated
2811     int skip_count;
2812     attribute_deprecated
2813     int misc_bits;
2814
2815     /** @deprecated this field is unused */
2816     attribute_deprecated
2817     int frame_bits;
2818 #endif
2819
2820     /**
2821      * pass1 encoding statistics output buffer
2822      * - encoding: Set by libavcodec.
2823      * - decoding: unused
2824      */
2825     char *stats_out;
2826
2827     /**
2828      * pass2 encoding statistics input buffer
2829      * Concatenated stuff from stats_out of pass1 should be placed here.
2830      * - encoding: Allocated/set/freed by user.
2831      * - decoding: unused
2832      */
2833     char *stats_in;
2834
2835     /**
2836      * Work around bugs in encoders which sometimes cannot be detected automatically.
2837      * - encoding: Set by user
2838      * - decoding: Set by user
2839      */
2840     int workaround_bugs;
2841 #define FF_BUG_AUTODETECT       1  ///< autodetection
2842 #if FF_API_OLD_MSMPEG4
2843 #define FF_BUG_OLD_MSMPEG4      2
2844 #endif
2845 #define FF_BUG_XVID_ILACE       4
2846 #define FF_BUG_UMP4             8
2847 #define FF_BUG_NO_PADDING       16
2848 #define FF_BUG_AMV              32
2849 #if FF_API_AC_VLC
2850 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2851 #endif
2852 #define FF_BUG_QPEL_CHROMA      64
2853 #define FF_BUG_STD_QPEL         128
2854 #define FF_BUG_QPEL_CHROMA2     256
2855 #define FF_BUG_DIRECT_BLOCKSIZE 512
2856 #define FF_BUG_EDGE             1024
2857 #define FF_BUG_HPEL_CHROMA      2048
2858 #define FF_BUG_DC_CLIP          4096
2859 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2860 #define FF_BUG_TRUNCATED       16384
2861
2862     /**
2863      * strictly follow the standard (MPEG-4, ...).
2864      * - encoding: Set by user.
2865      * - decoding: Set by user.
2866      * Setting this to STRICT or higher means the encoder and decoder will
2867      * generally do stupid things, whereas setting it to unofficial or lower
2868      * will mean the encoder might produce output that is not supported by all
2869      * spec-compliant decoders. Decoders don't differentiate between normal,
2870      * unofficial and experimental (that is, they always try to decode things
2871      * when they can) unless they are explicitly asked to behave stupidly
2872      * (=strictly conform to the specs)
2873      */
2874     int strict_std_compliance;
2875 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2876 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2877 #define FF_COMPLIANCE_NORMAL        0
2878 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2879 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2880
2881     /**
2882      * error concealment flags
2883      * - encoding: unused
2884      * - decoding: Set by user.
2885      */
2886     int error_concealment;
2887 #define FF_EC_GUESS_MVS   1
2888 #define FF_EC_DEBLOCK     2
2889 #define FF_EC_FAVOR_INTER 256
2890
2891     /**
2892      * debug
2893      * - encoding: Set by user.
2894      * - decoding: Set by user.
2895      */
2896     int debug;
2897 #define FF_DEBUG_PICT_INFO   1
2898 #define FF_DEBUG_RC          2
2899 #define FF_DEBUG_BITSTREAM   4
2900 #define FF_DEBUG_MB_TYPE     8
2901 #define FF_DEBUG_QP          16
2902 #if FF_API_DEBUG_MV
2903 /**
2904  * @deprecated this option does nothing
2905  */
2906 #define FF_DEBUG_MV          32
2907 #endif
2908 #define FF_DEBUG_DCT_COEFF   0x00000040
2909 #define FF_DEBUG_SKIP        0x00000080
2910 #define FF_DEBUG_STARTCODE   0x00000100
2911 #if FF_API_UNUSED_MEMBERS
2912 #define FF_DEBUG_PTS         0x00000200
2913 #endif /* FF_API_UNUSED_MEMBERS */
2914 #define FF_DEBUG_ER          0x00000400
2915 #define FF_DEBUG_MMCO        0x00000800
2916 #define FF_DEBUG_BUGS        0x00001000
2917 #if FF_API_DEBUG_MV
2918 #define FF_DEBUG_VIS_QP      0x00002000 ///< only access through AVOptions from outside libavcodec
2919 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2920 #endif
2921 #define FF_DEBUG_BUFFERS     0x00008000
2922 #define FF_DEBUG_THREADS     0x00010000
2923 #define FF_DEBUG_GREEN_MD    0x00800000
2924 #define FF_DEBUG_NOMC        0x01000000
2925
2926 #if FF_API_DEBUG_MV
2927     /**
2928      * debug
2929      * Code outside libavcodec should access this field using AVOptions
2930      * - encoding: Set by user.
2931      * - decoding: Set by user.
2932      */
2933     int debug_mv;
2934 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
2935 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
2936 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2937 #endif
2938
2939     /**
2940      * Error recognition; may misdetect some more or less valid parts as errors.
2941      * - encoding: unused
2942      * - decoding: Set by user.
2943      */
2944     int err_recognition;
2945
2946 /**
2947  * Verify checksums embedded in the bitstream (could be of either encoded or
2948  * decoded data, depending on the codec) and print an error message on mismatch.
2949  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2950  * decoder returning an error.
2951  */
2952 #define AV_EF_CRCCHECK  (1<<0)
2953 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
2954 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
2955 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
2956
2957 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
2958 #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
2959 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
2960 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
2961
2962
2963     /**
2964      * opaque 64-bit number (generally a PTS) that will be reordered and
2965      * output in AVFrame.reordered_opaque
2966      * - encoding: unused
2967      * - decoding: Set by user.
2968      */
2969     int64_t reordered_opaque;
2970
2971     /**
2972      * Hardware accelerator in use
2973      * - encoding: unused.
2974      * - decoding: Set by libavcodec
2975      */
2976     struct AVHWAccel *hwaccel;
2977
2978     /**
2979      * Hardware accelerator context.
2980      * For some hardware accelerators, a global context needs to be
2981      * provided by the user. In that case, this holds display-dependent
2982      * data FFmpeg cannot instantiate itself. Please refer to the
2983      * FFmpeg HW accelerator documentation to know how to fill this
2984      * is. e.g. for VA API, this is a struct vaapi_context.
2985      * - encoding: unused
2986      * - decoding: Set by user
2987      */
2988     void *hwaccel_context;
2989
2990     /**
2991      * error
2992      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2993      * - decoding: unused
2994      */
2995     uint64_t error[AV_NUM_DATA_POINTERS];
2996
2997     /**
2998      * DCT algorithm, see FF_DCT_* below
2999      * - encoding: Set by user.
3000      * - decoding: unused
3001      */
3002     int dct_algo;
3003 #define FF_DCT_AUTO    0
3004 #define FF_DCT_FASTINT 1
3005 #define FF_DCT_INT     2
3006 #define FF_DCT_MMX     3
3007 #define FF_DCT_ALTIVEC 5
3008 #define FF_DCT_FAAN    6
3009
3010     /**
3011      * IDCT algorithm, see FF_IDCT_* below.
3012      * - encoding: Set by user.
3013      * - decoding: Set by user.
3014      */
3015     int idct_algo;
3016 #define FF_IDCT_AUTO          0
3017 #define FF_IDCT_INT           1
3018 #define FF_IDCT_SIMPLE        2
3019 #define FF_IDCT_SIMPLEMMX     3
3020 #define FF_IDCT_ARM           7
3021 #define FF_IDCT_ALTIVEC       8
3022 #if FF_API_ARCH_SH4
3023 #define FF_IDCT_SH4           9
3024 #endif
3025 #define FF_IDCT_SIMPLEARM     10
3026 #if FF_API_UNUSED_MEMBERS
3027 #define FF_IDCT_IPP           13
3028 #endif /* FF_API_UNUSED_MEMBERS */
3029 #define FF_IDCT_XVID          14
3030 #if FF_API_IDCT_XVIDMMX
3031 #define FF_IDCT_XVIDMMX       14
3032 #endif /* FF_API_IDCT_XVIDMMX */
3033 #define FF_IDCT_SIMPLEARMV5TE 16
3034 #define FF_IDCT_SIMPLEARMV6   17
3035 #if FF_API_ARCH_SPARC
3036 #define FF_IDCT_SIMPLEVIS     18
3037 #endif
3038 #define FF_IDCT_FAAN          20
3039 #define FF_IDCT_SIMPLENEON    22
3040 #if FF_API_ARCH_ALPHA
3041 #define FF_IDCT_SIMPLEALPHA   23
3042 #endif
3043 #define FF_IDCT_SIMPLEAUTO    128
3044
3045     /**
3046      * bits per sample/pixel from the demuxer (needed for huffyuv).
3047      * - encoding: Set by libavcodec.
3048      * - decoding: Set by user.
3049      */
3050      int bits_per_coded_sample;
3051
3052     /**
3053      * Bits per sample/pixel of internal libavcodec pixel/sample format.
3054      * - encoding: set by user.
3055      * - decoding: set by libavcodec.
3056      */
3057     int bits_per_raw_sample;
3058
3059 #if FF_API_LOWRES
3060     /**
3061      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3062      * - encoding: unused
3063      * - decoding: Set by user.
3064      * Code outside libavcodec should access this field using:
3065      * av_codec_{get,set}_lowres(avctx)
3066      */
3067      int lowres;
3068 #endif
3069
3070 #if FF_API_CODED_FRAME
3071     /**
3072      * the picture in the bitstream
3073      * - encoding: Set by libavcodec.
3074      * - decoding: unused
3075      *
3076      * @deprecated use the quality factor packet side data instead
3077      */
3078     attribute_deprecated AVFrame *coded_frame;
3079 #endif
3080
3081     /**
3082      * thread count
3083      * is used to decide how many independent tasks should be passed to execute()
3084      * - encoding: Set by user.
3085      * - decoding: Set by user.
3086      */
3087     int thread_count;
3088
3089     /**
3090      * Which multithreading methods to use.
3091      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3092      * so clients which cannot provide future frames should not use it.
3093      *
3094      * - encoding: Set by user, otherwise the default is used.
3095      * - decoding: Set by user, otherwise the default is used.
3096      */
3097     int thread_type;
3098 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
3099 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
3100
3101     /**
3102      * Which multithreading methods are in use by the codec.
3103      * - encoding: Set by libavcodec.
3104      * - decoding: Set by libavcodec.
3105      */
3106     int active_thread_type;
3107
3108     /**
3109      * Set by the client if its custom get_buffer() callback can be called
3110      * synchronously from another thread, which allows faster multithreaded decoding.
3111      * draw_horiz_band() will be called from other threads regardless of this setting.
3112      * Ignored if the default get_buffer() is used.
3113      * - encoding: Set by user.
3114      * - decoding: Set by user.
3115      */
3116     int thread_safe_callbacks;
3117
3118     /**
3119      * The codec may call this to execute several independent things.
3120      * It will return only after finishing all tasks.
3121      * The user may replace this with some multithreaded implementation,
3122      * the default implementation will execute the parts serially.
3123      * @param count the number of things to execute
3124      * - encoding: Set by libavcodec, user can override.
3125      * - decoding: Set by libavcodec, user can override.
3126      */
3127     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3128
3129     /**
3130      * The codec may call this to execute several independent things.
3131      * It will return only after finishing all tasks.
3132      * The user may replace this with some multithreaded implementation,
3133      * the default implementation will execute the parts serially.
3134      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3135      * @param c context passed also to func
3136      * @param count the number of things to execute
3137      * @param arg2 argument passed unchanged to func
3138      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3139      * @param func function that will be called count times, with jobnr from 0 to count-1.
3140      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3141      *             two instances of func executing at the same time will have the same threadnr.
3142      * @return always 0 currently, but code should handle a future improvement where when any call to func
3143      *         returns < 0 no further calls to func may be done and < 0 is returned.
3144      * - encoding: Set by libavcodec, user can override.
3145      * - decoding: Set by libavcodec, user can override.
3146      */
3147     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3148
3149     /**
3150      * noise vs. sse weight for the nsse comparison function
3151      * - encoding: Set by user.
3152      * - decoding: unused
3153      */
3154      int nsse_weight;
3155
3156     /**
3157      * profile
3158      * - encoding: Set by user.
3159      * - decoding: Set by libavcodec.
3160      */
3161      int profile;
3162 #define FF_PROFILE_UNKNOWN -99
3163 #define FF_PROFILE_RESERVED -100
3164
3165 #define FF_PROFILE_AAC_MAIN 0
3166 #define FF_PROFILE_AAC_LOW  1
3167 #define FF_PROFILE_AAC_SSR  2
3168 #define FF_PROFILE_AAC_LTP  3
3169 #define FF_PROFILE_AAC_HE   4
3170 #define FF_PROFILE_AAC_HE_V2 28
3171 #define FF_PROFILE_AAC_LD   22
3172 #define FF_PROFILE_AAC_ELD  38
3173 #define FF_PROFILE_MPEG2_AAC_LOW 128
3174 #define FF_PROFILE_MPEG2_AAC_HE  131
3175
3176 #define FF_PROFILE_DNXHD         0
3177 #define FF_PROFILE_DNXHR_LB      1
3178 #define FF_PROFILE_DNXHR_SQ      2
3179 #define FF_PROFILE_DNXHR_HQ      3
3180 #define FF_PROFILE_DNXHR_HQX     4
3181 #define FF_PROFILE_DNXHR_444     5
3182
3183 #define FF_PROFILE_DTS         20
3184 #define FF_PROFILE_DTS_ES      30
3185 #define FF_PROFILE_DTS_96_24   40
3186 #define FF_PROFILE_DTS_HD_HRA  50
3187 #define FF_PROFILE_DTS_HD_MA   60
3188 #define FF_PROFILE_DTS_EXPRESS 70
3189
3190 #define FF_PROFILE_MPEG2_422    0
3191 #define FF_PROFILE_MPEG2_HIGH   1
3192 #define FF_PROFILE_MPEG2_SS     2
3193 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3194 #define FF_PROFILE_MPEG2_MAIN   4
3195 #define FF_PROFILE_MPEG2_SIMPLE 5
3196
3197 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3198 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3199
3200 #define FF_PROFILE_H264_BASELINE             66
3201 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3202 #define FF_PROFILE_H264_MAIN                 77
3203 #define FF_PROFILE_H264_EXTENDED             88
3204 #define FF_PROFILE_H264_HIGH                 100
3205 #define FF_PROFILE_H264_HIGH_10              110
3206 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3207 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
3208 #define FF_PROFILE_H264_HIGH_422             122
3209 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3210 #define FF_PROFILE_H264_STEREO_HIGH          128
3211 #define FF_PROFILE_H264_HIGH_444             144
3212 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3213 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3214 #define FF_PROFILE_H264_CAVLC_444            44
3215
3216 #define FF_PROFILE_VC1_SIMPLE   0
3217 #define FF_PROFILE_VC1_MAIN     1
3218 #define FF_PROFILE_VC1_COMPLEX  2
3219 #define FF_PROFILE_VC1_ADVANCED 3
3220
3221 #define FF_PROFILE_MPEG4_SIMPLE                     0
3222 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3223 #define FF_PROFILE_MPEG4_CORE                       2
3224 #define FF_PROFILE_MPEG4_MAIN                       3
3225 #define FF_PROFILE_MPEG4_N_BIT                      4
3226 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3227 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3228 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3229 #define FF_PROFILE_MPEG4_HYBRID                     8
3230 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3231 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3232 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3233 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3234 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3235 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3236 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3237
3238 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
3239 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
3240 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
3241 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3242 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3243
3244 #define FF_PROFILE_VP9_0                            0
3245 #define FF_PROFILE_VP9_1                            1
3246 #define FF_PROFILE_VP9_2                            2
3247 #define FF_PROFILE_VP9_3                            3
3248
3249 #define FF_PROFILE_HEVC_MAIN                        1
3250 #define FF_PROFILE_HEVC_MAIN_10                     2
3251 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3252 #define FF_PROFILE_HEVC_REXT                        4
3253
3254     /**
3255      * level
3256      * - encoding: Set by user.
3257      * - decoding: Set by libavcodec.
3258      */
3259      int level;
3260 #define FF_LEVEL_UNKNOWN -99
3261
3262     /**
3263      * Skip loop filtering for selected frames.
3264      * - encoding: unused
3265      * - decoding: Set by user.
3266      */
3267     enum AVDiscard skip_loop_filter;
3268
3269     /**
3270      * Skip IDCT/dequantization for selected frames.
3271      * - encoding: unused
3272      * - decoding: Set by user.
3273      */
3274     enum AVDiscard skip_idct;
3275
3276     /**
3277      * Skip decoding for selected frames.
3278      * - encoding: unused
3279      * - decoding: Set by user.
3280      */
3281     enum AVDiscard skip_frame;
3282
3283     /**
3284      * Header containing style information for text subtitles.
3285      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3286      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3287      * the Format line following. It shouldn't include any Dialogue line.
3288      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3289      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3290      */
3291     uint8_t *subtitle_header;
3292     int subtitle_header_size;
3293
3294 #if FF_API_ERROR_RATE
3295     /**
3296      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3297      * encoders
3298      */
3299     attribute_deprecated
3300     int error_rate;
3301 #endif
3302
3303 #if FF_API_VBV_DELAY
3304     /**
3305      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3306      * Used for compliant TS muxing.
3307      * - encoding: Set by libavcodec.
3308      * - decoding: unused.
3309      * @deprecated this value is now exported as a part of
3310      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3311      */
3312     attribute_deprecated
3313     uint64_t vbv_delay;
3314 #endif
3315
3316 #if FF_API_SIDEDATA_ONLY_PKT
3317     /**
3318      * Encoding only and set by default. Allow encoders to output packets
3319      * that do not contain any encoded data, only side data.
3320      *
3321      * Some encoders need to output such packets, e.g. to update some stream
3322      * parameters at the end of encoding.
3323      *
3324      * @deprecated this field disables the default behaviour and
3325      *             it is kept only for compatibility.
3326      */
3327     attribute_deprecated
3328     int side_data_only_packets;
3329 #endif
3330
3331     /**
3332      * Audio only. The number of "priming" samples (padding) inserted by the
3333      * encoder at the beginning of the audio. I.e. this number of leading
3334      * decoded samples must be discarded by the caller to get the original audio
3335      * without leading padding.
3336      *
3337      * - decoding: unused
3338      * - encoding: Set by libavcodec. The timestamps on the output packets are
3339      *             adjusted by the encoder so that they always refer to the
3340      *             first sample of the data actually contained in the packet,
3341      *             including any added padding.  E.g. if the timebase is
3342      *             1/samplerate and the timestamp of the first input sample is
3343      *             0, the timestamp of the first output packet will be
3344      *             -initial_padding.
3345      */
3346     int initial_padding;
3347
3348     /**
3349      * - decoding: For codecs that store a framerate value in the compressed
3350      *             bitstream, the decoder may export it here. { 0, 1} when
3351      *             unknown.
3352      * - encoding: May be used to signal the framerate of CFR content to an
3353      *             encoder.
3354      */
3355     AVRational framerate;
3356
3357     /**
3358      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3359      * - encoding: unused.
3360      * - decoding: Set by libavcodec before calling get_format()
3361      */
3362     enum AVPixelFormat sw_pix_fmt;
3363
3364     /**
3365      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3366      * Code outside libavcodec should access this field using:
3367      * av_codec_{get,set}_pkt_timebase(avctx)
3368      * - encoding unused.
3369      * - decoding set by user.
3370      */
3371     AVRational pkt_timebase;
3372
3373     /**
3374      * AVCodecDescriptor
3375      * Code outside libavcodec should access this field using:
3376      * av_codec_{get,set}_codec_descriptor(avctx)
3377      * - encoding: unused.
3378      * - decoding: set by libavcodec.
3379      */
3380     const AVCodecDescriptor *codec_descriptor;
3381
3382 #if !FF_API_LOWRES
3383     /**
3384      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3385      * - encoding: unused
3386      * - decoding: Set by user.
3387      * Code outside libavcodec should access this field using:
3388      * av_codec_{get,set}_lowres(avctx)
3389      */
3390      int lowres;
3391 #endif
3392
3393     /**
3394      * Current statistics for PTS correction.
3395      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3396      * - encoding: unused
3397      */
3398     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3399     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3400     int64_t pts_correction_last_pts;       /// PTS of the last frame
3401     int64_t pts_correction_last_dts;       /// DTS of the last frame
3402
3403     /**
3404      * Character encoding of the input subtitles file.
3405      * - decoding: set by user
3406      * - encoding: unused
3407      */
3408     char *sub_charenc;
3409
3410     /**
3411      * Subtitles character encoding mode. Formats or codecs might be adjusting
3412      * this setting (if they are doing the conversion themselves for instance).
3413      * - decoding: set by libavcodec
3414      * - encoding: unused
3415      */
3416     int sub_charenc_mode;
3417 #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)
3418 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3419 #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
3420
3421     /**
3422      * Skip processing alpha if supported by codec.
3423      * Note that if the format uses pre-multiplied alpha (common with VP6,
3424      * and recommended due to better video quality/compression)
3425      * the image will look as if alpha-blended onto a black background.
3426      * However for formats that do not use pre-multiplied alpha
3427      * there might be serious artefacts (though e.g. libswscale currently
3428      * assumes pre-multiplied alpha anyway).
3429      * Code outside libavcodec should access this field using AVOptions
3430      *
3431      * - decoding: set by user
3432      * - encoding: unused
3433      */
3434     int skip_alpha;
3435
3436     /**
3437      * Number of samples to skip after a discontinuity
3438      * - decoding: unused
3439      * - encoding: set by libavcodec
3440      */
3441     int seek_preroll;
3442
3443 #if !FF_API_DEBUG_MV
3444     /**
3445      * debug motion vectors
3446      * Code outside libavcodec should access this field using AVOptions
3447      * - encoding: Set by user.
3448      * - decoding: Set by user.
3449      */
3450     int debug_mv;
3451 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3452 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3453 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3454 #endif
3455
3456     /**
3457      * custom intra quantization matrix
3458      * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3459      * - encoding: Set by user, can be NULL.
3460      * - decoding: unused.
3461      */
3462     uint16_t *chroma_intra_matrix;
3463
3464     /**
3465      * dump format separator.
3466      * can be ", " or "\n      " or anything else
3467      * Code outside libavcodec should access this field using AVOptions
3468      * (NO direct access).
3469      * - encoding: Set by user.
3470      * - decoding: Set by user.
3471      */
3472     uint8_t *dump_separator;
3473
3474     /**
3475      * ',' separated list of allowed decoders.
3476      * If NULL then all are allowed
3477      * - encoding: unused
3478      * - decoding: set by user through AVOPtions (NO direct access)
3479      */
3480     char *codec_whitelist;
3481
3482     /*
3483      * Properties of the stream that gets decoded
3484      * To be accessed through av_codec_get_properties() (NO direct access)
3485      * - encoding: unused
3486      * - decoding: set by libavcodec
3487      */
3488     unsigned properties;
3489 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3490 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3491
3492     /**
3493      * Additional data associated with the entire coded stream.
3494      *
3495      * - decoding: unused
3496      * - encoding: may be set by libavcodec after avcodec_open2().
3497      */
3498     AVPacketSideData *coded_side_data;
3499     int            nb_coded_side_data;
3500
3501     /**
3502      * Encoding only.
3503      *
3504      * For hardware encoders configured to use a hwaccel pixel format, this
3505      * field should be set by the caller to a reference to the AVHWFramesContext
3506      * describing input frames. AVHWFramesContext.format must be equal to
3507      * AVCodecContext.pix_fmt.
3508      *
3509      * This field should be set before avcodec_open2() is called and is
3510      * afterwards owned and managed by libavcodec.
3511      */
3512     AVBufferRef *hw_frames_ctx;
3513
3514     /**
3515      * Control the form of AVSubtitle.rects[N]->ass
3516      * - decoding: set by user
3517      * - encoding: unused
3518      */
3519     int sub_text_format;
3520 #define FF_SUB_TEXT_FMT_ASS              0
3521 #if FF_API_ASS_TIMING
3522 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3523 #endif
3524
3525 } AVCodecContext;
3526
3527 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3528 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3529
3530 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3531 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3532
3533 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3534
3535 int  av_codec_get_lowres(const AVCodecContext *avctx);
3536 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3537
3538 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3539 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3540
3541 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3542 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3543
3544 /**
3545  * AVProfile.
3546  */
3547 typedef struct AVProfile {
3548     int profile;
3549     const char *name; ///< short name for the profile
3550 } AVProfile;
3551
3552 typedef struct AVCodecDefault AVCodecDefault;
3553
3554 struct AVSubtitle;
3555
3556 /**
3557  * AVCodec.
3558  */
3559 typedef struct AVCodec {
3560     /**
3561      * Name of the codec implementation.
3562      * The name is globally unique among encoders and among decoders (but an
3563      * encoder and a decoder can share the same name).
3564      * This is the primary way to find a codec from the user perspective.
3565      */
3566     const char *name;
3567     /**
3568      * Descriptive name for the codec, meant to be more human readable than name.
3569      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3570      */
3571     const char *long_name;
3572     enum AVMediaType type;
3573     enum AVCodecID id;
3574     /**
3575      * Codec capabilities.
3576      * see AV_CODEC_CAP_*
3577      */
3578     int capabilities;
3579     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3580     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3581     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3582     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3583     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3584     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3585     const AVClass *priv_class;              ///< AVClass for the private context
3586     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3587
3588     /*****************************************************************
3589      * No fields below this line are part of the public API. They
3590      * may not be used outside of libavcodec and can be changed and
3591      * removed at will.
3592      * New public fields should be added right above.
3593      *****************************************************************
3594      */
3595     int priv_data_size;
3596     struct AVCodec *next;
3597     /**
3598      * @name Frame-level threading support functions
3599      * @{
3600      */
3601     /**
3602      * If defined, called on thread contexts when they are created.
3603      * If the codec allocates writable tables in init(), re-allocate them here.
3604      * priv_data will be set to a copy of the original.
3605      */
3606     int (*init_thread_copy)(AVCodecContext *);
3607     /**
3608      * Copy necessary context variables from a previous thread context to the current one.
3609      * If not defined, the next thread will start automatically; otherwise, the codec
3610      * must call ff_thread_finish_setup().
3611      *
3612      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3613      */
3614     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3615     /** @} */
3616
3617     /**
3618      * Private codec-specific defaults.
3619      */
3620     const AVCodecDefault *defaults;
3621
3622     /**
3623      * Initialize codec static data, called from avcodec_register().
3624      */
3625     void (*init_static_data)(struct AVCodec *codec);
3626
3627     int (*init)(AVCodecContext *);
3628     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3629                       const struct AVSubtitle *sub);
3630     /**
3631      * Encode data to an AVPacket.
3632      *
3633      * @param      avctx          codec context
3634      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3635      * @param[in]  frame          AVFrame containing the raw data to be encoded
3636      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3637      *                            non-empty packet was returned in avpkt.
3638      * @return 0 on success, negative error code on failure
3639      */
3640     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3641                    int *got_packet_ptr);
3642     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3643     int (*close)(AVCodecContext *);
3644     /**
3645      * Decode/encode API with decoupled packet/frame dataflow. The API is the
3646      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3647      * that:
3648      * - never called if the codec is closed or the wrong type,
3649      * - AVPacket parameter change side data is applied right before calling
3650      *   AVCodec->send_packet,
3651      * - if AV_CODEC_CAP_DELAY is not set, drain packets or frames are never sent,
3652      * - only one drain packet is ever passed down (until the next flush()),
3653      * - a drain AVPacket is always NULL (no need to check for avpkt->size).
3654      */
3655     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3656     int (*send_packet)(AVCodecContext *avctx, const AVPacket *avpkt);
3657     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3658     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3659     /**
3660      * Flush buffers.
3661      * Will be called when seeking
3662      */
3663     void (*flush)(AVCodecContext *);
3664     /**
3665      * Internal codec capabilities.
3666      * See FF_CODEC_CAP_* in internal.h
3667      */
3668     int caps_internal;
3669 } AVCodec;
3670
3671 int av_codec_get_max_lowres(const AVCodec *codec);
3672
3673 struct MpegEncContext;
3674
3675 /**
3676  * @defgroup lavc_hwaccel AVHWAccel
3677  * @{
3678  */
3679 typedef struct AVHWAccel {
3680     /**
3681      * Name of the hardware accelerated codec.
3682      * The name is globally unique among encoders and among decoders (but an
3683      * encoder and a decoder can share the same name).
3684      */
3685     const char *name;
3686
3687     /**
3688      * Type of codec implemented by the hardware accelerator.
3689      *
3690      * See AVMEDIA_TYPE_xxx
3691      */
3692     enum AVMediaType type;
3693
3694     /**
3695      * Codec implemented by the hardware accelerator.
3696      *
3697      * See AV_CODEC_ID_xxx
3698      */
3699     enum AVCodecID id;
3700
3701     /**
3702      * Supported pixel format.
3703      *
3704      * Only hardware accelerated formats are supported here.
3705      */
3706     enum AVPixelFormat pix_fmt;
3707
3708     /**
3709      * Hardware accelerated codec capabilities.
3710      * see HWACCEL_CODEC_CAP_*
3711      */
3712     int capabilities;
3713
3714     /*****************************************************************
3715      * No fields below this line are part of the public API. They
3716      * may not be used outside of libavcodec and can be changed and
3717      * removed at will.
3718      * New public fields should be added right above.
3719      *****************************************************************
3720      */
3721     struct AVHWAccel *next;
3722
3723     /**
3724      * Allocate a custom buffer
3725      */
3726     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3727
3728     /**
3729      * Called at the beginning of each frame or field picture.
3730      *
3731      * Meaningful frame information (codec specific) is guaranteed to
3732      * be parsed at this point. This function is mandatory.
3733      *
3734      * Note that buf can be NULL along with buf_size set to 0.
3735      * Otherwise, this means the whole frame is available at this point.
3736      *
3737      * @param avctx the codec context
3738      * @param buf the frame data buffer base
3739      * @param buf_size the size of the frame in bytes
3740      * @return zero if successful, a negative value otherwise
3741      */
3742     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3743
3744     /**
3745      * Callback for each slice.
3746      *
3747      * Meaningful slice information (codec specific) is guaranteed to
3748      * be parsed at this point. This function is mandatory.
3749      * The only exception is XvMC, that works on MB level.
3750      *
3751      * @param avctx the codec context
3752      * @param buf the slice data buffer base
3753      * @param buf_size the size of the slice in bytes
3754      * @return zero if successful, a negative value otherwise
3755      */
3756     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3757
3758     /**
3759      * Called at the end of each frame or field picture.
3760      *
3761      * The whole picture is parsed at this point and can now be sent
3762      * to the hardware accelerator. This function is mandatory.
3763      *
3764      * @param avctx the codec context
3765      * @return zero if successful, a negative value otherwise
3766      */
3767     int (*end_frame)(AVCodecContext *avctx);
3768
3769     /**
3770      * Size of per-frame hardware accelerator private data.
3771      *
3772      * Private data is allocated with av_mallocz() before
3773      * AVCodecContext.get_buffer() and deallocated after
3774      * AVCodecContext.release_buffer().
3775      */
3776     int frame_priv_data_size;
3777
3778     /**
3779      * Called for every Macroblock in a slice.
3780      *
3781      * XvMC uses it to replace the ff_mpv_decode_mb().
3782      * Instead of decoding to raw picture, MB parameters are
3783      * stored in an array provided by the video driver.
3784      *
3785      * @param s the mpeg context
3786      */
3787     void (*decode_mb)(struct MpegEncContext *s);
3788
3789     /**
3790      * Initialize the hwaccel private data.
3791      *
3792      * This will be called from ff_get_format(), after hwaccel and
3793      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3794      * is allocated.
3795      */
3796     int (*init)(AVCodecContext *avctx);
3797
3798     /**
3799      * Uninitialize the hwaccel private data.
3800      *
3801      * This will be called from get_format() or avcodec_close(), after hwaccel
3802      * and hwaccel_context are already uninitialized.
3803      */
3804     int (*uninit)(AVCodecContext *avctx);
3805
3806     /**
3807      * Size of the private data to allocate in
3808      * AVCodecInternal.hwaccel_priv_data.
3809      */
3810     int priv_data_size;
3811 } AVHWAccel;
3812
3813 /**
3814  * Hardware acceleration should be used for decoding even if the codec level
3815  * used is unknown or higher than the maximum supported level reported by the
3816  * hardware driver.
3817  *
3818  * It's generally a good idea to pass this flag unless you have a specific
3819  * reason not to, as hardware tends to under-report supported levels.
3820  */
3821 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3822
3823 /**
3824  * Hardware acceleration can output YUV pixel formats with a different chroma
3825  * sampling than 4:2:0 and/or other than 8 bits per component.
3826  */
3827 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3828
3829 /**
3830  * @}
3831  */
3832
3833 #if FF_API_AVPICTURE
3834 /**
3835  * @defgroup lavc_picture AVPicture
3836  *
3837  * Functions for working with AVPicture
3838  * @{
3839  */
3840
3841 /**
3842  * Picture data structure.
3843  *
3844  * Up to four components can be stored into it, the last component is
3845  * alpha.
3846  * @deprecated use AVFrame or imgutils functions instead
3847  */
3848 typedef struct AVPicture {
3849     attribute_deprecated
3850     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
3851     attribute_deprecated
3852     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3853 } AVPicture;
3854
3855 /**
3856  * @}
3857  */
3858 #endif
3859
3860 enum AVSubtitleType {
3861     SUBTITLE_NONE,
3862
3863     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3864
3865     /**
3866      * Plain text, the text field must be set by the decoder and is
3867      * authoritative. ass and pict fields may contain approximations.
3868      */
3869     SUBTITLE_TEXT,
3870
3871     /**
3872      * Formatted text, the ass field must be set by the decoder and is
3873      * authoritative. pict and text fields may contain approximations.
3874      */
3875     SUBTITLE_ASS,
3876 };
3877
3878 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3879
3880 typedef struct AVSubtitleRect {
3881     int x;         ///< top left corner  of pict, undefined when pict is not set
3882     int y;         ///< top left corner  of pict, undefined when pict is not set
3883     int w;         ///< width            of pict, undefined when pict is not set
3884     int h;         ///< height           of pict, undefined when pict is not set
3885     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3886
3887 #if FF_API_AVPICTURE
3888     /**
3889      * @deprecated unused
3890      */
3891     attribute_deprecated
3892     AVPicture pict;
3893 #endif
3894     /**
3895      * data+linesize for the bitmap of this subtitle.
3896      * Can be set for text/ass as well once they are rendered.
3897      */
3898     uint8_t *data[4];
3899     int linesize[4];
3900
3901     enum AVSubtitleType type;
3902
3903     char *text;                     ///< 0 terminated plain UTF-8 text
3904
3905     /**
3906      * 0 terminated ASS/SSA compatible event line.
3907      * The presentation of this is unaffected by the other values in this
3908      * struct.
3909      */
3910     char *ass;
3911
3912     int flags;
3913 } AVSubtitleRect;
3914
3915 typedef struct AVSubtitle {
3916     uint16_t format; /* 0 = graphics */
3917     uint32_t start_display_time; /* relative to packet pts, in ms */
3918     uint32_t end_display_time; /* relative to packet pts, in ms */
3919     unsigned num_rects;
3920     AVSubtitleRect **rects;
3921     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3922 } AVSubtitle;
3923
3924 /**
3925  * This struct describes the properties of an encoded stream.
3926  *
3927  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3928  * be allocated with avcodec_parameters_alloc() and freed with
3929  * avcodec_parameters_free().
3930  */
3931 typedef struct AVCodecParameters {
3932     /**
3933      * General type of the encoded data.
3934      */
3935     enum AVMediaType codec_type;
3936     /**
3937      * Specific type of the encoded data (the codec used).
3938      */
3939     enum AVCodecID   codec_id;
3940     /**
3941      * Additional information about the codec (corresponds to the AVI FOURCC).
3942      */
3943     uint32_t         codec_tag;
3944
3945     /**
3946      * Extra binary data needed for initializing the decoder, codec-dependent.
3947      *
3948      * Must be allocated with av_malloc() and will be freed by
3949      * avcodec_parameters_free(). The allocated size of extradata must be at
3950      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3951      * bytes zeroed.
3952      */
3953     uint8_t *extradata;
3954     /**
3955      * Size of the extradata content in bytes.
3956      */
3957     int      extradata_size;
3958
3959     /**
3960      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3961      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3962      */
3963     int format;
3964
3965     /**
3966      * The average bitrate of the encoded data (in bits per second).
3967      */
3968     int64_t bit_rate;
3969
3970     /**
3971      * The number of bits per sample in the codedwords.
3972      *
3973      * This is basically the bitrate per sample. It is mandatory for a bunch of
3974      * formats to actually decode them. It's the number of bits for one sample in
3975      * the actual coded bitstream.
3976      *
3977      * This could be for example 4 for ADPCM
3978      * For PCM formats this matches bits_per_raw_sample
3979      * Can be 0
3980      */
3981     int bits_per_coded_sample;
3982
3983     /**
3984      * This is the number of valid bits in each output sample. If the
3985      * sample format has more bits, the least significant bits are additional
3986      * padding bits, which are always 0. Use right shifts to reduce the sample
3987      * to its actual size. For example, audio formats with 24 bit samples will
3988      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3989      * To get the original sample use "(int32_t)sample >> 8"."
3990      *
3991      * For ADPCM this might be 12 or 16 or similar
3992      * Can be 0
3993      */
3994     int bits_per_raw_sample;
3995
3996     /**
3997      * Codec-specific bitstream restrictions that the stream conforms to.
3998      */
3999     int profile;
4000     int level;
4001
4002     /**
4003      * Video only. The dimensions of the video frame in pixels.
4004      */
4005     int width;
4006     int height;
4007
4008     /**
4009      * Video only. The aspect ratio (width / height) which a single pixel
4010      * should have when displayed.
4011      *
4012      * When the aspect ratio is unknown / undefined, the numerator should be
4013      * set to 0 (the denominator may have any value).
4014      */
4015     AVRational sample_aspect_ratio;
4016
4017     /**
4018      * Video only. The order of the fields in interlaced video.
4019      */
4020     enum AVFieldOrder                  field_order;
4021
4022     /**
4023      * Video only. Additional colorspace characteristics.
4024      */
4025     enum AVColorRange                  color_range;
4026     enum AVColorPrimaries              color_primaries;
4027     enum AVColorTransferCharacteristic color_trc;
4028     enum AVColorSpace                  color_space;
4029     enum AVChromaLocation              chroma_location;
4030
4031     /**
4032      * Video only. Number of delayed frames.
4033      */
4034     int video_delay;
4035
4036     /**
4037      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4038      * unknown or unspecified, otherwise the number of bits set must be equal to
4039      * the channels field.
4040      */
4041     uint64_t channel_layout;
4042     /**
4043      * Audio only. The number of audio channels.
4044      */
4045     int      channels;
4046     /**
4047      * Audio only. The number of audio samples per second.
4048      */
4049     int      sample_rate;
4050     /**
4051      * Audio only. The number of bytes per coded audio frame, required by some
4052      * formats.
4053      *
4054      * Corresponds to nBlockAlign in WAVEFORMATEX.
4055      */
4056     int      block_align;
4057     /**
4058      * Audio only. Audio frame size, if known. Required by some formats to be static.
4059      */
4060     int      frame_size;
4061
4062     /**
4063      * Audio only. The amount of padding (in samples) inserted by the encoder at
4064      * the beginning of the audio. I.e. this number of leading decoded samples
4065      * must be discarded by the caller to get the original audio without leading
4066      * padding.
4067      */
4068     int initial_padding;
4069     /**
4070      * Audio only. The amount of padding (in samples) appended by the encoder to
4071      * the end of the audio. I.e. this number of decoded samples must be
4072      * discarded by the caller from the end of the stream to get the original
4073      * audio without any trailing padding.
4074      */
4075     int trailing_padding;
4076     /**
4077      * Audio only. Number of samples to skip after a discontinuity.
4078      */
4079     int seek_preroll;
4080 } AVCodecParameters;
4081
4082 /**
4083  * If c is NULL, returns the first registered codec,
4084  * if c is non-NULL, returns the next registered codec after c,
4085  * or NULL if c is the last one.
4086  */
4087 AVCodec *av_codec_next(const AVCodec *c);
4088
4089 /**
4090  * Return the LIBAVCODEC_VERSION_INT constant.
4091  */
4092 unsigned avcodec_version(void);
4093
4094 /**
4095  * Return the libavcodec build-time configuration.
4096  */
4097 const char *avcodec_configuration(void);
4098
4099 /**
4100  * Return the libavcodec license.
4101  */
4102 const char *avcodec_license(void);
4103
4104 /**
4105  * Register the codec codec and initialize libavcodec.
4106  *
4107  * @warning either this function or avcodec_register_all() must be called
4108  * before any other libavcodec functions.
4109  *
4110  * @see avcodec_register_all()
4111  */
4112 void avcodec_register(AVCodec *codec);
4113
4114 /**
4115  * Register all the codecs, parsers and bitstream filters which were enabled at
4116  * configuration time. If you do not call this function you can select exactly
4117  * which formats you want to support, by using the individual registration
4118  * functions.
4119  *
4120  * @see avcodec_register
4121  * @see av_register_codec_parser
4122  * @see av_register_bitstream_filter
4123  */
4124 void avcodec_register_all(void);
4125
4126 /**
4127  * Allocate an AVCodecContext and set its fields to default values. The
4128  * resulting struct should be freed with avcodec_free_context().
4129  *
4130  * @param codec if non-NULL, allocate private data and initialize defaults
4131  *              for the given codec. It is illegal to then call avcodec_open2()
4132  *              with a different codec.
4133  *              If NULL, then the codec-specific defaults won't be initialized,
4134  *              which may result in suboptimal default settings (this is
4135  *              important mainly for encoders, e.g. libx264).
4136  *
4137  * @return An AVCodecContext filled with default values or NULL on failure.
4138  */
4139 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4140
4141 /**
4142  * Free the codec context and everything associated with it and write NULL to
4143  * the provided pointer.
4144  */
4145 void avcodec_free_context(AVCodecContext **avctx);
4146
4147 #if FF_API_GET_CONTEXT_DEFAULTS
4148 /**
4149  * @deprecated This function should not be used, as closing and opening a codec
4150  * context multiple time is not supported. A new codec context should be
4151  * allocated for each new use.
4152  */
4153 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4154 #endif
4155
4156 /**
4157  * Get the AVClass for AVCodecContext. It can be used in combination with
4158  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4159  *
4160  * @see av_opt_find().
4161  */
4162 const AVClass *avcodec_get_class(void);
4163
4164 #if FF_API_COPY_CONTEXT
4165 /**
4166  * Get the AVClass for AVFrame. It can be used in combination with
4167  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4168  *
4169  * @see av_opt_find().
4170  */
4171 const AVClass *avcodec_get_frame_class(void);
4172
4173 /**
4174  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4175  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4176  *
4177  * @see av_opt_find().
4178  */
4179 const AVClass *avcodec_get_subtitle_rect_class(void);
4180
4181 /**
4182  * Copy the settings of the source AVCodecContext into the destination
4183  * AVCodecContext. The resulting destination codec context will be
4184  * unopened, i.e. you are required to call avcodec_open2() before you
4185  * can use this AVCodecContext to decode/encode video/audio data.
4186  *
4187  * @param dest target codec context, should be initialized with
4188  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
4189  * @param src source codec context
4190  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4191  *
4192  * @deprecated The semantics of this function are ill-defined and it should not
4193  * be used. If you need to transfer the stream parameters from one codec context
4194  * to another, use an intermediate AVCodecParameters instance and the
4195  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4196  * functions.
4197  */
4198 attribute_deprecated
4199 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4200 #endif
4201
4202 /**
4203  * Allocate a new AVCodecParameters and set its fields to default values
4204  * (unknown/invalid/0). The returned struct must be freed with
4205  * avcodec_parameters_free().
4206  */
4207 AVCodecParameters *avcodec_parameters_alloc(void);
4208
4209 /**
4210  * Free an AVCodecParameters instance and everything associated with it and
4211  * write NULL to the supplied pointer.
4212  */
4213 void avcodec_parameters_free(AVCodecParameters **par);
4214
4215 /**
4216  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4217  * replaced with newly allocated duplicates of the corresponding fields in src.
4218  *
4219  * @return >= 0 on success, a negative AVERROR code on failure.
4220  */
4221 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4222
4223 /**
4224  * Fill the parameters struct based on the values from the supplied codec
4225  * context. Any allocated fields in par are freed and replaced with duplicates
4226  * of the corresponding fields in codec.
4227  *
4228  * @return >= 0 on success, a negative AVERROR code on failure
4229  */
4230 int avcodec_parameters_from_context(AVCodecParameters *par,
4231                                     const AVCodecContext *codec);
4232
4233 /**
4234  * Fill the codec context based on the values from the supplied codec
4235  * parameters. Any allocated fields in codec that have a corresponding field in
4236  * par are freed and replaced with duplicates of the corresponding field in par.
4237  * Fields in codec that do not have a counterpart in par are not touched.
4238  *
4239  * @return >= 0 on success, a negative AVERROR code on failure.
4240  */
4241 int avcodec_parameters_to_context(AVCodecContext *codec,
4242                                   const AVCodecParameters *par);
4243
4244 /**
4245  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4246  * function the context has to be allocated with avcodec_alloc_context3().
4247  *
4248  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4249  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4250  * retrieving a codec.
4251  *
4252  * @warning This function is not thread safe!
4253  *
4254  * @note Always call this function before using decoding routines (such as
4255  * @ref avcodec_receive_frame()).
4256  *
4257  * @code
4258  * avcodec_register_all();
4259  * av_dict_set(&opts, "b", "2.5M", 0);
4260  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4261  * if (!codec)
4262  *     exit(1);
4263  *
4264  * context = avcodec_alloc_context3(codec);
4265  *
4266  * if (avcodec_open2(context, codec, opts) < 0)
4267  *     exit(1);
4268  * @endcode
4269  *
4270  * @param avctx The context to initialize.
4271  * @param codec The codec to open this context for. If a non-NULL codec has been
4272  *              previously passed to avcodec_alloc_context3() or
4273  *              for this context, then this parameter MUST be either NULL or
4274  *              equal to the previously passed codec.
4275  * @param options A dictionary filled with AVCodecContext and codec-private options.
4276  *                On return this object will be filled with options that were not found.
4277  *
4278  * @return zero on success, a negative value on error
4279  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4280  *      av_dict_set(), av_opt_find().
4281  */
4282 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4283
4284 /**
4285  * Close a given AVCodecContext and free all the data associated with it
4286  * (but not the AVCodecContext itself).
4287  *
4288  * Calling this function on an AVCodecContext that hasn't been opened will free
4289  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4290  * codec. Subsequent calls will do nothing.
4291  *
4292  * @note Do not use this function. Use avcodec_free_context() to destroy a
4293  * codec context (either open or closed). Opening and closing a codec context
4294  * multiple times is not supported anymore -- use multiple codec contexts
4295  * instead.
4296  */
4297 int avcodec_close(AVCodecContext *avctx);
4298
4299 /**
4300  * Free all allocated data in the given subtitle struct.
4301  *
4302  * @param sub AVSubtitle to free.
4303  */
4304 void avsubtitle_free(AVSubtitle *sub);
4305
4306 /**
4307  * @}
4308  */
4309
4310 /**
4311  * @addtogroup lavc_packet
4312  * @{
4313  */
4314
4315 /**
4316  * Allocate an AVPacket and set its fields to default values.  The resulting
4317  * struct must be freed using av_packet_free().
4318  *
4319  * @return An AVPacket filled with default values or NULL on failure.
4320  *
4321  * @note this only allocates the AVPacket itself, not the data buffers. Those
4322  * must be allocated through other means such as av_new_packet.
4323  *
4324  * @see av_new_packet
4325  */
4326 AVPacket *av_packet_alloc(void);
4327
4328 /**
4329  * Create a new packet that references the same data as src.
4330  *
4331  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4332  *
4333  * @return newly created AVPacket on success, NULL on error.
4334  *
4335  * @see av_packet_alloc
4336  * @see av_packet_ref
4337  */
4338 AVPacket *av_packet_clone(AVPacket *src);
4339
4340 /**
4341  * Free the packet, if the packet is reference counted, it will be
4342  * unreferenced first.
4343  *
4344  * @param packet packet to be freed. The pointer will be set to NULL.
4345  * @note passing NULL is a no-op.
4346  */
4347 void av_packet_free(AVPacket **pkt);
4348
4349 /**
4350  * Initialize optional fields of a packet with default values.
4351  *
4352  * Note, this does not touch the data and size members, which have to be
4353  * initialized separately.
4354  *
4355  * @param pkt packet
4356  */
4357 void av_init_packet(AVPacket *pkt);
4358
4359 /**
4360  * Allocate the payload of a packet and initialize its fields with
4361  * default values.
4362  *
4363  * @param pkt packet
4364  * @param size wanted payload size
4365  * @return 0 if OK, AVERROR_xxx otherwise
4366  */
4367 int av_new_packet(AVPacket *pkt, int size);
4368
4369 /**
4370  * Reduce packet size, correctly zeroing padding
4371  *
4372  * @param pkt packet
4373  * @param size new size
4374  */
4375 void av_shrink_packet(AVPacket *pkt, int size);
4376
4377 /**
4378  * Increase packet size, correctly zeroing padding
4379  *
4380  * @param pkt packet
4381  * @param grow_by number of bytes by which to increase the size of the packet
4382  */
4383 int av_grow_packet(AVPacket *pkt, int grow_by);
4384
4385 /**
4386  * Initialize a reference-counted packet from av_malloc()ed data.
4387  *
4388  * @param pkt packet to be initialized. This function will set the data, size,
4389  *        buf and destruct fields, all others are left untouched.
4390  * @param data Data allocated by av_malloc() to be used as packet data. If this
4391  *        function returns successfully, the data is owned by the underlying AVBuffer.
4392  *        The caller may not access the data through other means.
4393  * @param size size of data in bytes, without the padding. I.e. the full buffer
4394  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4395  *
4396  * @return 0 on success, a negative AVERROR on error
4397  */
4398 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4399
4400 #if FF_API_AVPACKET_OLD_API
4401 /**
4402  * @warning This is a hack - the packet memory allocation stuff is broken. The
4403  * packet is allocated if it was not really allocated.
4404  *
4405  * @deprecated Use av_packet_ref
4406  */
4407 attribute_deprecated
4408 int av_dup_packet(AVPacket *pkt);
4409 /**
4410  * Copy packet, including contents
4411  *
4412  * @return 0 on success, negative AVERROR on fail
4413  */
4414 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4415
4416 /**
4417  * Copy packet side data
4418  *
4419  * @return 0 on success, negative AVERROR on fail
4420  */
4421 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4422
4423 /**
4424  * Free a packet.
4425  *
4426  * @deprecated Use av_packet_unref
4427  *
4428  * @param pkt packet to free
4429  */
4430 attribute_deprecated
4431 void av_free_packet(AVPacket *pkt);
4432 #endif
4433 /**
4434  * Allocate new information of a packet.
4435  *
4436  * @param pkt packet
4437  * @param type side information type
4438  * @param size side information size
4439  * @return pointer to fresh allocated data or NULL otherwise
4440  */
4441 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4442                                  int size);
4443
4444 /**
4445  * Wrap an existing array as a packet side data.
4446  *
4447  * @param pkt packet
4448  * @param type side information type
4449  * @param data the side data array. It must be allocated with the av_malloc()
4450  *             family of functions. The ownership of the data is transferred to
4451  *             pkt.
4452  * @param size side information size
4453  * @return a non-negative number on success, a negative AVERROR code on
4454  *         failure. On failure, the packet is unchanged and the data remains
4455  *         owned by the caller.
4456  */
4457 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4458                             uint8_t *data, size_t size);
4459
4460 /**
4461  * Shrink the already allocated side data buffer
4462  *
4463  * @param pkt packet
4464  * @param type side information type
4465  * @param size new side information size
4466  * @return 0 on success, < 0 on failure
4467  */
4468 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4469                                int size);
4470
4471 /**
4472  * Get side information from packet.
4473  *
4474  * @param pkt packet
4475  * @param type desired side information type
4476  * @param size pointer for side information size to store (optional)
4477  * @return pointer to data if present or NULL otherwise
4478  */
4479 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4480                                  int *size);
4481
4482 int av_packet_merge_side_data(AVPacket *pkt);
4483
4484 int av_packet_split_side_data(AVPacket *pkt);
4485
4486 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4487
4488 /**
4489  * Pack a dictionary for use in side_data.
4490  *
4491  * @param dict The dictionary to pack.
4492  * @param size pointer to store the size of the returned data
4493  * @return pointer to data if successful, NULL otherwise
4494  */
4495 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4496 /**
4497  * Unpack a dictionary from side_data.
4498  *
4499  * @param data data from side_data
4500  * @param size size of the data
4501  * @param dict the metadata storage dictionary
4502  * @return 0 on success, < 0 on failure
4503  */
4504 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4505
4506
4507 /**
4508  * Convenience function to free all the side data stored.
4509  * All the other fields stay untouched.
4510  *
4511  * @param pkt packet
4512  */
4513 void av_packet_free_side_data(AVPacket *pkt);
4514
4515 /**
4516  * Setup a new reference to the data described by a given packet
4517  *
4518  * If src is reference-counted, setup dst as a new reference to the
4519  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4520  * data from src into it.
4521  *
4522  * All the other fields are copied from src.
4523  *
4524  * @see av_packet_unref
4525  *
4526  * @param dst Destination packet
4527  * @param src Source packet
4528  *
4529  * @return 0 on success, a negative AVERROR on error.
4530  */
4531 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4532
4533 /**
4534  * Wipe the packet.
4535  *
4536  * Unreference the buffer referenced by the packet and reset the
4537  * remaining packet fields to their default values.
4538  *
4539  * @param pkt The packet to be unreferenced.
4540  */
4541 void av_packet_unref(AVPacket *pkt);
4542
4543 /**
4544  * Move every field in src to dst and reset src.
4545  *
4546  * @see av_packet_unref
4547  *
4548  * @param src Source packet, will be reset
4549  * @param dst Destination packet
4550  */
4551 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4552
4553 /**
4554  * Copy only "properties" fields from src to dst.
4555  *
4556  * Properties for the purpose of this function are all the fields
4557  * beside those related to the packet data (buf, data, size)
4558  *
4559  * @param dst Destination packet
4560  * @param src Source packet
4561  *
4562  * @return 0 on success AVERROR on failure.
4563  */
4564 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4565
4566 /**
4567  * Convert valid timing fields (timestamps / durations) in a packet from one
4568  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4569  * ignored.
4570  *
4571  * @param pkt packet on which the conversion will be performed
4572  * @param tb_src source timebase, in which the timing fields in pkt are
4573  *               expressed
4574  * @param tb_dst destination timebase, to which the timing fields will be
4575  *               converted
4576  */
4577 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4578
4579 /**
4580  * @}
4581  */
4582
4583 /**
4584  * @addtogroup lavc_decoding
4585  * @{
4586  */
4587
4588 /**
4589  * Find a registered decoder with a matching codec ID.
4590  *
4591  * @param id AVCodecID of the requested decoder
4592  * @return A decoder if one was found, NULL otherwise.
4593  */
4594 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4595
4596 /**
4597  * Find a registered decoder with the specified name.
4598  *
4599  * @param name name of the requested decoder
4600  * @return A decoder if one was found, NULL otherwise.
4601  */
4602 AVCodec *avcodec_find_decoder_by_name(const char *name);
4603
4604 /**
4605  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4606  * it can be called by custom get_buffer2() implementations for decoders without
4607  * AV_CODEC_CAP_DR1 set.
4608  */
4609 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4610
4611 #if FF_API_EMU_EDGE
4612 /**
4613  * Return the amount of padding in pixels which the get_buffer callback must
4614  * provide around the edge of the image for codecs which do not have the
4615  * CODEC_FLAG_EMU_EDGE flag.
4616  *
4617  * @return Required padding in pixels.
4618  *
4619  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4620  * needed
4621  */
4622 attribute_deprecated
4623 unsigned avcodec_get_edge_width(void);
4624 #endif
4625
4626 /**
4627  * Modify width and height values so that they will result in a memory
4628  * buffer that is acceptable for the codec if you do not use any horizontal
4629  * padding.
4630  *
4631  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4632  */
4633 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4634
4635 /**
4636  * Modify width and height values so that they will result in a memory
4637  * buffer that is acceptable for the codec if you also ensure that all
4638  * line sizes are a multiple of the respective linesize_align[i].
4639  *
4640  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4641  */
4642 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4643                                int linesize_align[AV_NUM_DATA_POINTERS]);
4644
4645 /**
4646  * Converts AVChromaLocation to swscale x/y chroma position.
4647  *
4648  * The positions represent the chroma (0,0) position in a coordinates system
4649  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4650  *
4651  * @param xpos  horizontal chroma sample position
4652  * @param ypos  vertical   chroma sample position
4653  */
4654 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4655
4656 /**
4657  * Converts swscale x/y chroma position to AVChromaLocation.
4658  *
4659  * The positions represent the chroma (0,0) position in a coordinates system
4660  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4661  *
4662  * @param xpos  horizontal chroma sample position
4663  * @param ypos  vertical   chroma sample position
4664  */
4665 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4666
4667 /**
4668  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4669  *
4670  * Some decoders may support multiple frames in a single AVPacket. Such
4671  * decoders would then just decode the first frame and the return value would be
4672  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4673  * called again with an AVPacket containing the remaining data in order to
4674  * decode the second frame, etc...  Even if no frames are returned, the packet
4675  * needs to be fed to the decoder with remaining data until it is completely
4676  * consumed or an error occurs.
4677  *
4678  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4679  * and output. This means that for some packets they will not immediately
4680  * produce decoded output and need to be flushed at the end of decoding to get
4681  * all the decoded data. Flushing is done by calling this function with packets
4682  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4683  * returning samples. It is safe to flush even those decoders that are not
4684  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4685  *
4686  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4687  *          larger than the actual read bytes because some optimized bitstream
4688  *          readers read 32 or 64 bits at once and could read over the end.
4689  *
4690  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4691  * before packets may be fed to the decoder.
4692  *
4693  * @param      avctx the codec context
4694  * @param[out] frame The AVFrame in which to store decoded audio samples.
4695  *                   The decoder will allocate a buffer for the decoded frame by
4696  *                   calling the AVCodecContext.get_buffer2() callback.
4697  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
4698  *                   reference counted and the returned reference belongs to the
4699  *                   caller. The caller must release the frame using av_frame_unref()
4700  *                   when the frame is no longer needed. The caller may safely write
4701  *                   to the frame if av_frame_is_writable() returns 1.
4702  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
4703  *                   reference belongs to the decoder and is valid only until the
4704  *                   next call to this function or until closing or flushing the
4705  *                   decoder. The caller may not write to it.
4706  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4707  *                           non-zero. Note that this field being set to zero
4708  *                           does not mean that an error has occurred. For
4709  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
4710  *                           call is guaranteed to produce a frame.
4711  * @param[in]  avpkt The input AVPacket containing the input buffer.
4712  *                   At least avpkt->data and avpkt->size should be set. Some
4713  *                   decoders might also require additional fields to be set.
4714  * @return A negative error code is returned if an error occurred during
4715  *         decoding, otherwise the number of bytes consumed from the input
4716  *         AVPacket is returned.
4717  *
4718 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4719  */
4720 attribute_deprecated
4721 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4722                           int *got_frame_ptr, const AVPacket *avpkt);
4723
4724 /**
4725  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4726  * Some decoders may support multiple frames in a single AVPacket, such
4727  * decoders would then just decode the first frame.
4728  *
4729  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4730  * the actual read bytes because some optimized bitstream readers read 32 or 64
4731  * bits at once and could read over the end.
4732  *
4733  * @warning The end of the input buffer buf should be set to 0 to ensure that
4734  * no overreading happens for damaged MPEG streams.
4735  *
4736  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4737  * between input and output, these need to be fed with avpkt->data=NULL,
4738  * avpkt->size=0 at the end to return the remaining frames.
4739  *
4740  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4741  * before packets may be fed to the decoder.
4742  *
4743  * @param avctx the codec context
4744  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4745  *             Use av_frame_alloc() to get an AVFrame. The codec will
4746  *             allocate memory for the actual bitmap by calling the
4747  *             AVCodecContext.get_buffer2() callback.
4748  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
4749  *             reference counted and the returned reference belongs to the
4750  *             caller. The caller must release the frame using av_frame_unref()
4751  *             when the frame is no longer needed. The caller may safely write
4752  *             to the frame if av_frame_is_writable() returns 1.
4753  *             When AVCodecContext.refcounted_frames is set to 0, the returned
4754  *             reference belongs to the decoder and is valid only until the
4755  *             next call to this function or until closing or flushing the
4756  *             decoder. The caller may not write to it.
4757  *
4758  * @param[in] avpkt The input AVPacket containing the input buffer.
4759  *            You can create such packet with av_init_packet() and by then setting
4760  *            data and size, some decoders might in addition need other fields like
4761  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4762  *            fields possible.
4763  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4764  * @return On error a negative value is returned, otherwise the number of bytes
4765  * used or zero if no frame could be decompressed.
4766  *
4767  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4768  */
4769 attribute_deprecated
4770 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4771                          int *got_picture_ptr,
4772                          const AVPacket *avpkt);
4773
4774 /**
4775  * Decode a subtitle message.
4776  * Return a negative value on error, otherwise return the number of bytes used.
4777  * If no subtitle could be decompressed, got_sub_ptr is zero.
4778  * Otherwise, the subtitle is stored in *sub.
4779  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4780  * simplicity, because the performance difference is expect to be negligible
4781  * and reusing a get_buffer written for video codecs would probably perform badly
4782  * due to a potentially very different allocation pattern.
4783  *
4784  * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4785  * and output. This means that for some packets they will not immediately
4786  * produce decoded output and need to be flushed at the end of decoding to get
4787  * all the decoded data. Flushing is done by calling this function with packets
4788  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4789  * returning subtitles. It is safe to flush even those decoders that are not
4790  * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4791  *
4792  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4793  * before packets may be fed to the decoder.
4794  *
4795  * @param avctx the codec context
4796  * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4797  *                 must be freed with avsubtitle_free if *got_sub_ptr is set.
4798  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4799  * @param[in] avpkt The input AVPacket containing the input buffer.
4800  */
4801 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4802                             int *got_sub_ptr,
4803                             AVPacket *avpkt);
4804
4805 /**
4806  * Supply raw packet data as input to a decoder.
4807  *
4808  * Internally, this call will copy relevant AVCodecContext fields, which can
4809  * influence decoding per-packet, and apply them when the packet is actually
4810  * decoded. (For example AVCodecContext.skip_frame, which might direct the
4811  * decoder to drop the frame contained by the packet sent with this function.)
4812  *
4813  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4814  *          larger than the actual read bytes because some optimized bitstream
4815  *          readers read 32 or 64 bits at once and could read over the end.
4816  *
4817  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4818  *          on the same AVCodecContext. It will return unexpected results now
4819  *          or in future libavcodec versions.
4820  *
4821  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4822  *       before packets may be fed to the decoder.
4823  *
4824  * @param avctx codec context
4825  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4826  *                  frame, or several complete audio frames.
4827  *                  Ownership of the packet remains with the caller, and the
4828  *                  decoder will not write to the packet. The decoder may create
4829  *                  a reference to the packet data (or copy it if the packet is
4830  *                  not reference-counted).
4831  *                  Unlike with older APIs, the packet is always fully consumed,
4832  *                  and if it contains multiple frames (e.g. some audio codecs),
4833  *                  will require you to call avcodec_receive_frame() multiple
4834  *                  times afterwards before you can send a new packet.
4835  *                  It can be NULL (or an AVPacket with data set to NULL and
4836  *                  size set to 0); in this case, it is considered a flush
4837  *                  packet, which signals the end of the stream. Sending the
4838  *                  first flush packet will return success. Subsequent ones are
4839  *                  unnecessary and will return AVERROR_EOF. If the decoder
4840  *                  still has frames buffered, it will return them after sending
4841  *                  a flush packet.
4842  *
4843  * @return 0 on success, otherwise negative error code:
4844  *      AVERROR(EAGAIN):   input is not accepted right now - the packet must be
4845  *                         resent after trying to read output
4846  *      AVERROR_EOF:       the decoder has been flushed, and no new packets can
4847  *                         be sent to it (also returned if more than 1 flush
4848  *                         packet is sent)
4849  *      AVERROR(EINVAL):   codec not opened, it is an encoder, or requires flush
4850  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4851  *      other errors: legitimate decoding errors
4852  */
4853 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4854
4855 /**
4856  * Return decoded output data from a decoder.
4857  *
4858  * @param avctx codec context
4859  * @param frame This will be set to a reference-counted video or audio
4860  *              frame (depending on the decoder type) allocated by the
4861  *              decoder. Note that the function will always call
4862  *              av_frame_unref(frame) before doing anything else.
4863  *
4864  * @return
4865  *      0:                 success, a frame was returned
4866  *      AVERROR(EAGAIN):   output is not available right now - user must try
4867  *                         to send new input
4868  *      AVERROR_EOF:       the decoder has been fully flushed, and there will be
4869  *                         no more output frames
4870  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4871  *      other negative values: legitimate decoding errors
4872  */
4873 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4874
4875 /**
4876  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4877  * to retrieve buffered output packets.
4878  *
4879  * @param avctx     codec context
4880  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4881  *                  Ownership of the frame remains with the caller, and the
4882  *                  encoder will not write to the frame. The encoder may create
4883  *                  a reference to the frame data (or copy it if the frame is
4884  *                  not reference-counted).
4885  *                  It can be NULL, in which case it is considered a flush
4886  *                  packet.  This signals the end of the stream. If the encoder
4887  *                  still has packets buffered, it will return them after this
4888  *                  call. Once flushing mode has been entered, additional flush
4889  *                  packets are ignored, and sending frames will return
4890  *                  AVERROR_EOF.
4891  *
4892  *                  For audio:
4893  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4894  *                  can have any number of samples.
4895  *                  If it is not set, frame->nb_samples must be equal to
4896  *                  avctx->frame_size for all frames except the last.
4897  *                  The final frame may be smaller than avctx->frame_size.
4898  * @return 0 on success, otherwise negative error code:
4899  *      AVERROR(EAGAIN):   input is not accepted right now - the frame must be
4900  *                         resent after trying to read output packets
4901  *      AVERROR_EOF:       the encoder has been flushed, and no new frames can
4902  *                         be sent to it
4903  *      AVERROR(EINVAL):   codec not opened, refcounted_frames not set, it is a
4904  *                         decoder, or requires flush
4905  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4906  *      other errors: legitimate decoding errors
4907  */
4908 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4909
4910 /**
4911  * Read encoded data from the encoder.
4912  *
4913  * @param avctx codec context
4914  * @param avpkt This will be set to a reference-counted packet allocated by the
4915  *              encoder. Note that the function will always call
4916  *              av_frame_unref(frame) before doing anything else.
4917  * @return 0 on success, otherwise negative error code:
4918  *      AVERROR(EAGAIN):   output is not available right now - user must try
4919  *                         to send input
4920  *      AVERROR_EOF:       the encoder has been fully flushed, and there will be
4921  *                         no more output packets
4922  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4923  *      other errors: legitimate decoding errors
4924  */
4925 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4926
4927
4928 /**
4929  * @defgroup lavc_parsing Frame parsing
4930  * @{
4931  */
4932
4933 enum AVPictureStructure {
4934     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
4935     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
4936     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4937     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
4938 };
4939
4940 typedef struct AVCodecParserContext {
4941     void *priv_data;
4942     struct AVCodecParser *parser;
4943     int64_t frame_offset; /* offset of the current frame */
4944     int64_t cur_offset; /* current offset
4945                            (incremented by each av_parser_parse()) */
4946     int64_t next_frame_offset; /* offset of the next frame */
4947     /* video info */
4948     int pict_type; /* XXX: Put it back in AVCodecContext. */
4949     /**
4950      * This field is used for proper frame duration computation in lavf.
4951      * It signals, how much longer the frame duration of the current frame
4952      * is compared to normal frame duration.
4953      *
4954      * frame_duration = (1 + repeat_pict) * time_base
4955      *
4956      * It is used by codecs like H.264 to display telecined material.
4957      */
4958     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4959     int64_t pts;     /* pts of the current frame */
4960     int64_t dts;     /* dts of the current frame */
4961
4962     /* private data */
4963     int64_t last_pts;
4964     int64_t last_dts;
4965     int fetch_timestamp;
4966
4967 #define AV_PARSER_PTS_NB 4
4968     int cur_frame_start_index;
4969     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4970     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4971     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4972
4973     int flags;
4974 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4975 #define PARSER_FLAG_ONCE                      0x0002
4976 /// Set if the parser has a valid file offset
4977 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4978 #define PARSER_FLAG_USE_CODEC_TS              0x1000
4979
4980     int64_t offset;      ///< byte offset from starting packet start
4981     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4982
4983     /**
4984      * Set by parser to 1 for key frames and 0 for non-key frames.
4985      * It is initialized to -1, so if the parser doesn't set this flag,
4986      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4987      * will be used.
4988      */
4989     int key_frame;
4990
4991 #if FF_API_CONVERGENCE_DURATION
4992     /**
4993      * @deprecated unused
4994      */
4995     attribute_deprecated
4996     int64_t convergence_duration;
4997 #endif
4998
4999     // Timestamp generation support:
5000     /**
5001      * Synchronization point for start of timestamp generation.
5002      *
5003      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
5004      * (default).
5005      *
5006      * For example, this corresponds to presence of H.264 buffering period
5007      * SEI message.
5008      */
5009     int dts_sync_point;
5010
5011     /**
5012      * Offset of the current timestamp against last timestamp sync point in
5013      * units of AVCodecContext.time_base.
5014      *
5015      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5016      * contain a valid timestamp offset.
5017      *
5018      * Note that the timestamp of sync point has usually a nonzero
5019      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
5020      * the next frame after timestamp sync point will be usually 1.
5021      *
5022      * For example, this corresponds to H.264 cpb_removal_delay.
5023      */
5024     int dts_ref_dts_delta;
5025
5026     /**
5027      * Presentation delay of current frame in units of AVCodecContext.time_base.
5028      *
5029      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
5030      * contain valid non-negative timestamp delta (presentation time of a frame
5031      * must not lie in the past).
5032      *
5033      * This delay represents the difference between decoding and presentation
5034      * time of the frame.
5035      *
5036      * For example, this corresponds to H.264 dpb_output_delay.
5037      */
5038     int pts_dts_delta;
5039
5040     /**
5041      * Position of the packet in file.
5042      *
5043      * Analogous to cur_frame_pts/dts
5044      */
5045     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
5046
5047     /**
5048      * Byte position of currently parsed frame in stream.
5049      */
5050     int64_t pos;
5051
5052     /**
5053      * Previous frame byte position.
5054      */
5055     int64_t last_pos;
5056
5057     /**
5058      * Duration of the current frame.
5059      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
5060      * For all other types, this is in units of AVCodecContext.time_base.
5061      */
5062     int duration;
5063
5064     enum AVFieldOrder field_order;
5065
5066     /**
5067      * Indicate whether a picture is coded as a frame, top field or bottom field.
5068      *
5069      * For example, H.264 field_pic_flag equal to 0 corresponds to
5070      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
5071      * equal to 1 and bottom_field_flag equal to 0 corresponds to
5072      * AV_PICTURE_STRUCTURE_TOP_FIELD.
5073      */
5074     enum AVPictureStructure picture_structure;
5075
5076     /**
5077      * Picture number incremented in presentation or output order.
5078      * This field may be reinitialized at the first picture of a new sequence.
5079      *
5080      * For example, this corresponds to H.264 PicOrderCnt.
5081      */
5082     int output_picture_number;
5083
5084     /**
5085      * Dimensions of the decoded video intended for presentation.
5086      */
5087     int width;
5088     int height;
5089
5090     /**
5091      * Dimensions of the coded video.
5092      */
5093     int coded_width;
5094     int coded_height;
5095
5096     /**
5097      * The format of the coded data, corresponds to enum AVPixelFormat for video
5098      * and for enum AVSampleFormat for audio.
5099      *
5100      * Note that a decoder can have considerable freedom in how exactly it
5101      * decodes the data, so the format reported here might be different from the
5102      * one returned by a decoder.
5103      */
5104     int format;
5105 } AVCodecParserContext;
5106
5107 typedef struct AVCodecParser {
5108     int codec_ids[5]; /* several codec IDs are permitted */
5109     int priv_data_size;
5110     int (*parser_init)(AVCodecParserContext *s);
5111     /* This callback never returns an error, a negative value means that
5112      * the frame start was in a previous packet. */
5113     int (*parser_parse)(AVCodecParserContext *s,
5114                         AVCodecContext *avctx,
5115                         const uint8_t **poutbuf, int *poutbuf_size,
5116                         const uint8_t *buf, int buf_size);
5117     void (*parser_close)(AVCodecParserContext *s);
5118     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
5119     struct AVCodecParser *next;
5120 } AVCodecParser;
5121
5122 AVCodecParser *av_parser_next(const AVCodecParser *c);
5123
5124 void av_register_codec_parser(AVCodecParser *parser);
5125 AVCodecParserContext *av_parser_init(int codec_id);
5126
5127 /**
5128  * Parse a packet.
5129  *
5130  * @param s             parser context.
5131  * @param avctx         codec context.
5132  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
5133  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
5134  * @param buf           input buffer.
5135  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
5136  * @param pts           input presentation timestamp.
5137  * @param dts           input decoding timestamp.
5138  * @param pos           input byte position in stream.
5139  * @return the number of bytes of the input bitstream used.
5140  *
5141  * Example:
5142  * @code
5143  *   while(in_len){
5144  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
5145  *                                        in_data, in_len,
5146  *                                        pts, dts, pos);
5147  *       in_data += len;
5148  *       in_len  -= len;
5149  *
5150  *       if(size)
5151  *          decode_frame(data, size);
5152  *   }
5153  * @endcode
5154  */
5155 int av_parser_parse2(AVCodecParserContext *s,
5156                      AVCodecContext *avctx,
5157                      uint8_t **poutbuf, int *poutbuf_size,
5158                      const uint8_t *buf, int buf_size,
5159                      int64_t pts, int64_t dts,
5160                      int64_t pos);
5161
5162 /**
5163  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
5164  * @deprecated use AVBitStreamFilter
5165  */
5166 int av_parser_change(AVCodecParserContext *s,
5167                      AVCodecContext *avctx,
5168                      uint8_t **poutbuf, int *poutbuf_size,
5169                      const uint8_t *buf, int buf_size, int keyframe);
5170 void av_parser_close(AVCodecParserContext *s);
5171
5172 /**
5173  * @}
5174  * @}
5175  */
5176
5177 /**
5178  * @addtogroup lavc_encoding
5179  * @{
5180  */
5181
5182 /**
5183  * Find a registered encoder with a matching codec ID.
5184  *
5185  * @param id AVCodecID of the requested encoder
5186  * @return An encoder if one was found, NULL otherwise.
5187  */
5188 AVCodec *avcodec_find_encoder(enum AVCodecID id);
5189
5190 /**
5191  * Find a registered encoder with the specified name.
5192  *
5193  * @param name name of the requested encoder
5194  * @return An encoder if one was found, NULL otherwise.
5195  */
5196 AVCodec *avcodec_find_encoder_by_name(const char *name);
5197
5198 /**
5199  * Encode a frame of audio.
5200  *
5201  * Takes input samples from frame and writes the next output packet, if
5202  * available, to avpkt. The output packet does not necessarily contain data for
5203  * the most recent frame, as encoders can delay, split, and combine input frames
5204  * internally as needed.
5205  *
5206  * @param avctx     codec context
5207  * @param avpkt     output AVPacket.
5208  *                  The user can supply an output buffer by setting
5209  *                  avpkt->data and avpkt->size prior to calling the
5210  *                  function, but if the size of the user-provided data is not
5211  *                  large enough, encoding will fail. If avpkt->data and
5212  *                  avpkt->size are set, avpkt->destruct must also be set. All
5213  *                  other AVPacket fields will be reset by the encoder using
5214  *                  av_init_packet(). If avpkt->data is NULL, the encoder will
5215  *                  allocate it. The encoder will set avpkt->size to the size
5216  *                  of the output packet.
5217  *
5218  *                  If this function fails or produces no output, avpkt will be
5219  *                  freed using av_packet_unref().
5220  * @param[in] frame AVFrame containing the raw audio data to be encoded.
5221  *                  May be NULL when flushing an encoder that has the
5222  *                  AV_CODEC_CAP_DELAY capability set.
5223  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
5224  *                  can have any number of samples.
5225  *                  If it is not set, frame->nb_samples must be equal to
5226  *                  avctx->frame_size for all frames except the last.
5227  *                  The final frame may be smaller than avctx->frame_size.
5228  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5229  *                            output packet is non-empty, and to 0 if it is
5230  *                            empty. If the function returns an error, the
5231  *                            packet can be assumed to be invalid, and the
5232  *                            value of got_packet_ptr is undefined and should
5233  *                            not be used.
5234  * @return          0 on success, negative error code on failure
5235  *
5236  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5237  */
5238 attribute_deprecated
5239 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
5240                           const AVFrame *frame, int *got_packet_ptr);
5241
5242 /**
5243  * Encode a frame of video.
5244  *
5245  * Takes input raw video data from frame and writes the next output packet, if
5246  * available, to avpkt. The output packet does not necessarily contain data for
5247  * the most recent frame, as encoders can delay and reorder input frames
5248  * internally as needed.
5249  *
5250  * @param avctx     codec context
5251  * @param avpkt     output AVPacket.
5252  *                  The user can supply an output buffer by setting
5253  *                  avpkt->data and avpkt->size prior to calling the
5254  *                  function, but if the size of the user-provided data is not
5255  *                  large enough, encoding will fail. All other AVPacket fields
5256  *                  will be reset by the encoder using av_init_packet(). If
5257  *                  avpkt->data is NULL, the encoder will allocate it.
5258  *                  The encoder will set avpkt->size to the size of the
5259  *                  output packet. The returned data (if any) belongs to the
5260  *                  caller, he is responsible for freeing it.
5261  *
5262  *                  If this function fails or produces no output, avpkt will be
5263  *                  freed using av_packet_unref().
5264  * @param[in] frame AVFrame containing the raw video data to be encoded.
5265  *                  May be NULL when flushing an encoder that has the
5266  *                  AV_CODEC_CAP_DELAY capability set.
5267  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
5268  *                            output packet is non-empty, and to 0 if it is
5269  *                            empty. If the function returns an error, the
5270  *                            packet can be assumed to be invalid, and the
5271  *                            value of got_packet_ptr is undefined and should
5272  *                            not be used.
5273  * @return          0 on success, negative error code on failure
5274  *
5275  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
5276  */
5277 attribute_deprecated
5278 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
5279                           const AVFrame *frame, int *got_packet_ptr);
5280
5281 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
5282                             const AVSubtitle *sub);
5283
5284
5285 /**
5286  * @}
5287  */
5288
5289 #if FF_API_AVCODEC_RESAMPLE
5290 /**
5291  * @defgroup lavc_resample Audio resampling
5292  * @ingroup libavc
5293  * @deprecated use libswresample instead
5294  *
5295  * @{
5296  */
5297 struct ReSampleContext;
5298 struct AVResampleContext;
5299
5300 typedef struct ReSampleContext ReSampleContext;
5301
5302 /**
5303  *  Initialize audio resampling context.
5304  *
5305  * @param output_channels  number of output channels
5306  * @param input_channels   number of input channels
5307  * @param output_rate      output sample rate
5308  * @param input_rate       input sample rate
5309  * @param sample_fmt_out   requested output sample format
5310  * @param sample_fmt_in    input sample format
5311  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
5312  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5313  * @param linear           if 1 then the used FIR filter will be linearly interpolated
5314                            between the 2 closest, if 0 the closest will be used
5315  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
5316  * @return allocated ReSampleContext, NULL if error occurred
5317  */
5318 attribute_deprecated
5319 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
5320                                         int output_rate, int input_rate,
5321                                         enum AVSampleFormat sample_fmt_out,
5322                                         enum AVSampleFormat sample_fmt_in,
5323                                         int filter_length, int log2_phase_count,
5324                                         int linear, double cutoff);
5325
5326 attribute_deprecated
5327 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
5328
5329 /**
5330  * Free resample context.
5331  *
5332  * @param s a non-NULL pointer to a resample context previously
5333  *          created with av_audio_resample_init()
5334  */
5335 attribute_deprecated
5336 void audio_resample_close(ReSampleContext *s);
5337
5338
5339 /**
5340  * Initialize an audio resampler.
5341  * Note, if either rate is not an integer then simply scale both rates up so they are.
5342  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
5343  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
5344  * @param linear If 1 then the used FIR filter will be linearly interpolated
5345                  between the 2 closest, if 0 the closest will be used
5346  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
5347  */
5348 attribute_deprecated
5349 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
5350
5351 /**
5352  * Resample an array of samples using a previously configured context.
5353  * @param src an array of unconsumed samples
5354  * @param consumed the number of samples of src which have been consumed are returned here
5355  * @param src_size the number of unconsumed samples available
5356  * @param dst_size the amount of space in samples available in dst
5357  * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
5358  * @return the number of samples written in dst or -1 if an error occurred
5359  */
5360 attribute_deprecated
5361 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
5362
5363
5364 /**
5365  * Compensate samplerate/timestamp drift. The compensation is done by changing
5366  * the resampler parameters, so no audible clicks or similar distortions occur
5367  * @param compensation_distance distance in output samples over which the compensation should be performed
5368  * @param sample_delta number of output samples which should be output less
5369  *
5370  * example: av_resample_compensate(c, 10, 500)
5371  * here instead of 510 samples only 500 samples would be output
5372  *
5373  * note, due to rounding the actual compensation might be slightly different,
5374  * especially if the compensation_distance is large and the in_rate used during init is small
5375  */
5376 attribute_deprecated
5377 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
5378 attribute_deprecated
5379 void av_resample_close(struct AVResampleContext *c);
5380
5381 /**
5382  * @}
5383  */
5384 #endif
5385
5386 #if FF_API_AVPICTURE
5387 /**
5388  * @addtogroup lavc_picture
5389  * @{
5390  */
5391
5392 /**
5393  * @deprecated unused
5394  */
5395 attribute_deprecated
5396 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
5397
5398 /**
5399  * @deprecated unused
5400  */
5401 attribute_deprecated
5402 void avpicture_free(AVPicture *picture);
5403
5404 /**
5405  * @deprecated use av_image_fill_arrays() instead.
5406  */
5407 attribute_deprecated
5408 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
5409                    enum AVPixelFormat pix_fmt, int width, int height);
5410
5411 /**
5412  * @deprecated use av_image_copy_to_buffer() instead.
5413  */
5414 attribute_deprecated
5415 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
5416                      int width, int height,
5417                      unsigned char *dest, int dest_size);
5418
5419 /**
5420  * @deprecated use av_image_get_buffer_size() instead.
5421  */
5422 attribute_deprecated
5423 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
5424
5425 /**
5426  * @deprecated av_image_copy() instead.
5427  */
5428 attribute_deprecated
5429 void av_picture_copy(AVPicture *dst, const AVPicture *src,
5430                      enum AVPixelFormat pix_fmt, int width, int height);
5431
5432 /**
5433  * @deprecated unused
5434  */
5435 attribute_deprecated
5436 int av_picture_crop(AVPicture *dst, const AVPicture *src,
5437                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
5438
5439 /**
5440  * @deprecated unused
5441  */
5442 attribute_deprecated
5443 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
5444             int padtop, int padbottom, int padleft, int padright, int *color);
5445
5446 /**
5447  * @}
5448  */
5449 #endif
5450
5451 /**
5452  * @defgroup lavc_misc Utility functions
5453  * @ingroup libavc
5454  *
5455  * Miscellaneous utility functions related to both encoding and decoding
5456  * (or neither).
5457  * @{
5458  */
5459
5460 /**
5461  * @defgroup lavc_misc_pixfmt Pixel formats
5462  *
5463  * Functions for working with pixel formats.
5464  * @{
5465  */
5466
5467 /**
5468  * Utility function to access log2_chroma_w log2_chroma_h from
5469  * the pixel format AVPixFmtDescriptor.
5470  *
5471  * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
5472  * for one that returns a failure code and continues in case of invalid
5473  * pix_fmts.
5474  *
5475  * @param[in]  pix_fmt the pixel format
5476  * @param[out] h_shift store log2_chroma_w
5477  * @param[out] v_shift store log2_chroma_h
5478  *
5479  * @see av_pix_fmt_get_chroma_sub_sample
5480  */
5481
5482 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
5483
5484 /**
5485  * Return a value representing the fourCC code associated to the
5486  * pixel format pix_fmt, or 0 if no associated fourCC code can be
5487  * found.
5488  */
5489 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
5490
5491 /**
5492  * @deprecated see av_get_pix_fmt_loss()
5493  */
5494 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
5495                              int has_alpha);
5496
5497 /**
5498  * Find the best pixel format to convert to given a certain source pixel
5499  * format.  When converting from one pixel format to another, information loss
5500  * may occur.  For example, when converting from RGB24 to GRAY, the color
5501  * information will be lost. Similarly, other losses occur when converting from
5502  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
5503  * the given pixel formats should be used to suffer the least amount of loss.
5504  * The pixel formats from which it chooses one, are determined by the
5505  * pix_fmt_list parameter.
5506  *
5507  *
5508  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5509  * @param[in] src_pix_fmt source pixel format
5510  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5511  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5512  * @return The best pixel format to convert to or -1 if none was found.
5513  */
5514 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5515                                             enum AVPixelFormat src_pix_fmt,
5516                                             int has_alpha, int *loss_ptr);
5517
5518 /**
5519  * @deprecated see av_find_best_pix_fmt_of_2()
5520  */
5521 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5522                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5523
5524 attribute_deprecated
5525 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5526 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5527                                               enum AVPixelFormat src_pix_fmt,
5528                                               int has_alpha, int *loss_ptr);
5529 #else
5530 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5531                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5532 #endif
5533
5534
5535 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5536
5537 /**
5538  * @}
5539  */
5540
5541 #if FF_API_SET_DIMENSIONS
5542 /**
5543  * @deprecated this function is not supposed to be used from outside of lavc
5544  */
5545 attribute_deprecated
5546 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5547 #endif
5548
5549 /**
5550  * Put a string representing the codec tag codec_tag in buf.
5551  *
5552  * @param buf       buffer to place codec tag in
5553  * @param buf_size size in bytes of buf
5554  * @param codec_tag codec tag to assign
5555  * @return the length of the string that would have been generated if
5556  * enough space had been available, excluding the trailing null
5557  */
5558 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5559
5560 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5561
5562 /**
5563  * Return a name for the specified profile, if available.
5564  *
5565  * @param codec the codec that is searched for the given profile
5566  * @param profile the profile value for which a name is requested
5567  * @return A name for the profile if found, NULL otherwise.
5568  */
5569 const char *av_get_profile_name(const AVCodec *codec, int profile);
5570
5571 /**
5572  * Return a name for the specified profile, if available.
5573  *
5574  * @param codec_id the ID of the codec to which the requested profile belongs
5575  * @param profile the profile value for which a name is requested
5576  * @return A name for the profile if found, NULL otherwise.
5577  *
5578  * @note unlike av_get_profile_name(), which searches a list of profiles
5579  *       supported by a specific decoder or encoder implementation, this
5580  *       function searches the list of profiles from the AVCodecDescriptor
5581  */
5582 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5583
5584 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5585 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5586 //FIXME func typedef
5587
5588 /**
5589  * Fill AVFrame audio data and linesize pointers.
5590  *
5591  * The buffer buf must be a preallocated buffer with a size big enough
5592  * to contain the specified samples amount. The filled AVFrame data
5593  * pointers will point to this buffer.
5594  *
5595  * AVFrame extended_data channel pointers are allocated if necessary for
5596  * planar audio.
5597  *
5598  * @param frame       the AVFrame
5599  *                    frame->nb_samples must be set prior to calling the
5600  *                    function. This function fills in frame->data,
5601  *                    frame->extended_data, frame->linesize[0].
5602  * @param nb_channels channel count
5603  * @param sample_fmt  sample format
5604  * @param buf         buffer to use for frame data
5605  * @param buf_size    size of buffer
5606  * @param align       plane size sample alignment (0 = default)
5607  * @return            >=0 on success, negative error code on failure
5608  * @todo return the size in bytes required to store the samples in
5609  * case of success, at the next libavutil bump
5610  */
5611 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5612                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
5613                              int buf_size, int align);
5614
5615 /**
5616  * Reset the internal decoder state / flush internal buffers. Should be called
5617  * e.g. when seeking or when switching to a different stream.
5618  *
5619  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5620  * this invalidates the frames previously returned from the decoder. When
5621  * refcounted frames are used, the decoder just releases any references it might
5622  * keep internally, but the caller's reference remains valid.
5623  */
5624 void avcodec_flush_buffers(AVCodecContext *avctx);
5625
5626 /**
5627  * Return codec bits per sample.
5628  *
5629  * @param[in] codec_id the codec
5630  * @return Number of bits per sample or zero if unknown for the given codec.
5631  */
5632 int av_get_bits_per_sample(enum AVCodecID codec_id);
5633
5634 /**
5635  * Return the PCM codec associated with a sample format.
5636  * @param be  endianness, 0 for little, 1 for big,
5637  *            -1 (or anything else) for native
5638  * @return  AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5639  */
5640 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5641
5642 /**
5643  * Return codec bits per sample.
5644  * Only return non-zero if the bits per sample is exactly correct, not an
5645  * approximation.
5646  *
5647  * @param[in] codec_id the codec
5648  * @return Number of bits per sample or zero if unknown for the given codec.
5649  */
5650 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5651
5652 /**
5653  * Return audio frame duration.
5654  *
5655  * @param avctx        codec context
5656  * @param frame_bytes  size of the frame, or 0 if unknown
5657  * @return             frame duration, in samples, if known. 0 if not able to
5658  *                     determine.
5659  */
5660 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5661
5662 /**
5663  * This function is the same as av_get_audio_frame_duration(), except it works
5664  * with AVCodecParameters instead of an AVCodecContext.
5665  */
5666 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5667
5668 #if FF_API_OLD_BSF
5669 typedef struct AVBitStreamFilterContext {
5670     void *priv_data;
5671     struct AVBitStreamFilter *filter;
5672     AVCodecParserContext *parser;
5673     struct AVBitStreamFilterContext *next;
5674     /**
5675      * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5676      * Not for access by library users.
5677      */
5678     char *args;
5679 } AVBitStreamFilterContext;
5680 #endif
5681
5682 typedef struct AVBSFInternal AVBSFInternal;
5683
5684 /**
5685  * The bitstream filter state.
5686  *
5687  * This struct must be allocated with av_bsf_alloc() and freed with
5688  * av_bsf_free().
5689  *
5690  * The fields in the struct will only be changed (by the caller or by the
5691  * filter) as described in their documentation, and are to be considered
5692  * immutable otherwise.
5693  */
5694 typedef struct AVBSFContext {
5695     /**
5696      * A class for logging and AVOptions
5697      */
5698     const AVClass *av_class;
5699
5700     /**
5701      * The bitstream filter this context is an instance of.
5702      */
5703     const struct AVBitStreamFilter *filter;
5704
5705     /**
5706      * Opaque libavcodec internal data. Must not be touched by the caller in any
5707      * way.
5708      */
5709     AVBSFInternal *internal;
5710
5711     /**
5712      * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5713      * this is an AVOptions-enabled struct.
5714      */
5715     void *priv_data;
5716
5717     /**
5718      * Parameters of the input stream. Set by the caller before av_bsf_init().
5719      */
5720     AVCodecParameters *par_in;
5721
5722     /**
5723      * Parameters of the output stream. Set by the filter in av_bsf_init().
5724      */
5725     AVCodecParameters *par_out;
5726
5727     /**
5728      * The timebase used for the timestamps of the input packets. Set by the
5729      * caller before av_bsf_init().
5730      */
5731     AVRational time_base_in;
5732
5733     /**
5734      * The timebase used for the timestamps of the output packets. Set by the
5735      * filter in av_bsf_init().
5736      */
5737     AVRational time_base_out;
5738 } AVBSFContext;
5739
5740 typedef struct AVBitStreamFilter {
5741     const char *name;
5742
5743     /**
5744      * A list of codec ids supported by the filter, terminated by
5745      * AV_CODEC_ID_NONE.
5746      * May be NULL, in that case the bitstream filter works with any codec id.
5747      */
5748     const enum AVCodecID *codec_ids;
5749
5750     /**
5751      * A class for the private data, used to declare bitstream filter private
5752      * AVOptions. This field is NULL for bitstream filters that do not declare
5753      * any options.
5754      *
5755      * If this field is non-NULL, the first member of the filter private data
5756      * must be a pointer to AVClass, which will be set by libavcodec generic
5757      * code to this class.
5758      */
5759     const AVClass *priv_class;
5760
5761     /*****************************************************************
5762      * No fields below this line are part of the public API. They
5763      * may not be used outside of libavcodec and can be changed and
5764      * removed at will.
5765      * New public fields should be added right above.
5766      *****************************************************************
5767      */
5768
5769     int priv_data_size;
5770     int (*init)(AVBSFContext *ctx);
5771     int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5772     void (*close)(AVBSFContext *ctx);
5773 } AVBitStreamFilter;
5774
5775 #if FF_API_OLD_BSF
5776 /**
5777  * Register a bitstream filter.
5778  *
5779  * The filter will be accessible to the application code through
5780  * av_bitstream_filter_next() or can be directly initialized with
5781  * av_bitstream_filter_init().
5782  *
5783  * @see avcodec_register_all()
5784  */
5785 attribute_deprecated
5786 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5787
5788 /**
5789  * Create and initialize a bitstream filter context given a bitstream
5790  * filter name.
5791  *
5792  * The returned context must be freed with av_bitstream_filter_close().
5793  *
5794  * @param name    the name of the bitstream filter
5795  * @return a bitstream filter context if a matching filter was found
5796  * and successfully initialized, NULL otherwise
5797  */
5798 attribute_deprecated
5799 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5800
5801 /**
5802  * Filter bitstream.
5803  *
5804  * This function filters the buffer buf with size buf_size, and places the
5805  * filtered buffer in the buffer pointed to by poutbuf.
5806  *
5807  * The output buffer must be freed by the caller.
5808  *
5809  * @param bsfc            bitstream filter context created by av_bitstream_filter_init()
5810  * @param avctx           AVCodecContext accessed by the filter, may be NULL.
5811  *                        If specified, this must point to the encoder context of the
5812  *                        output stream the packet is sent to.
5813  * @param args            arguments which specify the filter configuration, may be NULL
5814  * @param poutbuf         pointer which is updated to point to the filtered buffer
5815  * @param poutbuf_size    pointer which is updated to the filtered buffer size in bytes
5816  * @param buf             buffer containing the data to filter
5817  * @param buf_size        size in bytes of buf
5818  * @param keyframe        set to non-zero if the buffer to filter corresponds to a key-frame packet data
5819  * @return >= 0 in case of success, or a negative error code in case of failure
5820  *
5821  * If the return value is positive, an output buffer is allocated and
5822  * is available in *poutbuf, and is distinct from the input buffer.
5823  *
5824  * If the return value is 0, the output buffer is not allocated and
5825  * should be considered identical to the input buffer, or in case
5826  * *poutbuf was set it points to the input buffer (not necessarily to
5827  * its starting address). A special case is if *poutbuf was set to NULL and
5828  * *poutbuf_size was set to 0, which indicates the packet should be dropped.
5829  */
5830 attribute_deprecated
5831 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5832                                AVCodecContext *avctx, const char *args,
5833                                uint8_t **poutbuf, int *poutbuf_size,
5834                                const uint8_t *buf, int buf_size, int keyframe);
5835
5836 /**
5837  * Release bitstream filter context.
5838  *
5839  * @param bsf the bitstream filter context created with
5840  * av_bitstream_filter_init(), can be NULL
5841  */
5842 attribute_deprecated
5843 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5844
5845 /**
5846  * If f is NULL, return the first registered bitstream filter,
5847  * if f is non-NULL, return the next registered bitstream filter
5848  * after f, or NULL if f is the last one.
5849  *
5850  * This function can be used to iterate over all registered bitstream
5851  * filters.
5852  */
5853 attribute_deprecated
5854 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5855 #endif
5856
5857 /**
5858  * @return a bitstream filter with the specified name or NULL if no such
5859  *         bitstream filter exists.
5860  */
5861 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5862
5863 /**
5864  * Iterate over all registered bitstream filters.
5865  *
5866  * @param opaque a pointer where libavcodec will store the iteration state. Must
5867  *               point to NULL to start the iteration.
5868  *
5869  * @return the next registered bitstream filter or NULL when the iteration is
5870  *         finished
5871  */
5872 const AVBitStreamFilter *av_bsf_next(void **opaque);
5873
5874 /**
5875  * Allocate a context for a given bitstream filter. The caller must fill in the
5876  * context parameters as described in the documentation and then call
5877  * av_bsf_init() before sending any data to the filter.
5878  *
5879  * @param filter the filter for which to allocate an instance.
5880  * @param ctx a pointer into which the pointer to the newly-allocated context
5881  *            will be written. It must be freed with av_bsf_free() after the
5882  *            filtering is done.
5883  *
5884  * @return 0 on success, a negative AVERROR code on failure
5885  */
5886 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5887
5888 /**
5889  * Prepare the filter for use, after all the parameters and options have been
5890  * set.
5891  */
5892 int av_bsf_init(AVBSFContext *ctx);
5893
5894 /**
5895  * Submit a packet for filtering.
5896  *
5897  * After sending each packet, the filter must be completely drained by calling
5898  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5899  * AVERROR_EOF.
5900  *
5901  * @param pkt the packet to filter. The bitstream filter will take ownership of
5902  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5903  * This parameter may be NULL, which signals the end of the stream (i.e. no more
5904  * packets will be sent). That will cause the filter to output any packets it
5905  * may have buffered internally.
5906  *
5907  * @return 0 on success, a negative AVERROR on error.
5908  */
5909 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5910
5911 /**
5912  * Retrieve a filtered packet.
5913  *
5914  * @param[out] pkt this struct will be filled with the contents of the filtered
5915  *                 packet. It is owned by the caller and must be freed using
5916  *                 av_packet_unref() when it is no longer needed.
5917  *                 This parameter should be "clean" (i.e. freshly allocated
5918  *                 with av_packet_alloc() or unreffed with av_packet_unref())
5919  *                 when this function is called. If this function returns
5920  *                 successfully, the contents of pkt will be completely
5921  *                 overwritten by the returned data. On failure, pkt is not
5922  *                 touched.
5923  *
5924  * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5925  * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5926  * will be no further output from the filter. Another negative AVERROR value if
5927  * an error occurs.
5928  *
5929  * @note one input packet may result in several output packets, so after sending
5930  * a packet with av_bsf_send_packet(), this function needs to be called
5931  * repeatedly until it stops returning 0. It is also possible for a filter to
5932  * output fewer packets than were sent to it, so this function may return
5933  * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5934  */
5935 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5936
5937 /**
5938  * Free a bitstream filter context and everything associated with it; write NULL
5939  * into the supplied pointer.
5940  */
5941 void av_bsf_free(AVBSFContext **ctx);
5942
5943 /**
5944  * Get the AVClass for AVBSFContext. It can be used in combination with
5945  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5946  *
5947  * @see av_opt_find().
5948  */
5949 const AVClass *av_bsf_get_class(void);
5950
5951 /* memory */
5952
5953 /**
5954  * Same behaviour av_fast_malloc but the buffer has additional
5955  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5956  *
5957  * In addition the whole buffer will initially and after resizes
5958  * be 0-initialized so that no uninitialized data will ever appear.
5959  */
5960 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5961
5962 /**
5963  * Same behaviour av_fast_padded_malloc except that buffer will always
5964  * be 0-initialized after call.
5965  */
5966 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5967
5968 /**
5969  * Encode extradata length to a buffer. Used by xiph codecs.
5970  *
5971  * @param s buffer to write to; must be at least (v/255+1) bytes long
5972  * @param v size of extradata in bytes
5973  * @return number of bytes written to the buffer.
5974  */
5975 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5976
5977 #if FF_API_MISSING_SAMPLE
5978 /**
5979  * Log a generic warning message about a missing feature. This function is
5980  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5981  * only, and would normally not be used by applications.
5982  * @param[in] avc a pointer to an arbitrary struct of which the first field is
5983  * a pointer to an AVClass struct
5984  * @param[in] feature string containing the name of the missing feature
5985  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5986  * If want_sample is non-zero, additional verbiage will be added to the log
5987  * message which tells the user how to report samples to the development
5988  * mailing list.
5989  * @deprecated Use avpriv_report_missing_feature() instead.
5990  */
5991 attribute_deprecated
5992 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5993
5994 /**
5995  * Log a generic warning message asking for a sample. This function is
5996  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5997  * only, and would normally not be used by applications.
5998  * @param[in] avc a pointer to an arbitrary struct of which the first field is
5999  * a pointer to an AVClass struct
6000  * @param[in] msg string containing an optional message, or NULL if no message
6001  * @deprecated Use avpriv_request_sample() instead.
6002  */
6003 attribute_deprecated
6004 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
6005 #endif /* FF_API_MISSING_SAMPLE */
6006
6007 /**
6008  * Register the hardware accelerator hwaccel.
6009  */
6010 void av_register_hwaccel(AVHWAccel *hwaccel);
6011
6012 /**
6013  * If hwaccel is NULL, returns the first registered hardware accelerator,
6014  * if hwaccel is non-NULL, returns the next registered hardware accelerator
6015  * after hwaccel, or NULL if hwaccel is the last one.
6016  */
6017 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
6018
6019
6020 /**
6021  * Lock operation used by lockmgr
6022  */
6023 enum AVLockOp {
6024   AV_LOCK_CREATE,  ///< Create a mutex
6025   AV_LOCK_OBTAIN,  ///< Lock the mutex
6026   AV_LOCK_RELEASE, ///< Unlock the mutex
6027   AV_LOCK_DESTROY, ///< Free mutex resources
6028 };
6029
6030 /**
6031  * Register a user provided lock manager supporting the operations
6032  * specified by AVLockOp. The "mutex" argument to the function points
6033  * to a (void *) where the lockmgr should store/get a pointer to a user
6034  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
6035  * value left by the last call for all other ops. If the lock manager is
6036  * unable to perform the op then it should leave the mutex in the same
6037  * state as when it was called and return a non-zero value. However,
6038  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
6039  * have been successfully destroyed. If av_lockmgr_register succeeds
6040  * it will return a non-negative value, if it fails it will return a
6041  * negative value and destroy all mutex and unregister all callbacks.
6042  * av_lockmgr_register is not thread-safe, it must be called from a
6043  * single thread before any calls which make use of locking are used.
6044  *
6045  * @param cb User defined callback. av_lockmgr_register invokes calls
6046  *           to this callback and the previously registered callback.
6047  *           The callback will be used to create more than one mutex
6048  *           each of which must be backed by its own underlying locking
6049  *           mechanism (i.e. do not use a single static object to
6050  *           implement your lock manager). If cb is set to NULL the
6051  *           lockmgr will be unregistered.
6052  */
6053 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
6054
6055 /**
6056  * Get the type of the given codec.
6057  */
6058 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
6059
6060 /**
6061  * Get the name of a codec.
6062  * @return  a static string identifying the codec; never NULL
6063  */
6064 const char *avcodec_get_name(enum AVCodecID id);
6065
6066 /**
6067  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
6068  * with no corresponding avcodec_close()), 0 otherwise.
6069  */
6070 int avcodec_is_open(AVCodecContext *s);
6071
6072 /**
6073  * @return a non-zero number if codec is an encoder, zero otherwise
6074  */
6075 int av_codec_is_encoder(const AVCodec *codec);
6076
6077 /**
6078  * @return a non-zero number if codec is a decoder, zero otherwise
6079  */
6080 int av_codec_is_decoder(const AVCodec *codec);
6081
6082 /**
6083  * @return descriptor for given codec ID or NULL if no descriptor exists.
6084  */
6085 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
6086
6087 /**
6088  * Iterate over all codec descriptors known to libavcodec.
6089  *
6090  * @param prev previous descriptor. NULL to get the first descriptor.
6091  *
6092  * @return next descriptor or NULL after the last descriptor
6093  */
6094 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
6095
6096 /**
6097  * @return codec descriptor with the given name or NULL if no such descriptor
6098  *         exists.
6099  */
6100 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
6101
6102 /**
6103  * Allocate a CPB properties structure and initialize its fields to default
6104  * values.
6105  *
6106  * @param size if non-NULL, the size of the allocated struct will be written
6107  *             here. This is useful for embedding it in side data.
6108  *
6109  * @return the newly allocated struct or NULL on failure
6110  */
6111 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
6112
6113 /**
6114  * @}
6115  */
6116
6117 #endif /* AVCODEC_AVCODEC_H */