ffserver-doc.texi 7.87 KB
Newer Older
1
\input texinfo @c -*- texinfo -*-
2

3 4 5 6 7 8
@settitle FFserver Documentation
@titlepage
@sp 7
@center @titlefont{FFserver Documentation}
@sp 3
@end titlepage
9 10


11
@chapter Introduction
12

13
@c man begin DESCRIPTION
14 15 16 17
FFserver is a streaming server for both audio and video. It supports
several live feeds, streaming from files and time shifting on live feeds
(you can seek to positions in the past on each live feed, provided you
specify a big enough feed storage in ffserver.conf).
18

19 20
This documentation covers only the streaming aspects of ffserver /
ffmpeg. All questions about parameters for ffmpeg, codec questions,
21
etc. are not covered here. Read @file{ffmpeg-doc.html} for more
22
information.
23
@c man end
24 25 26 27 28 29

@chapter QuickStart

[Contributed by Philip Gladstone, philip-ffserver at gladstonefamily dot net]

@section What can this do?
30 31 32 33 34 35 36 37

When properly configured and running, you can capture video and audio in real
time from a suitable capture card, and stream it out over the Internet to
either Windows Media Player or RealAudio player (with some restrictions).

It can also stream from files, though that is currently broken. Very often, a
web server can be used to serve up the files just as well.

38 39 40
It can stream prerecorded video from .ffm files, though it is somewhat tricky
to make it work correctly.

41
@section What do I need?
42 43

I use Linux on a 900MHz Duron with a cheapo Bt848 based TV capture card. I'm
Diego Biurrun's avatar
Diego Biurrun committed
44 45
using stock Linux 2.4.17 with the stock drivers. [Actually that isn't true,
I needed some special drivers for my motherboard-based sound card.]
46 47 48

I understand that FreeBSD systems work just fine as well.

49
@section How do I make it work?
50 51

First, build the kit. It *really* helps to have installed LAME first. Then when
52 53
you run the ffserver ./configure, make sure that you have the
@code{--enable-libmp3lame} flag turned on.
54

55
LAME is important as it allows for streaming audio to Windows Media Player.
Diego Biurrun's avatar
Diego Biurrun committed
56
Don't ask why the other audio types do not work.
57

58 59
As a simple test, just run the following two command lines (assuming that you
have a V4L video capture card):
60

61
@example
62 63
./ffserver -f doc/ffserver.conf &
./ffmpeg http://localhost:8090/feed1.ffm
64
@end example
65

Diego Biurrun's avatar
Diego Biurrun committed
66
At this point you should be able to go to your Windows machine and fire up
67
Windows Media Player (WMP). Go to Open URL and enter
68

69
@example
70
    http://<linuxbox>:8090/test.asf
71
@end example
72

73
You should (after a short delay) see video and hear audio.
74

75
WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
Diego Biurrun's avatar
Diego Biurrun committed
76 77
transfer the entire file before starting to play.
The same is true of AVI files.
78

79
@section What happens next?
80

81
You should edit the ffserver.conf file to suit your needs (in terms of
82 83 84
frame rates etc). Then install ffserver and ffmpeg, write a script to start
them up, and off you go.

85
@section Troubleshooting
86

Diego Biurrun's avatar
Diego Biurrun committed
87
@subsection I don't hear any audio, but video is fine.
88

Diego Biurrun's avatar
Diego Biurrun committed
89 90
Maybe you didn't install LAME, or got your ./configure statement wrong. Check
the ffmpeg output to see if a line referring to MP3 is present. If not, then
91
your configuration was incorrect. If it is, then maybe your wiring is not
92
set up correctly. Maybe the sound card is not getting data from the right
93
input source. Maybe you have a really awful audio interface (like I do)
94 95
that only captures in stereo and also requires that one channel be flipped.
If you are one of these people, then export 'AUDIO_FLIP_LEFT=1' before
96 97
starting ffmpeg.

98
@subsection The audio and video loose sync after a while.
99 100 101

Yes, they do.

102
@subsection After a long while, the video update rate goes way down in WMP.
103 104 105

Yes, it does. Who knows why?

106
@subsection WMP 6.4 behaves differently to WMP 7.
107 108 109

Yes, it does. Any thoughts on this would be gratefully received. These
differences extend to embedding WMP into a web page. [There are two
110 111
object IDs that you can use: The old one, which does not play well, and
the new one, which does (both tested on the same system). However,
112 113
I suspect that the new one is not available unless you have installed WMP 7].

114
@section What else can it do?
115

