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