ffmpeg-doc.texi 17.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
\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
that ffmpeg tries to figure out all the parameters, when
possible. You have usually to give only the target bitrate you want.

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

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

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

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

35 36 37 38 39
Note that you must activate the right video source and channel before
launching ffmpeg. You can use any TV viewer such as xawtv
(@url{http://bytesex.org/xawtv/}) by Gerd Knorr which I find very
good. You must also set correctly the audio recording levels with a
standard mixer.
40

41
@section Video and Audio file format conversion
42 43 44 45 46 47 48 49

* ffmpeg can use any supported file format and protocol as input: 

Examples:

* You can input from YUV files:

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

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

59 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
if ffmpeg cannot guess it.
63 64 65 66

* You can input from a RAW YUV420P file:

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

70 71 72
The RAW YUV420P is a file containing RAW YUV planar, for each frame first
come the Y plane followed by U and V planes, which are half vertical and
horizontal resolution.
73 74 75 76

* You can output to a RAW YUV420P file:

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

* You can set several input files and output files:

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

86 87
Convert the audio file a.wav and the raw yuv video file a.yuv
to mpeg file a.mpg
88

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

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

95
Convert the sample rate of a.wav to 22050 Hz and encode it to MPEG audio.
96 97

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

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

104 105 106
Convert a.wav to a.mp2 at 64 kbits and b.mp2 at 128 kbits. '-map
file:index' specify which input stream is used for each output
stream, in the order of the definition of output streams.
107 108 109 110

* You can transcode decrypted VOBs

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

114 115 116 117 118 119 120 121
This is a typical DVD ripper example, input from a VOB file, output
to 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, GOP
size is 300 that means an INTRA frame every 10 seconds for 29.97 fps
input video.  Also the audio stream is MP3 encoded so you need LAME
support which is enabled using @code{--enable-mp3lame} when
configuring.  The mapping is particularly useful for DVD transcoding
to get the desired audio language.
122

123 124
NOTE: to see the supported input formats, use @code{ffmpeg -formats}.
@c man end
125 126 127 128 129

@chapter Invocation

@section Syntax

130
The generic syntax is:
131 132

@example 
133 134 135
@c man begin SYNOPSIS
ffmpeg [[options][@option{-i} @var{input_file}]]... @{[options] @var{output_file}@}...
@c man end
136
@end example
137 138
@c man begin DESCRIPTION
If no input file is given, audio/video grabbing is done.
139

140 141 142 143
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
bitrate of the next file. Format option may be needed for raw input
files.
144

145 146 147 148
By default, ffmpeg tries to convert as losslessly as possible: it
uses the same audio and video parameter for the outputs as the one
specified for the inputs.
@c man end
149

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

153
@table @option
154 155 156
@item -L
show license
@item -h
157 158
show help
@item -formats
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
show available formats, codecs, protocols, ...
@item -f fmt              
force format
@item -i filename         
input file name

@item -y                  
overwrite output files

@item -t duration         
set the recording time in seconds. @code{hh:mm:ss[.xxx]} syntax is also
supported.

@item -title string       
set the title

@item -author string      
set the author

@item -copyright string   
set the copyright

@item -comment string     
set the comment

@end table

@section Video Options

188
@table @option
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
@item -s size             
set frame size                       [160x128]
@item -r fps           
set frame rate                       [25]
@item -b bitrate
set the video bitrate in kbit/s      [200]
@item -vn
disable video recording              [no]
@item -bt tolerance       
set video bitrate tolerance (in kbit/s)
@item -sameq              
use same video quality as source (implies VBR)

@item -pass n  
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 at the exact requested bit rate is generated in the second pass.

@item -passlogfile file   
select two pass log file name

@end table

@section Audio Options

212
@table @option
213 214 215 216 217 218 219 220 221 222 223 224 225 226
@item -ab bitrate         
set audio bitrate (in kbit/s)
@item -ar freq    
 set the audio sampling freq          [44100]
@item -ab bitrate 
 set the audio bitrate in kbit/s      [64]
@item -ac channels
 set the number of audio channels     [1]
@item -an     
 disable audio recording              [no]
@end table

@section Advanced options

227
@table @option
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
@item -map file:stream    
set input stream mapping
@item -g gop_size         
set the group of picture size
@item -intra              
use only intra frames
@item -qscale q           
use fixed video quantiser scale (VBR)
@item -qmin q             
min video quantiser scale (VBR)
@item -qmax q             
max video quantiser scale (VBR)
@item -qdiff q            
max difference between the quantiser scale (VBR)
@item -qblur blur         
video quantiser scale blur (VBR)
@item -qcomp compression  
video quantiser scale compression (VBR)
@item -vd device          
set video device
@item -vcodec codec       
force video codec
@item -me method          
set motion estimation method
@item -bf frames          
use 'frames' B frames (only MPEG-4)
@item -hq                 
activate high quality settings
@item -4mv                
use four motion vector by macroblock (only MPEG-4)
@item -ad device          
set audio device
@item -acodec codec       
force audio codec
@item -deinterlace        
deinterlace pictures
@item -benchmark          
add timings for benchmarking
@item -hex                
dump each input packet
@item -psnr               
calculate PSNR of compressed frames
@item -vstats             
dump video coding statistics to file
@end table
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
@c man end

@ignore

@setfilename ffmpeg
@settitle FFmpeg video converter

@c man begin SEEALSO
ffserver(1), ffplay(1) and the html documentation of @file{ffmpeg}.
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore
289 290 291

@section Protocols

Fabrice Bellard's avatar
Fabrice Bellard committed
292 293
The filename can be @file{-} to read from the standard input or to write
to the standard output.
294 295 296

ffmpeg handles also many protocols specified with the URL syntax.

297
Use 'ffmpeg -formats' to have a list of the supported protocols.
298

299 300 301
The protocol @code{http:} is currently used only to communicate with
ffserver (see the ffserver documentation). When ffmpeg will be a
video player it will also be used for streaming :-)
302 303 304 305 306

@chapter Tips

@itemize
@item For streaming at very low bit rate application, use a low frame rate
307 308 309
and a small gop size. This is especially true for real video where
the Linux player does not seem to be very fast, so it can miss
frames. An example is:
310 311

@example
312
ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
313 314 315
@end example

@item  The parameter 'q' which is displayed while encoding is the current
316 317 318 319 320
quantizer. The value of 1 indicates that a very good quality could
be achieved. The value of 31 indicates the worst quality. If q=31
too often, it means that the encoder cannot compress enough to meet
your bit rate. You must either increase the bit rate, decrease the
frame rate or decrease the frame size.
321 322

@item If your computer is not fast enough, you can speed up the
323 324 325 326
compression at the expense of the compression ratio. You can use
'-me zero' to speed up motion estimation, and '-intra' to disable
completely motion estimation (you have only I frames, which means it
is about as good as JPEG compression).
327 328

@item To have very low bitrates in audio, reduce the sampling frequency
329
(down to 22050 kHz for mpeg audio, 22050 or 11025 for ac3).
330 331

@item To have a constant quality (but a variable bitrate), use the option
332 333
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
quality).
334 335

