ffmpeg-doc.texi 25.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
@item -L
show license
Fabrice Bellard's avatar
Fabrice Bellard committed
156

157
@item -h
158
show help
Fabrice Bellard's avatar
Fabrice Bellard committed
159

160
@item -formats
161
show available formats, codecs, protocols, ...
Fabrice Bellard's avatar
Fabrice Bellard committed
162

163 164
@item -f fmt              
force format
Fabrice Bellard's avatar
Fabrice Bellard committed
165

166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
@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

Fabrice Bellard's avatar
Fabrice Bellard committed
188 189 190
@item -hq                 
activate high quality settings

191 192 193 194
@end table

@section Video Options

195
@table @option
196
@item -b bitrate
Fabrice Bellard's avatar
Fabrice Bellard committed
197 198 199 200
set the video bitrate in kbit/s (default = 200 kb/s)
@item -r fps           
set frame rate (default = 25)
@item -s size             
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
201 202 203
set frame size. The format is @samp{WxH} (default 160x128).  The
following abbreviations are recognized:
@table @samp
Fabrice Bellard's avatar
Fabrice Bellard committed
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
@item sqcif
128x96
@item qcif
176x144
@item cif
352x288
@item 4cif
704x576
@end table

@item -aspect aspect
set aspect ratio (4:3, 16:9 or 1.3333, 1.7777)
@item -croptop size
set top crop band size (in pixels)
@item -cropbottom size
set bottom crop band size (in pixels)
@item -cropleft size
set left crop band size (in pixels)
@item -cropright size
set right crop band size (in pixels)
224
@item -vn
Fabrice Bellard's avatar
Fabrice Bellard committed
225
disable video recording
226 227
@item -bt tolerance       
set video bitrate tolerance (in kbit/s)
Fabrice Bellard's avatar
Fabrice Bellard committed
228 229 230 231 232 233 234
@item -maxrate bitrate
set max video bitrate tolerance (in kbit/s)
@item -minrate bitrate
set min video bitrate tolerance (in kbit/s)
@item -bufsize size
set ratecontrol buffere size (in kbit)
@item -vcodec codec       
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
235 236
force video codec to @var{codec}. Use the @code{copy} special value to
tell that the raw codec data must be copied as is.
Fabrice Bellard's avatar
Fabrice Bellard committed
237
@item -sameq
238 239 240
use same video quality as source (implies VBR)

@item -pass n  
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
241 242 243 244
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.
245 246

@item -passlogfile file   
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
247
select two pass log file name to @var{file}.
248 249 250

@end table

Fabrice Bellard's avatar
Fabrice Bellard committed
251
@section Advanced Video Options
252

253
@table @option
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
@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)
Fabrice Bellard's avatar
Fabrice Bellard committed
270 271 272 273 274 275 276 277 278 279 280 281

