ffmpeg-doc.texi 44.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
\input texinfo @c -*- texinfo -*-

@settitle FFmpeg Documentation
@titlepage
@sp 7
@center @titlefont{FFmpeg Documentation}
@sp 3
@end titlepage


@chapter Introduction

FFmpeg is a very fast video and audio converter. It can also grab from
a live audio/video source.
  
The command line interface is designed to be intuitive, in the sense
Diego Biurrun's avatar
Diego Biurrun committed
17 18 19
that FFmpeg tries to figure out all parameters that can possibly be
derived automatically. You usually only have to specify the target
bitrate you want.
20 21 22 23 24 25

FFmpeg can also convert from any sample rate to any other, and resize
video on the fly with a high quality polyphase filter.

@chapter Quick Start

26
@c man begin EXAMPLES
27 28
@section Video and Audio grabbing

29 30 31
FFmpeg can use a video4linux compatible video source and any Open Sound
System audio source:

32
@example
33
ffmpeg /tmp/out.mpg 
34 35
@end example

36
Note that you must activate the right video source and channel before
Diego Biurrun's avatar
Diego Biurrun committed
37 38 39
launching FFmpeg with any TV viewer such as xawtv
(@url{http://bytesex.org/xawtv/}) by Gerd Knorr. You also
have to set the audio recording levels correctly with a
40
standard mixer.
41

42
@section Video and Audio file format conversion
43

Diego Biurrun's avatar
Diego Biurrun committed
44
* FFmpeg can use any supported file format and protocol as input:
45 46 47

Examples:

Diego Biurrun's avatar
Diego Biurrun committed
48
* You can use YUV files as input:
49 50

@example
51
ffmpeg -i /tmp/test%d.Y /tmp/out.mpg 
52 53
@end example

54
It will use the files: 
55
@example
56 57
/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
58 59
@end example

60 61 62
The Y files use twice the resolution of the U and V files. They are
raw files, without header. They can be generated by all decent video
decoders. You must specify the size of the image with the @option{-s} option
Diego Biurrun's avatar
Diego Biurrun committed
63
if FFmpeg cannot guess it.
64

Diego Biurrun's avatar
Diego Biurrun committed
65
* You can input from a raw YUV420P file:
66 67

@example
68
ffmpeg -i /tmp/test.yuv /tmp/out.avi
69 70
@end example

Diego Biurrun's avatar
Diego Biurrun committed
71 72
test.yuv is a file containing raw YUV planar data. Each frame is composed
of the Y plane followed by the U and V planes at half vertical and
73
horizontal resolution.
74

Diego Biurrun's avatar
Diego Biurrun committed
75
* You can output to a raw YUV420P file:
76 77

@example
78
ffmpeg -i mydivx.avi hugefile.yuv
79 80 81 82 83
@end example

* You can set several input files and output files:

@example
84
ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
85 86
@end example

Diego Biurrun's avatar
Diego Biurrun committed
87 88
Converts the audio file a.wav and the raw YUV video file a.yuv
to MPEG file a.mpg.
89

90
* You can also do audio and video conversions at the same time:
91 92

@example
93
ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
94 95
@end example

Diego Biurrun's avatar
Diego Biurrun committed
96
Converts a.wav to MPEG audio at 22050Hz sample rate.
97 98

* You can encode to several formats at the same time and define a
99
mapping from input stream to output streams:
100 101

@example
102
ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
103 104
@end example

Diego Biurrun's avatar
Diego Biurrun committed
105 106
Converts a.wav to a.mp2 at 64 kbits and to b.mp2 at 128 kbits. '-map
file:index' specifies which input stream is used for each output
107
stream, in the order of the definition of output streams.
108 109 110 111

* You can transcode decrypted VOBs

@example
112
ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
113 114
@end example

Diego Biurrun's avatar
Diego Biurrun committed
115 116 117 118 119 120 121
This is a typical DVD ripping example; the input is a VOB file, the
output an AVI file with MPEG-4 video and MP3 audio. Note that in this
command we use B-frames so the MPEG-4 stream is DivX5 compatible, and
GOP size is 300 which means one intra frame every 10 seconds for 29.97fps
input video. Furthermore, the audio stream is MP3-encoded so you need
to enable LAME support by passing @code{--enable-mp3lame} to configure.
The mapping is particularly useful for DVD transcoding
122
to get the desired audio language.
123

Diego Biurrun's avatar
Diego Biurrun committed
124
NOTE: To see the supported input formats, use @code{ffmpeg -formats}.
125
@c man end
126 127 128 129 130

@chapter Invocation

@section Syntax

131
The generic syntax is:
132 133

@example 
134
@c man begin SYNOPSIS
Michael Niedermayer's avatar
Michael Niedermayer committed
135
ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
136
@c man end
137
@end example
138 139
@c man begin DESCRIPTION
If no input file is given, audio/video grabbing is done.
140

141 142
As a general rule, options are applied to the next specified
file. For example, if you give the @option{-b 64} option, it sets the video
Diego Biurrun's avatar
Diego Biurrun committed
143
bitrate of the next file. The format option may be needed for raw input
144
files.
145

Diego Biurrun's avatar
Diego Biurrun committed
146 147
By default, FFmpeg tries to convert as losslessly as possible: It
uses the same audio and video parameters for the outputs as the one
148 149
specified for the inputs.
@c man end
150

151
@c man begin OPTIONS
152 153
@section Main options

154
@table @option
155
@item -L
Diego Biurrun's avatar
Diego Biurrun committed
156
Show license.
Fabrice Bellard's avatar
Fabrice Bellard committed
157

158
@item -h
Diego Biurrun's avatar
Diego Biurrun committed
159
Show help.
Fabrice Bellard's avatar
Fabrice Bellard committed
160

161
@item -formats
Diego Biurrun's avatar
Diego Biurrun committed
162
Show available formats, codecs, protocols, ...
Fabrice Bellard's avatar
Fabrice Bellard committed
163

164
@item -f fmt              
Diego Biurrun's avatar
Diego Biurrun committed
165
Force format.
Fabrice Bellard's avatar
Fabrice Bellard committed
166

167
@item -i filename         
Diego Biurrun's avatar
Diego Biurrun committed
168
input filename
169 170

@item -y                  
Diego Biurrun's avatar
Diego Biurrun committed
171
Overwrite output files.
172 173

@item -t duration         
Diego Biurrun's avatar
Diego Biurrun committed
174 175
Set the recording time in seconds.
@code{hh:mm:ss[.xxx]} syntax is also supported.
176

177
@item -ss position
Diego Biurrun's avatar
Diego Biurrun committed
178 179
Seek to given time position in seconds.
@code{hh:mm:ss[.xxx]} syntax is also supported.
180

181
@item -title string       
Diego Biurrun's avatar
Diego Biurrun committed
182
Set the title.
183 184

@item -author string      
Diego Biurrun's avatar
Diego Biurrun committed
185
Set the author.
186 187

@item -copyright string   
Diego Biurrun's avatar
Diego Biurrun committed
188
Set the copyright.
189 190

@item -comment string     
Diego Biurrun's avatar
Diego Biurrun committed
191
Set the comment.
192

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
193
@item -target type
Diego Biurrun's avatar
Diego Biurrun committed
194 195 196
Specify target file type ("vcd", "svcd", "dvd", "dv", "pal-vcd",
"ntsc-svcd", ... ). All the format options (bitrate, codecs,
buffer sizes) are then set automatically. You can just type:
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
197 198 199 200 201

@example
ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
@end example

Diego Biurrun's avatar
Diego Biurrun committed
202 203
Nevertheless you can specify additional options as long as you know
they do not conflict with the standard, as in:
204 205 206 207 208

@example
ffmpeg -i myfile.avi -target vcd -bf 2 /tmp/vcd.mpg
@end example

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
209
@item -hq
Diego Biurrun's avatar
Diego Biurrun committed
210
Activate high quality settings.
Fabrice Bellard's avatar
Fabrice Bellard committed
211

212
@item -itsoffset offset
Diego Biurrun's avatar
Diego Biurrun committed
213 214 215 216 217 218
Set the input time offset in seconds.
@code{[-]hh:mm:ss[.xxx]} syntax is also supported.
This option affects all the input files that follow it.
The offset is added to the timestamps of the input files.
Specifying a positive offset means that the corresponding
streams are delayed by 'offset' seconds.
219

220 221 222 223
@end table

@section Video Options

224
@table @option
225
@item -b bitrate
Diego Biurrun's avatar
Diego Biurrun committed
226
Set the video bitrate in kbit/s (default = 200 kb/s).
Fabrice Bellard's avatar
Fabrice Bellard committed
227
@item -r fps           
Diego Biurrun's avatar
Diego Biurrun committed
228
Set frame rate (default = 25).
Fabrice Bellard's avatar
Fabrice Bellard committed
229
@item -s size             
Diego Biurrun's avatar
Diego Biurrun committed
230 231
Set frame size. The format is @samp{wxh} (default = 160x128).
The following abbreviations are recognized:
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
232
@table @samp
Fabrice Bellard's avatar
Fabrice Bellard committed
233 234 235 236 237 238 239 240 241 242 243
@item sqcif
128x96
@item qcif
176x144
@item cif
352x288
@item 4cif
704x576
@end table

@item -aspect aspect
Diego Biurrun's avatar
Diego Biurrun committed
244
Set aspect ratio (4:3, 16:9 or 1.3333, 1.7777).
Fabrice Bellard's avatar
Fabrice Bellard committed
245
@item -croptop size
Diego Biurrun's avatar
Diego Biurrun committed
246
Set top crop band size (in pixels).
Fabrice Bellard's avatar
Fabrice Bellard committed
247
@item -cropbottom size
Diego Biurrun's avatar
Diego Biurrun committed
248
Set bottom crop band size (in pixels).
Fabrice Bellard's avatar
Fabrice Bellard committed
249
@item -cropleft size
Diego Biurrun's avatar
Diego Biurrun committed
250
Set left crop band size (in pixels).
Fabrice Bellard's avatar
Fabrice Bellard committed
251
@item -cropright size
Diego Biurrun's avatar
Diego Biurrun committed
252
Set right crop band size (in pixels).
253
@item -padtop size
Diego Biurrun's avatar
Diego Biurrun committed
254
Set top pad band size (in pixels).
255
@item -padbottom size
Diego Biurrun's avatar
Diego Biurrun committed
256
Set bottom pad band size (in pixels).
257
@item -padleft size
Diego Biurrun's avatar
Diego Biurrun committed
258
Set left pad band size (in pixels).
259
@item -padright size
Diego Biurrun's avatar
Diego Biurrun committed
260
Set right pad band size (in pixels).
261
@item -padcolor (hex color)
Diego Biurrun's avatar
Diego Biurrun committed
262 263 264 265
Set color of padded bands. The value for padcolor is expressed
as a six digit hexadecimal number where the first two digits
represent red, the middle two digits green and last two digits
blue (default = 000000 (black)).
266
@item -vn
Diego Biurrun's avatar
Diego Biurrun committed
267
Disable video recording.
268
@item -bt tolerance       
Diego Biurrun's avatar
Diego Biurrun committed
269
Set video bitrate tolerance (in kbit/s).
Fabrice Bellard's avatar
Fabrice Bellard committed
270
@item -maxrate bitrate
Diego Biurrun's avatar
Diego Biurrun committed
271
Set max video bitrate tolerance (in kbit/s).
Fabrice Bellard's avatar
Fabrice Bellard committed
272
@item -minrate bitrate
Diego Biurrun's avatar
Diego Biurrun committed
273
Set min video bitrate tolerance (in kbit/s).
Fabrice Bellard's avatar
Fabrice Bellard committed
274
@item -bufsize size
Diego Biurrun's avatar
Diego Biurrun committed
275
Set rate control buffer size (in kbit).
Fabrice Bellard's avatar
Fabrice Bellard committed
276
@item -vcodec codec       
Diego Biurrun's avatar
Diego Biurrun committed
277
Force video codec to @var{codec}. Use the @code{copy} special value to
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
278
tell that the raw codec data must be copied as is.
Fabrice Bellard's avatar
Fabrice Bellard committed
279
@item -sameq
Diego Biurrun's avatar
Diego Biurrun committed
280
Use same video quality as source (implies VBR).
281 282

@item -pass n  
Diego Biurrun's avatar
Diego Biurrun committed
283 284 285 286
Select the pass number (1 or 2). It is useful to do two pass
encoding. The statistics of the video are recorded in the first
pass and the video is generated at the exact requested bitrate
in the second pass.
287 288

@item -passlogfile file   
Diego Biurrun's avatar
Diego Biurrun committed
289
Set two pass logfile name to @var{file}.
290 291 292

@end table

Fabrice Bellard's avatar
Fabrice Bellard committed
293
@section Advanced Video Options
294

295
@table @option
296
@item -g gop_size         
Diego Biurrun's avatar
Diego Biurrun committed
297
Set the group of pictures size.
298
@item -intra              
Diego Biurrun's avatar
Diego Biurrun committed
299
Use only intra frames.
300
@item -qscale q           
Diego Biurrun's avatar
Diego Biurrun committed
301
Use fixed video quantiser scale (VBR).
302
@item -qmin q             
Diego Biurrun's avatar
Diego Biurrun committed
303
minimum video quantiser scale (VBR)
304
@item -qmax q             
Diego Biurrun's avatar
Diego Biurrun committed
305
maximum video quantiser scale (VBR)
306
@item -qdiff q            
Diego Biurrun's avatar
Diego Biurrun committed
307
maximum difference between the quantiser scales (VBR)
308 309 310 311
@item -qblur blur         
video quantiser scale blur (VBR)
@item -qcomp compression  
video quantiser scale compression (VBR)
Fabrice Bellard's avatar
Fabrice Bellard committed
312 313

@item -rc_init_cplx complexity
Diego Biurrun's avatar
Diego Biurrun committed
314
initial complexity for single pass encoding
Fabrice Bellard's avatar
Fabrice Bellard committed
315
@item -b_qfactor factor
Diego Biurrun's avatar
Diego Biurrun committed
316
qp factor between P- and B-frames
Fabrice Bellard's avatar
Fabrice Bellard committed
317
@item -i_qfactor factor
Diego Biurrun's avatar
Diego Biurrun committed
318
qp factor between P- and I-frames
Fabrice Bellard's avatar
Fabrice Bellard committed
319
@item -b_qoffset offset
Diego Biurrun's avatar
Diego Biurrun committed
320
qp offset between P- and B-frames
Fabrice Bellard's avatar
Fabrice Bellard committed
321
@item -i_qoffset offset
Diego Biurrun's avatar
Diego Biurrun committed
322
qp offset between P- and I-frames
Fabrice Bellard's avatar
Fabrice Bellard committed
323
@item -rc_eq equation
Diego Biurrun's avatar
Diego Biurrun committed
324 325
Set rate control equation (@pxref{FFmpeg formula
evaluator}) (default = @code{tex^qComp}).
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
326 327
@item -rc_override override
rate control override for specific intervals
Fabrice Bellard's avatar
Fabrice Bellard committed
328
@item -me method
Diego Biurrun's avatar
Diego Biurrun committed
329 330
Set motion estimation method to @var{method}.
Available methods are (from lowest to best quality):
Fabrice Bellard's avatar
Fabrice Bellard committed
331 332
@table @samp
@item zero
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
333
Try just the (0, 0) vector.
Fabrice Bellard's avatar
Fabrice Bellard committed
334 335 336 337 338 339 340 341 342 343
@item phods
@item log
@item x1
@item epzs
(default method)
@item full
exhaustive search (slow and marginally better than epzs)
@end table

@item -dct_algo algo
Diego Biurrun's avatar
Diego Biurrun committed
344
Set DCT algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
@table @samp
@item 0
FF_DCT_AUTO (default)
@item 1
FF_DCT_FASTINT
@item 2
FF_DCT_INT
@item 3
FF_DCT_MMX
@item 4
FF_DCT_MLIB
@item 5
FF_DCT_ALTIVEC
@end table

@item -idct_algo algo
Diego Biurrun's avatar
Diego Biurrun committed
361
Set IDCT algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
@table @samp
@item 0
FF_IDCT_AUTO (default)
@item 1
FF_IDCT_INT          
@item 2
FF_IDCT_SIMPLE       
@item 3
FF_IDCT_SIMPLEMMX    
@item 4
FF_IDCT_LIBMPEG2MMX  
@item 5
FF_IDCT_PS2          
@item 6
FF_IDCT_MLIB         
@item 7
FF_IDCT_ARM          
@item 8
FF_IDCT_ALTIVEC      
@item 9
FF_IDCT_SH4          
@item 10
FF_IDCT_SIMPLEARM    
@end table

@item -er n
Diego Biurrun's avatar
Diego Biurrun committed
388
Set error resilience to @var{n}.
Fabrice Bellard's avatar
Fabrice Bellard committed
389 390
@table @samp
@item 1 
Diego Biurrun's avatar
Diego Biurrun committed
391
FF_ER_CAREFUL (default)
Fabrice Bellard's avatar
Fabrice Bellard committed
392
@item 2
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
393
FF_ER_COMPLIANT
Fabrice Bellard's avatar
Fabrice Bellard committed
394 395 396 397 398 399
@item 3
FF_ER_AGGRESSIVE
@item 4
FF_ER_VERY_AGGRESSIVE
@end table

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
400
@item -ec bit_mask
Diego Biurrun's avatar
Diego Biurrun committed
401
Set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
402
the following values:
Fabrice Bellard's avatar
Fabrice Bellard committed
403 404
@table @samp
@item 1
Diego Biurrun's avatar
Diego Biurrun committed
405
FF_EC_GUESS_MVS (default = enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
406
@item 2
Diego Biurrun's avatar
Diego Biurrun committed
407
FF_EC_DEBLOCK (default = enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
408 409 410
@end table

@item -bf frames
Diego Biurrun's avatar
Diego Biurrun committed
411
Use 'frames' B-frames (supported for MPEG-1, MPEG-2 and MPEG-4).
Fabrice Bellard's avatar
Fabrice Bellard committed
412 413 414 415
@item -mbd mode
macroblock decision
@table @samp
@item 0
Diego Biurrun's avatar
Diego Biurrun committed
416
FF_MB_DECISION_SIMPLE: Use mb_cmp (cannot change it yet in FFmpeg).
Fabrice Bellard's avatar
Fabrice Bellard committed
417
@item 1
Diego Biurrun's avatar
Diego Biurrun committed
418
FF_MB_DECISION_BITS: Choose the one which needs the fewest bits.
Fabrice Bellard's avatar
Fabrice Bellard committed
419
@item 2
Diego Biurrun's avatar
Diego Biurrun committed
420
FF_MB_DECISION_RD: rate distortion
Fabrice Bellard's avatar
Fabrice Bellard committed
421 422 423
@end table

@item -4mv
Diego Biurrun's avatar
Diego Biurrun committed
424
Use four motion vector by macroblock (MPEG-4 only).
Fabrice Bellard's avatar
Fabrice Bellard committed
425
@item -part
Diego Biurrun's avatar
Diego Biurrun committed
426
Use data partitioning (MPEG-4 only).
Fabrice Bellard's avatar
Fabrice Bellard committed
427
@item -bug param
Diego Biurrun's avatar
Diego Biurrun committed
428
Work around encoder bugs that are not auto-detected.
Fabrice Bellard's avatar
Fabrice Bellard committed
429
@item -strict strictness
Diego Biurrun's avatar
Diego Biurrun committed
430
How strictly to follow the standards.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
431
@item -aic
Diego Biurrun's avatar
Diego Biurrun committed
432
Enable Advanced intra coding (h263+).
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
433
@item -umv
Diego Biurrun's avatar
Diego Biurrun committed
434
Enable Unlimited Motion Vector (h263+)
Fabrice Bellard's avatar
Fabrice Bellard committed
435 436

@item -deinterlace
Diego Biurrun's avatar
Diego Biurrun committed
437
Deinterlace pictures.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
438
@item -interlace
Diego Biurrun's avatar
Diego Biurrun committed
439 440 441 442 443
Force interlacing support in encoder (MPEG-2 and MPEG-4 only).
Use this option if your input file is interlaced and you want
to keep the interlaced format for minimum losses.
The alternative is to deinterlace the input stream with
@option{-deinterlace}, but deinterlacing introduces losses.
Fabrice Bellard's avatar
Fabrice Bellard committed
444
@item -psnr
Diego Biurrun's avatar
Diego Biurrun committed
445
Calculate PSNR of compressed frames.
Fabrice Bellard's avatar
Fabrice Bellard committed
446
@item -vstats
Diego Biurrun's avatar
Diego Biurrun committed
447
Dump video coding statistics to @file{vstats_HHMMSS.log}.
Fabrice Bellard's avatar
Fabrice Bellard committed
448
@item -vhook module
Diego Biurrun's avatar
Diego Biurrun committed
449
Insert video processing @var{module}. @var{module} contains the module
Fabrice Bellard's avatar
Fabrice Bellard committed
450 451 452 453 454 455 456
name and its parameters separated by spaces.
@end table

@section Audio Options

@table @option
@item -ar freq    
Diego Biurrun's avatar
Diego Biurrun committed
457
Set the audio sampling frequency (default = 44100 Hz).
Fabrice Bellard's avatar
Fabrice Bellard committed
458
@item -ab bitrate 
Diego Biurrun's avatar
Diego Biurrun committed
459
Set the audio bitrate in kbit/s (default = 64).
Fabrice Bellard's avatar
Fabrice Bellard committed
460
@item -ac channels
Diego Biurrun's avatar
Diego Biurrun committed
461
Set the number of audio channels (default = 1).
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
462
@item -an
Diego Biurrun's avatar
Diego Biurrun committed
463
Disable audio recording.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
464
@item -acodec codec
Diego Biurrun's avatar
Diego Biurrun committed
465 466
Force audio codec to @var{codec}. Use the @code{copy} special value to
specify that the raw codec data must be copied as is.
Fabrice Bellard's avatar
Fabrice Bellard committed
467 468 469 470 471 472
@end table

@section Audio/Video grab options

@table @option
@item -vd device
Diego Biurrun's avatar
Diego Biurrun committed
473
sEt video grab device (e.g. @file{/dev/video0}).
Fabrice Bellard's avatar
Fabrice Bellard committed
474
@item -vc channel
Diego Biurrun's avatar
Diego Biurrun committed
475
Set video grab channel (DV1394 only).
Fabrice Bellard's avatar
Fabrice Bellard committed
476
@item -tvstd standard
Diego Biurrun's avatar
Diego Biurrun committed
477
Set television standard (NTSC, PAL (SECAM)).
Fabrice Bellard's avatar
Fabrice Bellard committed
478
@item -dv1394
Diego Biurrun's avatar
Diego Biurrun committed
479
Set DV1394 grab.
Fabrice Bellard's avatar
Fabrice Bellard committed
480
@item -ad device
Diego Biurrun's avatar
Diego Biurrun committed
481
Set audio device (e.g. @file{/dev/dsp}).
Fabrice Bellard's avatar
Fabrice Bellard committed
482 483 484 485 486 487
@end table

@section Advanced options

@table @option
@item -map file:stream    
Diego Biurrun's avatar
Diego Biurrun committed
488
Set input stream mapping.
Fabrice Bellard's avatar
Fabrice Bellard committed
489
@item -debug
Diego Biurrun's avatar
Diego Biurrun committed
490
Print specific debug info.
491
@item -benchmark          
Diego Biurrun's avatar
Diego Biurrun committed
492
Add timings for benchmarking.
493
@item -hex                
Diego Biurrun's avatar
Diego Biurrun committed
494
Dump each input packet.
Fabrice Bellard's avatar
Fabrice Bellard committed
495
@item -bitexact
Diego Biurrun's avatar
Diego Biurrun committed
496
Only use bit exact algorithms (for codec testing).
Fabrice Bellard's avatar
Fabrice Bellard committed
497
@item -ps size
Diego Biurrun's avatar
Diego Biurrun committed
498
Set packet size in bits.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
499
@item -re
Diego Biurrun's avatar
Diego Biurrun committed
500
Read input at native frame rate. Mainly used to simulate a grab device.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
501
@item -loop
Diego Biurrun's avatar
Diego Biurrun committed
502 503
Loop over the input stream. Currently it works only for image
streams. This option is used for automatic FFserver testing.
504
@item -loop_output number_of_times
Diego Biurrun's avatar
Diego Biurrun committed
505
Repeatedly loop output for formats that support looping such as animated GIF
Diego Biurrun's avatar
Diego Biurrun committed
506
(0 will loop the output infinitely).
507
@end table
Fabrice Bellard's avatar
Fabrice Bellard committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566

@node FFmpeg formula evaluator
@section FFmpeg formula evaluator

When evaluating a rate control string, FFmpeg uses an internal formula
evaluator. 

The following binary operators are available: @code{+}, @code{-},
@code{*}, @code{/}, @code{^}.

The following unary operators are available: @code{+}, @code{-},
@code{(...)}.

The following functions are available:
@table @var
@item sinh(x)
@item cosh(x)
@item tanh(x)
@item sin(x)
@item cos(x)
@item tan(x)
@item exp(x)
@item log(x)
@item squish(x)
@item gauss(x)
@item abs(x)
@item max(x, y)
@item min(x, y)
@item gt(x, y)
@item lt(x, y)
@item eq(x, y)
@item bits2qp(bits)
@item qp2bits(qp)
@end table

The following constants are available:
@table @var
@item PI
@item E
@item iTex
@item pTex
@item tex
@item mv
@item fCode
@item iCount
@item mcVar
@item var
@item isI
@item isP
@item isB
@item avgQP
@item qComp
@item avgIITex
@item avgPITex
@item avgPPTex
@item avgBPTex
@item avgTex
@end table

567 568 569 570 571 572 573 574
@c man end

@ignore

@setfilename ffmpeg
@settitle FFmpeg video converter

@c man begin SEEALSO
Diego Biurrun's avatar
Diego Biurrun committed
575
ffserver(1), ffplay(1) and the HTML documentation of @file{ffmpeg}.
576 577 578 579 580 581 582
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore
583 584 585

@section Protocols

Diego Biurrun's avatar
Diego Biurrun committed
586 587
The filename can be @file{-} to read from standard input or to write
to standard output.
588

Diego Biurrun's avatar
Diego Biurrun committed
589
FFmpeg also handles many protocols specified with an URL syntax.
590

Diego Biurrun's avatar
Diego Biurrun committed
591
Use 'ffmpeg -formats' to see a list of the supported protocols.
592

593
The protocol @code{http:} is currently used only to communicate with
Diego Biurrun's avatar
Diego Biurrun committed
594
FFserver (see the FFserver documentation). When FFmpeg will be a
595
video player it will also be used for streaming :-)
596 597 598 599

@chapter Tips

@itemize
Diego Biurrun's avatar
Diego Biurrun committed
600 601
@item For streaming at very low bitrate application, use a low frame rate
and a small GOP size. This is especially true for RealVideo where
602 603
the Linux player does not seem to be very fast, so it can miss
frames. An example is:
604 605

@example
606
ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
607 608 609
@end example

@item  The parameter 'q' which is displayed while encoding is the current
Diego Biurrun's avatar
Diego Biurrun committed
610 611
quantizer. The value 1 indicates that a very good quality could
be achieved. The value 31 indicates the worst quality. If q=31 appears
612
too often, it means that the encoder cannot compress enough to meet
Diego Biurrun's avatar
Diego Biurrun committed
613
your bitrate. You must either increase the bitrate, decrease the
614
frame rate or decrease the frame size.
615 616

@item If your computer is not fast enough, you can speed up the
617 618
compression at the expense of the compression ratio. You can use
'-me zero' to speed up motion estimation, and '-intra' to disable
Diego Biurrun's avatar
Diego Biurrun committed
619
motion estimation completely (you have only I-frames, which means it
620
is about as good as JPEG compression).
621

Diego Biurrun's avatar
Diego Biurrun committed
622
@item To have very low audio bitrates, reduce the sampling frequency
Diego Biurrun's avatar
Diego Biurrun committed
623
(down to 22050 kHz for MPEG audio, 22050 or 11025 for AC3).
624 625

@item To have a constant quality (but a variable bitrate), use the option
626 627
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
quality).
628 629

@item When converting video files, you can use the '-sameq' option which
Diego Biurrun's avatar
Diego Biurrun committed
630 631
uses the same quality factor in the encoder as in the decoder.
It allows almost lossless encoding.
632 633 634 635 636 637 638 639 640

@end itemize

@chapter Supported File Formats and Codecs

You can use the @code{-formats} option to have an exhaustive list.

@section File Formats

641
FFmpeg supports the following file formats through the @code{libavformat}
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
642
library:
643

644
@multitable @columnfractions .4 .1 .1 .4
645 646
@item Supported File Format @tab Encoding @tab Decoding @tab Comments
@item MPEG audio @tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
647
@item MPEG-1 systems @tab X  @tab  X
648
@tab muxed audio and video
Diego Biurrun's avatar
Diego Biurrun committed
649
@item MPEG-2 PS @tab X  @tab  X
650
@tab also known as @code{VOB} file
Diego Biurrun's avatar
Diego Biurrun committed
651
@item MPEG-2 TS @tab    @tab  X
652 653 654 655 656
@tab also known as DVB Transport Stream
@item ASF@tab X @tab X 
@item AVI@tab X @tab X 
@item WAV@tab X @tab X 
@item Macromedia Flash@tab X @tab X
Diego Biurrun's avatar
Diego Biurrun committed
657
@tab Only embedded audio is decoded.
658 659
@item FLV              @tab  X @tab X
@tab Macromedia Flash video files
660 661 662 663 664
@item Real Audio and Video @tab X @tab X 
@item Raw AC3 @tab X  @tab  X 
@item Raw MJPEG @tab X  @tab  X 
@item Raw MPEG video @tab X  @tab  X 
@item Raw PCM8/16 bits, mulaw/Alaw@tab X  @tab  X 
Mike Melanson's avatar
Mike Melanson committed
665
@item Raw CRI ADX audio @tab X  @tab  X 
Mike Melanson's avatar
Mike Melanson committed
666
@item Raw Shorten audio @tab    @tab  X 
667
@item SUN AU format @tab X  @tab  X 
Alex Beregszaszi's avatar
Alex Beregszaszi committed
668
@item NUT @tab X @tab X @tab NUT Open Container Format
Diego Biurrun's avatar
Diego Biurrun committed
669
@item QuickTime        @tab X @tab  X 
Diego Biurrun's avatar
Diego Biurrun committed
670 671
@item MPEG-4           @tab X @tab  X
@tab MPEG-4 is a variant of QuickTime.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
672
@item Raw MPEG4 video  @tab  X @tab  X 
673
@item DV               @tab  X @tab  X
Mike Melanson's avatar
Mike Melanson committed
674
@item 4xm              @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
675
@tab 4X Technologies format, used in some games.
Mike Melanson's avatar
Mike Melanson committed
676 677
@item Playstation STR  @tab    @tab X
@item Id RoQ           @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
678
@tab Used in Quake III, Jedi Knight 2, other computer games.
Mike Melanson's avatar
Mike Melanson committed
679
@item Interplay MVE    @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
680
@tab Format used in various Interplay computer games.
Mike Melanson's avatar
Mike Melanson committed
681
@item WC3 Movie        @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
682
@tab Multimedia format used in Origin's Wing Commander III computer game.
683
@item Sega FILM/CPK    @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
684
@tab Used in many Sega Saturn console games.
685
@item Westwood Studios VQA/AUD  @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
686
@tab Multimedia formats used in Westwood Studios games.
687
@item Id Cinematic (.cin) @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
688
@tab Used in Quake II.
Mike Melanson's avatar
Mike Melanson committed
689 690
@item FLIC format      @tab    @tab X
@tab .fli/.flc files
Mike Melanson's avatar
Mike Melanson committed
691
@item Sierra VMD       @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
692
@tab Used in Sierra CD-ROM games.
693
@item Sierra Online    @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
694
@tab .sol files used in Sierra Online games.
Mike Melanson's avatar
Mike Melanson committed
695
@item Matroska         @tab    @tab X
696
@item Electronic Arts Multimedia    @tab    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
697
@tab Used in various EA games; files have extensions like WVE and UV2.
Mike Melanson's avatar
Mike Melanson committed
698 699
@item Nullsoft Video (NSV) format @tab    @tab X
@end multitable
700

Diego Biurrun's avatar
Diego Biurrun committed
701
@code{X} means that encoding (resp. decoding) is supported.
702

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
703 704 705 706 707
@section Image Formats

FFmpeg can read and write images for each frame of a video sequence. The
following image formats are supported:

708
@multitable @columnfractions .4 .1 .1 .4
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
709 710
@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
@item PGM, PPM     @tab X @tab X 
Diego Biurrun's avatar
Diego Biurrun committed
711
@item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support.
712
@item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
Diego Biurrun's avatar
Diego Biurrun committed
713 714 715 716
@item JPEG         @tab X @tab X @tab Progressive JPEG is not supported.
@item .Y.U.V       @tab X @tab X @tab one raw file per component
@item animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated.
@item PNG          @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet.
717
@item SGI          @tab X @tab X @tab SGI RGB image format
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
718 719
@end multitable

Diego Biurrun's avatar
Diego Biurrun committed
720
@code{X} means that encoding (resp. decoding) is supported.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
721

722 723
@section Video Codecs

724
@multitable @columnfractions .4 .1 .1 .4
725
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
Diego Biurrun's avatar
Diego Biurrun committed
726 727 728
@item MPEG-1 video           @tab  X  @tab  X
@item MPEG-2 video           @tab  X  @tab  X
@item MPEG-4                 @tab  X  @tab  X @tab also known as DivX4/5
729 730
@item MSMPEG4 V1             @tab  X  @tab  X
@item MSMPEG4 V2             @tab  X  @tab  X
Diego Biurrun's avatar
Diego Biurrun committed
731
@item MSMPEG4 V3             @tab  X  @tab  X @tab also known as DivX3
732
@item WMV7                   @tab  X  @tab  X
Diego Biurrun's avatar
Diego Biurrun committed
733
@item WMV8                   @tab  X  @tab  X @tab not completely working
Mike Melanson's avatar
Mike Melanson committed
734
@item H.261                  @tab  X  @tab  X
Diego Biurrun's avatar
Diego Biurrun committed
735
@item H.263(+)               @tab  X  @tab  X @tab also known as RealVideo 1.0
Mike Melanson's avatar
Mike Melanson committed
736
@item H.264                  @tab     @tab  X
737
@item MJPEG                  @tab  X  @tab  X 
Diego Biurrun's avatar
Diego Biurrun committed
738
@item lossless MJPEG         @tab  X  @tab  X
Alex Beregszaszi's avatar
Alex Beregszaszi committed
739 740
@item Apple MJPEG-B          @tab     @tab  X
@item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
741
@item DV                     @tab  X  @tab  X 
Diego Biurrun's avatar
Diego Biurrun committed
742 743 744
@item HuffYUV                @tab  X  @tab  X
@item FFmpeg Video 1         @tab  X  @tab  X @tab experimental lossless codec (fourcc: FFV1)
@item FFmpeg Snow            @tab  X  @tab  X @tab experimental wavelet codec (fourcc: SNOW)
Mike Melanson's avatar
Mike Melanson committed
745
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
Mike Melanson's avatar
Mike Melanson committed
746
@item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
Mike Melanson's avatar
Mike Melanson committed
747
@item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
Mike Melanson's avatar
Mike Melanson committed
748
@item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
Mike Melanson's avatar
Mike Melanson committed
749 750
@item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
@item On2 VP3                @tab     @tab  X @tab still experimental
Alex Beregszaszi's avatar
Alex Beregszaszi committed
751
@item Theora                 @tab     @tab  X @tab still experimental
752
@item Intel Indeo 3          @tab     @tab  X
Alex Beregszaszi's avatar
Alex Beregszaszi committed
753
@item FLV                    @tab  X  @tab  X @tab Sorenson H.263 used in Flash
Mike Melanson's avatar
Mike Melanson committed
754
@item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
Alex Beregszaszi's avatar
Alex Beregszaszi committed
755
@item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
Mike Melanson's avatar
Mike Melanson committed
756
@item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
Diego Biurrun's avatar
Diego Biurrun committed
757
@item 4X Video               @tab     @tab  X @tab Used in certain computer games.
Mike Melanson's avatar
Mike Melanson committed
758
@item Sony Playstation MDEC  @tab     @tab  X 
Diego Biurrun's avatar
Diego Biurrun committed
759 760 761
@item Id RoQ                 @tab     @tab  X @tab Used in Quake III, Jedi Knight 2, other computer games.
@item Xan/WC3                @tab     @tab  X @tab Used in Wing Commander III .MVE files.
@item Interplay Video        @tab     @tab  X @tab Used in Interplay .MVE files.
762
@item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
Mike Melanson's avatar
Mike Melanson committed
763
@item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
764
@item Apple Video            @tab     @tab  X @tab fourcc: rpza
765
@item Apple QuickDraw        @tab     @tab  X @tab fourcc: qdrw
766 767 768
@item Cinepak                @tab     @tab  X
@item Microsoft RLE          @tab     @tab  X
@item Microsoft Video-1      @tab     @tab  X
769
@item Westwood VQA           @tab     @tab  X
Diego Biurrun's avatar
Diego Biurrun committed
770
@item Id Cinematic Video     @tab     @tab  X @tab Used in Quake II.
Roberto Togni's avatar
Roberto Togni committed
771
@item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
Mike Melanson's avatar
Mike Melanson committed
772
@item FLIC video             @tab     @tab  X
773
@item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
Mike Melanson's avatar
Mike Melanson committed
774
@item Duck TrueMotion v2     @tab     @tab  X @tab fourcc: TM20
Diego Biurrun's avatar
Diego Biurrun committed
775
@item VMD Video              @tab     @tab  X @tab Used in Sierra VMD files.
Roberto Togni's avatar
Roberto Togni committed
776 777
@item MSZH                   @tab     @tab  X @tab Part of LCL
@item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
778
@item TechSmith Camtasia     @tab     @tab  X @tab fourcc: TSCC
779
@item IBM Ultimotion         @tab     @tab  X @tab fourcc: ULTI
780
@item Miro VideoXL           @tab     @tab  X @tab fourcc: VIXL
781
@item QPEG                   @tab     @tab  X @tab fourccs: QPEG, Q1.0, Q1.1
782
@item LOCO                   @tab     @tab  X @tab 
783
@item Winnov WNV1            @tab     @tab  X @tab 
784
@item Autodesk Animator Studio Codec  @tab     @tab  X @tab fourcc: AASC
785
@item Fraps FPS1             @tab     @tab  X @tab 
786 787
@end multitable

Diego Biurrun's avatar
Diego Biurrun committed
788
@code{X} means that encoding (resp. decoding) is supported.
789

Diego Biurrun's avatar
Diego Biurrun committed
790 791 792
See @url{http://www.mplayerhq.hu/~michael/codec-features.html} to
get a precise comparison of the FFmpeg MPEG-4 codec compared to
other implementations.
Fabrice Bellard's avatar
Fabrice Bellard committed
793

794 795 796 797 798 799
@section Audio Codecs

@multitable @columnfractions .4 .1 .1 .1 .7
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
@item MPEG audio layer 2     @tab  IX  @tab  IX 
@item MPEG audio layer 1/3   @tab IX   @tab  IX
Diego Biurrun's avatar
Diego Biurrun committed
800
@tab MP3 encoding is supported through the external library LAME.
801
@item AC3                    @tab  IX  @tab  IX
Diego Biurrun's avatar
Diego Biurrun committed
802
@tab liba52 is used internally for decoding.
803
@item Vorbis                 @tab  X   @tab  X
Diego Biurrun's avatar
Diego Biurrun committed
804
@tab Supported through the external library libvorbis.
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
805
@item WMA V1/V2              @tab      @tab X
806
@item AAC                    @tab X    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
807
@tab Supported through the external library libfaac/libfaad.
Michael Niedermayer's avatar
Michael Niedermayer committed
808
@item Microsoft ADPCM        @tab X    @tab X
Mike Melanson's avatar
Mike Melanson committed
809 810 811
@item MS IMA ADPCM           @tab X    @tab X
@item QT IMA ADPCM           @tab      @tab X
@item 4X IMA ADPCM           @tab      @tab X
Roman Shaposhnik's avatar
Roman Shaposhnik committed
812
@item G.726  ADPCM           @tab X    @tab X
Mike Melanson's avatar
Mike Melanson committed
813
@item Duck DK3 IMA ADPCM     @tab      @tab X
Diego Biurrun's avatar
Diego Biurrun committed
814
@tab Used in some Sega Saturn console games.
Mike Melanson's avatar
Mike Melanson committed
815
@item Duck DK4 IMA ADPCM     @tab      @tab X
Diego Biurrun's avatar
Diego Biurrun committed
816
@tab Used in some Sega Saturn console games.
817
@item Westwood Studios IMA ADPCM @tab      @tab X
Diego Biurrun's avatar
Diego Biurrun committed
818
@tab Used in Westwood Studios games like Command and Conquer.
819
@item SMJPEG IMA ADPCM       @tab      @tab X
Diego Biurrun's avatar
Diego Biurrun committed
820
@tab Used in certain Loki game ports.
Mike Melanson's avatar
Mike Melanson committed
821 822
@item CD-ROM XA ADPCM        @tab      @tab X
@item CRI ADX ADPCM          @tab X    @tab X
Diego Biurrun's avatar
Diego Biurrun committed
823
@tab Used in Sega Dreamcast games.
824
@item Electronic Arts ADPCM  @tab      @tab X
Diego Biurrun's avatar
Diego Biurrun committed
825
@tab Used in various EA titles.
826
@item Creative ADPCM         @tab      @tab X
827 828 829 830
@item RA144                  @tab      @tab X
@tab Real 14400 bit/s codec
@item RA288                  @tab      @tab X
@tab Real 28800 bit/s codec
Benjamin Larsson's avatar