@item When converting video files, you can use the '-sameq' option which
336 337
uses in the encoder the same quality factor than in the decoder. It
allows to be almost lossless in encoding.
338 339 340 341 342 343 344 345 346

@end itemize

@chapter Supported File Formats and Codecs

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

@section File Formats

347
FFmpeg supports the following file formats through the @code{libavformat}
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
348
library:
349 350 351 352 353 354 355 356 357 358 359 360 361 362 363

@multitable @columnfractions .4 .1 .1
@item Supported File Format @tab Encoding @tab Decoding @tab Comments
@item MPEG audio @tab X @tab X
@item MPEG1 systems @tab X  @tab  X 
@tab muxed audio and video
@item MPEG2 PS @tab X  @tab  X 
@tab also known as @code{VOB} file
@item MPEG2 TS @tab    @tab  X 
@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
@tab Only embedded audio is decoded
364 365
@item FLV              @tab  X @tab X
@tab Macromedia Flash video files
366 367 368 369 370 371 372 373 374
@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 
@item SUN AU format @tab X  @tab  X 
@item Quicktime        @tab   @tab  X 
@item MPEG4            @tab  @tab  X 
@tab MPEG4 is a variant of Quicktime
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
375
@item Raw MPEG4 video  @tab  X @tab  X 
376
@item DV               @tab  @tab X
Mike Melanson's avatar
Mike Melanson committed
377 378
@item 4xm              @tab    @tab X
@tab 4X Technologies format, used in some games
379 380 381 382
@end multitable

