- Updating docs....
[ffmpeg.git] / doc / ffmpeg.txt
1 *************** FFMPEG soft VCR documentation *****************
2
3 0) Introduction
4 ---------------
5
6   FFmpeg is a very fast video and audio encoder. It can grab from
7   files or from a live audio/video source. 
8   
9   The command line interface is designed to be intuitive, in the sense
10   that ffmpeg tries to figure out all the parameters, when
11   possible. You have usually to give only the target bitrate you want.
12
13   FFmpeg can also convert from any sample rate to any other, and
14   resize video on the fly with a high quality polyphase filter.
15
16 1) Video and Audio grabbing
17 ---------------------------
18
19 * FFmpeg can use a video4linux compatible video source and any Open
20   Sound System audio source:
21
22   ffmpeg /tmp/out.mpg 
23
24   Note that you must activate the right video source and channel
25   before launching ffmpeg. You can use any TV viewer such as xawtv by
26   Gerd Knorr which I find very good. You must also set correctly the
27   audio recording levels with a standard mixer.
28
29 2) Video and Audio file format convertion
30 -----------------------------------------
31
32 * ffmpeg can use any supported file format and protocol as input: 
33
34 Examples:
35
36 * You can input from YUV files:
37
38   ffmpeg -i /tmp/test%d.Y /tmp/out.mpg 
39
40   It will use the files: 
41        /tmp/test0.Y, /tmp/test0.U, /tmp/test0.V,
42        /tmp/test1.Y, /tmp/test1.U, /tmp/test1.V, etc...
43
44   The Y files use twice the resolution of the U and V files. They are
45   raw files, without header. They can be generated by all decent video
46   decoders. You must specify the size of the image with the '-s' option
47   if ffmpeg cannot guess it.
48
49 * You can input from a RAW YUV420P file:
50
51   ffmpeg -i /tmp/test.yuv /tmp/out.avi
52
53   The RAW YUV420P is a file containing RAW YUV planar, for each frame first
54   come the Y plane followed by U and V planes, which are half vertical and
55   horizontal resolution.
56
57 * You can output to a RAW YUV420P file:
58
59   ffmpeg -i mydivx.avi -o hugefile.yuv
60
61 * You can set several input files and output files:
62
63   ffmpeg -i /tmp/a.wav -s 640x480 -i /tmp/a.yuv /tmp/a.mpg
64
65   Convert the audio file a.wav and the raw yuv video file a.yuv
66   to mpeg file a.mpg
67
68 * You can also do audio and video convertions at the same time:
69
70   ffmpeg -i /tmp/a.wav -ar 22050 /tmp/a.mp2
71
72   Convert the sample rate of a.wav to 22050 Hz and encode it to MPEG audio.
73
74 * You can encode to several formats at the same time and define a
75   mapping from input stream to output streams:
76
77   ffmpeg -i /tmp/a.wav -ab 64 /tmp/a.mp2 -ab 128 /tmp/b.mp2 -map 0:0 -map 0:0
78
79   Convert a.wav to a.mp2 at 64 kbits and b.mp2 at 128 kbits. '-map
80   file:index' specify which input stream is used for each output
81   stream, in the order of the definition of output streams.
82
83 * You can transcode decrypted VOBs
84
85   ffmpeg -i snatch_1.vob -f avi -vcodec mpeg4 -b 800 -g 300 -bf 2 -acodec
86   mp3 -ab 128 snatch.avi
87
88   This is a typicall DVD ripper example, input from a VOB file, output to
89   an AVI file with MPEG-4 video and MP3 audio, note that in this command we
90   use B frames so the MPEG-4 stream is DivX5 compatible, GOP size is 300
91   that means an INTRA frame every 10 seconds for 29.97 fps input video.
92   Also the audio stream is MP3 encoded so you need LAME support which is
93   enabled using '--enable-mp3lame' when configuring.
94   The mapping is particullary usefull for DVD transcoding to get the desired
95   audio language.
96
97   NOTE: to see the supported input formats, use 'ffmpeg -formats'.
98
99 2) Invocation
100 -------------
101
102 * The generic syntax is :
103
104   ffmpeg [[options][-i input_file]]... {[options] output_file}...
105
106   If no input file is given, audio/video grabbing is done.
107
108   As a general rule, options are applied to the next specified
109   file. For example, if you give the '-b 64' option, it sets the video
110   bitrate of the next file. Format option may be needed for raw input
111   files.
112
113   By default, ffmpeg tries to convert as losslessly as possible: it
114   uses the same audio and video parameter fors the outputs as the one
115   specified for the inputs.
116
117 * Main options are:
118
119 -L                  show license
120 -h                  show help
121 -formats            show available formats, codecs, protocols, ...
122 -f fmt              force format
123 -i filename         input file name
124 -y                  overwrite output files
125 -t duration         set the recording time
126 -title string       set the title
127 -author string      set the author
128 -copyright string   set the copyright
129 -comment string     set the comment
130 -b bitrate          set video bitrate (in kbit/s)
131
132 * Video Options are:
133
134 -s size             set frame size                       [160x128]
135 -r fps              set frame rate                       [25]
136 -b bitrate          set the video bitrate in kbit/s      [200]
137 -vn                 disable video recording              [no]
138 -bt tolerance       set video bitrate tolerance (in kbit/s)
139 -sameq              use same video quality as source (implies VBR)
140 -ab bitrate         set audio bitrate (in kbit/s)
141
142 * Audio Options are:
143
144 -ar freq     set the audio sampling freq          [44100]
145 -ab bitrate  set the audio bitrate in kbit/s      [64]
146 -ac channels set the number of audio channels     [1]
147 -an          disable audio recording              [no]
148
149 * Advanced options are:
150
151 -map file:stream    set input stream mapping
152 -g gop_size         set the group of picture size
153 -intra              use only intra frames
154 -qscale q           use fixed video quantiser scale (VBR)
155 -qmin q             min video quantiser scale (VBR)
156 -qmax q             max video quantiser scale (VBR)
157 -qdiff q            max difference between the quantiser scale (VBR)
158 -qblur blur         video quantiser scale blur (VBR)
159 -qcomp compression  video quantiser scale compression (VBR)
160 -vd device          set video device
161 -vcodec codec       force video codec
162 -me method          set motion estimation method
163 -bf frames          use 'frames' B frames (only MPEG-4)
164 -hq                 activate high quality settings
165 -4mv                use four motion vector by macroblock (only MPEG-4)
166 -ad device          set audio device
167 -acodec codec       force audio codec
168 -deinterlace        deinterlace pictures
169 -benchmark          add timings for benchmarking
170 -hex                dump each input packet
171 -psnr               calculate PSNR of compressed frames
172 -vstats             dump video coding statistics to file
173
174 The output file can be "-" to output to a pipe. This is only possible
175 with mpeg1 and h263 formats. 
176
177 3) Protocols
178
179  ffmpeg handles also many protocols specified with the URL syntax.
180
181  Use 'ffmpeg -formats' to have a list of the supported protocols.
182
183  The protocol 'http:' is currently used only to communicate with
184  ffserver (see the ffserver documentation). When ffmpeg will be a
185  video player it will also be used for streaming :-)
186
187 4) File formats and codecs
188 --------------------------
189
190  Use 'ffmpeg -formats' to have a list of the supported output
191  formats. Only some formats are handled as input, but it will improve
192  in the next versions.
193
194 5) Tips
195 -------
196
197 - For streaming at very low bit rate application, use a low frame rate
198   and a small gop size. This is especially true for real video where
199   the Linux player does not seem to be very fast, so it can miss
200   frames. An example is:
201
202   ffmpeg -g 3 -r 3 -t 10 -b 50 -s qcif -f rv10 /tmp/b.rm
203
204 - The parameter 'q' which is displayed while encoding is the current
205   quantizer. The value of 1 indicates that a very good quality could
206   be achieved. The value of 31 indicates the worst quality. If q=31
207   too often, it means that the encoder cannot compress enough to meet
208   your bit rate. You must either increase the bit rate, decrease the
209   frame rate or decrease the frame size.
210
211 - If your computer is not fast enough, you can speed up the
212   compression at the expense of the compression ratio. You can use
213   '-me zero' to speed up motion estimation, and '-intra' to disable
214   completly motion estimation (you have only I frames, which means it
215   is about as good as JPEG compression).
216
217 - To have very low bitrates in audio, reduce the sampling frequency
218   (down to 22050 kHz for mpeg audio, 22050 or 11025 for ac3).
219
220 - To have a constant quality (but a variable bitrate), use the option
221   '-qscale n' when 'n' is between 1 (excellent quality) and 31 (worst
222   quality).
223
224 - When converting video files, you can use the '-sameq' option which
225   uses in the encoder the same quality factor than in the decoder. It
226   allows to be almost lossless in encoding.