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