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