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