Canopus Lossless decoder
[ffmpeg.git] / 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  * external API header
27  */
28
29 #include <errno.h>
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37
38 #include "libavcodec/version.h"
39 /**
40  * @defgroup libavc Encoding/Decoding Library
41  * @{
42  *
43  * @defgroup lavc_decoding Decoding
44  * @{
45  * @}
46  *
47  * @defgroup lavc_encoding Encoding
48  * @{
49  * @}
50  *
51  * @defgroup lavc_codec Codecs
52  * @{
53  * @defgroup lavc_codec_native Native Codecs
54  * @{
55  * @}
56  * @defgroup lavc_codec_wrappers External library wrappers
57  * @{
58  * @}
59  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
60  * @{
61  * @}
62  * @}
63  * @defgroup lavc_internal Internal
64  * @{
65  * @}
66  * @}
67  *
68  */
69
70 /**
71  * @defgroup lavc_core Core functions/structures.
72  * @ingroup libavc
73  *
74  * Basic definitions, functions for querying libavcodec capabilities,
75  * allocating core structures, etc.
76  * @{
77  */
78
79 /**
80  * Identify the syntax and semantics of the bitstream.
81  * The principle is roughly:
82  * Two decoders with the same ID can decode the same streams.
83  * Two encoders with the same ID can encode compatible streams.
84  * There may be slight deviations from the principle due to implementation
85  * details.
86  *
87  * If you add a codec ID to this list, add it so that
88  * 1. no value of a existing codec ID changes (that would break ABI),
89  * 2. it is as close as possible to similar codecs.
90  */
91 enum CodecID {
92     CODEC_ID_NONE,
93
94     /* video codecs */
95     CODEC_ID_MPEG1VIDEO,
96     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
97     CODEC_ID_MPEG2VIDEO_XVMC,
98     CODEC_ID_H261,
99     CODEC_ID_H263,
100     CODEC_ID_RV10,
101     CODEC_ID_RV20,
102     CODEC_ID_MJPEG,
103     CODEC_ID_MJPEGB,
104     CODEC_ID_LJPEG,
105     CODEC_ID_SP5X,
106     CODEC_ID_JPEGLS,
107     CODEC_ID_MPEG4,
108     CODEC_ID_RAWVIDEO,
109     CODEC_ID_MSMPEG4V1,
110     CODEC_ID_MSMPEG4V2,
111     CODEC_ID_MSMPEG4V3,
112     CODEC_ID_WMV1,
113     CODEC_ID_WMV2,
114     CODEC_ID_H263P,
115     CODEC_ID_H263I,
116     CODEC_ID_FLV1,
117     CODEC_ID_SVQ1,
118     CODEC_ID_SVQ3,
119     CODEC_ID_DVVIDEO,
120     CODEC_ID_HUFFYUV,
121     CODEC_ID_CYUV,
122     CODEC_ID_H264,
123     CODEC_ID_INDEO3,
124     CODEC_ID_VP3,
125     CODEC_ID_THEORA,
126     CODEC_ID_ASV1,
127     CODEC_ID_ASV2,
128     CODEC_ID_FFV1,
129     CODEC_ID_4XM,
130     CODEC_ID_VCR1,
131     CODEC_ID_CLJR,
132     CODEC_ID_MDEC,
133     CODEC_ID_ROQ,
134     CODEC_ID_INTERPLAY_VIDEO,
135     CODEC_ID_XAN_WC3,
136     CODEC_ID_XAN_WC4,
137     CODEC_ID_RPZA,
138     CODEC_ID_CINEPAK,
139     CODEC_ID_WS_VQA,
140     CODEC_ID_MSRLE,
141     CODEC_ID_MSVIDEO1,
142     CODEC_ID_IDCIN,
143     CODEC_ID_8BPS,
144     CODEC_ID_SMC,
145     CODEC_ID_FLIC,
146     CODEC_ID_TRUEMOTION1,
147     CODEC_ID_VMDVIDEO,
148     CODEC_ID_MSZH,
149     CODEC_ID_ZLIB,
150     CODEC_ID_QTRLE,
151     CODEC_ID_SNOW,
152     CODEC_ID_TSCC,
153     CODEC_ID_ULTI,
154     CODEC_ID_QDRAW,
155     CODEC_ID_VIXL,
156     CODEC_ID_QPEG,
157     CODEC_ID_PNG,
158     CODEC_ID_PPM,
159     CODEC_ID_PBM,
160     CODEC_ID_PGM,
161     CODEC_ID_PGMYUV,
162     CODEC_ID_PAM,
163     CODEC_ID_FFVHUFF,
164     CODEC_ID_RV30,
165     CODEC_ID_RV40,
166     CODEC_ID_VC1,
167     CODEC_ID_WMV3,
168     CODEC_ID_LOCO,
169     CODEC_ID_WNV1,
170     CODEC_ID_AASC,
171     CODEC_ID_INDEO2,
172     CODEC_ID_FRAPS,
173     CODEC_ID_TRUEMOTION2,
174     CODEC_ID_BMP,
175     CODEC_ID_CSCD,
176     CODEC_ID_MMVIDEO,
177     CODEC_ID_ZMBV,
178     CODEC_ID_AVS,
179     CODEC_ID_SMACKVIDEO,
180     CODEC_ID_NUV,
181     CODEC_ID_KMVC,
182     CODEC_ID_FLASHSV,
183     CODEC_ID_CAVS,
184     CODEC_ID_JPEG2000,
185     CODEC_ID_VMNC,
186     CODEC_ID_VP5,
187     CODEC_ID_VP6,
188     CODEC_ID_VP6F,
189     CODEC_ID_TARGA,
190     CODEC_ID_DSICINVIDEO,
191     CODEC_ID_TIERTEXSEQVIDEO,
192     CODEC_ID_TIFF,
193     CODEC_ID_GIF,
194     CODEC_ID_DXA,
195     CODEC_ID_DNXHD,
196     CODEC_ID_THP,
197     CODEC_ID_SGI,
198     CODEC_ID_C93,
199     CODEC_ID_BETHSOFTVID,
200     CODEC_ID_PTX,
201     CODEC_ID_TXD,
202     CODEC_ID_VP6A,
203     CODEC_ID_AMV,
204     CODEC_ID_VB,
205     CODEC_ID_PCX,
206     CODEC_ID_SUNRAST,
207     CODEC_ID_INDEO4,
208     CODEC_ID_INDEO5,
209     CODEC_ID_MIMIC,
210     CODEC_ID_RL2,
211     CODEC_ID_ESCAPE124,
212     CODEC_ID_DIRAC,
213     CODEC_ID_BFI,
214     CODEC_ID_CMV,
215     CODEC_ID_MOTIONPIXELS,
216     CODEC_ID_TGV,
217     CODEC_ID_TGQ,
218     CODEC_ID_TQI,
219     CODEC_ID_AURA,
220     CODEC_ID_AURA2,
221     CODEC_ID_V210X,
222     CODEC_ID_TMV,
223     CODEC_ID_V210,
224     CODEC_ID_DPX,
225     CODEC_ID_MAD,
226     CODEC_ID_FRWU,
227     CODEC_ID_FLASHSV2,
228     CODEC_ID_CDGRAPHICS,
229     CODEC_ID_R210,
230     CODEC_ID_ANM,
231     CODEC_ID_BINKVIDEO,
232     CODEC_ID_IFF_ILBM,
233     CODEC_ID_IFF_BYTERUN1,
234     CODEC_ID_KGV1,
235     CODEC_ID_YOP,
236     CODEC_ID_VP8,
237     CODEC_ID_PICTOR,
238     CODEC_ID_ANSI,
239     CODEC_ID_A64_MULTI,
240     CODEC_ID_A64_MULTI5,
241     CODEC_ID_R10K,
242     CODEC_ID_MXPEG,
243     CODEC_ID_LAGARITH,
244     CODEC_ID_PRORES,
245     CODEC_ID_JV,
246     CODEC_ID_DFA,
247     CODEC_ID_WMV3IMAGE,
248     CODEC_ID_VC1IMAGE,
249     CODEC_ID_UTVIDEO,
250     CODEC_ID_BMV_VIDEO,
251     CODEC_ID_VBLE,
252     CODEC_ID_DXTORY,
253     CODEC_ID_V410,
254     CODEC_ID_XWD,
255     CODEC_ID_CDXL,
256     CODEC_ID_XBM,
257     CODEC_ID_ZEROCODEC,
258     CODEC_ID_MSS1,
259     CODEC_ID_MSA1,
260     CODEC_ID_TSCC2,
261     CODEC_ID_MTS2,
262     CODEC_ID_CLLC,
263
264     /* various PCM "codecs" */
265     CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
266     CODEC_ID_PCM_S16LE = 0x10000,
267     CODEC_ID_PCM_S16BE,
268     CODEC_ID_PCM_U16LE,
269     CODEC_ID_PCM_U16BE,
270     CODEC_ID_PCM_S8,
271     CODEC_ID_PCM_U8,
272     CODEC_ID_PCM_MULAW,
273     CODEC_ID_PCM_ALAW,
274     CODEC_ID_PCM_S32LE,
275     CODEC_ID_PCM_S32BE,
276     CODEC_ID_PCM_U32LE,
277     CODEC_ID_PCM_U32BE,
278     CODEC_ID_PCM_S24LE,
279     CODEC_ID_PCM_S24BE,
280     CODEC_ID_PCM_U24LE,
281     CODEC_ID_PCM_U24BE,
282     CODEC_ID_PCM_S24DAUD,
283     CODEC_ID_PCM_ZORK,
284     CODEC_ID_PCM_S16LE_PLANAR,
285     CODEC_ID_PCM_DVD,
286     CODEC_ID_PCM_F32BE,
287     CODEC_ID_PCM_F32LE,
288     CODEC_ID_PCM_F64BE,
289     CODEC_ID_PCM_F64LE,
290     CODEC_ID_PCM_BLURAY,
291     CODEC_ID_PCM_LXF,
292     CODEC_ID_S302M,
293     CODEC_ID_PCM_S8_PLANAR,
294
295     /* various ADPCM codecs */
296     CODEC_ID_ADPCM_IMA_QT = 0x11000,
297     CODEC_ID_ADPCM_IMA_WAV,
298     CODEC_ID_ADPCM_IMA_DK3,
299     CODEC_ID_ADPCM_IMA_DK4,
300     CODEC_ID_ADPCM_IMA_WS,
301     CODEC_ID_ADPCM_IMA_SMJPEG,
302     CODEC_ID_ADPCM_MS,
303     CODEC_ID_ADPCM_4XM,
304     CODEC_ID_ADPCM_XA,
305     CODEC_ID_ADPCM_ADX,
306     CODEC_ID_ADPCM_EA,
307     CODEC_ID_ADPCM_G726,
308     CODEC_ID_ADPCM_CT,
309     CODEC_ID_ADPCM_SWF,
310     CODEC_ID_ADPCM_YAMAHA,
311     CODEC_ID_ADPCM_SBPRO_4,
312     CODEC_ID_ADPCM_SBPRO_3,
313     CODEC_ID_ADPCM_SBPRO_2,
314     CODEC_ID_ADPCM_THP,
315     CODEC_ID_ADPCM_IMA_AMV,
316     CODEC_ID_ADPCM_EA_R1,
317     CODEC_ID_ADPCM_EA_R3,
318     CODEC_ID_ADPCM_EA_R2,
319     CODEC_ID_ADPCM_IMA_EA_SEAD,
320     CODEC_ID_ADPCM_IMA_EA_EACS,
321     CODEC_ID_ADPCM_EA_XAS,
322     CODEC_ID_ADPCM_EA_MAXIS_XA,
323     CODEC_ID_ADPCM_IMA_ISS,
324     CODEC_ID_ADPCM_G722,
325     CODEC_ID_ADPCM_IMA_APC,
326
327     /* AMR */
328     CODEC_ID_AMR_NB = 0x12000,
329     CODEC_ID_AMR_WB,
330
331     /* RealAudio codecs*/
332     CODEC_ID_RA_144 = 0x13000,
333     CODEC_ID_RA_288,
334
335     /* various DPCM codecs */
336     CODEC_ID_ROQ_DPCM = 0x14000,
337     CODEC_ID_INTERPLAY_DPCM,
338     CODEC_ID_XAN_DPCM,
339     CODEC_ID_SOL_DPCM,
340
341     /* audio codecs */
342     CODEC_ID_MP2 = 0x15000,
343     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
344     CODEC_ID_AAC,
345     CODEC_ID_AC3,
346     CODEC_ID_DTS,
347     CODEC_ID_VORBIS,
348     CODEC_ID_DVAUDIO,
349     CODEC_ID_WMAV1,
350     CODEC_ID_WMAV2,
351     CODEC_ID_MACE3,
352     CODEC_ID_MACE6,
353     CODEC_ID_VMDAUDIO,
354     CODEC_ID_FLAC,
355     CODEC_ID_MP3ADU,
356     CODEC_ID_MP3ON4,
357     CODEC_ID_SHORTEN,
358     CODEC_ID_ALAC,
359     CODEC_ID_WESTWOOD_SND1,
360     CODEC_ID_GSM, ///< as in Berlin toast format
361     CODEC_ID_QDM2,
362     CODEC_ID_COOK,
363     CODEC_ID_TRUESPEECH,
364     CODEC_ID_TTA,
365     CODEC_ID_SMACKAUDIO,
366     CODEC_ID_QCELP,
367     CODEC_ID_WAVPACK,
368     CODEC_ID_DSICINAUDIO,
369     CODEC_ID_IMC,
370     CODEC_ID_MUSEPACK7,
371     CODEC_ID_MLP,
372     CODEC_ID_GSM_MS, /* as found in WAV */
373     CODEC_ID_ATRAC3,
374     CODEC_ID_VOXWARE,
375     CODEC_ID_APE,
376     CODEC_ID_NELLYMOSER,
377     CODEC_ID_MUSEPACK8,
378     CODEC_ID_SPEEX,
379     CODEC_ID_WMAVOICE,
380     CODEC_ID_WMAPRO,
381     CODEC_ID_WMALOSSLESS,
382     CODEC_ID_ATRAC3P,
383     CODEC_ID_EAC3,
384     CODEC_ID_SIPR,
385     CODEC_ID_MP1,
386     CODEC_ID_TWINVQ,
387     CODEC_ID_TRUEHD,
388     CODEC_ID_MP4ALS,
389     CODEC_ID_ATRAC1,
390     CODEC_ID_BINKAUDIO_RDFT,
391     CODEC_ID_BINKAUDIO_DCT,
392     CODEC_ID_AAC_LATM,
393     CODEC_ID_QDMC,
394     CODEC_ID_CELT,
395     CODEC_ID_G723_1,
396     CODEC_ID_G729,
397     CODEC_ID_8SVX_EXP,
398     CODEC_ID_8SVX_FIB,
399     CODEC_ID_BMV_AUDIO,
400     CODEC_ID_RALF,
401     CODEC_ID_IAC,
402     CODEC_ID_ILBC,
403
404     /* subtitle codecs */
405     CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
406     CODEC_ID_DVD_SUBTITLE = 0x17000,
407     CODEC_ID_DVB_SUBTITLE,
408     CODEC_ID_TEXT,  ///< raw UTF-8 text
409     CODEC_ID_XSUB,
410     CODEC_ID_SSA,
411     CODEC_ID_MOV_TEXT,
412     CODEC_ID_HDMV_PGS_SUBTITLE,
413     CODEC_ID_DVB_TELETEXT,
414     CODEC_ID_SRT,
415
416     /* other specific kind of codecs (generally used for attachments) */
417     CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
418     CODEC_ID_TTF = 0x18000,
419
420     CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
421
422     CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
423                                 * stream (only used by libavformat) */
424     CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
425                                 * stream (only used by libavformat) */
426     CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
427 };
428
429 #if FF_API_OLD_DECODE_AUDIO
430 /* in bytes */
431 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
432 #endif
433
434 /**
435  * @ingroup lavc_decoding
436  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
437  * This is mainly needed because some optimized bitstream readers read
438  * 32 or 64 bit at once and could read over the end.<br>
439  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
440  * MPEG bitstreams could cause overread and segfault.
441  */
442 #define FF_INPUT_BUFFER_PADDING_SIZE 8
443
444 /**
445  * @ingroup lavc_encoding
446  * minimum encoding buffer size
447  * Used to avoid some checks during header writing.
448  */
449 #define FF_MIN_BUFFER_SIZE 16384
450
451
452 /**
453  * @ingroup lavc_encoding
454  * motion estimation type.
455  */
456 enum Motion_Est_ID {
457     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
458     ME_FULL,
459     ME_LOG,
460     ME_PHODS,
461     ME_EPZS,        ///< enhanced predictive zonal search
462     ME_X1,          ///< reserved for experiments
463     ME_HEX,         ///< hexagon based search
464     ME_UMH,         ///< uneven multi-hexagon search
465     ME_ITER,        ///< iterative search
466     ME_TESA,        ///< transformed exhaustive search algorithm
467 };
468
469 /**
470  * @ingroup lavc_decoding
471  */
472 enum AVDiscard{
473     /* We leave some space between them for extensions (drop some
474      * keyframes for intra-only or drop just some bidir frames). */
475     AVDISCARD_NONE    =-16, ///< discard nothing
476     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
477     AVDISCARD_NONREF  =  8, ///< discard all non reference
478     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
479     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
480     AVDISCARD_ALL     = 48, ///< discard all
481 };
482
483 enum AVColorPrimaries{
484     AVCOL_PRI_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
485     AVCOL_PRI_UNSPECIFIED = 2,
486     AVCOL_PRI_BT470M      = 4,
487     AVCOL_PRI_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
488     AVCOL_PRI_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
489     AVCOL_PRI_SMPTE240M   = 7, ///< functionally identical to above
490     AVCOL_PRI_FILM        = 8,
491     AVCOL_PRI_NB             , ///< Not part of ABI
492 };
493
494 enum AVColorTransferCharacteristic{
495     AVCOL_TRC_BT709       = 1, ///< also ITU-R BT1361
496     AVCOL_TRC_UNSPECIFIED = 2,
497     AVCOL_TRC_GAMMA22     = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
498     AVCOL_TRC_GAMMA28     = 5, ///< also ITU-R BT470BG
499     AVCOL_TRC_SMPTE240M   = 7,
500     AVCOL_TRC_NB             , ///< Not part of ABI
501 };
502
503 enum AVColorSpace{
504     AVCOL_SPC_RGB         = 0,
505     AVCOL_SPC_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
506     AVCOL_SPC_UNSPECIFIED = 2,
507     AVCOL_SPC_FCC         = 4,
508     AVCOL_SPC_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
509     AVCOL_SPC_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
510     AVCOL_SPC_SMPTE240M   = 7,
511     AVCOL_SPC_YCOCG       = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
512     AVCOL_SPC_NB             , ///< Not part of ABI
513 };
514
515 enum AVColorRange{
516     AVCOL_RANGE_UNSPECIFIED = 0,
517     AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
518     AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
519     AVCOL_RANGE_NB             , ///< Not part of ABI
520 };
521
522 /**
523  *  X   X      3 4 X      X are luma samples,
524  *             1 2        1-6 are possible chroma positions
525  *  X   X      5 6 X      0 is undefined/unknown position
526  */
527 enum AVChromaLocation{
528     AVCHROMA_LOC_UNSPECIFIED = 0,
529     AVCHROMA_LOC_LEFT        = 1, ///< mpeg2/4, h264 default
530     AVCHROMA_LOC_CENTER      = 2, ///< mpeg1, jpeg, h263
531     AVCHROMA_LOC_TOPLEFT     = 3, ///< DV
532     AVCHROMA_LOC_TOP         = 4,
533     AVCHROMA_LOC_BOTTOMLEFT  = 5,
534     AVCHROMA_LOC_BOTTOM      = 6,
535     AVCHROMA_LOC_NB             , ///< Not part of ABI
536 };
537
538 enum AVAudioServiceType {
539     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
540     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
541     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
542     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
543     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
544     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
545     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
546     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
547     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
548     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
549 };
550
551 /**
552  * @ingroup lavc_encoding
553  */
554 typedef struct RcOverride{
555     int start_frame;
556     int end_frame;
557     int qscale; // If this is 0 then quality_factor will be used instead.
558     float quality_factor;
559 } RcOverride;
560
561 #define FF_MAX_B_FRAMES 16
562
563 /* encoding support
564    These flags can be passed in AVCodecContext.flags before initialization.
565    Note: Not everything is supported yet.
566 */
567
568 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
569 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
570 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
571 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
572 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
573 /**
574  * The parent program guarantees that the input for B-frames containing
575  * streams is not written to for at least s->max_b_frames+1 frames, if
576  * this is not set the input will be copied.
577  */
578 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
579 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
580 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
581 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
582 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
583 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
584 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
585                                                   location instead of only at frame boundaries. */
586 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
587 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
588 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
589 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
590 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
591 /* Fx : Flag for h263+ extra options */
592 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
593 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
594 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
595 #define CODEC_FLAG_CLOSED_GOP     0x80000000
596 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
597 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
598 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
599 #if FF_API_MPV_GLOBAL_OPTS
600 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
601 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
602 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
603 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
604 #endif
605 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
606
607 /* Unsupported options :
608  *              Syntax Arithmetic coding (SAC)
609  *              Reference Picture Selection
610  *              Independent Segment Decoding */
611 /* /Fx */
612 /* codec capabilities */
613
614 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
615 /**
616  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
617  * If not set, it might not use get_buffer() at all or use operations that
618  * assume the buffer was allocated by avcodec_default_get_buffer.
619  */
620 #define CODEC_CAP_DR1             0x0002
621 #define CODEC_CAP_TRUNCATED       0x0008
622 /* Codec can export data for HW decoding (XvMC). */
623 #define CODEC_CAP_HWACCEL         0x0010
624 /**
625  * Encoder or decoder requires flushing with NULL input at the end in order to
626  * give the complete and correct output.
627  *
628  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
629  *       with NULL data. The user can still send NULL data to the public encode
630  *       or decode function, but libavcodec will not pass it along to the codec
631  *       unless this flag is set.
632  *
633  * Decoders:
634  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
635  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
636  * returns frames.
637  *
638  * Encoders:
639  * The encoder needs to be fed with NULL data at the end of encoding until the
640  * encoder no longer returns data.
641  *
642  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
643  *       flag also means that the encoder must set the pts and duration for
644  *       each output packet. If this flag is not set, the pts and duration will
645  *       be determined by libavcodec from the input frame.
646  */
647 #define CODEC_CAP_DELAY           0x0020
648 /**
649  * Codec can be fed a final frame with a smaller size.
650  * This can be used to prevent truncation of the last audio samples.
651  */
652 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
653 /**
654  * Codec can export data for HW decoding (VDPAU).
655  */
656 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
657 /**
658  * Codec can output multiple frames per AVPacket
659  * Normally demuxers return one frame at a time, demuxers which do not do
660  * are connected to a parser to split what they return into proper frames.
661  * This flag is reserved to the very rare category of codecs which have a
662  * bitstream that cannot be split into frames without timeconsuming
663  * operations like full decoding. Demuxers carring such bitstreams thus
664  * may return multiple frames in a packet. This has many disadvantages like
665  * prohibiting stream copy in many cases thus it should only be considered
666  * as a last resort.
667  */
668 #define CODEC_CAP_SUBFRAMES        0x0100
669 /**
670  * Codec is experimental and is thus avoided in favor of non experimental
671  * encoders
672  */
673 #define CODEC_CAP_EXPERIMENTAL     0x0200
674 /**
675  * Codec should fill in channel configuration and samplerate instead of container
676  */
677 #define CODEC_CAP_CHANNEL_CONF     0x0400
678 /**
679  * Codec is able to deal with negative linesizes
680  */
681 #define CODEC_CAP_NEG_LINESIZES    0x0800
682 /**
683  * Codec supports frame-level multithreading.
684  */
685 #define CODEC_CAP_FRAME_THREADS    0x1000
686 /**
687  * Codec supports slice-based (or partition-based) multithreading.
688  */
689 #define CODEC_CAP_SLICE_THREADS    0x2000
690 /**
691  * Codec supports changed parameters at any point.
692  */
693 #define CODEC_CAP_PARAM_CHANGE     0x4000
694 /**
695  * Codec supports avctx->thread_count == 0 (auto).
696  */
697 #define CODEC_CAP_AUTO_THREADS     0x8000
698 /**
699  * Audio encoder supports receiving a different number of samples in each call.
700  */
701 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
702
703 //The following defines may change, don't expect compatibility if you use them.
704 #define MB_TYPE_INTRA4x4   0x0001
705 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
706 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
707 #define MB_TYPE_16x16      0x0008
708 #define MB_TYPE_16x8       0x0010
709 #define MB_TYPE_8x16       0x0020
710 #define MB_TYPE_8x8        0x0040
711 #define MB_TYPE_INTERLACED 0x0080
712 #define MB_TYPE_DIRECT2    0x0100 //FIXME
713 #define MB_TYPE_ACPRED     0x0200
714 #define MB_TYPE_GMC        0x0400
715 #define MB_TYPE_SKIP       0x0800
716 #define MB_TYPE_P0L0       0x1000
717 #define MB_TYPE_P1L0       0x2000
718 #define MB_TYPE_P0L1       0x4000
719 #define MB_TYPE_P1L1       0x8000
720 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
721 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
722 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
723 #define MB_TYPE_QUANT      0x00010000
724 #define MB_TYPE_CBP        0x00020000
725 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
726
727 /**
728  * Pan Scan area.
729  * This specifies the area which should be displayed.
730  * Note there may be multiple such areas for one frame.
731  */
732 typedef struct AVPanScan{
733     /**
734      * id
735      * - encoding: Set by user.
736      * - decoding: Set by libavcodec.
737      */
738     int id;
739
740     /**
741      * width and height in 1/16 pel
742      * - encoding: Set by user.
743      * - decoding: Set by libavcodec.
744      */
745     int width;
746     int height;
747
748     /**
749      * position of the top left corner in 1/16 pel for up to 3 fields/frames
750      * - encoding: Set by user.
751      * - decoding: Set by libavcodec.
752      */
753     int16_t position[3][2];
754 }AVPanScan;
755
756 #define FF_QSCALE_TYPE_MPEG1 0
757 #define FF_QSCALE_TYPE_MPEG2 1
758 #define FF_QSCALE_TYPE_H264  2
759 #define FF_QSCALE_TYPE_VP56  3
760
761 #define FF_BUFFER_TYPE_INTERNAL 1
762 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
763 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
764 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
765
766 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
767 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
768 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
769 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
770
771 /**
772  * @defgroup lavc_packet AVPacket
773  *
774  * Types and functions for working with AVPacket.
775  * @{
776  */
777 enum AVPacketSideDataType {
778     AV_PKT_DATA_PALETTE,
779     AV_PKT_DATA_NEW_EXTRADATA,
780
781     /**
782      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
783      * @code
784      * u32le param_flags
785      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
786      *     s32le channel_count
787      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
788      *     u64le channel_layout
789      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
790      *     s32le sample_rate
791      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
792      *     s32le width
793      *     s32le height
794      * @endcode
795      */
796     AV_PKT_DATA_PARAM_CHANGE,
797
798     /**
799      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
800      * structures with info about macroblocks relevant to splitting the
801      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
802      * That is, it does not necessarily contain info about all macroblocks,
803      * as long as the distance between macroblocks in the info is smaller
804      * than the target payload size.
805      * Each MB info structure is 12 bytes, and is laid out as follows:
806      * @code
807      * u32le bit offset from the start of the packet
808      * u8    current quantizer at the start of the macroblock
809      * u8    GOB number
810      * u16le macroblock address within the GOB
811      * u8    horizontal MV predictor
812      * u8    vertical MV predictor
813      * u8    horizontal MV predictor for block number 3
814      * u8    vertical MV predictor for block number 3
815      * @endcode
816      */
817     AV_PKT_DATA_H263_MB_INFO,
818 };
819
820 typedef struct AVPacket {
821     /**
822      * Presentation timestamp in AVStream->time_base units; the time at which
823      * the decompressed packet will be presented to the user.
824      * Can be AV_NOPTS_VALUE if it is not stored in the file.
825      * pts MUST be larger or equal to dts as presentation cannot happen before
826      * decompression, unless one wants to view hex dumps. Some formats misuse
827      * the terms dts and pts/cts to mean something different. Such timestamps
828      * must be converted to true pts/dts before they are stored in AVPacket.
829      */
830     int64_t pts;
831     /**
832      * Decompression timestamp in AVStream->time_base units; the time at which
833      * the packet is decompressed.
834      * Can be AV_NOPTS_VALUE if it is not stored in the file.
835      */
836     int64_t dts;
837     uint8_t *data;
838     int   size;
839     int   stream_index;
840     /**
841      * A combination of AV_PKT_FLAG values
842      */
843     int   flags;
844     /**
845      * Additional packet data that can be provided by the container.
846      * Packet can contain several types of side information.
847      */
848     struct {
849         uint8_t *data;
850         int      size;
851         enum AVPacketSideDataType type;
852     } *side_data;
853     int side_data_elems;
854
855     /**
856      * Duration of this packet in AVStream->time_base units, 0 if unknown.
857      * Equals next_pts - this_pts in presentation order.
858      */
859     int   duration;
860     void  (*destruct)(struct AVPacket *);
861     void  *priv;
862     int64_t pos;                            ///< byte position in stream, -1 if unknown
863
864     /**
865      * Time difference in AVStream->time_base units from the pts of this
866      * packet to the point at which the output from the decoder has converged
867      * independent from the availability of previous frames. That is, the
868      * frames are virtually identical no matter if decoding started from
869      * the very first frame or from this keyframe.
870      * Is AV_NOPTS_VALUE if unknown.
871      * This field is not the display duration of the current packet.
872      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
873      * set.
874      *
875      * The purpose of this field is to allow seeking in streams that have no
876      * keyframes in the conventional sense. It corresponds to the
877      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
878      * essential for some types of subtitle streams to ensure that all
879      * subtitles are correctly displayed after seeking.
880      */
881     int64_t convergence_duration;
882 } AVPacket;
883 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
884 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
885
886 enum AVSideDataParamChangeFlags {
887     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
888     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
889     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
890     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
891 };
892 /**
893  * @}
894  */
895
896 /**
897  * Audio Video Frame.
898  * New fields can be added to the end of AVFRAME with minor version
899  * bumps. Removal, reordering and changes to existing fields require
900  * a major version bump.
901  * sizeof(AVFrame) must not be used outside libav*.
902  */
903 typedef struct AVFrame {
904 #define AV_NUM_DATA_POINTERS 8
905     /**
906      * pointer to the picture/channel planes.
907      * This might be different from the first allocated byte
908      * - encoding: Set by user
909      * - decoding: set by AVCodecContext.get_buffer()
910      */
911     uint8_t *data[AV_NUM_DATA_POINTERS];
912
913     /**
914      * Size, in bytes, of the data for each picture/channel plane.
915      *
916      * For audio, only linesize[0] may be set. For planar audio, each channel
917      * plane must be the same size.
918      *
919      * - encoding: Set by user
920      * - decoding: set by AVCodecContext.get_buffer()
921      */
922     int linesize[AV_NUM_DATA_POINTERS];
923
924     /**
925      * pointers to the data planes/channels.
926      *
927      * For video, this should simply point to data[].
928      *
929      * For planar audio, each channel has a separate data pointer, and
930      * linesize[0] contains the size of each channel buffer.
931      * For packed audio, there is just one data pointer, and linesize[0]
932      * contains the total size of the buffer for all channels.
933      *
934      * Note: Both data and extended_data will always be set by get_buffer(),
935      * but for planar audio with more channels that can fit in data,
936      * extended_data must be used by the decoder in order to access all
937      * channels.
938      *
939      * encoding: unused
940      * decoding: set by AVCodecContext.get_buffer()
941      */
942     uint8_t **extended_data;
943
944     /**
945      * width and height of the video frame
946      * - encoding: unused
947      * - decoding: Read by user.
948      */
949     int width, height;
950
951     /**
952      * number of audio samples (per channel) described by this frame
953      * - encoding: Set by user
954      * - decoding: Set by libavcodec
955      */
956     int nb_samples;
957
958     /**
959      * format of the frame, -1 if unknown or unset
960      * Values correspond to enum PixelFormat for video frames,
961      * enum AVSampleFormat for audio)
962      * - encoding: unused
963      * - decoding: Read by user.
964      */
965     int format;
966
967     /**
968      * 1 -> keyframe, 0-> not
969      * - encoding: Set by libavcodec.
970      * - decoding: Set by libavcodec.
971      */
972     int key_frame;
973
974     /**
975      * Picture type of the frame, see ?_TYPE below.
976      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
977      * - decoding: Set by libavcodec.
978      */
979     enum AVPictureType pict_type;
980
981     /**
982      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
983      * This isn't used by libavcodec unless the default get/release_buffer() is used.
984      * - encoding:
985      * - decoding:
986      */
987     uint8_t *base[AV_NUM_DATA_POINTERS];
988
989     /**
990      * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
991      * - encoding: unused
992      * - decoding: Read by user.
993      */
994     AVRational sample_aspect_ratio;
995
996     /**
997      * presentation timestamp in time_base units (time when frame should be shown to user)
998      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
999      * - encoding: MUST be set by user.
1000      * - decoding: Set by libavcodec.
1001      */
1002     int64_t pts;
1003
1004     /**
1005      * reordered pts from the last AVPacket that has been input into the decoder
1006      * - encoding: unused
1007      * - decoding: Read by user.
1008      */
1009     int64_t pkt_pts;
1010
1011     /**
1012      * dts from the last AVPacket that has been input into the decoder
1013      * - encoding: unused
1014      * - decoding: Read by user.
1015      */
1016     int64_t pkt_dts;
1017
1018     /**
1019      * picture number in bitstream order
1020      * - encoding: set by
1021      * - decoding: Set by libavcodec.
1022      */
1023     int coded_picture_number;
1024     /**
1025      * picture number in display order
1026      * - encoding: set by
1027      * - decoding: Set by libavcodec.
1028      */
1029     int display_picture_number;
1030
1031     /**
1032      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1033      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1034      * - decoding: Set by libavcodec.
1035      */
1036     int quality;
1037
1038     /**
1039      * is this picture used as reference
1040      * The values for this are the same as the MpegEncContext.picture_structure
1041      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1042      * Set to 4 for delayed, non-reference frames.
1043      * - encoding: unused
1044      * - decoding: Set by libavcodec. (before get_buffer() call)).
1045      */
1046     int reference;
1047
1048     /**
1049      * QP table
1050      * - encoding: unused
1051      * - decoding: Set by libavcodec.
1052      */
1053     int8_t *qscale_table;
1054     /**
1055      * QP store stride
1056      * - encoding: unused
1057      * - decoding: Set by libavcodec.
1058      */
1059     int qstride;
1060
1061     /**
1062      *
1063      */
1064     int qscale_type;
1065
1066     /**
1067      * mbskip_table[mb]>=1 if MB didn't change
1068      * stride= mb_width = (width+15)>>4
1069      * - encoding: unused
1070      * - decoding: Set by libavcodec.
1071      */
1072     uint8_t *mbskip_table;
1073
1074     /**
1075      * motion vector table
1076      * @code
1077      * example:
1078      * int mv_sample_log2= 4 - motion_subsample_log2;
1079      * int mb_width= (width+15)>>4;
1080      * int mv_stride= (mb_width << mv_sample_log2) + 1;
1081      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1082      * @endcode
1083      * - encoding: Set by user.
1084      * - decoding: Set by libavcodec.
1085      */
1086     int16_t (*motion_val[2])[2];
1087
1088     /**
1089      * macroblock type table
1090      * mb_type_base + mb_width + 2
1091      * - encoding: Set by user.
1092      * - decoding: Set by libavcodec.
1093      */
1094     uint32_t *mb_type;
1095
1096     /**
1097      * DCT coefficients
1098      * - encoding: unused
1099      * - decoding: Set by libavcodec.
1100      */
1101     short *dct_coeff;
1102
1103     /**
1104      * motion reference frame index
1105      * the order in which these are stored can depend on the codec.
1106      * - encoding: Set by user.
1107      * - decoding: Set by libavcodec.
1108      */
1109     int8_t *ref_index[2];
1110
1111     /**
1112      * for some private data of the user
1113      * - encoding: unused
1114      * - decoding: Set by user.
1115      */
1116     void *opaque;
1117
1118     /**
1119      * error
1120      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1121      * - decoding: unused
1122      */
1123     uint64_t error[AV_NUM_DATA_POINTERS];
1124
1125     /**
1126      * type of the buffer (to keep track of who has to deallocate data[*])
1127      * - encoding: Set by the one who allocates it.
1128      * - decoding: Set by the one who allocates it.
1129      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1130      */
1131     int type;
1132
1133     /**
1134      * When decoding, this signals how much the picture must be delayed.
1135      * extra_delay = repeat_pict / (2*fps)
1136      * - encoding: unused
1137      * - decoding: Set by libavcodec.
1138      */
1139     int repeat_pict;
1140
1141     /**
1142      * The content of the picture is interlaced.
1143      * - encoding: Set by user.
1144      * - decoding: Set by libavcodec. (default 0)
1145      */
1146     int interlaced_frame;
1147
1148     /**
1149      * If the content is interlaced, is top field displayed first.
1150      * - encoding: Set by user.
1151      * - decoding: Set by libavcodec.
1152      */
1153     int top_field_first;
1154
1155     /**
1156      * Tell user application that palette has changed from previous frame.
1157      * - encoding: ??? (no palette-enabled encoder yet)
1158      * - decoding: Set by libavcodec. (default 0).
1159      */
1160     int palette_has_changed;
1161
1162     /**
1163      * codec suggestion on buffer type if != 0
1164      * - encoding: unused
1165      * - decoding: Set by libavcodec. (before get_buffer() call)).
1166      */
1167     int buffer_hints;
1168
1169     /**
1170      * Pan scan.
1171      * - encoding: Set by user.
1172      * - decoding: Set by libavcodec.
1173      */
1174     AVPanScan *pan_scan;
1175
1176     /**
1177      * reordered opaque 64bit (generally an integer or a double precision float
1178      * PTS but can be anything).
1179      * The user sets AVCodecContext.reordered_opaque to represent the input at
1180      * that time,
1181      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1182      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1183      * @deprecated in favor of pkt_pts
1184      * - encoding: unused
1185      * - decoding: Read by user.
1186      */
1187     int64_t reordered_opaque;
1188
1189     /**
1190      * hardware accelerator private data (Libav-allocated)
1191      * - encoding: unused
1192      * - decoding: Set by libavcodec
1193      */
1194     void *hwaccel_picture_private;
1195
1196     /**
1197      * the AVCodecContext which ff_thread_get_buffer() was last called on
1198      * - encoding: Set by libavcodec.
1199      * - decoding: Set by libavcodec.
1200      */
1201     struct AVCodecContext *owner;
1202
1203     /**
1204      * used by multithreading to store frame-specific info
1205      * - encoding: Set by libavcodec.
1206      * - decoding: Set by libavcodec.
1207      */
1208     void *thread_opaque;
1209
1210     /**
1211      * log2 of the size of the block which a single vector in motion_val represents:
1212      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1213      * - encoding: unused
1214      * - decoding: Set by libavcodec.
1215      */
1216     uint8_t motion_subsample_log2;
1217
1218     /**
1219      * Sample rate of the audio data.
1220      *
1221      * - encoding: unused
1222      * - decoding: set by get_buffer()
1223      */
1224     int sample_rate;
1225
1226     /**
1227      * Channel layout of the audio data.
1228      *
1229      * - encoding: unused
1230      * - decoding: set by get_buffer()
1231      */
1232     uint64_t channel_layout;
1233 } AVFrame;
1234
1235 struct AVCodecInternal;
1236
1237 enum AVFieldOrder {
1238     AV_FIELD_UNKNOWN,
1239     AV_FIELD_PROGRESSIVE,
1240     AV_FIELD_TT,          //< Top coded_first, top displayed first
1241     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1242     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1243     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1244 };
1245
1246 /**
1247  * main external API structure.
1248  * New fields can be added to the end with minor version bumps.
1249  * Removal, reordering and changes to existing fields require a major
1250  * version bump.
1251  * sizeof(AVCodecContext) must not be used outside libav*.
1252  */
1253 typedef struct AVCodecContext {
1254     /**
1255      * information on struct for av_log
1256      * - set by avcodec_alloc_context3
1257      */
1258     const AVClass *av_class;
1259     int log_level_offset;
1260
1261     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1262     struct AVCodec  *codec;
1263     char             codec_name[32];
1264     enum CodecID     codec_id; /* see CODEC_ID_xxx */
1265
1266     /**
1267      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1268      * This is used to work around some encoder bugs.
1269      * A demuxer should set this to what is stored in the field used to identify the codec.
1270      * If there are multiple such fields in a container then the demuxer should choose the one
1271      * which maximizes the information about the used codec.
1272      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1273      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1274      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1275      * first.
1276      * - encoding: Set by user, if not then the default based on codec_id will be used.
1277      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1278      */
1279     unsigned int codec_tag;
1280
1281     /**
1282      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1283      * This is used to work around some encoder bugs.
1284      * - encoding: unused
1285      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1286      */
1287     unsigned int stream_codec_tag;
1288
1289 #if FF_API_SUB_ID
1290     /**
1291      * @deprecated this field is unused
1292      */
1293     attribute_deprecated int sub_id;
1294 #endif
1295
1296     void *priv_data;
1297
1298     /**
1299      * Private context used for internal data.
1300      *
1301      * Unlike priv_data, this is not codec-specific. It is used in general
1302      * libavcodec functions.
1303      */
1304     struct AVCodecInternal *internal;
1305
1306     /**
1307      * Private data of the user, can be used to carry app specific stuff.
1308      * - encoding: Set by user.
1309      * - decoding: Set by user.
1310      */
1311     void *opaque;
1312
1313     /**
1314      * the average bitrate
1315      * - encoding: Set by user; unused for constant quantizer encoding.
1316      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1317      */
1318     int bit_rate;
1319
1320     /**
1321      * number of bits the bitstream is allowed to diverge from the reference.
1322      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1323      * - encoding: Set by user; unused for constant quantizer encoding.
1324      * - decoding: unused
1325      */
1326     int bit_rate_tolerance;
1327
1328     /**
1329      * Global quality for codecs which cannot change it per frame.
1330      * This should be proportional to MPEG-1/2/4 qscale.
1331      * - encoding: Set by user.
1332      * - decoding: unused
1333      */
1334     int global_quality;
1335
1336     /**
1337      * - encoding: Set by user.
1338      * - decoding: unused
1339      */
1340     int compression_level;
1341 #define FF_COMPRESSION_DEFAULT -1
1342
1343     /**
1344      * CODEC_FLAG_*.
1345      * - encoding: Set by user.
1346      * - decoding: Set by user.
1347      */
1348     int flags;
1349
1350     /**
1351      * CODEC_FLAG2_*
1352      * - encoding: Set by user.
1353      * - decoding: Set by user.
1354      */
1355     int flags2;
1356
1357     /**
1358      * some codecs need / can use extradata like Huffman tables.
1359      * mjpeg: Huffman tables
1360      * rv10: additional flags
1361      * mpeg4: global headers (they can be in the bitstream or here)
1362      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1363      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1364      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1365      * - encoding: Set/allocated/freed by libavcodec.
1366      * - decoding: Set/allocated/freed by user.
1367      */
1368     uint8_t *extradata;
1369     int extradata_size;
1370
1371     /**
1372      * This is the fundamental unit of time (in seconds) in terms
1373      * of which frame timestamps are represented. For fixed-fps content,
1374      * timebase should be 1/framerate and timestamp increments should be
1375      * identically 1.
1376      * - encoding: MUST be set by user.
1377      * - decoding: Set by libavcodec.
1378      */
1379     AVRational time_base;
1380
1381     /**
1382      * For some codecs, the time base is closer to the field rate than the frame rate.
1383      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1384      * if no telecine is used ...
1385      *
1386      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1387      */
1388     int ticks_per_frame;
1389
1390     /**
1391      * Encoder delay.
1392      *
1393      * Video:
1394      *   Number of frames the decoded output will be delayed relative to the
1395      *   encoded input.
1396      *
1397      * Audio:
1398      *   Number of "priming" samples added to the beginning of the stream
1399      *   during encoding. The decoded output will be delayed by this many
1400      *   samples relative to the input to the encoder. Note that this field is
1401      *   purely informational and does not directly affect the pts output by
1402      *   the encoder, which should always be based on the actual presentation
1403      *   time, including any delay.
1404      *
1405      * - encoding: Set by libavcodec.
1406      * - decoding: unused
1407      */
1408     int delay;
1409
1410
1411     /* video only */
1412     /**
1413      * picture width / height.
1414      * - encoding: MUST be set by user.
1415      * - decoding: Set by libavcodec.
1416      * Note: For compatibility it is possible to set this instead of
1417      * coded_width/height before decoding.
1418      */
1419     int width, height;
1420
1421     /**
1422      * Bitstream width / height, may be different from width/height.
1423      * - encoding: unused
1424      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1425      */
1426     int coded_width, coded_height;
1427
1428 #define FF_ASPECT_EXTENDED 15
1429
1430     /**
1431      * the number of pictures in a group of pictures, or 0 for intra_only
1432      * - encoding: Set by user.
1433      * - decoding: unused
1434      */
1435     int gop_size;
1436
1437     /**
1438      * Pixel format, see PIX_FMT_xxx.
1439      * May be set by the demuxer if known from headers.
1440      * May be overriden by the decoder if it knows better.
1441      * - encoding: Set by user.
1442      * - decoding: Set by user if known, overridden by libavcodec if known
1443      */
1444     enum PixelFormat pix_fmt;
1445
1446     /**
1447      * Motion estimation algorithm used for video coding.
1448      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1449      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1450      * - encoding: MUST be set by user.
1451      * - decoding: unused
1452      */
1453     int me_method;
1454
1455     /**
1456      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1457      * decoder to draw a horizontal band. It improves cache usage. Not
1458      * all codecs can do that. You must check the codec capabilities
1459      * beforehand.
1460      * When multithreading is used, it may be called from multiple threads
1461      * at the same time; threads might draw different parts of the same AVFrame,
1462      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1463      * in order.
1464      * The function is also used by hardware acceleration APIs.
1465      * It is called at least once during frame decoding to pass
1466      * the data needed for hardware render.
1467      * In that mode instead of pixel data, AVFrame points to
1468      * a structure specific to the acceleration API. The application
1469      * reads the structure and can change some fields to indicate progress
1470      * or mark state.
1471      * - encoding: unused
1472      * - decoding: Set by user.
1473      * @param height the height of the slice
1474      * @param y the y position of the slice
1475      * @param type 1->top field, 2->bottom field, 3->frame
1476      * @param offset offset into the AVFrame.data from which the slice should be read
1477      */
1478     void (*draw_horiz_band)(struct AVCodecContext *s,
1479                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1480                             int y, int type, int height);
1481
1482     /**
1483      * callback to negotiate the pixelFormat
1484      * @param fmt is the list of formats which are supported by the codec,
1485      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1486      * The first is always the native one.
1487      * @return the chosen format
1488      * - encoding: unused
1489      * - decoding: Set by user, if not set the native format will be chosen.
1490      */
1491     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1492
1493     /**
1494      * maximum number of B-frames between non-B-frames
1495      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1496      * - encoding: Set by user.
1497      * - decoding: unused
1498      */
1499     int max_b_frames;
1500
1501     /**
1502      * qscale factor between IP and B-frames
1503      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1504      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1505      * - encoding: Set by user.
1506      * - decoding: unused
1507      */
1508     float b_quant_factor;
1509
1510     /** obsolete FIXME remove */
1511     int rc_strategy;
1512 #define FF_RC_STRATEGY_XVID 1
1513
1514     int b_frame_strategy;
1515
1516 #if FF_API_MPV_GLOBAL_OPTS
1517     /**
1518      * luma single coefficient elimination threshold
1519      * - encoding: Set by user.
1520      * - decoding: unused
1521      */
1522     attribute_deprecated int luma_elim_threshold;
1523
1524     /**
1525      * chroma single coeff elimination threshold
1526      * - encoding: Set by user.
1527      * - decoding: unused
1528      */
1529     attribute_deprecated int chroma_elim_threshold;
1530 #endif
1531
1532     /**
1533      * qscale offset between IP and B-frames
1534      * - encoding: Set by user.
1535      * - decoding: unused
1536      */
1537     float b_quant_offset;
1538
1539     /**
1540      * Size of the frame reordering buffer in the decoder.
1541      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1542      * - encoding: Set by libavcodec.
1543      * - decoding: Set by libavcodec.
1544      */
1545     int has_b_frames;
1546
1547     /**
1548      * 0-> h263 quant 1-> mpeg quant
1549      * - encoding: Set by user.
1550      * - decoding: unused
1551      */
1552     int mpeg_quant;
1553
1554     /**
1555      * qscale factor between P and I-frames
1556      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1557      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1558      * - encoding: Set by user.
1559      * - decoding: unused
1560      */
1561     float i_quant_factor;
1562
1563     /**
1564      * qscale offset between P and I-frames
1565      * - encoding: Set by user.
1566      * - decoding: unused
1567      */
1568     float i_quant_offset;
1569
1570     /**
1571      * luminance masking (0-> disabled)
1572      * - encoding: Set by user.
1573      * - decoding: unused
1574      */
1575     float lumi_masking;
1576
1577     /**
1578      * temporary complexity masking (0-> disabled)
1579      * - encoding: Set by user.
1580      * - decoding: unused
1581      */
1582     float temporal_cplx_masking;
1583
1584     /**
1585      * spatial complexity masking (0-> disabled)
1586      * - encoding: Set by user.
1587      * - decoding: unused
1588      */
1589     float spatial_cplx_masking;
1590
1591     /**
1592      * p block masking (0-> disabled)
1593      * - encoding: Set by user.
1594      * - decoding: unused
1595      */
1596     float p_masking;
1597
1598     /**
1599      * darkness masking (0-> disabled)
1600      * - encoding: Set by user.
1601      * - decoding: unused
1602      */
1603     float dark_masking;
1604
1605     /**
1606      * slice count
1607      * - encoding: Set by libavcodec.
1608      * - decoding: Set by user (or 0).
1609      */
1610     int slice_count;
1611     /**
1612      * prediction method (needed for huffyuv)
1613      * - encoding: Set by user.
1614      * - decoding: unused
1615      */
1616      int prediction_method;
1617 #define FF_PRED_LEFT   0
1618 #define FF_PRED_PLANE  1
1619 #define FF_PRED_MEDIAN 2
1620
1621     /**
1622      * slice offsets in the frame in bytes
1623      * - encoding: Set/allocated by libavcodec.
1624      * - decoding: Set/allocated by user (or NULL).
1625      */
1626     int *slice_offset;
1627
1628     /**
1629      * sample aspect ratio (0 if unknown)
1630      * That is the width of a pixel divided by the height of the pixel.
1631      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1632      * - encoding: Set by user.
1633      * - decoding: Set by libavcodec.
1634      */
1635     AVRational sample_aspect_ratio;
1636
1637     /**
1638      * motion estimation comparison function
1639      * - encoding: Set by user.
1640      * - decoding: unused
1641      */
1642     int me_cmp;
1643     /**
1644      * subpixel motion estimation comparison function
1645      * - encoding: Set by user.
1646      * - decoding: unused
1647      */
1648     int me_sub_cmp;
1649     /**
1650      * macroblock comparison function (not supported yet)
1651      * - encoding: Set by user.
1652      * - decoding: unused
1653      */
1654     int mb_cmp;
1655     /**
1656      * interlaced DCT comparison function
1657      * - encoding: Set by user.
1658      * - decoding: unused
1659      */
1660     int ildct_cmp;
1661 #define FF_CMP_SAD    0
1662 #define FF_CMP_SSE    1
1663 #define FF_CMP_SATD   2
1664 #define FF_CMP_DCT    3
1665 #define FF_CMP_PSNR   4
1666 #define FF_CMP_BIT    5
1667 #define FF_CMP_RD     6
1668 #define FF_CMP_ZERO   7
1669 #define FF_CMP_VSAD   8
1670 #define FF_CMP_VSSE   9
1671 #define FF_CMP_NSSE   10
1672 #define FF_CMP_W53    11
1673 #define FF_CMP_W97    12
1674 #define FF_CMP_DCTMAX 13
1675 #define FF_CMP_DCT264 14
1676 #define FF_CMP_CHROMA 256
1677
1678     /**
1679      * ME diamond size & shape
1680      * - encoding: Set by user.
1681      * - decoding: unused
1682      */
1683     int dia_size;
1684
1685     /**
1686      * amount of previous MV predictors (2a+1 x 2a+1 square)
1687      * - encoding: Set by user.
1688      * - decoding: unused
1689      */
1690     int last_predictor_count;
1691
1692     /**
1693      * prepass for motion estimation
1694      * - encoding: Set by user.
1695      * - decoding: unused
1696      */
1697     int pre_me;
1698
1699     /**
1700      * motion estimation prepass comparison function
1701      * - encoding: Set by user.
1702      * - decoding: unused
1703      */
1704     int me_pre_cmp;
1705
1706     /**
1707      * ME prepass diamond size & shape
1708      * - encoding: Set by user.
1709      * - decoding: unused
1710      */
1711     int pre_dia_size;
1712
1713     /**
1714      * subpel ME quality
1715      * - encoding: Set by user.
1716      * - decoding: unused
1717      */
1718     int me_subpel_quality;
1719
1720     /**
1721      * DTG active format information (additional aspect ratio
1722      * information only used in DVB MPEG-2 transport streams)
1723      * 0 if not set.
1724      *
1725      * - encoding: unused
1726      * - decoding: Set by decoder.
1727      */
1728     int dtg_active_format;
1729 #define FF_DTG_AFD_SAME         8
1730 #define FF_DTG_AFD_4_3          9
1731 #define FF_DTG_AFD_16_9         10
1732 #define FF_DTG_AFD_14_9         11
1733 #define FF_DTG_AFD_4_3_SP_14_9  13
1734 #define FF_DTG_AFD_16_9_SP_14_9 14
1735 #define FF_DTG_AFD_SP_4_3       15
1736
1737     /**
1738      * maximum motion estimation search range in subpel units
1739      * If 0 then no limit.
1740      *
1741      * - encoding: Set by user.
1742      * - decoding: unused
1743      */
1744     int me_range;
1745
1746     /**
1747      * intra quantizer bias
1748      * - encoding: Set by user.
1749      * - decoding: unused
1750      */
1751     int intra_quant_bias;
1752 #define FF_DEFAULT_QUANT_BIAS 999999
1753
1754     /**
1755      * inter quantizer bias
1756      * - encoding: Set by user.
1757      * - decoding: unused
1758      */
1759     int inter_quant_bias;
1760
1761 #if FF_API_COLOR_TABLE_ID
1762     /**
1763      * color table ID
1764      * - encoding: unused
1765      * - decoding: Which clrtable should be used for 8bit RGB images.
1766      *             Tables have to be stored somewhere. FIXME
1767      */
1768     attribute_deprecated int color_table_id;
1769 #endif
1770
1771     /**
1772      * slice flags
1773      * - encoding: unused
1774      * - decoding: Set by user.
1775      */
1776     int slice_flags;
1777 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1778 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1779 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1780
1781     /**
1782      * XVideo Motion Acceleration
1783      * - encoding: forbidden
1784      * - decoding: set by decoder
1785      */
1786     int xvmc_acceleration;
1787
1788     /**
1789      * macroblock decision mode
1790      * - encoding: Set by user.
1791      * - decoding: unused
1792      */
1793     int mb_decision;
1794 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1795 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1796 #define FF_MB_DECISION_RD     2        ///< rate distortion
1797
1798     /**
1799      * custom intra quantization matrix
1800      * - encoding: Set by user, can be NULL.
1801      * - decoding: Set by libavcodec.
1802      */
1803     uint16_t *intra_matrix;
1804
1805     /**
1806      * custom inter quantization matrix
1807      * - encoding: Set by user, can be NULL.
1808      * - decoding: Set by libavcodec.
1809      */
1810     uint16_t *inter_matrix;
1811
1812     /**
1813      * scene change detection threshold
1814      * 0 is default, larger means fewer detected scene changes.
1815      * - encoding: Set by user.
1816      * - decoding: unused
1817      */
1818     int scenechange_threshold;
1819
1820     /**
1821      * noise reduction strength
1822      * - encoding: Set by user.
1823      * - decoding: unused
1824      */
1825     int noise_reduction;
1826
1827 #if FF_API_INTER_THRESHOLD
1828     /**
1829      * @deprecated this field is unused
1830      */
1831     attribute_deprecated int inter_threshold;
1832 #endif
1833
1834 #if FF_API_MPV_GLOBAL_OPTS
1835     /**
1836      * @deprecated use mpegvideo private options instead
1837      */
1838     attribute_deprecated int quantizer_noise_shaping;
1839 #endif
1840
1841     /**
1842      * Motion estimation threshold below which no motion estimation is
1843      * performed, but instead the user specified motion vectors are used.
1844      *
1845      * - encoding: Set by user.
1846      * - decoding: unused
1847      */
1848     int me_threshold;
1849
1850     /**
1851      * Macroblock threshold below which the user specified macroblock types will be used.
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855     int mb_threshold;
1856
1857     /**
1858      * precision of the intra DC coefficient - 8
1859      * - encoding: Set by user.
1860      * - decoding: unused
1861      */
1862     int intra_dc_precision;
1863
1864     /**
1865      * Number of macroblock rows at the top which are skipped.
1866      * - encoding: unused
1867      * - decoding: Set by user.
1868      */
1869     int skip_top;
1870
1871     /**
1872      * Number of macroblock rows at the bottom which are skipped.
1873      * - encoding: unused
1874      * - decoding: Set by user.
1875      */
1876     int skip_bottom;
1877
1878     /**
1879      * Border processing masking, raises the quantizer for mbs on the borders
1880      * of the picture.
1881      * - encoding: Set by user.
1882      * - decoding: unused
1883      */
1884     float border_masking;
1885
1886     /**
1887      * minimum MB lagrange multipler
1888      * - encoding: Set by user.
1889      * - decoding: unused
1890      */
1891     int mb_lmin;
1892
1893     /**
1894      * maximum MB lagrange multipler
1895      * - encoding: Set by user.
1896      * - decoding: unused
1897      */
1898     int mb_lmax;
1899
1900     /**
1901      *
1902      * - encoding: Set by user.
1903      * - decoding: unused
1904      */
1905     int me_penalty_compensation;
1906
1907     /**
1908      *
1909      * - encoding: Set by user.
1910      * - decoding: unused
1911      */
1912     int bidir_refine;
1913
1914     /**
1915      *
1916      * - encoding: Set by user.
1917      * - decoding: unused
1918      */
1919     int brd_scale;
1920
1921     /**
1922      * minimum GOP size
1923      * - encoding: Set by user.
1924      * - decoding: unused
1925      */
1926     int keyint_min;
1927
1928     /**
1929      * number of reference frames
1930      * - encoding: Set by user.
1931      * - decoding: Set by lavc.
1932      */
1933     int refs;
1934
1935     /**
1936      * chroma qp offset from luma
1937      * - encoding: Set by user.
1938      * - decoding: unused
1939      */
1940     int chromaoffset;
1941
1942     /**
1943      * Multiplied by qscale for each frame and added to scene_change_score.
1944      * - encoding: Set by user.
1945      * - decoding: unused
1946      */
1947     int scenechange_factor;
1948
1949     /**
1950      *
1951      * Note: Value depends upon the compare function used for fullpel ME.
1952      * - encoding: Set by user.
1953      * - decoding: unused
1954      */
1955     int mv0_threshold;
1956
1957     /**
1958      * Adjust sensitivity of b_frame_strategy 1.
1959      * - encoding: Set by user.
1960      * - decoding: unused
1961      */
1962     int b_sensitivity;
1963
1964     /**
1965      * Chromaticity coordinates of the source primaries.
1966      * - encoding: Set by user
1967      * - decoding: Set by libavcodec
1968      */
1969     enum AVColorPrimaries color_primaries;
1970
1971     /**
1972      * Color Transfer Characteristic.
1973      * - encoding: Set by user
1974      * - decoding: Set by libavcodec
1975      */
1976     enum AVColorTransferCharacteristic color_trc;
1977
1978     /**
1979      * YUV colorspace type.
1980      * - encoding: Set by user
1981      * - decoding: Set by libavcodec
1982      */
1983     enum AVColorSpace colorspace;
1984
1985     /**
1986      * MPEG vs JPEG YUV range.
1987      * - encoding: Set by user
1988      * - decoding: Set by libavcodec
1989      */
1990     enum AVColorRange color_range;
1991
1992     /**
1993      * This defines the location of chroma samples.
1994      * - encoding: Set by user
1995      * - decoding: Set by libavcodec
1996      */
1997     enum AVChromaLocation chroma_sample_location;
1998
1999     /**
2000      * Number of slices.
2001      * Indicates number of picture subdivisions. Used for parallelized
2002      * decoding.
2003      * - encoding: Set by user
2004      * - decoding: unused
2005      */
2006     int slices;
2007
2008     /** Field order
2009      * - encoding: set by libavcodec
2010      * - decoding: Set by libavcodec
2011      */
2012     enum AVFieldOrder field_order;
2013
2014     /* audio only */
2015     int sample_rate; ///< samples per second
2016     int channels;    ///< number of audio channels
2017
2018     /**
2019      * audio sample format
2020      * - encoding: Set by user.
2021      * - decoding: Set by libavcodec.
2022      */
2023     enum AVSampleFormat sample_fmt;  ///< sample format
2024
2025     /* The following data should not be initialized. */
2026     /**
2027      * Samples per packet, initialized when calling 'init'.
2028      */
2029     int frame_size;
2030
2031     /**
2032      * Frame counter, set by libavcodec.
2033      *
2034      * - decoding: total number of frames returned from the decoder so far.
2035      * - encoding: total number of frames passed to the encoder so far.
2036      *
2037      *   @note the counter is not incremented if encoding/decoding resulted in
2038      *   an error.
2039      */
2040     int frame_number;
2041
2042     /**
2043      * number of bytes per packet if constant and known or 0
2044      * Used by some WAV based audio codecs.
2045      */
2046     int block_align;
2047
2048     /**
2049      * Audio cutoff bandwidth (0 means "automatic")
2050      * - encoding: Set by user.
2051      * - decoding: unused
2052      */
2053     int cutoff;
2054
2055 #if FF_API_REQUEST_CHANNELS
2056     /**
2057      * Decoder should decode to this many channels if it can (0 for default)
2058      * - encoding: unused
2059      * - decoding: Set by user.
2060      * @deprecated Deprecated in favor of request_channel_layout.
2061      */
2062     int request_channels;
2063 #endif
2064
2065     /**
2066      * Audio channel layout.
2067      * - encoding: set by user.
2068      * - decoding: set by libavcodec.
2069      */
2070     uint64_t channel_layout;
2071
2072     /**
2073      * Request decoder to use this channel layout if it can (0 for default)
2074      * - encoding: unused
2075      * - decoding: Set by user.
2076      */
2077     uint64_t request_channel_layout;
2078
2079     /**
2080      * Type of service that the audio stream conveys.
2081      * - encoding: Set by user.
2082      * - decoding: Set by libavcodec.
2083      */
2084     enum AVAudioServiceType audio_service_type;
2085
2086     /**
2087      * Used to request a sample format from the decoder.
2088      * - encoding: unused.
2089      * - decoding: Set by user.
2090      */
2091     enum AVSampleFormat request_sample_fmt;
2092
2093     /**
2094      * Called at the beginning of each frame to get a buffer for it.
2095      *
2096      * The function will set AVFrame.data[], AVFrame.linesize[].
2097      * AVFrame.extended_data[] must also be set, but it should be the same as
2098      * AVFrame.data[] except for planar audio with more channels than can fit
2099      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2100      * many data pointers as it can hold.
2101      *
2102      * if CODEC_CAP_DR1 is not set then get_buffer() must call
2103      * avcodec_default_get_buffer() instead of providing buffers allocated by
2104      * some other means.
2105      *
2106      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2107      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2108      * but if get_buffer() is overridden then alignment considerations should
2109      * be taken into account.
2110      *
2111      * @see avcodec_default_get_buffer()
2112      *
2113      * Video:
2114      *
2115      * If pic.reference is set then the frame will be read later by libavcodec.
2116      * avcodec_align_dimensions2() should be used to find the required width and
2117      * height, as they normally need to be rounded up to the next multiple of 16.
2118      *
2119      * If frame multithreading is used and thread_safe_callbacks is set,
2120      * it may be called from a different thread, but not from more than one at
2121      * once. Does not need to be reentrant.
2122      *
2123      * @see release_buffer(), reget_buffer()
2124      * @see avcodec_align_dimensions2()
2125      *
2126      * Audio:
2127      *
2128      * Decoders request a buffer of a particular size by setting
2129      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2130      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2131      * to a smaller value in the output frame.
2132      *
2133      * Decoders cannot use the buffer after returning from
2134      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2135      * is assumed to be released immediately upon return.
2136      *
2137      * As a convenience, av_samples_get_buffer_size() and
2138      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2139      * functions to find the required data size and to fill data pointers and
2140      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2141      * since all planes must be the same size.
2142      *
2143      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2144      *
2145      * - encoding: unused
2146      * - decoding: Set by libavcodec, user can override.
2147      */
2148     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2149
2150     /**
2151      * Called to release buffers which were allocated with get_buffer.
2152      * A released buffer can be reused in get_buffer().
2153      * pic.data[*] must be set to NULL.
2154      * May be called from a different thread if frame multithreading is used,
2155      * but not by more than one thread at once, so does not need to be reentrant.
2156      * - encoding: unused
2157      * - decoding: Set by libavcodec, user can override.
2158      */
2159     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2160
2161     /**
2162      * Called at the beginning of a frame to get cr buffer for it.
2163      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2164      * libavcodec will pass previous buffer in pic, function should return
2165      * same buffer or new buffer with old frame "painted" into it.
2166      * If pic.data[0] == NULL must behave like get_buffer().
2167      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2168      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2169      * some other means.
2170      * - encoding: unused
2171      * - decoding: Set by libavcodec, user can override.
2172      */
2173     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2174
2175
2176     /* - encoding parameters */
2177     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2178     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2179
2180     /**
2181      * minimum quantizer
2182      * - encoding: Set by user.
2183      * - decoding: unused
2184      */
2185     int qmin;
2186
2187     /**
2188      * maximum quantizer
2189      * - encoding: Set by user.
2190      * - decoding: unused
2191      */
2192     int qmax;
2193
2194     /**
2195      * maximum quantizer difference between frames
2196      * - encoding: Set by user.
2197      * - decoding: unused
2198      */
2199     int max_qdiff;
2200
2201     /**
2202      * ratecontrol qmin qmax limiting method
2203      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2204      * - encoding: Set by user.
2205      * - decoding: unused
2206      */
2207     float rc_qsquish;
2208
2209     float rc_qmod_amp;
2210     int rc_qmod_freq;
2211
2212     /**
2213      * decoder bitstream buffer size
2214      * - encoding: Set by user.
2215      * - decoding: unused
2216      */
2217     int rc_buffer_size;
2218
2219     /**
2220      * ratecontrol override, see RcOverride
2221      * - encoding: Allocated/set/freed by user.
2222      * - decoding: unused
2223      */
2224     int rc_override_count;
2225     RcOverride *rc_override;
2226
2227     /**
2228      * rate control equation
2229      * - encoding: Set by user
2230      * - decoding: unused
2231      */
2232     const char *rc_eq;
2233
2234     /**
2235      * maximum bitrate
2236      * - encoding: Set by user.
2237      * - decoding: unused
2238      */
2239     int rc_max_rate;
2240
2241     /**
2242      * minimum bitrate
2243      * - encoding: Set by user.
2244      * - decoding: unused
2245      */
2246     int rc_min_rate;
2247
2248     float rc_buffer_aggressivity;
2249
2250     /**
2251      * initial complexity for pass1 ratecontrol
2252      * - encoding: Set by user.
2253      * - decoding: unused
2254      */
2255     float rc_initial_cplx;
2256
2257     /**
2258      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2259      * - encoding: Set by user.
2260      * - decoding: unused.
2261      */
2262     float rc_max_available_vbv_use;
2263
2264     /**
2265      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2266      * - encoding: Set by user.
2267      * - decoding: unused.
2268      */
2269     float rc_min_vbv_overflow_use;
2270
2271     /**
2272      * Number of bits which should be loaded into the rc buffer before decoding starts.
2273      * - encoding: Set by user.
2274      * - decoding: unused
2275      */
2276     int rc_initial_buffer_occupancy;
2277
2278 #define FF_CODER_TYPE_VLC       0
2279 #define FF_CODER_TYPE_AC        1
2280 #define FF_CODER_TYPE_RAW       2
2281 #define FF_CODER_TYPE_RLE       3
2282 #define FF_CODER_TYPE_DEFLATE   4
2283     /**
2284      * coder type
2285      * - encoding: Set by user.
2286      * - decoding: unused
2287      */
2288     int coder_type;
2289
2290     /**
2291      * context model
2292      * - encoding: Set by user.
2293      * - decoding: unused
2294      */
2295     int context_model;
2296
2297     /**
2298      * minimum Lagrange multipler
2299      * - encoding: Set by user.
2300      * - decoding: unused
2301      */
2302     int lmin;
2303
2304     /**
2305      * maximum Lagrange multipler
2306      * - encoding: Set by user.
2307      * - decoding: unused
2308      */
2309     int lmax;
2310
2311     /**
2312      * frame skip threshold
2313      * - encoding: Set by user.
2314      * - decoding: unused
2315      */
2316     int frame_skip_threshold;
2317
2318     /**
2319      * frame skip factor
2320      * - encoding: Set by user.
2321      * - decoding: unused
2322      */
2323     int frame_skip_factor;
2324
2325     /**
2326      * frame skip exponent
2327      * - encoding: Set by user.
2328      * - decoding: unused
2329      */
2330     int frame_skip_exp;
2331
2332     /**
2333      * frame skip comparison function
2334      * - encoding: Set by user.
2335      * - decoding: unused
2336      */
2337     int frame_skip_cmp;
2338
2339     /**
2340      * trellis RD quantization
2341      * - encoding: Set by user.
2342      * - decoding: unused
2343      */
2344     int trellis;
2345
2346     /**
2347      * - encoding: Set by user.
2348      * - decoding: unused
2349      */
2350     int min_prediction_order;
2351
2352     /**
2353      * - encoding: Set by user.
2354      * - decoding: unused
2355      */
2356     int max_prediction_order;
2357
2358     /**
2359      * GOP timecode frame start number, in non drop frame format
2360      * - encoding: Set by user.
2361      * - decoding: unused
2362      */
2363     int64_t timecode_frame_start;
2364
2365     /* The RTP callback: This function is called    */
2366     /* every time the encoder has a packet to send. */
2367     /* It depends on the encoder if the data starts */
2368     /* with a Start Code (it should). H.263 does.   */
2369     /* mb_nb contains the number of macroblocks     */
2370     /* encoded in the RTP payload.                  */
2371     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2372
2373     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2374                             /* do its best to deliver a chunk with size     */
2375                             /* below rtp_payload_size, the chunk will start */
2376                             /* with a start code on some codecs like H.263. */
2377                             /* This doesn't take account of any particular  */
2378                             /* headers inside the transmitted RTP payload.  */
2379
2380     /* statistics, used for 2-pass encoding */
2381     int mv_bits;
2382     int header_bits;
2383     int i_tex_bits;
2384     int p_tex_bits;
2385     int i_count;
2386     int p_count;
2387     int skip_count;
2388     int misc_bits;
2389
2390     /**
2391      * number of bits used for the previously encoded frame
2392      * - encoding: Set by libavcodec.
2393      * - decoding: unused
2394      */
2395     int frame_bits;
2396
2397     /**
2398      * pass1 encoding statistics output buffer
2399      * - encoding: Set by libavcodec.
2400      * - decoding: unused
2401      */
2402     char *stats_out;
2403
2404     /**
2405      * pass2 encoding statistics input buffer
2406      * Concatenated stuff from stats_out of pass1 should be placed here.
2407      * - encoding: Allocated/set/freed by user.
2408      * - decoding: unused
2409      */
2410     char *stats_in;
2411
2412     /**
2413      * Work around bugs in encoders which sometimes cannot be detected automatically.
2414      * - encoding: Set by user
2415      * - decoding: Set by user
2416      */
2417     int workaround_bugs;
2418 #define FF_BUG_AUTODETECT       1  ///< autodetection
2419 #define FF_BUG_OLD_MSMPEG4      2
2420 #define FF_BUG_XVID_ILACE       4
2421 #define FF_BUG_UMP4             8
2422 #define FF_BUG_NO_PADDING       16
2423 #define FF_BUG_AMV              32
2424 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2425 #define FF_BUG_QPEL_CHROMA      64
2426 #define FF_BUG_STD_QPEL         128
2427 #define FF_BUG_QPEL_CHROMA2     256
2428 #define FF_BUG_DIRECT_BLOCKSIZE 512
2429 #define FF_BUG_EDGE             1024
2430 #define FF_BUG_HPEL_CHROMA      2048
2431 #define FF_BUG_DC_CLIP          4096
2432 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2433 #define FF_BUG_TRUNCATED       16384
2434
2435     /**
2436      * strictly follow the standard (MPEG4, ...).
2437      * - encoding: Set by user.
2438      * - decoding: Set by user.
2439      * Setting this to STRICT or higher means the encoder and decoder will
2440      * generally do stupid things, whereas setting it to unofficial or lower
2441      * will mean the encoder might produce output that is not supported by all
2442      * spec-compliant decoders. Decoders don't differentiate between normal,
2443      * unofficial and experimental (that is, they always try to decode things
2444      * when they can) unless they are explicitly asked to behave stupidly
2445      * (=strictly conform to the specs)
2446      */
2447     int strict_std_compliance;
2448 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2449 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2450 #define FF_COMPLIANCE_NORMAL        0
2451 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2452 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2453
2454     /**
2455      * error concealment flags
2456      * - encoding: unused
2457      * - decoding: Set by user.
2458      */
2459     int error_concealment;
2460 #define FF_EC_GUESS_MVS   1
2461 #define FF_EC_DEBLOCK     2
2462
2463     /**
2464      * debug
2465      * - encoding: Set by user.
2466      * - decoding: Set by user.
2467      */
2468     int debug;
2469 #define FF_DEBUG_PICT_INFO   1
2470 #define FF_DEBUG_RC          2
2471 #define FF_DEBUG_BITSTREAM   4
2472 #define FF_DEBUG_MB_TYPE     8
2473 #define FF_DEBUG_QP          16
2474 #define FF_DEBUG_MV          32
2475 #define FF_DEBUG_DCT_COEFF   0x00000040
2476 #define FF_DEBUG_SKIP        0x00000080
2477 #define FF_DEBUG_STARTCODE   0x00000100
2478 #define FF_DEBUG_PTS         0x00000200
2479 #define FF_DEBUG_ER          0x00000400
2480 #define FF_DEBUG_MMCO        0x00000800
2481 #define FF_DEBUG_BUGS        0x00001000
2482 #define FF_DEBUG_VIS_QP      0x00002000
2483 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2484 #define FF_DEBUG_BUFFERS     0x00008000
2485 #define FF_DEBUG_THREADS     0x00010000
2486
2487     /**
2488      * debug
2489      * - encoding: Set by user.
2490      * - decoding: Set by user.
2491      */
2492     int debug_mv;
2493 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2494 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2495 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2496
2497     /**
2498      * Error recognition; may misdetect some more or less valid parts as errors.
2499      * - encoding: unused
2500      * - decoding: Set by user.
2501      */
2502     int err_recognition;
2503 #define AV_EF_CRCCHECK  (1<<0)
2504 #define AV_EF_BITSTREAM (1<<1)
2505 #define AV_EF_BUFFER    (1<<2)
2506 #define AV_EF_EXPLODE   (1<<3)
2507
2508     /**
2509      * opaque 64bit number (generally a PTS) that will be reordered and
2510      * output in AVFrame.reordered_opaque
2511      * @deprecated in favor of pkt_pts
2512      * - encoding: unused
2513      * - decoding: Set by user.
2514      */
2515     int64_t reordered_opaque;
2516
2517     /**
2518      * Hardware accelerator in use
2519      * - encoding: unused.
2520      * - decoding: Set by libavcodec
2521      */
2522     struct AVHWAccel *hwaccel;
2523
2524     /**
2525      * Hardware accelerator context.
2526      * For some hardware accelerators, a global context needs to be
2527      * provided by the user. In that case, this holds display-dependent
2528      * data Libav cannot instantiate itself. Please refer to the
2529      * Libav HW accelerator documentation to know how to fill this
2530      * is. e.g. for VA API, this is a struct vaapi_context.
2531      * - encoding: unused
2532      * - decoding: Set by user
2533      */
2534     void *hwaccel_context;
2535
2536     /**
2537      * error
2538      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2539      * - decoding: unused
2540      */
2541     uint64_t error[AV_NUM_DATA_POINTERS];
2542
2543     /**
2544      * DCT algorithm, see FF_DCT_* below
2545      * - encoding: Set by user.
2546      * - decoding: unused
2547      */
2548     int dct_algo;
2549 #define FF_DCT_AUTO    0
2550 #define FF_DCT_FASTINT 1
2551 #define FF_DCT_INT     2
2552 #define FF_DCT_MMX     3
2553 #define FF_DCT_ALTIVEC 5
2554 #define FF_DCT_FAAN    6
2555
2556     /**
2557      * IDCT algorithm, see FF_IDCT_* below.
2558      * - encoding: Set by user.
2559      * - decoding: Set by user.
2560      */
2561     int idct_algo;
2562 #define FF_IDCT_AUTO          0
2563 #define FF_IDCT_INT           1
2564 #define FF_IDCT_SIMPLE        2
2565 #define FF_IDCT_SIMPLEMMX     3
2566 #define FF_IDCT_LIBMPEG2MMX   4
2567 #define FF_IDCT_MMI           5
2568 #define FF_IDCT_ARM           7
2569 #define FF_IDCT_ALTIVEC       8
2570 #define FF_IDCT_SH4           9
2571 #define FF_IDCT_SIMPLEARM     10
2572 #define FF_IDCT_H264          11
2573 #define FF_IDCT_VP3           12
2574 #define FF_IDCT_IPP           13
2575 #define FF_IDCT_XVIDMMX       14
2576 #define FF_IDCT_CAVS          15
2577 #define FF_IDCT_SIMPLEARMV5TE 16
2578 #define FF_IDCT_SIMPLEARMV6   17
2579 #define FF_IDCT_SIMPLEVIS     18
2580 #define FF_IDCT_WMV2          19
2581 #define FF_IDCT_FAAN          20
2582 #define FF_IDCT_EA            21
2583 #define FF_IDCT_SIMPLENEON    22
2584 #define FF_IDCT_SIMPLEALPHA   23
2585 #define FF_IDCT_BINK          24
2586
2587 #if FF_API_DSP_MASK
2588     /**
2589      * Unused.
2590      * @deprecated use av_set_cpu_flags_mask() instead.
2591      */
2592     attribute_deprecated unsigned dsp_mask;
2593 #endif
2594
2595     /**
2596      * bits per sample/pixel from the demuxer (needed for huffyuv).
2597      * - encoding: Set by libavcodec.
2598      * - decoding: Set by user.
2599      */
2600      int bits_per_coded_sample;
2601
2602     /**
2603      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2604      * - encoding: set by user.
2605      * - decoding: set by libavcodec.
2606      */
2607     int bits_per_raw_sample;
2608
2609     /**
2610      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2611      * - encoding: unused
2612      * - decoding: Set by user.
2613      */
2614     attribute_deprecated int lowres;
2615
2616     /**
2617      * the picture in the bitstream
2618      * - encoding: Set by libavcodec.
2619      * - decoding: Set by libavcodec.
2620      */
2621     AVFrame *coded_frame;
2622
2623     /**
2624      * thread count
2625      * is used to decide how many independent tasks should be passed to execute()
2626      * - encoding: Set by user.
2627      * - decoding: Set by user.
2628      */
2629     int thread_count;
2630
2631     /**
2632      * Which multithreading methods to use.
2633      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2634      * so clients which cannot provide future frames should not use it.
2635      *
2636      * - encoding: Set by user, otherwise the default is used.
2637      * - decoding: Set by user, otherwise the default is used.
2638      */
2639     int thread_type;
2640 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2641 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2642
2643     /**
2644      * Which multithreading methods are in use by the codec.
2645      * - encoding: Set by libavcodec.
2646      * - decoding: Set by libavcodec.
2647      */
2648     int active_thread_type;
2649
2650     /**
2651      * Set by the client if its custom get_buffer() callback can be called
2652      * synchronously from another thread, which allows faster multithreaded decoding.
2653      * draw_horiz_band() will be called from other threads regardless of this setting.
2654      * Ignored if the default get_buffer() is used.
2655      * - encoding: Set by user.
2656      * - decoding: Set by user.
2657      */
2658     int thread_safe_callbacks;
2659
2660     /**
2661      * The codec may call this to execute several independent things.
2662      * It will return only after finishing all tasks.
2663      * The user may replace this with some multithreaded implementation,
2664      * the default implementation will execute the parts serially.
2665      * @param count the number of things to execute
2666      * - encoding: Set by libavcodec, user can override.
2667      * - decoding: Set by libavcodec, user can override.
2668      */
2669     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2670
2671     /**
2672      * The codec may call this to execute several independent things.
2673      * It will return only after finishing all tasks.
2674      * The user may replace this with some multithreaded implementation,
2675      * the default implementation will execute the parts serially.
2676      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2677      * @param c context passed also to func
2678      * @param count the number of things to execute
2679      * @param arg2 argument passed unchanged to func
2680      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2681      * @param func function that will be called count times, with jobnr from 0 to count-1.
2682      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2683      *             two instances of func executing at the same time will have the same threadnr.
2684      * @return always 0 currently, but code should handle a future improvement where when any call to func
2685      *         returns < 0 no further calls to func may be done and < 0 is returned.
2686      * - encoding: Set by libavcodec, user can override.
2687      * - decoding: Set by libavcodec, user can override.
2688      */
2689     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2690
2691     /**
2692      * thread opaque
2693      * Can be used by execute() to store some per AVCodecContext stuff.
2694      * - encoding: set by execute()
2695      * - decoding: set by execute()
2696      */
2697     void *thread_opaque;
2698
2699     /**
2700      * noise vs. sse weight for the nsse comparsion function
2701      * - encoding: Set by user.
2702      * - decoding: unused
2703      */
2704      int nsse_weight;
2705
2706     /**
2707      * profile
2708      * - encoding: Set by user.
2709      * - decoding: Set by libavcodec.
2710      */
2711      int profile;
2712 #define FF_PROFILE_UNKNOWN -99
2713 #define FF_PROFILE_RESERVED -100
2714
2715 #define FF_PROFILE_AAC_MAIN 0
2716 #define FF_PROFILE_AAC_LOW  1
2717 #define FF_PROFILE_AAC_SSR  2
2718 #define FF_PROFILE_AAC_LTP  3
2719 #define FF_PROFILE_AAC_HE   4
2720 #define FF_PROFILE_AAC_HE_V2 28
2721 #define FF_PROFILE_AAC_LD   22
2722 #define FF_PROFILE_AAC_ELD  38
2723
2724 #define FF_PROFILE_DTS         20
2725 #define FF_PROFILE_DTS_ES      30
2726 #define FF_PROFILE_DTS_96_24   40
2727 #define FF_PROFILE_DTS_HD_HRA  50
2728 #define FF_PROFILE_DTS_HD_MA   60
2729
2730 #define FF_PROFILE_MPEG2_422    0
2731 #define FF_PROFILE_MPEG2_HIGH   1
2732 #define FF_PROFILE_MPEG2_SS     2
2733 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2734 #define FF_PROFILE_MPEG2_MAIN   4
2735 #define FF_PROFILE_MPEG2_SIMPLE 5
2736
2737 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2738 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2739
2740 #define FF_PROFILE_H264_BASELINE             66
2741 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2742 #define FF_PROFILE_H264_MAIN                 77
2743 #define FF_PROFILE_H264_EXTENDED             88
2744 #define FF_PROFILE_H264_HIGH                 100
2745 #define FF_PROFILE_H264_HIGH_10              110
2746 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2747 #define FF_PROFILE_H264_HIGH_422             122
2748 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2749 #define FF_PROFILE_H264_HIGH_444             144
2750 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2751 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2752 #define FF_PROFILE_H264_CAVLC_444            44
2753
2754 #define FF_PROFILE_VC1_SIMPLE   0
2755 #define FF_PROFILE_VC1_MAIN     1
2756 #define FF_PROFILE_VC1_COMPLEX  2
2757 #define FF_PROFILE_VC1_ADVANCED 3
2758
2759 #define FF_PROFILE_MPEG4_SIMPLE                     0
2760 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2761 #define FF_PROFILE_MPEG4_CORE                       2
2762 #define FF_PROFILE_MPEG4_MAIN                       3
2763 #define FF_PROFILE_MPEG4_N_BIT                      4
2764 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2765 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2766 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2767 #define FF_PROFILE_MPEG4_HYBRID                     8
2768 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2769 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2770 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2771 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2772 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2773 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2774 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2775
2776     /**
2777      * level
2778      * - encoding: Set by user.
2779      * - decoding: Set by libavcodec.
2780      */
2781      int level;
2782 #define FF_LEVEL_UNKNOWN -99
2783
2784     /**
2785      *
2786      * - encoding: unused
2787      * - decoding: Set by user.
2788      */
2789     enum AVDiscard skip_loop_filter;
2790
2791     /**
2792      *
2793      * - encoding: unused
2794      * - decoding: Set by user.
2795      */
2796     enum AVDiscard skip_idct;
2797
2798     /**
2799      *
2800      * - encoding: unused
2801      * - decoding: Set by user.
2802      */
2803     enum AVDiscard skip_frame;
2804
2805     /**
2806      * Header containing style information for text subtitles.
2807      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2808      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2809      * the Format line following. It shouldn't include any Dialogue line.
2810      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2811      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2812      */
2813     uint8_t *subtitle_header;
2814     int subtitle_header_size;
2815
2816     /**
2817      * Simulates errors in the bitstream to test error concealment.
2818      * - encoding: Set by user.
2819      * - decoding: unused
2820      */
2821     int error_rate;
2822
2823     /**
2824      * Current packet as passed into the decoder, to avoid having
2825      * to pass the packet into every function. Currently only valid
2826      * inside lavc and get/release_buffer callbacks.
2827      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2828      * - encoding: unused
2829      */
2830     AVPacket *pkt;
2831
2832     /**
2833      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2834      * Used for compliant TS muxing.
2835      * - encoding: Set by libavcodec.
2836      * - decoding: unused.
2837      */
2838     uint64_t vbv_delay;
2839 } AVCodecContext;
2840
2841 /**
2842  * AVProfile.
2843  */
2844 typedef struct AVProfile {
2845     int profile;
2846     const char *name; ///< short name for the profile
2847 } AVProfile;
2848
2849 typedef struct AVCodecDefault AVCodecDefault;
2850
2851 /**
2852  * AVCodec.
2853  */
2854 typedef struct AVCodec {
2855     /**
2856      * Name of the codec implementation.
2857      * The name is globally unique among encoders and among decoders (but an
2858      * encoder and a decoder can share the same name).
2859      * This is the primary way to find a codec from the user perspective.
2860      */
2861     const char *name;
2862     /**
2863      * Descriptive name for the codec, meant to be more human readable than name.
2864      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2865      */
2866     const char *long_name;
2867     enum AVMediaType type;
2868     enum CodecID id;
2869     /**
2870      * Codec capabilities.
2871      * see CODEC_CAP_*
2872      */
2873     int capabilities;
2874     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2875     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2876     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2877     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2878     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2879     attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2880     const AVClass *priv_class;              ///< AVClass for the private context
2881     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2882
2883     /*****************************************************************
2884      * No fields below this line are part of the public API. They
2885      * may not be used outside of libavcodec and can be changed and
2886      * removed at will.
2887      * New public fields should be added right above.
2888      *****************************************************************
2889      */
2890     int priv_data_size;
2891     struct AVCodec *next;
2892     /**
2893      * @name Frame-level threading support functions
2894      * @{
2895      */
2896     /**
2897      * If defined, called on thread contexts when they are created.
2898      * If the codec allocates writable tables in init(), re-allocate them here.
2899      * priv_data will be set to a copy of the original.
2900      */
2901     int (*init_thread_copy)(AVCodecContext *);
2902     /**
2903      * Copy necessary context variables from a previous thread context to the current one.
2904      * If not defined, the next thread will start automatically; otherwise, the codec
2905      * must call ff_thread_finish_setup().
2906      *
2907      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2908      */
2909     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2910     /** @} */
2911
2912     /**
2913      * Private codec-specific defaults.
2914      */
2915     const AVCodecDefault *defaults;
2916
2917     /**
2918      * Initialize codec static data, called from avcodec_register().
2919      */
2920     void (*init_static_data)(struct AVCodec *codec);
2921
2922     int (*init)(AVCodecContext *);
2923     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2924     /**
2925      * Encode data to an AVPacket.
2926      *
2927      * @param      avctx          codec context
2928      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2929      * @param[in]  frame          AVFrame containing the raw data to be encoded
2930      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2931      *                            non-empty packet was returned in avpkt.
2932      * @return 0 on success, negative error code on failure
2933      */
2934     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2935                    int *got_packet_ptr);
2936     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2937     int (*close)(AVCodecContext *);
2938     /**
2939      * Flush buffers.
2940      * Will be called when seeking
2941      */
2942     void (*flush)(AVCodecContext *);
2943 } AVCodec;
2944
2945 /**
2946  * AVHWAccel.
2947  */
2948 typedef struct AVHWAccel {
2949     /**
2950      * Name of the hardware accelerated codec.
2951      * The name is globally unique among encoders and among decoders (but an
2952      * encoder and a decoder can share the same name).
2953      */
2954     const char *name;
2955
2956     /**
2957      * Type of codec implemented by the hardware accelerator.
2958      *
2959      * See AVMEDIA_TYPE_xxx
2960      */
2961     enum AVMediaType type;
2962
2963     /**
2964      * Codec implemented by the hardware accelerator.
2965      *
2966      * See CODEC_ID_xxx
2967      */
2968     enum CodecID id;
2969
2970     /**
2971      * Supported pixel format.
2972      *
2973      * Only hardware accelerated formats are supported here.
2974      */
2975     enum PixelFormat pix_fmt;
2976
2977     /**
2978      * Hardware accelerated codec capabilities.
2979      * see FF_HWACCEL_CODEC_CAP_*
2980      */
2981     int capabilities;
2982
2983     struct AVHWAccel *next;
2984
2985     /**
2986      * Called at the beginning of each frame or field picture.
2987      *
2988      * Meaningful frame information (codec specific) is guaranteed to
2989      * be parsed at this point. This function is mandatory.
2990      *
2991      * Note that buf can be NULL along with buf_size set to 0.
2992      * Otherwise, this means the whole frame is available at this point.
2993      *
2994      * @param avctx the codec context
2995      * @param buf the frame data buffer base
2996      * @param buf_size the size of the frame in bytes
2997      * @return zero if successful, a negative value otherwise
2998      */
2999     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3000
3001     /**
3002      * Callback for each slice.
3003      *
3004      * Meaningful slice information (codec specific) is guaranteed to
3005      * be parsed at this point. This function is mandatory.
3006      *
3007      * @param avctx the codec context
3008      * @param buf the slice data buffer base
3009      * @param buf_size the size of the slice in bytes
3010      * @return zero if successful, a negative value otherwise
3011      */
3012     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3013
3014     /**
3015      * Called at the end of each frame or field picture.
3016      *
3017      * The whole picture is parsed at this point and can now be sent
3018      * to the hardware accelerator. This function is mandatory.
3019      *
3020      * @param avctx the codec context
3021      * @return zero if successful, a negative value otherwise
3022      */
3023     int (*end_frame)(AVCodecContext *avctx);
3024
3025     /**
3026      * Size of HW accelerator private data.
3027      *
3028      * Private data is allocated with av_mallocz() before
3029      * AVCodecContext.get_buffer() and deallocated after
3030      * AVCodecContext.release_buffer().
3031      */
3032     int priv_data_size;
3033 } AVHWAccel;
3034
3035 /**
3036  * @defgroup lavc_picture AVPicture
3037  *
3038  * Functions for working with AVPicture
3039  * @{
3040  */
3041
3042 /**
3043  * four components are given, that's all.
3044  * the last component is alpha
3045  */
3046 typedef struct AVPicture {
3047     uint8_t *data[AV_NUM_DATA_POINTERS];
3048     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3049 } AVPicture;
3050
3051 /**
3052  * @}
3053  */
3054
3055 #define AVPALETTE_SIZE 1024
3056 #define AVPALETTE_COUNT 256
3057
3058 enum AVSubtitleType {
3059     SUBTITLE_NONE,
3060
3061     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3062
3063     /**
3064      * Plain text, the text field must be set by the decoder and is
3065      * authoritative. ass and pict fields may contain approximations.
3066      */
3067     SUBTITLE_TEXT,
3068
3069     /**
3070      * Formatted text, the ass field must be set by the decoder and is
3071      * authoritative. pict and text fields may contain approximations.
3072      */
3073     SUBTITLE_ASS,
3074 };
3075
3076 typedef struct AVSubtitleRect {
3077     int x;         ///< top left corner  of pict, undefined when pict is not set
3078     int y;         ///< top left corner  of pict, undefined when pict is not set
3079     int w;         ///< width            of pict, undefined when pict is not set
3080     int h;         ///< height           of pict, undefined when pict is not set
3081     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3082
3083     /**
3084      * data+linesize for the bitmap of this subtitle.
3085      * can be set for text/ass as well once they where rendered
3086      */
3087     AVPicture pict;
3088     enum AVSubtitleType type;
3089
3090     char *text;                     ///< 0 terminated plain UTF-8 text
3091
3092     /**
3093      * 0 terminated ASS/SSA compatible event line.
3094      * The pressentation of this is unaffected by the other values in this
3095      * struct.
3096      */
3097     char *ass;
3098 } AVSubtitleRect;
3099
3100 typedef struct AVSubtitle {
3101     uint16_t format; /* 0 = graphics */
3102     uint32_t start_display_time; /* relative to packet pts, in ms */
3103     uint32_t end_display_time; /* relative to packet pts, in ms */
3104     unsigned num_rects;
3105     AVSubtitleRect **rects;
3106     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3107 } AVSubtitle;
3108
3109 /**
3110  * If c is NULL, returns the first registered codec,
3111  * if c is non-NULL, returns the next registered codec after c,
3112  * or NULL if c is the last one.
3113  */
3114 AVCodec *av_codec_next(AVCodec *c);
3115
3116 /**
3117  * Return the LIBAVCODEC_VERSION_INT constant.
3118  */
3119 unsigned avcodec_version(void);
3120
3121 /**
3122  * Return the libavcodec build-time configuration.
3123  */
3124 const char *avcodec_configuration(void);
3125
3126 /**
3127  * Return the libavcodec license.
3128  */
3129 const char *avcodec_license(void);
3130
3131 /**
3132  * Register the codec codec and initialize libavcodec.
3133  *
3134  * @warning either this function or avcodec_register_all() must be called
3135  * before any other libavcodec functions.
3136  *
3137  * @see avcodec_register_all()
3138  */
3139 void avcodec_register(AVCodec *codec);
3140
3141 /**
3142  * Register all the codecs, parsers and bitstream filters which were enabled at
3143  * configuration time. If you do not call this function you can select exactly
3144  * which formats you want to support, by using the individual registration
3145  * functions.
3146  *
3147  * @see avcodec_register
3148  * @see av_register_codec_parser
3149  * @see av_register_bitstream_filter
3150  */
3151 void avcodec_register_all(void);
3152
3153 /**
3154  * Allocate an AVCodecContext and set its fields to default values.  The
3155  * resulting struct can be deallocated by calling avcodec_close() on it followed
3156  * by av_free().
3157  *
3158  * @param codec if non-NULL, allocate private data and initialize defaults
3159  *              for the given codec. It is illegal to then call avcodec_open2()
3160  *              with a different codec.
3161  *              If NULL, then the codec-specific defaults won't be initialized,
3162  *              which may result in suboptimal default settings (this is
3163  *              important mainly for encoders, e.g. libx264).
3164  *
3165  * @return An AVCodecContext filled with default values or NULL on failure.
3166  * @see avcodec_get_context_defaults
3167  */
3168 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3169
3170 /**
3171  * Set the fields of the given AVCodecContext to default values corresponding
3172  * to the given codec (defaults may be codec-dependent).
3173  *
3174  * Do not call this function if a non-NULL codec has been passed
3175  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3176  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3177  * different codec on this AVCodecContext.
3178  */
3179 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3180
3181 /**
3182  * Get the AVClass for AVCodecContext. It can be used in combination with
3183  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3184  *
3185  * @see av_opt_find().
3186  */
3187 const AVClass *avcodec_get_class(void);
3188
3189 /**
3190  * Copy the settings of the source AVCodecContext into the destination
3191  * AVCodecContext. The resulting destination codec context will be
3192  * unopened, i.e. you are required to call avcodec_open2() before you
3193  * can use this AVCodecContext to decode/encode video/audio data.
3194  *
3195  * @param dest target codec context, should be initialized with
3196  *             avcodec_alloc_context3(), but otherwise uninitialized
3197  * @param src source codec context
3198  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3199  */
3200 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3201
3202 /**
3203  * Allocate an AVFrame and set its fields to default values.  The resulting
3204  * struct can be deallocated by simply calling av_free().
3205  *
3206  * @return An AVFrame filled with default values or NULL on failure.
3207  * @see avcodec_get_frame_defaults
3208  */
3209 AVFrame *avcodec_alloc_frame(void);
3210
3211 /**
3212  * Set the fields of the given AVFrame to default values.
3213  *
3214  * @param pic The AVFrame of which the fields should be set to default values.
3215  */
3216 void avcodec_get_frame_defaults(AVFrame *pic);
3217
3218 /**
3219  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3220  * function the context has to be allocated with avcodec_alloc_context3().
3221  *
3222  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3223  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3224  * retrieving a codec.
3225  *
3226  * @warning This function is not thread safe!
3227  *
3228  * @code
3229  * avcodec_register_all();
3230  * av_dict_set(&opts, "b", "2.5M", 0);
3231  * codec = avcodec_find_decoder(CODEC_ID_H264);
3232  * if (!codec)
3233  *     exit(1);
3234  *
3235  * context = avcodec_alloc_context3(codec);
3236  *
3237  * if (avcodec_open2(context, codec, opts) < 0)
3238  *     exit(1);
3239  * @endcode
3240  *
3241  * @param avctx The context to initialize.
3242  * @param codec The codec to open this context for. If a non-NULL codec has been
3243  *              previously passed to avcodec_alloc_context3() or
3244  *              avcodec_get_context_defaults3() for this context, then this
3245  *              parameter MUST be either NULL or equal to the previously passed
3246  *              codec.
3247  * @param options A dictionary filled with AVCodecContext and codec-private options.
3248  *                On return this object will be filled with options that were not found.
3249  *
3250  * @return zero on success, a negative value on error
3251  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3252  *      av_dict_set(), av_opt_find().
3253  */
3254 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3255
3256 /**
3257  * Close a given AVCodecContext and free all the data associated with it
3258  * (but not the AVCodecContext itself).
3259  *
3260  * Calling this function on an AVCodecContext that hasn't been opened will free
3261  * the codec-specific data allocated in avcodec_alloc_context3() /
3262  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3263  * do nothing.
3264  */
3265 int avcodec_close(AVCodecContext *avctx);
3266
3267 /**
3268  * Free all allocated data in the given subtitle struct.
3269  *
3270  * @param sub AVSubtitle to free.
3271  */
3272 void avsubtitle_free(AVSubtitle *sub);
3273
3274 /**
3275  * @}
3276  */
3277
3278 /**
3279  * @addtogroup lavc_packet
3280  * @{
3281  */
3282
3283 /**
3284  * @deprecated use NULL instead
3285  */
3286 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3287
3288 /**
3289  * Default packet destructor.
3290  */
3291 void av_destruct_packet(AVPacket *pkt);
3292
3293 /**
3294  * Initialize optional fields of a packet with default values.
3295  *
3296  * Note, this does not touch the data and size members, which have to be
3297  * initialized separately.
3298  *
3299  * @param pkt packet
3300  */
3301 void av_init_packet(AVPacket *pkt);
3302
3303 /**
3304  * Allocate the payload of a packet and initialize its fields with
3305  * default values.
3306  *
3307  * @param pkt packet
3308  * @param size wanted payload size
3309  * @return 0 if OK, AVERROR_xxx otherwise
3310  */
3311 int av_new_packet(AVPacket *pkt, int size);
3312
3313 /**
3314  * Reduce packet size, correctly zeroing padding
3315  *
3316  * @param pkt packet
3317  * @param size new size
3318  */
3319 void av_shrink_packet(AVPacket *pkt, int size);
3320
3321 /**
3322  * Increase packet size, correctly zeroing padding
3323  *
3324  * @param pkt packet
3325  * @param grow_by number of bytes by which to increase the size of the packet
3326  */
3327 int av_grow_packet(AVPacket *pkt, int grow_by);
3328
3329 /**
3330  * @warning This is a hack - the packet memory allocation stuff is broken. The
3331  * packet is allocated if it was not really allocated.
3332  */
3333 int av_dup_packet(AVPacket *pkt);
3334
3335 /**
3336  * Free a packet.
3337  *
3338  * @param pkt packet to free
3339  */
3340 void av_free_packet(AVPacket *pkt);
3341
3342 /**
3343  * Allocate new information of a packet.
3344  *
3345  * @param pkt packet
3346  * @param type side information type
3347  * @param size side information size
3348  * @return pointer to fresh allocated data or NULL otherwise
3349  */
3350 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3351                                  int size);
3352
3353 /**
3354  * Shrink the already allocated side data buffer
3355  *
3356  * @param pkt packet
3357  * @param type side information type
3358  * @param size new side information size
3359  * @return 0 on success, < 0 on failure
3360  */
3361 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3362                                int size);
3363
3364 /**
3365  * Get side information from packet.
3366  *
3367  * @param pkt packet
3368  * @param type desired side information type
3369  * @param size pointer for side information size to store (optional)
3370  * @return pointer to data if present or NULL otherwise
3371  */
3372 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3373                                  int *size);
3374
3375 /**
3376  * @}
3377  */
3378
3379 /**
3380  * @addtogroup lavc_decoding
3381  * @{
3382  */
3383
3384 /**
3385  * Find a registered decoder with a matching codec ID.
3386  *
3387  * @param id CodecID of the requested decoder
3388  * @return A decoder if one was found, NULL otherwise.
3389  */
3390 AVCodec *avcodec_find_decoder(enum CodecID id);
3391
3392 /**
3393  * Find a registered decoder with the specified name.
3394  *
3395  * @param name name of the requested decoder
3396  * @return A decoder if one was found, NULL otherwise.
3397  */
3398 AVCodec *avcodec_find_decoder_by_name(const char *name);
3399
3400 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3401 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3402 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3403
3404 /**
3405  * Return the amount of padding in pixels which the get_buffer callback must
3406  * provide around the edge of the image for codecs which do not have the
3407  * CODEC_FLAG_EMU_EDGE flag.
3408  *
3409  * @return Required padding in pixels.
3410  */
3411 unsigned avcodec_get_edge_width(void);
3412
3413 /**
3414  * Modify width and height values so that they will result in a memory
3415  * buffer that is acceptable for the codec if you do not use any horizontal
3416  * padding.
3417  *
3418  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3419  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3420  * according to avcodec_get_edge_width() before.
3421  */
3422 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3423
3424 /**
3425  * Modify width and height values so that they will result in a memory
3426  * buffer that is acceptable for the codec if you also ensure that all
3427  * line sizes are a multiple of the respective linesize_align[i].
3428  *
3429  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3430  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3431  * according to avcodec_get_edge_width() before.
3432  */
3433 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3434                                int linesize_align[AV_NUM_DATA_POINTERS]);
3435
3436 #if FF_API_OLD_DECODE_AUDIO
3437 /**
3438  * Wrapper function which calls avcodec_decode_audio4.
3439  *
3440  * @deprecated Use avcodec_decode_audio4 instead.
3441  *
3442  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3443  * Some decoders may support multiple frames in a single AVPacket, such
3444  * decoders would then just decode the first frame. In this case,
3445  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3446  * the remaining data in order to decode the second frame etc.
3447  * If no frame
3448  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3449  * decompressed frame size in bytes.
3450  *
3451  * @warning You must set frame_size_ptr to the allocated size of the
3452  * output buffer before calling avcodec_decode_audio3().
3453  *
3454  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3455  * the actual read bytes because some optimized bitstream readers read 32 or 64
3456  * bits at once and could read over the end.
3457  *
3458  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3459  * no overreading happens for damaged MPEG streams.
3460  *
3461  * @warning You must not provide a custom get_buffer() when using
3462  * avcodec_decode_audio3().  Doing so will override it with
3463  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,
3464  * which does allow the application to provide a custom get_buffer().
3465  *
3466  * @note You might have to align the input buffer avpkt->data and output buffer
3467  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3468  * necessary at all, on others it won't work at all if not aligned and on others
3469  * it will work but it will have an impact on performance.
3470  *
3471  * In practice, avpkt->data should have 4 byte alignment at minimum and
3472  * samples should be 16 byte aligned unless the CPU doesn't need it
3473  * (AltiVec and SSE do).
3474  *
3475  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3476  * between input and output, these need to be fed with avpkt->data=NULL,
3477  * avpkt->size=0 at the end to return the remaining frames.
3478  *
3479  * @param avctx the codec context
3480  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3481  *                     If the sample format is planar, each channel plane will
3482  *                     be the same size, with no padding between channels.
3483  * @param[in,out] frame_size_ptr the output buffer size in bytes
3484  * @param[in] avpkt The input AVPacket containing the input buffer.
3485  *            You can create such packet with av_init_packet() and by then setting
3486  *            data and size, some decoders might in addition need other fields.
3487  *            All decoders are designed to use the least fields possible though.
3488  * @return On error a negative value is returned, otherwise the number of bytes
3489  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3490  */
3491 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3492                          int *frame_size_ptr,
3493                          AVPacket *avpkt);
3494 #endif
3495
3496 /**
3497  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3498  *
3499  * Some decoders may support multiple frames in a single AVPacket. Such
3500  * decoders would then just decode the first frame. In this case,
3501  * avcodec_decode_audio4 has to be called again with an AVPacket containing
3502  * the remaining data in order to decode the second frame, etc...
3503  * Even if no frames are returned, the packet needs to be fed to the decoder
3504  * with remaining data until it is completely consumed or an error occurs.
3505  *
3506  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3507  *          larger than the actual read bytes because some optimized bitstream
3508  *          readers read 32 or 64 bits at once and could read over the end.
3509  *
3510  * @note You might have to align the input buffer. The alignment requirements
3511  *       depend on the CPU and the decoder.
3512  *
3513  * @param      avctx the codec context
3514  * @param[out] frame The AVFrame in which to store decoded audio samples.
3515  *                   Decoders request a buffer of a particular size by setting
3516  *                   AVFrame.nb_samples prior to calling get_buffer(). The
3517  *                   decoder may, however, only utilize part of the buffer by
3518  *                   setting AVFrame.nb_samples to a smaller value in the
3519  *                   output frame.
3520  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3521  *                           non-zero.
3522  * @param[in]  avpkt The input AVPacket containing the input buffer.
3523  *                   At least avpkt->data and avpkt->size should be set. Some
3524  *                   decoders might also require additional fields to be set.
3525  * @return A negative error code is returned if an error occurred during
3526  *         decoding, otherwise the number of bytes consumed from the input
3527  *         AVPacket is returned.
3528  */
3529 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3530                           int *got_frame_ptr, AVPacket *avpkt);
3531
3532 /**
3533  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3534  * Some decoders may support multiple frames in a single AVPacket, such
3535  * decoders would then just decode the first frame.
3536  *
3537  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3538  * the actual read bytes because some optimized bitstream readers read 32 or 64
3539  * bits at once and could read over the end.
3540  *
3541  * @warning The end of the input buffer buf should be set to 0 to ensure that
3542  * no overreading happens for damaged MPEG streams.
3543  *
3544  * @note You might have to align the input buffer avpkt->data.
3545  * The alignment requirements depend on the CPU: on some CPUs it isn't
3546  * necessary at all, on others it won't work at all if not aligned and on others
3547  * it will work but it will have an impact on performance.
3548  *
3549  * In practice, avpkt->data should have 4 byte alignment at minimum.
3550  *
3551  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3552  * between input and output, these need to be fed with avpkt->data=NULL,
3553  * avpkt->size=0 at the end to return the remaining frames.
3554  *
3555  * @param avctx the codec context
3556  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3557  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3558  *             allocate memory for the actual bitmap.
3559  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3560  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3561  *                   decodes and the decoder tells the user once it does not need the data anymore,
3562  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3563  *
3564  * @param[in] avpkt The input AVpacket containing the input buffer.
3565  *            You can create such packet with av_init_packet() and by then setting
3566  *            data and size, some decoders might in addition need other fields like
3567  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3568  *            fields possible.
3569  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3570  * @return On error a negative value is returned, otherwise the number of bytes
3571  * used or zero if no frame could be decompressed.
3572  */
3573 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3574                          int *got_picture_ptr,
3575                          AVPacket *avpkt);
3576
3577 /**
3578  * Decode a subtitle message.
3579  * Return a negative value on error, otherwise return the number of bytes used.
3580  * If no subtitle could be decompressed, got_sub_ptr is zero.
3581  * Otherwise, the subtitle is stored in *sub.
3582  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3583  * simplicity, because the performance difference is expect to be negligible
3584  * and reusing a get_buffer written for video codecs would probably perform badly
3585  * due to a potentially very different allocation pattern.
3586  *
3587  * @param avctx the codec context
3588  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3589                    freed with avsubtitle_free if *got_sub_ptr is set.
3590  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3591  * @param[in] avpkt The input AVPacket containing the input buffer.
3592  */
3593 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3594                             int *got_sub_ptr,
3595                             AVPacket *avpkt);
3596
3597 /**
3598  * @defgroup lavc_parsing Frame parsing
3599  * @{
3600  */
3601
3602 typedef struct AVCodecParserContext {
3603     void *priv_data;
3604     struct AVCodecParser *parser;
3605     int64_t frame_offset; /* offset of the current frame */
3606     int64_t cur_offset; /* current offset
3607                            (incremented by each av_parser_parse()) */
3608     int64_t next_frame_offset; /* offset of the next frame */
3609     /* video info */
3610     int pict_type; /* XXX: Put it back in AVCodecContext. */
3611     /**
3612      * This field is used for proper frame duration computation in lavf.
3613      * It signals, how much longer the frame duration of the current frame
3614      * is compared to normal frame duration.
3615      *
3616      * frame_duration = (1 + repeat_pict) * time_base
3617      *
3618      * It is used by codecs like H.264 to display telecined material.
3619      */
3620     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3621     int64_t pts;     /* pts of the current frame */
3622     int64_t dts;     /* dts of the current frame */
3623
3624     /* private data */
3625     int64_t last_pts;
3626     int64_t last_dts;
3627     int fetch_timestamp;
3628
3629 #define AV_PARSER_PTS_NB 4
3630     int cur_frame_start_index;
3631     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3632     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3633     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3634
3635     int flags;
3636 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3637 #define PARSER_FLAG_ONCE                      0x0002
3638 /// Set if the parser has a valid file offset
3639 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
3640
3641     int64_t offset;      ///< byte offset from starting packet start
3642     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3643
3644     /**
3645      * Set by parser to 1 for key frames and 0 for non-key frames.
3646      * It is initialized to -1, so if the parser doesn't set this flag,
3647      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3648      * will be used.
3649      */
3650     int key_frame;
3651
3652     /**
3653      * Time difference in stream time base units from the pts of this
3654      * packet to the point at which the output from the decoder has converged
3655      * independent from the availability of previous frames. That is, the
3656      * frames are virtually identical no matter if decoding started from
3657      * the very first frame or from this keyframe.
3658      * Is AV_NOPTS_VALUE if unknown.
3659      * This field is not the display duration of the current frame.
3660      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3661      * set.
3662      *
3663      * The purpose of this field is to allow seeking in streams that have no
3664      * keyframes in the conventional sense. It corresponds to the
3665      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3666      * essential for some types of subtitle streams to ensure that all
3667      * subtitles are correctly displayed after seeking.
3668      */
3669     int64_t convergence_duration;
3670
3671     // Timestamp generation support:
3672     /**
3673      * Synchronization point for start of timestamp generation.
3674      *
3675      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3676      * (default).
3677      *
3678      * For example, this corresponds to presence of H.264 buffering period
3679      * SEI message.
3680      */
3681     int dts_sync_point;
3682
3683     /**
3684      * Offset of the current timestamp against last timestamp sync point in
3685      * units of AVCodecContext.time_base.
3686      *
3687      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3688      * contain a valid timestamp offset.
3689      *
3690      * Note that the timestamp of sync point has usually a nonzero
3691      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3692      * the next frame after timestamp sync point will be usually 1.
3693      *
3694      * For example, this corresponds to H.264 cpb_removal_delay.
3695      */
3696     int dts_ref_dts_delta;
3697
3698     /**
3699      * Presentation delay of current frame in units of AVCodecContext.time_base.
3700      *
3701      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3702      * contain valid non-negative timestamp delta (presentation time of a frame
3703      * must not lie in the past).
3704      *
3705      * This delay represents the difference between decoding and presentation
3706      * time of the frame.
3707      *
3708      * For example, this corresponds to H.264 dpb_output_delay.
3709      */
3710     int pts_dts_delta;
3711
3712     /**
3713      * Position of the packet in file.
3714      *
3715      * Analogous to cur_frame_pts/dts
3716      */
3717     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3718
3719     /**
3720      * Byte position of currently parsed frame in stream.
3721      */
3722     int64_t pos;
3723
3724     /**
3725      * Previous frame byte position.
3726      */
3727     int64_t last_pos;
3728
3729     /**
3730      * Duration of the current frame.
3731      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3732      * For all other types, this is in units of AVCodecContext.time_base.
3733      */
3734     int duration;
3735 } AVCodecParserContext;
3736
3737 typedef struct AVCodecParser {
3738     int codec_ids[5]; /* several codec IDs are permitted */
3739     int priv_data_size;
3740     int (*parser_init)(AVCodecParserContext *s);
3741     int (*parser_parse)(AVCodecParserContext *s,
3742                         AVCodecContext *avctx,
3743                         const uint8_t **poutbuf, int *poutbuf_size,
3744                         const uint8_t *buf, int buf_size);
3745     void (*parser_close)(AVCodecParserContext *s);
3746     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3747     struct AVCodecParser *next;
3748 } AVCodecParser;
3749
3750 AVCodecParser *av_parser_next(AVCodecParser *c);
3751
3752 void av_register_codec_parser(AVCodecParser *parser);
3753 AVCodecParserContext *av_parser_init(int codec_id);
3754
3755 /**
3756  * Parse a packet.
3757  *
3758  * @param s             parser context.
3759  * @param avctx         codec context.
3760  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3761  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3762  * @param buf           input buffer.
3763  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3764  * @param pts           input presentation timestamp.
3765  * @param dts           input decoding timestamp.
3766  * @param pos           input byte position in stream.
3767  * @return the number of bytes of the input bitstream used.
3768  *
3769  * Example:
3770  * @code
3771  *   while(in_len){
3772  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3773  *                                        in_data, in_len,
3774  *                                        pts, dts, pos);
3775  *       in_data += len;
3776  *       in_len  -= len;
3777  *
3778  *       if(size)
3779  *          decode_frame(data, size);
3780  *   }
3781  * @endcode
3782  */
3783 int av_parser_parse2(AVCodecParserContext *s,
3784                      AVCodecContext *avctx,
3785                      uint8_t **poutbuf, int *poutbuf_size,
3786                      const uint8_t *buf, int buf_size,
3787                      int64_t pts, int64_t dts,
3788                      int64_t pos);
3789
3790 int av_parser_change(AVCodecParserContext *s,
3791                      AVCodecContext *avctx,
3792                      uint8_t **poutbuf, int *poutbuf_size,
3793                      const uint8_t *buf, int buf_size, int keyframe);
3794 void av_parser_close(AVCodecParserContext *s);
3795
3796 /**
3797  * @}
3798  * @}
3799  */
3800
3801 /**
3802  * @addtogroup lavc_encoding
3803  * @{
3804  */
3805
3806 /**
3807  * Find a registered encoder with a matching codec ID.
3808  *
3809  * @param id CodecID of the requested encoder
3810  * @return An encoder if one was found, NULL otherwise.
3811  */
3812 AVCodec *avcodec_find_encoder(enum CodecID id);
3813
3814 /**
3815  * Find a registered encoder with the specified name.
3816  *
3817  * @param name name of the requested encoder
3818  * @return An encoder if one was found, NULL otherwise.
3819  */
3820 AVCodec *avcodec_find_encoder_by_name(const char *name);
3821
3822 #if FF_API_OLD_ENCODE_AUDIO
3823 /**
3824  * Encode an audio frame from samples into buf.
3825  *
3826  * @deprecated Use avcodec_encode_audio2 instead.
3827  *
3828  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3829  * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3830  * will know how much space is needed because it depends on the value passed
3831  * in buf_size as described below. In that case a lower value can be used.
3832  *
3833  * @param avctx the codec context
3834  * @param[out] buf the output buffer
3835  * @param[in] buf_size the output buffer size
3836  * @param[in] samples the input buffer containing the samples
3837  * The number of samples read from this buffer is frame_size*channels,
3838  * both of which are defined in avctx.
3839  * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3840  * samples read from samples is equal to:
3841  * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3842  * This also implies that av_get_bits_per_sample() must not return 0 for these
3843  * codecs.
3844  * @return On error a negative value is returned, on success zero or the number
3845  * of bytes used to encode the data read from the input buffer.
3846  */
3847 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3848                                               uint8_t *buf, int buf_size,
3849                                               const short *samples);
3850 #endif
3851
3852 /**
3853  * Encode a frame of audio.
3854  *
3855  * Takes input samples from frame and writes the next output packet, if
3856  * available, to avpkt. The output packet does not necessarily contain data for
3857  * the most recent frame, as encoders can delay, split, and combine input frames
3858  * internally as needed.
3859  *
3860  * @param avctx     codec context
3861  * @param avpkt     output AVPacket.
3862  *                  The user can supply an output buffer by setting
3863  *                  avpkt->data and avpkt->size prior to calling the
3864  *                  function, but if the size of the user-provided data is not
3865  *                  large enough, encoding will fail. All other AVPacket fields
3866  *                  will be reset by the encoder using av_init_packet(). If
3867  *                  avpkt->data is NULL, the encoder will allocate it.
3868  *                  The encoder will set avpkt->size to the size of the
3869  *                  output packet.
3870  *
3871  *                  If this function fails or produces no output, avpkt will be
3872  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
3873  *                  called to free the user supplied buffer).
3874  * @param[in] frame AVFrame containing the raw audio data to be encoded.
3875  *                  May be NULL when flushing an encoder that has the
3876  *                  CODEC_CAP_DELAY capability set.
3877  *                  If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3878  *                  can have any number of samples.
3879  *                  If it is not set, frame->nb_samples must be equal to
3880  *                  avctx->frame_size for all frames except the last.
3881  *                  The final frame may be smaller than avctx->frame_size.
3882  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3883  *                            output packet is non-empty, and to 0 if it is
3884  *                            empty. If the function returns an error, the
3885  *                            packet can be assumed to be invalid, and the
3886  *                            value of got_packet_ptr is undefined and should
3887  *                            not be used.
3888  * @return          0 on success, negative error code on failure
3889  */
3890 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3891                           const AVFrame *frame, int *got_packet_ptr);
3892
3893 #if FF_API_OLD_ENCODE_VIDEO
3894 /**
3895  * @deprecated use avcodec_encode_video2() instead.
3896  *
3897  * Encode a video frame from pict into buf.
3898  * The input picture should be
3899  * stored using a specific format, namely avctx.pix_fmt.
3900  *
3901  * @param avctx the codec context
3902  * @param[out] buf the output buffer for the bitstream of encoded frame
3903  * @param[in] buf_size the size of the output buffer in bytes
3904  * @param[in] pict the input picture to encode
3905  * @return On error a negative value is returned, on success zero or the number
3906  * of bytes used from the output buffer.
3907  */
3908 attribute_deprecated
3909 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3910                          const AVFrame *pict);
3911 #endif
3912
3913 /**
3914  * Encode a frame of video.
3915  *
3916  * Takes input raw video data from frame and writes the next output packet, if
3917  * available, to avpkt. The output packet does not necessarily contain data for
3918  * the most recent frame, as encoders can delay and reorder input frames
3919  * internally as needed.
3920  *
3921  * @param avctx     codec context
3922  * @param avpkt     output AVPacket.
3923  *                  The user can supply an output buffer by setting
3924  *                  avpkt->data and avpkt->size prior to calling the
3925  *                  function, but if the size of the user-provided data is not
3926  *                  large enough, encoding will fail. All other AVPacket fields
3927  *                  will be reset by the encoder using av_init_packet(). If
3928  *                  avpkt->data is NULL, the encoder will allocate it.
3929  *                  The encoder will set avpkt->size to the size of the
3930  *                  output packet. The returned data (if any) belongs to the
3931  *                  caller, he is responsible for freeing it.
3932  *
3933  *                  If this function fails or produces no output, avpkt will be
3934  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
3935  *                  called to free the user supplied buffer).
3936  * @param[in] frame AVFrame containing the raw video data to be encoded.
3937  *                  May be NULL when flushing an encoder that has the
3938  *                  CODEC_CAP_DELAY capability set.
3939  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3940  *                            output packet is non-empty, and to 0 if it is
3941  *                            empty. If the function returns an error, the
3942  *                            packet can be assumed to be invalid, and the
3943  *                            value of got_packet_ptr is undefined and should
3944  *                            not be used.
3945  * @return          0 on success, negative error code on failure
3946  */
3947 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3948                           const AVFrame *frame, int *got_packet_ptr);
3949
3950 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3951                             const AVSubtitle *sub);
3952
3953
3954 /**
3955  * @}
3956  */
3957
3958 /**
3959  * @defgroup lavc_resample Audio resampling
3960  * @ingroup libavc
3961  *
3962  * @{
3963  */
3964 struct ReSampleContext;
3965 struct AVResampleContext;
3966
3967 typedef struct ReSampleContext ReSampleContext;
3968
3969 /**
3970  *  Initialize audio resampling context.
3971  *
3972  * @param output_channels  number of output channels
3973  * @param input_channels   number of input channels
3974  * @param output_rate      output sample rate
3975  * @param input_rate       input sample rate
3976  * @param sample_fmt_out   requested output sample format
3977  * @param sample_fmt_in    input sample format
3978  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3979  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3980  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3981                            between the 2 closest, if 0 the closest will be used
3982  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3983  * @return allocated ReSampleContext, NULL if error occurred
3984  */
3985 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3986                                         int output_rate, int input_rate,
3987                                         enum AVSampleFormat sample_fmt_out,
3988                                         enum AVSampleFormat sample_fmt_in,
3989                                         int filter_length, int log2_phase_count,
3990                                         int linear, double cutoff);
3991
3992 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3993
3994 /**
3995  * Free resample context.
3996  *
3997  * @param s a non-NULL pointer to a resample context previously
3998  *          created with av_audio_resample_init()
3999  */
4000 void audio_resample_close(ReSampleContext *s);
4001
4002
4003 /**
4004  * Initialize an audio resampler.
4005  * Note, if either rate is not an integer then simply scale both rates up so they are.
4006  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4007  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4008  * @param linear If 1 then the used FIR filter will be linearly interpolated
4009                  between the 2 closest, if 0 the closest will be used
4010  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4011  */
4012 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4013
4014 /**
4015  * Resample an array of samples using a previously configured context.
4016  * @param src an array of unconsumed samples
4017  * @param consumed the number of samples of src which have been consumed are returned here
4018  * @param src_size the number of unconsumed samples available
4019  * @param dst_size the amount of space in samples available in dst
4020  * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4021  * @return the number of samples written in dst or -1 if an error occurred
4022  */
4023 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4024
4025
4026 /**
4027  * Compensate samplerate/timestamp drift. The compensation is done by changing
4028  * the resampler parameters, so no audible clicks or similar distortions occur
4029  * @param compensation_distance distance in output samples over which the compensation should be performed
4030  * @param sample_delta number of output samples which should be output less
4031  *
4032  * example: av_resample_compensate(c, 10, 500)
4033  * here instead of 510 samples only 500 samples would be output
4034  *
4035  * note, due to rounding the actual compensation might be slightly different,
4036  * especially if the compensation_distance is large and the in_rate used during init is small
4037  */
4038 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4039 void av_resample_close(struct AVResampleContext *c);
4040
4041 /**
4042  * @}
4043  */
4044
4045 /**
4046  * @addtogroup lavc_picture
4047  * @{
4048  */
4049
4050 /**
4051  * Allocate memory for a picture.  Call avpicture_free() to free it.
4052  *
4053  * @see avpicture_fill()
4054  *
4055  * @param picture the picture to be filled in
4056  * @param pix_fmt the format of the picture
4057  * @param width the width of the picture
4058  * @param height the height of the picture
4059  * @return zero if successful, a negative value if not
4060  */
4061 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4062
4063 /**
4064  * Free a picture previously allocated by avpicture_alloc().
4065  * The data buffer used by the AVPicture is freed, but the AVPicture structure
4066  * itself is not.
4067  *
4068  * @param picture the AVPicture to be freed
4069  */
4070 void avpicture_free(AVPicture *picture);
4071
4072 /**
4073  * Fill in the AVPicture fields.
4074  * The fields of the given AVPicture are filled in by using the 'ptr' address
4075  * which points to the image data buffer. Depending on the specified picture
4076  * format, one or multiple image data pointers and line sizes will be set.
4077  * If a planar format is specified, several pointers will be set pointing to
4078  * the different picture planes and the line sizes of the different planes
4079  * will be stored in the lines_sizes array.
4080  * Call with ptr == NULL to get the required size for the ptr buffer.
4081  *
4082  * To allocate the buffer and fill in the AVPicture fields in one call,
4083  * use avpicture_alloc().
4084  *
4085  * @param picture AVPicture whose fields are to be filled in
4086  * @param ptr Buffer which will contain or contains the actual image data
4087  * @param pix_fmt The format in which the picture data is stored.
4088  * @param width the width of the image in pixels
4089  * @param height the height of the image in pixels
4090  * @return size of the image data in bytes
4091  */
4092 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4093                    enum PixelFormat pix_fmt, int width, int height);
4094
4095 /**
4096  * Copy pixel data from an AVPicture into a buffer.
4097  * The data is stored compactly, without any gaps for alignment or padding
4098  * which may be applied by avpicture_fill().
4099  *
4100  * @see avpicture_get_size()
4101  *
4102  * @param[in] src AVPicture containing image data
4103  * @param[in] pix_fmt The format in which the picture data is stored.
4104  * @param[in] width the width of the image in pixels.
4105  * @param[in] height the height of the image in pixels.
4106  * @param[out] dest A buffer into which picture data will be copied.
4107  * @param[in] dest_size The size of 'dest'.
4108  * @return The number of bytes written to dest, or a negative value (error code) on error.
4109  */
4110 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4111                      unsigned char *dest, int dest_size);
4112
4113 /**
4114  * Calculate the size in bytes that a picture of the given width and height
4115  * would occupy if stored in the given picture format.
4116  * Note that this returns the size of a compact representation as generated
4117  * by avpicture_layout(), which can be smaller than the size required for e.g.
4118  * avpicture_fill().
4119  *
4120  * @param pix_fmt the given picture format
4121  * @param width the width of the image
4122  * @param height the height of the image
4123  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4124  */
4125 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4126
4127 /**
4128  *  deinterlace - if not supported return -1
4129  */
4130 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4131                           enum PixelFormat pix_fmt, int width, int height);
4132 /**
4133  * Copy image src to dst. Wraps av_picture_data_copy() above.
4134  */
4135 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4136                      enum PixelFormat pix_fmt, int width, int height);
4137
4138 /**
4139  * Crop image top and left side.
4140  */
4141 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4142                     enum PixelFormat pix_fmt, int top_band, int left_band);
4143
4144 /**
4145  * Pad image.
4146  */
4147 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4148             int padtop, int padbottom, int padleft, int padright, int *color);
4149
4150 /**
4151  * @}
4152  */
4153
4154 /**
4155  * @defgroup lavc_misc Utility functions
4156  * @ingroup libavc
4157  *
4158  * Miscellaneous utility functions related to both encoding and decoding
4159  * (or neither).
4160  * @{
4161  */
4162
4163 /**
4164  * @defgroup lavc_misc_pixfmt Pixel formats
4165  *
4166  * Functions for working with pixel formats.
4167  * @{
4168  */
4169
4170 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4171
4172 /**
4173  * Return a value representing the fourCC code associated to the
4174  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4175  * found.
4176  */
4177 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4178
4179 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
4180 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
4181 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
4182 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
4183 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
4184 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4185
4186 /**
4187  * Compute what kind of losses will occur when converting from one specific
4188  * pixel format to another.
4189  * When converting from one pixel format to another, information loss may occur.
4190  * For example, when converting from RGB24 to GRAY, the color information will
4191  * be lost. Similarly, other losses occur when converting from some formats to
4192  * other formats. These losses can involve loss of chroma, but also loss of
4193  * resolution, loss of color depth, loss due to the color space conversion, loss
4194  * of the alpha bits or loss due to color quantization.
4195  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4196  * which will occur when converting from one pixel format to another.
4197  *
4198  * @param[in] dst_pix_fmt destination pixel format
4199  * @param[in] src_pix_fmt source pixel format
4200  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4201  * @return Combination of flags informing you what kind of losses will occur.
4202  */
4203 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4204                              int has_alpha);
4205
4206 #if FF_API_FIND_BEST_PIX_FMT
4207 /**
4208  * @deprecated use avcodec_find_best_pix_fmt2() instead.
4209  *
4210  * Find the best pixel format to convert to given a certain source pixel
4211  * format.  When converting from one pixel format to another, information loss
4212  * may occur.  For example, when converting from RGB24 to GRAY, the color
4213  * information will be lost. Similarly, other losses occur when converting from
4214  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4215  * the given pixel formats should be used to suffer the least amount of loss.
4216  * The pixel formats from which it chooses one, are determined by the
4217  * pix_fmt_mask parameter.
4218  *
4219  * @code
4220  * src_pix_fmt = PIX_FMT_YUV420P;
4221  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4222  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4223  * @endcode
4224  *
4225  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4226  * @param[in] src_pix_fmt source pixel format
4227  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4228  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4229  * @return The best pixel format to convert to or -1 if none was found.
4230  */
4231 attribute_deprecated
4232 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4233                               int has_alpha, int *loss_ptr);
4234 #endif /* FF_API_FIND_BEST_PIX_FMT */
4235
4236 /**
4237  * Find the best pixel format to convert to given a certain source pixel
4238  * format.  When converting from one pixel format to another, information loss
4239  * may occur.  For example, when converting from RGB24 to GRAY, the color
4240  * information will be lost. Similarly, other losses occur when converting from
4241  * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4242  * the given pixel formats should be used to suffer the least amount of loss.
4243  * The pixel formats from which it chooses one, are determined by the
4244  * pix_fmt_list parameter.
4245  *
4246  *
4247  * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4248  * @param[in] src_pix_fmt source pixel format
4249  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4250  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4251  * @return The best pixel format to convert to or -1 if none was found.
4252  */
4253 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4254                                             enum PixelFormat src_pix_fmt,
4255                                             int has_alpha, int *loss_ptr);
4256
4257 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4258
4259 /**
4260  * @}
4261  */
4262
4263 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4264
4265 /**
4266  * Put a string representing the codec tag codec_tag in buf.
4267  *
4268  * @param buf_size size in bytes of buf
4269  * @return the length of the string that would have been generated if
4270  * enough space had been available, excluding the trailing null
4271  */
4272 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4273
4274 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4275
4276 /**
4277  * Return a name for the specified profile, if available.
4278  *
4279  * @param codec the codec that is searched for the given profile
4280  * @param profile the profile value for which a name is requested
4281  * @return A name for the profile if found, NULL otherwise.
4282  */
4283 const char *av_get_profile_name(const AVCodec *codec, int profile);
4284
4285 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4286 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4287 //FIXME func typedef
4288
4289 /**
4290  * Fill audio frame data and linesize.
4291  * AVFrame extended_data channel pointers are allocated if necessary for
4292  * planar audio.
4293  *
4294  * @param frame       the AVFrame
4295  *                    frame->nb_samples must be set prior to calling the
4296  *                    function. This function fills in frame->data,
4297  *                    frame->extended_data, frame->linesize[0].
4298  * @param nb_channels channel count
4299  * @param sample_fmt  sample format
4300  * @param buf         buffer to use for frame data
4301  * @param buf_size    size of buffer
4302  * @param align       plane size sample alignment (0 = default)
4303  * @return            0 on success, negative error code on failure
4304  */
4305 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4306                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4307                              int buf_size, int align);
4308
4309 /**
4310  * Flush buffers, should be called when seeking or when switching to a different stream.
4311  */
4312 void avcodec_flush_buffers(AVCodecContext *avctx);
4313
4314 void avcodec_default_free_buffers(AVCodecContext *s);
4315
4316 /**
4317  * Return codec bits per sample.
4318  *
4319  * @param[in] codec_id the codec
4320  * @return Number of bits per sample or zero if unknown for the given codec.
4321  */
4322 int av_get_bits_per_sample(enum CodecID codec_id);
4323
4324 /**
4325  * Return codec bits per sample.
4326  * Only return non-zero if the bits per sample is exactly correct, not an
4327  * approximation.
4328  *
4329  * @param[in] codec_id the codec
4330  * @return Number of bits per sample or zero if unknown for the given codec.
4331  */
4332 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4333
4334 /**
4335  * Return audio frame duration.
4336  *
4337  * @param avctx        codec context
4338  * @param frame_bytes  size of the frame, or 0 if unknown
4339  * @return             frame duration, in samples, if known. 0 if not able to
4340  *                     determine.
4341  */
4342 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4343
4344
4345 typedef struct AVBitStreamFilterContext {
4346     void *priv_data;
4347     struct AVBitStreamFilter *filter;
4348     AVCodecParserContext *parser;
4349     struct AVBitStreamFilterContext *next;
4350 } AVBitStreamFilterContext;
4351
4352
4353 typedef struct AVBitStreamFilter {
4354     const char *name;
4355     int priv_data_size;
4356     int (*filter)(AVBitStreamFilterContext *bsfc,
4357                   AVCodecContext *avctx, const char *args,
4358                   uint8_t **poutbuf, int *poutbuf_size,
4359                   const uint8_t *buf, int buf_size, int keyframe);
4360     void (*close)(AVBitStreamFilterContext *bsfc);
4361     struct AVBitStreamFilter *next;
4362 } AVBitStreamFilter;
4363
4364 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4365 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4366 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4367                                AVCodecContext *avctx, const char *args,
4368                                uint8_t **poutbuf, int *poutbuf_size,
4369                                const uint8_t *buf, int buf_size, int keyframe);
4370 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4371
4372 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4373
4374 /* memory */
4375
4376 /**
4377  * Reallocate the given block if it is not large enough, otherwise do nothing.
4378  *
4379  * @see av_realloc
4380  */
4381 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4382
4383 /**
4384  * Allocate a buffer, reusing the given one if large enough.
4385  *
4386  * Contrary to av_fast_realloc the current buffer contents might not be
4387  * preserved and on error the old buffer is freed, thus no special
4388  * handling to avoid memleaks is necessary.
4389  *
4390  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4391  * @param size size of the buffer *ptr points to
4392  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4393  *                 *size 0 if an error occurred.
4394  */
4395 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4396
4397 /**
4398  * Allocate a buffer with padding, reusing the given one if large enough.
4399  *
4400  * Same behaviour av_fast_malloc but the buffer has additional
4401  * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4402  *
4403  */
4404 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4405
4406 /**
4407  * Encode extradata length to a buffer. Used by xiph codecs.
4408  *
4409  * @param s buffer to write to; must be at least (v/255+1) bytes long
4410  * @param v size of extradata in bytes
4411  * @return number of bytes written to the buffer.
4412  */
4413 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4414
4415 /**
4416  * Log a generic warning message about a missing feature. This function is
4417  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4418  * only, and would normally not be used by applications.
4419  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4420  * a pointer to an AVClass struct
4421  * @param[in] feature string containing the name of the missing feature
4422  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4423  * If want_sample is non-zero, additional verbage will be added to the log
4424  * message which tells the user how to report samples to the development
4425  * mailing list.
4426  */
4427 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4428
4429 /**
4430  * Log a generic warning message asking for a sample. This function is
4431  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4432  * only, and would normally not be used by applications.
4433  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4434  * a pointer to an AVClass struct
4435  * @param[in] msg string containing an optional message, or NULL if no message
4436  */
4437 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4438
4439 /**
4440  * Register the hardware accelerator hwaccel.
4441  */
4442 void av_register_hwaccel(AVHWAccel *hwaccel);
4443
4444 /**
4445  * If hwaccel is NULL, returns the first registered hardware accelerator,
4446  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4447  * after hwaccel, or NULL if hwaccel is the last one.
4448  */
4449 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4450
4451
4452 /**
4453  * Lock operation used by lockmgr
4454  */
4455 enum AVLockOp {
4456   AV_LOCK_CREATE,  ///< Create a mutex
4457   AV_LOCK_OBTAIN,  ///< Lock the mutex
4458   AV_LOCK_RELEASE, ///< Unlock the mutex
4459   AV_LOCK_DESTROY, ///< Free mutex resources
4460 };
4461
4462 /**
4463  * Register a user provided lock manager supporting the operations
4464  * specified by AVLockOp. mutex points to a (void *) where the
4465  * lockmgr should store/get a pointer to a user allocated mutex. It's
4466  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4467  *
4468  * @param cb User defined callback. Note: Libav may invoke calls to this
4469  *           callback during the call to av_lockmgr_register().
4470  *           Thus, the application must be prepared to handle that.
4471  *           If cb is set to NULL the lockmgr will be unregistered.