@item -rc_init_cplx complexity
initial complexity for 1-pass encoding
@item -b_qfactor factor
qp factor between p and b frames
@item -i_qfactor factor
qp factor between p and i frames
@item -b_qoffset offset
qp offset between p and b frames
@item -i_qoffset offset
qp offset between p and i frames
@item -rc_eq equation
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
282 283 284 285
set rate control equation (@pxref{FFmpeg formula
evaluator}). Default is @code{tex^qComp}.
@item -rc_override override
rate control override for specific intervals
Fabrice Bellard's avatar
Fabrice Bellard committed
286
@item -me method
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
287 288
set motion estimation method to @var{method}. Available methods are
(from lower to best quality):
Fabrice Bellard's avatar
Fabrice Bellard committed
289 290
@table @samp
@item zero
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
291
Try just the (0, 0) vector.
Fabrice Bellard's avatar
Fabrice Bellard committed
292 293 294 295 296 297 298 299 300 301
@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
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
302
set dct algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
@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
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
319
set idct algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
@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
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
346
set error resilience to @var{n}.
Fabrice Bellard's avatar
Fabrice Bellard committed
347 348
@table @samp
@item 1 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
349
FF_ER_CAREFULL (default)
Fabrice Bellard's avatar
Fabrice Bellard committed
350
@item 2
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
351
FF_ER_COMPLIANT
Fabrice Bellard's avatar
Fabrice Bellard committed
352 353 354 355 356 357
@item 3
FF_ER_AGGRESSIVE
@item 4
FF_ER_VERY_AGGRESSIVE
@end table

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
358 359 360
@item -ec bit_mask
set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
the following values:
Fabrice Bellard's avatar
Fabrice Bellard committed
361 362
@table @samp
@item 1
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
363
FF_EC_GUESS_MVS (default=enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
364
@item 2
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
365
FF_EC_DEBLOCK (default=enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
366 367 368
@end table

@item -bf frames
Fabrice Bellard's avatar
Fabrice Bellard committed
369
use 'frames' B frames (supported for MPEG-1, MPEG-2 and MPEG-4)
Fabrice Bellard's avatar
Fabrice Bellard committed
370 371 372 373 374 375 376 377 378 379 380 381
@item -mbd mode
macroblock decision
@table @samp
@item 0
FF_MB_DECISION_SIMPLE: use mb_cmp (cannot change it yet in ffmpeg)
@item 1
FF_MB_DECISION_BITS: chooses the one which needs the fewest bits
@item 2
FF_MB_DECISION_RD: rate distoration
@end table

@item -4mv
382
use four motion vector by macroblock (only MPEG-4)
Fabrice Bellard's avatar
Fabrice Bellard committed
383 384 385 386 387 388
@item -part
use data partitioning (only MPEG-4)
@item -bug param
workaround not auto detected encoder bugs
@item -strict strictness
how strictly to follow the standarts
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
389 390 391 392
@item -aic
enable Advanced intra coding (h263+)
@item -umv
enable Unlimited Motion Vector (h263+)
Fabrice Bellard's avatar
Fabrice Bellard committed
393 394 395 396 397 398

@item -deinterlace
deinterlace pictures
@item -psnr
calculate PSNR of compressed frames
@item -vstats
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
399
dump video coding statistics to @file{vstats_HHMMSS.log}.
Fabrice Bellard's avatar
Fabrice Bellard committed
400 401 402 403 404 405 406 407 408 409 410
@item -vhook module
insert video processing @var{module}. @var{module} contains the module
name and its parameters separated by spaces.
@end table

@section Audio Options

@table @option
@item -ab bitrate         
set audio bitrate (in kbit/s)
@item -ar freq    
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
411
set the audio sampling freq (default = 44100 Hz)
Fabrice Bellard's avatar
Fabrice Bellard committed
412
@item -ab bitrate 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
413
set the audio bitrate in kbit/s (default = 64)
Fabrice Bellard's avatar
Fabrice Bellard committed
414
@item -ac channels
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
415 416 417 418 419 420
set the number of audio channels (default = 1)
@item -an
disable audio recording
@item -acodec codec
force audio codec to @var{codec}. Use the @code{copy} special value to
tell that the raw codec data must be copied as is.
Fabrice Bellard's avatar
Fabrice Bellard committed
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444
@end table

@section Audio/Video grab options

@table @option
@item -vd device
set video grab device (e.g. @file{/dev/video0})
@item -vc channel
set video grab channel (DV1394 only)
@item -tvstd standard
set television standard (NTSC, PAL (SECAM))
@item -dv1394
set DV1394 grab
@item -ad device
set audio device (e.g. @file{/dev/dsp})
@end table

@section Advanced options

@table @option
@item -map file:stream    
set input stream mapping
@item -debug
print specific debug info
445 446 447 448
@item -benchmark          
add timings for benchmarking
@item -hex                
dump each input packet
Fabrice Bellard's avatar
Fabrice Bellard committed
449 450 451 452
@item -bitexact
only use bit exact algorithms (for codec testing)
@item -ps size
set packet size in bits
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
453 454 455 456 457
@item -re
read input at native frame rate. Mainly used to simulate a grab device.
@item -loop
loop over the input stream. Currently it works only for image
streams. This option is used for ffserver automatic testing.
458
@end table
Fabrice Bellard's avatar
Fabrice Bellard committed
459 460 461 462 463 464 465 466 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 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517

@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

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
@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
534 535 536

@section Protocols

Fabrice Bellard's avatar
Fabrice Bellard committed
537 538
The filename can be @file{-} to read from the standard input or to write
to the standard output.
539 540 541

ffmpeg handles also many protocols specified with the URL syntax.

542
Use 'ffmpeg -formats' to have a list of the supported protocols.
543

544 545 546
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 :-)
547 548 549 550 551

@chapter Tips

@itemize
@item For streaming at very low bit rate application, use a low frame rate
552 553 554
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:
555 556

@example
557
ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
558 559 560
@end example

@item  The parameter 'q' which is displayed while encoding is the current
561 562 563 564 565
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.
566 567

@item If your computer is not fast enough, you can speed up the
568 569 570 571
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).
572 573

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

