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