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