@code{X} means that the encoding (resp. decoding) is supported.

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
383 384 385 386 387 388 389 390
@section Image Formats

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

@multitable @columnfractions .4 .1 .1
@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
@item PGM, PPM     @tab X @tab X 
391 392
@item PAM          @tab X @tab X @tab PAM is a PNM extension with alpha support
@item PGMYUV       @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
393 394
@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
395 396
@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
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
397 398 399 400
@end multitable

@code{X} means that the encoding (resp. decoding) is supported.

401 402 403 404
@section Video Codecs

@multitable @columnfractions .4 .1 .1 .7
@item Supported Codec @tab Encoding @tab Decoding @tab Comments
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
405
@item MPEG1 video            @tab  X  @tab  X
406 407 408 409 410 411
@item MPEG2 video            @tab     @tab  X 
@item MPEG4                  @tab  X  @tab  X @tab Also known as DIVX4/5
@item MSMPEG4 V1             @tab  X  @tab  X
@item MSMPEG4 V2             @tab  X  @tab  X
@item MSMPEG4 V3             @tab  X  @tab  X @tab Also known as DIVX3
@item WMV7                   @tab  X  @tab  X
Mike Melanson's avatar
Mike Melanson committed
412
@item WMV8                   @tab  X  @tab  X @tab Not completely working
413 414 415
@item H263(+)                @tab  X  @tab  X @tab Also known as Real Video 1.0
@item MJPEG                  @tab  X  @tab  X 
@item DV                     @tab     @tab  X 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
416
@item Huff YUV               @tab  X  @tab  X
Mike Melanson's avatar
Mike Melanson committed
417 418 419 420 421 422 423
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
@item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
@item H.264                  @tab     @tab  X
@item Sorenson Video 1       @tab     @tab  X @tab fourcc: SVQ1
@item Sorenson Video 3       @tab     @tab  X @tab fourcc: SVQ3
@item On2 VP3                @tab     @tab  X @tab still experimental
@item Intel Indeo 3          @tab     @tab  X @tab only works on i386 right now
424
@item FLV                    @tab  X  @tab  X @tab Flash H263 variant
425 426 427 428
@end multitable

@code{X} means that the encoding (resp. decoding) is supported.

