doc/ffserver.texi

   1 \input texinfo @c -*- texinfo -*-
   2
   3 @settitle ffserver Documentation
   4 @titlepage
   5 @center @titlefont{ffserver Documentation}
   6 @end titlepage
   7
   8 @top
   9
  10 @contents
  11
  12 @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
  22 @chapter Description
  23 @c man begin DESCRIPTION
  24
  25 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
  30 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 This documentation covers only the streaming aspects of ffserver /
  36 ffmpeg. All questions about parameters for ffmpeg, codec questions,
  37 etc. are not covered here. Read @file{ffmpeg-doc.html} for more
  38 information.
  39
  40 @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 @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 @section What can this do?
  81
  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 It can stream prerecorded video from .ffm files, though it is somewhat tricky
  90 to make it work correctly.
  91
  92 @section What do I need?
  93
  94 I use Linux on a 900 MHz Duron with a cheapo Bt848 based TV capture card. I'm
  95 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
  98 I understand that FreeBSD systems work just fine as well.
  99
 100 @section How do I make it work?
 101
 102 First, build the kit. It *really* helps to have installed LAME first. Then when
 103 you run the ffserver ./configure, make sure that you have the
 104 @code{--enable-libmp3lame} flag turned on.
 105
 106 LAME is important as it allows for streaming audio to Windows Media Player.
 107 Don't ask why the other audio types do not work.
 108
 109 As a simple test, just run the following two command lines where INPUTFILE
 110 is some file which you can decode with ffmpeg:
 111
 112 @example
 113 ./ffserver -f doc/ffserver.conf &
 114 ./ffmpeg -i INPUTFILE http://localhost:8090/feed1.ffm
 115 @end example
 116
 117 At this point you should be able to go to your Windows machine and fire up
 118 Windows Media Player (WMP). Go to Open URL and enter
 119
 120 @example
 121     http://<linuxbox>:8090/test.asf
 122 @end example
 123
 124 You should (after a short delay) see video and hear audio.
 125
 126 WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
 127 transfer the entire file before starting to play.
 128 The same is true of AVI files.
 129
 130 @section What happens next?
 131
 132 You should edit the ffserver.conf file to suit your needs (in terms of
 133 frame rates etc). Then install ffserver and ffmpeg, write a script to start
 134 them up, and off you go.
 135
 136 @section Troubleshooting
 137
 138 @subsection I don't hear any audio, but video is fine.
 139
 140 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 your configuration was incorrect. If it is, then maybe your wiring is not
 143 set up correctly. Maybe the sound card is not getting data from the right
 144 input source. Maybe you have a really awful audio interface (like I do)
 145 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 starting ffmpeg.
 148
 149 @subsection The audio and video loose sync after a while.
 150
 151 Yes, they do.
 152
 153 @subsection After a long while, the video update rate goes way down in WMP.
 154
 155 Yes, it does. Who knows why?
 156
 157 @subsection WMP 6.4 behaves differently to WMP 7.
 158
 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 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 I suspect that the new one is not available unless you have installed WMP 7].
 164
 165 @section What else can it do?
 166
 167 You can replay video from .ffm files that was recorded earlier.
 168 However, there are a number of caveats, including the fact that the
 169 ffserver parameters must match the original parameters used to record the
 170 file. If they do not, then ffserver deletes the file before recording into it.
 171 (Now that I write this, it seems broken).
 172
 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 to the mailing list if there are some 'must have' parameters. Look in
 176 ffserver.conf for a list of the currently available controls.
 177
 178 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 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 often 'infinite' and thus the browser tries to download it and never
 184 finishes.]
 185
 186 @section Tips
 187
 188 * When you connect to a live stream, most players (WMP, RA, etc) want to
 189 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 in realtime. This means that there is a pause of a few seconds while the
 192 buffering is being done by the player. The good news is that this can be
 193 cured by adding a '?buffer=5' to the end of the URL. This means that the
 194 stream should start 5 seconds in the past -- and so the first 5 seconds
 195 of the stream are sent as fast as the network will allow. It will then
 196 slow down to real time. This noticeably improves the startup experience.
 197
 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
 207 @section Why does the ?buffer / Preroll stop working after a time?
 208
 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 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
 215 Fixing this requires a change in the internals of how timestamps are
 216 handled.
 217
 218 @section Does the @code{?date=} stuff work.
 219
 220 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 thus wiping out what you had recorded before.
 223
 224 The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
 225 of the following formats (the 'T' is literal):
 226
 227 @example
 228 * YYYY-MM-DDTHH:MM:SS     (localtime)
 229 * YYYY-MM-DDTHH:MM:SSZ    (UTC)
 230 @end example
 231
 232 You can omit the YYYY-MM-DD, and then it refers to the current day. However
 233 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
 236 You use this by adding the ?date= to the end of the URL for the stream.
 237 For example:   @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
 238 @c man end
 239
 240 @chapter Options
 241 @c man begin OPTIONS
 242
 243 @include fftools-common-opts.texi
 244
 245 @section Main options
 246
 247 @table @option
 248 @item -f @var{configfile}
 249 Use @file{configfile} instead of @file{/etc/ffserver.conf}.
 250 @item -n
 251 Enable no-launch mode. This option disables all the Launch directives
 252 within the various <Stream> sections. Since ffserver will not launch
 253 any ffmpeg instances, you will have to launch them manually.
 254 @item -d
 255 Enable debug mode. This option increases log verbosity, directs log
 256 messages to stdout and causes ffserver to run in the foreground
 257 rather than as a daemon.
 258 @end table
 259 @c man end
 260
 261 @ignore
 262
 263 @setfilename ffserver
 264 @settitle ffserver video server
 265
 266 @c man begin SEEALSO
 267
 268 ffmpeg(1), ffplay(1), ffprobe(1), the @file{ffmpeg/doc/ffserver.conf}
 269 example and the FFmpeg HTML documentation
 270 @c man end
 271
 272 @c man begin AUTHORS
 273 The FFmpeg developers
 274 @c man end
 275
 276 @end ignore
 277
 278 @bye