ffmpeg-doc.texi 33.2 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
@c man begin SYNOPSIS
Michael Niedermayer's avatar
Michael Niedermayer committed
134
ffmpeg [[infile options][@option{-i} @var{infile}]]... @{[outfile options] @var{outfile}@}...
135
@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
@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.

176 177 178 179
@item -ss position
seek to given time position. @code{hh:mm:ss[.xxx]} syntax is also
supported.

180 181 182 183 184 185 186 187 188 189 190 191
@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
update  
Fabrice Bellard committed
192
@item -target type
193
specify target file type ("vcd", "svcd", "dvd", "pal-vcd", "ntsc-svcd", ... ). All the format
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
194 195 196 197 198 199 200
options (bitrate, codecs, buffer sizes) are automatically set by this
option. You can just type:

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

201 202 203 204 205 206 207
Nevertheless you can specify additional options as long as you know they do not compromise the
standard, as in:

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

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
208
@item -hq
Fabrice Bellard's avatar
Fabrice Bellard committed
209 210
activate high quality settings

211 212 213 214 215 216 217
@item -itsoffset offset
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 input files' timestamps;
specifying a positive offset means that the corresponding streams are
delayed by 'offset' seconds.

218 219 220 221
@end table

@section Video Options

222
@table @option
223
@item -b bitrate
Fabrice Bellard's avatar
Fabrice Bellard committed
224 225 226 227
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
228 229 230
set frame size. The format is @samp{WxH} (default 160x128).  The
following abbreviations are recognized:
@table @samp
Fabrice Bellard's avatar
Fabrice Bellard committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
@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)
251 252 253 254 255 256 257 258
@item -padtop size
set top pad band size (in pixels)
@item -padbottom size
set bottom pad band size (in pixels)
@item -padleft size
set left pad band size (in pixels)
@item -padright size
set right pad band size (in pixels)
259 260
@item -padcolor (hex color)
set color of padded bands. The value for pad color is expressed 
261 262
as a six digit hexidecimal number where the first two digits represent red, 
middle two digits green and last two digits blue. Defaults to 000000 (black)
263
@item -vn
Fabrice Bellard's avatar
Fabrice Bellard committed
264
disable video recording
265 266
@item -bt tolerance       
set video bitrate tolerance (in kbit/s)
Fabrice Bellard's avatar
Fabrice Bellard committed
267 268 269 270 271 272 273
@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
274 275
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
276
@item -sameq
277 278 279
use same video quality as source (implies VBR)

@item -pass n  
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
280 281 282 283
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.
284 285

@item -passlogfile file   
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
286
select two pass log file name to @var{file}.
287 288 289

@end table

Fabrice Bellard's avatar
Fabrice Bellard committed
290
@section Advanced Video Options
291

292
@table @option
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
@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
309 310 311 312 313 314 315 316 317 318 319 320

