Statistics
| Branch: | Revision:

ffmpeg / doc / ffserver-doc.texi @ 6b8bcd3e

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