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