@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
321 322 323 324
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
325
@item -me method
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
326 327
set motion estimation method to @var{method}. Available methods are
(from lower to best quality):
Fabrice Bellard's avatar
Fabrice Bellard committed
328 329
@table @samp
@item zero
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
330
Try just the (0, 0) vector.
Fabrice Bellard's avatar
Fabrice Bellard committed
331 332 333 334 335 336 337 338 339 340
@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
341
set dct algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
@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
358
set idct algorithm to @var{algo}. Available values are:
Fabrice Bellard's avatar
Fabrice Bellard committed
359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
@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
385
set error resilience to @var{n}.
Fabrice Bellard's avatar
Fabrice Bellard committed
386 387
@table @samp
@item 1 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
388
FF_ER_CAREFULL (default)
Fabrice Bellard's avatar
Fabrice Bellard committed
389
@item 2
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
390
FF_ER_COMPLIANT
Fabrice Bellard's avatar
Fabrice Bellard committed
391 392 393 394 395 396
@item 3
FF_ER_AGGRESSIVE
@item 4
FF_ER_VERY_AGGRESSIVE
@end table

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
397 398 399
@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
400 401
@table @samp
@item 1
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
402
FF_EC_GUESS_MVS (default=enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
403
@item 2
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
404
FF_EC_DEBLOCK (default=enabled)
Fabrice Bellard's avatar
Fabrice Bellard committed
405 406 407
@end table

@item -bf frames
Fabrice Bellard's avatar
Fabrice Bellard committed
408
use 'frames' B frames (supported for MPEG-1, MPEG-2 and MPEG-4)
Fabrice Bellard's avatar
Fabrice Bellard committed
409 410 411 412 413 414 415 416 417 418 419 420
@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
421
use four motion vector by macroblock (only MPEG-4)
Fabrice Bellard's avatar
Fabrice Bellard committed
422 423 424 425 426 427
@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
428 429 430 431
@item -aic
enable Advanced intra coding (h263+)
@item -umv
enable Unlimited Motion Vector (h263+)
Fabrice Bellard's avatar
Fabrice Bellard committed
432 433 434

@item -deinterlace
deinterlace pictures
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
435 436 437 438 439 440
@item -interlace
force interlacing support in encoder (only MPEG-2 and MPEG-4). Use this option
if your input file is interlaced and if you want to keep the interlaced
format for minimum losses. The alternative is to deinterlace the input
stream with @option{-deinterlace}, but deinterlacing introduces more
losses.
Fabrice Bellard's avatar
Fabrice Bellard committed
441 442 443
@item -psnr
calculate PSNR of compressed frames
@item -vstats
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
444
dump video coding statistics to @file{vstats_HHMMSS.log}.
Fabrice Bellard's avatar
Fabrice Bellard committed
445 446 447 448 449 450 451 452 453
@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 -ar freq    
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
454
set the audio sampling freq (default = 44100 Hz)
Fabrice Bellard's avatar
Fabrice Bellard committed
455
@item -ab bitrate 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
456
set the audio bitrate in kbit/s (default = 64)
Fabrice Bellard's avatar
Fabrice Bellard committed
457
@item -ac channels
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
458 459 460 461 462 463
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
464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487
@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
488 489 490 491
@item -benchmark          
add timings for benchmarking
@item -hex                
dump each input packet
Fabrice Bellard's avatar
Fabrice Bellard committed
492 493 494 495
@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
496 497 498 499 500
@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.
501
@end table
Fabrice Bellard's avatar
Fabrice Bellard committed
502 503 504 505 506 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 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

@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

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576
@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
577 578 579

@section Protocols

Fabrice Bellard's avatar
Fabrice Bellard committed
580 581
The filename can be @file{-} to read from the standard input or to write
to the standard output.
582 583 584

ffmpeg handles also many protocols specified with the URL syntax.

585
Use 'ffmpeg -formats' to have a list of the supported protocols.
586

587 588 589
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 :-)
590 591 592 593 594

@chapter Tips

@itemize
@item For streaming at very low bit rate application, use a low frame rate
595 596 597
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:
598 599

@example
600
ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
601 602 603
@end example

@item  The parameter 'q' which is displayed while encoding is the current
604 605 606 607 608
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.
609 610

@item If your computer is not fast enough, you can speed up the
611 612 613 614
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).
615 616

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

@item To have a constant quality (but a variable bitrate), use the option
620 621
'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
quality).
622 623

@item When converting video files, you can use the '-sameq' option which
624 625
uses in the encoder the same quality factor than in the decoder. It
allows to be almost lossless in encoding.
626 627 628 629 630 631 632 633 634

@end itemize

@chapter Supported File Formats and Codecs

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

@section File Formats

635
FFmpeg supports the following file formats through the @code{libavformat}
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
636
library:
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651

@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
652 653
@item FLV              @tab  X @tab X
@tab Macromedia Flash video files
654 655 656 657 658
@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
659
@item Raw CRI ADX audio @tab X  @tab  X 
660
@item SUN AU format @tab X  @tab  X 
Alex Beregszaszi's avatar
Alex Beregszaszi committed
661
@item NUT @tab X @tab X @tab NUT Open Container Format
662 663
@item Quicktime        @tab X @tab  X 
@item MPEG4            @tab X @tab  X 
664
@tab MPEG4 is a variant of Quicktime
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
665
@item Raw MPEG4 video  @tab  X @tab  X 
666
@item DV               @tab  X @tab  X
Mike Melanson's avatar
Mike Melanson committed
667 668
@item 4xm              @tab    @tab X
@tab 4X Technologies format, used in some games
Mike Melanson's avatar
Mike Melanson committed
669 670 671 672 673
@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
674 675
@item WC3 Movie        @tab    @tab X
@tab multimedia format used in Origin's Wing Commander III computer game
676 677 678 679
@item Sega FILM/CPK    @tab    @tab X
@tab used in many Sega Saturn console games
@item Westwood Studios VQA/AUD  @tab    @tab X
@tab Multimedia formats used in Westwood Studios games
680 681
@item Id Cinematic (.cin) @tab    @tab X
@tab Used in Quake II
Mike Melanson's avatar
Mike Melanson committed
682 683
@item FLIC format      @tab    @tab X
@tab .fli/.flc files
Mike Melanson's avatar
Mike Melanson committed
684 685
@item Sierra VMD       @tab    @tab X
@tab used in Sierra CD-ROM games
686 687
@item Sierra Online    @tab    @tab X
@tab .sol files used in Sierra Online games
Mike Melanson's avatar
Mike Melanson committed
688
@item Matroska         @tab    @tab X
689
@end multitable
690 691
@item Electronic Arts Multimedia    @tab    @tab X
@tab used in various EA games; files have extensions like WVE and UV2
692 693 694

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

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
695 696 697 698 699 700 701 702
@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 
703 704
@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
705 706
@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
707 708
@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
709
@item SGI          @tab X @tab X @tab SGI RGB image format
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
710 711 712 713
@end multitable

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