Fabrice Bellard's avatar
Fabrice Bellard committed
429 430 431 432
Check at @url{http://www.mplayerhq.hu/~michael/codec-features.html} to
get a precise comparison of FFmpeg MPEG4 codec compared to the other
solutions.

433 434 435 436 437 438
@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
439
@tab MP3 encoding is supported through the external library LAME
440
@item AC3                    @tab  IX  @tab  X
441
@tab liba52 is used internally for decoding
442
@item Vorbis                 @tab  X   @tab  X
443
@tab supported through the external library libvorbis
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
444
@item WMA V1/V2              @tab      @tab X
Mike Melanson's avatar
Mike Melanson committed
445 446
@item Microsoft ADPCM        @tab X    @tab X
@item IMA ADPCM              @tab X    @tab X
447 448 449 450 451 452 453
@item RA144                  @tab      @tab X
@tab Real 14400 bit/s codec
@item RA288                  @tab      @tab X
@tab Real 28800 bit/s codec
@item AMR-NB                 @tab X    @tab X
@tab supported through an external library
@item DV audio               @tab      @tab X
454 455 456 457 458 459 460
@end multitable

@code{X} means that the encoding (resp. decoding) is supported.

@code{I} means that an integer only version is available too (ensures highest
performances on systems without hardware floating point support).

Fabrice Bellard's avatar
Fabrice Bellard committed
461 462 463 464 465
@chapter Platform Specific information

@section Linux

ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
466
preferred compiler now for ffmpeg. All future optimizations will depend on
Fabrice Bellard's avatar
Fabrice Bellard committed
467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
features only found in GCC 3.2.

@section BSD

@section Windows

@section MacOS X

@section BeOS

The configure script should guess the configuration itself.
Networking support is currently not finished.
errno issues fixed by Andrew Bachmann.

Old stuff:

François Revol - revol at free dot fr - April 2002

The configure script should guess the configuration itself, 
however I still didn't tested building on net_server version of BeOS.

ffserver is broken (needs poll() implementation).

There is still issues with errno codes, which are negative in BeOs, and
that ffmpeg negates when returning. This ends up turning errors into 
valid results, then crashes.
(To be fixed)

495
@chapter Developers Guide
496 497 498 499 500 501 502

@section API
@itemize
@item libavcodec is the library containing the codecs (both encoding and
  decoding). See @file{libavcodec/apiexample.c} to see how to use it.

@item libavformat is the library containing the file formats handling (mux and
503 504 505 506
  demux code for several formats). See @file{ffplay.c} to use it in a
player. See @file{output_example.c} to use it to generate audio or video
streams.

507 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
@end itemize

@section Integrating libavcodec or libavformat in your program

You can integrate all the source code of the libraries to link them
statically to avoid any version problem. All you need is to provide a
'config.mak' and a 'config.h' in the parent directory. See the defines
generated by ./configure to understand what is needed.

You can use libavcodec or libavformat in your commercial program, but
@emph{any patch you make must be published}. The best way to proceed is
to send your patches to the ffmpeg mailing list.

@section Coding Rules

ffmpeg is programmed in ANSI C language. GCC extensions are
tolerated. Indent size is 4. The TAB character should not be used.

The presentation is the one specified by 'indent -i4 -kr'.

Main priority in ffmpeg is simplicity and small code size (=less
bugs).

Comments: for functions visible from other modules, use the JavaDoc
format (see examples in @file{libav/utils.c}) so that a documentation
can be generated automatically.

@section Submitting patches

When you submit your patch, try to send a unified diff (diff '-u'
option). I cannot read other diffs :-)

Run the regression tests before submitting a patch so that you can
540
verify that there are no big problems.
541 542 543 544 545 546 547 548

Patches should be posted as base64 encoded attachments (or any other
encoding which ensures that the patch wont be trashed during 
transmission) to the ffmpeg-devel mailinglist, see 
@url{http://lists.sourceforge.net/lists/listinfo/ffmpeg-devel}

@section Regression tests

549
Before submitting a patch (or committing with CVS), you should at least
550 551 552
test that you did not break anything.

The regression test build a synthetic video stream and a synthetic
553
audio stream. Then these are encoded then decoded with all codecs or
554 555 556 557
formats. The CRC (or MD5) of each generated file is recorded in a
result file. Then a 'diff' is launched with the reference results and
the result file.

558 559 560 561
The regression test then goes on to test the ffserver code with a 
limited set of streams. It is important that this step runs correctly
as well.

562 563 564 565 566 567 568 569 570
Run 'make test' to test all the codecs.

Run 'make libavtest' to test all the codecs.

[Of course, some patches may change the regression tests results. In
this case, the regression tests reference results shall be modified
accordingly].

@bye