@item To have a constant quality (but a variable bitrate), use the option
577 578
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
quality).
579 580

@item When converting video files, you can use the '-sameq' option which
581 582
uses in the encoder the same quality factor than in the decoder. It
allows to be almost lossless in encoding.
583 584 585 586 587 588 589 590 591

@end itemize

@chapter Supported File Formats and Codecs

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

@section File Formats

592
FFmpeg supports the following file formats through the @code{libavformat}
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
593
library:
594 595 596 597 598 599 600 601 602 603 604 605 606 607 608

@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
609 610
@item FLV              @tab  X @tab X
@tab Macromedia Flash video files
611 612 613 614 615 616
@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 
617 618
@item Quicktime        @tab X @tab  X 
@item MPEG4            @tab X @tab  X 
619
@tab MPEG4 is a variant of Quicktime
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
620
@item Raw MPEG4 video  @tab  X @tab  X 
621
@item DV               @tab  @tab X
Mike Melanson's avatar
Mike Melanson committed
622 623
@item 4xm              @tab    @tab X
@tab 4X Technologies format, used in some games
Mike Melanson's avatar
Mike Melanson committed
624 625 626 627 628
@item Playstation STR  @tab    @tab X
@item Id RoQ           @tab    @tab X
@tab used in Quake III, Jedi Knight 2, other computer games
@item Interplay MVE    @tab    @tab X
@tab format used in various Interplay computer games
Mike Melanson's avatar
Mike Melanson committed
629 630
@item WC3 Movie        @tab    @tab X
@tab multimedia format used in Origin's Wing Commander III computer game
631 632 633 634
@end multitable

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

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
635 636 637 638 639 640 641 642
@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 
643 644
@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
645 646
@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
647 648
@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
649 650 651 652
@end multitable

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

653 654 655 656
@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
657
@item MPEG1 video            @tab  X  @tab  X
Fabrice Bellard's avatar
Fabrice Bellard committed
658
@item MPEG2 video            @tab  X  @tab  X 
659 660 661 662 663
@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
664
@item WMV8                   @tab  X  @tab  X @tab Not completely working
665 666 667
@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
668
@item Huff YUV               @tab  X  @tab  X
Mike Melanson's avatar
Mike Melanson committed
669
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
Mike Melanson's avatar
Mike Melanson committed
670
@item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
Mike Melanson's avatar
Mike Melanson committed
671 672 673 674 675 676
@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
677
@item FLV                    @tab  X  @tab  X @tab Flash H263 variant
Mike Melanson's avatar
Mike Melanson committed
678 679 680 681 682
@item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
@item Cirrus Logic AccuPak   @tab     @tab  X @tab fourcc: CLJR
@item 4X Video               @tab     @tab  X @tab used in certain computer games
@item Sony Playstation MDEC  @tab     @tab  X 
@item Id RoQ                 @tab     @tab  X @tab used in Quake III, Jedi Knight 2, other computer games
Mike Melanson's avatar
Mike Melanson committed
683
@item Xan/WC3                @tab     @tab  X @tab used in Wing Commander III .MVE files
684
@item Interplay Video        @tab     @tab  X @tab used in Interplay .MVE files
685 686 687 688
@end multitable

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

Fabrice Bellard's avatar
Fabrice Bellard committed
689 690 691 692
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.