714 715 716 717
@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
718
@item MPEG1 video            @tab  X  @tab  X
Fabrice Bellard's avatar
Fabrice Bellard committed
719
@item MPEG2 video            @tab  X  @tab  X 
720 721 722 723 724
@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
725
@item WMV8                   @tab  X  @tab  X @tab Not completely working
726 727
@item H263(+)                @tab  X  @tab  X @tab Also known as Real Video 1.0
@item MJPEG                  @tab  X  @tab  X 
Alex Beregszaszi's avatar
Alex Beregszaszi committed
728 729 730
@item Lossless MJPEG         @tab  X  @tab  X
@item Apple MJPEG-B          @tab     @tab  X
@item Sunplus MJPEG          @tab     @tab  X @tab fourcc: SP5X
731
@item DV                     @tab  X  @tab  X 
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
732
@item Huff YUV               @tab  X  @tab  X
Alex Beregszaszi's avatar
Alex Beregszaszi committed
733 734
@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
735
@item Asus v1                @tab  X  @tab  X @tab fourcc: ASV1
Mike Melanson's avatar
Mike Melanson committed
736
@item Asus v2                @tab  X  @tab  X @tab fourcc: ASV2
Mike Melanson's avatar
Mike Melanson committed
737 738
@item Creative YUV           @tab     @tab  X @tab fourcc: CYUV
@item H.264                  @tab     @tab  X
Mike Melanson's avatar
Mike Melanson committed
739
@item Sorenson Video 1       @tab  X  @tab  X @tab fourcc: SVQ1
Mike Melanson's avatar
Mike Melanson committed
740 741
@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
742
@item Theora                 @tab     @tab  X @tab still experimental
Mike Melanson's avatar
Mike Melanson committed
743
@item Intel Indeo 3          @tab     @tab  X @tab only works on i386 right now
744
@item FLV                    @tab  X  @tab  X @tab Flash H263 variant
Mike Melanson's avatar
Mike Melanson committed
745
@item ATI VCR1               @tab     @tab  X @tab fourcc: VCR1
Alex Beregszaszi's avatar
Alex Beregszaszi committed
746
@item ATI VCR2               @tab     @tab  X @tab fourcc: VCR2
Mike Melanson's avatar
Mike Melanson committed
747 748 749 750
@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
751
@item Xan/WC3                @tab     @tab  X @tab used in Wing Commander III .MVE files
752
@item Interplay Video        @tab     @tab  X @tab used in Interplay .MVE files
753
@item Apple Animation        @tab     @tab  X @tab fourcc: 'rle '
Mike Melanson's avatar
Mike Melanson committed
754
@item Apple Graphics         @tab     @tab  X @tab fourcc: 'smc '
755
@item Apple Video            @tab     @tab  X @tab fourcc: rpza
756
@item Apple QuickDraw        @tab     @tab  X @tab fourcc: qdrw
757 758 759
@item Cinepak                @tab     @tab  X
@item Microsoft RLE          @tab     @tab  X
@item Microsoft Video-1      @tab     @tab  X
760 761
@item Westwood VQA           @tab     @tab  X
@item Id Cinematic Video     @tab     @tab  X @tab used in Quake II
Roberto Togni's avatar
Roberto Togni committed
762
@item Planar RGB             @tab     @tab  X @tab fourcc: 8BPS
Mike Melanson's avatar
Mike Melanson committed
763
@item FLIC video             @tab     @tab  X
764
@item Duck TrueMotion v1     @tab     @tab  X @tab fourcc: DUCK
Mike Melanson's avatar
Mike Melanson committed
765
@item VMD Video              @tab     @tab  X @tab used in Sierra VMD files
Roberto Togni's avatar
Roberto Togni committed
766 767
@item MSZH                   @tab     @tab  X @tab Part of LCL
@item ZLIB                   @tab  X  @tab  X @tab Part of LCL, encoder experimental
768
@item TechSmith Camtasia     @tab     @tab  X @tab fourcc: TSCC
769
@item IBM Ultimotion         @tab     @tab  X @tab fourcc: ULTI
770 771 772 773
@end multitable

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

