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