Matroska credits
[libav.git] / doc / ffmpeg-doc.texi
CommitLineData
9181577c
FB
1\input texinfo @c -*- texinfo -*-
2
3@settitle FFmpeg Documentation
4@titlepage
5@sp 7
6@center @titlefont{FFmpeg Documentation}
7@sp 3
8@end titlepage
9
10
11@chapter Introduction
12
13FFmpeg is a very fast video and audio converter. It can also grab from
14a live audio/video source.
15
16The command line interface is designed to be intuitive, in the sense
17that ffmpeg tries to figure out all the parameters, when
18possible. You have usually to give only the target bitrate you want.
19
20FFmpeg can also convert from any sample rate to any other, and resize
21video on the fly with a high quality polyphase filter.
22
23@chapter Quick Start
24
e99c4e10 25@c man begin EXAMPLES
9181577c
FB
26@section Video and Audio grabbing
27
e99c4e10
FB
28FFmpeg can use a video4linux compatible video source and any Open Sound
29System audio source:
30
9181577c 31@example
e99c4e10 32ffmpeg /tmp/out.mpg
9181577c
FB
33@end example
34
e99c4e10
FB
35Note that you must activate the right video source and channel before
36launching ffmpeg. You can use any TV viewer such as xawtv
37(@url{http://bytesex.org/xawtv/}) by Gerd Knorr which I find very
38good. You must also set correctly the audio recording levels with a
39standard mixer.
9181577c 40
6bf40f39 41@section Video and Audio file format conversion
9181577c
FB
42
43* ffmpeg can use any supported file format and protocol as input:
44
45Examples:
46
47* You can input from YUV files:
48
49@example
e99c4e10 50ffmpeg -i /tmp/test%d.Y /tmp/out.mpg
9181577c
FB
51@end example
52
e99c4e10 53It will use the files:
9181577c 54@example
e99c4e10
FB
55/tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
56/tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
9181577c
FB
57@end example
58
e99c4e10
FB
59The Y files use twice the resolution of the U and V files. They are
60raw files, without header. They can be generated by all decent video
61decoders. You must specify the size of the image with the @option{-s} option
62if ffmpeg cannot guess it.
9181577c
FB
63
64* You can input from a RAW YUV420P file:
65
66@example
e99c4e10 67ffmpeg -i /tmp/test.yuv /tmp/out.avi
9181577c
FB
68@end example
69
e99c4e10
FB
70The RAW YUV420P is a file containing RAW YUV planar, for each frame first
71come the Y plane followed by U and V planes, which are half vertical and
72horizontal resolution.
9181577c
FB
73
74* You can output to a RAW YUV420P file:
75
76@example
e99c4e10 77ffmpeg -i mydivx.avi -o hugefile.yuv
9181577c
FB
78@end example
79
80* You can set several input files and output files:
81
82@example
e99c4e10 83ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
9181577c
FB
84@end example
85
e99c4e10
FB
86Convert the audio file a.wav and the raw yuv video file a.yuv
87to mpeg file a.mpg
9181577c 88
6bf40f39 89* You can also do audio and video conversions at the same time:
9181577c
FB
90
91@example
e99c4e10 92ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
9181577c
FB
93@end example
94
e99c4e10 95Convert the sample rate of a.wav to 22050 Hz and encode it to MPEG audio.
9181577c
FB
96
97* You can encode to several formats at the same time and define a
e99c4e10 98mapping from input stream to output streams:
9181577c
FB
99
100@example
e99c4e10 101ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
9181577c
FB
102@end example
103
e99c4e10
FB
104Convert a.wav to a.mp2 at 64 kbits and b.mp2 at 128 kbits. '-map
105file:index' specify which input stream is used for each output
106stream, in the order of the definition of output streams.
9181577c
FB
107
108* You can transcode decrypted VOBs
109
110@example
e99c4e10 111ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec mp3 -ab 128 snatch.avi
9181577c
FB
112@end example
113
e99c4e10
FB
114This is a typical DVD ripper example, input from a VOB file, output
115to an AVI file with MPEG-4 video and MP3 audio, note that in this
116command we use B frames so the MPEG-4 stream is DivX5 compatible, GOP
117size is 300 that means an INTRA frame every 10 seconds for 29.97 fps
118input video. Also the audio stream is MP3 encoded so you need LAME
119support which is enabled using @code{--enable-mp3lame} when
120configuring. The mapping is particularly useful for DVD transcoding
121to get the desired audio language.
9181577c 122
e99c4e10
FB
123NOTE: to see the supported input formats, use @code{ffmpeg -formats}.
124@c man end
9181577c
FB
125
126@chapter Invocation
127
128@section Syntax
129
e99c4e10 130The generic syntax is:
9181577c
FB
131
132@example
e99c4e10
FB
133@c man begin SYNOPSIS
134ffmpeg [[options][@option{-i} @var{input_file}]]... @{[options] @var{output_file}@}...
135@c man end
9181577c 136@end example
e99c4e10
FB
137@c man begin DESCRIPTION
138If no input file is given, audio/video grabbing is done.
9181577c 139
e99c4e10
FB
140As a general rule, options are applied to the next specified
141file. For example, if you give the @option{-b 64} option, it sets the video
142bitrate of the next file. Format option may be needed for raw input
143files.
9181577c 144
e99c4e10
FB
145By default, ffmpeg tries to convert as losslessly as possible: it
146uses the same audio and video parameter for the outputs as the one
147specified for the inputs.
148@c man end
9181577c 149
e99c4e10 150@c man begin OPTIONS
9181577c
FB
151@section Main options
152
e99c4e10 153@table @option
9181577c
FB
154@item -L
155show license
18bff752 156
9181577c 157@item -h
e99c4e10 158show help
18bff752 159
e99c4e10 160@item -formats
9181577c 161show available formats, codecs, protocols, ...
18bff752 162
9181577c
FB
163@item -f fmt
164force format
18bff752 165
9181577c
FB
166@item -i filename
167input file name
168
169@item -y
170overwrite output files
171
172@item -t duration
173set the recording time in seconds. @code{hh:mm:ss[.xxx]} syntax is also
174supported.
175
e83a84ac
BL
176@item -ss position
177seek to given time position. @code{hh:mm:ss[.xxx]} syntax is also
178supported.
179
9181577c
FB
180@item -title string
181set the title
182
183@item -author string
184set the author
185
186@item -copyright string
187set the copyright
188
189@item -comment string
190set the comment
191
99db6420
FB
192@item -target type
193specify target file type ("vcd", "svcd" or "dvd"). All the format
194options (bitrate, codecs, buffer sizes) are automatically set by this
195option. You can just type:
196
197@example
198ffmpeg -i myfile.avi -target vcd /tmp/vcd.mpg
199@end example
200
201@item -hq
18bff752
FB
202activate high quality settings
203
9181577c
FB
204@end table
205
206@section Video Options
207
e99c4e10 208@table @option
9181577c 209@item -b bitrate
18bff752
FB
210set the video bitrate in kbit/s (default = 200 kb/s)
211@item -r fps
212set frame rate (default = 25)
213@item -s size
5ee03c86
FB
214set frame size. The format is @samp{WxH} (default 160x128). The
215following abbreviations are recognized:
216@table @samp
18bff752
FB
217@item sqcif
218128x96
219@item qcif
220176x144
221@item cif
222352x288
223@item 4cif
224704x576
225@end table
226
227@item -aspect aspect
228set aspect ratio (4:3, 16:9 or 1.3333, 1.7777)
229@item -croptop size
230set top crop band size (in pixels)
231@item -cropbottom size
232set bottom crop band size (in pixels)
233@item -cropleft size
234set left crop band size (in pixels)
235@item -cropright size
236set right crop band size (in pixels)
9181577c 237@item -vn
18bff752 238disable video recording
9181577c
FB
239@item -bt tolerance
240set video bitrate tolerance (in kbit/s)
18bff752
FB
241@item -maxrate bitrate
242set max video bitrate tolerance (in kbit/s)
243@item -minrate bitrate
244set min video bitrate tolerance (in kbit/s)
245@item -bufsize size
246set ratecontrol buffere size (in kbit)
247@item -vcodec codec
5ee03c86
FB
248force video codec to @var{codec}. Use the @code{copy} special value to
249tell that the raw codec data must be copied as is.
18bff752 250@item -sameq
9181577c
FB
251use same video quality as source (implies VBR)
252
253@item -pass n
5ee03c86
FB
254select the pass number (1 or 2). It is useful to do two pass
255encoding. The statistics of the video are recorded in the first pass and
256the video at the exact requested bit rate is generated in the second
257pass.
9181577c
FB
258
259@item -passlogfile file
5ee03c86 260select two pass log file name to @var{file}.
9181577c
FB
261
262@end table
263
18bff752 264@section Advanced Video Options
9181577c 265
e99c4e10 266@table @option
9181577c
FB
267@item -g gop_size
268set the group of picture size
269@item -intra
270use only intra frames
271@item -qscale q
272use fixed video quantiser scale (VBR)
273@item -qmin q
274min video quantiser scale (VBR)
275@item -qmax q
276max video quantiser scale (VBR)
277@item -qdiff q
278max difference between the quantiser scale (VBR)
279@item -qblur blur
280video quantiser scale blur (VBR)
281@item -qcomp compression
282video quantiser scale compression (VBR)
18bff752
FB
283
284@item -rc_init_cplx complexity
285initial complexity for 1-pass encoding
286@item -b_qfactor factor
287qp factor between p and b frames
288@item -i_qfactor factor
289qp factor between p and i frames
290@item -b_qoffset offset
291qp offset between p and b frames
292@item -i_qoffset offset
293qp offset between p and i frames
294@item -rc_eq equation
5ee03c86
FB
295set rate control equation (@pxref{FFmpeg formula
296evaluator}). Default is @code{tex^qComp}.
297@item -rc_override override
298rate control override for specific intervals
18bff752 299@item -me method
5ee03c86
FB
300set motion estimation method to @var{method}. Available methods are
301(from lower to best quality):
18bff752
FB
302@table @samp
303@item zero
5ee03c86 304Try just the (0, 0) vector.
18bff752
FB
305@item phods
306@item log
307@item x1
308@item epzs
309(default method)
310@item full
311exhaustive search (slow and marginally better than epzs)
312@end table
313
314@item -dct_algo algo
5ee03c86 315set dct algorithm to @var{algo}. Available values are:
18bff752
FB
316@table @samp
317@item 0
318FF_DCT_AUTO (default)
319@item 1
320FF_DCT_FASTINT
321@item 2
322FF_DCT_INT
323@item 3
324FF_DCT_MMX
325@item 4
326FF_DCT_MLIB
327@item 5
328FF_DCT_ALTIVEC
329@end table
330
331@item -idct_algo algo
5ee03c86 332set idct algorithm to @var{algo}. Available values are:
18bff752
FB
333@table @samp
334@item 0
335FF_IDCT_AUTO (default)
336@item 1
337FF_IDCT_INT
338@item 2
339FF_IDCT_SIMPLE
340@item 3
341FF_IDCT_SIMPLEMMX
342@item 4
343FF_IDCT_LIBMPEG2MMX
344@item 5
345FF_IDCT_PS2
346@item 6
347FF_IDCT_MLIB
348@item 7
349FF_IDCT_ARM
350@item 8
351FF_IDCT_ALTIVEC
352@item 9
353FF_IDCT_SH4
354@item 10
355FF_IDCT_SIMPLEARM
356@end table
357
358@item -er n
5ee03c86 359set error resilience to @var{n}.
18bff752
FB
360@table @samp
361@item 1
5ee03c86 362FF_ER_CAREFULL (default)
18bff752 363@item 2
5ee03c86 364FF_ER_COMPLIANT
18bff752
FB
365@item 3
366FF_ER_AGGRESSIVE
367@item 4
368FF_ER_VERY_AGGRESSIVE
369@end table
370
5ee03c86
FB
371@item -ec bit_mask
372set error concealment to @var{bit_mask}. @var{bit_mask} is a bit mask of
373the following values:
18bff752
FB
374@table @samp
375@item 1
5ee03c86 376FF_EC_GUESS_MVS (default=enabled)
18bff752 377@item 2
5ee03c86 378FF_EC_DEBLOCK (default=enabled)
18bff752
FB
379@end table
380
381@item -bf frames
50f52fcd 382use 'frames' B frames (supported for MPEG-1, MPEG-2 and MPEG-4)
18bff752
FB
383@item -mbd mode
384macroblock decision
385@table @samp
386@item 0
387FF_MB_DECISION_SIMPLE: use mb_cmp (cannot change it yet in ffmpeg)
388@item 1
389FF_MB_DECISION_BITS: chooses the one which needs the fewest bits
390@item 2
391FF_MB_DECISION_RD: rate distoration
392@end table
393
394@item -4mv
9181577c 395use four motion vector by macroblock (only MPEG-4)
18bff752
FB
396@item -part
397use data partitioning (only MPEG-4)
398@item -bug param
399workaround not auto detected encoder bugs
400@item -strict strictness
401how strictly to follow the standarts
5ee03c86
FB
402@item -aic
403enable Advanced intra coding (h263+)
404@item -umv
405enable Unlimited Motion Vector (h263+)
18bff752
FB
406
407@item -deinterlace
408deinterlace pictures
99db6420
FB
409@item -interlace
410force interlacing support in encoder (only MPEG-2 and MPEG-4). Use this option
411if your input file is interlaced and if you want to keep the interlaced
412format for minimum losses. The alternative is to deinterlace the input
413stream with @option{-deinterlace}, but deinterlacing introduces more
414losses.
18bff752
FB
415@item -psnr
416calculate PSNR of compressed frames
417@item -vstats
5ee03c86 418dump video coding statistics to @file{vstats_HHMMSS.log}.
18bff752
FB
419@item -vhook module
420insert video processing @var{module}. @var{module} contains the module
421name and its parameters separated by spaces.
18bff752
FB
422@end table
423
424@section Audio Options
425
426@table @option
427@item -ab bitrate
428set audio bitrate (in kbit/s)
429@item -ar freq
5ee03c86 430set the audio sampling freq (default = 44100 Hz)
18bff752 431@item -ab bitrate
5ee03c86 432set the audio bitrate in kbit/s (default = 64)
18bff752 433@item -ac channels
5ee03c86
FB
434set the number of audio channels (default = 1)
435@item -an
436disable audio recording
437@item -acodec codec
438force audio codec to @var{codec}. Use the @code{copy} special value to
439tell that the raw codec data must be copied as is.
18bff752
FB
440@end table
441
442@section Audio/Video grab options
443
444@table @option
445@item -vd device
446set video grab device (e.g. @file{/dev/video0})
447@item -vc channel
448set video grab channel (DV1394 only)
449@item -tvstd standard
450set television standard (NTSC, PAL (SECAM))
451@item -dv1394
452set DV1394 grab
453@item -ad device
454set audio device (e.g. @file{/dev/dsp})
455@end table
456
457@section Advanced options
458
459@table @option
460@item -map file:stream
461set input stream mapping
462@item -debug
463print specific debug info
9181577c
FB
464@item -benchmark
465add timings for benchmarking
466@item -hex
467dump each input packet
18bff752
FB
468@item -bitexact
469only use bit exact algorithms (for codec testing)
470@item -ps size
471set packet size in bits
5ee03c86
FB
472@item -re
473read input at native frame rate. Mainly used to simulate a grab device.
474@item -loop
475loop over the input stream. Currently it works only for image
476streams. This option is used for ffserver automatic testing.
9181577c 477@end table
18bff752
FB
478
479@node FFmpeg formula evaluator
480@section FFmpeg formula evaluator
481
482When evaluating a rate control string, FFmpeg uses an internal formula
483evaluator.
484
485The following binary operators are available: @code{+}, @code{-},
486@code{*}, @code{/}, @code{^}.
487
488The following unary operators are available: @code{+}, @code{-},
489@code{(...)}.
490
491The following functions are available:
492@table @var
493@item sinh(x)
494@item cosh(x)
495@item tanh(x)
496@item sin(x)
497@item cos(x)
498@item tan(x)
499@item exp(x)
500@item log(x)
501@item squish(x)
502@item gauss(x)
503@item abs(x)
504@item max(x, y)
505@item min(x, y)
506@item gt(x, y)
507@item lt(x, y)
508@item eq(x, y)
509@item bits2qp(bits)
510@item qp2bits(qp)
511@end table
512
513The following constants are available:
514@table @var
515@item PI
516@item E
517@item iTex
518@item pTex
519@item tex
520@item mv
521@item fCode
522@item iCount
523@item mcVar
524@item var
525@item isI
526@item isP
527@item isB
528@item avgQP
529@item qComp
530@item avgIITex
531@item avgPITex
532@item avgPPTex
533@item avgBPTex
534@item avgTex
535@end table
536
e99c4e10
FB
537@c man end
538
539@ignore
540
541@setfilename ffmpeg
542@settitle FFmpeg video converter
543
544@c man begin SEEALSO
545ffserver(1), ffplay(1) and the html documentation of @file{ffmpeg}.
546@c man end
547
548@c man begin AUTHOR
549Fabrice Bellard
550@c man end
551
552@end ignore
9181577c
FB
553
554@section Protocols
555
47d944d2
FB
556The filename can be @file{-} to read from the standard input or to write
557to the standard output.
9181577c
FB
558
559ffmpeg handles also many protocols specified with the URL syntax.
560
e99c4e10 561Use 'ffmpeg -formats' to have a list of the supported protocols.
9181577c 562
e99c4e10
FB
563The protocol @code{http:} is currently used only to communicate with
564ffserver (see the ffserver documentation). When ffmpeg will be a
565video player it will also be used for streaming :-)
9181577c
FB
566
567@chapter Tips
568
569@itemize
570@item For streaming at very low bit rate application, use a low frame rate
e99c4e10
FB
571and a small gop size. This is especially true for real video where
572the Linux player does not seem to be very fast, so it can miss
573frames. An example is:
9181577c
FB
574
575@example
e99c4e10 576ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
9181577c
FB
577@end example
578
579@item The parameter 'q' which is displayed while encoding is the current
e99c4e10
FB
580quantizer. The value of 1 indicates that a very good quality could
581be achieved. The value of 31 indicates the worst quality. If q=31
582too often, it means that the encoder cannot compress enough to meet
583your bit rate. You must either increase the bit rate, decrease the
584frame rate or decrease the frame size.
9181577c
FB
585
586@item If your computer is not fast enough, you can speed up the
e99c4e10
FB
587compression at the expense of the compression ratio. You can use
588'-me zero' to speed up motion estimation, and '-intra' to disable
589completely motion estimation (you have only I frames, which means it
590is about as good as JPEG compression).
9181577c
FB
591
592@item To have very low bitrates in audio, reduce the sampling frequency
e99c4e10 593(down to 22050 kHz for mpeg audio, 22050 or 11025 for ac3).
9181577c
FB
594
595@item To have a constant quality (but a variable bitrate), use the option
e99c4e10
FB
596'-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
597quality).
9181577c
FB
598
599@item When converting video files, you can use the '-sameq' option which
e99c4e10
FB
600uses in the encoder the same quality factor than in the decoder. It
601allows to be almost lossless in encoding.
9181577c
FB
602
603@end itemize
604
605@chapter Supported File Formats and Codecs
606
607You can use the @code{-formats} option to have an exhaustive list.
608
609@section File Formats
610
6bf40f39 611FFmpeg supports the following file formats through the @code{libavformat}
0699d2fe 612library:
9181577c
FB
613
614@multitable @columnfractions .4 .1 .1
615@item Supported File Format @tab Encoding @tab Decoding @tab Comments
616@item MPEG audio @tab X @tab X
617@item MPEG1 systems @tab X @tab X
618@tab muxed audio and video
619@item MPEG2 PS @tab X @tab X
620@tab also known as @code{VOB} file
621@item MPEG2 TS @tab @tab X
622@tab also known as DVB Transport Stream
623@item ASF@tab X @tab X
624@item AVI@tab X @tab X
625@item WAV@tab X @tab X
626@item Macromedia Flash@tab X @tab X
627@tab Only embedded audio is decoded
2eb5d024
FB
628@item FLV @tab X @tab X
629@tab Macromedia Flash video files
9181577c 630@item Real Audio and Video @tab X @tab X
9181577c
FB
631@item Raw AC3 @tab X @tab X
632@item Raw MJPEG @tab X @tab X
633@item Raw MPEG video @tab X @tab X
634@item Raw PCM8/16 bits, mulaw/Alaw@tab X @tab X
42cad81a 635@item Raw CRI ADX audio @tab X @tab X
9181577c 636@item SUN AU format @tab X @tab X
7fe4c823 637@item NUT @tab X @tab X @tab NUT Open Container Format
8a5483e7
MM
638@item Quicktime @tab X @tab X
639@item MPEG4 @tab X @tab X
9181577c 640@tab MPEG4 is a variant of Quicktime
0699d2fe 641@item Raw MPEG4 video @tab X @tab X
4fa1c4fa 642@item DV @tab X @tab X
701b603d
MM
643@item 4xm @tab @tab X
644@tab 4X Technologies format, used in some games
4d3b1f8d
MM
645@item Playstation STR @tab @tab X
646@item Id RoQ @tab @tab X
647@tab used in Quake III, Jedi Knight 2, other computer games
648@item Interplay MVE @tab @tab X
649@tab format used in various Interplay computer games
b17e9c99
MM
650@item WC3 Movie @tab @tab X
651@tab multimedia format used in Origin's Wing Commander III computer game
2fdf638b
MM
652@item Sega FILM/CPK @tab @tab X
653@tab used in many Sega Saturn console games
654@item Westwood Studios VQA/AUD @tab @tab X
655@tab Multimedia formats used in Westwood Studios games
4120a53a
MM
656@item Id Cinematic (.cin) @tab @tab X
657@tab Used in Quake II
42cad81a
MM
658@item FLIC format @tab @tab X
659@tab .fli/.flc files
da00f30e
MM
660@item Sierra VMD @tab @tab X
661@tab used in Sierra CD-ROM games
38088adf 662@item Matroska @tab @tab X
9181577c
FB
663@end multitable
664
665@code{X} means that the encoding (resp. decoding) is supported.
666
0699d2fe
FB
667@section Image Formats
668
669FFmpeg can read and write images for each frame of a video sequence. The
670following image formats are supported:
671
672@multitable @columnfractions .4 .1 .1
673@item Supported Image Format @tab Encoding @tab Decoding @tab Comments
674@item PGM, PPM @tab X @tab X
2eb5d024
FB
675@item PAM @tab X @tab X @tab PAM is a PNM extension with alpha support
676@item PGMYUV @tab X @tab X @tab PGM with U and V components in YUV 4:2:0
0699d2fe
FB
677@item JPEG @tab X @tab X @tab Progressive JPEG is not supported
678@item .Y.U.V @tab X @tab X @tab One raw file per component
2eb5d024
FB
679@item Animated GIF @tab X @tab X @tab Only uncompressed GIFs are generated
680@item PNG @tab X @tab X @tab 2 bit and 4 bit/pixel not supported yet
0699d2fe
FB
681@end multitable
682
683@code{X} means that the encoding (resp. decoding) is supported.
684
9181577c
FB
685@section Video Codecs
686
687@multitable @columnfractions .4 .1 .1 .7
688@item Supported Codec @tab Encoding @tab Decoding @tab Comments
4745b5bf 689@item MPEG1 video @tab X @tab X
50f52fcd 690@item MPEG2 video @tab X @tab X
9181577c
FB
691@item MPEG4 @tab X @tab X @tab Also known as DIVX4/5
692@item MSMPEG4 V1 @tab X @tab X
693@item MSMPEG4 V2 @tab X @tab X
694@item MSMPEG4 V3 @tab X @tab X @tab Also known as DIVX3
695@item WMV7 @tab X @tab X
701b603d 696@item WMV8 @tab X @tab X @tab Not completely working
9181577c
FB
697@item H263(+) @tab X @tab X @tab Also known as Real Video 1.0
698@item MJPEG @tab X @tab X
d6896c49
AB
699@item Lossless MJPEG @tab X @tab X
700@item Apple MJPEG-B @tab @tab X
701@item Sunplus MJPEG @tab @tab X @tab fourcc: SP5X
4fa1c4fa 702@item DV @tab X @tab X
4745b5bf 703@item Huff YUV @tab X @tab X
d6896c49 704@item FFmpeg Video 1 @tab X @tab X @tab Lossless codec (fourcc: FFV1)
701b603d 705@item Asus v1 @tab X @tab X @tab fourcc: ASV1
4d3b1f8d 706@item Asus v2 @tab X @tab X @tab fourcc: ASV2
701b603d
MM
707@item Creative YUV @tab @tab X @tab fourcc: CYUV
708@item H.264 @tab @tab X
709@item Sorenson Video 1 @tab @tab X @tab fourcc: SVQ1
710@item Sorenson Video 3 @tab @tab X @tab fourcc: SVQ3
711@item On2 VP3 @tab @tab X @tab still experimental
d6896c49 712@item Theora @tab @tab X @tab still experimental
701b603d 713@item Intel Indeo 3 @tab @tab X @tab only works on i386 right now
2eb5d024 714@item FLV @tab X @tab X @tab Flash H263 variant
4d3b1f8d 715@item ATI VCR1 @tab @tab X @tab fourcc: VCR1
7fe4c823 716@item ATI VCR2 @tab @tab X @tab fourcc: VCR2
4d3b1f8d
MM
717@item Cirrus Logic AccuPak @tab @tab X @tab fourcc: CLJR
718@item 4X Video @tab @tab X @tab used in certain computer games
719@item Sony Playstation MDEC @tab @tab X
720@item Id RoQ @tab @tab X @tab used in Quake III, Jedi Knight 2, other computer games
b17e9c99 721@item Xan/WC3 @tab @tab X @tab used in Wing Commander III .MVE files
186447f8 722@item Interplay Video @tab @tab X @tab used in Interplay .MVE files
070ed1bc 723@item Apple Animation @tab @tab X @tab fourcc: 'rle '
42cad81a 724@item Apple Graphics @tab @tab X @tab fourcc: 'smc '
2fdf638b
MM
725@item Apple Video @tab @tab X @tab fourcc: rpza
726@item Cinepak @tab @tab X
727@item Microsoft RLE @tab @tab X
728@item Microsoft Video-1 @tab @tab X
4120a53a
MM
729@item Westwood VQA @tab @tab X
730@item Id Cinematic Video @tab @tab X @tab used in Quake II
1dc1ed99 731@item Planar RGB @tab @tab X @tab fourcc: 8BPS
42cad81a 732@item FLIC video @tab @tab X
9a4117d5 733@item Duck TrueMotion v1 @tab @tab X @tab fourcc: DUCK
da00f30e 734@item VMD Video @tab @tab X @tab used in Sierra VMD files
a273bbfb
RT
735@item MSZH @tab @tab X @tab Part of LCL
736@item ZLIB @tab X @tab X @tab Part of LCL, encoder experimental
9181577c
FB
737@end multitable
738
739@code{X} means that the encoding (resp. decoding) is supported.
740
60837265
FB
741Check at @url{http://www.mplayerhq.hu/~michael/codec-features.html} to
742get a precise comparison of FFmpeg MPEG4 codec compared to the other
743solutions.
744
9181577c
FB
745@section Audio Codecs
746
747@multitable @columnfractions .4 .1 .1 .1 .7
748@item Supported Codec @tab Encoding @tab Decoding @tab Comments
749@item MPEG audio layer 2 @tab IX @tab IX
750@item MPEG audio layer 1/3 @tab IX @tab IX
6bf40f39 751@tab MP3 encoding is supported through the external library LAME
9181577c 752@item AC3 @tab IX @tab X
2eb5d024 753@tab liba52 is used internally for decoding
34d7008d 754@item Vorbis @tab X @tab X
2eb5d024 755@tab supported through the external library libvorbis
4745b5bf 756@item WMA V1/V2 @tab @tab X
d4c3c5a6 757@item Microsoft ADPCM @tab X @tab X
4d3b1f8d
MM
758@item MS IMA ADPCM @tab X @tab X
759@item QT IMA ADPCM @tab @tab X
760@item 4X IMA ADPCM @tab @tab X
d4e437df 761@item G.726 ADPCM @tab X @tab X
b17e9c99
MM
762@item Duck DK3 IMA ADPCM @tab @tab X
763@tab used in some Sega Saturn console games
764@item Duck DK4 IMA ADPCM @tab @tab X
765@tab used in some Sega Saturn console games
2fdf638b 766@item Westwood Studios IMA ADPCM @tab @tab X
42cad81a 767@tab used in Westwood Studios games like Command and Conquer
7d8379f2
MM
768@item SMJPEG IMA ADPCM @tab @tab X
769@tab used in certain Loki game ports
42cad81a
MM
770@item CD-ROM XA ADPCM @tab @tab X
771@item CRI ADX ADPCM @tab X @tab X
772@tab used in Sega Dreamcast games
7d8379f2
MM
773@item Electronic Arts ADPCM @tab @tab X
774@tab used in various EA titles
2eb5d024
FB
775@item RA144 @tab @tab X
776@tab Real 14400 bit/s codec
777@item RA288 @tab @tab X
778@tab Real 28800 bit/s codec
779@item AMR-NB @tab X @tab X
780@tab supported through an external library
d663a1fd
MN
781@item AMR-WB @tab X @tab X
782@tab supported through an external library
2eb5d024 783@item DV audio @tab @tab X
4d3b1f8d
MM
784@item Id RoQ DPCM @tab @tab X
785@tab used in Quake III, Jedi Knight 2, other computer games
786@item Interplay MVE DPCM @tab @tab X
787@tab used in various Interplay computer games
b17e9c99
MM
788@item Xan DPCM @tab @tab X
789@tab used in Origin's Wing Commander IV AVI files
d6896c49
AB
790@item Apple MACE 3 @tab @tab X
791@item Apple MACE 6 @tab @tab X
f8d58f4d 792@item FLAC @tab @tab X
9181577c
FB
793@end multitable
794
795@code{X} means that the encoding (resp. decoding) is supported.
796
797@code{I} means that an integer only version is available too (ensures highest
798performances on systems without hardware floating point support).
799
47d944d2
FB
800@chapter Platform Specific information
801
802@section Linux
803
804ffmpeg should be compiled with at least GCC 2.95.3. GCC 3.2 is the
6bf40f39 805preferred compiler now for ffmpeg. All future optimizations will depend on
47d944d2
FB
806features only found in GCC 3.2.
807
808@section BSD
809
810@section Windows
811
b030b284
FB
812@subsection Native Windows compilation
813
814@itemize
815@item Install the current versions of MSYS and MinGW from
816@url{http://www.mingw.org/}. You can find detailed installation
817instructions in the download section and the FAQ.
818
50f52fcd
FB
819@item If you want to test the FFmpeg Simple Media Player, also download
820the MinGW development library of SDL 1.2.x
821(@file{SDL-devel-1.2.x-mingw32.tar.gz}) from
822@url{http://www.libsdl.org}. Unpack it in a temporary place, and
823unpack the archive @file{i386-mingw32msvc.tar.gz} in the MinGW tool
988a9f9e
FB
824directory. Edit the @file{sdl-config} script so that it gives the
825correct SDL directory when invoked.
50f52fcd
FB
826
827@item Extract the current version of FFmpeg (the latest release version or the current CVS snapshot whichever is recommended).
b030b284
FB
828
829@item Start the MSYS shell (file @file{msys.bat}).
830
50f52fcd
FB
831@item Change to the FFMPEG directory and follow
832 the instructions of how to compile ffmpeg (file
833@file{INSTALL}). Usually, launching @file{./configure} and @file{make}
834suffices. If you have problems using SDL, verify that
835@file{sdl-config} can be launched from the MSYS command line.
836
988a9f9e
FB
837@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
838@file{ffplay}.
50f52fcd 839
b030b284
FB
840@end itemize
841
988a9f9e
FB
842Notes:
843@itemize
50f52fcd 844
988a9f9e
FB
845@item The target @file{make wininstaller} can be used to create a
846Nullsoft based Windows installer for FFmpeg and FFplay. @file{SDL.dll}
847must be copied in the ffmpeg directory in order to build the
848installer.
849
850@item By using @code{./configure --enable-shared} when configuring ffmpeg,
851you can build @file{avcodec.dll} and @file{avformat.dll}. With
852@code{make install} you install the FFmpeg DLLs and the associated
853headers in @file{Program Files/FFmpeg}.
854
855@item Visual C++ compatibility: if you used @code{./configure --enable-shared}
856when configuring FFmpeg, then FFmpeg tries to use the Microsoft Visual
857C++ @code{lib} tool to build @code{avcodec.lib} and
858@code{avformat.lib}. With these libraries, you can link your Visual C++
859code directly with the FFmpeg DLLs.
860
861@end itemize
b030b284
FB
862
863@subsection Cross compilation for Windows with Linux
864
865You must use the MinGW cross compilation tools available at
866@url{http://www.mingw.org/}.
867
868Then configure ffmpeg with the following options:
869@example
870./configure --enable-mingw32 --cross-prefix=i386-mingw32msvc-
871@end example
872(you can change the cross-prefix according to the prefix choosen for the
873MinGW tools).
874
875Then you can easily test ffmpeg with wine
876(@url{http://www.winehq.com/}).
877
47d944d2
FB
878@section MacOS X
879
880@section BeOS
881
882The configure script should guess the configuration itself.
883Networking support is currently not finished.
884errno issues fixed by Andrew Bachmann.
885
886Old stuff:
887
888