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