added ffplay documentation - added automatic man page generation for ffmpeg, ffserver...
[ffmpeg.git] / doc / ffserver-doc.texi
1 \input texinfo @c -*- texinfo -*-
2
3 @settitle FFserver Documentation
4 @titlepage
5 @sp 7
6 @center @titlefont{FFserver Documentation}
7 @sp 3
8 @end titlepage
9
10
11 @chapter Introduction
12
13 @c man begin DESCRIPTION
14 FFserver is a streaming server for both audio and video. It supports
15 several live feeds, streaming from files and time shifting on live feeds
16 (you can seek to positions in the past on each live feed, provided you
17 specify a big enough feed storage in ffserver.conf).
18
19 This documentation covers only the streaming aspects of ffserver /
20 ffmpeg. All questions about parameters for ffmpeg, codec questions,
21 etc. are not covered here. Read @file{ffmpeg-doc.html} for more
22 information.
23 @c man end
24
25 @chapter QuickStart
26
27 [Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]
28
29 @section What can this do?
30
31 When properly configured and running, you can capture video and audio in real
32 time from a suitable capture card, and stream it out over the Internet to
33 either Windows Media Player or RealAudio player (with some restrictions).
34
35 It can also stream from files, though that is currently broken. Very often, a
36 web server can be used to serve up the files just as well.
37
38 It can stream prerecorded video from .ffm files, though it is somewhat tricky
39 to make it work correctly.
40
41 @section What do I need?
42
43 I use Linux on a 900MHz Duron with a cheapo Bt848 based TV capture card. I'm
44 using stock linux 2.4.17 with the stock drivers. [Actually that isn't true,
45 I needed some special drivers from my motherboard based sound card.]
46
47 I understand that FreeBSD systems work just fine as well.
48
49 @section How do I make it work?
50
51 First, build the kit. It *really* helps to have installed LAME first. Then when
52 you run the ffserver ./configure, make sure that you have the --enable-mp3lame
53 flag turned on.
54
55 LAME is important as it allows streaming of audio to Windows Media Player. Don't
56 ask why the other audio types do not work.
57
58 As a simple test, just run the following two command lines (assuming that you
59 have a V4L video capture card):
60
61 @example
62 ./ffserver -f doc/ffserver.conf &
63 ./ffmpeg http://localhost:8090/feed1.ffm
64 @end example
65
66 At this point you should be able to go to your windows machine and fire up
67 Windows Media Player (WMP). Go to Open URL and enter 
68
69 @example
70     http://<linuxbox>:8090/test.asf
71 @end example
72
73 You should see (after a short delay) video and hear audio. 
74
75 WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
76 transfer the entire file before starting to play. The same is true of avi files.
77
78 @section What happens next?
79
80 You should edit the ffserver.conf file to suit your needs (in terms of 
81 frame rates etc). Then install ffserver and ffmpeg, write a script to start
82 them up, and off you go.
83
84 @section Troubleshooting
85
86 @subsection I don't hear any audio, but video is fine
87
88 Maybe you didn't install LAME, or get your ./configure statement right. Check
89 the ffmpeg output to see if a line referring to mp3 is present. If not, then
90 your configuration was incorrect. If it is, then maybe your wiring is not
91 setup correctly. Maybe the sound card is not getting data from the right 
92 input source. Maybe you have a really awful audio interface (like I do)
93 that only captures in stereo and also requires that one channel be flipped. 
94 If you are one of these people, then export 'AUDIO_FLIP_LEFT=1' before 
95 starting ffmpeg.
96
97 @subsection The audio and video loose sync after a while.
98
99 Yes, they do.
100
101 @subsection After a long while, the video update rate goes way down in WMP.
102
103 Yes, it does. Who knows why?
104
105 @subsection WMP 6.4 behaves differently to WMP 7.
106
107 Yes, it does. Any thoughts on this would be gratefully received. These
108 differences extend to embedding WMP into a web page. [There are two
109 different object ids that you can use, one of them -- the old one -- cannot
110 play very well, and the new one works well (both on the same system). However, 
111 I suspect that the new one is not available unless you have installed WMP 7].
112
113 @section What else can it do?
114
115 You can replay video from .ffm files that was recorded earlier.
116 However, there are a number of caveats which include the fact that the 
117 ffserver parameters must match the original parameters used to record the
118 file. If not, then ffserver deletes the file before recording into it. (Now I write
119 this, this seems broken).
120
121 You can fiddle with many of the codec choices and encoding parameters, and
122 there are a bunch more parameters that you cannot control. Post a message
123 to the mailing list if there are some 'must have' parameters. Look in the
124 ffserver.conf for a list of the currently available controls.
125
126 It will automatically generate the .ASX or .RAM files that are often used
127 in browsers. These files are actually redirections to the underlying .ASF
128 or .RM file. The reason for this is that the browser often fetches the
129 entire file before starting up the external viewer. The redirection files
130 are very small and can be transferred quickly. [The stream itself is
131 often 'infinite' and thus the browser tries to download it and never 
132 finishes.]
133
134 @section Tips
135
136 * When you connect to a live stream, most players (WMP, RA etc) want to
137 buffer a certain number of seconds of material so that they can display the
138 signal continuously. However, ffserver (by default) starts sending data
139 in real time. This means that there is a pause of a few seconds while the
140 buffering is being done by the player. The good news is that this can be
141 cured by adding a '?buffer=5' to the end of the URL. This says that the
142 stream should start 5 seconds in the past -- and so the first 5 seconds 
143 of the stream is sent as fast as the network will allow. It will then
144 slow down to real time. This noticeably improves the startup experience.
145
146 You can also add a 'Preroll 15' statement into the ffserver.conf that will
147 add the 15 second prebuffering on all requests that do not otherwise
148 specify a time. In addition, ffserver will skip frames until a key_frame
149 is found. This further reduces the startup delay by not transferring data
150 that will be discarded.
151
152 * You may want to adjust the MaxBandwidth in the ffserver.conf to limit
153 the amount of bandwidth consumed by live streams.
154
155 @section Why does the ?buffer / Preroll stop working after a time?
156
157 It turns out that (on my machine at least) the number of frames successfully
158 grabbed is marginally less than the number that ought to be grabbed. This
159 means that the timestamp in the encoded data stream gets behind real time.
160 This means that if you say 'preroll 10', then when the stream gets 10
161 or more seconds behind, there is no preroll left.
162
163 Fixing this requires a change in the internals in how timestamps are 
164 handled.
165
166 @section Does the @code{?date=} stuff work.
167
168 Yes (subject to the caution above). Also note that whenever you start
169 ffserver, it deletes the ffm file (if any parameters have changed), thus wiping out what you had recorded
170 before. 
171
172 The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
173 of the following formats (the 'T' is literal):
174
175 @example
176 * YYYY-MM-DDTHH:MM:SS     (localtime)
177 * YYYY-MM-DDTHH:MM:SSZ    (UTC)
178 @end example
179
180 You can omit the YYYY-MM-DD, and then it refers to the current day. However 
181 note that @samp{?date=16:00:00}  refers to 4PM on the current day -- this may be
182 in the future and so unlikely to useful.
183
184 You use this by adding the ?date= to the end of the URL for the stream.
185 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
186
187 @chapter Invocation
188 @section Syntax
189 @example 
190 @c man begin SYNOPSIS
191 ffserver [options]
192 @c man end
193 @end example
194
195 @section Options
196 @c man begin OPTIONS
197 @table @option
198 @item -L
199 print the license
200 @item -h
201 print the help
202 @item -f configfile
203 use @file{configfile} instead of @file{/etc/ffserver.conf}
204 @end table
205 @c man end
206
207 @ignore
208
209 @setfilename ffsserver
210 @settitle FFserver video server
211
212 @c man begin SEEALSO
213 ffmpeg(1), ffplay(1) and the html documentation of @file{ffmpeg}.
214 @c man end
215
216 @c man begin AUTHOR
217 Fabrice Bellard
218 @c man end
219
220 @end ignore
221
222 @bye