Statistics
| Branch: | Revision:

ffmpeg / doc / ffserver-doc.texi @ 0eb4ff9e

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