Fabrice Bellard's avatar
Fabrice Bellard committed
774 775 776 777
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.

778 779 780 781 782 783
@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
784
@tab MP3 encoding is supported through the external library LAME
785
@item AC3                    @tab  IX  @tab  IX
786
@tab liba52 is used internally for decoding
787
@item Vorbis                 @tab  X   @tab  X
788
@tab supported through the external library libvorbis
Fabrice Bellard's avatar
update  
Fabrice Bellard committed
789
@item WMA V1/V2              @tab      @tab X
790 791
@item AAC                    @tab X    @tab X
@tab supported through the external library libfaac/libfaad
Michael Niedermayer's avatar
Michael Niedermayer committed
792
@item Microsoft ADPCM        @tab X    @tab X
Mike Melanson's avatar
Mike Melanson committed
793 794 795
@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
796
@item G.726  ADPCM           @tab X    @tab X
Mike Melanson's avatar
Mike Melanson committed
797 798 799 800
@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
801
@item Westwood Studios IMA ADPCM @tab      @tab X
Mike Melanson's avatar
Mike Melanson committed
802
@tab used in Westwood Studios games like Command and Conquer
803 804
@item SMJPEG IMA ADPCM       @tab      @tab X
@tab used in certain Loki game ports
Mike Melanson's avatar
Mike Melanson committed
805 806 807
@item CD-ROM XA ADPCM        @tab      @tab X
@item CRI ADX ADPCM          @tab X    @tab X
@tab used in Sega Dreamcast games
808 809
@item Electronic Arts ADPCM  @tab      @tab X
@tab used in various EA titles
810
@item Creative ADPCM         @tab      @tab X
811 812 813 814
@item RA144                  @tab      @tab X
@tab Real 14400 bit/s codec
@item RA288                  @tab      @tab X
@tab Real 28800 bit/s codec
815 816
@item RADnet                 @tab X    @tab IX
@tab Real lowbitrate AC3 codec, liba52 is used for decoding
817 818
@item AMR-NB                 @tab X    @tab X
@tab supported through an external library
819 820
@item AMR-WB                 @tab X    @tab X
@tab supported through an external library
821
@item DV audio               @tab      @tab X
Mike Melanson's avatar
Mike Melanson committed
822 823 824 825
@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
826 827
@item Xan DPCM               @tab      @tab X
@tab used in Origin's Wing Commander IV AVI files
828 829
@item Sierra Online DPCM     @tab      @tab X
@tab used in Sierra Online game audio files
Alex Beregszaszi's avatar
Alex Beregszaszi committed
830 831
@item Apple MACE 3           @tab      @tab X
@item Apple MACE 6           @tab      @tab X
Alex Beregszaszi's avatar
flac  
Alex Beregszaszi committed
832
@item FLAC                   @tab      @tab X
Alex Beregszaszi's avatar
Alex Beregszaszi committed
833 834
@item FFmpeg Sonic           @tab X    @tab X
@tab Experimental lossy/lossless codec
835 836 837 838 839 840 841
@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
842 843 844 845 846
@chapter Platform Specific information

@section Linux

ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
847
preferred compiler now for ffmpeg. All future optimizations will depend on
Fabrice Bellard's avatar
Fabrice Bellard committed
848 849 850 851 852 853
features only found in GCC 3.2.

@section BSD

@section Windows

854 855 856 857 858 859 860
@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
861 862 863 864 865
@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
Fabrice Bellard's avatar
Fabrice Bellard committed
866 867
directory. Edit the @file{sdl-config} script so that it gives the
correct SDL directory when invoked.
Fabrice Bellard's avatar
Fabrice Bellard committed
868 869

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

Fabrice Bellard's avatar
Fabrice Bellard committed
873 874 875 876 877 878
@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.

Fabrice Bellard's avatar
Fabrice Bellard committed
879 880
@item You can install FFmpeg in @file{Program Files/FFmpeg} by typing @file{make install}. Don't forget to copy @file{SDL.dll} at the place you launch 
@file{ffplay}.
Fabrice Bellard's avatar
Fabrice Bellard committed
881

882 883
@end itemize

Fabrice Bellard's avatar
Fabrice Bellard committed
884 885
Notes: 
@itemize
Fabrice Bellard's avatar
Fabrice Bellard committed
886

Fabrice Bellard's avatar
Fabrice Bellard committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903
@item The target @file{make wininstaller} can be used to create a
Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
must be copied in the ffmpeg directory in order to build the
installer.

