Remove useless intermediate var
[FFMpeg-mirror/DVCPRO-HD.git] / doc / ffserver.conf
blobf7db66ed26c67bd271b06fe60923809788ae973b
1 # Port on which the server is listening. You must select a different
2 # port from your standard HTTP web server if it is running on the same
3 # computer.
4 Port 8090
6 # Address on which the server is bound. Only useful if you have
7 # several network interfaces.
8 BindAddress 0.0.0.0
10 # Number of simultaneous requests that can be handled. Since FFServer
11 # is very fast, it is more likely that you will want to leave this high
12 # and use MaxBandwidth, below.
13 MaxClients 1000
15 # This the maximum amount of kbit/sec that you are prepared to
16 # consume when streaming to clients.
17 MaxBandwidth 1000
19 # Access log file (uses standard Apache log file format)
20 # '-' is the standard output.
21 CustomLog -
23 # Suppress that if you want to launch ffserver as a daemon.
24 NoDaemon
27 ##################################################################
28 # Definition of the live feeds. Each live feed contains one video
29 # and/or audio sequence coming from an ffmpeg encoder or another
30 # ffserver. This sequence may be encoded simultaneously with several
31 # codecs at several resolutions.
33 <Feed feed1.ffm>
35 # You must use 'ffmpeg' to send a live feed to ffserver. In this
36 # example, you can type:
38 # ffmpeg http://localhost:8090/feed1.ffm
40 # ffserver can also do time shifting. It means that it can stream any
41 # previously recorded live stream. The request should contain:
42 # "http://xxxx?date=[YYYY-MM-DDT][[HH:]MM:]SS[.m...]".You must specify
43 # a path where the feed is stored on disk. You also specify the
44 # maximum size of the feed, where zero means unlimited. Default:
45 # File=/tmp/feed_name.ffm FileMaxSize=5M
46 File /tmp/feed1.ffm
47 FileMaxSize 200K
49 # You could specify
50 # ReadOnlyFile /saved/specialvideo.ffm
51 # This marks the file as readonly and it will not be deleted or updated.
53 # Specify launch in order to start ffmpeg automatically.
54 # First ffmpeg must be defined with an appropriate path if needed,
55 # after that options can follow, but avoid adding the http:// field
56 #Launch ffmpeg
58 # Only allow connections from localhost to the feed.
59 ACL allow 127.0.0.1
61 </Feed>
64 ##################################################################
65 # Now you can define each stream which will be generated from the
66 # original audio and video stream. Each format has a filename (here
67 # 'test1.mpg'). FFServer will send this stream when answering a
68 # request containing this filename.
70 <Stream test1.mpg>
72 # coming from live feed 'feed1'
73 Feed feed1.ffm
75 # Format of the stream : you can choose among:
76 # mpeg       : MPEG-1 multiplexed video and audio
77 # mpegvideo  : only MPEG-1 video
78 # mp2        : MPEG-2 audio (use AudioCodec to select layer 2 and 3 codec)
79 # ogg        : Ogg format (Vorbis audio codec)
80 # rm         : RealNetworks-compatible stream. Multiplexed audio and video.
81 # ra         : RealNetworks-compatible stream. Audio only.
82 # mpjpeg     : Multipart JPEG (works with Netscape without any plugin)
83 # jpeg       : Generate a single JPEG image.
84 # asf        : ASF compatible streaming (Windows Media Player format).
85 # swf        : Macromedia Flash compatible stream
86 # avi        : AVI format (MPEG-4 video, MPEG audio sound)
87 # master     : special ffmpeg stream used to duplicate a server
88 Format mpeg
90 # Bitrate for the audio stream. Codecs usually support only a few
91 # different bitrates.
92 AudioBitRate 32
94 # Number of audio channels: 1 = mono, 2 = stereo
95 AudioChannels 1
97 # Sampling frequency for audio. When using low bitrates, you should
98 # lower this frequency to 22050 or 11025. The supported frequencies
99 # depend on the selected audio codec.
100 AudioSampleRate 44100
102 # Bitrate for the video stream
103 VideoBitRate 64
105 # Ratecontrol buffer size
106 VideoBufferSize 40
108 # Number of frames per second
109 VideoFrameRate 3
111 # Size of the video frame: WxH (default: 160x128)
112 # The following abbreviations are defined: sqcif, qcif, cif, 4cif, qqvga,
113 # qvga, vga, svga, xga, uxga, qxga, sxga, qsxga, hsxga, wvga, wxga, wsxga,
114 # wuxga, woxga, wqsxga, wquxga, whsxga, whuxga, cga, ega, hd480, hd720,
115 # hd1080
116 VideoSize 160x128
118 # Transmit only intra frames (useful for low bitrates, but kills frame rate).
119 #VideoIntraOnly
121 # If non-intra only, an intra frame is transmitted every VideoGopSize
122 # frames. Video synchronization can only begin at an intra frame.
123 VideoGopSize 12
125 # More MPEG-4 parameters
126 # VideoHighQuality
127 # Video4MotionVector
129 # Choose your codecs:
130 #AudioCodec mp2
131 #VideoCodec mpeg1video
133 # Suppress audio
134 #NoAudio
136 # Suppress video
137 #NoVideo
139 #VideoQMin 3
140 #VideoQMax 31
142 # Set this to the number of seconds backwards in time to start. Note that
143 # most players will buffer 5-10 seconds of video, and also you need to allow
144 # for a keyframe to appear in the data stream.
145 #Preroll 15
147 # ACL:
149 # You can allow ranges of addresses (or single addresses)
150 #ACL ALLOW <first address> <last address>
152 # You can deny ranges of addresses (or single addresses)
153 #ACL DENY <first address> <last address>
155 # You can repeat the ACL allow/deny as often as you like. It is on a per
156 # stream basis. The first match defines the action. If there are no matches,
157 # then the default is the inverse of the last ACL statement.
159 # Thus 'ACL allow localhost' only allows access from localhost.
160 # 'ACL deny 1.0.0.0 1.255.255.255' would deny the whole of network 1 and
161 # allow everybody else.
163 </Stream>
166 ##################################################################
167 # Example streams
170 # Multipart JPEG
172 #<Stream test.mjpg>
173 #Feed feed1.ffm
174 #Format mpjpeg
175 #VideoFrameRate 2
176 #VideoIntraOnly
177 #NoAudio
178 #Strict -1
179 #</Stream>
182 # Single JPEG
184 #<Stream test.jpg>
185 #Feed feed1.ffm
186 #Format jpeg
187 #VideoFrameRate 2
188 #VideoIntraOnly
189 ##VideoSize 352x240
190 #NoAudio
191 #Strict -1
192 #</Stream>
195 # Flash
197 #<Stream test.swf>
198 #Feed feed1.ffm
199 #Format swf
200 #VideoFrameRate 2
201 #VideoIntraOnly
202 #NoAudio
203 #</Stream>
206 # ASF compatible
208 <Stream test.asf>
209 Feed feed1.ffm
210 Format asf
211 VideoFrameRate 15
212 VideoSize 352x240
213 VideoBitRate 256
214 VideoBufferSize 40
215 VideoGopSize 30
216 AudioBitRate 64
217 StartSendOnKey
218 </Stream>
221 # MP3 audio
223 #<Stream test.mp3>
224 #Feed feed1.ffm
225 #Format mp2
226 #AudioCodec mp3
227 #AudioBitRate 64
228 #AudioChannels 1
229 #AudioSampleRate 44100
230 #NoVideo
231 #</Stream>
234 # Ogg Vorbis audio
236 #<Stream test.ogg>
237 #Feed feed1.ffm
238 #Title "Stream title"
239 #AudioBitRate 64
240 #AudioChannels 2
241 #AudioSampleRate 44100
242 #NoVideo
243 #</Stream>
246 # Real with audio only at 32 kbits
248 #<Stream test.ra>
249 #Feed feed1.ffm
250 #Format rm
251 #AudioBitRate 32
252 #NoVideo
253 #NoAudio
254 #</Stream>
257 # Real with audio and video at 64 kbits
259 #<Stream test.rm>
260 #Feed feed1.ffm
261 #Format rm
262 #AudioBitRate 32
263 #VideoBitRate 128
264 #VideoFrameRate 25
265 #VideoGopSize 25
266 #NoAudio
267 #</Stream>
270 ##################################################################
271 # A stream coming from a file: you only need to set the input
272 # filename and optionally a new format. Supported conversions:
273 #    AVI -> ASF
275 #<Stream file.rm>
276 #File "/usr/local/httpd/htdocs/tlive.rm"
277 #NoAudio
278 #</Stream>
280 #<Stream file.asf>
281 #File "/usr/local/httpd/htdocs/test.asf"
282 #NoAudio
283 #Author "Me"
284 #Copyright "Super MegaCorp"
285 #Title "Test stream from disk"
286 #Comment "Test comment"
287 #</Stream>
290 ##################################################################
291 # RTSP examples
293 # You can access this stream with the RTSP URL:
294 #   rtsp://localhost:5454/test1-rtsp.mpg
296 # A non-standard RTSP redirector is also created. Its URL is:
297 #   http://localhost:8090/test1-rtsp.rtsp
299 #<Stream test1-rtsp.mpg>
300 #Format rtp
301 #File "/usr/local/httpd/htdocs/test1.mpg"
302 #</Stream>
305 ##################################################################
306 # SDP/multicast examples
308 # If you want to send your stream in multicast, you must set the
309 # multicast address with MulticastAddress. The port and the TTL can
310 # also be set.
312 # An SDP file is automatically generated by ffserver by adding the
313 # 'sdp' extension to the stream name (here
314 # http://localhost:8090/test1-sdp.sdp). You should usually give this
315 # file to your player to play the stream.
317 # The 'NoLoop' option can be used to avoid looping when the stream is
318 # terminated.
320 #<Stream test1-sdp.mpg>
321 #Format rtp
322 #File "/usr/local/httpd/htdocs/test1.mpg"
323 #MulticastAddress 224.124.0.1
324 #MulticastPort 5000
325 #MulticastTTL 16
326 #NoLoop
327 #</Stream>
330 ##################################################################
331 # Special streams
333 # Server status
335 <Stream stat.html>
336 Format status
338 # Only allow local people to get the status
339 ACL allow localhost
340 ACL allow 192.168.0.0 192.168.255.255
342 #FaviconURL http://pond1.gladstonefamily.net:8080/favicon.ico
343 </Stream>
346 # Redirect index.html to the appropriate site
348 <Redirect index.html>
349 URL http://www.ffmpeg.org/
350 </Redirect>