Statistics
| Branch: | Revision:

ffmpeg / doc / ffmpeg-doc.texi @ 3a74415d

History | View | Annotate | Download (56.8 KB)

1 9181577c Fabrice Bellard
\input texinfo @c -*- texinfo -*-
2
3
@settitle FFmpeg Documentation
4
@titlepage
5
@sp 7
6
@center @titlefont{FFmpeg Documentation}
7
@sp 3
8
@end titlepage
9
10
11
@chapter Introduction
12
13
FFmpeg is a very fast video and audio converter. It can also grab from
14
a live audio/video source.
15 115329f1 Diego Biurrun
16 9181577c Fabrice Bellard
The command line interface is designed to be intuitive, in the sense
17 4c5f7207 Diego Biurrun
that FFmpeg tries to figure out all parameters that can possibly be
18
derived automatically. You usually only have to specify the target
19
bitrate you want.
20 9181577c Fabrice Bellard
21
FFmpeg can also convert from any sample rate to any other, and resize
22
video on the fly with a high quality polyphase filter.
23
24
@chapter Quick Start
25
26 e99c4e10 Fabrice Bellard
@c man begin EXAMPLES
27 9181577c Fabrice Bellard
@section Video and Audio grabbing
28
29 cc58300e Ramiro Polla
FFmpeg can grab video and audio from devices given that you specify the input
30
format and device.
31 e99c4e10 Fabrice Bellard
32 9181577c Fabrice Bellard
@example
33 cc58300e Ramiro Polla
ffmpeg -f audio_device -i /dev/dsp -f video4linux2 -i /dev/video0 /tmp/out.mpg
34 9181577c Fabrice Bellard
@end example
35
36 e99c4e10 Fabrice Bellard
Note that you must activate the right video source and channel before
37 4c5f7207 Diego Biurrun
launching FFmpeg with any TV viewer such as xawtv
38
(@url{http://bytesex.org/xawtv/}) by Gerd Knorr. You also
39
have to set the audio recording levels correctly with a
40 e99c4e10 Fabrice Bellard
standard mixer.
41 9181577c Fabrice Bellard
42 76d2efda Baptiste Coudurier
@section X11 grabbing
43
44 913e4081 Diego Biurrun
FFmpeg can grab the X11 display.
45 76d2efda Baptiste Coudurier
46
@example
47 cc58300e Ramiro Polla
ffmpeg -f x11grab -i :0.0 /tmp/out.mpg
48 76d2efda Baptiste Coudurier
@end example
49
50 913e4081 Diego Biurrun
0.0 is display.screen number of your X11 server, same as
51
the DISPLAY environment variable.
52 76d2efda Baptiste Coudurier
53 0cd4faf9 Panagiotis Issaris
@example
54 cc58300e Ramiro Polla
ffmpeg -f x11grab -i :0.0+10,20 /tmp/out.mpg
55 0cd4faf9 Panagiotis Issaris
@end example
56
57
0.0 is display.screen number of your X11 server, same as the DISPLAY environment
58
variable. 10 is the x-offset and 20 the y-offset for the grabbing.
59
60 6bf40f39 Philip Gladstone
@section Video and Audio file format conversion
61 9181577c Fabrice Bellard
62 4c5f7207 Diego Biurrun
* FFmpeg can use any supported file format and protocol as input:
63 9181577c Fabrice Bellard
64
Examples:
65
66 4c5f7207 Diego Biurrun
* You can use YUV files as input:
67 9181577c Fabrice Bellard
68
@example
69 115329f1 Diego Biurrun
ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
70 9181577c Fabrice Bellard
@end example
71
72 115329f1 Diego Biurrun
It will use the files:
73 9181577c Fabrice Bellard
@example
74 e99c4e10 Fabrice Bellard
/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
75
/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
76 9181577c Fabrice Bellard
@end example
77
78 e99c4e10 Fabrice Bellard
The Y files use twice the resolution of the U and V files. They are
79
raw files, without header. They can be generated by all decent video
80
decoders. You must specify the size of the image with the @option{-s} option
81 4c5f7207 Diego Biurrun
if FFmpeg cannot guess it.
82 9181577c Fabrice Bellard
83 4c5f7207 Diego Biurrun
* You can input from a raw YUV420P file:
84 9181577c Fabrice Bellard
85
@example
86 e99c4e10 Fabrice Bellard
ffmpeg -i /tmp/test.yuv /tmp/out.avi
87 9181577c Fabrice Bellard
@end example
88
89 4c5f7207 Diego Biurrun
test.yuv is a file containing raw YUV planar data. Each frame is composed
90
of the Y plane followed by the U and V planes at half vertical and
91 e99c4e10 Fabrice Bellard
horizontal resolution.
92 9181577c Fabrice Bellard
93 4c5f7207 Diego Biurrun
* You can output to a raw YUV420P file:
94 9181577c Fabrice Bellard
95
@example
96 f926cbe7 Michel Bardiaux
ffmpeg -i mydivx.avi hugefile.yuv
97 9181577c Fabrice Bellard
@end example
98
99
* You can set several input files and output files:
100
101
@example
102 e99c4e10 Fabrice Bellard
ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
103 9181577c Fabrice Bellard
@end example
104
105 4c5f7207 Diego Biurrun
Converts the audio file a.wav and the raw YUV video file a.yuv
106
to MPEG file a.mpg.
107 9181577c Fabrice Bellard
108 6bf40f39 Philip Gladstone
* You can also do audio and video conversions at the same time:
109 9181577c Fabrice Bellard
110
@example
111 e99c4e10 Fabrice Bellard
ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
112 9181577c Fabrice Bellard
@end example
113
114 4c5f7207 Diego Biurrun
Converts a.wav to MPEG audio at 22050Hz sample rate.
115 9181577c Fabrice Bellard
116
* You can encode to several formats at the same time and define a
117 e99c4e10 Fabrice Bellard
mapping from input stream to output streams:
118 9181577c Fabrice Bellard
119
@example
120 5438308f Panagiotis Issaris
ffmpeg -i /tmp/a.wav -ab 64k /tmp/a.mp2 -ab 128k /tmp/b.mp2 -map 0:0 -map 0:0
121 9181577c Fabrice Bellard
@end example
122
123 4c5f7207 Diego Biurrun
Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
124
file:index' specifies which input stream is used for each output
125 e99c4e10 Fabrice Bellard
stream, in the order of the definition of output streams.
126 9181577c Fabrice Bellard
127
* You can transcode decrypted VOBs
128
129
@example
130 5438308f Panagiotis Issaris
ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800k -g 300 -bf 2 -acodec mp3 -ab 128k snatch.avi
131 9181577c Fabrice Bellard
@end example
132
133 4c5f7207 Diego Biurrun
This is a typical DVD ripping example; the input is a VOB file, the
134
output an AVI file with MPEG-4 video and MP3 audio. Note that in this
135
command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
136
GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
137
input video. Furthermore, the audio stream is MP3-encoded so you need
138
to enable LAME support by passing @code{--enable-mp3lame} to configure.
139
The mapping is particularly useful for DVD transcoding
140 e99c4e10 Fabrice Bellard
to get the desired audio language.
141 9181577c Fabrice Bellard
142 4c5f7207 Diego Biurrun
NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
143 e99c4e10 Fabrice Bellard
@c man end
144 9181577c Fabrice Bellard
145
@chapter Invocation
146
147
@section Syntax
148
149 e99c4e10 Fabrice Bellard
The generic syntax is:
150 9181577c Fabrice Bellard
151 115329f1 Diego Biurrun
@example
152 e99c4e10 Fabrice Bellard
@c man begin SYNOPSIS
153 28f88dc8 Michael Niedermayer
ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
154 e99c4e10 Fabrice Bellard
@c man end
155 9181577c Fabrice Bellard
@end example
156 e99c4e10 Fabrice Bellard
@c man begin DESCRIPTION
157
As a general rule, options are applied to the next specified
158 699e77b1 Víctor Paesa
file. Therefore, order is important, and you can have the same
159 8cc62264 Diego Biurrun
option on the command line multiple times. Each occurrence is
160 699e77b1 Víctor Paesa
then applied to the next input or output file.
161
162 eb10acec Diego Biurrun
* To set the video bitrate of the output file to 64kbit/s:
163 699e77b1 Víctor Paesa
@example
164
ffmpeg -i input.avi -b 64k output.avi
165
@end example
166
167
* To force the frame rate of the input and output file to 24 fps:
168
@example
169
ffmpeg -r 24 -i input.avi output.avi
170
@end example
171
172
* To force the frame rate of the output file to 24 fps:
173
@example
174
ffmpeg -i input.avi -r 24 output.avi
175
@end example
176
177
* To force the frame rate of input file to 1 fps and the output file to 24 fps:
178
@example
179
ffmpeg -r 1 -i input.avi -r 24 output.avi
180
@end example
181
182
The format option may be needed for raw input files.
183 9181577c Fabrice Bellard
184 4c5f7207 Diego Biurrun
By default, FFmpeg tries to convert as losslessly as possible: It
185
uses the same audio and video parameters for the outputs as the one
186 e99c4e10 Fabrice Bellard
specified for the inputs.
187
@c man end
188 9181577c Fabrice Bellard
189 e99c4e10 Fabrice Bellard
@c man begin OPTIONS
190 9181577c Fabrice Bellard
@section Main options
191
192 e99c4e10 Fabrice Bellard
@table @option
193 9181577c Fabrice Bellard
@item -L
194 4c5f7207 Diego Biurrun
Show license.
195 18bff752 Fabrice Bellard
196 9181577c Fabrice Bellard
@item -h
197 4c5f7207 Diego Biurrun
Show help.
198 18bff752 Fabrice Bellard
199 4386f941 Diego Biurrun
@item -version
200
Show version.
201
202 e99c4e10 Fabrice Bellard
@item -formats
203 4c5f7207 Diego Biurrun
Show available formats, codecs, protocols, ...
204 18bff752 Fabrice Bellard
205 115329f1 Diego Biurrun
@item -f fmt
206 4c5f7207 Diego Biurrun
Force format.
207 18bff752 Fabrice Bellard
208 115329f1 Diego Biurrun
@item -i filename
209 4c5f7207 Diego Biurrun
input filename
210 9181577c Fabrice Bellard
211 115329f1 Diego Biurrun
@item -y
212 4c5f7207 Diego Biurrun
Overwrite output files.
213 9181577c Fabrice Bellard
214 115329f1 Diego Biurrun
@item -t duration
215 4c5f7207 Diego Biurrun
Set the recording time in seconds.
216
@code{hh:mm:ss[.xxx]} syntax is also supported.
217 9181577c Fabrice Bellard
218 4386f941 Diego Biurrun
@item -fs limit_size
219
Set the file size limit.
220
221 e83a84ac Benjamin Larsson
@item -ss position
222 4c5f7207 Diego Biurrun
Seek to given time position in seconds.
223
@code{hh:mm:ss[.xxx]} syntax is also supported.
224 e83a84ac Benjamin Larsson
225 4386f941 Diego Biurrun
@item -itsoffset offset
226
Set the input time offset in seconds.
227
@code{[-]hh:mm:ss[.xxx]} syntax is also supported.
228
This option affects all the input files that follow it.
229
The offset is added to the timestamps of the input files.
230
Specifying a positive offset means that the corresponding
231
streams are delayed by 'offset' seconds.
232
233 115329f1 Diego Biurrun
@item -title string
234 4c5f7207 Diego Biurrun
Set the title.
235 9181577c Fabrice Bellard
236 4386f941 Diego Biurrun
@item -timestamp time
237
Set the timestamp.
238
239 115329f1 Diego Biurrun
@item -author string
240 4c5f7207 Diego Biurrun
Set the author.
241 9181577c Fabrice Bellard
242 115329f1 Diego Biurrun
@item -copyright string
243 4c5f7207 Diego Biurrun
Set the copyright.
244 9181577c Fabrice Bellard
245 115329f1 Diego Biurrun
@item -comment string
246 4c5f7207 Diego Biurrun
Set the comment.
247 9181577c Fabrice Bellard
248 4386f941 Diego Biurrun
@item -album string
249
Set the album.
250
251 ec1b10f4 Panagiotis Issaris
@item -track number
252
Set the track.
253
254
@item -year number
255
Set the year.
256
257 4386f941 Diego Biurrun
@item -v verbose
258
Control amount of logging.
259
260 99db6420 Fabrice Bellard
@item -target type
261 4386f941 Diego Biurrun
Specify target file type ("vcd", "svcd", "dvd", "dv", "dv50", "pal-vcd",
262 4c5f7207 Diego Biurrun
"ntsc-svcd", ... ). All the format options (bitrate, codecs,
263
buffer sizes) are then set automatically. You can just type:
264 99db6420 Fabrice Bellard
265
@example
266
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
267
@end example
268
269 4c5f7207 Diego Biurrun
Nevertheless you can specify additional options as long as you know
270
they do not conflict with the standard, as in:
271 791d8d1d Michel Bardiaux
272
@example
273
ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
274
@end example
275
276 4386f941 Diego Biurrun
@item -dframes number
277
Set the number of data frames to record.
278
279
@item -scodec codec
280
Force subtitle codec ('copy' to copy stream).
281
282
@item -newsubtitle
283
Add a new subtitle stream to the current output stream.
284
285
@item -slang code
286
Set the ISO 639 language code (3 letters) of the current subtitle stream.
287 401fbdde Michael Niedermayer
288 9181577c Fabrice Bellard
@end table
289
290
@section Video Options
291
292 e99c4e10 Fabrice Bellard
@table @option
293 9181577c Fabrice Bellard
@item -b bitrate
294 3c0ba870 Panagiotis Issaris
Set the video bitrate in bit/s (default = 200 kb/s).
295 4386f941 Diego Biurrun
@item -vframes number
296
Set the number of video frames to record.
297 115329f1 Diego Biurrun
@item -r fps
298 4386f941 Diego Biurrun
Set frame rate (Hz value, fraction or abbreviation), (default = 25).
299 115329f1 Diego Biurrun
@item -s size
300 67053c30 Ivan Kalvachev
Set frame size. The format is @samp{wxh} (ffserver default = 160x128, ffmpeg default = same as source).
301 4c5f7207 Diego Biurrun
The following abbreviations are recognized:
302 5ee03c86 Fabrice Bellard
@table @samp
303 18bff752 Fabrice Bellard
@item sqcif
304
128x96
305
@item qcif
306
176x144
307
@item cif
308
352x288
309
@item 4cif
310
704x576
311
@end table
312
313
@item -aspect aspect
314 4c5f7207 Diego Biurrun
Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
315 18bff752 Fabrice Bellard
@item -croptop size
316 4c5f7207 Diego Biurrun
Set top crop band size (in pixels).
317 18bff752 Fabrice Bellard
@item -cropbottom size
318 4c5f7207 Diego Biurrun
Set bottom crop band size (in pixels).
319 18bff752 Fabrice Bellard
@item -cropleft size
320 4c5f7207 Diego Biurrun
Set left crop band size (in pixels).
321 18bff752 Fabrice Bellard
@item -cropright size
322 4c5f7207 Diego Biurrun
Set right crop band size (in pixels).
323 1ff93ffc Todd Kirby
@item -padtop size
324 4c5f7207 Diego Biurrun
Set top pad band size (in pixels).
325 1ff93ffc Todd Kirby
@item -padbottom size
326 4c5f7207 Diego Biurrun
Set bottom pad band size (in pixels).
327 1ff93ffc Todd Kirby
@item -padleft size
328 4c5f7207 Diego Biurrun
Set left pad band size (in pixels).
329 1ff93ffc Todd Kirby
@item -padright size
330 4c5f7207 Diego Biurrun
Set right pad band size (in pixels).
331 5b79a73e Todd Kirby
@item -padcolor (hex color)
332 4c5f7207 Diego Biurrun
Set color of padded bands. The value for padcolor is expressed
333
as a six digit hexadecimal number where the first two digits
334
represent red, the middle two digits green and last two digits
335
blue (default = 000000 (black)).
336 9181577c Fabrice Bellard
@item -vn
337 4c5f7207 Diego Biurrun
Disable video recording.
338 115329f1 Diego Biurrun
@item -bt tolerance
339 dc5ee8bc Panagiotis Issaris
Set video bitrate tolerance (in bit/s).
340 18bff752 Fabrice Bellard
@item -maxrate bitrate
341 a5515106 Panagiotis Issaris
Set max video bitrate tolerance (in bit/s).
342 18bff752 Fabrice Bellard
@item -minrate bitrate
343 a5515106 Panagiotis Issaris
Set min video bitrate tolerance (in bit/s).
344 18bff752 Fabrice Bellard
@item -bufsize size
345 81d0618f Panagiotis Issaris
Set rate control buffer size (in bits).
346 115329f1 Diego Biurrun
@item -vcodec codec
347 4c5f7207 Diego Biurrun
Force video codec to @var{codec}. Use the @code{copy} special value to
348 5ee03c86 Fabrice Bellard
tell that the raw codec data must be copied as is.
349 18bff752 Fabrice Bellard
@item -sameq
350 4c5f7207 Diego Biurrun
Use same video quality as source (implies VBR).
351 9181577c Fabrice Bellard
352 115329f1 Diego Biurrun
@item -pass n
353 4c5f7207 Diego Biurrun
Select the pass number (1 or 2). It is useful to do two pass
354
encoding. The statistics of the video are recorded in the first
355
pass and the video is generated at the exact requested bitrate
356
in the second pass.
357 9181577c Fabrice Bellard
358 115329f1 Diego Biurrun
@item -passlogfile file
359 4c5f7207 Diego Biurrun
Set two pass logfile name to @var{file}.
360 9181577c Fabrice Bellard
361 4386f941 Diego Biurrun
@item -newvideo
362
Add a new video stream to the current output stream.
363
364 9181577c Fabrice Bellard
@end table
365
366 18bff752 Fabrice Bellard
@section Advanced Video Options
367 9181577c Fabrice Bellard
368 e99c4e10 Fabrice Bellard
@table @option
369 4386f941 Diego Biurrun
@item -pix_fmt format
370
Set pixel format.
371 115329f1 Diego Biurrun
@item -g gop_size
372 4c5f7207 Diego Biurrun
Set the group of pictures size.
373 115329f1 Diego Biurrun
@item -intra
374 4c5f7207 Diego Biurrun
Use only intra frames.
375 4386f941 Diego Biurrun
@item -vdt n
376
Discard threshold.
377 115329f1 Diego Biurrun
@item -qscale q
378 4bef236b Diego Biurrun
Use fixed video quantizer scale (VBR).
379 115329f1 Diego Biurrun
@item -qmin q
380 4bef236b Diego Biurrun
minimum video quantizer scale (VBR)
381 115329f1 Diego Biurrun
@item -qmax q
382 4bef236b Diego Biurrun
maximum video quantizer scale (VBR)
383 115329f1 Diego Biurrun
@item -qdiff q
384 4bef236b Diego Biurrun
maximum difference between the quantizer scales (VBR)
385 115329f1 Diego Biurrun
@item -qblur blur
386 4bef236b Diego Biurrun
video quantizer scale blur (VBR)
387 115329f1 Diego Biurrun
@item -qcomp compression
388 4bef236b Diego Biurrun
video quantizer scale compression (VBR)
389 18bff752 Fabrice Bellard
390 9ae711e1 Víctor Paesa
@item -lmin lambda
391
minimum video lagrange factor (VBR)
392
@item -lmax lambda
393
max video lagrange factor (VBR)
394
@item -mblmin lambda
395
minimum macroblock quantizer scale (VBR)
396
@item -mblmax lambda
397
maximum macroblock quantizer scale (VBR)
398
399
These four options (lmin, lmax, mblmin, mblmax) use 'lambda' units,
400
but you may use the QP2LAMBDA constant to easily convert from 'q' units:
401
@example
402
ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
403
@end example
404
405 18bff752 Fabrice Bellard
@item -rc_init_cplx complexity
406 4c5f7207 Diego Biurrun
initial complexity for single pass encoding
407 18bff752 Fabrice Bellard
@item -b_qfactor factor
408 4c5f7207 Diego Biurrun
qp factor between P- and B-frames
409 18bff752 Fabrice Bellard
@item -i_qfactor factor
410 4c5f7207 Diego Biurrun
qp factor between P- and I-frames
411 18bff752 Fabrice Bellard
@item -b_qoffset offset
412 4c5f7207 Diego Biurrun
qp offset between P- and B-frames
413 18bff752 Fabrice Bellard
@item -i_qoffset offset
414 4c5f7207 Diego Biurrun
qp offset between P- and I-frames
415 18bff752 Fabrice Bellard
@item -rc_eq equation
416 4c5f7207 Diego Biurrun
Set rate control equation (@pxref{FFmpeg formula
417
evaluator}) (default = @code{tex^qComp}).
418 5ee03c86 Fabrice Bellard
@item -rc_override override
419
rate control override for specific intervals
420 18bff752 Fabrice Bellard
@item -me method
421 4c5f7207 Diego Biurrun
Set motion estimation method to @var{method}.
422
Available methods are (from lowest to best quality):
423 18bff752 Fabrice Bellard
@table @samp
424
@item zero
425 5ee03c86 Fabrice Bellard
Try just the (0, 0) vector.
426 18bff752 Fabrice Bellard
@item phods
427
@item log
428
@item x1
429
@item epzs
430
(default method)
431
@item full
432
exhaustive search (slow and marginally better than epzs)
433
@end table
434
435
@item -dct_algo algo
436 4c5f7207 Diego Biurrun
Set DCT algorithm to @var{algo}. Available values are:
437 18bff752 Fabrice Bellard
@table @samp
438
@item 0
439
FF_DCT_AUTO (default)
440
@item 1
441
FF_DCT_FASTINT
442
@item 2
443
FF_DCT_INT
444
@item 3
445
FF_DCT_MMX
446
@item 4
447
FF_DCT_MLIB
448
@item 5
449
FF_DCT_ALTIVEC
450
@end table
451
452
@item -idct_algo algo
453 4c5f7207 Diego Biurrun
Set IDCT algorithm to @var{algo}. Available values are:
454 18bff752 Fabrice Bellard
@table @samp
455
@item 0
456
FF_IDCT_AUTO (default)
457
@item 1
458 115329f1 Diego Biurrun
FF_IDCT_INT
459 18bff752 Fabrice Bellard
@item 2
460 115329f1 Diego Biurrun
FF_IDCT_SIMPLE
461 18bff752 Fabrice Bellard
@item 3
462 115329f1 Diego Biurrun
FF_IDCT_SIMPLEMMX
463 18bff752 Fabrice Bellard
@item 4
464 115329f1 Diego Biurrun
FF_IDCT_LIBMPEG2MMX
465 18bff752 Fabrice Bellard
@item 5
466 115329f1 Diego Biurrun
FF_IDCT_PS2
467 18bff752 Fabrice Bellard
@item 6
468 115329f1 Diego Biurrun
FF_IDCT_MLIB
469 18bff752 Fabrice Bellard
@item 7
470 115329f1 Diego Biurrun
FF_IDCT_ARM
471 18bff752 Fabrice Bellard
@item 8
472 115329f1 Diego Biurrun
FF_IDCT_ALTIVEC
473 18bff752 Fabrice Bellard
@item 9
474 115329f1 Diego Biurrun
FF_IDCT_SH4
475 18bff752 Fabrice Bellard
@item 10
476 115329f1 Diego Biurrun
FF_IDCT_SIMPLEARM
477 18bff752 Fabrice Bellard
@end table
478
479
@item -er n
480 4c5f7207 Diego Biurrun
Set error resilience to @var{n}.
481 18bff752 Fabrice Bellard
@table @samp
482 115329f1 Diego Biurrun
@item 1
483 1471c6c2 Diego Biurrun
FF_ER_CAREFUL (default)
484 18bff752 Fabrice Bellard
@item 2
485 5ee03c86 Fabrice Bellard
FF_ER_COMPLIANT
486 18bff752 Fabrice Bellard
@item 3
487
FF_ER_AGGRESSIVE
488
@item 4
489
FF_ER_VERY_AGGRESSIVE
490
@end table
491
492 5ee03c86 Fabrice Bellard
@item -ec bit_mask
493 4c5f7207 Diego Biurrun
Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
494 5ee03c86 Fabrice Bellard
the following values:
495 18bff752 Fabrice Bellard
@table @samp
496
@item 1
497 4c5f7207 Diego Biurrun
FF_EC_GUESS_MVS (default = enabled)
498 18bff752 Fabrice Bellard
@item 2
499 4c5f7207 Diego Biurrun
FF_EC_DEBLOCK (default = enabled)
500 18bff752 Fabrice Bellard
@end table
501
502
@item -bf frames
503 4c5f7207 Diego Biurrun
Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
504 18bff752 Fabrice Bellard
@item -mbd mode
505
macroblock decision
506
@table @samp
507
@item 0
508 4c5f7207 Diego Biurrun
FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
509 18bff752 Fabrice Bellard
@item 1
510 4c5f7207 Diego Biurrun
FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
511 18bff752 Fabrice Bellard
@item 2
512 019c8838 Diego Biurrun
FF_MB_DECISION_RD: rate distortion
513 18bff752 Fabrice Bellard
@end table
514
515
@item -4mv
516 4c5f7207 Diego Biurrun
Use four motion vector by macroblock (MPEG-4 only).
517 18bff752 Fabrice Bellard
@item -part
518 4c5f7207 Diego Biurrun
Use data partitioning (MPEG-4 only).
519 18bff752 Fabrice Bellard
@item -bug param
520 4c5f7207 Diego Biurrun
Work around encoder bugs that are not auto-detected.
521 18bff752 Fabrice Bellard
@item -strict strictness
522 4c5f7207 Diego Biurrun
How strictly to follow the standards.
523 5ee03c86 Fabrice Bellard
@item -aic
524 4c5f7207 Diego Biurrun
Enable Advanced intra coding (h263+).
525 5ee03c86 Fabrice Bellard
@item -umv
526 4c5f7207 Diego Biurrun
Enable Unlimited Motion Vector (h263+)
527 18bff752 Fabrice Bellard
528
@item -deinterlace
529 4c5f7207 Diego Biurrun
Deinterlace pictures.
530 3841e813 Benjamin Larsson
@item -ilme
531 4c5f7207 Diego Biurrun
Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
532
Use this option if your input file is interlaced and you want
533
to keep the interlaced format for minimum losses.
534
The alternative is to deinterlace the input stream with
535
@option{-deinterlace}, but deinterlacing introduces losses.
536 18bff752 Fabrice Bellard
@item -psnr
537 4c5f7207 Diego Biurrun
Calculate PSNR of compressed frames.
538 18bff752 Fabrice Bellard
@item -vstats
539 4c5f7207 Diego Biurrun
Dump video coding statistics to @file{vstats_HHMMSS.log}.
540 18bff752 Fabrice Bellard
@item -vhook module
541 4c5f7207 Diego Biurrun
Insert video processing @var{module}. @var{module} contains the module
542 18bff752 Fabrice Bellard
name and its parameters separated by spaces.
543 4386f941 Diego Biurrun
@item -top n
544
top=1/bottom=0/auto=-1 field first
545
@item -dc precision
546
Intra_dc_precision.
547
@item -vtag fourcc/tag
548
Force video tag/fourcc.
549
@item -qphist
550
Show QP histogram.
551
@item -vbsf bitstream filter
552
Bitstream filters available are "dump_extra", "remove_extra", "noise".
553 18bff752 Fabrice Bellard
@end table
554
555
@section Audio Options
556
557
@table @option
558 4386f941 Diego Biurrun
@item -aframes number
559
Set the number of audio frames to record.
560 115329f1 Diego Biurrun
@item -ar freq
561 4c5f7207 Diego Biurrun
Set the audio sampling frequency (default = 44100 Hz).
562 115329f1 Diego Biurrun
@item -ab bitrate
563 5438308f Panagiotis Issaris
Set the audio bitrate in bit/s (default = 64k).
564 18bff752 Fabrice Bellard
@item -ac channels
565 4c5f7207 Diego Biurrun
Set the number of audio channels (default = 1).
566 5ee03c86 Fabrice Bellard
@item -an
567 4c5f7207 Diego Biurrun
Disable audio recording.
568 5ee03c86 Fabrice Bellard
@item -acodec codec
569 4c5f7207 Diego Biurrun
Force audio codec to @var{codec}. Use the @code{copy} special value to
570
specify that the raw codec data must be copied as is.
571 de62a89d Víctor Paesa
@item -newaudio
572 18fd519f Diego Biurrun
Add a new audio track to the output file. If you want to specify parameters,
573
do so before @code{-newaudio} (@code{-acodec}, @code{-ab}, etc..).
574 de62a89d Víctor Paesa
575 18fd519f Diego Biurrun
Mapping will be done automatically, if the number of output streams is equal to
576
the number of input streams, else it will pick the first one that matches. You
577 de62a89d Víctor Paesa
can override the mapping using @code{-map} as usual.
578
579
Example:
580
@example
581 5438308f Panagiotis Issaris
ffmpeg -i file.mpg -vcodec copy -acodec ac3 -ab 384k test.mpg -acodec mp2 -ab 192k -newaudio
582 de62a89d Víctor Paesa
@end example
583 4386f941 Diego Biurrun
@item -alang code
584
Set the ISO 639 language code (3 letters) of the current audio stream.
585
@end table
586
587
@section Advanced Audio options:
588
589
@table @option
590
@item -atag fourcc/tag
591
Force audio tag/fourcc.
592
@item -absf bitstream filter
593
Bitstream filters available are "dump_extra", "remove_extra", "noise", "mp3comp", "mp3decomp".
594
@end table
595
596
@section Subtitle options:
597
598
@table @option
599
@item -scodec codec
600
Force subtitle codec ('copy' to copy stream).
601
@item -newsubtitle
602
Add a new subtitle stream to the current output stream.
603
@item -slang code
604
Set the ISO 639 language code (3 letters) of the current subtitle stream.
605 18bff752 Fabrice Bellard
@end table
606
607
@section Audio/Video grab options
608
609
@table @option
610
@item -vc channel
611 4c5f7207 Diego Biurrun
Set video grab channel (DV1394 only).
612 18bff752 Fabrice Bellard
@item -tvstd standard
613 4c5f7207 Diego Biurrun
Set television standard (NTSC, PAL (SECAM)).
614 cc58300e Ramiro Polla
@item -isync
615
Synchronize read on input.
616 18bff752 Fabrice Bellard
@end table
617
618
@section Advanced options
619
620
@table @option
621 e645a733 Benjamin Larsson
@item -map input stream id[:input stream id]
622
Set stream mapping from input streams to output streams.
623
Just enumerate the input streams in the order you want them in the output.
624
[input stream id] sets the (input) stream to sync against.
625 4386f941 Diego Biurrun
@item -map_meta_data outfile:infile
626
Set meta data information of outfile from infile.
627 18bff752 Fabrice Bellard
@item -debug
628 4c5f7207 Diego Biurrun
Print specific debug info.
629 115329f1 Diego Biurrun
@item -benchmark
630 4c5f7207 Diego Biurrun
Add timings for benchmarking.
631 4386f941 Diego Biurrun
@item -dump
632 4c5f7207 Diego Biurrun
Dump each input packet.
633 4386f941 Diego Biurrun
@item -hex
634
When dumping packets, also dump the payload.
635 18bff752 Fabrice Bellard
@item -bitexact
636 4c5f7207 Diego Biurrun
Only use bit exact algorithms (for codec testing).
637 18bff752 Fabrice Bellard
@item -ps size
638 4c5f7207 Diego Biurrun
Set packet size in bits.
639 5ee03c86 Fabrice Bellard
@item -re
640 4c5f7207 Diego Biurrun
Read input at native frame rate. Mainly used to simulate a grab device.
641 4386f941 Diego Biurrun
@item -loop_input
642 4c5f7207 Diego Biurrun
Loop over the input stream. Currently it works only for image
643
streams. This option is used for automatic FFserver testing.
644 8108551a Todd Kirby
@item -loop_output number_of_times
645 019c8838 Diego Biurrun
Repeatedly loop output for formats that support looping such as animated GIF
646 4c5f7207 Diego Biurrun
(0 will loop the output infinitely).
647 4386f941 Diego Biurrun
@item -threads count
648
Thread count.
649 c52e13f1 Benjamin Larsson
@item -vsync parameter
650 29c9183c Diego Biurrun
Video sync method. Video will be stretched/squeezed to match the timestamps,
651
it is done by duplicating and dropping frames. With -map you can select from
652
which stream the timestamps should be taken. You can leave either video or
653 c52e13f1 Benjamin Larsson
audio unchanged and sync the remaining stream(s) to the unchanged one.
654
@item -async samples_per_second
655 29c9183c Diego Biurrun
Audio sync method. "Stretches/squeezes" the audio stream to match the timestamps,
656 c52e13f1 Benjamin Larsson
the parameter is the maximum samples per second by which the audio is changed.
657
-async 1 is a special case where only the start of the audio stream is corrected
658
without any later correction.
659 9181577c Fabrice Bellard
@end table
660 18bff752 Fabrice Bellard
661
@node FFmpeg formula evaluator
662
@section FFmpeg formula evaluator
663
664
When evaluating a rate control string, FFmpeg uses an internal formula
665 115329f1 Diego Biurrun
evaluator.
666 18bff752 Fabrice Bellard
667
The following binary operators are available: @code{+}, @code{-},
668
@code{*}, @code{/}, @code{^}.
669
670
The following unary operators are available: @code{+}, @code{-},
671
@code{(...)}.
672
673
The following functions are available:
674
@table @var
675
@item sinh(x)
676
@item cosh(x)
677
@item tanh(x)
678
@item sin(x)
679
@item cos(x)
680
@item tan(x)
681
@item exp(x)
682
@item log(x)
683
@item squish(x)
684
@item gauss(x)
685
@item abs(x)
686
@item max(x, y)
687
@item min(x, y)
688
@item gt(x, y)
689
@item lt(x, y)
690
@item eq(x, y)
691
@item bits2qp(bits)
692
@item qp2bits(qp)
693
@end table
694
695
The following constants are available:
696
@table @var
697
@item PI
698
@item E
699
@item iTex
700
@item pTex
701
@item tex
702
@item mv
703
@item fCode
704
@item iCount
705
@item mcVar
706
@item var
707
@item isI
708
@item isP
709
@item isB
710
@item avgQP
711
@item qComp
712
@item avgIITex
713
@item avgPITex
714
@item avgPPTex
715
@item avgBPTex
716
@item avgTex
717
@end table
718
719 e99c4e10 Fabrice Bellard
@c man end
720
721
@ignore
722
723
@setfilename ffmpeg
724
@settitle FFmpeg video converter
725
726
@c man begin SEEALSO
727 019c8838 Diego Biurrun
ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
728 e99c4e10 Fabrice Bellard
@c man end
729
730
@c man begin AUTHOR
731
Fabrice Bellard
732
@c man end
733
734
@end ignore
735 9181577c Fabrice Bellard
736
@section Protocols
737
738 4c5f7207 Diego Biurrun
The filename can be @file{-} to read from standard input or to write
739
to standard output.
740 9181577c Fabrice Bellard
741 4c5f7207 Diego Biurrun
FFmpeg also handles many protocols specified with an URL syntax.
742 9181577c Fabrice Bellard
743 4c5f7207 Diego Biurrun
Use 'ffmpeg -formats' to see a list of the supported protocols.
744 9181577c Fabrice Bellard
745 e99c4e10 Fabrice Bellard
The protocol @code{http:} is currently used only to communicate with
746 4c5f7207 Diego Biurrun
FFserver (see the FFserver documentation). When FFmpeg will be a
747 e99c4e10 Fabrice Bellard
video player it will also be used for streaming :-)
748 9181577c Fabrice Bellard
749
@chapter Tips
750
751
@itemize
752 4c5f7207 Diego Biurrun
@item For streaming at very low bitrate application, use a low frame rate
753
and a small GOP size. This is especially true for RealVideo where
754 e99c4e10 Fabrice Bellard
the Linux player does not seem to be very fast, so it can miss
755
frames. An example is:
756 9181577c Fabrice Bellard
757
@example
758 3c0ba870 Panagiotis Issaris
ffmpeg -g 3 -r 3 -t 10 -b 50k -s qcif -f rv10 /tmp/b.rm
759 9181577c Fabrice Bellard
@end example
760
761
@item  The parameter 'q' which is displayed while encoding is the current
762 4c5f7207 Diego Biurrun
quantizer. The value 1 indicates that a very good quality could
763
be achieved. The value 31 indicates the worst quality. If q=31 appears
764 e99c4e10 Fabrice Bellard
too often, it means that the encoder cannot compress enough to meet
765 4c5f7207 Diego Biurrun
your bitrate. You must either increase the bitrate, decrease the
766 e99c4e10 Fabrice Bellard
frame rate or decrease the frame size.
767 9181577c Fabrice Bellard
768
@item If your computer is not fast enough, you can speed up the
769 e99c4e10 Fabrice Bellard
compression at the expense of the compression ratio. You can use
770
'-me zero' to speed up motion estimation, and '-intra' to disable
771 4c5f7207 Diego Biurrun
motion estimation completely (you have only I-frames, which means it
772 e99c4e10 Fabrice Bellard
is about as good as JPEG compression).
773 9181577c Fabrice Bellard
774 4c5f7207 Diego Biurrun
@item To have very low audio bitrates, reduce the sampling frequency
775 019c8838 Diego Biurrun
(down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
776 9181577c Fabrice Bellard
777
@item To have a constant quality (but a variable bitrate), use the option
778 e99c4e10 Fabrice Bellard
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
779
quality).
780 9181577c Fabrice Bellard
781
@item When converting video files, you can use the '-sameq' option which
782 4c5f7207 Diego Biurrun
uses the same quality factor in the encoder as in the decoder.
783
It allows almost lossless encoding.
784 9181577c Fabrice Bellard
785
@end itemize
786
787 47404f9f Diego Biurrun
788
@chapter external libraries
789
790
FFmpeg can be hooked up with a number of external libraries to add support
791 7bb93206 Diego Biurrun
for more formats. None of them are used by default, their use has to be
792
explicitly requested by passing the appropriate flags to @file{./configure}.
793 47404f9f Diego Biurrun
794
@section AMR
795
796
AMR comes in two different flavors, WB and NB. FFmpeg can make use of the
797
AMR WB (floating-point mode) and the AMR NB (both floating-point and
798
fixed-point mode) reference decoders and encoders.
799
800
@itemize
801
802 6056c939 Diego Biurrun
@item For AMR WB floating-point and AMR NB floating point support, go to
803
@url{http://www.penguin.cz/~utx/amr} and follow the instructions for building
804
the libraries.
805
806
@item For AMR NB fixed-point download TS26.073 REL-6 V6.0.0 from
807
@url{http://www.3gpp.org/ftp/Specs/archive/26_series/26.073/26073-600.zip}
808
and extract the source to the directory @file{libavcodec/amr}.
809 ef4e31d4 Diego Biurrun
You must also add @code{-DMMS_IO} to @code{CFLAGS} in
810 6056c939 Diego Biurrun
@file{libavcodec/amr/makefile}, i.e.
811
``@code{CFLAGS = -Wall -pedantic-errors -I. $(CFLAGS_$(MODE)) -D$(VAD) -DMMS_IO}''.
812 47404f9f Diego Biurrun
813
@end itemize
814
815
816 9181577c Fabrice Bellard
@chapter Supported File Formats and Codecs
817
818
You can use the @code{-formats} option to have an exhaustive list.
819
820
@section File Formats
821
822 6bf40f39 Philip Gladstone
FFmpeg supports the following file formats through the @code{libavformat}
823 0699d2fe Fabrice Bellard
library:
824 9181577c Fabrice Bellard
825 3fc9e78f Diego Biurrun
@multitable @columnfractions .4 .1 .1 .4
826 9181577c Fabrice Bellard
@item Supported File Format @tab Encoding @tab Decoding @tab Comments
827
@item MPEG audio @tab X @tab X
828 4c5f7207 Diego Biurrun
@item MPEG-1 systems @tab X  @tab  X
829 9181577c Fabrice Bellard
@tab muxed audio and video
830 4c5f7207 Diego Biurrun
@item MPEG-2 PS @tab X  @tab  X
831 9181577c Fabrice Bellard
@tab also known as @code{VOB} file
832 4c5f7207 Diego Biurrun
@item MPEG-2 TS @tab    @tab  X
833 9181577c Fabrice Bellard
@tab also known as DVB Transport Stream
834 115329f1 Diego Biurrun
@item ASF@tab X @tab X
835
@item AVI@tab X @tab X
836
@item WAV@tab X @tab X
837 9181577c Fabrice Bellard
@item Macromedia Flash@tab X @tab X
838 4c5f7207 Diego Biurrun
@tab Only embedded audio is decoded.
839 2eb5d024 Fabrice Bellard
@item FLV              @tab  X @tab X
840
@tab Macromedia Flash video files
841 115329f1 Diego Biurrun
@item Real Audio and Video @tab X @tab X
842
@item Raw AC3 @tab X  @tab  X
843
@item Raw MJPEG @tab X  @tab  X
844
@item Raw MPEG video @tab X  @tab  X
845
@item Raw PCM8/16 bits, mulaw/Alaw@tab X  @tab  X
846
@item Raw CRI ADX audio @tab X  @tab  X
847
@item Raw Shorten audio @tab    @tab  X
848
@item SUN AU format @tab X  @tab  X
849 7fe4c823 Alex Beregszaszi
@item NUT @tab X @tab X @tab NUT Open Container Format
850 115329f1 Diego Biurrun
@item QuickTime        @tab X @tab  X
851 4c5f7207 Diego Biurrun
@item MPEG-4           @tab X @tab  X
852
@tab MPEG-4 is a variant of QuickTime.
853 115329f1 Diego Biurrun
@item Raw MPEG4 video  @tab  X @tab  X
854 4fa1c4fa Roman Shaposhnik
@item DV               @tab  X @tab  X
855 701b603d Mike Melanson
@item 4xm              @tab    @tab X
856 4c5f7207 Diego Biurrun
@tab 4X Technologies format, used in some games.
857 4d3b1f8d Mike Melanson
@item Playstation STR  @tab    @tab X
858
@item Id RoQ           @tab    @tab X
859 4c5f7207 Diego Biurrun
@tab Used in Quake III, Jedi Knight 2, other computer games.
860 4d3b1f8d Mike Melanson
@item Interplay MVE    @tab    @tab X
861 4c5f7207 Diego Biurrun
@tab Format used in various Interplay computer games.
862 b17e9c99 Mike Melanson
@item WC3 Movie        @tab    @tab X
863 4c5f7207 Diego Biurrun
@tab Multimedia format used in Origin's Wing Commander III computer game.
864 2fdf638b Mike Melanson
@item Sega FILM/CPK    @tab    @tab X
865 4c5f7207 Diego Biurrun
@tab Used in many Sega Saturn console games.
866 2fdf638b Mike Melanson
@item Westwood Studios VQA/AUD  @tab    @tab X
867 4c5f7207 Diego Biurrun
@tab Multimedia formats used in Westwood Studios games.
868 4120a53a Mike Melanson
@item Id Cinematic (.cin) @tab    @tab X
869 4c5f7207 Diego Biurrun
@tab Used in Quake II.
870 42cad81a Mike Melanson
@item FLIC format      @tab    @tab X
871
@tab .fli/.flc files
872 da00f30e Mike Melanson
@item Sierra VMD       @tab    @tab X
873 4c5f7207 Diego Biurrun
@tab Used in Sierra CD-ROM games.
874 d08d7142 Mike Melanson
@item Sierra Online    @tab    @tab X
875 4c5f7207 Diego Biurrun
@tab .sol files used in Sierra Online games.
876 38088adf Mike Melanson
@item Matroska         @tab    @tab X
877 ad81a9fe Mike Melanson
@item Electronic Arts Multimedia    @tab    @tab X
878 4c5f7207 Diego Biurrun
@tab Used in various EA games; files have extensions like WVE and UV2.
879 353147ed Mike Melanson
@item Nullsoft Video (NSV) format @tab    @tab X
880 4accd1fd Måns Rullgård
@item ADTS AAC audio @tab X @tab X
881 ea395e8c Aurelien Jacobs
@item Creative VOC @tab X @tab X @tab Created for the Sound Blaster Pro.
882 4e114829 Mike Melanson
@item American Laser Games MM  @tab    @tab X
883
@tab Multimedia format used in games like Mad Dog McCree
884 26376701 Mike Melanson
@item AVS @tab    @tab X
885
@tab Multimedia format used by the Creature Shock game.
886 348efc18 Kostya Shishkov
@item Smacker @tab    @tab X
887
@tab Multimedia format used by many games.
888 d7a3a783 Baptiste Coudurier
@item GXF @tab  X @tab X
889
@tab General eXchange Format SMPTE 360M, used by Thomson Grass Valley playout servers.
890 dc56e0de Baptiste Coudurier
@item CIN @tab    @tab X
891
@tab Multimedia format used by Delphine Software games.
892 f3239539 Baptiste Coudurier
@item MXF @tab    @tab X
893
@tab Material eXchange Format SMPTE 377M, used by D-Cinema, broadcast industry.
894 29f86228 Baptiste Coudurier
@item SEQ @tab    @tab X
895
@tab Tiertex .seq files used in the DOS CDROM version of the game Flashback.
896 33a0dd37 Kostya Shishkov
@item DXA @tab    @tab X
897
@tab This format is used in non-Windows version of Feeble Files game and
898
different game cutscenes repacked for use with ScummVM.
899 efb0c399 Diego Biurrun
@item THP @tab    @tab X
900 d1e0d21f Marco Gerards
@tab Used on the Nintendo GameCube.
901 9a0ddd09 Anssi Hannula
@item C93 @tab    @tab X
902
@tab Used in the game Cyberia from Interplay.
903 1e6c6759 Nicholas Tung
@item Bethsoft VID @tab    @tab X
904
@tab Used in some games from Bethesda Softworks.
905 8e952e4d Anssi Hannula
@item CRYO APC @tab    @tab X
906
@tab Audio format used in some games by CRYO Interactive Entertainment.
907 353147ed Mike Melanson
@end multitable
908 9181577c Fabrice Bellard
909 4c5f7207 Diego Biurrun
@code{X} means that encoding (resp. decoding) is supported.
910 9181577c Fabrice Bellard
911 0699d2fe Fabrice Bellard
@section Image Formats
912
913
FFmpeg can read and write images for each frame of a video sequence. The
914
following image formats are supported:
915
916 3fc9e78f Diego Biurrun
@multitable @columnfractions .4 .1 .1 .4
917 0699d2fe Fabrice Bellard
@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
918 115329f1 Diego Biurrun
@item PGM, PPM     @tab X @tab X
919 4c5f7207 Diego Biurrun
@item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support.
920 2eb5d024 Fabrice Bellard
@item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
921 4c5f7207 Diego Biurrun
@item JPEG         @tab X @tab X @tab Progressive JPEG is not supported.
922
@item .Y.U.V       @tab X @tab X @tab one raw file per component
923
@item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
924
@item PNG          @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
925 3689cf16 Kostya Shishkov
@item Targa        @tab   @tab X @tab Targa (.TGA) image format.
926 716222db Michael Niedermayer
@item TIFF         @tab X @tab X @tab YUV, JPEG and some extension is not supported yet.
927 6a91ec51 Mike Melanson
@item SGI          @tab X @tab X @tab SGI RGB image format
928 0699d2fe Fabrice Bellard
@end multitable
929
930 4c5f7207 Diego Biurrun
@code{X} means that encoding (resp. decoding) is supported.
931 0699d2fe Fabrice Bellard
932 9181577c Fabrice Bellard
@section Video Codecs
933
934 3fc9e78f Diego Biurrun
@multitable @columnfractions .4 .1 .1 .4
935 9181577c Fabrice Bellard
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
936 4c5f7207 Diego Biurrun
@item MPEG-1 video           @tab  X  @tab  X
937
@item MPEG-2 video           @tab  X  @tab  X
938 2bc5da7b Michael Niedermayer
@item MPEG-4                 @tab  X  @tab  X
939 9181577c Fabrice Bellard
@item MSMPEG4 V1             @tab  X  @tab  X
940
@item MSMPEG4 V2             @tab  X  @tab  X
941 2bc5da7b Michael Niedermayer
@item MSMPEG4 V3             @tab  X  @tab  X
942 9181577c Fabrice Bellard
@item WMV7                   @tab  X  @tab  X
943 4c5f7207 Diego Biurrun
@item WMV8                   @tab  X  @tab  X @tab not completely working
944 17a21f3c Diego Biurrun
@item WMV9                   @tab     @tab  X @tab not completely working
945
@item VC1                    @tab     @tab  X
946 b06b45c4 Mike Melanson
@item H.261                  @tab  X  @tab  X
947 4c5f7207 Diego Biurrun
@item H.263(+)               @tab  X  @tab  X @tab also known as RealVideo 1.0
948 b06b45c4 Mike Melanson
@item H.264                  @tab     @tab  X
949 e839a994 Diego Biurrun
@item RealVideo 1.0          @tab  X  @tab  X
950
@item RealVideo 2.0          @tab  X  @tab  X
951 115329f1 Diego Biurrun
@item MJPEG                  @tab  X  @tab  X
952 4c5f7207 Diego Biurrun
@item lossless MJPEG         @tab  X  @tab  X
953 26d6d032 Benjamin Larsson
@item JPEG-LS                @tab  X  @tab  X @tab fourcc: MJLS, lossless and near-lossless is supported
954 d6896c49 Alex Beregszaszi
@item Apple MJPEG-B          @tab     @tab  X
955
@item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
956 115329f1 Diego Biurrun
@item DV                     @tab  X  @tab  X
957 4c5f7207 Diego Biurrun
@item HuffYUV                @tab  X  @tab  X
958
@item FFmpeg Video 1         @tab  X  @tab  X @tab experimental lossless codec (fourcc: FFV1)
959
@item FFmpeg Snow            @tab  X  @tab  X @tab experimental wavelet codec (fourcc: SNOW)
960 701b603d Mike Melanson
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
961 4d3b1f8d Mike Melanson
@item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
962 701b603d Mike Melanson
@item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
963 d2bfadc0 Mike Melanson
@item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
964 701b603d Mike Melanson
@item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
965
@item On2 VP3                @tab     @tab  X @tab still experimental
966 5ce117c3 Aurelien Jacobs
@item On2 VP5                @tab     @tab  X @tab fourcc: VP50
967 9110a0e3 Aurelien Jacobs
@item On2 VP6                @tab     @tab  X @tab fourcc: VP60,VP61,VP62
968 150d2772 Diego Biurrun
@item Theora                 @tab  X  @tab  X @tab still experimental
969 cdb2c1ca Sebastian Jedruszkiewicz
@item Intel Indeo 3          @tab     @tab  X
970 9303d49c Alex Beregszaszi
@item FLV                    @tab  X  @tab  X @tab Sorenson H.263 used in Flash
971 15419468 Benjamin Larsson
@item Flash Screen Video     @tab  X  @tab  X @tab fourcc: FSV1
972 4d3b1f8d Mike Melanson
@item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
973 7fe4c823 Alex Beregszaszi
@item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
974 4d3b1f8d Mike Melanson
@item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
975 4c5f7207 Diego Biurrun
@item 4X Video               @tab     @tab  X @tab Used in certain computer games.
976 115329f1 Diego Biurrun
@item Sony Playstation MDEC  @tab     @tab  X
977 4c5f7207 Diego Biurrun
@item Id RoQ                 @tab     @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
978
@item Xan/WC3                @tab     @tab  X @tab Used in Wing Commander III .MVE files.
979
@item Interplay Video        @tab     @tab  X @tab Used in Interplay .MVE files.
980 070ed1bc Mike Melanson
@item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
981 42cad81a Mike Melanson
@item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
982 2fdf638b Mike Melanson
@item Apple Video            @tab     @tab  X @tab fourcc: rpza
983 d08d7142 Mike Melanson
@item Apple QuickDraw        @tab     @tab  X @tab fourcc: qdrw
984 2fdf638b Mike Melanson
@item Cinepak                @tab     @tab  X
985
@item Microsoft RLE          @tab     @tab  X
986
@item Microsoft Video-1      @tab     @tab  X
987 4120a53a Mike Melanson
@item Westwood VQA           @tab     @tab  X
988 4c5f7207 Diego Biurrun
@item Id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
989 1dc1ed99 Roberto Togni
@item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
990 42cad81a Mike Melanson
@item FLIC video             @tab     @tab  X
991 9a4117d5 Mike Melanson
@item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
992 dce76c20 Mike Melanson
@item Duck TrueMotion v2     @tab     @tab  X @tab fourcc: TM20
993 4c5f7207 Diego Biurrun
@item VMD Video              @tab     @tab  X @tab Used in Sierra VMD files.
994 a273bbfb Roberto Togni
@item MSZH                   @tab     @tab  X @tab Part of LCL
995
@item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
996 9d53d58e Mike Melanson
@item TechSmith Camtasia     @tab     @tab  X @tab fourcc: TSCC
997 d0a0bbd2 Mike Melanson
@item IBM Ultimotion         @tab     @tab  X @tab fourcc: ULTI
998 ab711b3c Mike Melanson
@item Miro VideoXL           @tab     @tab  X @tab fourcc: VIXL
999 acfd8f0f Mike Melanson
@item QPEG                   @tab     @tab  X @tab fourccs: QPEG, Q1.0, Q1.1
1000 115329f1 Diego Biurrun
@item LOCO                   @tab     @tab  X @tab
1001
@item Winnov WNV1            @tab     @tab  X @tab
1002 589f8220 Mike Melanson
@item Autodesk Animator Studio Codec  @tab     @tab  X @tab fourcc: AASC
1003 115329f1 Diego Biurrun
@item Fraps FPS1             @tab     @tab  X @tab
1004 2b6c1d80 Diego Biurrun
@item CamStudio              @tab     @tab  X @tab fourcc: CSCD
1005 4e114829 Mike Melanson
@item American Laser Games Video  @tab    @tab X @tab Used in games like Mad Dog McCree
1006 f48d6e1b Kostya Shishkov
@item ZMBV                   @tab   X @tab  X @tab Encoder works only on PAL8
1007 26376701 Mike Melanson
@item AVS Video              @tab     @tab  X @tab Video encoding used by the Creature Shock game.
1008 348efc18 Kostya Shishkov
@item Smacker Video          @tab     @tab  X @tab Video encoding used in Smacker.
1009 dfca23e3 Reimar Döffinger
@item RTjpeg                 @tab     @tab  X @tab Video encoding used in NuppelVideo files.
1010 fd7b1991 Kostya Shishkov
@item KMVC                   @tab     @tab  X @tab Codec used in Worms games.
1011 eb57c889 Kostya Shishkov
@item VMware Video           @tab     @tab  X @tab Codec used in videos captured by VMware.
1012 dc56e0de Baptiste Coudurier
@item Cin Video              @tab     @tab  X @tab Codec used in Delphine Software games.
1013 29f86228 Baptiste Coudurier
@item Tiertex Seq Video      @tab     @tab  X @tab Codec used in DOS CDROM FlashBack game.
1014 33a0dd37 Kostya Shishkov
@item DXA Video              @tab     @tab  X @tab Codec originally used in Feeble Files game.
1015 52b6bad2 Baptiste Coudurier
@item AVID DNxHD             @tab     @tab  X @tab aka SMPTE VC3
1016 9a0ddd09 Anssi Hannula
@item C93 Video              @tab     @tab  X @tab Codec used in Cyberia game.
1017 8845202e Diego Biurrun
@item THP                    @tab     @tab  X @tab Used on the Nintendo GameCube.
1018 1e6c6759 Nicholas Tung
@item Bethsoft VID           @tab     @tab  X @tab Used in some games from Bethesda Softworks.
1019 9181577c Fabrice Bellard
@end multitable
1020
1021 4c5f7207 Diego Biurrun
@code{X} means that encoding (resp. decoding) is supported.
1022 9181577c Fabrice Bellard
1023
@section Audio Codecs
1024
1025
@multitable @columnfractions .4 .1 .1 .1 .7
1026
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
1027 115329f1 Diego Biurrun
@item MPEG audio layer 2     @tab  IX  @tab  IX
1028 9181577c Fabrice Bellard
@item MPEG audio layer 1/3   @tab IX   @tab  IX
1029 4c5f7207 Diego Biurrun
@tab MP3 encoding is supported through the external library LAME.
1030 37776c3b Benjamin Larsson
@item AC3                    @tab  IX  @tab  IX
1031 4c5f7207 Diego Biurrun
@tab liba52 is used internally for decoding.
1032 34d7008d Philip Gladstone
@item Vorbis                 @tab  X   @tab  X
1033 74882049 Diego Biurrun
@item WMA V1/V2              @tab X    @tab X
1034 f6fa7a6c Benjamin Larsson
@item AAC                    @tab X    @tab X
1035 4c5f7207 Diego Biurrun
@tab Supported through the external library libfaac/libfaad.
1036 d4c3c5a6 Michael Niedermayer
@item Microsoft ADPCM        @tab X    @tab X
1037 4d3b1f8d Mike Melanson
@item MS IMA ADPCM           @tab X    @tab X
1038
@item QT IMA ADPCM           @tab      @tab X
1039
@item 4X IMA ADPCM           @tab      @tab X
1040 d4e437df Roman Shaposhnik
@item G.726  ADPCM           @tab X    @tab X
1041 b17e9c99 Mike Melanson
@item Duck DK3 IMA ADPCM     @tab      @tab X
1042 4c5f7207 Diego Biurrun
@tab Used in some Sega Saturn console games.
1043 b17e9c99 Mike Melanson
@item Duck DK4 IMA ADPCM     @tab      @tab X
1044 4c5f7207 Diego Biurrun
@tab Used in some Sega Saturn console games.
1045 2fdf638b Mike Melanson
@item Westwood Studios IMA ADPCM @tab      @tab X
1046 4c5f7207 Diego Biurrun
@tab Used in Westwood Studios games like Command and Conquer.
1047 7d8379f2 Mike Melanson
@item SMJPEG IMA ADPCM       @tab      @tab X
1048 4c5f7207 Diego Biurrun
@tab Used in certain Loki game ports.
1049 42cad81a Mike Melanson
@item CD-ROM XA ADPCM        @tab      @tab X
1050
@item CRI ADX ADPCM          @tab X    @tab X
1051 4c5f7207 Diego Biurrun
@tab Used in Sega Dreamcast games.
1052 7d8379f2 Mike Melanson
@item Electronic Arts ADPCM  @tab      @tab X
1053 4c5f7207 Diego Biurrun
@tab Used in various EA titles.
1054 b3bfb299 Mike Melanson
@item Creative ADPCM         @tab      @tab X
1055 2433f24f Aurelien Jacobs
@tab 16 -> 4, 8 -> 4, 8 -> 3, 8 -> 2
1056 8845202e Diego Biurrun
@item THP ADPCM              @tab      @tab X
1057
@tab Used on the Nintendo GameCube.
1058 2eb5d024 Fabrice Bellard
@item RA144                  @tab      @tab X
1059
@tab Real 14400 bit/s codec
1060
@item RA288                  @tab      @tab X
1061
@tab Real 28800 bit/s codec
1062 37776c3b Benjamin Larsson
@item RADnet                 @tab X    @tab IX
1063 4c5f7207 Diego Biurrun
@tab Real low bitrate AC3 codec, liba52 is used for decoding.
1064 2eb5d024 Fabrice Bellard
@item AMR-NB                 @tab X    @tab X
1065 4c5f7207 Diego Biurrun
@tab Supported through an external library.
1066 d663a1fd Michael Niedermayer
@item AMR-WB                 @tab X    @tab X
1067 4c5f7207 Diego Biurrun
@tab Supported through an external library.
1068 2eb5d024 Fabrice Bellard
@item DV audio               @tab      @tab X
1069 4d3b1f8d Mike Melanson
@item Id RoQ DPCM            @tab      @tab X
1070 4c5f7207 Diego Biurrun
@tab Used in Quake III, Jedi Knight 2, other computer games.
1071 4d3b1f8d Mike Melanson
@item Interplay MVE DPCM     @tab      @tab X
1072 4c5f7207 Diego Biurrun
@tab Used in various Interplay computer games.
1073 b17e9c99 Mike Melanson
@item Xan DPCM               @tab      @tab X
1074 4c5f7207 Diego Biurrun
@tab Used in Origin's Wing Commander IV AVI files.
1075 d08d7142 Mike Melanson
@item Sierra Online DPCM     @tab      @tab X
1076 4c5f7207 Diego Biurrun
@tab Used in Sierra Online game audio files.
1077 d6896c49 Alex Beregszaszi
@item Apple MACE 3           @tab      @tab X
1078
@item Apple MACE 6           @tab      @tab X
1079 bfd9a00f Justin Ruggles
@item FLAC lossless audio    @tab X    @tab X
1080 13dfd2b9 Mike Melanson
@item Shorten lossless audio @tab      @tab X
1081 f770ee03 Mike Melanson
@item Apple lossless audio   @tab      @tab X
1082
@tab QuickTime fourcc 'alac'
1083 33a4d8b1 Alex Beregszaszi
@item FFmpeg Sonic           @tab X    @tab X
1084 4c5f7207 Diego Biurrun
@tab experimental lossy/lossless codec
1085 d9b1c197 Roberto Togni
@item Qdesign QDM2           @tab      @tab X
1086
@tab there are still some distortions
1087 440e7988 Roberto Togni
@item Real COOK              @tab      @tab X
1088
@tab All versions except 5.1 are supported
1089 e839a994 Diego Biurrun
@item DSP Group TrueSpeech   @tab      @tab X
1090 3dc411c0 Alex Beregszaszi
@item True Audio (TTA)       @tab      @tab X
1091 348efc18 Kostya Shishkov
@item Smacker Audio          @tab      @tab X
1092 730581f3 Kostya Shishkov
@item WavPack Audio          @tab      @tab X
1093 dc56e0de Baptiste Coudurier
@item Cin Audio              @tab      @tab X
1094
@tab Codec used in Delphine Software games.
1095 84ed36da Kostya Shishkov
@item Intel Music Coder      @tab      @tab X
1096 185c7b6b Kostya Shishkov
@item Musepack               @tab      @tab X
1097
@tab Only SV7 is supported
1098 01ca9ac3 Kostya Shishkov
@item DT$ Coherent Audio     @tab      @tab X
1099 9181577c Fabrice Bellard
@end multitable
1100
1101 4c5f7207 Diego Biurrun
@code{X} means that encoding (resp. decoding) is supported.
1102 9181577c Fabrice Bellard
1103 4c5f7207 Diego Biurrun
@code{I} means that an integer-only version is available, too (ensures high
1104
performance on systems without hardware floating point support).
1105 9181577c Fabrice Bellard
1106 47d944d2 Fabrice Bellard
@chapter Platform Specific information
1107
1108
@section BSD
1109
1110 21d1cb12 Diego Biurrun
BSD make will not build FFmpeg, you need to install and use GNU Make
1111
(@file{gmake}).
1112
1113 47d944d2 Fabrice Bellard
@section Windows
1114
1115 e2ef53fc Diego Biurrun
To get help and instructions for using FFmpeg under Windows, check out
1116
the FFmpeg Windows Help Forum at
1117
@url{http://arrozcru.no-ip.org/ffmpeg/}.
1118
1119 b030b284 Fabrice Bellard
@subsection Native Windows compilation
1120
1121
@itemize
1122
@item Install the current versions of MSYS and MinGW from
1123
@url{http://www.mingw.org/}. You can find detailed installation
1124
instructions in the download section and the FAQ.
1125
1126 f2d64c19 Alex Beregszaszi
NOTE: Use at least bash 3.1. Older versions are known to be failing on the
1127
configure script.
1128
1129 4c5f7207 Diego Biurrun
@item If you want to test the FFplay, also download
1130 50f52fcd Fabrice Bellard
the MinGW development library of SDL 1.2.x
1131
(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
1132 4c5f7207 Diego Biurrun
@url{http://www.libsdl.org}. Unpack it in a temporary directory, and
1133 50f52fcd Fabrice Bellard
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
1134 988a9f9e Fabrice Bellard
directory. Edit the @file{sdl-config} script so that it gives the
1135
correct SDL directory when invoked.
1136 50f52fcd Fabrice Bellard
1137 e926e391 Diego Biurrun
@item Extract the current version of FFmpeg.
1138 115329f1 Diego Biurrun
1139 b030b284 Fabrice Bellard
@item Start the MSYS shell (file @file{msys.bat}).
1140
1141 4c5f7207 Diego Biurrun
@item Change to the FFmpeg directory and follow
1142
 the instructions of how to compile FFmpeg (file
1143 50f52fcd Fabrice Bellard
@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
1144
suffices. If you have problems using SDL, verify that
1145
@file{sdl-config} can be launched from the MSYS command line.
1146
1147 4c5f7207 Diego Biurrun
@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing
1148 ce10ff8e Diego Biurrun
@file{make install}. Do not forget to copy @file{SDL.dll} to the place
1149 4c5f7207 Diego Biurrun
you launch @file{ffplay} from.
1150 50f52fcd Fabrice Bellard
1151 b030b284 Fabrice Bellard
@end itemize
1152
1153 115329f1 Diego Biurrun
Notes:
1154 988a9f9e Fabrice Bellard
@itemize
1155 50f52fcd Fabrice Bellard
1156 988a9f9e Fabrice Bellard
@item The target @file{make wininstaller} can be used to create a
1157
Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
1158 4c5f7207 Diego Biurrun
must be copied to the FFmpeg directory in order to build the
1159 988a9f9e Fabrice Bellard
installer.
1160
1161 4c5f7207 Diego Biurrun
@item By using @code{./configure --enable-shared} when configuring FFmpeg,
1162 988a9f9e Fabrice Bellard
you can build @file{avcodec.dll} and @file{avformat.dll}. With
1163
@code{make install} you install the FFmpeg DLLs and the associated
1164 115329f1 Diego Biurrun
headers in @file{Program Files/FFmpeg}.
1165 988a9f9e Fabrice Bellard
1166 4c5f7207 Diego Biurrun
@item Visual C++ compatibility: If you used @code{./configure --enable-shared}
1167
when configuring FFmpeg, FFmpeg tries to use the Microsoft Visual
1168 988a9f9e Fabrice Bellard
C++ @code{lib} tool to build @code{avcodec.lib} and
1169 4c5f7207 Diego Biurrun
@code{avformat.lib}. With these libraries you can link your Visual C++
1170 be0efc0c Martin Boehme
code directly with the FFmpeg DLLs (see below).
1171 988a9f9e Fabrice Bellard
1172
@end itemize
1173 b030b284 Fabrice Bellard
1174 be0efc0c Martin Boehme
@subsection Visual C++ compatibility
1175
1176
FFmpeg will not compile under Visual C++ -- and it has too many
1177
dependencies on the GCC compiler to make a port viable. However,
1178
if you want to use the FFmpeg libraries in your own applications,
1179
you can still compile those applications using Visual C++. An
1180
important restriction to this is that you have to use the
1181
dynamically linked versions of the FFmpeg libraries (i.e. the
1182
DLLs), and you have to make sure that Visual-C++-compatible
1183
import libraries are created during the FFmpeg build process.
1184
1185
This description of how to use the FFmpeg libraries with Visual C++ is
1186
based on Visual C++ 2005 Express Edition Beta 2. If you have a different
1187
version, you might have to modify the procedures slightly.
1188
1189
Here are the step-by-step instructions for building the FFmpeg libraries
1190
so they can be used with Visual C++:
1191
1192
@enumerate
1193
1194 ce10ff8e Diego Biurrun
@item Install Visual C++ (if you have not done so already).
1195 be0efc0c Martin Boehme
1196
@item Install MinGW and MSYS as described above.
1197
1198
@item Add a call to @file{vcvars32.bat} (which sets up the environment
1199
variables for the Visual C++ tools) as the first line of
1200
@file{msys.bat}. The standard location for @file{vcvars32.bat} is
1201
@file{C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat},
1202
and the standard location for @file{msys.bat} is
1203
@file{C:\msys\1.0\msys.bat}. If this corresponds to your setup, add the
1204
following line as the first line of @file{msys.bat}:
1205
1206
@code{call "C:\Program Files\Microsoft Visual Studio 8\VC\bin\vcvars32.bat"}
1207
1208
@item Start the MSYS shell (file @file{msys.bat}) and type @code{link.exe}.
1209
If you get a help message with the command line options of @code{link.exe},
1210
this means your environment variables are set up correctly, the
1211
Microsoft linker is on the path and will be used by FFmpeg to
1212
create Visual-C++-compatible import libraries.
1213
1214 e926e391 Diego Biurrun
@item Extract the current version of FFmpeg and change to the FFmpeg directory.
1215 be0efc0c Martin Boehme
1216
@item Type the command
1217 51d8321d Diego Biurrun
@code{./configure --enable-shared --disable-static --enable-memalign-hack}
1218 ce10ff8e Diego Biurrun
to configure and, if that did not produce any errors,
1219 51d8321d Diego Biurrun
type @code{make} to build FFmpeg.
1220 be0efc0c Martin Boehme
1221
@item The subdirectories @file{libavformat}, @file{libavcodec}, and
1222
@file{libavutil} should now contain the files @file{avformat.dll},
1223
@file{avformat.lib}, @file{avcodec.dll}, @file{avcodec.lib},
1224
@file{avutil.dll}, and @file{avutil.lib}, respectively. Copy the three
1225
DLLs to your System32 directory (typically @file{C:\Windows\System32}).
1226
1227
@end enumerate
1228
1229
And here is how to use these libraries with Visual C++:
1230
1231
@enumerate
1232
1233
@item Create a new console application ("File / New / Project") and then
1234
select "Win32 Console Application". On the appropriate page of the
1235
Application Wizard, uncheck the "Precompiled headers" option.
1236
1237
@item Write the source code for your application, or, for testing, just
1238
copy the code from an existing sample application into the source file
1239
that Visual C++ has already created for you. (Note that your source
1240 ce10ff8e Diego Biurrun
filehas to have a @code{.cpp} extension; otherwise, Visual C++ will not
1241
compile the FFmpeg headers correctly because in C mode, it does not
1242 be0efc0c Martin Boehme
recognize the @code{inline} keyword.)  For example, you can copy
1243
@file{output_example.c} from the FFmpeg distribution (but you will
1244
have to make minor modifications so the code will compile under
1245
C++, see below).
1246
1247
@item Open the "Project / Properties" dialog box. In the "Configuration"
1248
combo box, select "All Configurations" so that the changes you make will
1249
affect both debug and release builds. In the tree view on the left hand
1250
side, select "C/C++ / General", then edit the "Additional Include
1251
Directories" setting to contain the complete paths to the
1252
@file{libavformat}, @file{libavcodec}, and @file{libavutil}
1253
subdirectories of your FFmpeg directory. Note that the directories have
1254
to be separated using semicolons. Now select "Linker / General" from the
1255
tree view and edit the "Additional Library Directories" setting to
1256
contain the same three directories.
1257
1258
@item Still in the "Project / Properties" dialog box, select "Linker / Input"
1259
from the tree view, then add the files @file{avformat.lib},
1260
@file{avcodec.lib}, and @file{avutil.lib} to the end of the "Additional
1261
Dependencies". Note that the names of the libraries have to be separated
1262
using spaces.
1263
1264 765c3440 Fredrik Orderud
@item Now, select "C/C++ / Code Generation" from the tree view. Select
1265 be0efc0c Martin Boehme
"Debug" in the "Configuration" combo box. Make sure that "Runtime
1266
Library" is set to "Multi-threaded Debug DLL". Then, select "Release" in
1267
the "Configuration" combo box and make sure that "Runtime Library" is
1268
set to "Multi-threaded DLL".
1269
1270
@item Click "OK" to close the "Project / Properties" dialog box and build
1271
the application. Hopefully, it should compile and run cleanly. If you
1272
used @file{output_example.c} as your sample application, you will get a
1273
few compiler errors, but they are easy to fix. The first type of error
1274 ce10ff8e Diego Biurrun
occurs because Visual C++ does not allow an @code{int} to be converted to
1275 be0efc0c Martin Boehme
an @code{enum} without a cast. To solve the problem, insert the required
1276
casts (this error occurs once for a @code{CodecID} and once for a
1277
@code{CodecType}).  The second type of error occurs because C++ requires
1278
the return value of @code{malloc} to be cast to the exact type of the
1279
pointer it is being assigned to. Visual C++ will complain that, for
1280
example, @code{(void *)} is being assigned to @code{(uint8_t *)} without
1281
an explicit cast. So insert an explicit cast in these places to silence
1282
the compiler. The third type of error occurs because the @code{snprintf}
1283
library function is called @code{_snprintf} under Visual C++.  So just
1284
add an underscore to fix the problem. With these changes,
1285
@file{output_example.c} should compile under Visual C++, and the
1286
resulting executable should produce valid video files.
1287
1288
@end enumerate
1289
1290 b030b284 Fabrice Bellard
@subsection Cross compilation for Windows with Linux
1291
1292
You must use the MinGW cross compilation tools available at
1293
@url{http://www.mingw.org/}.
1294
1295 4c5f7207 Diego Biurrun
Then configure FFmpeg with the following options:
1296 b030b284 Fabrice Bellard
@example
1297 6b74787b Víctor Paesa
./configure --target-os=mingw32 --cross-prefix=i386-mingw32msvc-
1298 b030b284 Fabrice Bellard
@end example
1299 019c8838 Diego Biurrun
(you can change the cross-prefix according to the prefix chosen for the
1300 b030b284 Fabrice Bellard
MinGW tools).
1301
1302 4c5f7207 Diego Biurrun
Then you can easily test FFmpeg with Wine
1303 b030b284 Fabrice Bellard
(@url{http://www.winehq.com/}).
1304
1305 30aee296 Diego Biurrun
@subsection Compilation under Cygwin
1306
1307
Cygwin works very much like Unix.
1308
1309
Just install your Cygwin with all the "Base" packages, plus the
1310
following "Devel" ones:
1311
@example
1312
binutils, gcc-core, make, subversion
1313
@end example
1314
1315
Do not install binutils-20060709-1 (they are buggy on shared builds);
1316
use binutils-20050610-1 instead.
1317
1318
Then run
1319
1320
@example
1321
./configure --enable-static --disable-shared
1322
@end example
1323
1324
to make a static build or
1325
1326
@example
1327
./configure --enable-shared --disable-static
1328
@end example
1329
1330
to build shared libraries.
1331
1332
If you want to build FFmpeg with additional libraries, download Cygwin
1333
"Devel" packages for Ogg and Vorbis from any Cygwin packages repository
1334
and/or SDL, xvid, faac, faad2 packages from Cygwin Ports,
1335
(@url{http://cygwinports.dotsrc.org/}).
1336
1337
@subsection Crosscompilation for Windows under Cygwin
1338
1339 ce10ff8e Diego Biurrun
With Cygwin you can create Windows binaries that do not need the cygwin1.dll.
1340 30aee296 Diego Biurrun
1341
Just install your Cygwin as explained before, plus these additional
1342
"Devel" packages:
1343
@example
1344
gcc-mingw-core, mingw-runtime, mingw-zlib
1345
@end example
1346
1347
and add some special flags to your configure invocation.
1348
1349
For a static build run
1350
@example
1351 6b74787b Víctor Paesa
./configure --target-os=mingw32 --enable-memalign-hack --enable-static --disable-shared --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1352 30aee296 Diego Biurrun
@end example
1353
1354
and for a build with shared libraries
1355
@example
1356 6b74787b Víctor Paesa
./configure --target-os=mingw32 --enable-memalign-hack --enable-shared --disable-static --extra-cflags=-mno-cygwin --extra-libs=-mno-cygwin
1357 30aee296 Diego Biurrun
@end example
1358
1359 47d944d2 Fabrice Bellard
@section BeOS
1360
1361
The configure script should guess the configuration itself.
1362
Networking support is currently not finished.
1363
errno issues fixed by Andrew Bachmann.
1364
1365
Old stuff:
1366
1367 7dd611c9 François Revol
François Revol - revol at free dot fr - April 2002
1368 47d944d2 Fabrice Bellard
1369 115329f1 Diego Biurrun
The configure script should guess the configuration itself,
1370 ce10ff8e Diego Biurrun
however I still did not test building on the net_server version of BeOS.
1371 47d944d2 Fabrice Bellard
1372 4c5f7207 Diego Biurrun
FFserver is broken (needs poll() implementation).
1373 47d944d2 Fabrice Bellard
1374 4c5f7207 Diego Biurrun
There are still issues with errno codes, which are negative in BeOS, and
1375 115329f1 Diego Biurrun
that FFmpeg negates when returning. This ends up turning errors into
1376 47d944d2 Fabrice Bellard
valid results, then crashes.
1377
(To be fixed)
1378
1379 34d7008d Philip Gladstone
@chapter Developers Guide
1380 9181577c Fabrice Bellard
1381
@section API
1382 a0b72f90 Diego Biurrun
@itemize @bullet
1383 9181577c Fabrice Bellard
@item libavcodec is the library containing the codecs (both encoding and
1384 4c5f7207 Diego Biurrun
decoding). Look at @file{libavcodec/apiexample.c} to see how to use it.
1385 9181577c Fabrice Bellard
1386 4c5f7207 Diego Biurrun
@item libavformat is the library containing the file format handling (mux and
1387
demux code for several formats). Look at @file{ffplay.c} to use it in a
1388 a93b9dba Fabrice Bellard
player. See @file{output_example.c} to use it to generate audio or video
1389
streams.
1390
1391 9181577c Fabrice Bellard
@end itemize
1392
1393
@section Integrating libavcodec or libavformat in your program
1394
1395
You can integrate all the source code of the libraries to link them
1396
statically to avoid any version problem. All you need is to provide a
1397
'config.mak' and a 'config.h' in the parent directory. See the defines
1398
generated by ./configure to understand what is needed.
1399
1400
You can use libavcodec or libavformat in your commercial program, but
1401
@emph{any patch you make must be published}. The best way to proceed is
1402 4c5f7207 Diego Biurrun
to send your patches to the FFmpeg mailing list.
1403 9181577c Fabrice Bellard
1404 80d1c272 Michael Niedermayer
@node Coding Rules
1405 9181577c Fabrice Bellard
@section Coding Rules
1406
1407 4c5f7207 Diego Biurrun
FFmpeg is programmed in the ISO C90 language with a few additional
1408 cb6e87c1 Falk Hüffner
features from ISO C99, namely:
1409
@itemize @bullet
1410
@item
1411
the @samp{inline} keyword;
1412
@item
1413
@samp{//} comments;
1414
@item
1415
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
1416
@item
1417 114afa9c Diego Biurrun
compound literals (@samp{x = (struct s) @{ 17, 23 @};})
1418 cb6e87c1 Falk Hüffner
@end itemize
1419
1420 ce10ff8e Diego Biurrun
These features are supported by all compilers we care about, so we will not
1421
accept patches to remove their use unless they absolutely do not impair
1422 cb6e87c1 Falk Hüffner
clarity and performance.
1423
1424 4c5f7207 Diego Biurrun
All code must compile with GCC 2.95 and GCC 3.3. Currently, FFmpeg also
1425 cb6e87c1 Falk Hüffner
compiles with several other compilers, such as the Compaq ccc compiler
1426
or Sun Studio 9, and we would like to keep it that way unless it would
1427 ce10ff8e Diego Biurrun
be exceedingly involved. To ensure compatibility, please do not use any
1428 4c5f7207 Diego Biurrun
additional C99 features or GCC extensions. Especially watch out for:
1429 cb6e87c1 Falk Hüffner
@itemize @bullet
1430
@item
1431
mixing statements and declarations;
1432
@item
1433
@samp{long long} (use @samp{int64_t} instead);
1434
@item
1435
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
1436
@item
1437 019c8838 Diego Biurrun
GCC statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
1438 cb6e87c1 Falk Hüffner
@end itemize
1439 9181577c Fabrice Bellard
1440 53862e0f Diego Biurrun
Indent size is 4.
1441 b86e38a0 Aurelien Jacobs
The presentation is the one specified by 'indent -i4 -kr -nut'.
1442 53862e0f Diego Biurrun
The TAB character is forbidden outside of Makefiles as is any
1443
form of trailing whitespace. Commits containing either will be
1444 1c1b5a40 Diego Biurrun
rejected by the Subversion repository.
1445 9181577c Fabrice Bellard
1446 4c5f7207 Diego Biurrun
Main priority in FFmpeg is simplicity and small code size (=less
1447 9181577c Fabrice Bellard
bugs).
1448
1449 4c5f7207 Diego Biurrun
Comments: Use the JavaDoc/Doxygen
1450
format (see examples below) so that code documentation
1451
can be generated automatically. All nontrivial functions should have a comment
1452 ce10ff8e Diego Biurrun
above them explaining what the function does, even if it is just one sentence.
1453 4c5f7207 Diego Biurrun
All structures and their member variables should be documented, too.
1454 f4888b83 Michael Niedermayer
@example
1455
/**
1456 2185824b Måns Rullgård
 * @@file mpeg.c
1457
 * MPEG codec.
1458
 * @@author ...
1459
 */
1460 f4888b83 Michael Niedermayer
1461
/**
1462 2185824b Måns Rullgård
 * Summary sentence.
1463
 * more text ...
1464
 * ...
1465
 */
1466 114afa9c Diego Biurrun
typedef struct Foobar@{
1467 2185824b Måns Rullgård
    int var1; /**< var1 description */
1468
    int var2; ///< var2 description
1469
    /** var3 description */
1470
    int var3;
1471 114afa9c Diego Biurrun
@} Foobar;
1472 f4888b83 Michael Niedermayer
1473
/**
1474 2185824b Måns Rullgård
 * Summary sentence.
1475
 * more text ...
1476
 * ...
1477
 * @@param my_parameter description of my_parameter
1478
 * @@return return value description
1479
 */
1480 f4888b83 Michael Niedermayer
int myfunc(int my_parameter)
1481
...
1482
@end example
1483 9181577c Fabrice Bellard
1484 115329f1 Diego Biurrun
fprintf and printf are forbidden in libavformat and libavcodec,
1485 36d9b4e8 Michael Niedermayer
please use av_log() instead.
1486
1487 1c1b5a40 Diego Biurrun
@section Development Policy
1488 7a57b90c Michael Niedermayer
1489
@enumerate
1490 115329f1 Diego Biurrun
@item
1491 7a57b90c Michael Niedermayer
   You must not commit code which breaks FFmpeg! (Meaning unfinished but
1492 4c5f7207 Diego Biurrun
   enabled code which breaks compilation or compiles but does not work or
1493 7a57b90c Michael Niedermayer
   breaks the regression tests)
1494
   You can commit unfinished stuff (for testing etc), but it must be disabled
1495
   (#ifdef etc) by default so it does not interfere with other developers'
1496
   work.
1497 115329f1 Diego Biurrun
@item
1498 ce10ff8e Diego Biurrun
   You do not have to over-test things. If it works for you, and you think it
1499 4c5f7207 Diego Biurrun
   should work for others, then commit. If your code has problems
1500
   (portability, triggers compiler bugs, unusual environment etc) they will be
1501 7a57b90c Michael Niedermayer
   reported and eventually fixed.
1502 115329f1 Diego Biurrun
@item
1503 7a57b90c Michael Niedermayer
   Do not commit unrelated changes together, split them into self-contained
1504 ce10ff8e Diego Biurrun
   pieces. Also do not forget that if part B depends on part A, but A does not
1505
   depend on B, then A can and should be committed first and separate from B.
1506
   Keeping changes well split into self-contained parts makes reviewing and
1507
   understanding them on the commit log mailing list easier. This also helps
1508
   in case of debugging later on.
1509
   Also if you have doubts about splitting or not splitting, do not hesitate to
1510 981990db Michael Niedermayer
   ask/disscuss it on the developer mailing list.
1511 7a57b90c Michael Niedermayer
@item
1512
   Do not change behavior of the program (renaming options etc) without
1513 019c8838 Diego Biurrun
   first discussing it on the ffmpeg-devel mailing list. Do not remove
1514 7a57b90c Michael Niedermayer
   functionality from the code. Just improve!
1515 115329f1 Diego Biurrun
1516 4c5f7207 Diego Biurrun
   Note: Redundant code can be removed.
1517 7a57b90c Michael Niedermayer
@item
1518
   Do not commit changes to the build system (Makefiles, configure script)
1519 019c8838 Diego Biurrun
   which change behavior, defaults etc, without asking first. The same
1520 7a57b90c Michael Niedermayer
   applies to compiler warning fixes, trivial looking fixes and to code
1521
   maintained by other developers. We usually have a reason for doing things
1522 019c8838 Diego Biurrun
   the way we do. Send your changes as patches to the ffmpeg-devel mailing
1523 7a57b90c Michael Niedermayer
   list, and if the code maintainers say OK, you may commit. This does not
1524
   apply to files you wrote and/or maintain.
1525
@item
1526
   We refuse source indentation and other cosmetic changes if they are mixed
1527
   with functional changes, such commits will be rejected and removed. Every
1528
   developer has his own indentation style, you should not change it. Of course
1529
   if you (re)write something, you can use your own style, even though we would
1530 4c5f7207 Diego Biurrun
   prefer if the indentation throughout FFmpeg was consistent (Many projects
1531 ce10ff8e Diego Biurrun
   force a given indentation style - we do not.). If you really need to make
1532 7a57b90c Michael Niedermayer
   indentation changes (try to avoid this), separate them strictly from real
1533
   changes.
1534
1535 114afa9c Diego Biurrun
   NOTE: If you had to put if()@{ .. @} over a large (> 5 lines) chunk of code,
1536 ce10ff8e Diego Biurrun
   then either do NOT change the indentation of the inner part within (do not
1537 019c8838 Diego Biurrun
   move it to the right)! or do so in a separate commit
1538 7a57b90c Michael Niedermayer
@item
1539
   Always fill out the commit log message. Describe in a few lines what you
1540
   changed and why. You can refer to mailing list postings if you fix a
1541
   particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
1542
@item
1543
   If you apply a patch by someone else, include the name and email address in
1544 1c1b5a40 Diego Biurrun
   the log message. Since the ffmpeg-cvslog mailing list is publicly
1545 019c8838 Diego Biurrun
   archived you should add some SPAM protection to the email address. Send an
1546
   answer to ffmpeg-devel (or wherever you got the patch from) saying that
1547 7a57b90c Michael Niedermayer
   you applied the patch.
1548
@item
1549 5ab0f204 Diego Biurrun
    Do NOT commit to code actively maintained by others without permission.
1550
    Send a patch to ffmpeg-devel instead. If noone answers within a reasonable
1551
    timeframe (12h for build failures and security fixes, 3 days small changes,
1552 ce10ff8e Diego Biurrun
    1 week for big patches) then commit your patch if you think it is OK.
1553 5ab0f204 Diego Biurrun
    Also note, the maintainer can simply ask for more time to review!
1554 7a57b90c Michael Niedermayer
@item
1555 1c1b5a40 Diego Biurrun
    Subscribe to the ffmpeg-cvslog mailing list. The diffs of all commits
1556 7a57b90c Michael Niedermayer
    are sent there and reviewed by all the other developers. Bugs and possible
1557
    improvements or general questions regarding commits are discussed there. We
1558
    expect you to react if problems with your code are uncovered.
1559
@item
1560
    Update the documentation if you change behavior or add features. If you are
1561 019c8838 Diego Biurrun
    unsure how best to do this, send a patch to ffmpeg-devel, the documentation
1562 7a57b90c Michael Niedermayer
    maintainer(s) will review and commit your stuff.
1563
@item
1564 0541f2c4 Michael Niedermayer
    Try to keep important discussions and requests (also) on the public
1565
    developer mailing list, so that all developers can benefit from them.
1566
@item
1567 4c5f7207 Diego Biurrun
    Never write to unallocated memory, never write over the end of arrays,
1568
    always check values read from some untrusted source before using them
1569
    as array index or other risky things.
1570 76bec1d8 Alexander Strasser
@item
1571
    Remember to check if you need to bump versions for the specific libav
1572 f0efbde7 Diego Biurrun
    parts (libavutil, libavcodec, libavformat) you are changing. You need
1573 76bec1d8 Alexander Strasser
    to change the version integer and the version string.
1574
    Incrementing the first component means no backward compatibility to
1575 a940b428 Michael Niedermayer
    previous versions (e.g. removal of a function from the public API).
1576 76bec1d8 Alexander Strasser
    Incrementing the second component means backward compatible change
1577 a940b428 Michael Niedermayer
    (e.g. addition of a function to the public API).
1578 76bec1d8 Alexander Strasser
    Incrementing the third component means a noteworthy binary compatible
1579
    change (e.g. encoder bug fix that matters for the decoder).
1580 ebd32fd7 Diego Biurrun
@item
1581 3f1965c4 Diego Biurrun
    If you add a new codec, remember to update the changelog, add it to
1582
    the supported codecs table in the documentation and bump the second
1583
    component of the @file{libavcodec} version number appropriately. If
1584
    it has a fourcc, add it to @file{libavformat/avienc.c}, even if it
1585
    is only a decoder.
1586 65d0bea8 Michael Niedermayer
@item
1587 ce10ff8e Diego Biurrun
    Do not change code to hide warnings without ensuring that the underlying
1588
    logic is correct and thus the warning was inappropriate.
1589 114afa9c Diego Biurrun
@end enumerate
1590 7a57b90c Michael Niedermayer
1591
We think our rules are not too hard. If you have comments, contact us.
1592
1593
Note, these rules are mostly borrowed from the MPlayer project.
1594
1595 9181577c Fabrice Bellard
@section Submitting patches
1596
1597 ce10ff8e Diego Biurrun
First, (@pxref{Coding Rules}) above if you did not yet.
1598 80d1c272 Michael Niedermayer
1599 6a6810b1 Michael Niedermayer
When you submit your patch, try to send a unified diff (diff '-up'
1600 9181577c Fabrice Bellard
option). I cannot read other diffs :-)
1601
1602 6e5c1877 Michael Niedermayer
Also please do not submit patches which contain several unrelated changes.
1603 115329f1 Diego Biurrun
Split them into individual self-contained patches; this makes reviewing
1604 7885603a Michael Niedermayer
them much easier.
1605
1606 9181577c Fabrice Bellard
Run the regression tests before submitting a patch so that you can
1607 6bf40f39 Philip Gladstone
verify that there are no big problems.
1608 9181577c Fabrice Bellard
1609
Patches should be posted as base64 encoded attachments (or any other
1610 ce10ff8e Diego Biurrun
encoding which ensures that the patch will not be trashed during
1611 115329f1 Diego Biurrun
transmission) to the ffmpeg-devel mailing list, see
1612 2b165e29 Diego Biurrun
@url{http://lists.mplayerhq.hu/mailman/listinfo/ffmpeg-devel}
1613 9181577c Fabrice Bellard
1614 54fcf429 Michael Niedermayer
It also helps quite a bit if you tell us what the patch does (for example
1615 4c5f7207 Diego Biurrun
'replaces lrint by lrintf'), and why (for example '*BSD isn't C99 compliant
1616 54fcf429 Michael Niedermayer
and has no lrint()')
1617
1618 f5f11d71 Michael Niedermayer
@section Patch review process
1619
1620
All patches posted to ffmpeg-devel will be reviewed, unless they contain a
1621
clear note that the patch is not for SVN.
1622
Reviews and comments will be posted as replies to the patch on the
1623 ce10ff8e Diego Biurrun
mailing list. The patch submitter then has to take care of every comment,
1624 f5f11d71 Michael Niedermayer
that can be by resubmitting a changed patch or by disscussion. Resubmitted
1625 ce10ff8e Diego Biurrun
patches will themselves be reviewed like any other patch. If at some point
1626 f5f11d71 Michael Niedermayer
a patch passes review with no comments then it is approved, that can for
1627 ce10ff8e Diego Biurrun
simple and small patches happen immediately while large patches will generally
1628 f5f11d71 Michael Niedermayer
have to be changed and reviewed many times before they are approved.
1629 ce10ff8e Diego Biurrun
After a patch is approved it will be committed to the repository.
1630 f5f11d71 Michael Niedermayer
1631
We will review all submitted patches, but sometimes we are quite busy so
1632
especially for large patches this can take several weeks.
1633
1634
When resubmitting patches, please do not make any significant changes
1635 ce10ff8e Diego Biurrun
not related to the comments received during review. Such patches will
1636
be rejected. Instead, submit  significant changes or new features as
1637
separate patches.
1638 cf7f2b16 Michael Niedermayer
1639 9181577c Fabrice Bellard
@section Regression tests
1640
1641 1c1b5a40 Diego Biurrun
Before submitting a patch (or committing to the repository), you should at least
1642 9181577c Fabrice Bellard
test that you did not break anything.
1643
1644 4c5f7207 Diego Biurrun
The regression tests build a synthetic video stream and a synthetic
1645
audio stream. These are then encoded and decoded with all codecs or
1646 9181577c Fabrice Bellard
formats. The CRC (or MD5) of each generated file is recorded in a
1647 4c5f7207 Diego Biurrun
result file. A 'diff' is launched to compare the reference results and
1648 9181577c Fabrice Bellard
the result file.
1649
1650 4c5f7207 Diego Biurrun
The regression tests then go on to test the FFserver code with a
1651 6bf40f39 Philip Gladstone
limited set of streams. It is important that this step runs correctly
1652
as well.
1653
1654 36d9b4e8 Michael Niedermayer
Run 'make test' to test all the codecs and formats.
1655 9181577c Fabrice Bellard
1656 4c5f7207 Diego Biurrun
Run 'make fulltest' to test all the codecs, formats and FFserver.
1657 9181577c Fabrice Bellard
1658 4c5f7207 Diego Biurrun
[Of course, some patches may change the results of the regression tests. In
1659
this case, the reference results of the regression tests shall be modified
1660 9181577c Fabrice Bellard
accordingly].
1661
1662
@bye