@item By using @code{./configure --enable-shared} when configuring ffmpeg, 
you can build @file{avcodec.dll} and @file{avformat.dll}. With
@code{make install} you install the FFmpeg DLLs and the associated
headers in @file{Program Files/FFmpeg}. 

@item Visual C++ compatibility: if you used @code{./configure --enable-shared} 
when configuring FFmpeg, then FFmpeg tries to use the Microsoft Visual
C++ @code{lib} tool to build @code{avcodec.lib} and
@code{avformat.lib}. With these libraries, you can link your Visual C++
code directly with the FFmpeg DLLs.

@end itemize
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919

@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
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941
@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)

942
@chapter Developers Guide
943 944 945 946 947 948 949

@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
950 951 952 953
  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.

954 955 956 957 958 959 960 961 962 963 964 965 966
@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.

967
@node Coding Rules
968 969
@section Coding Rules

Falk Hüffner's avatar
Falk Hüffner committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
ffmpeg is programmed in the ISO C90 language with a few additional
features from ISO C99, namely:
@itemize @bullet
@item
the @samp{inline} keyword;
@item
@samp{//} comments;
@item
designated struct initializers (@samp{struct s x = @{ .i = 17 @};})
@item
compound literals (@samp{x = (struct s) { 17, 23 @};})
@end itemize

These features are supported by all compilers we care about, so we won't
accept patches to remove their use unless they absolutely don't impair
clarity and performance.

All code must compile with gcc 2.95 and gcc 3.3. Currently, ffmpeg also
compiles with several other compilers, such as the Compaq ccc compiler
or Sun Studio 9, and we would like to keep it that way unless it would
be exceedingly involved. To ensure compatibility, please don't use any
additional C99 features or gcc extensions. Watch out especially for:
@itemize @bullet
@item
mixing statements and declarations;
@item
@samp{long long} (use @samp{int64_t} instead);
@item
@samp{__attribute__} not protected by @samp{#ifdef __GNUC__} or similar;
@item
gcc statement expressions (@samp{(x = (@{ int y = 4; y; @})}).
@end itemize
1002

Falk Hüffner's avatar
Falk Hüffner committed
1003
Indent size is 4. The TAB character should not be used.
1004 1005 1006 1007 1008
The presentation is the one specified by 'indent -i4 -kr'.

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

1009
Comments: use the JavaDoc/Doxygen 
Michael Niedermayer's avatar
Michael Niedermayer committed
1010
format (see examples below) so that a documentation
1011 1012 1013
can be generated automatically. All non trivial functions should have a comment
above it explaining what the function does, even if its just one sentance.
All Structures and their member variables should be documented too.
Michael Niedermayer's avatar
Michael Niedermayer committed
1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
@example
/**
 * @file mpeg.c
 * mpeg codec.
 * @author ...
 */

/**
 * Summary sentance.
 * more text ...
 * ...
 */
typedef struct Foobar{
    int var1; /**< var1 description */
    int var2; ///< var2 description
    /** var3 description */
    int var3;
} Foobar;

/**
 * Summary sentance.
 * more text ...
 * ...
 * @param my_parameter description of my_parameter
 * @return return value description
 */
int myfunc(int my_parameter)
...
@end example
1043

1044 1045 1046
fprintf and printf are forbidden in libavformat and libavcodec, 
please use av_log() instead.

1047 1048
@section Submitting patches

1049 1050
First, (@pxref{Coding Rules}) above if you didn't yet.

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

Run the regression tests before submitting a patch so that you can
1055
verify that there are no big problems.
1056 1057 1058 1059 1060 1061

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}

1062 1063 1064 1065
It also helps quite a bit if you tell us what the patch does (for example
'replaces lrint by lrintf') , and why (for example '*bsd isnt c99 compliant
and has no lrint()')

1066 1067 1068
We reply to all patches submitted and either apply or reject with some
explanation why, but sometimes we are quite busy so it can take a week or 2

1069 1070
@section Regression tests

1071
Before submitting a patch (or committing with CVS), you should at least
1072 1073 1074
test that you did not break anything.

The regression test build a synthetic video stream and a synthetic
1075
audio stream. Then these are encoded then decoded with all codecs or
1076 1077 1078 1079
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.

1080 1081 1082 1083
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.

1084
Run 'make test' to test all the codecs and formats.
1085

Fabrice Bellard's avatar
update  
Fabrice Bellard committed
1086
Run 'make fulltest' to test all the codecs, formats and ffserver.
1087 1088 1089 1090 1091 1092

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

@bye