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