Statistics
| Branch: | Revision:

ffmpeg / doc / ffserver.texi @ 106f271f

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