Statistics
| Branch: | Revision:

ffmpeg / doc / ffserver.texi @ 8cf2d3d3

History | View | Annotate | Download (9.6 KB)

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