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

3
@settitle ffserver Documentation
4
@titlepage
5
@center @titlefont{ffserver Documentation}
6
@end titlepage
7

8 9 10 11
@top

@contents

12
@chapter Synopsis
13

14
ffserver [@var{options}]
15

16
@chapter Description
17
@c man begin DESCRIPTION
18

19 20 21 22 23 24 25 26
@command{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.

@command{ffserver} is configured through a configuration file, which
is read at startup. If not explicitly specified, it will read from
@file{/etc/ffserver.conf}.
27

28 29 30
@command{ffserver} receives prerecorded files or FFM streams from some
@command{ffmpeg} instance as input, then streams them over
RTP/RTSP/HTTP.
31

32 33 34 35 36
An @command{ffserver} instance will listen on some port as specified
in the configuration file. You can launch one or more instances of
@command{ffmpeg} and send one or more FFM streams to the port where
ffserver is expecting to receive them. Alternately, you can make
@command{ffserver} launch such @command{ffmpeg} instances at startup.
37

38 39
Input streams are called feeds, and each one is specified by a
@code{<Feed>} section in the configuration file.
40 41

For each feed you can have different output streams in various
42 43
formats, each one specified by a @code{<Stream>} section in the
configuration file.
44

45 46 47 48 49 50 51
@chapter Detailed description

@command{ffserver} works by forwarding streams encoded by
@command{ffmpeg}, or pre-recorded streams which are read from disk.

Precisely, @command{ffserver} acts as an HTTP server, accepting POST
requests from @command{ffmpeg} to acquire the stream to publish, and
52 53
serving RTSP clients or HTTP clients GET requests with the stream
media content.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68

A feed is an @ref{FFM} stream created by @command{ffmpeg}, and sent to
a port where @command{ffserver} is listening.

Each feed is identified by a unique name, corresponding to the name
of the resource published on @command{ffserver}, and is configured by
a dedicated @code{Feed} section in the configuration file.

The feed publish URL is given by:
@example
http://@var{ffserver_ip_address}:@var{http_port}/@var{feed_name}
@end example

where @var{ffserver_ip_address} is the IP address of the machine where
@command{ffserver} is installed, @var{http_port} is the port number of
69
the HTTP server (configured through the @option{HTTPPort} option), and
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
@var{feed_name} is the name of the corresponding feed defined in the
configuration file.

Each feed is associated to a file which is stored on disk. This stored
file is used to allow to send pre-recorded data to a player as fast as
possible when new content is added in real-time to the stream.

A "live-stream" or "stream" is a resource published by
@command{ffserver}, and made accessible through the HTTP protocol to
clients.

A stream can be connected to a feed, or to a file. In the first case,
the published stream is forwarded from the corresponding feed
generated by a running instance of @command{ffmpeg}, in the second
case the stream is read from a pre-recorded file.

Each stream is identified by a unique name, corresponding to the name
of the resource served by @command{ffserver}, and is configured by
a dedicated @code{Stream} section in the configuration file.

90
The stream access HTTP URL is given by:
91 92 93 94
@example
http://@var{ffserver_ip_address}:@var{http_port}/@var{stream_name}[@var{options}]
@end example

95 96 97 98 99
The stream access RTSP URL is given by:
@example
http://@var{ffserver_ip_address}:@var{rtsp_port}/@var{stream_name}[@var{options}]
@end example

100 101 102
@var{stream_name} is the name of the corresponding stream defined in
the configuration file. @var{options} is a list of options specified
after the URL which affects how the stream is served by
103
@command{ffserver}. @var{http_port} and @var{rtsp_port} are the HTTP
104
and RTSP ports configured with the options @var{HTTPPort} and
105
@var{RTSPPort} respectively.
106 107 108 109 110 111 112 113

In case the stream is associated to a feed, the encoding parameters
must be configured in the stream configuration. They are sent to
@command{ffmpeg} when setting up the encoding. This allows
@command{ffserver} to define the encoding parameters used by
the @command{ffmpeg} encoders.

The @command{ffmpeg} @option{override_ffserver} commandline option
114
allows one to override the encoding parameters set by the server.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160

Multiple streams can be connected to the same feed.

For example, you can have a situation described by the following
graph:
@example
               _________       __________
              |         |     |          |
ffmpeg 1 -----| feed 1  |-----| stream 1 |
    \         |_________|\    |__________|
     \                    \
      \                    \   __________
       \                    \ |          |
        \                    \| stream 2 |
         \                    |__________|
          \
           \   _________       __________
            \ |         |     |          |
             \| feed 2  |-----| stream 3 |
              |_________|     |__________|

               _________       __________
              |         |     |          |
ffmpeg 2 -----| feed 3  |-----| stream 4 |
              |_________|     |__________|

               _________       __________
              |         |     |          |
              | file 1  |-----| stream 5 |
              |_________|     |__________|
@end example

@anchor{FFM}
@section FFM, FFM2 formats

FFM and FFM2 are formats used by ffserver. They allow storing a wide variety of
video and audio streams and encoding options, and can store a moving time segment
of an infinite movie or a whole movie.

FFM is version specific, and there is limited compatibility of FFM files
generated by one version of ffmpeg/ffserver and another version of
ffmpeg/ffserver. It may work but it is not guaranteed to work.

FFM2 is extensible while maintaining compatibility and should work between
differing versions of tools. FFM2 is the default.

161 162
@section Status stream

163 164
@command{ffserver} supports an HTTP interface which exposes the
current status of the server.
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182

Simply point your browser to the address of the special status stream
specified in the configuration file.

For example if you have:
@example
<Stream status.html>
Format status

# Only allow local people to get the status
ACL allow localhost
ACL allow 192.168.0.0 192.168.255.255
</Stream>
@end example

then the server will post a page with the status information when
the special stream @file{status.html} is requested.

183
@section How do I make it work?
184

185 186
As a simple test, just run the following two command lines where INPUTFILE
is some file which you can decode with ffmpeg:
187

188
@example
189 190
ffserver -f doc/ffserver.conf &
ffmpeg -i INPUTFILE http://localhost:8090/feed1.ffm
191
@end example
192

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

196
@example
197
    http://<linuxbox>:8090/test.asf
198
@end example
199

200
You should (after a short delay) see video and hear audio.
201

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

206 207 208
You should edit the @file{ffserver.conf} file to suit your needs (in
terms of frame rates etc). Then install @command{ffserver} and
@command{ffmpeg}, write a script to start them up, and off you go.
209

210
@section What else can it do?
211

212
You can replay video from .ffm files that was recorded earlier.
213
However, there are a number of caveats, including the fact that the
214
ffserver parameters must match the original parameters used to record the
215
file. If they do not, then ffserver deletes the file before recording into it.
Diego Biurrun's avatar
Diego Biurrun committed
216
(Now that I write this, it seems broken).
217 218 219

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
220
to the mailing list if there are some 'must have' parameters. Look in
221 222
ffserver.conf for a list of the currently available controls.

Diego Biurrun's avatar
Diego Biurrun committed
223 224 225
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
226 227
entire file before starting up the external viewer. The redirection files
are very small and can be transferred quickly. [The stream itself is
228
often 'infinite' and thus the browser tries to download it and never
229 230
finishes.]

231
@section Tips
232

233
* When you connect to a live stream, most players (WMP, RA, etc) want to
234 235
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
236
in realtime. This means that there is a pause of a few seconds while the
237
buffering is being done by the player. The good news is that this can be
238
cured by adding a '?buffer=5' to the end of the URL. This means that the
239
stream should start 5 seconds in the past -- and so the first 5 seconds
Diego Biurrun's avatar
Diego Biurrun committed
240
of the stream are sent as fast as the network will allow. It will then
241
slow down to real time. This noticeably improves the startup experience.
242 243 244 245 246 247 248

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.

249
@section Why does the ?buffer / Preroll stop working after a time?
250 251 252

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
253 254 255
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.
256

257
Fixing this requires a change in the internals of how timestamps are
258 259
handled.

260
@section Does the @code{?date=} stuff work.
261

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

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

269
@example
270 271
* YYYY-MM-DDTHH:MM:SS     (localtime)
* YYYY-MM-DDTHH:MM:SSZ    (UTC)
272
@end example
273

274
You can omit the YYYY-MM-DD, and then it refers to the current day. However
275 276
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.
277 278

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

282
@chapter Options
283
@c man begin OPTIONS
284

285
@include fftools-common-opts.texi
286

287 288
@section Main options

289
@table @option
290
@item -f @var{configfile}
291 292
Read configuration file @file{configfile}. If not specified it will
read by default from @file{/etc/ffserver.conf}.
293

294
@item -n
295
Enable no-launch mode. This option disables all the @code{Launch}
296
directives within the various @code{<Feed>} sections. Since
297 298 299
@command{ffserver} will not launch any @command{ffmpeg} instances, you
will have to launch them manually.

300
@item -d
301 302 303
Enable debug mode. This option increases log verbosity, and directs
log messages to stdout. When specified, the @option{CustomLog} option
is ignored.
304
@end table
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320

@chapter Configuration file syntax

@command{ffserver} reads a configuration file containing global
options and settings for each stream and feed.

The configuration file consists of global options and dedicated
sections, which must be introduced by "<@var{SECTION_NAME}
@var{ARGS}>" on a separate line and must be terminated by a line in
the form "</@var{SECTION_NAME}>". @var{ARGS} is optional.

Currently the following sections are recognized: @samp{Feed},
@samp{Stream}, @samp{Redirect}.

A line starting with @code{#} is ignored and treated as a comment.

321 322
Name of options and sections are case-insensitive.

323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
@section ACL syntax
An ACL (Access Control List) specifies the address which are allowed
to access a given stream, or to write a given feed.

It accepts the folling forms
@itemize
@item
Allow/deny access to @var{address}.
@example
ACL ALLOW <address>
ACL DENY <address>
@end example

@item
Allow/deny access to ranges of addresses from @var{first_address} to
@var{last_address}.
@example
ACL ALLOW <first_address> <last_address>
ACL DENY <first_address> <last_address>
@end example
@end itemize

You can repeat the ACL allow/deny as often as you like. It is on a per
stream basis. The first match defines the action. If there are no matches,
then the default is the inverse of the last ACL statement.

Thus 'ACL allow localhost' only allows access from localhost.
'ACL deny 1.0.0.0 1.255.255.255' would deny the whole of network 1 and
allow everybody else.

353 354
@section Global options
@table @option
355
@item HTTPPort @var{port_number}
356 357 358
@item Port @var{port_number}
@item RTSPPort @var{port_number}

359 360 361 362 363 364 365
@var{HTTPPort} sets the HTTP server listening TCP port number,
@var{RTSPPort} sets the RTSP server listening TCP port number.

@var{Port} is the equivalent of @var{HTTPPort} and is deprecated.

You must select a different port from your standard HTTP web server if
it is running on the same computer.
366 367 368

If not specified, no corresponding server will be created.

369
@item HTTPBindAddress @var{ip_address}
370 371
@item BindAddress @var{ip_address}
@item RTSPBindAddress @var{ip_address}
372
Set address on which the HTTP/RTSP server is bound. Only useful if you
373 374
have several network interfaces.

375 376 377
@var{BindAddress} is the equivalent of @var{HTTPBindAddress} and is
deprecated.

378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
@item MaxHTTPConnections @var{n}
Set number of simultaneous HTTP connections that can be handled. It
has to be defined @emph{before} the @option{MaxClients} parameter,
since it defines the @option{MaxClients} maximum limit.

Default value is 2000.

@item MaxClients @var{n}
Set number of simultaneous requests that can be handled. Since
@command{ffserver} is very fast, it is more likely that you will want
to leave this high and use @option{MaxBandwidth}.

Default value is 5.

@item MaxBandwidth @var{kbps}
Set the maximum amount of kbit/sec that you are prepared to consume
when streaming to clients.

Default value is 1000.

@item CustomLog @var{filename}
399 400
Set access log file (uses standard Apache log file format). '-' is the
standard output.
401

402
If not specified @command{ffserver} will produce no log.
403 404

In case the commandline option @option{-d} is specified this option is
405
ignored, and the log is written to standard output.
406 407 408

@item NoDaemon
Set no-daemon mode. This option is currently ignored since now
409 410
@command{ffserver} will always work in no-daemon mode, and is
deprecated.
411 412 413 414 415 416

@item UseDefaults
@item NoDefaults
Control whether default codec options are used for the all streams or not.
Each stream may overwrite this setting for its own. Default is @var{UseDefaults}.
The lastest occurrence overrides previous if multiple definitions.
417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
@end table

@section Feed section

A Feed section defines a feed provided to @command{ffserver}.

Each live feed contains one video and/or audio sequence coming from an
@command{ffmpeg} encoder or another @command{ffserver}. This sequence
may be encoded simultaneously with several codecs at several
resolutions.

A feed instance specification is introduced by a line in the form:
@example
<Feed FEED_FILENAME>
@end example

where @var{FEED_FILENAME} specifies the unique name of the FFM stream.

The following options are recognized within a Feed section.

@table @option
@item File @var{filename}
439 440 441 442 443 444 445 446 447 448 449 450 451
@item ReadOnlyFile @var{filename}
Set the path where the feed file is stored on disk.

If not specified, the @file{/tmp/FEED.ffm} is assumed, where
@var{FEED} is the feed name.

If @option{ReadOnlyFile} is used the file is marked as read-only and
it will not be deleted or updated.

@item Truncate
Truncate the feed file, rather than appending to it. By default
@command{ffserver} will append data to the file, until the maximum
file size value is reached (see @option{FileMaxSize} option).
452 453

@item FileMaxSize @var{size}
454 455 456
Set maximum size of the feed file in bytes. 0 means unlimited. The
postfixes @code{K} (2^10), @code{M} (2^20), and @code{G} (2^30) are
recognized.
457

458
Default value is 5M.
459

460 461 462 463 464 465 466 467 468
@item Launch @var{args}
Launch an @command{ffmpeg} command when creating @command{ffserver}.

@var{args} must be a sequence of arguments to be provided to an
@command{ffmpeg} instance. The first provided argument is ignored, and
it is replaced by a path with the same dirname of the @command{ffserver}
instance, followed by the remaining argument and terminated with a
path corresponding to the feed.

469 470 471
When the launched process exits, @command{ffserver} will launch
another program instance.

472 473 474 475 476 477
In case you need a more complex @command{ffmpeg} configuration,
e.g. if you need to generate multiple FFM feeds with a single
@command{ffmpeg} instance, you should launch @command{ffmpeg} by hand.

This option is ignored in case the commandline option @option{-n} is
specified.
478

479
@item ACL @var{spec}
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
Specify the list of IP address which are allowed or denied to write
the feed. Multiple ACL options can be specified.
@end table

@section Stream section

A Stream section defines a stream provided by @command{ffserver}, and
identified by a single name.

The stream is sent when answering a request containing the stream
name.

A stream section must be introduced by the line:
@example
<Stream STREAM_NAME>
@end example

where @var{STREAM_NAME} specifies the unique name of the stream.

The following options are recognized within a Stream section.

501 502 503 504 505 506 507 508
Encoding options are marked with the @emph{encoding} tag, and they are
used to set the encoding parameters, and are mapped to libavcodec
encoding options. Not all encoding options are supported, in
particular it is not possible to set encoder private options. In order
to override the encoding options specified by @command{ffserver}, you
can use the @command{ffmpeg} @option{override_ffserver} commandline
option.

509 510
Only one of the @option{Feed} and @option{File} options should be set.

511 512
@table @option
@item Feed @var{feed_name}
513 514 515 516 517 518 519 520
Set the input feed. @var{feed_name} must correspond to an existing
feed defined in a @code{Feed} section.

When this option is set, encoding options are used to setup the
encoding operated by the remote @command{ffmpeg} process.

@item File @var{filename}
Set the filename of the pre-recorded input file to stream.
521

522 523
When this option is set, encoding options are ignored and the input
file content is re-streamed as is.
524 525

@item Format @var{format_name}
526
Set the format of the output stream.
527

528 529
Must be the name of a format recognized by FFmpeg. If set to
@samp{status}, it is treated as a status stream.
530

531 532 533
@item InputFormat @var{format_name}
Set input format. If not specified, it is automatically guessed.

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
@item Preroll @var{n}
Set this to the number of seconds backwards in time to start. Note that
most players will buffer 5-10 seconds of video, and also you need to allow
for a keyframe to appear in the data stream.

Default value is 0.

@item StartSendOnKey
Do not send stream until it gets the first key frame. By default
@command{ffserver} will send data immediately.

@item MaxTime @var{n}
Set the number of seconds to run. This value set the maximum duration
of the stream a client will be able to receive.

A value of 0 means that no limit is set on the stream duration.

@item ACL @var{spec}
Set ACL for the stream.

554 555
@item DynamicACL @var{spec}

556
@item RTSPOption @var{option}
557 558 559 560 561 562 563 564 565

@item MulticastAddress @var{address}

@item MulticastPort @var{port}

@item MulticastTTL @var{integer}

@item NoLoop

566 567 568 569 570 571 572 573
@item FaviconURL @var{url}
Set favicon (favourite icon) for the server status page. It is ignored
for regular streams.

@item Author @var{value}
@item Comment @var{value}
@item Copyright @var{value}
@item Title @var{value}
574 575 576 577 578
Set metadata corresponding to the option. All these options are
deprecated in favor of @option{Metadata}.

@item Metadata @var{key} @var{value}
Set metadata value on the output stream.
579

580 581 582 583 584
@item UseDefaults
@item NoDefaults
Control whether default codec options are used for the stream or not.
Default is @var{UseDefaults} unless disabled globally.

585 586 587 588
@item NoAudio
@item NoVideo
Suppress audio/video.

589 590 591 592
@item AudioCodec @var{codec_name} (@emph{encoding,audio})
Set audio codec.

@item AudioBitRate @var{rate} (@emph{encoding,audio})
593
Set bitrate for the audio stream in kbits per second.
594

595
@item AudioChannels @var{n} (@emph{encoding,audio})
596 597
Set number of audio channels.

598
@item AudioSampleRate @var{n} (@emph{encoding,audio})
599 600 601 602
Set sampling frequency for audio. When using low bitrates, you should
lower this frequency to 22050 or 11025. The supported frequencies
depend on the selected audio codec.

603 604 605
@item AVOptionAudio [@var{codec}:]@var{option} @var{value} (@emph{encoding,audio})
Set generic or private option for audio stream.
Private option must be prefixed with codec name or codec must be defined before.
606 607 608 609 610 611 612 613

@item AVPresetAudio @var{preset} (@emph{encoding,audio})
Set preset for audio stream.

@item VideoCodec @var{codec_name} (@emph{encoding,video})
Set video codec.

@item VideoBitRate @var{n} (@emph{encoding,video})
614
Set bitrate for the video stream in kbits per second.
615

616
@item VideoBitRateRange @var{range} (@emph{encoding,video})
617 618
Set video bitrate range.

619 620
A range must be specified in the form @var{minrate}-@var{maxrate}, and
specifies the @option{minrate} and @option{maxrate} encoding options
621
expressed in kbits per second.
622

623
@item VideoBitRateRangeTolerance @var{n} (@emph{encoding,video})
624
Set video bitrate tolerance in kbits per second.
625

626
@item PixelFormat @var{pixel_format} (@emph{encoding,video})
627 628
Set video pixel format.

629
@item Debug @var{integer} (@emph{encoding,video})
630 631
Set video @option{debug} encoding option.

632
@item Strict @var{integer} (@emph{encoding,video})
633 634
Set video @option{strict} encoding option.

635
@item VideoBufferSize @var{n} (@emph{encoding,video})
636
Set ratecontrol buffer size, expressed in KB.
637

638
@item VideoFrameRate @var{n} (@emph{encoding,video})
639 640
Set number of video frames per second.

641
@item VideoSize (@emph{encoding,video})
642 643 644 645 646 647
Set size of the video frame, must be an abbreviation or in the form
@var{W}x@var{H}.  See @ref{video size syntax,,the Video size section
in the ffmpeg-utils(1) manual,ffmpeg-utils}.

Default value is @code{160x128}.

648
@item VideoIntraOnly (@emph{encoding,video})
649 650
Transmit only intra frames (useful for low bitrates, but kills frame rate).

651
@item VideoGopSize @var{n} (@emph{encoding,video})
652 653 654
If non-intra only, an intra frame is transmitted every VideoGopSize
frames. Video synchronization can only begin at an intra frame.

655
@item VideoTag @var{tag} (@emph{encoding,video})
656 657
Set video tag.

658 659
@item VideoHighQuality (@emph{encoding,video})
@item Video4MotionVector (@emph{encoding,video})
660

661
@item BitExact (@emph{encoding,video})
662 663
Set bitexact encoding flag.

664
@item IdctSimple (@emph{encoding,video})
665 666
Set simple IDCT algorithm.

667
@item Qscale @var{n} (@emph{encoding,video})
668 669 670
Enable constant quality encoding, and set video qscale (quantization
scale) value, expressed in @var{n} QP units.

671 672
@item VideoQMin @var{n} (@emph{encoding,video})
@item VideoQMax @var{n} (@emph{encoding,video})
673 674
Set video qmin/qmax.

675
@item VideoQDiff @var{integer} (@emph{encoding,video})
676 677
Set video @option{qdiff} encoding option.

678 679
@item LumiMask @var{float} (@emph{encoding,video})
@item DarkMask @var{float} (@emph{encoding,video})
680 681
Set @option{lumi_mask}/@option{dark_mask} encoding options.

682 683 684
@item AVOptionVideo [@var{codec}:]@var{option} @var{value} (@emph{encoding,video})
Set generic or private option for video stream.
Private option must be prefixed with codec name or codec must be defined before.
685

686 687
@item AVPresetVideo @var{preset} (@emph{encoding,video})
Set preset for video stream.
688 689 690 691 692 693 694 695 696 697

@var{preset} must be the path of a preset file.
@end table

@subsection Server status stream

A server status stream is a special stream which is used to show
statistics about the @command{ffserver} operations.

It must be specified setting the option @option{Format} to
698
@samp{status}.
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

@section Redirect section

A redirect section specifies where to redirect the requested URL to
another page.

A redirect section must be introduced by the line:
@example
<Redirect NAME>
@end example

where @var{NAME} is the name of the page which should be redirected.

It only accepts the option @option{URL}, which specify the redirection
URL.

@chapter Stream examples

@itemize
@item
Multipart JPEG
@example
<Stream test.mjpg>
Feed feed1.ffm
Format mpjpeg
VideoFrameRate 2
VideoIntraOnly
NoAudio
Strict -1
</Stream>
@end example

@item
Single JPEG
@example
<Stream test.jpg>
Feed feed1.ffm
Format jpeg
VideoFrameRate 2
VideoIntraOnly
739
VideoSize 352x240
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
NoAudio
Strict -1
</Stream>
@end example

@item
Flash
@example
<Stream test.swf>
Feed feed1.ffm
Format swf
VideoFrameRate 2
VideoIntraOnly
NoAudio
</Stream>
@end example

@item
ASF compatible
@example
<Stream test.asf>
Feed feed1.ffm
Format asf
VideoFrameRate 15
VideoSize 352x240
VideoBitRate 256
VideoBufferSize 40
VideoGopSize 30
AudioBitRate 64
StartSendOnKey
</Stream>
@end example

@item
MP3 audio
@example
<Stream test.mp3>
Feed feed1.ffm
Format mp2
AudioCodec mp3
AudioBitRate 64
AudioChannels 1
AudioSampleRate 44100
NoVideo
</Stream>
@end example

@item
788
Ogg Vorbis audio
789 790 791
@example
<Stream test.ogg>
Feed feed1.ffm
792
Metadata title "Stream title"
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838
AudioBitRate 64
AudioChannels 2
AudioSampleRate 44100
NoVideo
</Stream>
@end example

@item
Real with audio only at 32 kbits
@example
<Stream test.ra>
Feed feed1.ffm
Format rm
AudioBitRate 32
NoVideo
</Stream>
@end example

@item
Real with audio and video at 64 kbits
@example
<Stream test.rm>
Feed feed1.ffm
Format rm
AudioBitRate 32
VideoBitRate 128
VideoFrameRate 25
VideoGopSize 25
</Stream>
@end example

@item
For stream coming from a file: you only need to set the input filename
and optionally a new format.

@example
<Stream file.rm>
File "/usr/local/httpd/htdocs/tlive.rm"
NoAudio
</Stream>
@end example

@example
<Stream file.asf>
File "/usr/local/httpd/htdocs/test.asf"
NoAudio
839 840 841 842
Metadata author "Me"
Metadata copyright "Super MegaCorp"
Metadata title "Test stream from disk"
Metadata comment "Test comment"
843 844 845 846
</Stream>
@end example
@end itemize

847 848
@c man end

849
@include config.texi
850
@ifset config-all
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873
@ifset config-avutil
@include utils.texi
@end ifset
@ifset config-avcodec
@include codecs.texi
@include bitstream_filters.texi
@end ifset
@ifset config-avformat
@include formats.texi
@include protocols.texi
@end ifset
@ifset config-avdevice
@include devices.texi
@end ifset
@ifset config-swresample
@include resampler.texi
@end ifset
@ifset config-swscale
@include scaler.texi
@end ifset
@ifset config-avfilter
@include filters.texi
@end ifset
874 875
@end ifset

876 877 878
@chapter See Also

@ifhtml
879 880 881 882 883 884 885
@ifset config-all
@url{ffserver.html,ffserver},
@end ifset
@ifset config-not-all
@url{ffserver-all.html,ffserver-all},
@end ifset
the @file{doc/ffserver.conf} example,
886 887 888 889 890
@url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
@url{ffmpeg-utils.html,ffmpeg-utils},
@url{ffmpeg-scaler.html,ffmpeg-scaler},
@url{ffmpeg-resampler.html,ffmpeg-resampler},
@url{ffmpeg-codecs.html,ffmpeg-codecs},
891
@url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
892 893 894 895 896 897 898
@url{ffmpeg-formats.html,ffmpeg-formats},
@url{ffmpeg-devices.html,ffmpeg-devices},
@url{ffmpeg-protocols.html,ffmpeg-protocols},
@url{ffmpeg-filters.html,ffmpeg-filters}
@end ifhtml

@ifnothtml
899 900 901 902 903 904 905
@ifset config-all
ffserver(1),
@end ifset
@ifset config-not-all
ffserver-all(1),
@end ifset
the @file{doc/ffserver.conf} example, ffmpeg(1), ffplay(1), ffprobe(1),
906 907 908 909 910
ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
@end ifnothtml

911 912
@include authors.texi

913 914
@ignore

915
@setfilename ffserver
916
@settitle ffserver video server
917 918 919

@end ignore

920
@bye