116
You can replay video from .ffm files that was recorded earlier.
117
However, there are a number of caveats, including the fact that the
118
ffserver parameters must match the original parameters used to record the
119
file. If they do not, then ffserver deletes the file before recording into it.
Diego Biurrun's avatar
Diego Biurrun committed
120
(Now that I write this, it seems broken).
121 122 123

You can fiddle with many of the codec choices and encoding parameters, and
there are a bunch more parameters that you cannot control. Post a message
Diego Biurrun's avatar
Diego Biurrun committed
124
to the mailing list if there are some 'must have' parameters. Look in
125 126
ffserver.conf for a list of the currently available controls.

Diego Biurrun's avatar
Diego Biurrun committed
127 128 129
It will automatically generate the ASX or RAM files that are often used
in browsers. These files are actually redirections to the underlying ASF
or RM file. The reason for this is that the browser often fetches the
130 131
entire file before starting up the external viewer. The redirection files
are very small and can be transferred quickly. [The stream itself is
132
often 'infinite' and thus the browser tries to download it and never
133 134
finishes.]

135
@section Tips
136

137
* When you connect to a live stream, most players (WMP, RA, etc) want to
138 139
buffer a certain number of seconds of material so that they can display the
signal continuously. However, ffserver (by default) starts sending data
Diego Biurrun's avatar
Diego Biurrun committed
140
in realtime. This means that there is a pause of a few seconds while the
141
buffering is being done by the player. The good news is that this can be
142
cured by adding a '?buffer=5' to the end of the URL. This means that the
143
stream should start 5 seconds in the past -- and so the first 5 seconds
Diego Biurrun's avatar
Diego Biurrun committed
144
of the stream are sent as fast as the network will allow. It will then
145
slow down to real time. This noticeably improves the startup experience.
146 147 148 149 150 151 152 153 154

You can also add a 'Preroll 15' statement into the ffserver.conf that will
add the 15 second prebuffering on all requests that do not otherwise
specify a time. In addition, ffserver will skip frames until a key_frame
is found. This further reduces the startup delay by not transferring data
that will be discarded.

* You may want to adjust the MaxBandwidth in the ffserver.conf to limit
the amount of bandwidth consumed by live streams.
155

156
@section Why does the ?buffer / Preroll stop working after a time?
157 158 159

It turns out that (on my machine at least) the number of frames successfully
grabbed is marginally less than the number that ought to be grabbed. This
Diego Biurrun's avatar
Diego Biurrun committed
160 161 162
means that the timestamp in the encoded data stream gets behind realtime.
This means that if you say 'Preroll 10', then when the stream gets 10
or more seconds behind, there is no Preroll left.
163

164
Fixing this requires a change in the internals of how timestamps are
165 166
handled.

167
@section Does the @code{?date=} stuff work.
168

Diego Biurrun's avatar
Diego Biurrun committed
169 170
Yes (subject to the limitation outlined above). Also note that whenever you
start ffserver, it deletes the ffm file (if any parameters have changed),
171
thus wiping out what you had recorded before.
172

173
The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
174 175
of the following formats (the 'T' is literal):

176
@example
177 178
* YYYY-MM-DDTHH:MM:SS     (localtime)
* YYYY-MM-DDTHH:MM:SSZ    (UTC)
179
@end example
180

181
You can omit the YYYY-MM-DD, and then it refers to the current day. However
182 183
note that @samp{?date=16:00:00} refers to 16:00 on the current day -- this
may be in the future and so is unlikely to be useful.
184 185

You use this by adding the ?date= to the end of the URL for the stream.
186 187
For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.

188 189
@chapter Invocation
@section Syntax
190
@example
191 192 193 194 195 196 197 198 199
@c man begin SYNOPSIS
ffserver [options]
@c man end
@end example

@section Options
@c man begin OPTIONS
@table @option
@item -L
Diego Biurrun's avatar
Diego Biurrun committed
200
Print the license.
201
@item -h
Diego Biurrun's avatar
Diego Biurrun committed
202
Print the help.
203
@item -f configfile
Diego Biurrun's avatar
Diego Biurrun committed
204
Use @file{configfile} instead of @file{/etc/ffserver.conf}.
205 206 207 208 209 210 211 212 213
@end table
@c man end

@ignore

@setfilename ffsserver
@settitle FFserver video server

@c man begin SEEALSO
Fabrice Bellard's avatar
Fabrice Bellard committed
214
ffmpeg(1), ffplay(1), the @file{ffmpeg/doc/ffserver.conf} example and
Diego Biurrun's avatar
Diego Biurrun committed
215
the HTML documentation of @file{ffmpeg}.
216 217 218 219 220 221 222 223
@c man end

@c man begin AUTHOR
Fabrice Bellard
@c man end

@end ignore

224
@bye