2002-11-19 19:47:50 +00:00
|
|
|
\input texinfo @c -*- texinfo -*-
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2011-04-23 13:19:17 +00:00
|
|
|
@settitle ffserver Documentation
|
2002-11-19 19:47:50 +00:00
|
|
|
@titlepage
|
2011-04-23 13:19:17 +00:00
|
|
|
@center @titlefont{ffserver Documentation}
|
2002-11-19 19:47:50 +00:00
|
|
|
@end titlepage
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2011-01-29 12:24:13 +00:00
|
|
|
@top
|
|
|
|
|
|
|
|
@contents
|
|
|
|
|
2012-12-23 19:25:28 +00:00
|
|
|
@chapter Synopsis
|
2010-06-08 22:32:29 +00:00
|
|
|
|
2012-12-17 11:55:28 +00:00
|
|
|
ffserver [@var{options}]
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2010-06-03 21:23:01 +00:00
|
|
|
@chapter Description
|
2003-08-24 11:16:29 +00:00
|
|
|
@c man begin DESCRIPTION
|
2010-06-03 21:23:01 +00:00
|
|
|
|
2013-11-28 16:27:01 +00:00
|
|
|
@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}.
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2013-01-11 11:53:18 +00:00
|
|
|
@command{ffserver} receives prerecorded files or FFM streams from some
|
|
|
|
@command{ffmpeg} instance as input, then streams them over
|
|
|
|
RTP/RTSP/HTTP.
|
2008-06-18 21:48:56 +00:00
|
|
|
|
2013-01-11 11:53:18 +00:00
|
|
|
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.
|
2008-06-18 21:48:56 +00:00
|
|
|
|
2013-01-11 11:53:18 +00:00
|
|
|
Input streams are called feeds, and each one is specified by a
|
|
|
|
@code{<Feed>} section in the configuration file.
|
2008-06-18 21:48:56 +00:00
|
|
|
|
|
|
|
For each feed you can have different output streams in various
|
2013-01-11 11:53:18 +00:00
|
|
|
formats, each one specified by a @code{<Stream>} section in the
|
|
|
|
configuration file.
|
2008-06-18 21:48:56 +00:00
|
|
|
|
2008-06-19 21:42:09 +00:00
|
|
|
@section Status stream
|
|
|
|
|
2013-11-28 09:56:36 +00:00
|
|
|
@command{ffserver} supports an HTTP interface which exposes the
|
|
|
|
current status of the server.
|
2008-06-19 21:42:09 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section How do I make it work?
|
2002-05-09 01:11:27 +00:00
|
|
|
|
|
|
|
First, build the kit. It *really* helps to have installed LAME first. Then when
|
2007-06-06 08:51:41 +00:00
|
|
|
you run the ffserver ./configure, make sure that you have the
|
|
|
|
@code{--enable-libmp3lame} flag turned on.
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2005-06-09 22:29:18 +00:00
|
|
|
LAME is important as it allows for streaming audio to Windows Media Player.
|
2005-06-09 21:14:15 +00:00
|
|
|
Don't ask why the other audio types do not work.
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2008-06-16 08:26:38 +00:00
|
|
|
As a simple test, just run the following two command lines where INPUTFILE
|
|
|
|
is some file which you can decode with ffmpeg:
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@example
|
2011-11-13 22:33:22 +00:00
|
|
|
ffserver -f doc/ffserver.conf &
|
|
|
|
ffmpeg -i INPUTFILE http://localhost:8090/feed1.ffm
|
2002-11-19 19:47:50 +00:00
|
|
|
@end example
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2005-06-09 21:14:15 +00:00
|
|
|
At this point you should be able to go to your Windows machine and fire up
|
2005-12-17 18:14:38 +00:00
|
|
|
Windows Media Player (WMP). Go to Open URL and enter
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@example
|
2002-05-09 01:11:27 +00:00
|
|
|
http://<linuxbox>:8090/test.asf
|
2002-11-19 19:47:50 +00:00
|
|
|
@end example
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2005-12-17 18:14:38 +00:00
|
|
|
You should (after a short delay) see video and hear audio.
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2002-05-17 01:54:39 +00:00
|
|
|
WARNING: trying to stream test1.mpg doesn't work with WMP as it tries to
|
2005-06-09 21:14:15 +00:00
|
|
|
transfer the entire file before starting to play.
|
|
|
|
The same is true of AVI files.
|
2002-05-17 01:54:39 +00:00
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section What happens next?
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2005-12-17 18:14:38 +00:00
|
|
|
You should edit the ffserver.conf file to suit your needs (in terms of
|
2002-05-09 01:11:27 +00:00
|
|
|
frame rates etc). Then install ffserver and ffmpeg, write a script to start
|
|
|
|
them up, and off you go.
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section What else can it do?
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2002-11-21 03:52:01 +00:00
|
|
|
You can replay video from .ffm files that was recorded earlier.
|
2005-12-17 18:14:38 +00:00
|
|
|
However, there are a number of caveats, including the fact that the
|
2002-11-21 03:52:01 +00:00
|
|
|
ffserver parameters must match the original parameters used to record the
|
2005-06-09 22:29:18 +00:00
|
|
|
file. If they do not, then ffserver deletes the file before recording into it.
|
2005-06-09 21:14:15 +00:00
|
|
|
(Now that I write this, it seems broken).
|
2002-05-09 01:11:27 +00:00
|
|
|
|
|
|
|
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
|
2005-06-09 21:14:15 +00:00
|
|
|
to the mailing list if there are some 'must have' parameters. Look in
|
2002-05-09 01:11:27 +00:00
|
|
|
ffserver.conf for a list of the currently available controls.
|
|
|
|
|
2005-06-09 21:14:15 +00:00
|
|
|
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
|
2002-05-16 02:03:34 +00:00
|
|
|
entire file before starting up the external viewer. The redirection files
|
|
|
|
are very small and can be transferred quickly. [The stream itself is
|
2005-12-17 18:14:38 +00:00
|
|
|
often 'infinite' and thus the browser tries to download it and never
|
2002-05-16 02:03:34 +00:00
|
|
|
finishes.]
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section Tips
|
2002-05-09 01:11:27 +00:00
|
|
|
|
2005-06-09 22:29:18 +00:00
|
|
|
* When you connect to a live stream, most players (WMP, RA, etc) want to
|
2002-05-09 01:11:27 +00:00
|
|
|
buffer a certain number of seconds of material so that they can display the
|
|
|
|
signal continuously. However, ffserver (by default) starts sending data
|
2005-06-09 21:14:15 +00:00
|
|
|
in realtime. This means that there is a pause of a few seconds while the
|
2002-05-09 01:11:27 +00:00
|
|
|
buffering is being done by the player. The good news is that this can be
|
2005-06-09 22:29:18 +00:00
|
|
|
cured by adding a '?buffer=5' to the end of the URL. This means that the
|
2005-12-17 18:14:38 +00:00
|
|
|
stream should start 5 seconds in the past -- and so the first 5 seconds
|
2005-06-09 21:14:15 +00:00
|
|
|
of the stream are sent as fast as the network will allow. It will then
|
2002-05-09 01:11:27 +00:00
|
|
|
slow down to real time. This noticeably improves the startup experience.
|
2002-05-16 02:03:34 +00:00
|
|
|
|
|
|
|
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.
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section Why does the ?buffer / Preroll stop working after a time?
|
2002-07-27 03:22:55 +00:00
|
|
|
|
|
|
|
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
|
2005-06-09 21:14:15 +00:00
|
|
|
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.
|
2002-07-27 03:22:55 +00:00
|
|
|
|
2005-12-17 18:14:38 +00:00
|
|
|
Fixing this requires a change in the internals of how timestamps are
|
2002-07-27 03:22:55 +00:00
|
|
|
handled.
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@section Does the @code{?date=} stuff work.
|
2002-07-27 03:22:55 +00:00
|
|
|
|
2005-06-09 21:14:15 +00:00
|
|
|
Yes (subject to the limitation outlined above). Also note that whenever you
|
|
|
|
start ffserver, it deletes the ffm file (if any parameters have changed),
|
2005-12-17 18:14:38 +00:00
|
|
|
thus wiping out what you had recorded before.
|
2002-07-27 03:22:55 +00:00
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
The format of the @code{?date=xxxxxx} is fairly flexible. You should use one
|
2002-07-27 03:22:55 +00:00
|
|
|
of the following formats (the 'T' is literal):
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@example
|
2002-07-27 03:22:55 +00:00
|
|
|
* YYYY-MM-DDTHH:MM:SS (localtime)
|
|
|
|
* YYYY-MM-DDTHH:MM:SSZ (UTC)
|
2002-11-19 19:47:50 +00:00
|
|
|
@end example
|
2002-07-27 03:22:55 +00:00
|
|
|
|
2005-12-17 18:14:38 +00:00
|
|
|
You can omit the YYYY-MM-DD, and then it refers to the current day. However
|
2005-06-09 22:29:18 +00:00
|
|
|
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.
|
2002-07-27 03:22:55 +00:00
|
|
|
|
|
|
|
You use this by adding the ?date= to the end of the URL for the stream.
|
2002-11-19 19:47:50 +00:00
|
|
|
For example: @samp{http://localhost:8080/test.asf?date=2002-07-26T23:05:00}.
|
2008-06-24 09:07:19 +00:00
|
|
|
@c man end
|
2002-11-19 19:47:50 +00:00
|
|
|
|
2012-11-05 15:24:57 +00:00
|
|
|
@section What is FFM, FFM2
|
|
|
|
|
2012-12-23 19:25:28 +00:00
|
|
|
FFM and FFM2 are formats used by ffserver. They allow storing a wide variety of
|
2012-11-06 10:35:14 +00:00
|
|
|
video and audio streams and encoding options, and can store a moving time segment
|
|
|
|
of an infinite movie or a whole movie.
|
2012-11-05 15:24:57 +00:00
|
|
|
|
2012-11-06 10:35:14 +00:00
|
|
|
FFM is version specific, and there is limited compatibility of FFM files
|
2012-11-05 15:24:57 +00:00
|
|
|
generated by one version of ffmpeg/ffserver and another version of
|
2013-02-14 22:45:48 +00:00
|
|
|
ffmpeg/ffserver. It may work but it is not guaranteed to work.
|
2012-11-05 15:24:57 +00:00
|
|
|
|
|
|
|
FFM2 is extensible while maintaining compatibility and should work between
|
|
|
|
differing versions of tools. FFM2 is the default.
|
|
|
|
|
2010-06-08 22:32:29 +00:00
|
|
|
@chapter Options
|
2003-08-24 11:16:29 +00:00
|
|
|
@c man begin OPTIONS
|
2010-02-21 10:56:38 +00:00
|
|
|
|
2013-09-08 22:36:55 +00:00
|
|
|
@include fftools-common-opts.texi
|
2010-02-21 10:56:38 +00:00
|
|
|
|
2010-03-20 00:09:30 +00:00
|
|
|
@section Main options
|
|
|
|
|
2010-02-21 10:56:38 +00:00
|
|
|
@table @option
|
2008-04-08 16:39:30 +00:00
|
|
|
@item -f @var{configfile}
|
2013-11-28 16:27:01 +00:00
|
|
|
Read configuration file @file{configfile}. If not specified it will
|
|
|
|
read by default from @file{/etc/ffserver.conf}.
|
2013-11-28 15:42:07 +00:00
|
|
|
|
2008-06-22 16:23:58 +00:00
|
|
|
@item -n
|
2013-11-28 15:42:07 +00:00
|
|
|
Enable no-launch mode. This option disables all the @code{Launch}
|
2013-11-28 17:55:11 +00:00
|
|
|
directives within the various @code{<Feed>} sections. Since
|
2013-11-28 15:42:07 +00:00
|
|
|
@command{ffserver} will not launch any @command{ffmpeg} instances, you
|
|
|
|
will have to launch them manually.
|
|
|
|
|
2008-06-22 17:26:13 +00:00
|
|
|
@item -d
|
2013-11-28 17:54:41 +00:00
|
|
|
Enable debug mode. This option increases log verbosity, and directs
|
|
|
|
log messages to stdout. When specified, the @option{CustomLog} option
|
|
|
|
is ignored.
|
2003-08-24 11:16:29 +00:00
|
|
|
@end table
|
2013-11-27 11:09:27 +00:00
|
|
|
|
|
|
|
@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.
|
|
|
|
|
2013-11-28 16:11:10 +00:00
|
|
|
Name of options and sections are case-insensitive.
|
|
|
|
|
2013-11-28 18:14:38 +00:00
|
|
|
@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.
|
|
|
|
|
2013-11-27 11:09:27 +00:00
|
|
|
@section Global options
|
|
|
|
@table @option
|
|
|
|
@item Port @var{port_number}
|
|
|
|
@item RTSPPort @var{port_number}
|
|
|
|
|
|
|
|
Set TCP port number on which the HTTP/RTSP server is listening. You
|
|
|
|
must select a different port from your standard HTTP web server if it
|
|
|
|
is running on the same computer.
|
|
|
|
|
|
|
|
If not specified, no corresponding server will be created.
|
|
|
|
|
|
|
|
@item BindAddress @var{ip_address}
|
|
|
|
@item RTSPBindAddress @var{ip_address}
|
2013-11-28 16:27:37 +00:00
|
|
|
Set address on which the HTTP/RTSP server is bound. Only useful if you
|
2013-11-27 11:09:27 +00:00
|
|
|
have several network interfaces.
|
|
|
|
|
|
|
|
@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}
|
2013-11-28 19:02:16 +00:00
|
|
|
Set access log file (uses standard Apache log file format). '-' is the
|
|
|
|
standard output.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
2013-11-28 19:02:16 +00:00
|
|
|
If not specified @command{ffserver} will produce no log.
|
2013-11-28 17:54:41 +00:00
|
|
|
|
|
|
|
In case the commandline option @option{-d} is specified this option is
|
2013-11-28 19:02:16 +00:00
|
|
|
ignored, and the log is written to standard output.
|
2013-11-28 15:42:42 +00:00
|
|
|
|
|
|
|
@item NoDaemon
|
|
|
|
Set no-daemon mode. This option is currently ignored since now
|
|
|
|
@command{ffserver} will work in no-daemon mode, and is deprecated.
|
|
|
|
|
2013-11-27 11:09:27 +00:00
|
|
|
@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}
|
|
|
|
Set the path where the file is stored on disk.
|
|
|
|
|
|
|
|
@item FileMaxSize @var{size}
|
|
|
|
Set maximum size of the feed. 0 means unlimited.
|
|
|
|
|
|
|
|
@item ReadOnlyFile @var{filename}
|
|
|
|
Mark the file as readonly and it will not be deleted or updated.
|
|
|
|
|
2013-11-28 17:49:27 +00:00
|
|
|
@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.
|
|
|
|
|
|
|
|
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.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
|
|
|
@item ACL
|
|
|
|
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.
|
|
|
|
|
|
|
|
@table @option
|
|
|
|
@item Feed @var{feed_name}
|
|
|
|
Set the input feed.
|
|
|
|
|
2013-11-28 18:33:07 +00:00
|
|
|
Must be specified for regular streams.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
|
|
|
@item Format @var{format_name}
|
2013-11-28 18:33:07 +00:00
|
|
|
Set the format of the output stream.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
2013-11-28 18:33:07 +00:00
|
|
|
Must be the name of a format recognized by FFmpeg. If set to
|
|
|
|
@samp{status}, it is treated as a status stream.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
2013-11-28 20:06:28 +00:00
|
|
|
@item InputFormat @var{format_name}
|
|
|
|
Set input format. If not specified, it is automatically guessed.
|
|
|
|
|
2013-11-27 11:09:27 +00:00
|
|
|
@item AudioBitRate @var{rate}
|
|
|
|
Set bitrate for the audio stream in KB per second.
|
|
|
|
|
|
|
|
@item AudioChannels @var{n}
|
|
|
|
Set number of audio channels.
|
|
|
|
|
|
|
|
@item AudioSampleRate @var{n}
|
|
|
|
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.
|
|
|
|
|
|
|
|
@item VideoBitRate @var{n}
|
|
|
|
Set bitrate for the video stream in KB per second.
|
|
|
|
|
|
|
|
@item VideoBitRateRange @var{range}
|
|
|
|
Set video bitrate range.
|
|
|
|
|
2013-11-28 18:34:14 +00:00
|
|
|
A range must be specified in the form @var{minrate}-@var{maxrate}, and
|
|
|
|
specifies the @option{minrate} and @option{maxrate} encoding options
|
|
|
|
expressed in KB.
|
|
|
|
|
2013-11-27 11:09:27 +00:00
|
|
|
@item VideoBitRateRangeTolerance @var{n}
|
|
|
|
|
|
|
|
@item PixelFormat
|
|
|
|
Set video pixel format.
|
|
|
|
|
|
|
|
@item VideoBufferSize @var{n}
|
|
|
|
Set ratecontrol buffer size.
|
|
|
|
|
|
|
|
@item VideoFrameRate @var{n}
|
|
|
|
Set number of video frames per second.
|
|
|
|
|
|
|
|
@item VideoSize
|
|
|
|
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}.
|
|
|
|
|
|
|
|
@item VideoIntraOnly
|
|
|
|
Transmit only intra frames (useful for low bitrates, but kills frame rate).
|
|
|
|
|
|
|
|
@item VideoGopSize @var{n}
|
|
|
|
If non-intra only, an intra frame is transmitted every VideoGopSize
|
|
|
|
frames. Video synchronization can only begin at an intra frame.
|
|
|
|
|
|
|
|
@item VideoHighQuality
|
|
|
|
@item Video4MotionVector
|
|
|
|
|
|
|
|
@item AudioCodec @var{codec_name}
|
|
|
|
@item VideoCodec @var{codec_name}
|
|
|
|
Set audio/video codec.
|
|
|
|
|
|
|
|
@item NoAudio
|
|
|
|
@item NoVideo
|
|
|
|
Suppress audio/video.
|
|
|
|
|
|
|
|
@item VideoQMin @var{n}
|
|
|
|
@item VideoQMax @var{n}
|
|
|
|
Set video qmin/qmax.
|
|
|
|
|
|
|
|
@item AVOptionAudio @var{option} @var{value}
|
|
|
|
@item AVOptionVideo @var{option} @var{value}
|
|
|
|
Set generic option for audio/video stream.
|
|
|
|
|
|
|
|
@item AVPresetAudio @var{preset}
|
|
|
|
@item AVOptionVideo @var{preset}
|
|
|
|
Set preset for audio/video stream.
|
|
|
|
|
|
|
|
@var{preset} must be the path of a preset file.
|
|
|
|
|
|
|
|
@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.
|
|
|
|
|
2013-11-28 16:07:19 +00:00
|
|
|
Default value is 0.
|
|
|
|
|
2013-11-27 11:09:27 +00:00
|
|
|
@item ACL @var{spec}
|
|
|
|
Set ACL for the stream.
|
|
|
|
|
|
|
|
@item Author @var{value}
|
|
|
|
@item Comment @var{value}
|
|
|
|
@item Copyright @var{value}
|
|
|
|
@item Title @var{value}
|
|
|
|
Set metadata corresponding to the option.
|
|
|
|
|
|
|
|
@item StartSendOnKey
|
|
|
|
Do not send stream until it gets the first key frame. By default
|
|
|
|
@command{ffserver} will send data immediately.
|
|
|
|
|
|
|
|
@item FaviconURL @var{url}
|
|
|
|
Set favicon (favourite icon) for the server status page. It is ignored
|
|
|
|
for regular streams.
|
|
|
|
@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
|
2013-11-28 18:33:07 +00:00
|
|
|
@samp{status}.
|
2013-11-27 11:09:27 +00:00
|
|
|
|
|
|
|
@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
|
|
|
|
#VideoSize 352x240
|
|
|
|
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
|
|
|
|
Ogg Vorbis audio:
|
|
|
|
@example
|
|
|
|
<Stream test.ogg>
|
|
|
|
Feed feed1.ffm
|
|
|
|
Title "Stream title"
|
|
|
|
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
|
|
|
|
NoAudio
|
|
|
|
</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
|
|
|
|
NoAudio
|
|
|
|
</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
|
|
|
|
Author "Me"
|
|
|
|
Copyright "Super MegaCorp"
|
|
|
|
Title "Test stream from disk"
|
|
|
|
Comment "Test comment"
|
|
|
|
</Stream>
|
|
|
|
@end example
|
|
|
|
@end itemize
|
|
|
|
|
2003-08-24 11:16:29 +00:00
|
|
|
@c man end
|
|
|
|
|
2013-04-24 16:39:49 +00:00
|
|
|
@include config.texi
|
2013-03-19 19:54:26 +00:00
|
|
|
@ifset config-all
|
2013-04-24 16:39:49 +00:00
|
|
|
@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
|
2013-03-19 19:54:26 +00:00
|
|
|
@end ifset
|
|
|
|
|
2012-12-16 19:53:16 +00:00
|
|
|
@chapter See Also
|
|
|
|
|
|
|
|
@ifhtml
|
2013-03-19 19:54:26 +00:00
|
|
|
@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,
|
2012-12-16 19:53:16 +00:00
|
|
|
@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},
|
2013-02-15 12:31:09 +00:00
|
|
|
@url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters},
|
2012-12-16 19:53:16 +00:00
|
|
|
@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
|
2013-03-19 19:54:26 +00:00
|
|
|
@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),
|
2012-12-16 19:53:16 +00:00
|
|
|
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
|
|
|
|
|
2012-12-16 17:04:37 +00:00
|
|
|
@include authors.texi
|
|
|
|
|
2003-08-24 11:16:29 +00:00
|
|
|
@ignore
|
|
|
|
|
2008-06-06 07:51:36 +00:00
|
|
|
@setfilename ffserver
|
2011-04-23 13:19:17 +00:00
|
|
|
@settitle ffserver video server
|
2003-08-24 11:16:29 +00:00
|
|
|
|
|
|
|
@end ignore
|
|
|
|
|
2002-11-19 19:47:50 +00:00
|
|
|
@bye
|