Make code independent/less dependent on dsputil.
[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 FFserver runs in daemon mode by default; that is, it puts itself in
20 the background and detaches from its TTY, unless it is launched in
21 debug mode or a NoDaemon option is specified in the configuration
22 file.
23
24 This documentation covers only the streaming aspects of ffserver /
25 ffmpeg. All questions about parameters for ffmpeg, codec questions,
26 etc. are not covered here. Read @file{ffmpeg-doc.html} for more
27 information.
28
29 [Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]
30
31 @section How does it work?
32
33 FFserver receives prerecorded files or FFM streams from some ffmpeg
34 instance as input, then streams them over RTP/RTSP/HTTP.
35
36 An ffserver instance will listen on some port as specified in the
37 configuration file. You can launch one or more instances of ffmpeg and
38 send one or more FFM streams to the port where ffserver is expecting
39 to receive them. Alternately, you can make ffserver launch such ffmpeg
40 instances at startup.
41
42 Input streams are called feeds, and each one is specified by a <Feed>
43 section in the configuration file.
44
45 For each feed you can have different output streams in various
46 formats, each one specified by a <Stream> section in the configuration
47 file.
48
49 @section Status stream
50
51 FFserver supports an HTTP interface which exposes the current status
52 of the server.
53
54 Simply point your browser to the address of the special status stream
55 specified in the configuration file.
56
57 For example if you have:
58 @example
59 <Stream status.html>
60 Format status
61
62 # Only allow local people to get the status
63 ACL allow localhost
64 ACL allow 192.168.0.0 192.168.255.255
65 </Stream>
66 @end example
67
68 then the server will post a page with the status information when
69 the special stream @file{status.html} is requested.
70
71 @section What can this do?
72
73 When properly configured and running, you can capture video and audio in real
74 time from a suitable capture card, and stream it out over the Internet to
75 either Windows Media Player or RealAudio player (with some restrictions).
76
77 It can also stream from files, though that is currently broken. Very often, a
78 web server can be used to serve up the files just as well.
79
80 It can stream prerecorded video from .ffm files, though it is somewhat tricky
81 to make it work correctly.
82
83 @section What do I need?
84
85 I use Linux on a 900MHz Duron with a cheapo Bt848 based TV capture card. I'm
86 using stock Linux 2.4.17 with the stock drivers. [Actually that isn't true,
87 I needed some special drivers for my motherboard-based sound card.]
88
89 I understand that FreeBSD systems work just fine as well.
90
91 @section How do I make it work?
92
93 First, build the kit. It *really* helps to have installed LAME first. Then when
94 you run the ffserver ./configure, make sure that you have the
95 @code{--enable-libmp3lame} flag turned on.
96
97 LAME is important as it allows for streaming audio to Windows Media Player.
98 Don't ask why the other audio types do not work.
99
100 As a simple test, just run the following two command lines where INPUTFILE
101 is some file which you can decode with ffmpeg:
102
103 @example
104 ./ffserver -f doc/ffserver.conf &
105 ./ffmpeg -i INPUTFILE http://localhost:8090/feed1.ffm
106 @end example
107
108 At this point you should be able to go to your Windows machine and fire up
109 Windows Media Player (WMP). Go to Open URL and enter
110
111 @example
112     http://<linuxbox>:8090/test.asf
113 @end example
114
115 You should (after a short delay) see video and hear audio.
116
117 WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
118 transfer the entire file before starting to play.
119 The same is true of AVI files.
120
121 @section What happens next?
122
123 You should edit the ffserver.conf file to suit your needs (in terms of
124 frame rates etc). Then install ffserver and ffmpeg, write a script to start
125 them up, and off you go.
126
127 @section Troubleshooting
128
129 @subsection I don't hear any audio, but video is fine.
130
131 Maybe you didn't install LAME, or got your ./configure statement wrong. Check
132 the ffmpeg output to see if a line referring to MP3 is present. If not, then
133 your configuration was incorrect. If it is, then maybe your wiring is not
134 set up correctly. Maybe the sound card is not getting data from the right
135 input source. Maybe you have a really awful audio interface (like I do)
136 that only captures in stereo and also requires that one channel be flipped.
137 If you are one of these people, then export 'AUDIO_FLIP_LEFT=1' before
138 starting ffmpeg.
139
140 @subsection The audio and video loose sync after a while.
141
142 Yes, they do.
143
144 @subsection After a long while, the video update rate goes way down in WMP.
145
146 Yes, it does. Who knows why?
147
148 @subsection WMP 6.4 behaves differently to WMP 7.
149
150 Yes, it does. Any thoughts on this would be gratefully received. These
151 differences extend to embedding WMP into a web page. [There are two
152 object IDs that you can use: The old one, which does not play well, and
153 the new one, which does (both tested on the same system). However,
154 I suspect that the new one is not available unless you have installed WMP 7].
155
156 @section What else can it do?
157
158 You can replay video from .ffm files that was recorded earlier.
159 However, there are a number of caveats, including the fact that the
160 ffserver parameters must match the original parameters used to record the
161 file. If they do not, then ffserver deletes the file before recording into it.
162 (Now that I write this, it seems broken).
163
164 You can fiddle with many of the codec choices and encoding parameters, and
165 there are a bunch more parameters that you cannot control. Post a message
166 to the mailing list if there are some 'must have' parameters. Look in
167 ffserver.conf for a list of the currently available controls.
168
169 It will automatically generate the ASX or RAM files that are often used
170 in browsers. These files are actually redirections to the underlying ASF
171 or RM file. The reason for this is that the browser often fetches the
172 entire file before starting up the external viewer. The redirection files
173 are very small and can be transferred quickly. [The stream itself is
174 often 'infinite' and thus the browser tries to download it and never
175 finishes.]
176
177 @section Tips
178
179 * When you connect to a live stream, most players (WMP, RA, etc) want to
180 buffer a certain number of seconds of material so that they can display the
181 signal continuously. However, ffserver (by default) starts sending data
182 in realtime. This means that there is a pause of a few seconds while the
183 buffering is being done by the player. The good news is that this can be
184 cured by adding a '?buffer=5' to the end of the URL. This means that the
185 stream should start 5 seconds in the past -- and so the first 5 seconds
186 of the stream are sent as fast as the network will allow. It will then
187 slow down to real time. This noticeably improves the startup experience.
188
189 You can also add a 'Preroll 15' statement into the ffserver.conf that will
190 add the 15 second prebuffering on all requests that do not otherwise
191 specify a time. In addition, ffserver will skip frames until a key_frame
192 is found. This further reduces the startup delay by not transferring data
193 that will be discarded.
194
195 * You may want to adjust the MaxBandwidth in the ffserver.conf to limit
196 the amount of bandwidth consumed by live streams.
197
198 @section Why does the ?buffer / Preroll stop working after a time?
199
200 It turns out that (on my machine at least) the number of frames successfully
201 grabbed is marginally less than the number that ought to be grabbed. This
202 means that the timestamp in the encoded data stream gets behind realtime.
203 This means that if you say 'Preroll 10', then when the stream gets 10
204 or more seconds behind, there is no Preroll left.
205
206 Fixing this requires a change in the internals of how timestamps are
207 handled.
208
209 @section Does the @code{?date=} stuff work.
210
211 Yes (subject to the limitation outlined above). Also note that whenever you
212 start ffserver, it deletes the ffm file (if any parameters have changed),
213 thus wiping out what you had recorded before.
214
215 The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
216 of the following formats (the 'T' is literal):
217
218 @example
219 * YYYY-MM-DDTHH:MM:SS     (localtime)
220 * YYYY-MM-DDTHH:MM:SSZ    (UTC)
221 @end example
222
223 You can omit the YYYY-MM-DD, and then it refers to the current day. However
224 note that @samp{?date=16:00:00} refers to 16:00 on the current day -- this
225 may be in the future and so is unlikely to be useful.
226
227 You use this by adding the ?date= to the end of the URL for the stream.
228 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
229 @c man end
230
231 @chapter Invocation
232 @section Syntax
233 @example
234 @c man begin SYNOPSIS
235 ffserver [options]
236 @c man end
237 @end example
238
239 @section Options
240 @c man begin OPTIONS
241 @table @option
242 @item -version
243 Show version.
244 @item -L
245 Show license.
246 @item -formats
247 Show available formats, codecs, protocols, ...
248 @item -h
249 Show help.
250 @item -f @var{configfile}
251 Use @file{configfile} instead of @file{/etc/ffserver.conf}.
252 @item -n
253 Enable no-launch mode. This option disables all the Launch directives
254 within the various <Stream> sections. FFserver will not launch any
255 ffmpeg instance, so you will have to launch them manually.
256 @item -d
257 Enable debug mode. This option increases log verbosity, directs log
258 messages to stdout and causes ffserver to run in the foreground
259 rather than as a daemon.
260 @end table
261 @c man end
262
263 @ignore
264
265 @setfilename ffserver
266 @settitle FFserver video server
267
268 @c man begin SEEALSO
269 ffmpeg(1), ffplay(1), the @file{ffmpeg/doc/ffserver.conf} example and
270 the HTML documentation of @file{ffmpeg}.
271 @c man end
272
273 @c man begin AUTHOR
274 Fabrice Bellard
275 @c man end
276
277 @end ignore
278
279 @bye