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