693 694 695 696 697 698
@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
699
@tab MP3 encoding is supported through the external library LAME
700
@item AC3                    @tab  IX  @tab  X
701
@tab liba52 is used internally for decoding
702
@item Vorbis                 @tab  X   @tab  X
703
@tab supported through the external library libvorbis
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
704
@item WMA V1/V2              @tab      @tab X
Mike Melanson's avatar
Mike Melanson committed
705
@item Microsoft ADPCM        @tab X    @tab X
Mike Melanson's avatar
Mike Melanson committed
706 707 708
@item MS IMA ADPCM           @tab X    @tab X
@item QT IMA ADPCM           @tab      @tab X
@item 4X IMA ADPCM           @tab      @tab X
Mike Melanson's avatar
Mike Melanson committed
709 710 711 712
@item Duck DK3 IMA ADPCM     @tab      @tab X
@tab used in some Sega Saturn console games
@item Duck DK4 IMA ADPCM     @tab      @tab X
@tab used in some Sega Saturn console games
713 714 715 716 717 718 719
@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
Mike Melanson's avatar
Mike Melanson committed
720 721 722 723
@item Id RoQ DPCM            @tab      @tab X
@tab used in Quake III, Jedi Knight 2, other computer games
@item Interplay MVE DPCM     @tab      @tab X
@tab used in various Interplay computer games
Mike Melanson's avatar
Mike Melanson committed
724 725
@item Xan DPCM               @tab      @tab X
@tab used in Origin's Wing Commander IV AVI files
726 727 728 729 730 731 732
@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
733 734 735 736 737
@chapter Platform Specific information

@section Linux

ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
738
preferred compiler now for ffmpeg. All future optimizations will depend on
Fabrice Bellard's avatar
Fabrice Bellard committed
739 740 741 742 743 744
features only found in GCC 3.2.

@section BSD

@section Windows

745 746 747 748 749 750 751
@subsection Native Windows compilation

@itemize
@item Install the current versions of MSYS and MinGW from
@url{http://www.mingw.org/}. You can find detailed installation
instructions in the download section and the FAQ.

Fabrice Bellard's avatar
Fabrice Bellard committed
752 753 754 755 756 757 758 759
@item If you want to test the FFmpeg Simple Media Player, also download 
the MinGW development library of SDL 1.2.x
(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
@url{http://www.libsdl.org}. Unpack it in a temporary place, and
unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
directory.

@item Extract the current version of FFmpeg (the latest release version or the current CVS snapshot whichever is recommended).
760 761 762
 
@item Start the MSYS shell (file @file{msys.bat}).

Fabrice Bellard's avatar
Fabrice Bellard committed
763 764 765 766 767 768 769 770
@item Change to the FFMPEG directory and follow
 the instructions of how to compile ffmpeg (file
@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
suffices. If you have problems using SDL, verify that
@file{sdl-config} can be launched from the MSYS command line.

@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}.

771 772
@end itemize

Fabrice Bellard's avatar
Fabrice Bellard committed
773 774
Note: The target @file{make wininstaller} can be used to create a Nullsoft based Windows installer for FFmpeg and FFplay.

775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
@subsection How to create a single Windows DLL from libavcodec and libavformat
 
Read @url{http://ffmpeg.org/win32.html}.

@subsection Cross compilation for Windows with Linux

You must use the MinGW cross compilation tools available at
@url{http://www.mingw.org/}.

Then configure ffmpeg with the following options:
@example
./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
@end example
(you can change the cross-prefix according to the prefix choosen for the
MinGW tools).

Then you can easily test ffmpeg with wine
(@url{http://www.winehq.com/}).

Fabrice Bellard's avatar
Fabrice Bellard committed
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
@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)

816
@chapter Developers Guide
817 818 819 820 821 822 823

@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
824 825 826 827
  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.

828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
@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
861
verify that there are no big problems.
862 863 864 865 866 867 868 869

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

870
Before submitting a patch (or committing with CVS), you should at least
871 872 873
test that you did not break anything.

The regression test build a synthetic video stream and a synthetic
874
audio stream. Then these are encoded then decoded with all codecs or
875 876 877 878
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.

879 880 881 882
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.

883 884
Run 'make test' to test all the codecs.

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
885
Run 'make fulltest' to test all the codecs, formats and ffserver.
886 887 888 889 890 891

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

@bye