|stream_index||Matches the stream with this index. E.g. -threads:1 4 would set the thread count for the second stream to 4.|
|stream_type[:stream_index]||stream_type is one of following: v or V for video, a for audio, s for subtitle, d for data, and t for attachments. v matches all video streams, V only matches video streams which are not attached pictures, video thumbnails or cover arts. If stream_index is given, then it matches stream number stream_index of this type. Otherwise, it matches all streams of this type.|
|p:program_id[:stream_index]||If stream_index is given, then it matches the stream with number stream_index in the program with the id program_id. Otherwise, it matches all streams in the program.|
|#stream_id or i:stream_id||Match the stream by stream id (e.g. PID in MPEG-TS container).|
|m:key[:value]||Matches streams with the metadata tag key having the specified value. If value is not given, matches streams that contain the given tag with any value.|
Matches streams with usable configuration, the codec must be defined and the
essential information such as video dimension or audio sample rate must be present.
Note that in ffmpeg, matching by metadata will only work properly for input files.
These options are shared amongst the ff* tools.
-L Show license. -h, -?, -help, --help [arg] Show help. An optional parameter may be specified to print help about a specific item. If no argument is specified, only basic (non advanced) tool options are shown.
Possible values of arg are:
long Print advanced tool options in addition to the basic tool options. full Print complete list of options, including shared and private options for encoders, decoders, demuxers, muxers, filters, etc. decoder=decoder_name Print detailed information about the decoder named decoder_name. Use the -decoders option to get a list of all decoders. encoder=encoder_name Print detailed information about the encoder named encoder_name. Use the -encoders option to get a list of all encoders. demuxer=demuxer_name Print detailed information about the demuxer named demuxer_name. Use the -formats option to get a list of all demuxers and muxers. muxer=muxer_name Print detailed information about the muxer named muxer_name. Use the -formats option to get a list of all muxers and demuxers. filter=filter_name Print detailed information about the filter name filter_name. Use the -filters option to get a list of all filters. -version Show version. -formats Show available formats (including devices). -devices Show available devices. -codecs Show all codecs known to libavcodec.
Note that the term codec is used throughout this documentation as a shortcut for what is more correctly called a media bitstream format.
-decoders Show available decoders. -encoders Show all available encoders. -bsfs Show available bitstream filters. -protocols Show available protocols. -filters Show available libavfilter filters. -pix_fmts Show available pixel formats. -sample_fmts Show available sample formats. -layouts Show channel names and standard channel layouts. -colors Show recognized color names. -sources device[,opt1=val1[,opt2=val2]...] Show autodetected sources of the intput device. Some devices may provide system-dependent source names that cannot be autodetected. The returned list cannot be assumed to be always complete.
ffmpeg -sources pulse,server=192.168.0.4
-sinks device[,opt1=val1[,opt2=val2]...] Show autodetected sinks of the output device. Some devices may provide system-dependent sink names that cannot be autodetected. The returned list cannot be assumed to be always complete.
ffmpeg -sinks pulse,server=192.168.0.4
-loglevel [repeat+]loglevel | -v [repeat+]loglevel Set the logging level used by the library. Adding repeat+ indicates that repeated log output should not be compressed to the first line and the Last message repeated n times line will be omitted. repeat can also be used alone. If repeat is used alone, and with no prior loglevel set, the default loglevel will be used. If multiple loglevel parameters are given, using repeat will not change the loglevel. loglevel is a string or a number containing one of the following values:
quiet, -8 Show nothing at all; be silent. panic, 0 Only show fatal errors which could lead the process to crash, such as and assert failure. This is not currently used for anything. fatal, 8 Only show fatal errors. These are errors after which the process absolutely cannot continue after. error, 16 Show all errors, including ones which can be recovered from. warning, 24 Show all warnings and errors. Any message related to possibly incorrect or unexpected events will be shown. info, 32 Show informative messages during processing. This is in addition to warnings and errors. This is the default value. verbose, 40 Same as info, except more verbose. debug, 48 Show everything, including debugging information. trace, 56
By default the program logs to stderr, if coloring is supported by the terminal, colors are used to mark errors and warnings. Log coloring can be disabled setting the environment variable AV_LOG_FORCE_NOCOLOR or NO_COLOR, or can be forced setting the environment variable AV_LOG_FORCE_COLOR. The use of the environment variable NO_COLOR is deprecated and will be dropped in a following FFmpeg version.
-report Dump full command line and console output to a file named program-YYYYMMDD-HHMMSS.log in the current directory. This file can be useful for bug reports. It also implies -loglevel verbose.
Setting the environment variable FFREPORT to any value has the same effect. If the value is a :-separated key=value sequence, these options will affect the report; option values must be escaped if they contain special characters or the options delimiter : (see the Quoting and escaping section in the ffmpeg-utils manual).
The following options are recognized:
file set the file name to use for the report; %p is expanded to the name of the program, %t is expanded to a timestamp, %% is expanded to a plain % level set the log verbosity level using a numerical value (see -loglevel).
For example, to output a report to a file named ffreport.log using a log level of 32 (alias for log level info):
FFREPORT=file=ffreport.log:level=32 ffmpeg -i input output
Errors in parsing the environment variable are not fatal, and will not appear in the report.
-hide_banner Suppress printing banner.
All FFmpeg tools will normally show a copyright notice, build options and library versions. This option can be used to suppress printing this information.
-cpuflags flags (global) Allows setting and clearing cpu flags. This option is intended for testing. Do not use it unless you know what youre doing.
ffmpeg -cpuflags -sse+mmx ... ffmpeg -cpuflags mmx ... ffmpeg -cpuflags 0 ...
Possible flags for this option are:
mmx mmxext sse sse2 sse2slow sse3 sse3slow ssse3 atom sse4.1 sse4.2 avx avx2 xop fma3 fma4 3dnow 3dnowext bmi1 bmi2 cmov ARM
armv5te armv6 armv6t2 vfp vfpv3 neon setend AArch64
armv8 vfp neon PowerPC
altivec Specific Processors
pentium2 pentium3 pentium4 k6 k62 athlon athlonxp k8 -opencl_bench This option is used to benchmark all available OpenCL devices and print the results. This option is only available when FFmpeg has been compiled with --enable-opencl.
When FFmpeg is configured with --enable-opencl, the options for the global OpenCL context are set via -opencl_options. See the OpenCL Options section in the ffmpeg-utils manual for the complete list of supported options. Amongst others, these options include the ability to select a specific platform and device to run the OpenCL code on. By default, FFmpeg will run on the first device of the first platform. While the options for the global OpenCL context provide flexibility to the user in selecting the OpenCL device of their choice, most users would probably want to select the fastest OpenCL device for their system.
This option assists the selection of the most efficient configuration by identifying the appropriate device for the users system. The built-in benchmark is run on all the OpenCL devices and the performance is measured for each device. The devices in the results list are sorted based on their performance with the fastest device listed first. The user can subsequently invoke ffmpeg using the device deemed most appropriate via -opencl_options to obtain the best performance for the OpenCL accelerated code.
Typical usage to use the fastest OpenCL device involve the following steps.
Run the command:
Note down the platform ID (pidx) and device ID (didx) of the first i.e. fastest device in the list. Select the platform and device using the command:
ffmpeg -opencl_options platform_idx=<pidx>:device_idx=<didx> ...
-opencl_options options (global) Set OpenCL environment options. This option is only available when FFmpeg has been compiled with --enable-opencl.
options must be a list of key=value option pairs separated by :. See the OpenCL Options section in the ffmpeg-utils manual for the list of supported options.
These options are provided directly by the libavformat, libavdevice and libavcodec libraries. To see the list of available AVOptions, use the -help option. They are separated into two categories:
For example to write an ID3v2.3 header instead of a default ID3v2.4 to an MP3 file, use the id3v2_version private option of the MP3 muxer:
generic These options can be set for any container, codec or device. Generic options are listed under AVFormatContext options for containers/devices and under AVCodecContext options for codecs. private These options are specific to the given container, device or codec. Private options are listed under their corresponding containers/devices/codecs.
ffmpeg -i input.flac -id3v2_version 3 out.mp3
All codec AVOptions are per-stream, and thus a stream specifier should be attached to them.
Note: the -nooption syntax cannot be used for boolean AVOptions, use -option 0/-option 1.
Note: the old undocumented way of specifying per-stream AVOptions by prepending v/a/s to the options name is now obsolete and will be removed soon.
-f configfile Read configuration file configfile. If not specified it will read by default from /etc/ffserver.conf. -n Enable no-launch mode. This option disables all the Launch directives within the various <Feed> sections. Since ffserver will not launch any ffmpeg instances, you will have to launch them manually. -d Enable debug mode. This option increases log verbosity, and directs log messages to stdout. When specified, the CustomLog option is ignored.
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 "<SECTION_NAME ARGS> on a separate line and must be terminated by a line in the form </SECTION_NAME>". ARGS is optional.
Currently the following sections are recognized: Feed, Stream, Redirect.
A line starting with # is ignored and treated as a comment.
Name of options and sections are case-insensitive.
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
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.
o Allow/deny access to address.
ACL ALLOW <address> ACL DENY <address>
o Allow/deny access to ranges of addresses from first_address to last_address.
ACL ALLOW <first_address> <last_address> ACL DENY <first_address> <last_address>
Thus ACL allow localhost only allows access from localhost. ACL deny 126.96.36.199 188.8.131.52 would deny the whole of network 1 and allow everybody else.
HTTPPort port_number Port port_number RTSPPort port_number HTTPPort sets the HTTP server listening TCP port number, RTSPPort sets the RTSP server listening TCP port number.
Port is the equivalent of HTTPPort and is deprecated.
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.
HTTPBindAddress ip_address BindAddress ip_address RTSPBindAddress ip_address Set address on which the HTTP/RTSP server is bound. Only useful if you have several network interfaces.
BindAddress is the equivalent of HTTPBindAddress and is deprecated.
MaxHTTPConnections n Set number of simultaneous HTTP connections that can be handled. It has to be defined before the MaxClients parameter, since it defines the MaxClients maximum limit.
Default value is 2000.
MaxClients n Set number of simultaneous requests that can be handled. Since ffserver is very fast, it is more likely that you will want to leave this high and use MaxBandwidth.
Default value is 5.
MaxBandwidth kbps Set the maximum amount of kbit/sec that you are prepared to consume when streaming to clients.
Default value is 1000.
CustomLog filename Set access log file (uses standard Apache log file format). - is the standard output.
If not specified ffserver will produce no log.
In case the commandline option -d is specified this option is ignored, and the log is written to standard output.
NoDaemon Set no-daemon mode. This option is currently ignored since now ffserver will always work in no-daemon mode, and is deprecated. UseDefaults 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 UseDefaults. The lastest occurrence overrides previous if multiple definitions.
A Feed section defines a feed provided to ffserver.
Each live feed contains one video and/or audio sequence coming from an ffmpeg encoder or another 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:
where FEED_FILENAME specifies the unique name of the FFM stream.
The following options are recognized within a Feed section.
File filename ReadOnlyFile filename Set the path where the feed file is stored on disk.
If not specified, the /tmp/FEED.ffm is assumed, where FEED is the feed name.
If ReadOnlyFile is used the file is marked as read-only and it will not be deleted or updated.
Truncate Truncate the feed file, rather than appending to it. By default ffserver will append data to the file, until the maximum file size value is reached (see FileMaxSize option). FileMaxSize size Set maximum size of the feed file in bytes. 0 means unlimited. The postfixes K (2^10), M (2^20), and G (2^30) are recognized.
Default value is 5M.
Launch args Launch an ffmpeg command when creating ffserver.
args must be a sequence of arguments to be provided to an ffmpeg instance. The first provided argument is ignored, and it is replaced by a path with the same dirname of the ffserver instance, followed by the remaining argument and terminated with a path corresponding to the feed.
When the launched process exits, ffserver will launch another program instance.
In case you need a more complex ffmpeg configuration, e.g. if you need to generate multiple FFM feeds with a single ffmpeg instance, you should launch ffmpeg by hand.
This option is ignored in case the commandline option -n is specified.
ACL spec Specify the list of IP address which are allowed or denied to write the feed. Multiple ACL options can be specified.
A Stream section defines a stream provided by 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:
where STREAM_NAME specifies the unique name of the stream.
The following options are recognized within a Stream section.
Encoding options are marked with the 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 ffserver, you can use the ffmpeg override_ffserver commandline option.
Only one of the Feed and File options should be set.
Server status stream
Feed feed_name Set the input feed. feed_name must correspond to an existing feed defined in a Feed section.
When this option is set, encoding options are used to setup the encoding operated by the remote ffmpeg process.
File filename Set the filename of the pre-recorded input file to stream.
When this option is set, encoding options are ignored and the input file content is re-streamed as is.
Format format_name Set the format of the output stream.
Must be the name of a format recognized by FFmpeg. If set to status, it is treated as a status stream.
InputFormat format_name Set input format. If not specified, it is automatically guessed. Preroll 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.
StartSendOnKey Do not send stream until it gets the first key frame. By default ffserver will send data immediately. MaxTime 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.
ACL spec Set ACL for the stream. DynamicACL spec RTSPOption option MulticastAddress address MulticastPort port MulticastTTL integer NoLoop FaviconURL url Set favicon (favourite icon) for the server status page. It is ignored for regular streams. Author value Comment value Copyright value Title value Set metadata corresponding to the option. All these options are deprecated in favor of Metadata. Metadata key value Set metadata value on the output stream. UseDefaults NoDefaults Control whether default codec options are used for the stream or not. Default is UseDefaults unless disabled globally. NoAudio NoVideo Suppress audio/video. AudioCodec codec_name (encoding,audio) Set audio codec. AudioBitRate rate (encoding,audio) Set bitrate for the audio stream in kbits per second. AudioChannels n (encoding,audio) Set number of audio channels. AudioSampleRate n (encoding,audio) 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. AVOptionAudio [codec:]option value (encoding,audio) Set generic or private option for audio stream. Private option must be prefixed with codec name or codec must be defined before. AVPresetAudio preset (encoding,audio) Set preset for audio stream. VideoCodec codec_name (encoding,video) Set video codec. VideoBitRate n (encoding,video) Set bitrate for the video stream in kbits per second. VideoBitRateRange range (encoding,video) Set video bitrate range.
A range must be specified in the form minrate-maxrate, and specifies the minrate and maxrate encoding options expressed in kbits per second.
VideoBitRateRangeTolerance n (encoding,video) Set video bitrate tolerance in kbits per second. PixelFormat pixel_format (encoding,video) Set video pixel format. Debug integer (encoding,video) Set video debug encoding option. Strict integer (encoding,video) Set video strict encoding option. VideoBufferSize n (encoding,video) Set ratecontrol buffer size, expressed in KB. VideoFrameRate n (encoding,video) Set number of video frames per second. VideoSize (encoding,video) Set size of the video frame, must be an abbreviation or in the form WxH. See the Video size section in the ffmpeg-utils(1) manual.
Default value is 160x128.
VideoIntraOnly (encoding,video) Transmit only intra frames (useful for low bitrates, but kills frame rate). VideoGopSize n (encoding,video) If non-intra only, an intra frame is transmitted every VideoGopSize frames. Video synchronization can only begin at an intra frame. VideoTag tag (encoding,video) Set video tag. VideoHighQuality (encoding,video) Video4MotionVector (encoding,video) BitExact (encoding,video) Set bitexact encoding flag. IdctSimple (encoding,video) Set simple IDCT algorithm. Qscale n (encoding,video) Enable constant quality encoding, and set video qscale (quantization scale) value, expressed in n QP units. VideoQMin n (encoding,video) VideoQMax n (encoding,video) Set video qmin/qmax. VideoQDiff integer (encoding,video) Set video qdiff encoding option. LumiMask float (encoding,video) DarkMask float (encoding,video) Set lumi_mask/dark_mask encoding options. AVOptionVideo [codec:]option value (encoding,video) Set generic or private option for video stream. Private option must be prefixed with codec name or codec must be defined before. AVPresetVideo preset (encoding,video) Set preset for video stream.
preset must be the path of a preset file.
A server status stream is a special stream which is used to show statistics about the ffserver operations.
It must be specified setting the option Format to status.
A redirect section specifies where to redirect the requested URL to another page.
A redirect section must be introduced by the line:
where NAME is the name of the page which should be redirected.
It only accepts the option URL, which specify the redirection URL.
o Multipart JPEG
<Stream test.mjpg> Feed feed1.ffm Format mpjpeg VideoFrameRate 2 VideoIntraOnly NoAudio Strict -1 </Stream>
o Single JPEG
<Stream test.jpg> Feed feed1.ffm Format jpeg VideoFrameRate 2 VideoIntraOnly VideoSize 352x240 NoAudio Strict -1 </Stream>
<Stream test.swf> Feed feed1.ffm Format swf VideoFrameRate 2 VideoIntraOnly NoAudio </Stream>
o ASF compatible
<Stream test.asf> Feed feed1.ffm Format asf VideoFrameRate 15 VideoSize 352x240 VideoBitRate 256 VideoBufferSize 40 VideoGopSize 30 AudioBitRate 64 StartSendOnKey </Stream>
o MP3 audio
<Stream test.mp3> Feed feed1.ffm Format mp2 AudioCodec mp3 AudioBitRate 64 AudioChannels 1 AudioSampleRate 44100 NoVideo </Stream>
o Ogg Vorbis audio
<Stream test.ogg> Feed feed1.ffm Metadata title "Stream title" AudioBitRate 64 AudioChannels 2 AudioSampleRate 44100 NoVideo </Stream>
o Real with audio only at 32 kbits
<Stream test.ra> Feed feed1.ffm Format rm AudioBitRate 32 NoVideo </Stream>
o Real with audio and video at 64 kbits
<Stream test.rm> Feed feed1.ffm Format rm AudioBitRate 32 VideoBitRate 128 VideoFrameRate 25 VideoGopSize 25 </Stream>
o For stream coming from a file: you only need to set the input filename and optionally a new format.
<Stream file.rm> File "/usr/local/httpd/htdocs/tlive.rm" NoAudio </Stream> <Stream file.asf> File "/usr/local/httpd/htdocs/test.asf" NoAudio Metadata author "Me" Metadata copyright "Super MegaCorp" Metadata title "Test stream from disk" Metadata comment "Test comment" </Stream>
ffserver-all(1), the doc/ffserver.conf example, ffmpeg(1), ffplay(1), ffprobe(1), 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)
The FFmpeg developers.
For details about the authorship, see the Git history of the project (git://source.ffmpeg.org/ffmpeg), e.g. by typing the command git log in the FFmpeg source directory, or browsing the online repository at <http://source.ffmpeg.org>.
Maintainers for the specific components are listed in the file MAINTAINERS in the source code tree.