Rename 'default-binds' input option to 'default-bindings'.

[mplayer/glamo.git] / DOCS / man / en / mplayer.1

.\" $Revision$
.\" MPlayer (C) 2000-2009 MPlayer Team
.\" This man page was/is done by Gabucino, Diego Biurrun, Jonas Jermann
.
.\" --------------------------------------------------------------------------
.\" Macro definitions
.\" --------------------------------------------------------------------------
.
.\" define indentation for suboptions
.nr SS 5
.\" add new suboption
.de IPs
.IP "\\$1" \n(SS
..
.\" begin of first level suboptions, end with .RE
.de RSs
.RS 10
..
.\" begin of 2nd level suboptions
.de RSss
.PD 0
.RS \n(SS+3
..
.\" end of 2nd level suboptions
.de REss
.RE
.PD 1
..
.
.\" --------------------------------------------------------------------------
.\" Title
.\" --------------------------------------------------------------------------
.
.TH MPlayer 1 "2009-01-05" "The MPlayer Project" "The Movie Player"
.
.SH NAME
mplayer  \- movie player
.br
mencoder \- movie encoder
.
.\" --------------------------------------------------------------------------
.\" Synopsis
.\" --------------------------------------------------------------------------
.
.SH SYNOPSIS
.na
.nh
.B mplayer
[options] [file|URL|playlist|\-]
.
.br
.B mplayer
[options] file1
[specific options] [file2] [specific options]
.
.br
.B mplayer
[options]
{group of files and options}
[group-specific options]
.
.br
.B mplayer
[dvd|dvdnav]://[title|[start_title]\-end_title][/device]
[options]
.
.br
.B mplayer
vcd://track[/device]
.
.br
.B mplayer
tv://[channel][/input_id]
[options]
.
.br
.B mplayer
radio://[channel|frequency][/capture]
[options]
.
.br
.B mplayer
pvr://
[options]
.
.br
.B mplayer
dvb://[card_number@]channel
[options]
.
.br
.B mplayer
mf://[filemask|@listfile]
[\-mf options] [options]
.
.br
.B mplayer
[cdda|cddb]://track[\-endtrack][:speed][/device]
[options]
.
.br
.B mplayer
cue://file[:track]
[options]
.
.br
.B mplayer
[file|mms[t]|http|http_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]://
[user:pass@]URL[:port] [options]
.
.br
.B mplayer
sdp://file
[options]
.
.br
.B mplayer
mpst://host[:port]/URL
[options]
.
.br
.B mplayer
tivo://host/[list|llist|fsid]
[options]
.
.br
.B gmplayer
[options]
[\-skin\ skin]
.
.br
.B mencoder
[options] file
[file|URL|\-] [\-o file | file://file | smb://[user:pass@]host/filepath]
.
.br
.B mencoder
[options] file1
[specific options] [file2] [specific options]
.ad
.hy
.
.\" --------------------------------------------------------------------------
.\" Description
.\" --------------------------------------------------------------------------
.
.SH DESCRIPTION
.B mplayer
is a movie player for Linux (runs on many other platforms and CPU
architectures, see the documentation).
It plays most MPEG/\:VOB, AVI, ASF/\:WMA/\:WMV, RM, QT/\:MOV/\:MP4, Ogg/\:OGM,
MKV, VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, supported by many
native and binary codecs.
You can watch VCD, SVCD, DVD, 3ivx, DivX 3/4/5, WMV and even H.264 movies,
too.
.PP
MPlayer supports a wide range of video and audio output drivers.
It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, AAlib, libcaca, DirectFB,
Quartz, Mac OS X CoreVideo, but you can also use GGI, SDL (and all their drivers),
VESA (on every VESA-compatible card, even without X11), some low-level
card-specific drivers (for Matrox, 3dfx and ATI) and some hardware MPEG decoder
boards, such as the Siemens DVB, Hauppauge PVR (IVTV), DXR2 and DXR3/\:Hollywood+.
Most of them support software or hardware scaling, so you can enjoy movies in
fullscreen mode.
.PP
MPlayer has an onscreen display (OSD) for status information, nice big
antialiased shaded subtitles and visual feedback for keyboard controls.
European/\:ISO8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean
fonts are supported along with 12 subtitle formats (MicroDVD, SubRip, OGM,
SubViewer, Sami, VPlayer, RT, SSA, AQTitle, JACOsub, PJS and our own: MPsub) and
DVD subtitles (SPU streams, VOBsub and Closed Captions).
.PP
.B mencoder
(MPlayer's Movie Encoder) is a simple movie encoder, designed to encode
MPlayer-playable movies (see above) to other MPlayer-playable formats (see
below).
It encodes to MPEG-4 (DivX/Xvid), one of the libavcodec codecs and
PCM/\:MP3/\:VBRMP3 audio in 1, 2 or 3 passes.
Furthermore it has stream copying abilities, a powerful filter system (crop,
expand, flip, postprocess, rotate, scale, noise, RGB/\:YUV conversion) and
more.
.PP
.B gmplayer
is MPlayer with a graphical user interface.
It has the same options as MPlayer.
.PP
Usage examples to get you started quickly can be found at the end
of this man page.
.PP
.B Also see the HTML documentation!
.
.
.\" --------------------------------------------------------------------------
.\" interactive control
.\" --------------------------------------------------------------------------
.
.SH "INTERACTIVE CONTROL"
MPlayer has a fully configurable, command-driven control layer
which allows you to control MPlayer using keyboard, mouse, joystick
or remote control (with LIRC).
See the \-input option for ways to customize it.
.
.TP
.B keyboard control
.PD 0
.RS
.IPs "<\- and \->"
Seek backward/\:forward 10 seconds.
.IPs "up and down"
Seek forward/\:backward 1 minute.
.IPs "pgup and pgdown"
Seek forward/\:backward 10 minutes.
.IPs "[ and ]"
Decrease/increase current playback speed by 10%.
.IPs "{ and }"
Halve/double current playback speed.
.IPs "backspace"
Reset playback speed to normal.
.IPs "< and >"
Go backward/\:forward in the playlist.
.IPs "ENTER"
Go forward in the playlist, even over the end.
.IPs "HOME and END"
next/\:previous playtree entry in the parent list
.IPs "INS and DEL (ASX playlist only)"
next/\:previous alternative source.
.IPs "p / SPACE"
Pause (pressing again unpauses).
.IPs ".\ \ \ \ "
Step forward.
Pressing once will pause movie, every consecutive press will play one frame
and then go into pause mode again (any other key unpauses).
.IPs "q / ESC"
Stop playing and quit.
.IPs "U\ \ \ \ "
Stop playing (and quit if \-idle is not used).
.IPs "+ and \-"
Adjust audio delay by +/\- 0.1 seconds.
.IPs "/ and *"
Decrease/\:increase volume.
.IPs "9 and 0"
Decrease/\:increase volume.
.IPs "( and )"
Adjust audio balance in favor of left/\:right channel.
.IPs "m\ \ \ \ "
Mute sound.
.IPs "_ (MPEG-TS, AVI and libavformat only)"
Cycle through the available video tracks.
.IPs "# (DVD, MPEG, Matroska, AVI and libavformat only)"
Cycle through the available audio tracks.
.IPs "TAB (MPEG-TS and libavformat only)"
Cycle through the available programs.
.IPs "f\ \ \ \ "
Toggle fullscreen (also see \-fs).
.IPs "T\ \ \ \ "
Toggle stay-on-top (also see \-ontop).
.IPs "w and e"
Decrease/\:increase pan-and-scan range.
.IPs "o\ \ \ \ "
Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
.IPs "d\ \ \ \ "
Toggle frame dropping states: none / skip display / skip decoding
(see \-framedrop and \-hardframedrop).
.IPs "v\ \ \ \ "
Toggle subtitle visibility.
.IPs "j\ \ \ \ "
Cycle through the available subtitles.
.IPs "y and g"
Step forward/backward in the subtitle list.
.IPs "F\ \ \ \ "
Toggle displaying "forced subtitles".
.IPs "a\ \ \ \ "
Toggle subtitle alignment: top / middle / bottom.
.IPs "x and z"
Adjust subtitle delay by +/\- 0.1 seconds.
.IPs "r and t"
Move subtitles up/down.
.IPs "i (\-edlout mode only)"
Set start or end of an EDL skip and write it out to the given file.
.IPs "s (\-vf screenshot only)"
Take a screenshot.
.IPs "S (\-vf screenshot only)"
Start/stop taking screenshots.
.IPs "I\ \ \ \ "
Show filename on the OSD.
.IPs "! and @"
Seek to the beginning of the previous/next chapter.
.IPs "D (\-vo xvmc, \-vo vdpau, \-vf yadif, \-vf kerndeint only)"
Activate/deactivate deinterlacer.
.IPs "A"
Cycle through the available DVD angles.
.RE
.PD 1
.PP
.RS
(The following keys are valid only when using a hardware accelerated video
output (xv, (x)vidix, (x)mga, etc), the software equalizer
(\-vf eq or \-vf eq2) or hue filter (\-vf hue).)
.RE
.PP
.PD 0
.RS
.IPs "1 and 2"
Adjust contrast.
.IPs "3 and 4"
Adjust brightness.
.IPs "5 and 6"
Adjust hue.
.IPs "7 and 8"
Adjust saturation.
.RE
.PD 1
.PP
.RS
(The following keys are valid only when using the quartz or macosx
video output driver.)
.RE
.PP
.PD 0
.RS
.IPs "command + 0"
Resize movie window to half its original size.
.IPs "command + 1"
Resize movie window to its original size.
.IPs "command + 2"
Resize movie window to double its original size.
.IPs "command + f"
Toggle fullscreen (also see \-fs).
.IPs "command + [ and command + ]"
Set movie window alpha.
.RE
.PD 1
.PP
.RS
(The following keys are valid only when using the sdl
video output driver.)
.RE
.PP
.PD 0
.RS
.IPs "c\ \ \ \ "
Cycle through available fullscreen modes.
.IPs "n\ \ \ \ "
Restore original mode.
.RE
.PD 1
.PP
.RS
(The following keys are valid if you have a keyboard
with multimedia keys.)
.RE
.PP
.PD 0
.RS
.IPs PAUSE
Pause.
.IPs "STOP\ "
Stop playing and quit.
.IPs "PREVIOUS and NEXT"
Seek backward/\:forward 1 minute.
.RE
.PD 1
.PP
.RS
(The following keys are only valid if GUI support is compiled in
and will take precedence over the keys defined above.)
.RE
.PP
.PD 0
.RS
.IPs ENTER
Start playing.
.IPs "ESC\ \ "
Stop playing.
.IPs "l\ \ \ \ "
Load file.
.IPs "t\ \ \ \ "
Load subtitle.
.IPs "c\ \ \ \ "
Open skin browser.
.IPs "p\ \ \ \ "
Open playlist.
.IPs "r\ \ \ \ "
Open preferences.
.RE
.PD 1
.PP
.RS
(The following keys are only valid if you compiled with TV or DVB input
support and will take precedence over the keys defined above.)
.RE
.PP
.PD 0
.RS
.IPs "h and k"
Select previous/\:next channel.
.IPs "n\ \ \ \ "
Change norm.
.IPs "u\ \ \ \ "
Change channel list.
.RE
.PD 1
.PP
.RS
(The following keys are only valid if you compiled with dvdnav
support: They are used to navigate the menus.)
.RE
.PP
.PD 0
.RS
.IPs "keypad 8"
Select button up.
.IPs "keypad 2"
Select button down.
.IPs "keypad 4"
Select button left.
.IPs "keypad 6"
Select button right.
.IPs "keypad 5"
Return to main menu.
.IPs "keypad 7"
Return to nearest menu (the order of preference is: chapter->title->root).
.IPs "keypad ENTER"
Confirm choice.
.RE
.PD 1
.PP
.RS
.
(The following keys are only valid if teletext support is enabled during
compilation: They are used for controlling TV teletext.)
.RE
.PP
.PD 0
.RS
.IPs "X\ \ \ \ "
Switch teletext on/\:off.
.IPs "Q and W"
Go to next/\:prev teletext page.
.RE
.PD 1
.PP
.RS
.
.TP
.B mouse control
.PD 0
.RS
.IPs "button 3 and button 4"
Seek backward/\:forward 1 minute.
.IPs "button 5 and button 6"
Decrease/\:increase volume.
.RE
.PD 1
.
.TP
.B joystick control
.PD 0
.RS
.IPs "left and right"
Seek backward/\:forward 10 seconds.
.IPs "up and down"
Seek forward/\:backward 1 minute.
.IPs "button 1"
Pause.
.IPs "button 2"
Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
.IPs "button 3 and button 4"
Decrease/\:increase volume.
.RE
.PD 1
.
.
.\" --------------------------------------------------------------------------
.\" Usage
.\" --------------------------------------------------------------------------
.
.SH "USAGE"
Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the
\-fs option is \-nofs.
.PP
If an option is marked as (XXX only), it will only work in combination with
the XXX option or if XXX is compiled in.
.PP
.I NOTE:
The suboption parser (used for example for \-ao pcm suboptions) supports
a special kind of string-escaping intended for use with external GUIs.
.br
It has the following format:
.br
%n%string_of_length_n
.br
.I EXAMPLES:
.br
mplayer \-ao pcm:file=%10%C:test.wav test.avi
.br
Or in a script:
.br
mplayer \-ao pcm:file=%`expr length "$NAME"`%"$NAME" test.avi
.PP
.
.\" --------------------------------------------------------------------------
.\" Configuration files
.\" --------------------------------------------------------------------------
.
.SH "CONFIGURATION FILES"
You can put all of the options in configuration files which will be read
every time MPlayer/MEncoder is run.
The system-wide configuration file 'mplayer.conf' is in your configuration
directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user
specific one is '~/\:.mplayer/\:config'.
The configuration file for MEncoder is 'mencoder.conf' in your configuration
directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the
user specific one is '~/\:.mplayer/\:mencoder.conf'.
User specific options override system-wide options and options given on the
command line override either.
The syntax of the configuration files is 'option=<value>', everything after
a '#' is considered a comment.
Options that work without values can be enabled by setting them to 'yes'
or '1' or 'true' and disabled by setting them to 'no' or '0' or 'false'.
Even suboptions can be specified in this way.
.PP
You can also write file-specific configuration files.
If you wish to have a configuration file for a file called 'movie.avi', create a file
named 'movie.avi.conf' with the file-specific options in it and put it in
~/.mplayer/.
You can also put the configuration file in the same directory as the file to
be played, as long as you give the \-use\-filedir\-conf option (either on the
command line or in your global config file).
.PP
.I EXAMPLE MPLAYER CONFIGURATION FILE:
.sp 1
.nf
# Use Matrox driver by default.
vo=xmga
# I love practicing handstands while watching videos.
flip=yes
# Decode/encode multiple files from PNG,
# start with mf://filemask
mf=type=png:fps=25
# Eerie negative images are cool.
vf=eq2=1.0:\-0.8
.fi
.PP
.I "EXAMPLE MENCODER CONFIGURATION FILE:"
.sp 1
.nf
# Make MEncoder output to a default filename.
o=encoded.avi
# The next 4 lines allow mencoder tv:// to start capturing immediately.
oac=pcm=yes
ovc=lavc=yes
lavcopts=vcodec=mjpeg
tv=driver=v4l2:input=1:width=768:height=576:device=/dev/video0:audiorate=48000
# more complex default encoding option set
lavcopts=vcodec=mpeg4:autoaspect=1
lameopts=aq=2:vbr=4
ovc=lavc=1
oac=lavc=1
passlogfile=pass1stats.log
noautoexpand=1
subfont-autoscale=3
subfont-osd-scale=6
subfont-text-scale=4
subalign=2
subpos=96
spuaa=20
.fi
.
.\" --------------------------------------------------------------------------
.\" Profiles
.\" --------------------------------------------------------------------------
.
.SH "PROFILES"
To ease working with different configurations profiles can be defined in the
configuration files.
A profile starts with its name between square brackets, e.g.\& '[my-profile]'.
All following options will be part of the profile.
A description (shown by \-profile help) can be defined with the profile-desc
option.
To end the profile, start another one or use the profile name 'default'
to continue with normal options.
.fi
.PP
.I "EXAMPLE MPLAYER PROFILE:"
.sp 1
.nf

[protocol.dvd]
profile-desc="profile for dvd:// streams"
vf=pp=hb/vb/dr/al/fd
alang=en

[protocol.dvdnav]
profile-desc="profile for dvdnav:// streams"
profile=protocol.dvd
mouse-movements=yes
nocache=yes

[extension.flv]
profile-desc="profile for .flv files"
flip=yes

[vo.pnm]
outdir=/tmp

[ao.alsa]
device=spdif
.fi
.PP
.I "EXAMPLE MENCODER PROFILE:"
.sp 1
.nf

[mpeg4]
profile-desc="MPEG4 encoding"
ovc=lacv=yes
lavcopts=vcodec=mpeg4:vbitrate=1200

[mpeg4\-hq]
profile-desc="HQ MPEG4 encoding"
profile=mpeg4
lavcopts=mbd=2:trell=yes:v4mv=yes
.fi
.
.\" --------------------------------------------------------------------------
.\" Options
.\" --------------------------------------------------------------------------
.
.SH "GENERAL OPTIONS"
.
.TP
.B \-codecs\-file <filename> (also see \-afm, \-ac, \-vfm, \-vc)
Override the standard search path and use the specified file
instead of the builtin codecs.conf.
.
.TP
.B \-include <configuration file>
Specify configuration file to be parsed after the default ones.
.
.TP
.B \-list\-options
Prints all available options.
.
.TP
.B \-msgcharset <charset>
Convert console messages to the specified character set (default: autodetect).
Text will be in the encoding specified with the \-\-charset configure option.
Set this to "noconv" to disable conversion (for e.g.\& iconv problems).
.br
.I NOTE:
The option takes effect after command line parsing has finished.
The MPLAYER_CHARSET environment variable can help you get rid of
the first lines of garbled output.
.
.TP
.B \-msgcolor
Enable colorful console output on terminals that support ANSI color.
.
.TP
.B \-msglevel <all=<level>:<module>=<level>:...>
Control verbosity directly for each module.
The 'all' module changes the verbosity of all the modules not
explicitly specified on the command line.
See '\-msglevel help' for a list of all modules.
.br
.I NOTE:
Some messages are printed before the command line is parsed and are
therefore not affected by \-msglevel.
To control these messages you have to use the MPLAYER_VERBOSE environment
variable, see its description below for details.
.br
Available levels:
.PD 0
.RSs
.IPs "\-1"
complete silence
.IPs " 0"
fatal messages only
.IPs " 1"
error messages
.IPs " 2"
warning messages
.IPs " 3"
short hints
.IPs " 4"
informational messages
.IPs " 5"
status messages (default)
.IPs " 6"
verbose messages
.IPs " 7"
debug level 2
.IPs " 8"
debug level 3
.IPs " 9"
debug level 4
.RE
.PD 1
.
.TP
.B \-msgmodule
Prepend module name in front of each console message.
.
.TP
.B \-noconfig <options>
Do not parse selected configuration files.
.br
.I NOTE:
If \-include or \-use\-filedir\-conf options are
specified at the command line, they will be honoured.
.sp 1
Available options are:
.PD 0
.RSs
.IPs "all\ \ "
all configuration files
.IPs "gui (GUI only)"
GUI configuration file
.IPs system
system configuration file
.IPs "user\ "
user configuration file
.RE
.PD 1
.
.TP
.B "\-quiet\ "
Make console output less verbose; in particular, prevents the status line
(i.e.\& A:   0.7 V:   0.6 A-V:  0.068 ...) from being displayed.
Particularly useful on slow terminals or broken ones which do not properly
handle carriage return (i.e.\& \\r).
.
.TP
.B \-priority <prio> (Windows and OS/2 only)
Set process priority for MPlayer according to the predefined
priorities available under Windows and OS/2.
Possible values of <prio>:
.RSs
idle|belownormal|normal|abovenormal|high|realtime
.RE
.sp 1
.RS
.I WARNING:
Using realtime priority can cause system lockup.
.RE
.
.TP
.B \-profile <profile1,profile2,...>
Use the given profile(s), \-profile help displays a list of the defined profiles.
.
.TP
.B \-really\-quiet (also see \-quiet)
Display even less output and status messages than with \-quiet.
Also suppresses the GUI error message boxes.
.
.TP
.B \-show\-profile <profile>
Show the description and content of a profile.
.
.TP
.B \-use\-filedir\-conf
Look for a file-specific configuration file in the same directory as
the file that is being played.
.br
.I WARNING:
May be dangerous if playing from untrusted media.
.
.TP
.B "\-v\ \ \ \ \ "
Increment verbosity level, one level for each \-v
found on the command line.
.
.
.
.SH "PLAYER OPTIONS (MPLAYER ONLY)"
.
.TP
.B \-autoq <quality> (use with \-vf [s]pp)
Dynamically changes the level of postprocessing depending on the available spare
CPU time.
The number you specify will be the maximum level used.
Usually you can use some big number.
You have to use \-vf [s]pp without parameters in order for this to work.
.
.TP
.B \-autosync <factor>
Gradually adjusts the A/V sync based on audio delay measurements.
Specifying \-autosync 0, the default, will cause frame timing to be based
entirely on audio delay measurements.
Specifying \-autosync 1 will do the same, but will subtly change the A/V
correction algorithm.
An uneven video framerate in a movie which plays fine with \-nosound can
often be helped by setting this to an integer value greater than 1.
The higher the value, the closer the timing will be to \-nosound.
Try \-autosync 30 to smooth out problems with sound drivers which do
not implement a perfect audio delay measurement.
With this value, if large A/V sync offsets occur, they will only take about
1 or 2 seconds to settle out.
This delay in reaction time to sudden A/V offsets should be the only
side-effect of turning this option on, for all sound drivers.
.
.TP
.B \-benchmark
Prints some statistics on CPU usage and dropped frames at the end of playback.
Use in combination with \-nosound and \-vo null for benchmarking only the
video codec.
.br
.I NOTE:
With this option MPlayer will also ignore frame duration when playing
only video (you can think of that as infinite fps).
.
.TP
.B \-colorkey <number>
Changes the colorkey to an RGB value of your choice.
0x000000 is black and 0xffffff is white.
Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
drivers.
.
.TP
.B \-nocolorkey
Disables colorkeying.
Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
drivers.
.
.TP
.B \-correct\-pts (EXPERIMENTAL)
Switches MPlayer to an experimental mode where timestamps for video frames
are calculated differently and video filters which add new frames or
modify timestamps of existing ones are supported.
The more accurate timestamps can be visible for example when playing
subtitles timed to scene changes with the \-ass option.
Without \-correct\-pts the subtitle timing will typically be off by some frames.
This option does not work correctly with some demuxers and codecs.
.
.TP
.B \-crash\-debug (DEBUG CODE)
Automatically attaches gdb upon crash or SIGTRAP.
Support must be compiled in by configuring with \-\-enable\-crash\-debug.
.
.TP
.B \-doubleclick\-time
Time in milliseconds to recognize two consecutive button presses as
a double-click (default: 300).
Set to 0 to let your windowing system decide what a double-click is
(\-vo directx only).
.br
.I NOTE:
You will get slightly different behaviour depending on whether you bind
MOUSE_BTN0_DBL or MOUSE_BTN0\-MOUSE_BTN0_DBL.
.
.TP
.B \-edlout <filename>
Creates a new file and writes edit decision list (EDL) records to it.
During playback, the user hits 'i' to mark the start or end of a skip block.
This provides a starting point from which the user can fine-tune EDL entries
later.
See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details.
.
.TP
.B \-enqueue (GUI only)
Enqueue files given on the command line in the playlist instead of playing them
immediately.
.
.TP
.B \-fixed\-vo
Enforces a fixed video system for multiple files (one (un)initialization for
all files).
Therefore only one window will be opened for all files.
Currently the following drivers are fixed-vo compliant: gl, gl2, mga, svga, x11,
xmga, xv, xvidix and dfbmga.
.
.TP
.B \-framedrop (also see \-hardframedrop, experimental without \-nocorrect\-pts)
Skip displaying some frames to maintain A/V sync on slow systems.
Video filters are not applied to such frames.
For B-frames even decoding is skipped completely.
.
.TP
.B \-(no)gui
Enable or disable the GUI interface (default depends on binary name).
Only works as the first argument on the command line.
Does not work as a config-file option.
.
.TP
.B \-h, \-help, \-\-help
Show short summary of options.
.
.TP
.B \-hardframedrop (experimental without \-nocorrect\-pts)
More intense frame dropping (breaks decoding).
Leads to image distortion!
Note that especially the libmpeg2 decoder may crash with this,
so consider using "\-vc ffmpeg12,".
.
.TP
.B \-heartbeat\-cmd
Command that is executed every 30 seconds during playback via system() -
i.e.\& using the shell.
.sp 1
.I NOTE:
MPlayer uses this command without any checking, it is your responsibility
to ensure it does not cause security problems (e.g.\& make sure to use full
paths if "." is in your path like on Windows).
It also only works when playing video (i.e.\& not with \-novideo but works with \-vo null).
.sp 1
This can be "misused" to disable screensavers that do not support the proper
X API (also see \-stop\-xscreensaver).
If you think this is too complicated, ask the author of the screensaver
program to support the proper X APIs.
.sp 1
.I EXAMPLE for xscreensaver:
mplayer \-heartbeat\-cmd "xscreensaver\-command \-deactivate" file
.sp 1
.I EXAMPLE for GNOME screensaver:
mplayer \-heartbeat\-cmd "gnome\-screensaver\-command \-p" file
.RE
.PD 1
.
.TP
.B \-identify
Shorthand for \-msglevel identify=4.
Show file parameters in an easily parseable format.
Also prints more detailed information about subtitle and audio
track languages and IDs.
In some cases you can get more information by using \-msglevel identify=6.
For example, for a DVD it will list the chapters and time length of each title,
as well as a disk ID.
Combine this with \-frames 0 to suppress all output.
The wrapper script TOOLS/\:midentify.sh suppresses the other MPlayer output and
(hopefully) shellescapes the filenames.
.
.TP
.B \-idle (also see \-slave)
Makes MPlayer wait idly instead of quitting when there is no file to play.
Mostly useful in slave mode where MPlayer can be controlled
through input commands.
.
.TP
.B \-input <commands>
This option can be used to configure certain parts of the input system.
Paths are relative to ~/.mplayer/.
.br
.I NOTE:
Autorepeat is currently only supported by joysticks.
.sp 1
Available commands are:
.sp 1
.PD 0
.RSs
.IPs conf=<filename>
Specify input configuration file other than the default
~/\:.mplayer/\:input.conf.
~/\:.mplayer/\:<filename> is assumed if no full path is given.
.IPs ar-dev=<device>
Device to be used for Apple IR Remote (default is autodetected, Linux only).
.IPs ar-delay
Delay in milliseconds before we start to autorepeat a key (0 to disable).
.IPs ar-rate
Number of key presses to generate per second on autorepeat.
.IPs (no)default-bindings
Use the key bindings that MPlayer ships with by default.
.IPs keylist
Prints all keys that can be bound to commands.
.IPs cmdlist
Prints all commands that can be bound to keys.
.IPs js-dev
Specifies the joystick device to use (default: /dev/\:input/\:js0).
.IPs file=<filename>
Read commands from the given file.
Mostly useful with a FIFO.
.br
.I NOTE:
When the given file is a FIFO MPlayer opens both ends so you can do
several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
.RE
.PD 1
.
.TP
.B \-key\-fifo\-size <2\-65000>
Specify the size of the FIFO that buffers key events (default: 7).
A FIFO of size n can buffer (n\-1) events.
If it is too small some events may be lost
(leading to "stuck mouse buttons" and similar effects).
If it is too big, MPlayer may seem to hang while it
processes the buffered events.
To get the same behavior as before this option was introduced,
set it to 2 for Linux or 1024 for Windows.
.
.TP
.B \-lircconf <filename> (LIRC only)
Specifies a configuration file for LIRC (default: ~/.lircrc).
.
.TP
.B \-list\-properties
Print a list of the available properties.
.
.TP
.B \-loop <number>
Loops movie playback <number> times.
0 means forever.
.
.TP
.B \-menu (OSD menu only)
Turn on OSD menu support.
.
.TP
.B \-menu\-cfg <filename> (OSD menu only)
Use an alternative menu.conf.
.
.TP
.B \-menu\-chroot <path> (OSD menu only)
Chroot the file selection menu to a specific location.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-menu\-chroot /home"
Will restrict the file selection menu to /\:home and downward (i.e.\& no
access to / will be possible, but /home/user_name will).
.RE
.PD 1
.
.TP
.B \-menu\-keepdir (OSD menu only)
File browser starts from the last known location instead of current directory.
.
.TP
.B \-menu\-root <value> (OSD menu only)
Specify the main menu.
.
.TP
.B \-menu\-startup (OSD menu only)
Display the main menu at MPlayer startup.
.
.TP
.B \-mouse\-movements
Permit MPlayer to receive pointer events reported by the video
output driver.
Necessary to select the buttons in DVD menus.
Supported for X11 based VOs (x11, xv, xvmc, etc.) and the gl, gl2, direct3d and
macosx VOs.
.
.TP
.B \-noar
Turns off AppleIR remote support.
.
.TP
.B \-noconsolecontrols
Prevent MPlayer from reading key events from standard input.
Useful when reading data from standard input.
This is automatically enabled when \- is found on the command line.
There are situations where you have to set it manually, e.g.\&
if you open /dev/\:stdin (or the equivalent on your system), use stdin
in a playlist or intend to read from stdin later on via the loadfile or
loadlist slave commands.
.
.TP
.B \-nojoystick
Turns off joystick support.
.
.TP
.B \-nolirc
Turns off LIRC support.
.
.TP
.B \-nomouseinput
Disable mouse button press/\:release input (mozplayerxp's context menu relies
on this option).
.
.TP
.B \-rtc (RTC only)
Turns on usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
mechanism.
This wakes up the process every 1/1024 seconds to check the current time.
Useless with modern Linux kernels configured for desktop use as they already
wake up the process with similar accuracy when using normal timed sleep.
.
.TP
.B \-playing\-msg <string>
Print out a string before starting playback.
The following expansions are supported:
.RSs
.IPs ${NAME}
Expand to the value of the property NAME.
.IPs ?(NAME:TEXT)
Expand TEXT only if the property NAME is available.
.IPs ?(!NAME:TEXT)
Expand TEXT only if the property NAME is not available.
.RE
.
.TP
.B \-playlist <filename>
Play files according to a playlist file (ASX, Winamp, SMIL, or
one-file-per-line format).
.br
.I NOTE:
This option is considered an entry so options found after it will apply
only to the elements of this playlist.
.br
FIXME: This needs to be clarified and documented thoroughly.
.
.TP
.B \-rtc\-device <device>
Use the specified device for RTC timing.
.
.TP
.B \-shuffle
Play files in random order.
.
.TP
.B \-skin <name> (GUI only)
Loads a skin from the directory given as parameter below the default skin
directories, /usr/\:local/\:share/\:mplayer/\:skins/\: and ~/.mplayer/\:skins/.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-skin fittyfene"
Tries /usr/\:local/\:share/\:mplayer/\:skins/\:fittyfene
and afterwards ~/.mplayer/\:skins/\:fittyfene.
.RE
.PD 1
.
.TP
.B \-slave (also see \-input)
Switches on slave mode, in which MPlayer works as a backend for other programs.
Instead of intercepting keyboard events, MPlayer will read commands separated
by a newline (\\n) from stdin.
.br
.I NOTE:
See \-input cmdlist for a list of slave commands and DOCS/tech/slave.txt
for their description.
Also, this is not intended to disable other inputs, e.g.\& via the video window,
use some other method like \-input nodefault\-binds:conf=/dev/null for that.
.
.TP
.B \-softsleep
Time frames by repeatedly checking the current time instead of asking the
kernel to wake up MPlayer at the correct time.
Useful if your kernel timing is imprecise and you cannot use the RTC either.
Comes at the price of higher CPU consumption.
.
.TP
.B \-sstep <sec>
Skip <sec> seconds after every frame.
The normal framerate of the movie is kept, so playback is accelerated.
Since MPlayer can only seek to the next keyframe this may be inexact.
.
.
.
.SH "DEMUXER/STREAM OPTIONS"
.
.TP
.B \-a52drc <level>
Select the Dynamic Range Compression level for AC-3 audio streams.
<level> is a float value ranging from 0 to 1, where 0 means no compression
and 1 (which is the default) means full compression (make loud passages more
silent and vice versa).
This option only shows an effect if the AC-3 stream contains the required range
compression information.
.
.TP
.B \-aid <ID> (also see \-alang)
Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
VOB(AC-3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
MPlayer prints the available audio IDs when run in verbose (\-v) mode.
When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
(if present) with the chosen audio stream.
.
.TP
.B \-ausid <ID> (also see \-alang)
Select audio substream channel.
Currently the valid range is 0x55..0x75 and applies only to MPEG-TS when handled
by the native demuxer (not by libavformat).
The format type may not be correctly identified because of how this information
(or lack thereof) is embedded in the stream, but it will demux correctly the
audio streams when multiple substreams are present.
MPlayer prints the available substream IDs when run with \-identify.
.
.TP
.B \-alang <language code[,language code,...]> (also see \-aid)
Specify a priority list of audio languages to use.
Different container formats employ different language codes.
DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT
use ISO 639-2 three letter language codes while OGM uses a free-form identifier.
MPlayer prints the available languages when run in verbose (\-v) mode.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "mplayer dvd://1 \-alang hu,en"
Chooses the Hungarian language track on a DVD and falls back on English if
Hungarian is not available.
.IPs "mplayer \-alang jpn example.mkv"
Plays a Matroska file in Japanese.
.RE
.PD 1
.
.TP
.B \-audio\-demuxer <[+]name> (\-audiofile only)
Force audio demuxer type for \-audiofile.
Use a '+' before the name to force it, this will skip some checks!
Give the demuxer name as printed by \-audio\-demuxer help.
For backward compatibility it also accepts the demuxer ID as defined in
libmpdemux/\:demuxer.h.
\-audio\-demuxer audio or \-audio\-demuxer 17 forces MP3.
.
.TP
.B \-audiofile <filename>
Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
movie.
.
.TP
.B \-audiofile\-cache <kBytes>
Enables caching for the stream used by \-audiofile, using the specified
amount of memory.
.
.TP
.B \-reuse\-socket (udp:// only)
Allows a socket to be reused by other processes as soon as it is closed.
.
.TP
.B \-bandwidth <value> (network only)
Specify the maximum bandwidth for network streaming (for servers that are
able to send content in different bitrates).
Useful if you want to watch live streamed media behind a slow connection.
With Real RTSP streaming, it is also used to set the maximum delivery
bandwidth allowing faster cache filling and stream dumping.
.
.TP
.B \-cache <kBytes>
This option specifies how much memory (in kBytes) to use when precaching a
file or URL.
Especially useful on slow media.
.
.TP
.B \-nocache
Turns off caching.
.
.TP
.B \-cache\-min <percentage>
Playback will start when the cache has been filled up to <percentage>
of the total.
.
.TP
.B \-cache\-seek\-min <percentage>
If a seek is to be made to a position within <percentage> of the cache size
from the current position, MPlayer will wait for the cache to be filled to
this position rather than performing a stream seek (default: 50).
.
.TP
.B \-cdda <option1:option2> (CDDA only)
This option can be used to tune the CD Audio reading feature of MPlayer.
.sp 1
Available options are:
.RSs
.IPs speed=<value>
Set CD spin speed.
.IPs paranoia=<0\-2>
Set paranoia level.
Values other than 0 seem to break playback of anything but the first track.
.RSss
0: disable checking (default)
.br
1: overlap checking only
.br
2: full data correction and verification
.REss
.IPs generic-dev=<value>
Use specified generic SCSI device.
.IPs sector-size=<value>
Set atomic read size.
.IPs overlap=<value>
Force minimum overlap search during verification to <value> sectors.
.IPs toc-bias
Assume that the beginning offset of track 1 as reported in the TOC will be
addressed as LBA 0.
Some Toshiba drives need this for getting track boundaries correct.
.IPs toc-offset=<value>
Add <value> sectors to the values reported when addressing tracks.
May be negative.
.IPs (no)skip
(Never) accept imperfect data reconstruction.
.RE
.
.TP
.B \-cdrom\-device <path to device>
Specify the CD-ROM device (default: /dev/\:cdrom).
.
.TP
.B \-channels <number> (also see \-af channels)
Request the number of playback channels (default: 2).
MPlayer asks the decoder to decode the audio into as many channels as
specified.
Then it is up to the decoder to fulfill the requirement.
This is usually only important when playing videos with AC-3 audio (like DVDs).
In that case liba52 does the decoding by default and correctly downmixes the
audio into the requested number of channels.
To directly control the number of output channels independently of how many
channels are decoded, use the channels filter.
.br
.I NOTE:
This option is honored by codecs (AC-3 only), filters (surround) and audio
output drivers (OSS at least).
.sp 1
Available options are:
.sp 1
.PD 0
.RSs
.IPs 2
stereo
.IPs 4
surround
.IPs 6
full 5.1
.RE
.PD 1
.
.TP
.B \-chapter <chapter ID>[\-<endchapter ID>] (dvd:// and dvdnav:// only)
Specify which chapter to start playing at.
Optionally specify which chapter to end playing at (default: 1).
.
.TP
.B \-cookies (network only)
Send cookies when making HTTP requests.
.
.TP
.B \-cookies\-file <filename> (network only)
Read HTTP cookies from <filename> (default: ~/.mozilla/ and ~/.netscape/)
and skip reading from default locations.
The file is assumed to be in Netscape format.
.
.TP
.B \-delay <sec>
audio delay in seconds (positive or negative float value)
.br
Negative values delay the audio, and positive values delay the video.
Note that this is the exact opposite of the \-audio\-delay MEncoder option.
.br
.I NOTE:
When used with MEncoder, this is not guaranteed to work correctly
with \-ovc copy; use \-audio\-delay instead.
.
.TP
.B \-ignore\-start
Ignore the specified starting time for streams in AVI files.
In MPlayer, this nullifies stream delays in files encoded with
the \-audio\-delay option.
During encoding, this option prevents MEncoder from transferring
original stream start times to the new file; the \-audio\-delay option is
not affected.
Note that MEncoder sometimes adjusts stream starting times
automatically to compensate for anticipated decoding delays, so do not
use this option for encoding without testing it first.
.
.TP
.B \-demuxer <[+]name>
Force demuxer type.
Use a '+' before the name to force it, this will skip some checks!
Give the demuxer name as printed by \-demuxer help.
For backward compatibility it also accepts the demuxer ID as defined in
libmpdemux/\:demuxer.h.
.
.TP
.B \-dumpaudio (MPlayer only)
Dumps raw compressed audio stream to ./stream.dump (useful with MPEG/\:AC-3,
in most other cases the resulting file will not be playable).
If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
on the command line only the last one will work.
.
.TP
.B \-dumpfile <filename> (MPlayer only)
Specify which file MPlayer should dump to.
Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream.
.
.TP
.B \-dumpstream (MPlayer only)
Dumps the raw stream to ./stream.dump.
Useful when ripping from DVD or network.
If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
on the command line only the last one will work.
.
.TP
.B \-dumpvideo (MPlayer only)
Dump raw compressed video stream to ./stream.dump (not very usable).
If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
on the command line only the last one will work.
.
.TP
.B \-dvbin <options> (DVB only)
Pass the following parameters to the DVB input module, in order to override
the default ones:
.sp 1
.PD 0
.RSs
.IPs card=<1\-4>
Specifies using card number 1\-4 (default: 1).
.IPs file=<filename>
Instructs MPlayer to read the channels list from <filename>.
Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl,atsc} (based on your card type)
or ~/.mplayer/\:channels.conf as a last resort.
.IPs timeout=<1\-30>
Maximum number of seconds to wait when trying to tune a
frequency before giving up (default: 30).
.RE
.PD 1
.
.TP
.B \-dvd\-device <path to device> (DVD only)
Specify the DVD device or .iso filename (default: /dev/\:dvd).
You can also specify a directory that contains files previously copied directly
from a DVD (with e.g.\& vobcopy).
.
.TP
.B \-dvd\-speed <factor or speed in KB/s> (DVD only)
Try to limit DVD speed (default: 0, no change).
DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to
10800KB/s.
Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be
quiet and fast enough.
MPlayer resets the speed to the drive default value on close.
Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd\-speed 8 selects
10800KB/s.
.br
.I NOTE:
You need write access to the DVD device to change the speed.
.
.TP
.B \-dvdangle <angle ID> (DVD only)
Some DVD discs contain scenes that can be viewed from multiple angles.
Here you can tell MPlayer which angles to use (default: 1).
.
.TP
.B \-edl <filename>
Enables edit decision list (EDL) actions during playback.
Video will be skipped over and audio will be muted and unmuted according to
the entries in the given file.
See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details
on how to use this.
.
.TP
.B \-endpos <[[hh:]mm:]ss[.ms]|size[b|kb|mb]> (also see \-ss and \-sb)
Stop at given time or byte position.
.br
.I NOTE:
Byte position is enabled only for MEncoder and will not be accurate, as it can
only stop at a frame boundary.
When used in conjunction with \-ss option, \-endpos time will shift forward by
seconds specified with \-ss.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-endpos 56"
Stop at 56 seconds.
.IPs "\-endpos 01:10:00"
Stop at 1 hour 10 minutes.
.IPs "\-ss 10 \-endpos 56"
Stop at 1 minute 6 seconds.
.IPs "\-endpos 100mb"
Encode only 100 MB.
.RE
.PD 1
.
.TP
.B \-forceidx
Force index rebuilding.
Useful for files with broken index (A/V desync, etc).
This will enable seeking in files where seeking was not possible.
You can fix the index permanently with MEncoder (see the documentation).
.br
.I NOTE:
This option only works if the underlying media supports seeking
(i.e.\& not with stdin, pipe, etc).
.
.TP
.B \-fps <float value>
Override video framerate.
Useful if the original value is wrong or missing.
.
.TP
.B \-frames <number>
Play/\:convert only first <number> frames, then quit.
.
.TP
.B \-hr\-mp3\-seek (MP3 only)
Hi-res MP3 seeking.
Enabled when playing from an external MP3 file, as we need to seek
to the very exact position to keep A/V sync.
Can be slow especially when seeking backwards since it has to rewind
to the beginning to find an exact frame position.
.
.TP
.B \-idx (also see \-forceidx)
Rebuilds index of files if no index was found, allowing seeking.
Useful with broken/\:incomplete downloads, or badly created files.
.br
.I NOTE:
This option only works if the underlying media supports seeking
(i.e.\& not with stdin, pipe, etc).
.
.TP
.B \-noidx
Skip rebuilding index file.
MEncoder skips writing the index with this option.
.
.TP
.B \-ipv4\-only\-proxy (network only)
Skip the proxy for IPv6 addresses.
It will still be used for IPv4 connections.
.
.TP
.B \-loadidx <index file>
The file from which to read the video index data saved by \-saveidx.
This index will be used for seeking, overriding any index data
contained in the AVI itself.
MPlayer will not prevent you from loading an index file generated
from a different AVI, but this is sure to cause unfavorable results.
.br
.I NOTE:
This option is obsolete now that MPlayer has OpenDML support.
.
.TP
.B \-mc <seconds/frame>
maximum A-V sync correction per frame (in seconds)
.
.TP
.B \-mf <option1:option2:...>
Used when decoding from multiple PNG or JPEG files.
.sp 1
Available options are:
.sp 1
.PD 0
.RSs
.IPs w=<value>
input file width (default: autodetect)
.IPs h=<value>
input file height (default: autodetect)
.IPs fps=<value>
output fps (default: 25)
.IPs type=<value>
input file type (available: jpeg, png, tga, sgi)
.RE
.PD 1
.
.TP
.B \-ni (AVI only)
Force usage of non-interleaved AVI parser (fixes playback
of some bad AVI files).
.
.TP
.B \-nobps (AVI only)
Do not use average byte/\:second value for A-V sync.
Helps with some AVI files with broken header.
.
.TP
.B \-noextbased
Disables extension-based demuxer selection.
By default, when the file type (demuxer) cannot be detected reliably
(the file has no header or it is not reliable enough), the filename
extension is used to select the demuxer.
Always falls back on content-based demuxer selection.
.
.TP
.B \-passwd <password> (also see \-user) (network only)
Specify password for HTTP authentication.
.
.TP
.B \-prefer\-ipv4 (network only)
Use IPv4 on network connections.
Falls back on IPv6 automatically.
.
.TP
.B \-prefer\-ipv6 (IPv6 network only)
Use IPv6 on network connections.
Falls back on IPv4 automatically.
.
.TP
.B \-psprobe <byte position>
When playing an MPEG-PS or MPEG-PES streams, this option lets you specify
how many bytes in the stream you want MPlayer to scan in order to identify
the video codec used.
This option is needed to play EVO or VDR files containing H.264 streams.
.
.TP
.B \-pvr <option1:option2:...> (PVR only)
This option tunes various encoding properties of the PVR capture module.
It has to be used with any hardware MPEG encoder based card supported by the
V4L2 driver.
The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV based
cards are known as PVR capture cards.
Be aware that only Linux 2.6.18 kernel
and above is able to handle MPEG stream through V4L2 layer.
For hardware capture of an MPEG stream and watching it with
MPlayer/MEncoder, use 'pvr://' as a movie URL.
.sp 1
Available options are:
.RSs
.IPs aspect=<0\-3>
Specify input aspect ratio:
.RSss
0: 1:1
.br
1: 4:3 (default)
.br
2: 16:9
.br
3: 2.21:1
.REss
.IPs arate=<32000\-48000>
Specify encoding audio rate (default: 48000 Hz, available: 32000, 44100
and 48000 Hz).
.IPs alayer=<1\-3>
Specify MPEG audio layer encoding (default: 2).
.IPs abitrate=<32\-448>
Specify audio encoding bitrate in kbps (default: 384).
.IPs amode=<value>
Specify audio encoding mode.
Available preset values are 'stereo', 'joint_stereo', 'dual' and 'mono' (default: stereo).
.IPs vbitrate=<value>
Specify average video bitrate encoding in Mbps (default: 6).
.IPs vmode=<value>
Specify video encoding mode:
.RSss
vbr: Variable BitRate (default)
.br
cbr: Constant BitRate
.REss
.IPs vpeak=<value>
Specify peak video bitrate encoding in Mbps
(only useful for VBR encoding, default: 9.6).
.IPs fmt=<value>
Choose an MPEG format for encoding:
.RSss
ps:    MPEG-2 Program Stream (default)
.br
ts:    MPEG-2 Transport Stream
.br
mpeg1: MPEG-1 System Stream
.br
vcd:   Video CD compatible stream
.br
svcd:  Super Video CD compatible stream
.br
dvd:   DVD compatible stream
.REss
.RE
.PD 1
.
.TP
.B \-radio <option1:option2:...> (radio only)
These options set various parameters of the radio capture module.
For listening to radio with MPlayer use 'radio://<frequency>'
(if channels option is not given) or 'radio://<channel_number>'
(if channels option is given) as a movie URL.
You can see allowed frequency range by running MPlayer with '\-v'.
To start the grabbing subsystem, use 'radio://<frequency or channel>/capture'.
If the capture keyword is not given you can listen to radio
using the line-in cable only.
Using capture to listen is not recommended due to synchronization
problems, which makes this process uncomfortable.
.sp 1
Available options are:
.RSs
.IPs device=<value>
Radio device to use (default: /dev/radio0 for Linux and /dev/tuner0 for *BSD).
.IPs driver=<value>
Radio driver to use (default: v4l2 if available, otherwise v4l).
Currently, v4l and v4l2 drivers are supported.
.IPs volume=<0..100>
sound volume for radio device (default 100)
.IPs "freq_min=<value> (*BSD BT848 only)"
minimum allowed frequency (default: 87.50)
.IPs "freq_max=<value> (*BSD BT848 only)"
maximum allowed frequency (default: 108.00)
.IPs channels=<frequency>\-<name>,<frequency>\-<name>,...
Set channel list.
Use _ for spaces in names (or play with quoting ;-).
The channel names will then be written using OSD and the slave commands
radio_step_channel and radio_set_channel will be usable for
a remote control (see LIRC).
If given, number in movie URL will be treated as channel position in
channel list.
.br
.I EXAMPLE:
radio://1, radio://104.4, radio_set_channel 1
.IPs "adevice=<value> (radio capture only)"
Name of device to capture sound from.
Without such a name capture will be disabled,
even if the capture keyword appears in the URL.
For ALSA devices use it in the form hw=<card>.<device>.
If the device name contains a '=', the module will use
ALSA to capture, otherwise OSS.
.IPs "arate=<value> (radio capture only)"
Rate in samples per second (default: 44100).
.br
.I NOTE:
When using audio capture set also \-rawaudio rate=<value> option
with the same value as arate.
If you have problems with sound speed (runs too quickly), try to play
with different rate values (e.g.\& 48000,44100,32000,...).
.IPs "achannels=<value> (radio capture only)"
Number of audio channels to capture.
.RE
.
.TP
.B \-rawaudio <option1:option2:...>
This option lets you play raw audio files.
You have to use \-demuxer rawaudio as well.
It may also be used to play audio CDs which are not 44kHz 16-bit stereo.
For playing raw AC-3 streams use \-rawaudio format=0x2000 \-demuxer rawaudio.
.sp 1
Available options are:
.sp 1
.PD 0
.RSs
.IPs channels=<value>
number of channels
.IPs rate=<value>
rate in samples per second
.IPs samplesize=<value>
sample size in bytes
.IPs bitrate=<value>
bitrate for rawaudio files
.IPs format=<value>
fourcc in hex
.RE
.PD 1
.
.TP
.B \-rawvideo <option1:option2:...>
This option lets you play raw video files.
You have to use \-demuxer rawvideo as well.
.sp 1
Available options are:
.sp 1
.PD 0
.RSs
.IPs fps=<value>
rate in frames per second (default: 25.0)
.IPs sqcif|qcif|cif|4cif|pal|ntsc
set standard image size
.IPs w=<value>
image width in pixels
.IPs h=<value>
image height in pixels
.IPs i420|yv12|yuy2|y8
set colorspace
.IPs format=<value>
colorspace (fourcc) in hex or string constant.
Use \-rawvideo format=help for a list of possible strings.
.IPs size=<value>
frame size in Bytes
.REss
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs "mplayer foreman.qcif -demuxer rawvideo -rawvideo qcif"
Play the famous "foreman" sample video.
.IPs "mplayer sample-720x576.yuv -demuxer rawvideo -rawvideo w=720:h=576"
Play a raw YUV sample.
.RE
.PD 1
.
.TP
.B \-rtsp\-port
Used with 'rtsp://' URLs to force the client's port number.
This option may be useful if you are behind a router and want to forward
the RTSP stream from the server to a specific client.
.
.TP
.B \-rtsp\-destination
Used with 'rtsp://' URLs to force the destination IP address to be bound.
This option may be useful with some RTSP server which do not
send RTP packets to the right interface.
If the connection to the RTSP server fails, use \-v to see
which IP address MPlayer tries to bind to and try to force
it to one assigned to your computer instead.
.
.TP
.B \-rtsp\-stream\-over\-tcp (LIVE555 and NEMESI only)
Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP
packets be streamed over TCP (using the same TCP connection as RTSP).
This option may be useful if you have a broken internet connection that does
not pass incoming UDP packets (see http://www.live555.com/\:mplayer/).
.
.TP
.B \-saveidx <filename>
Force index rebuilding and dump the index to <filename>.
Currently this only works with AVI files.
.br
.I NOTE:
This option is obsolete now that MPlayer has OpenDML support.
.
.TP
.B \-sb <byte position> (also see \-ss)
Seek to byte position.
Useful for playback from CD-ROM images or VOB files with junk at the beginning.
.
.TP
.B \-speed <0.01\-100>
Slow down or speed up playback by the factor given as parameter.
Not guaranteed to work correctly with \-oac copy.
.
.TP
.B \-srate <Hz>
Selects the output sample rate to be used
(of course sound cards have limits on this).
If the sample frequency selected is different from that
of the current media, the resample or lavcresample audio filter will be inserted
into the audio filter layer to compensate for the difference.
The type of resampling can be controlled by the \-af\-adv option.
The default is fast resampling that may cause distortion.
.
.TP
.B \-ss <time> (also see \-sb)
Seek to given time position.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-ss 56"
Seeks to 56 seconds.
.IPs "\-ss 01:10:00"
Seeks to 1 hour 10 min.
.RE
.PD 1
.
.TP
.B \-tskeepbroken
Tells MPlayer not to discard TS packets reported as broken in the stream.
Sometimes needed to play corrupted MPEG-TS files.
.
.TP
.B \-tsprobe <byte position>
When playing an MPEG-TS stream, this option lets you specify how many
bytes in the stream you want MPlayer to search for the desired
audio and video IDs.
.
.TP
.B \-tsprog <1\-65534>
When playing an MPEG-TS stream, you can specify with this option which
program (if present) you want to play.
Can be used with \-vid and \-aid.
.
.TP
.B \-tv <option1:option2:...> (TV/\:PVR only)
This option tunes various properties of the TV capture module.
For watching TV with MPlayer, use 'tv://' or 'tv://<channel_number>'
or even 'tv://<channel_name> (see option channels for channel_name below)
as a movie URL.
You can also use 'tv:///<input_id>' to start watching a
movie from a composite or S-Video input (see option input for details).
.sp 1
Available options are:
.RSs
.IPs noaudio
no sound
.IPs "automute=<0\-255> (v4l and v4l2 only)"
If signal strength reported by device is less than this value,
audio and video will be muted.
In most cases automute=100 will be enough.
Default is 0 (automute disabled).
.IPs driver=<value>
See \-tv driver=help for a list of compiled-in TV input drivers.
available: dummy, v4l, v4l2, bsdbt848 (default: autodetect)
.IPs device=<value>
Specify TV device (default: /dev/\:video0).
.I NOTE:
For the bsdbt848 driver you can provide both bktr and tuner device
names separating them with a comma, tuner after
bktr (e.g.\& -tv device=/dev/bktr1,/dev/tuner1).
.IPs input=<value>
Specify input (default: 0 (TV), see console output for available inputs).
.IPs freq=<value>
Specify the frequency to set the tuner to (e.g.\& 511.250).
Not compatible with the channels parameter.
.IPs outfmt=<value>
Specify the output format of the tuner with a preset value supported by the
V4L driver (yv12, rgb32, rgb24, rgb16, rgb15, uyvy, yuy2, i420) or an
arbitrary format given as hex value.
Try outfmt=help for a list of all available formats.
.IPs width=<value>
output window width
.IPs height=<value>
output window height
.IPs fps=<value>
framerate at which to capture video (frames per second)
.IPs buffersize=<value>
maximum size of the capture buffer in megabytes (default: dynamical)
.IPs norm=<value>
For bsdbt848 and v4l, PAL, SECAM, NTSC are available.
For v4l2, see the console output for a list of all available norms,
also see the normid option below.
.IPs "normid=<value> (v4l2 only)"
Sets the TV norm to the given numeric ID.
The TV norm depends on the capture card.
See the console output for a list of available TV norms.
.IPs channel=<value>
Set tuner to <value> channel.
.IPs chanlist=<value>
available: europe-east, europe-west, us-bcast, us-cable, etc
.IPs channels=<chan>\-<name>[=<norm>],<chan>\-<name>[=<norm>],...
Set names for channels.
.I NOTE:
If <chan> is an integer greater than 1000, it will be treated as frequency (in kHz)
rather than channel name from frequency table.
.br
Use _ for spaces in names (or play with quoting ;-).
The channel names will then be written using OSD, and the slave commands
tv_step_channel, tv_set_channel and tv_last_channel will be usable for
a remote control (see LIRC).
Not compatible with the frequency parameter.
.br
.I NOTE:
The channel number will then be the position in the 'channels' list,
beginning with 1.
.br
.I EXAMPLE:
tv://1, tv://TV1, tv_set_channel 1, tv_set_channel TV1
.IPs [brightness|contrast|hue|saturation]=<\-100\-100>
Set the image equalizer on the card.
.IPs audiorate=<value>
Set audio capture bitrate.
.IPs forceaudio
Capture audio even if there are no audio sources reported by v4l.
.IPs "alsa\ "
Capture from ALSA.
.IPs amode=<0\-3>
Choose an audio mode:
.RSss
0: mono
.br
1: stereo
.br
2: language 1
.br
3: language 2
.REss
.IPs forcechan=<1\-2>
By default, the count of recorded audio channels is determined automatically
by querying the audio mode from the TV card.
This option allows forcing stereo/\:mono recording regardless of the amode
option and the values returned by v4l.
This can be used for troubleshooting when the TV card is unable to report the
current audio mode.
.IPs adevice=<value>
Set an audio device.
<value> should be /dev/\:xxx for OSS and a hardware ID for ALSA.
You must replace any ':' by a '.' in the hardware ID for ALSA.
.IPs audioid=<value>
Choose an audio output of the capture card, if it has more than one.
.IPs "[volume|bass|treble|balance]=<0\-65535> (v4l1)"
.IPs "[volume|bass|treble|balance]=<0\-100> (v4l2)"
These options set parameters of the mixer on the video capture card.
They will have no effect, if your card does not have one.
For v4l2 50 maps to the default value of the
control, as reported by the driver.
.IPs "gain=<0\-100> (v4l2)"
Set gain control for video devices (usually webcams) to the desired
value and switch off automatic control.
A value of 0 enables automatic control.
If this option is omitted, gain control will not be modified.
.IPs immediatemode=<bool>
A value of 0 means capture and buffer audio and video together
(default for MEncoder).
A value of 1 (default for MPlayer) means to do video capture only and let the
audio go through a loopback cable from the TV card to the sound card.
.IPs mjpeg
Use hardware MJPEG compression (if the card supports it).
When using this option, you do not need to specify the width and height
of the output window, because MPlayer will determine it automatically
from the decimation value (see below).
.IPs decimation=<1|2|4>
choose the size of the picture that will be compressed by hardware
MJPEG compression:
.RSss
1: full size
    704x576    PAL
    704x480    NTSC
.br
2: medium size
    352x288    PAL
    352x240    NTSC
.br
4: small size
    176x144    PAL
    176x120    NTSC
.REss
.IPs quality=<0\-100>
Choose the quality of the JPEG compression
(< 60 recommended for full size).
.IPs tdevice=<value>
Specify TV teletext device (example: /dev/\:vbi0) (default: none).
.IPs tformat=<format>
Specify TV teletext display format (default: 0):
.RSss
0: opaque
.br
1: transparent
.br
2: opaque with inverted colors
.br
3: transparent with inverted colors
.REss
.IPs tpage=<100\-899>
Specify initial TV teletext page number (default: 100).
.IPs tlang=<\-1\-127>
Specify default teletext language code (default: 0), which will be used
as primary language until a type 28 packet is received.
Useful when the teletext system uses a non-latin character set, but language
codes are not transmitted via teletext type 28 packets for some reason.
To see a list of supported language codes set this option to \-1.
.IPs "hidden_video_renderer (dshow only)"
Terminate stream with video renderer instead of Null renderer (default: off).
Will help if video freezes but audio does not.
.I NOTE:
May not work with \-vo directx and \-vf crop combination.
.IPs "hidden_vp_renderer (dshow only)"
Terminate VideoPort pin stream with video renderer
instead of removing it from the graph (default: off).
Useful if your card has a VideoPort pin and video is choppy.
.I NOTE:
May not work with \-vo directx and \-vf crop combination.
.IPs "system_clock (dshow only)"
Use the system clock as sync source instead of the default graph clock
(usually the clock from one of the live sources in graph).
.IPs "normalize_audio_chunks (dshow only)"
Create audio chunks with a time length equal to
video frame time length (default: off).
Some audio cards create audio chunks about 0.5s in size, resulting in
choppy video when using immediatemode=0.
.RE
.
.TP
.B \-tvscan <option1:option2:...> (TV and MPlayer only)
Tune the TV channel scanner.
MPlayer will also print value for "-tv channels=" option,
including existing and just found channels.
.sp 1
Available suboptions are:
.RSs
.IPs autostart
Begin channel scanning immediately after startup (default: disabled).
.IPs period=<0.1\-2.0>
Specify delay in seconds before switching to next channel (default: 0.5).
Lower values will cause faster scanning, but can detect
inactive TV channels as active.
.IPs threshold=<1\-100>
Threshold value for the signal strength (in percent), as reported
by the device (default: 50).
A signal strength higher than this value will indicate that the
currently scanning channel is active.
.RE
.
.TP
.B \-user <username> (also see \-passwd) (network only)
Specify username for HTTP authentication.
.
.TP
.B \-user\-agent <string>
Use <string> as user agent for HTTP streaming.
.
.TP
.B \-vid <ID>
Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
(if present) with the chosen video stream.
.
.TP
.B \-vivo <suboption> (DEBUG CODE)
Force audio parameters for the VIVO demuxer (for debugging purposes).
FIXME: Document this.
.
.
.
.SH "OSD/SUBTITLE OPTIONS"
.I NOTE:
Also see \-vf expand.
.
.TP
.B \-ass (FreeType only)
Turn on SSA/ASS subtitle rendering.
With this option, libass will be used for SSA/ASS
external subtitles and Matroska tracks.
You may also want to use \-embeddedfonts.
.br
.I NOTE:
Unlike normal OSD, libass uses fontconfig by default. To disable it, use
\-nofontconfig.
.
.TP
.B \-ass\-border\-color <value>
Sets the border (outline) color for text subtitles.
The color format is RRGGBBAA.
.
.TP
.B \-ass\-bottom\-margin <value>
Adds a black band at the bottom of the frame.
The SSA/ASS renderer can place subtitles there (with \-ass\-use\-margins).
.
.TP
.B \-ass\-color <value>
Sets the color for text subtitles.
The color format is RRGGBBAA.
.
.TP
.B \-ass\-font\-scale <value>
Set the scale coefficient to be used for fonts in the SSA/ASS renderer.
.
.TP
.B \-ass\-force\-style <[Style.]Param=Value[,...]>
Override some style or script info parameters.
.sp
.I EXAMPLE:
.PD 0
.RSs
\-ass\-force\-style FontName=Arial,Default.Bold=1
.br
\-ass\-force\-style PlayResY=768
.RE
.PD 1
.
.TP
.B \-ass\-hinting <type>
Set hinting type.
<type> can be:
.PD 0
.RSs
.IPs 0
no hinting
.IPs 1
FreeType autohinter, light mode
.IPs 2
FreeType autohinter, normal mode
.IPs 3
font native hinter
.IPs "0-3 + 4"
The same, but hinting will only be performed if the OSD is rendered at
screen resolution and will therefore not be scaled.
.RE
.RSs
The default value is 7 (use native hinter for unscaled OSD and no hinting otherwise).
.RE
.PD 1
.
.TP
.B \-ass\-line\-spacing <value>
Set line spacing value for SSA/ASS renderer.
.
.TP
.B \-ass\-styles <filename>
Load all SSA/ASS styles found in the specified file and use them for
rendering text subtitles.
The syntax of the file is exactly like the
[V4 Styles] / [V4+ Styles] section of SSA/ASS.
.
.TP
.B \-ass\-top\-margin <value>
Adds a black band at the top of the frame.
The SSA/ASS renderer can place toptitles there (with \-ass\-use\-margins).
.
.TP
.B \-ass\-use\-margins
Enables placing toptitles and subtitles in black borders when they
are available.
.
.TP
.B \-dumpjacosub (MPlayer only)
Convert the given subtitle (specified with the \-sub option) to the time-based
JACOsub subtitle format.
Creates a dumpsub.js file in the current directory.
.
.TP
.B \-dumpmicrodvdsub (MPlayer only)
Convert the given subtitle (specified with the \-sub option) to the
MicroDVD subtitle format.
Creates a dumpsub.sub file in the current directory.
.
.TP
.B \-dumpmpsub (MPlayer only)
Convert the given subtitle (specified with the \-sub option) to MPlayer's
subtitle format, MPsub.
Creates a dump.mpsub file in the current directory.
.
.TP
.B \-dumpsami (MPlayer only)
Convert the given subtitle (specified with the \-sub option) to the time-based
SAMI subtitle format.
Creates a dumpsub.smi file in the current directory.
.
.TP
.B \-dumpsrtsub (MPlayer only)
Convert the given subtitle (specified with the \-sub option) to the time-based
SubViewer (SRT) subtitle format.
Creates a dumpsub.srt file in the current directory.
.br
.I NOTE:
Some broken hardware players choke on SRT subtitle files with Unix
line endings.
If you are unlucky enough to have such a box, pass your subtitle
files through unix2dos or a similar program to replace Unix line
endings with DOS/Windows line endings.
.
.TP
.B \-dumpsub (MPlayer only) (BETA CODE)
Dumps the subtitle substream from VOB streams.
Also see the \-dump*sub and \-vobsubout* options.
.
.TP
.B \-embeddedfonts (FreeType only)
Enables extraction of Matroska embedded fonts (default: disabled).
These fonts can be used for SSA/ASS subtitle
rendering (\-ass option).
Font files are created in the ~/.mplayer/\:fonts directory.
.br
.I NOTE:
With FontConfig 2.4.2 or newer, embedded fonts are opened directly from memory,
and this option is enabled by default.
.
.TP
.B \-ffactor <number>
Resample the font alphamap.
Can be:
.PD 0
.RSs
.IPs 0
plain white fonts
.IPs 0.75
very narrow black outline (default)
.IPs 1
narrow black outline
.IPs 10
bold black outline
.RE
.PD 1
.
.TP
.B \-flip\-hebrew (FriBiDi only)
Turns on flipping subtitles using FriBiDi.
.
.TP
.B \-noflip\-hebrew\-commas
Change FriBiDi's assumptions about the placements of commas in subtitles.
Use this if commas in subtitles are shown at the start of a sentence
instead of at the end.
.
.TP
.B \-font <path to font.desc file, path to font (FreeType), font pattern (Fontconfig)>
Search for the OSD/\:SUB fonts in an alternative directory (default for normal
fonts: ~/\:.mplayer/\:font/\:font.desc, default for FreeType fonts:
~/.mplayer/\:subfont.ttf).
.br
.I NOTE:
With FreeType, this option determines the path to the text font file.
With Fontconfig, this option determines the Fontconfig font pattern.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-font ~/\:.mplayer/\:arial-14/\:font.desc
.br
\-font ~/\:.mplayer/\:arialuni.ttf
.br
\-font 'Bitstream Vera Sans'
.br
\-font 'Bitstream Vera Sans:style=Bold'
.RE
.PD 1
.
.TP
.B \-fontconfig (fontconfig only)
Enables the usage of fontconfig managed fonts.
.br
.I NOTE:
By default fontconfig is used for libass-rendered subtitles and not used for
OSD. With \-fontconfig it is used for both libass and OSD, with \-nofontconfig
it is not used at all.
.
.TP
.B \-forcedsubsonly
Display only forced subtitles for the DVD subtitle stream selected by e.g.\&
\-slang.
.
.TP
.B \-fribidi\-charset <charset name> (FriBiDi only)
Specifies the character set that will be passed to FriBiDi when
decoding non-UTF-8 subtitles (default: ISO8859-8).
.
.TP
.B \-ifo <VOBsub IFO file>
Indicate the file that will be used to load palette and frame size for VOBsub
subtitles.
.
.TP
.B \-noautosub
Turns off automatic subtitle file loading.
.
.TP
.B \-osd\-duration <time>
Set the duration of the OSD messages in ms (default: 1000).
.
.TP
.B \-osdlevel <0\-3> (MPlayer only)
Specifies which mode the OSD should start in.
.PD 0
.RSs
.IPs 0
subtitles only
.IPs 1
volume + seek (default)
.IPs 2
volume + seek + timer + percentage
.IPs 3
volume + seek + timer + percentage + total time
.RE
.PD 1
.
.TP
.B \-overlapsub
Allows the next subtitle to be displayed while the current one is
still visible (default is to enable the support only for specific
formats).
.
.TP
.B \-sid <ID> (also see \-slang, \-vobsubid)
Display the subtitle stream specified by <ID> (0\-31).
MPlayer prints the available subtitle IDs when run in verbose (\-v) mode.
If you cannot select one of the subtitles on a DVD, also try \-vobsubid.
.
.TP
.B \-slang <language code[,language code,...]> (also see \-sid)
Specify a priority list of subtitle languages to use.
Different container formats employ different language codes.
DVDs use ISO 639-1 two letter language codes, Matroska uses ISO 639-2
three letter language codes while OGM uses a free-form identifier.
MPlayer prints the available languages when run in verbose (\-v) mode.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "mplayer dvd://1 \-slang hu,en"
Chooses the Hungarian subtitle track on a DVD and falls back on English if
Hungarian is not available.
.IPs "mplayer \-slang jpn example.mkv"
Plays a Matroska file with Japanese subtitles.
.RE
.PD 1
.
.TP
.B \-spuaa <mode>
Antialiasing/\:scaling mode for DVD/\:VOBsub.
A value of 16 may be added to <mode> in order to force scaling even
when original and scaled frame size already match.
This can be employed to e.g.\& smooth subtitles with gaussian blur.
Available modes are:
.PD 0
.RSs
.IPs 0
none (fastest, very ugly)
.IPs 1
approximate (broken?)
.IPs 2
full (slow)
.IPs 3
bilinear (default, fast and not too bad)
.IPs 4
uses swscaler gaussian blur (looks very good)
.RE
.PD 1
.
.TP
.B \-spualign <\-1\-2>
Specify how SPU (DVD/\:VOBsub) subtitles should be aligned.
.PD 0
.RSs
.IPs "\-1"
original position
.IPs " 0"
Align at top (original behavior, default).
.IPs " 1"
Align at center.
.IPs " 2"
Align at bottom.
.RE
.PD 1
.
.TP
.B \-spugauss <0.0\-3.0>
Variance parameter of gaussian used by \-spuaa 4.
Higher means more blur (default: 1.0).
.
.TP
.B \-sub <subtitlefile1,subtitlefile2,...>
Use/\:display these subtitle files.
Only one file can be displayed at the same time.
.
.TP
.B \-sub\-bg\-alpha <0\-255>
Specify the alpha channel value for subtitles and OSD backgrounds.
Big values mean more transparency.
0 means completely transparent.
.
.TP
.B \-sub\-bg\-color <0\-255>
Specify the color value for subtitles and OSD backgrounds.
Currently subtitles are grayscale so this value is equivalent to the
intensity of the color.
255 means white and 0 black.
.
.TP
.B \-sub\-demuxer <[+]name> (\-subfile only) (BETA CODE)
Force subtitle demuxer type for \-subfile.
Use a '+' before the name to force it, this will skip some checks!
Give the demuxer name as printed by \-sub\-demuxer help.
For backward compatibility it also accepts the demuxer ID as defined in
subreader.h.
.
.TP
.B \-sub\-fuzziness <mode>
Adjust matching fuzziness when searching for subtitles:
.PD 0
.RSs
.IPs 0
exact match
.IPs 1
Load all subs containing movie name.
.IPs 2
Load all subs in the current directory.
.RE
.PD 1
.
.TP
.B \-sub\-no\-text\-pp
Disables any kind of text post processing done after loading the subtitles.
Used for debug purposes.
.
.TP
.B \-subalign <0\-2>
Specify which edge of the subtitles should be aligned at the height
given by \-subpos.
.PD 0
.RSs
.IPs 0
Align subtitle top edge (original behavior).
.IPs 1
Align subtitle center.
.IPs 2
Align subtitle bottom edge (default).
.RE
.PD 1
.
.TP
.B "\-subcc \ "
Display DVD Closed Caption (CC) subtitles.
These are
.B not
the VOB subtitles, these are special ASCII subtitles for the
hearing impaired encoded in the VOB userdata stream on most region 1 DVDs.
CC subtitles have not been spotted on DVDs from other regions so far.
.
.TP
.B \-subcp <codepage> (iconv only)
If your system supports iconv(3), you can use this option to
specify the subtitle codepage.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-subcp latin2
.br
\-subcp cp1250
.RE
.PD 1
.
.TP
.B \-subcp enca:<language>:<fallback codepage> (ENCA only)
You can specify your language using a two letter language code to
make ENCA detect the codepage automatically.
If unsure, enter anything and watch mplayer \-v output for available
languages.
Fallback codepage specifies the codepage to use, when autodetection fails.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-subcp enca:cs:latin2"
Guess the encoding, assuming the subtitles are Czech, fall back on
latin 2, if the detection fails.
.IPs "\-subcp enca:pl:cp1250"
Guess the encoding for Polish, fall back on cp1250.
.RE
.PD 1
.
.TP
.B \-subdelay <sec>
Delays subtitles by <sec> seconds.
Can be negative.
.
.TP
.B \-subfile <filename> (BETA CODE)
Currently useless.
Same as \-audiofile, but for subtitle streams (OggDS?).
.
.TP
.B \-subfont <path to font (FreeType), font pattern (Fontconfig)> (FreeType only)
Sets the subtitle font (see \-font).
If no \-subfont is given, \-font is used.
.
.TP
.B \-subfont\-autoscale <0\-3> (FreeType only)
Sets the autoscale mode.
.br
.I NOTE:
0 means that text scale and OSD scale are font heights in points.
.sp 1
The mode can be:
.sp 1
.PD 0
.RSs
.IPs 0
no autoscale
.IPs 1
proportional to movie height
.IPs 2
proportional to movie width
.IPs 3
proportional to movie diagonal (default)
.RE
.PD 1
.
.TP
.B \-subfont\-blur <0\-8> (FreeType only)
Sets the font blur radius (default: 2).
.
.TP
.B \-subfont\-encoding <value> (FreeType only)
Sets the font encoding.
When set to 'unicode', all the glyphs from the font file will be rendered and
unicode will be used (default: unicode).
.
.TP
.B \-subfont\-osd\-scale <0\-100> (FreeType only)
Sets the autoscale coefficient of the OSD elements (default: 6).
.
.TP
.B \-subfont\-outline <0\-8> (FreeType only)
Sets the font outline thickness (default: 2).
.
.TP
.B \-subfont\-text\-scale <0\-100> (FreeType only)
Sets the subtitle text autoscale coefficient as percentage of the
screen size (default: 5).
.
.TP
.B \-subfps <rate>
Specify the framerate of the subtitle file (default: movie fps).
.br
.I NOTE:
<rate> > movie fps speeds the subtitles up for frame-based subtitle files and
slows them down for time-based ones.
.
.TP
.B \-subpos <0\-100> (useful with \-vf expand)
Specify the position of subtitles on the screen.
The value is the vertical position of the subtitle in % of the screen height.
.
.TP
.B \-subwidth <10\-100>
Specify the maximum width of subtitles on the screen.
Useful for TV-out.
The value is the width of the subtitle in % of the screen width.
.
.TP
.B \-noterm\-osd
Disable the display of OSD messages on the console when no video output is
available.
.
.TP
.B \-term\-osd\-esc <escape sequence>
Specify the escape sequence to use before writing an OSD message on the
console.
The escape sequence should move the pointer to the beginning of the line
used for the OSD and clear it (default: ^[[A\\r^[[K).
.
.TP
.B \-unicode
Tells MPlayer to handle the subtitle file as unicode.
.
.TP
.B \-unrarexec <path to unrar executable> (not supported on MingW)
Specify the path to the unrar executable so MPlayer can use it to access
rar-compressed VOBsub files (default: not set, so the feature is off).
The path must include the executable's filename, i.e.\& /usr/local/bin/unrar.
.
.TP
.B "\-utf8 \ \ "
Tells MPlayer to handle the subtitle file as UTF-8.
.
.TP
.B \-vobsub <VOBsub file without extension>
Specify a VOBsub file to use for subtitles.
Has to be the full pathname without extension, i.e.\& without
the '.idx', '.ifo' or '.sub'.
.
.TP
.B \-vobsubid <0\-31>
Specify the VOBsub subtitle ID.
.
.
.
.SH "AUDIO OUTPUT OPTIONS (MPLAYER ONLY)"
.
.TP
.B \-abs <value> (\-ao oss only) (OBSOLETE)
Override audio driver/\:card buffer size detection.
.
.TP
.B \-format <format> (also see the format audio filter)
Select the sample format used for output from the audio filter
layer to the sound card.
The values that <format> can adopt are listed below in the
description of the format audio filter.
.
.TP
.B \-mixer <device>
Use a mixer device different from the default /dev/\:mixer.
For ALSA this is the mixer name.
.
.TP
.B \-mixer\-channel <mixer line>[,mixer index] (\-ao oss and \-ao alsa only)
This option will tell MPlayer to use a different channel for controlling
volume than the default PCM.
Options for OSS include
.B vol, pcm, line.
For a complete list of options look for SOUND_DEVICE_NAMES in
/usr/\:include/\:linux/\:soundcard.h.
For ALSA you can use the names e.g.\& alsamixer displays, like
.B Master, Line, PCM.
.br
.I NOTE:
ALSA mixer channel names followed by a number must be specified in the
<name,number> format, i.e.\& a channel labeled 'PCM 1' in alsamixer must
be converted to
.BR PCM,1 .
.
.TP
.B \-softvol
Force the use of the software mixer, instead of using the sound card
mixer.
.
.TP
.B \-softvol\-max <10.0\-10000.0>
Set the maximum amplification level in percent (default: 110).
A value of 200 will allow you to adjust the volume up to a maximum of
double the current level.
With values below 100 the initial volume (which is 100%) will be above
the maximum, which e.g.\& the OSD cannot display correctly.
.
.TP
.B \-volstep <0\-100>
Set the step size of mixer volume changes in percent of the whole range
(default: 3).
.
.TP
.B \-volume <-1\-100> (also see \-af volume)
Set the startup volume in the mixer, either hardware or software (if
used with \-softvol).
A value of -1 (the default) will not change the volume.
.
.
.
.SH "AUDIO OUTPUT DRIVERS (MPLAYER ONLY)"
Audio output drivers are interfaces to different audio output facilities.
The syntax is:
.
.TP
.B \-ao <driver1[:suboption1[=value]:...],driver2,...[,]>
Specify a priority list of audio output drivers to be used.
.PP
If the list has a trailing ',' MPlayer will fall back on drivers not
contained in the list.
Suboptions are optional and can mostly be omitted.
.br
.I NOTE:
See \-ao help for a list of compiled-in audio output drivers.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-ao alsa,oss,"
Try the ALSA driver, then the OSS driver, then others.
.IPs "\-ao alsa:noblock:device=hw=0.3"
Sets noblock-mode and the device-name as first card, fourth device.
.RE
.PD 1
.sp 1
Available audio output drivers are:
.
.TP
.B "alsa\ \ \ "
ALSA 0.9/1.x audio output driver
.PD 0
.RSs
.IPs noblock
Sets noblock-mode.
.IPs device=<device>
Sets the device name.
Replace any ',' with '.' and any ':' with '=' in the ALSA device name.
For hwac3 output via S/PDIF, use an "iec958" or "spdif" device, unless
you really know how to set it correctly.
.RE
.PD 1
.
.TP
.B "alsa5\ \ "
ALSA 0.5 audio output driver
.
.TP
.B "oss\ \ \ \ "
OSS audio output driver
.PD 0
.RSs
.IPs <dsp-device>
Sets the audio output device (default: /dev/\:dsp).
.IPs <mixer-device>
Sets the audio mixer device (default: /dev/\:mixer).
.IPs <mixer-channel>
Sets the audio mixer channel (default: pcm).
.RE
.PD 1
.
.TP
.B sdl (SDL only)
highly platform independent SDL (Simple Directmedia Layer) library
audio output driver
.PD 0
.RSs
.IPs <driver>
Explicitly choose the SDL audio driver to use (default: let SDL choose).
.RE
.PD 1
.
.TP
.B "arts\ \ \ "
audio output through the aRts daemon
.
.TP
.B "esd\ \ \ \ "
audio output through the ESD daemon
.PD 0
.RSs
.IPs <server>
Explicitly choose the ESD server to use (default: localhost).
.RE
.PD 1
.
.TP
.B "jack\ \ \ \ "
audio output through JACK (Jack Audio Connection Kit)
.PD 0
.RSs
.IPs port=<name>
Connects to the ports with the given name (default: physical ports).
.IPs name=<client name>
Client name that is passed to JACK (default: MPlayer [<PID>]).
Useful if you want to have certain connections established automatically.
.IPs (no)estimate
Estimate the audio delay, supposed to make the video playback smoother
(default: enabled).
.IPs (no)autostart (default: disabled)
Automatically start jackd if necessary.
Note that this seems unreliable and will spam stdout with server messages.
.RE
.PD 1
.
.TP
.B "nas\ \ \ \ "
audio output through NAS
.
.TP
.B macosx (Mac OS X only)
native Mac OS X audio output driver
.
.TP
.B "openal\ "
Experimental OpenAL audio output driver
.
.TP
.B "pulse\ \ "
PulseAudio audio output driver
.PD 0
.RSs
.IPs "[<host>][:<output sink>]"
Specify the host and optionally output sink to use.
An empty <host> string uses a local connection, "localhost"
uses network transfer (most likely not what you want).
.RE
.PD 1
.
.TP
.B sgi (SGI only)
native SGI audio output driver
.PD 0
.RSs
.IPs "<output device name>"
Explicitly choose the output device/\:interface to use
(default: system-wide default).
For example, 'Analog Out' or 'Digital Out'.
.RE
.PD 1
.
.TP
.B sun (Sun only)
native Sun audio output driver
.PD 0
.RSs
.IPs <device>
Explicitly choose the audio device to use (default: /dev/\:audio).
.RE
.PD 1
.
.TP
.B win32 (Windows only)
native Windows waveout audio output driver
.
.TP
.B dsound (Windows only)
DirectX DirectSound audio output driver
.PD 0
.RSs
.IPs device=<devicenum>
Sets the device number to use.
Playing a file with \-v will show a list of available devices.
.RE
.PD 1
.
.TP
.B dart (OS/2 only)
OS/2 DART audio output driver
.PD 0
.RSs
.IPs (no)share
Open DART in shareable or exclusive mode.
.IPs bufsize=<size>
Set buffer size to <size> in samples (default: 2048).
.RE
.PD 1
.
.TP
.B dxr2 (also see \-dxr2) (DXR2 only)
Creative DXR2 specific output driver
.
.TP
.B ivtv (IVTV only)
IVTV specific MPEG audio output driver.
Works with \-ac hwmpa only.
.
.TP
.B v4l2 (requires Linux 2.6.22+ kernel)
Audio output driver for V4L2 cards with hardware MPEG decoder.
.
.TP
.B mpegpes (DVB only)
Audio output driver for DVB cards that writes the output to an MPEG-PES
file if no DVB card is installed.
.PD 0
.RSs
.IPs card=<1\-4>
DVB card to use if more than one card is present.
If not specified MPlayer will search the first usable card.
.IPs file=<filename>
output filename
.RE
.PD 1
.
.TP
.B "null\ \ \ "
Produces no audio output but maintains video playback speed.
Use \-nosound for benchmarking.
.
.TP
.B "pcm\ \ \ \ "
raw PCM/wave file writer audio output
.PD 0
.RSs
.IPs (no)waveheader
Include or do not include the wave header (default: included).
When not included, raw PCM will be generated.
.IPs file=<filename>
Write the sound to <filename> instead of the default
audiodump.wav.
If nowaveheader is specified, the default is audiodump.pcm.
.IPs "fast\ "
Try to dump faster than realtime.
Make sure the output does not get truncated (usually with
"Too many video packets in buffer" message).
It is normal that you get a "Your system is too SLOW to play this!" message.
.RE
.PD 1
.
.TP
.B "plugin\ \ "
plugin audio output driver
.
.
.
.SH "VIDEO OUTPUT OPTIONS (MPLAYER ONLY)"
.
.TP
.B \-adapter <value>
Set the graphics card that will receive the image.
You can get a list of available cards when you run this option with \-v.
Currently only works with the directx video output driver.
.
.TP
.B \-bpp <depth>
Override the autodetected color depth.
Only supported by the fbdev, dga, svga, vesa video output drivers.
.
.TP
.B \-border
Play movie with window border and decorations.
Since this is on by default, use \-noborder to disable the standard window
decorations.
.
.TP
.B \-brightness <\-100\-100>
Adjust the brightness of the video signal (default: 0).
Not supported by all video output drivers.
.
.TP
.B \-contrast <\-100\-100>
Adjust the contrast of the video signal (default: 0).
Not supported by all video output drivers.
.
.TP
.B \-display <name> (X11 only)
Specify the hostname and display number of the X server you want to display
on.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-display xtest.localdomain:0
.RE
.PD 1
.
.TP
.B "\-dr \ \ \ "
Turns on direct rendering (not supported by all codecs and video outputs)
.br
.I WARNING:
May cause OSD/SUB corruption!
.
.TP
.B \-dxr2 <option1:option2:...>
This option is used to control the dxr2 video output driver.
.RSs
.IPs ar-mode=<value>
aspect ratio mode (0 = normal, 1 = pan-and-scan, 2 = letterbox (default))
.IPs iec958-encoded
Set iec958 output mode to encoded.
.IPs iec958-decoded
Set iec958 output mode to decoded (default).
.IPs macrovision=<value>
macrovision mode (0 = off (default), 1 = agc, 2 = agc 2 colorstripe,
3 = agc 4 colorstripe)
.IPs "mute\ "
mute sound output
.IPs unmute
unmute sound output
.IPs ucode=<value>
path to the microcode
.RE
.RS
.sp 1
.I TV output
.RE
.RSs
.IPs 75ire
enable 7.5 IRE output mode
.IPs no75ire
disable 7.5 IRE output mode (default)
.IPs "bw\ \ \ "
b/w TV output
.IPs color
color TV output (default)
.IPs interlaced
interlaced TV output (default)
.IPs nointerlaced
disable interlaced TV output
.IPs norm=<value>
TV norm (ntsc (default), pal, pal60, palm, paln, palnc)
.IPs square-pixel
set pixel mode to square
.IPs ccir601-pixel
set pixel mode to ccir601
.RE
.RS
.sp 1
.I overlay
.RE
.RSs
.IPs cr-left=<0\-500>
Set the left cropping value (default: 50).
.IPs cr-right=<0\-500>
Set the right cropping value (default: 300).
.IPs cr-top=<0\-500>
Set the top cropping value (default: 0).
.IPs cr-bottom=<0\-500>
Set the bottom cropping value (default: 0).
.IPs ck-[r|g|b]=<0\-255>
Set the r(ed), g(reen) or b(lue) gain of the overlay color-key.
.IPs ck-[r|g|b]min=<0\-255>
minimum value for the respective color key
.IPs ck-[r|g|b]max=<0\-255>
maximum value for the respective color key
.IPs ignore-cache
Ignore cached overlay settings.
.IPs update-cache
Update cached overlay settings.
.IPs ol-osd
Enable overlay onscreen display.
.IPs nool-osd
Disable overlay onscreen display (default).
.IPs ol[h|w|x|y]-cor=<\-20\-20>
Adjust the overlay size (h,w) and position (x,y) in case it does not
match the window perfectly (default: 0).
.IPs overlay
Activate overlay (default).
.IPs nooverlay
Activate TV-out.
.IPs overlay-ratio=<1\-2500>
Tune the overlay (default: 1000).
.RE
.
.TP
.B \-fbmode <modename> (\-vo fbdev only)
Change video mode to the one that is labeled as <modename> in
/etc/\:fb.modes.
.br
.I NOTE:
VESA framebuffer does not support mode changing.
.
.TP
.B \-fbmodeconfig <filename> (\-vo fbdev only)
Override framebuffer mode configuration file (default: /etc/\:fb.modes).
.
.TP
.B \-fs (also see \-zoom)
Fullscreen playback (centers movie, and paints black bands around it).
Not supported by all video output drivers.
.
.TP
.B \-fsmode\-dontuse <0\-31> (OBSOLETE, use the \-fs option)
Try this option if you still experience fullscreen problems.
.
.TP
.B \-fstype <type1,type2,...> (X11 only)
Specify a priority list of fullscreen modes to be used.
You can negate the modes by prefixing them with '\-'.
If you experience problems like the fullscreen window being covered
by other windows try using a different order.
.br
.I NOTE:
See \-fstype help for a full list of available modes.
.sp 1
The available types are:
.sp 1
.PD 0
.RSs
.IPs above
Use the _NETWM_STATE_ABOVE hint if available.
.IPs below
Use the _NETWM_STATE_BELOW hint if available.
.IPs fullscreen
Use the _NETWM_STATE_FULLSCREEN hint if available.
.IPs layer
Use the _WIN_LAYER hint with the default layer.
.IPs layer=<0...15>
Use the _WIN_LAYER hint with the given layer number.
.IPs netwm
Force NETWM style.
.IPs "none\ "
Do not set fullscreen window layer.
.IPs stays_on_top
Use _NETWM_STATE_STAYS_ON_TOP hint if available.
.REss
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs layer,stays_on_top,above,fullscreen
Default order, will be used as a fallback if incorrect or
unsupported modes are specified.
.IPs \-fullscreen
Fixes fullscreen switching on OpenBox 1.x.
.RE
.PD 1
.
.TP
.B \-geometry x[%][:y[%]] or [WxH][+x+y]
Adjust where the output is on the screen initially.
The x and y specifications are in pixels measured from the top-left of the
screen to the top-left of the image being displayed, however if a percentage
sign is given after the argument it turns the value into a percentage of the
screen size in that direction.
It also supports the standard X11 \-geometry option format.
If an external window is specified using the \-wid option, then the x and
y coordinates are relative to the top-left corner of the window rather
than the screen.
.br
.I NOTE:
This option is only supported by the x11, xmga, xv, xvmc, xvidix,
gl, gl2, directx, fbdev and tdfxfb video output drivers.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs 50:40
Places the window at x=50, y=40.
.IPs 50%:50%
Places the window in the middle of the screen.
.IPs "100%\ "
Places the window at the middle of the right edge of the screen.
.IPs 100%:100%
Places the window at the bottom right corner of the screen.
.RE
.PD 1
.
.TP
.B \-guiwid <window ID> (also see \-wid) (GUI only)
This tells the GUI to also use an X11 window and stick itself to the bottom
of the video, which is useful to embed a mini-GUI in a browser (with the
MPlayer plugin for instance).
.
.TP
.B \-hue <\-100\-100>
Adjust the hue of the video signal (default: 0).
You can get a colored negative of the image with this option.
Not supported by all video output drivers.
.
.TP
.B \-monitor\-dotclock <range[,range,...]> (\-vo fbdev and vesa only)
Specify the dotclock or pixelclock range of the monitor.
.
.TP
.B \-monitor\-hfreq <range[,range,...]> (\-vo fbdev and vesa only)
Specify the horizontal frequency range of the monitor.
.
.TP
.B \-monitor\-vfreq <range[,range,...]> (\-vo fbdev and vesa only)
Specify the vertical frequency range of the monitor.
.
.TP
.B \-monitoraspect <ratio> (also see \-aspect)
Set the aspect ratio of your monitor or TV screen.
A value of 0 disables a previous setting (e.g.\& in the config file).
Overrides the \-monitorpixelaspect setting if enabled.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-monitoraspect 4:3  or 1.3333
.br
\-monitoraspect 16:9 or 1.7777
.RE
.PD 1
.
.TP
.B \-monitorpixelaspect <ratio> (also see \-aspect)
Set the aspect of a single pixel of your monitor or TV screen (default: 1).
A value of 1 means square pixels
(correct for (almost?) all LCDs).
.
.TP
.B \-nodouble
Disables double buffering, mostly for debugging purposes.
Double buffering fixes flicker by storing two frames in memory, and
displaying one while decoding another.
It can affect OSD negatively, but often removes OSD flickering.
.
.TP
.B \-nograbpointer
Do not grab the mouse pointer after a video mode change (\-vm).
Useful for multihead setups.
.
.TP
.B \-nokeepaspect
Do not keep window aspect ratio when resizing windows.
Only works with the x11, xv, xmga, xvidix, directx video output drivers.
Furthermore under X11 your window manager has to honor window aspect hints.
.
.TP
.B "\-ontop\ "
Makes the player window stay on top of other windows.
Supported by video output drivers which use X11, except SDL,
as well as directx, macosx, quartz, ggi and gl2.
.
.TP
.B \-panscan <0.0\-1.0>
Enables pan-and-scan functionality (cropping the sides of e.g.\& a 16:9
movie to make it fit a 4:3 display without black bands).
The range controls how much of the image is cropped.
Only works with the xv, xmga, mga, gl, gl2, quartz, macosx and xvidix
video output drivers.
.br
.I NOTE:
Values between \-1 and 0 are allowed as well, but highly experimental
and may crash or worse.
Use at your own risk!
.
.TP
.B \-panscanrange <\-19.0\-99.0> (experimental)
Change the range of the pan-and-scan functionality (default: 1).
Positive values mean multiples of the default range.
Negative numbers mean you can zoom in up to a factor of \-panscanrange+1.
E.g.\& \-panscanrange \-3 allows a zoom factor of up to 4.
This feature is experimental.
Do not report bugs unless you are using \-vo gl.
.
.TP
.B \-refreshrate <Hz>
Set the monitor refreshrate in Hz.
Currently only supported by \-vo directx combined with the \-vm option.
.
.TP
.B \-rootwin
Play movie in the root window (desktop background).
Desktop background images may cover the movie window, though.
Only works with the x11, xv, xmga, xvidix, quartz, macosx and directx video output drivers.
.
.TP
.B \-saturation <\-100\-100>
Adjust the saturation of the video signal (default: 0).
You can get grayscale output with this option.
Not supported by all video output drivers.
.
.TP
.B \-screenh <pixels>
Specify the screen height for video output drivers which
do not know the screen resolution like fbdev, x11 and TV-out.
.
.TP
.B \-screenw <pixels>
Specify the screen width for video output drivers which
do not know the screen resolution like fbdev, x11 and TV-out.
.
.TP
.B \-stop\-xscreensaver (X11 only)
Turns off xscreensaver at startup and turns it on again on exit.
If your screensaver supports neither the XSS nor XResetScreenSaver
API please use \-heartbeat\-cmd instead.
.
.TP
.B "\-vm \ \ \ "
Try to change to a different video mode.
Supported by the dga, x11, xv, sdl and directx video output drivers.
If used with the directx video output driver the \-screenw,
\-screenh, \-bpp and \-refreshrate options can be used to set
the new display mode.
.
.TP
.B "\-vsync \ \ "
Enables VBI for the vesa, dfbmga and svga video output drivers.
.
.TP
.B \-wid <window ID> (also see \-guiwid) (X11, OpenGL and DirectX only)
This tells MPlayer to attach to an existing window.
Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
.
.TP
.B \-xineramascreen <\-2\-...>
In Xinerama configurations (i.e.\& a single desktop that spans across multiple
displays) this option tells MPlayer which screen to display the movie on.
A value of \-2 means fullscreen across the whole virtual display (in this case
Xinerama information is completely ignored), \-1 means
fullscreen on the display the window currently is on.
The initial position set via the \-geometry option is relative to the
specified screen.
Will usually only work with "\-fstype \-fullscreen" or "\-fstype none".
This option is not suitable to only set the startup screen (because
it will always display on the given screen in fullscreen mode),
\-geometry is the best that is available for that purpose
currently.
Supported by the gl, gl2, x11, and xv video output drivers.
.
.TP
.B \-zrbw (\-vo zr only)
Display in black and white.
For optimal performance, this can be combined with '\-lavdopts gray'.
.
.TP
.B \-zrcrop <[width]x[height]+[x offset]+[y offset]> (\-vo zr only)
Select a part of the input image to display, multiple occurrences
of this option switch on cinerama mode.
In cinerama mode the movie is distributed over more than one TV
(or beamer) to create a larger image.
Options appearing after the n-th \-zrcrop apply to the n-th MJPEG card, each
card should at least have a \-zrdev in addition to the \-zrcrop.
For examples, see the output of \-zrhelp and the Zr section of the
documentation.
.
.TP
.B \-zrdev <device> (\-vo zr only)
Specify the device special file that belongs to your MJPEG card, by default
the zr video output driver takes the first v4l device it can find.
.
.TP
.B \-zrfd (\-vo zr only)
Force decimation: Decimation, as specified by \-zrhdec and \-zrvdec, only
happens if the hardware scaler can stretch the image to its original size.
Use this option to force decimation.
.
.TP
.B \-zrhdec <1|2|4> (\-vo zr only)
Horizontal decimation: Ask the driver to send only every 2nd or 4th
line/\:pixel of the input image to the MJPEG card and use the scaler
of the MJPEG card to stretch the image to its original size.
.
.TP
.B \-zrhelp (\-vo zr only)
Display a list of all \-zr* options, their default values and a
cinerama mode example.
.
.TP
.B \-zrnorm <norm> (\-vo zr only)
Specify the TV norm as PAL or NTSC (default: no change).
.
.TP
.B \-zrquality <1\-20> (\-vo zr only)
A number from 1 (best) to 20 (worst) representing the JPEG encoding quality.
.
.TP
.B \-zrvdec <1|2|4> (\-vo zr only)
Vertical decimation: Ask the driver to send only every 2nd or 4th
line/\:pixel of the input image to the MJPEG card and use the scaler
of the MJPEG card to stretch the image to its original size.
.
.TP
.B \-zrxdoff <x display offset> (\-vo zr only)
If the movie is smaller than the TV screen, this option specifies the x
offset from the upper-left corner of the TV screen (default: centered).
.
.TP
.B \-zrydoff <y display offset> (\-vo zr only)
If the movie is smaller than the TV screen, this option specifies the y
offset from the upper-left corner of the TV screen (default: centered).
.
.
.
.SH "VIDEO OUTPUT DRIVERS (MPLAYER ONLY)"
Video output drivers are interfaces to different video output facilities.
The syntax is:
.
.TP
.B \-vo <driver1[:suboption1[=value]:...],driver2,...[,]>
Specify a priority list of video output drivers to be used.
.PP
If the list has a trailing ',' MPlayer will fall back on drivers not
contained in the list.
Suboptions are optional and can mostly be omitted.
.br
.I NOTE:
See \-vo help for a list of compiled-in video output drivers.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-vo xmga,xv,"
Try the Matrox X11 driver, then the Xv driver, then others.
.IPs "\-vo directx:noaccel"
Uses the DirectX driver with acceleration features turned off.
.RE
.PD 1
.sp 1
Available video output drivers are:
.
.TP
.B xv (X11 only)
Uses the XVideo extension of XFree86 4.x to enable hardware
accelerated playback.
If you cannot use a hardware specific driver, this is probably
the best option.
For information about what colorkey is used and how it is drawn run MPlayer
with \-v option and look out for the lines tagged with [xv common] at the
beginning.
.PD 0
.RSs
.IPs adaptor=<number>
Select a specific XVideo adaptor (check xvinfo results).
.IPs port=<number>
Select a specific XVideo port.
.IPs ck=<cur|use|set>
Select the source from which the colorkey is taken (default: cur).
.RSss
.IPs cur
The default takes the colorkey currently set in Xv.
.IPs use
Use but do not set the colorkey from MPlayer (use \-colorkey option to change
it).
.IPs set
Same as use but also sets the supplied colorkey.
.RE
.IPs ck-method=<man|bg|auto>
Sets the colorkey drawing method (default: man).
.RSss
.IPs man
Draw the colorkey manually (reduces flicker in some cases).
.IPs bg
Set the colorkey as window background.
.IPs auto
Let Xv draw the colorkey.
.RE
.RE
.PD 1
.
.TP
.B x11 (X11 only)
Shared memory video output driver without hardware acceleration that
works whenever X11 is present.
.
.TP
.B xover (X11 only)
Adds X11 support to all overlay based video output drivers.
Currently only supported by tdfx_vid.
.PD 0
.RSs
.IPs <vo_driver>
Select the driver to use as source to overlay on top of X11.
.RE
.PD 1
.
.TP
.B vdpau (with \-vc ffmpeg12vdpau, ffwmv3vdpau, ffvc1vdpau or ffh264vdpau)
Video output that uses VDPAU to decode video via hardware.
Also supports displaying of software-decoded video.
.PD 0
.RSs
.IPs sharpen=<\-1\-1>
For positive values, apply a sharpening algorithm to the video,
for negative values a blurring algorithm (default: 0).
.IPs denoise=<0\-1>
Apply a noise reduction algorithm to the video (default: 0, no noise reduction).
.IPs deint=<0\-4>
Chooses the deinterlacer (default: 0).
All modes > 0 respect \-field\-dominance.
.RSss
.IPs 0
No deinterlacing.
.IPs 1
Show only first field, similar to \-vf field.
.IPs 2
Bob deinterlacing, similar to \-vf tfields=1.
.IPs 3
Motion adaptive temporal deinterlacing.
May lead to A/V desync with slow video hardware and/or high resolution.
This is the default if "D" is used to enable deinterlacing.
.IPs 4
Motion adaptive temporal deinterlacing with edge-guided spatial interpolation.
Needs fast video hardware.
.RE
.IPs chroma\-deint
Makes temporal deinterlacers operate both on luma and chroma (default).
Use nochroma\-deint to solely use luma and speed up advanced deinterlacing.
Useful with slow video memory.
.IPs pullup
Try to apply inverse telecine, needs motion adaptive temporal deinterlacing.
.RE
.PD 1 
.
.TP
.B xvmc (X11 with \-vc ffmpeg12mc only)
Video output driver that uses the XvMC (X Video Motion Compensation)
extension of XFree86 4.x to speed up MPEG-1/2 and VCR2 decoding.
.PD 0
.RSs
.IPs adaptor=<number>
Select a specific XVideo adaptor (check xvinfo results).
.IPs port=<number>
Select a specific XVideo port.
.IPs (no)benchmark
Disables image display.
Necessary for proper benchmarking of drivers that change
image buffers on monitor retrace only (nVidia).
Default is not to disable image display (nobenchmark).
.IPs (no)bobdeint
Very simple deinterlacer.
Might not look better than \-vf tfields=1,
but it is the only deinterlacer for xvmc (default: nobobdeint).
.IPs (no)queue
Queue frames for display to allow more parallel work of the video hardware.
May add a small (not noticeable) constant A/V desync (default: noqueue).
.IPs (no)sleep
Use sleep function while waiting for rendering to finish
(not recommended on Linux) (default: nosleep).
.IPs ck=cur|use|set
Same as \-vo xv:ck (see \-vo xv).
.IPs ck-method=man|bg|auto
Same as \-vo xv:ck-method (see \-vo xv).
.RE
.PD 1
.
.TP
.B dga (X11 only)
Play video through the XFree86 Direct Graphics Access extension.
Considered obsolete.
.
.TP
.B sdl (SDL only, buggy/outdated)
Highly platform independent SDL (Simple Directmedia Layer) library
video output driver.
Since SDL uses its own X11 layer, MPlayer X11 options do not have
any effect on SDL.
Note that it has several minor bugs (\-vm/\-novm is mostly ignored,
\-fs behaves like \-novm should, window is in top-left corner when
returning from fullscreen, panscan is not supported, ...)
.PD 0
.RSs
.IPs driver=<driver>
Explicitly choose the SDL driver to use.
.IPs (no)forcexv
Use XVideo through the sdl video output driver (default: forcexv).
.IPs (no)hwaccel
Use hardware accelerated scaler (default: hwaccel).
.RE
.PD 1
.
.TP
.B "vidix\ \ "
VIDIX (VIDeo Interface for *niX) is an interface to the
video acceleration features of different graphics cards.
Very fast video output driver on cards that support it.
.PD 0
.RSs
.IPs <subdevice>
Explicitly choose the VIDIX subdevice driver to use.
Available subdevice drivers are cyberblade, ivtv, mach64,
mga_crtc2, mga, nvidia, pm2, pm3, radeon, rage128, s3, sh_veu,
sis_vid and unichrome.
.RE
.PD 1
.
.TP
.B xvidix (X11 only)
X11 frontend for VIDIX
.PD 0
.RSs
.IPs <subdevice>
same as vidix
.RE
.PD 1
.
.TP
.B "cvidix\ "
Generic and platform independent VIDIX frontend, can even run in a
text console with nVidia cards.
.PD 0
.RSs
.IPs <subdevice>
same as vidix
.RE
.PD 1
.
.TP
.B winvidix (Windows only)
Windows frontend for VIDIX
.PD 0
.RSs
.IPs <subdevice>
same as vidix
.RE
.PD 1
.
.TP
.B direct3d (Windows only) (BETA CODE!)
Video output driver that uses the Direct3D interface (useful for Vista).
.
.TP
.B directx (Windows only)
Video output driver that uses the DirectX interface.
.PD 0
.RSs
.IPs noaccel
Turns off hardware acceleration.
Try this option if you have display problems.
.RE
.PD 1
.
.TP
.B kva (OS/2 only)
Video output driver that uses the libkva interface.
.PD 0
.RSs
.IPs snap
Force SNAP mode.
.IPs wo
Force WarpOverlay! mode.
.IPs dive
Force DIVE mode.
.IPs (no)t23
Enable/disable workaround for T23 laptop (default: \-not23).
Try to enable this option if your video card supports upscaling only.
.RE
.PD 1
.
.TP
.B quartz (Mac OS X only)
Mac OS X Quartz video output driver.
Under some circumstances, it might be more efficient to force a
packed YUV output format, with e.g.\& \-vf format=yuy2.
.PD 0
.RSs
.IPs device_id=<number>
Choose the display device to use in fullscreen.
.IPs fs_res=<width>:<height>
Specify the fullscreen resolution (useful on slow systems).
.RE
.PD 1
.
.TP
.B macosx (Mac OS X 10.4 or 10.3.9 with QuickTime 7)
Mac OS X CoreVideo video output driver
.PD 0
.RSs
.IPs device_id=<number>
Choose the display device to use for fullscreen or set it to \-1 to
always use the same screen the video window is on (default: \-1 \- auto).
.IPs shared_buffer
Write output to a shared memory buffer instead of displaying it and
try to open an existing NSConnection for communication with a GUI.
.IPs buffer_name=<name>
Name of the shared buffer created with shm_open as well as the name of
the NSConnection MPlayer will try to open (default: "mplayerosx").
Setting buffer_name implicitly enables shared_buffer.
.RE
.PD 1
.
.TP
.B fbdev (Linux only)
Uses the kernel framebuffer to play video.
.PD 0
.RSs
.IPs <device>
Explicitly choose the fbdev device name to use (e.g.\& /dev/\:fb0) or the
name of the VIDIX subdevice if the device name starts with 'vidix'
(e.g.\& 'vidixsis_vid' for the sis driver).
.RE
.PD 1
.
.TP
.B fbdev2 (Linux only)
Uses the kernel framebuffer to play video,
alternative implementation.
.PD 0
.RSs
.IPs <device>
Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
.RE
.PD 1
.
.TP
.B "vesa\ \ \ "
Very general video output driver that should work on any VESA VBE 2.0
compatible card.
.PD 0
.RSs
.IPs (no)dga
Turns DGA mode on or off (default: on).
.IPs neotv_pal
Activate the NeoMagic TV out and set it to PAL norm.
.IPs neotv_ntsc
Activate the NeoMagic TV out and set it to NTSC norm.
.IPs vidix
Use the VIDIX driver.
.IPs "lvo:\ \ \ "
Activate the Linux Video Overlay on top of VESA mode.
.RE
.PD 1
.
.TP
.B "svga\ \ \ "
Play video using the SVGA library.
.PD 0
.RSs
.IPs "<video mode>"
Specify video mode to use.
The mode can be given in a <width>x<height>x<colors> format,
e.g.\& 640x480x16M or be a graphics mode number, e.g.\& 84.
.IPs bbosd
Draw OSD into black bands below the movie (slower).
.IPs native
Use only native drawing functions.
This avoids direct rendering, OSD and hardware acceleration.
.IPs retrace
Force frame switch on vertical retrace.
Usable only with \-double.
It has the same effect as the \-vsync option.
.IPs "sq\ \ \ "
Try to select a video mode with square pixels.
.IPs vidix
Use svga with VIDIX.
.RE
.PD 1
.
.TP
.B "gl\ \ \ \ \ "
OpenGL video output driver, simple version.
Video size must be smaller than
the maximum texture size of your OpenGL implementation.
Intended to work even with the most basic OpenGL implementations,
but also makes use of newer extensions, which allow support for more
colorspaces and direct rendering.
For optimal speed try something similar to
.br
\-vo gl:yuv=2:rectangle=2:force\-pbo:ati\-hack \-dr \-noslices
.br
The code performs very few checks, so if a feature does not work, this
might be because it is not supported by your card/OpenGL implementation
even if you do not get any error message.
Use glxinfo or a similar tool to display the supported OpenGL extensions.
.PD 0
.RSs
.IPs (no)ati\-hack
ATI drivers may give a corrupted image when PBOs are used (when using \-dr
or force\-pbo).
This option fixes this, at the expense of using a bit more memory.
.IPs (no)force\-pbo
Always uses PBOs to transfer textures even if this involves an extra copy.
Currently this gives a little extra speed with NVidia drivers and a lot more
speed with ATI drivers.
May need \-noslices and the ati\-hack suboption to work correctly.
.IPs (no)scaled-osd
Changes the way the OSD behaves when the size of the
window changes (default: disabled).
When enabled behaves more like the other video output drivers,
which is better for fixed-size fonts.
Disabled looks much better with FreeType fonts and uses the
borders in fullscreen mode.
Does not work correctly with ass subtitles (see \-ass), you can instead
render them without OpenGL support via \-vf ass.
.IPs osdcolor=<0xAARRGGBB>
Color for OSD (default: 0x00ffffff, corresponds to non-transparent white).
.IPs rectangle=<0,1,2>
Select usage of rectangular textures which saves video RAM, but often is
slower (default: 0).
.RSss
0: Use power-of-two textures (default).
.br
1: Use the GL_ARB_texture_rectangle extension.
.br
2: Use the GL_ARB_texture_non_power_of_two extension.
In some cases only supported in software and thus very slow.
.RE
.IPs swapinterval=<n>
Minimum interval between two buffer swaps, counted in
displayed frames (default: 1).
1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
Values below 0 will leave it at the system default.
This limits the framerate to (horizontal refresh rate / n).
Requires GLX_SGI_swap_control support to work.
With some (most/all?) implementations this only works in fullscreen mode.
.IPs yuv=<n>
Select the type of YUV to RGB conversion.
.RSss
0: Use software conversion (default).
Compatible with all OpenGL versions.
Provides brightness, contrast and saturation control.
.br
1: Use register combiners.
This uses an nVidia-specific extension (GL_NV_register_combiners).
At least three texture units are needed.
Provides saturation and hue control.
This method is fast but inexact.
.br
2: Use a fragment program.
Needs the GL_ARB_fragment_program extension and at least three texture units.
Provides brightness, contrast, saturation and hue control.
.br
3: Use a fragment program using the POW instruction.
Needs the GL_ARB_fragment_program extension and at least three texture units.
Provides brightness, contrast, saturation, hue and gamma control.
Gamma can also be set independently for red, green and blue.
Method 4 is usually faster.
.br
4: Use a fragment program with additional lookup.
Needs the GL_ARB_fragment_program extension and at least four texture units.
Provides brightness, contrast, saturation, hue and gamma control.
Gamma can also be set independently for red, green and blue.
.br
5: Use ATI-specific method (for older cards).
This uses an ATI-specific extension (GL_ATI_fragment_shader \- not
GL_ARB_fragment_shader!).
At least three texture units are needed.
Provides saturation and hue control.
This method is fast but inexact.
.br
6: Use a 3D texture to do conversion via lookup.
Needs the GL_ARB_fragment_program extension and at least four texture units.
Extremely slow (software emulation) on some (all?) ATI cards since it uses
a texture with border pixels.
Provides brightness, contrast, saturation, hue and gamma control.
Gamma can also be set independently for red, green and blue.
Speed depends more on GPU memory bandwidth than other methods.
.RE
.IPs ycbcr
Use the GL_MESA_ycbcr_texture extension to convert YUV to RGB.
In most cases this is probably slower than doing software conversion to RGB.
.IPs lscale=<n>
Select the scaling function to use for luminance scaling.
Only valid for yuv modes 2, 3, 4 and 6.
.RSss
0: Use simple linear filtering (default).
.br
1: Use bicubic B-spline filtering (better quality).
Needs one additional texture unit.
Older cards will not be able to handle this for chroma at least in fullscreen mode.
.br
2: Use cubic filtering in horizontal, linear filtering in vertical direction.
Works on a few more cards than method 1.
.br
3: Same as 1 but does not use a lookup texture.
Might be faster on some cards.
.br
4: Use experimental unsharp masking with 3x3 support and a default strength of 0.5 (see filter-strength).
.br
5: Use experimental unsharp masking with 5x5 support and a default strength of 0.5 (see filter-strength).
.RE
.IPs cscale=<n>
Select the scaling function to use for chrominance scaling.
For details see lscale.
.IPs filter-strength=<value>
Set the effect strength for the lscale/cscale filters that support it.
.IPs customprog=<filename>
Load a custom fragment program from <filename>.
See TOOLS/edgedect.fp for an example.
.IPs customtex=<filename>
Load a custom "gamma ramp" texture from <filename>.
This can be used in combination with yuv=4 or with the customprog option.
.IPs (no)customtlin
If enabled (default) use GL_LINEAR interpolation, otherwise use GL_NEAREST
for customtex texture.
.IPs (no)customtrect
If enabled, use texture_rectangle for customtex texture.
Default is disabled.
.RE
.sp 1
.RS
Normally there is no reason to use the following options, they mostly
exist for testing purposes.
.RE
.sp 1
.RSs
.IPs (no)glfinish
Call glFinish() before swapping buffers.
Slower but in some cases more correct output (default: disabled).
.IPs (no)manyfmts
Enables support for more (RGB and BGR) color formats (default: enabled).
Needs OpenGL version >= 1.2.
.IPs slice-height=<0\-...>
Number of lines copied to texture in one piece (default: 0).
0 for whole image.
.br
.I NOTE:
If YUV colorspace is used (see yuv suboption), special rules apply:
.RSss
If the decoder uses slice rendering (see \-noslices), this setting
has no effect, the size of the slices as provided by the decoder is used.
.br
If the decoder does not use slice rendering, the default is 16.
.RE
.IPs (no)osd
Enable or disable support for OSD rendering via OpenGL (default: enabled).
This option is for testing; to disable the OSD use \-osdlevel 0 instead.
.IPs (no)aspect
Enable or disable aspect scaling and pan-and-scan support (default: enabled).
Disabling might increase speed.
.REss
.RE
.PD 1
.
.TP
.B "gl2\ \ \ \ "
Variant of the OpenGL video output driver.
Supports videos larger than the maximum texture size but lacks many of the
advanced features and optimizations of the gl driver and is unlikely to be
extended further.
.PD 0
.RSs
.IPs (no)glfinish
same as gl (default: enabled)
.IPs yuv=<n>
Select the type of YUV to RGB conversion.
If set to anything except 0 OSD will be disabled and brightness, contrast and
gamma setting is only available via the global X server settings.
Apart from this the values have the same meaning as for \-vo gl.
.REss
.
.TP
.B "null\ \ \ "
Produces no video output.
Useful for benchmarking.
.
.TP
.B "aa\ \ \ \ \ "
ASCII art video output driver that works on a text console.
You can get a list and an explanation of available suboptions
by executing 'mplayer \-vo aa:help'.
.br
.I NOTE:
The driver does not handle \-aspect correctly.
.br
.I HINT:
You probably have to specify \-monitorpixelaspect.
Try 'mplayer \-vo aa \-monitorpixelaspect 0.5'.
.
.TP
.B "caca\ \ \ "
Color ASCII art video output driver that works on a text console.
.
.TP
.B "bl\ \ \ \ \ "
Video playback using the Blinkenlights UDP protocol.
This driver is highly hardware specific.
.PD 0
.RSs
.IPs <subdevice>
Explicitly choose the Blinkenlights subdevice driver to use.
It is something like arcade:host=localhost:2323 or
hdl:file=name1,file=name2.
You must specify a subdevice.
.RE
.PD 1
.
.TP
.B "ggi\ \ \ \ "
GGI graphics system video output driver
.PD 0
.RSs
.IPs <driver>
Explicitly choose the GGI driver to use.
Replace any ',' that would appear in the driver string by a '.'.
.RE
.PD 1
.
.TP
.B directfb
Play video using the DirectFB library.
.PD 0
.RSs
.IPs (no)input
Use the DirectFB instead of the MPlayer keyboard code (default: enabled).
.IPs buffermode=single|double|triple
Double and triple buffering give best results if you want to avoid tearing issues.
Triple buffering is more efficient than double buffering as it does
not block MPlayer while waiting for the vertical retrace.
Single buffering should be avoided (default: single).
.IPs fieldparity=top|bottom
Control the output order for interlaced frames (default: disabled).
Valid values are top = top fields first, bottom = bottom fields first.
This option does not have any effect on progressive film material
like most MPEG movies are.
You need to enable this option if you have tearing issues or unsmooth
motions watching interlaced film material.
.IPs layer=N
Will force layer with ID N for playback (default: \-1 \- auto).
.IPs dfbopts=<list>
Specify a parameter list for DirectFB.
.RE
.PD 1
.
.TP
.B "dfbmga\ "
Matrox G400/\:G450/\:G550 specific video output driver that uses the
DirectFB library to make use of special hardware features.
Enables CRTC2 (second head), displaying video independently of the first head.
.PD 0
.RSs
.IPs (no)input
same as directfb (default: disabled)
.IPs buffermode=single|double|triple
same as directfb (default: triple)
.IPs fieldparity=top|bottom
same as directfb
.IPs (no)bes
Enable the use of the Matrox BES (backend scaler) (default: disabled).
Gives very good results concerning speed and output quality as interpolated
picture processing is done in hardware.
Works only on the primary head.
.IPs (no)spic
Make use of the Matrox sub picture layer to display the OSD (default: enabled).
.IPs (no)crtc2
Turn on TV-out on the second head (default: enabled).
The output quality is amazing as it is a full interlaced picture
with proper sync to every odd/\:even field.
.IPs tvnorm=pal|ntsc|auto
Will set the TV norm of the Matrox card without the need
for modifying /etc/\:directfbrc (default: disabled).
Valid norms are pal = PAL, ntsc = NTSC.
Special norm is auto (auto-adjust using PAL/\:NTSC) because it decides
which norm to use by looking at the framerate of the movie.
.RE
.PD 1
.
.TP
.B mga (Linux only)
Matrox specific video output driver that makes use of the YUV back
end scaler on Gxxx cards through a kernel module.
If you have a Matrox card, this is the fastest option.
.PD 0
.RSs
.IPs <device>
Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
.RE
.PD 1
.
.TP
.B xmga (Linux, X11 only)
The mga video output driver, running in an X11 window.
.PD 0
.RSs
.IPs <device>
Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
.RE
.PD 1
.
.TP
.B s3fb (Linux only) (also see \-vf yuv2 and \-dr)
S3 Virge specific video output driver.
This driver supports the card's YUV conversion and scaling, double
buffering and direct rendering features.
Use \-vf yuy2 to get hardware-accelerated YUY2 rendering, which is
much faster than YV12 on this card.
.PD 0
.RSs
.IPs <device>
Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
.RE
.PD 1
.
.TP
.B wii (Linux only)
Nintendo Wii/GameCube specific video output driver.
.
.TP
.B 3dfx (Linux only)
3dfx-specific video output driver that directly uses
the hardware on top of X11.
Only 16 bpp are supported.
.
.TP
.B tdfxfb (Linux only)
This driver employs the tdfxfb framebuffer driver to play movies with
YUV acceleration on 3dfx cards.
.PD 0
.RSs
.IPs <device>
Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
.RE
.PD 1
.
.TP
.B tdfx_vid (Linux only)
3dfx-specific video output driver that works in combination with
the tdfx_vid kernel module.
.PD 0
.RSs
.IPs <device>
Explicitly choose the device name to use (default: /dev/\:tdfx_vid).
.RE
.PD 1
.
.TP
.B dxr2 (also see \-dxr2) (DXR2 only)
Creative DXR2 specific video output driver.
.PD 0
.RSs
.IPs <vo_driver>
Output video subdriver to use as overlay (x11, xv).
.RE
.PD 1
.
.TP
.B dxr3 (DXR3 only)
Sigma Designs em8300 MPEG decoder chip (Creative DXR3, Sigma Designs
Hollywood Plus) specific video output driver.
Also see the lavc video filter.
.PD 0
.RSs
.IPs overlay
Activates the overlay instead of TV-out.
.IPs prebuf
Turns on prebuffering.
.IPs "sync\ "
Will turn on the new sync-engine.
.IPs norm=<norm>
Specifies the TV norm.
.RSss
0: Does not change current norm (default).
.br
1: Auto-adjust using PAL/\:NTSC.
.br
2: Auto-adjust using PAL/\:PAL-60.
.br
3: PAL
.br
4: PAL-60
.br
5: NTSC
.RE
.IPs <0\-3>
Specifies the device number to use if you have more than one em8300 card.
.RE
.PD 1
.
.TP
.B ivtv (IVTV only)
Conexant CX23415 (iCompression iTVC15) or Conexant CX23416 (iCompression
iTVC16) MPEG decoder chip (Hauppauge WinTV PVR-150/250/350/500)
specific video output driver for TV-out.
Also see the lavc video filter.
.PD 0
.RSs
.IPs <device>
Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
.IPs <output>
Explicitly choose the TV-out output to be used for the video signal.
.RE
.PD 1
.
.TP
.B v4l2 (requires Linux 2.6.22+ kernel)
Video output driver for V4L2 compliant cards with built-in hardware MPEG decoder.
Also see the lavc video filter.
.PD 0
.RSs
.IPs <device>
Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
.IPs <output>
Explicitly choose the TV-out output to be used for the video signal.
.RE
.PD 1
.
.TP
.B mpegpes (DVB only)
Video output driver for DVB cards that writes the output to an MPEG-PES file
if no DVB card is installed.
.PD 0
.RSs
.IPs card=<1\-4>
Specifies the device number to use if you have more than one DVB output card
(V3 API only, such as 1.x.y series drivers).
If not specified MPlayer will search the first usable card.
.IPs <filename>
output filename (default: ./grab.mpg)
.RE
.PD 1
.
.TP
.B zr (also see \-zr* and \-zrhelp)
Video output driver for a number of MJPEG capture/\:playback cards.
.
.TP
.B zr2 (also see the zrmjpeg video filter)
Video output driver for a number of MJPEG capture/\:playback cards,
second generation.
.PD 0
.RSs
.IPs dev=<device>
Specifies the video device to use.
.IPs norm=<PAL|NTSC|SECAM|auto>
Specifies the video norm to use (default: auto).
.IPs (no)prebuf
(De)Activate prebuffering, not yet supported.
.RE
.PD 1
.
.TP
.B "md5sum\ "
Calculate MD5 sums of each frame and write them to a file.
Supports RGB24 and YV12 colorspaces.
Useful for debugging.
.PD 0
.RSs
.IPs outfile=<value>
Specify the output filename (default: ./md5sums).
.RE
.PD 1
.
.TP
.B yuv4mpeg
Transforms the video stream into a sequence of uncompressed YUV 4:2:0
images and stores it in a file (default: ./stream.yuv).
The format is the same as the one employed by mjpegtools, so this is
useful if you want to process the video with the mjpegtools suite.
It supports the YV12, RGB (24 bpp) and BGR (24 bpp) format.
You can combine it with the \-fixed\-vo option to concatenate files
with the same dimensions and fps value.
.PD 0
.RSs
.IPs interlaced
Write the output as interlaced frames, top field first.
.IPs interlaced_bf
Write the output as interlaced frames, bottom field first.
.IPs file=<filename>
Write the output to <filename> instead of the default stream.yuv.
.REss
.PD 1
.RS
.sp 1
.I NOTE:
If you do not specify any option the output is progressive
(i.e.\& not interlaced).
.RE
.
.TP
.B "gif89a\ "
Output each frame into a single animated GIF file in the current directory.
It supports only RGB format with 24 bpp and the output is converted to 256
colors.
.PD 0
.RSs
.IPs <fps>
Float value to specify framerate (default: 5.0).
.IPs <output>
Specify the output filename (default: ./out.gif).
.REss
.PD 1
.RS
.sp 1
.I NOTE:
You must specify the framerate before the filename or the framerate will
be part of the filename.
.sp 1
.I EXAMPLE:
.RE
.PD 0
.RSs
mplayer video.nut \-vo gif89a:fps=15:output=test.gif
.RE
.PD 1
.
.TP
.B "jpeg\ \ \ "
Output each frame into a JPEG file in the current directory.
Each file takes the frame number padded with leading zeros as name.
.PD 0
.RSs
.IPs [no]progressive
Specify standard or progressive JPEG (default: noprogressive).
.IPs [no]baseline
Specify use of baseline or not (default: baseline).
.IPs optimize=<0\-100>
optimization factor (default: 100)
.IPs smooth=<0\-100>
smooth factor (default: 0)
.IPs quality=<0\-100>
quality factor (default: 75)
.IPs outdir=<dirname>
Specify the directory to save the JPEG files to (default: ./).
.IPs subdirs=<prefix>
Create numbered subdirectories with the specified prefix to
save the files in instead of the current directory.
.IPs "maxfiles=<value> (subdirs only)"
Maximum number of files to be saved per subdirectory.
Must be equal to or larger than 1 (default: 1000).
.RE
.PD 1
.
.TP
.B "pnm\ \ \ \ "
Output each frame into a PNM file in the current directory.
Each file takes the frame number padded with leading zeros as name.
It supports PPM, PGM and PGMYUV files in both raw and ASCII mode.
Also see pnm(5), ppm(5) and pgm(5).
.PD 0
.RSs
.IPs "ppm\ \ "
Write PPM files (default).
.IPs "pgm\ \ "
Write PGM files.
.IPs pgmyuv
Write PGMYUV files.
PGMYUV is like PGM, but it also contains the U and V plane, appended at the
bottom of the picture.
.IPs "raw\ \ "
Write PNM files in raw mode (default).
.IPs ascii
Write PNM files in ASCII mode.
.IPs outdir=<dirname>
Specify the directory to save the PNM files to (default: ./).
.IPs subdirs=<prefix>
Create numbered subdirectories with the specified prefix to
save the files in instead of the current directory.
.IPs "maxfiles=<value> (subdirs only)"
Maximum number of files to be saved per subdirectory.
Must be equal to or larger than 1 (default: 1000).
.RE
.PD 1
.
.TP
.B "png\ \ \ \ "
Output each frame into a PNG file in the current directory.
Each file takes the frame number padded with leading zeros as name.
24bpp RGB and BGR formats are supported.
.PD 0
.RSs
.IPs z=<0\-9>
Specifies the compression level.
0 is no compression, 9 is maximum compression.
.IPs outdir=<dirname>
Specify the directory to save the PNG files to (default: ./).
.IPs alpha (default: noalpha)
Create PNG files with an alpha channel.
Note that MPlayer in general does not support alpha, so this will only
be useful in some rare cases.
.RE
.PD 1
.
.TP
.B "tga\ \ \ \ "
Output each frame into a Targa file in the current directory.
Each file takes the frame number padded with leading zeros as name.
The purpose of this video output driver is to have a simple lossless
image writer to use without any external library.
It supports the BGR[A] color format, with 15, 24 and 32 bpp.
You can force a particular format with the format video filter.
.sp 1
.I EXAMPLE:
.RE
.PD 0
.RSs
mplayer video.nut \-vf format=bgr15 \-vo tga
.RE
.PD 1
.
.
.
.SH "DECODING/FILTERING OPTIONS"
.
.TP
.B \-ac <[\-|+]codec1,[\-|+]codec2,...[,]>
Specify a priority list of audio codecs to be used, according to their codec
name in codecs.conf.
Use a '\-' before the codec name to omit it.
Use a '+' before the codec name to force it, this will likely crash!
If the list has a trailing ',' MPlayer will fall back on codecs not
contained in the list.
.br
.I NOTE:
See \-ac help for a full list of available codecs.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-ac mp3acm"
Force the l3codeca.acm MP3 codec.
.IPs "\-ac mad,"
Try libmad first, then fall back on others.
.IPs "\-ac hwac3,a52,"
Try hardware AC-3 passthrough, software AC-3, then others.
.IPs "\-ac hwdts,"
Try hardware DTS passthrough, then fall back on others.
.IPs "\-ac \-ffmp3,"
Skip FFmpeg's MP3 decoder.
.RE
.PD 1
.
.TP
.B \-af\-adv <force=(0\-7):list=(filters)> (also see \-af)
Specify advanced audio filter options:
.RSs
.IPs force=<0\-7>
Forces the insertion of audio filters to one of the following:
.RSss
0: Use completely automatic filter insertion.
.br
1: Optimize for accuracy (default).
.br
2: Optimize for speed.
.I Warning:
Some features in the audio filters may silently fail,
and the sound quality may drop.
.br
3: Use no automatic insertion of filters and no optimization.
.I Warning:
It may be possible to crash MPlayer using this setting.
.br
4: Use automatic insertion of filters according to 0 above,
but use floating point processing when possible.
.br
5: Use automatic insertion of filters according to 1 above,
but use floating point processing when possible.
.br
6: Use automatic insertion of filters according to 2 above,
but use floating point processing when possible.
.br
7: Use no automatic insertion of filters according to 3 above,
and use floating point processing when possible.
.REss
.IPs list=<filters>
Same as \-af.
.RE
.
.TP
.B \-afm <driver1,driver2,...>
Specify a priority list of audio codec families to be used, according
to their codec name in codecs.conf.
Falls back on the default codecs if none of the given codec families work.
.br
.I NOTE:
See \-afm help for a full list of available codec families.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-afm ffmpeg"
Try FFmpeg's libavcodec codecs first.
.IPs "\-afm acm,dshow"
Try Win32 codecs first.
.RE
.PD 1
.
.TP
.B \-aspect <ratio> (also see \-zoom)
Override movie aspect ratio, in case aspect information is
incorrect or missing in the file being played.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-aspect 4:3  or \-aspect 1.3333
.br
\-aspect 16:9 or \-aspect 1.7777
.RE
.PD 1
.
.TP
.B \-noaspect
Disable automatic movie aspect ratio compensation.
.
.TP
.B "\-field\-dominance <\-1\-1>"
Set first field for interlaced content.
Useful for deinterlacers that double the framerate: \-vf tfields=1,
\-vf yadif=1, \-vo vdpau:deint and \-vo xvmc:bobdeint.
.PD 0
.RSs
.IPs \-1
auto (default): If the decoder does not export the appropriate information,
it falls back to 0 (top field first).
.IPs 0
top field first
.IPs 1
bottom field first
.RE
.PD 1
.
.TP
.B "\-flip \ "
Flip image upside-down.
.
.TP
.B \-lavdopts <option1:option2:...> (DEBUG CODE)
Specify libavcodec decoding parameters.
Separate multiple options with a colon.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-lavdopts gray:skiploopfilter=all:skipframe=nonref
.RE
.PD 1
.sp 1
.RS
Available options are:
.RE
.RSs
.IPs bitexact
Only use bit-exact algorithms in all decoding steps (for codec testing).
.IPs bug=<value>
Manually work around encoder bugs.
.RSss
0: nothing
.br
1: autodetect bugs (default)
.br
2 (msmpeg4v3): some old lavc generated msmpeg4v3 files (no autodetection)
.br
4 (mpeg4): Xvid interlacing bug (autodetected if fourcc==XVIX)
.br
8 (mpeg4): UMP4 (autodetected if fourcc==UMP4)
.br
16 (mpeg4): padding bug (autodetected)
.br
32 (mpeg4): illegal vlc bug (autodetected per fourcc)
.br
64 (mpeg4): Xvid and DivX qpel bug (autodetected per fourcc/\:version)
.br
128 (mpeg4): old standard qpel (autodetected per fourcc/\:version)
.br
256 (mpeg4): another qpel bug (autodetected per fourcc/\:version)
.br
512 (mpeg4): direct-qpel-blocksize bug (autodetected per fourcc/\:version)
.br
1024 (mpeg4): edge padding bug (autodetected per fourcc/\:version)
.REss
.IPs debug=<value>
Display debugging information.
.RSss
.br
0: disabled
.br
1: picture info
.br
2: rate control
.br
4: bitstream
.br
8: macroblock (MB) type
.br
16: per-block quantization parameter (QP)
.br
32: motion vector
.br
0x0040: motion vector visualization (use \-noslices)
.br
0x0080: macroblock (MB) skip
.br
0x0100: startcode
.br
0x0200: PTS
.br
0x0400: error resilience
.br
0x0800: memory management control operations (H.264)
.br
0x1000: bugs
.br
0x2000: Visualize quantization parameter (QP), lower QP are tinted greener.
.br
0x4000: Visualize block types.
.REss
.IPs ec=<value>
Set error concealment strategy.
.RSss
1: Use strong deblock filter for damaged MBs.
.br
2: iterative motion vector (MV) search (slow)
.br
3: all (default)
.REss
.IPs er=<value>
Set error resilience strategy.
.RSss
.br
0: disabled
.br
1: careful (Should work with broken encoders.)
.br
2: normal (default) (Works with compliant encoders.)
.br
3: aggressive (More checks, but might cause problems even for valid bitstreams.)
.br
4: very aggressive
.REss
.IPs "fast (MPEG-2, MPEG-4, and H.264 only)"
Enable optimizations which do not comply to the specification and might
potentially cause problems, like simpler dequantization, simpler motion
compensation, assuming use of the default quantization matrix, assuming
YUV 4:2:0 and skipping a few checks to detect damaged bitstreams.
.IPs "gray\ "
grayscale only decoding (a bit faster than with color)
.IPs "idct=<0\-99> (see \-lavcopts)"
For best decoding quality use the same IDCT algorithm for decoding and encoding.
This may come at a price in accuracy, though.
.IPs lowres=<number>[,<w>]
Decode at lower resolutions.
Low resolution decoding is not supported by all codecs, and it will
often result in ugly artifacts.
This is not a bug, but a side effect of not decoding at full resolution.
.RSss
.br
0: disabled
.br
1: 1/2 resolution
.br
2: 1/4 resolution
.br
3: 1/8 resolution
.REss
.RS
If <w> is specified lowres decoding will be used only if the width of the
video is major than or equal to <w>.
.RE
.B o=<key>=<value>[,<key>=<value>[,...]]
Pass AVOptions to libavcodec decoder.
Note, a patch to make the o= unneeded and pass all unknown options through
the AVOption system is welcome.
A full list of AVOptions can be found in the FFmpeg manual.
Note that some options may conflict with MEncoder options.
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.PD 0
.IPs o=debug=pict
.PD 1
.RE
.IPs "sb=<number> (MPEG-2 only)"
Skip the given number of macroblock rows at the bottom.
.IPs "st=<number> (MPEG-2 only)"
Skip the given number of macroblock rows at the top.
.IPs "skiploopfilter=<skipvalue> (H.264 only)"
Skips the loop filter (AKA deblocking) during H.264 decoding.
Since the filtered frame is supposed to be used as reference
for decoding dependent frames this has a worse effect on quality
than not doing deblocking on e.g.\& MPEG-2 video.
But at least for high bitrate HDTV this provides a big speedup with
no visible quality loss.
.sp 1
<skipvalue> can be either one of the following:
.RSss
.br
none: Never skip.
.br
default: Skip useless processing steps (e.g.\& 0 size packets in AVI).
.br
nonref: Skip frames that are not referenced (i.e.\& not used for
decoding other frames, the error cannot "build up").
.br
bidir: Skip B-Frames.
.br
nonkey: Skip all frames except keyframes.
.br
all: Skip all frames.
.REss
.IPs "skipidct=<skipvalue> (MPEG-1/2 only)"
Skips the IDCT step.
This degrades quality a lot of in almost all cases
(see skiploopfilter for available skip values).
.IPs skipframe=<skipvalue>
Skips decoding of frames completely.
Big speedup, but jerky motion and sometimes bad artifacts
(see skiploopfilter for available skip values).
.IPs "threads=<1\-8> (MPEG-1/2 and H.264 only)"
number of threads to use for decoding (default: 1)
.IPs vismv=<value>
Visualize motion vectors.
.RSss
.br
0: disabled
.br
1: Visualize forward predicted MVs of P-frames.
.br
2: Visualize forward predicted MVs of B-frames.
.br
4: Visualize backward predicted MVs of B-frames.
.REss
.IPs vstats
Prints some statistics and stores them in ./vstats_*.log.
.RE
.
.TP
.B \-noslices
Disable drawing video by 16-pixel height slices/\:bands, instead draws the
whole frame in a single run.
May be faster or slower, depending on video card and available cache.
It has effect only with libmpeg2 and libavcodec codecs.
.
.TP
.B \-nosound
Do not play/\:encode sound.
Useful for benchmarking.
.
.TP
.B \-novideo
Do not play/\:encode video.
In many cases this will not work, use \-vc null \-vo null instead.
.
.TP
.B \-pp <quality> (also see \-vf pp)
Set the DLL postprocess level.
This option is no longer usable with \-vf pp.
It only works with Win32 DirectShow DLLs with internal postprocessing routines.
The valid range of \-pp values varies by codec, it is mostly
0\-6, where 0=disable, 6=slowest/\:best.
.
.TP
.B \-pphelp (also see \-vf pp)
Show a summary about the available postprocess filters and their usage.
.
.TP
.B \-ssf <mode>
Specifies software scaler parameters.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
\-vf scale \-ssf lgb=3.0
.RE
.PD 1
.PD 0
.RSs
.IPs lgb=<0\-100>
gaussian blur filter (luma)
.IPs cgb=<0\-100>
gaussian blur filter (chroma)
.IPs ls=<\-100\-100>
sharpen filter (luma)
.IPs cs=<\-100\-100>
sharpen filter (chroma)
.IPs chs=<h>
chroma horizontal shifting
.IPs cvs=<v>
chroma vertical shifting
.RE
.PD 1
.
.TP
.B \-stereo <mode>
Select type of MP2/\:MP3 stereo output.
.PD 0
.RSs
.IPs 0
stereo
.IPs 1
left channel
.IPs 2
right channel
.RE
.PD 1
.
.TP
.B \-sws <software scaler type> (also see \-vf scale and \-zoom)
Specify the software scaler algorithm to be used with the \-zoom option.
This affects video output drivers which lack hardware acceleration, e.g.\& x11.
.sp 1
Available types are:
.sp 1
.PD 0
.RSs
.IPs 0
fast bilinear
.IPs 1
bilinear
.IPs 2
bicubic (good quality) (default)
.IPs 3
experimental
.IPs 4
nearest neighbor (bad quality)
.IPs 5
area
.IPs 6
luma bicubic / chroma bilinear
.IPs 7
gauss
.IPs 8
sincR
.IPs 9
lanczos
.IPs 10
natural bicubic spline
.RE
.PD 1
.sp 1
.RS
.I NOTE:
Some \-sws options are tunable.
The description of the scale video filter has further information.
.RE
.
.TP
.B \-vc <[\-|+]codec1,[\-|+]codec2,...[,]>
Specify a priority list of video codecs to be used, according to their codec
name in codecs.conf.
Use a '\-' before the codec name to omit it.
Use a '+' before the codec name to force it, this will likely crash!
If the list has a trailing ',' MPlayer will fall back on codecs not
contained in the list.
.br
.I NOTE:
See \-vc help for a full list of available codecs.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-vc divx"
Force Win32/\:VfW DivX codec, no fallback.
.IPs "\-vc \-divxds,\-divx,"
Skip Win32 DivX codecs.
.IPs "\-vc ffmpeg12,mpeg12,"
Try libavcodec's MPEG-1/2 codec, then libmpeg2, then others.
.RE
.PD 1
.
.TP
.B \-vfm <driver1,driver2,...>
Specify a priority list of video codec families to be used, according
to their names in codecs.conf.
Falls back on the default codecs if none of the given codec families work.
.br
.I NOTE:
See \-vfm help for a full list of available codec families.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-vfm ffmpeg,dshow,vfw"
Try the libavcodec, then Directshow, then VfW codecs and fall back
on others, if they do not work.
.IPs "\-vfm xanim"
Try XAnim codecs first.
.RE
.PD 1
.
.TP
.B \-x <x> (also see \-zoom) (MPlayer only)
Scale image to width <x> (if software/\:hardware scaling is available).
Disables aspect calculations.
.
.TP
.B \-xvidopts <option1:option2:...>
Specify additional parameters when decoding with Xvid.
.br
.I NOTE:
Since libavcodec is faster than Xvid you might want to use the libavcodec
postprocessing filter (\-vf pp) and decoder (\-vfm ffmpeg) instead.
.sp 1
Xvid's internal postprocessing filters:
.PD 0
.RSs
.IPs "deblock-chroma (also see \-vf pp)"
chroma deblock filter
.IPs "deblock-luma (also see \-vf pp)"
luma deblock filter
.IPs "dering-luma (also see \-vf pp)"
luma deringing filter
.IPs "dering-chroma (also see \-vf pp)"
chroma deringing filter
.IPs "filmeffect (also see \-vf noise)"
Adds artificial film grain to the video.
May increase perceived quality, while lowering true quality.
.RE
.sp 1
.RS
rendering methods:
.RE
.PD 0
.RSs
.IPs "dr2\ \ "
Activate direct rendering method 2.
.IPs nodr2
Deactivate direct rendering method 2.
.RE
.PD 1
.
.TP
.B \-xy <value> (also see \-zoom)
.PD 0
.RSs
.IPs value<=8
Scale image by factor <value>.
.IPs value>8
Set width to value and calculate height to keep correct aspect ratio.
.RE
.PD 1
.
.TP
.B \-y <y> (also see \-zoom) (MPlayer only)
Scale image to height <y> (if software/\:hardware scaling is available).
Disables aspect calculations.
.
.TP
.B "\-zoom\ \ "
Allow software scaling, where available.
This will allow scaling with output drivers (like x11, fbdev) that
do not support hardware scaling where MPlayer disables scaling by
default for performance reasons.
.
.
.
.SH "AUDIO FILTERS"
Audio filters allow you to modify the audio stream and its properties.
The syntax is:
.
.TP
.B \-af <filter1[=parameter1:parameter2:...],filter2,...>
Setup a chain of audio filters.
.PP
.I NOTE:
To get a full list of available audio filters, see \-af help.
.sp 1
Audio filters are managed in lists.
There are a few commands to manage the filter list.
.
.TP
.B \-af\-add <filter1[,filter2,...]>
Appends the filters given as arguments to the filter list.
.
.TP
.B \-af\-pre <filter1[,filter2,...]>
Prepends the filters given as arguments to the filter list.
.
.TP
.B \-af\-del <index1[,index2,...]>
Deletes the filters at the given indexes.
Index numbers start at 0, negative numbers address the end of the
list (\-1 is the last).
.
.TP
.B \-af\-clr
Completely empties the filter list.
.PP
Available filters are:
.
.TP
.B resample[=srate[:sloppy[:type]]]
Changes the sample rate of the audio stream.
Can be used if you have a fixed frequency sound card or if you are
stuck with an old sound card that is only capable of max 44.1kHz.
This filter is automatically enabled if necessary.
It only supports 16-bit integer and float in native-endian format as input.
.br
.I NOTE:
With MEncoder, you need to also use \-srate <srate>.
.PD 0
.RSs
.IPs <srate>
output sample frequency in Hz.
The valid range for this parameter is 8000 to 192000.
If the input and output sample frequency are the same or if this
parameter is omitted the filter is automatically unloaded.
A high sample frequency normally improves the audio quality,
especially when used in combination with other filters.
.IPs <sloppy>
Allow (1) or disallow (0) the output frequency to differ slightly
from the frequency given by <srate> (default: 1).
Can be used if the startup of the playback is extremely slow.
.IPs <type>
Selects which resampling method to use.
.RSss
0: linear interpolation (fast, poor quality especially when upsampling)
.br
1: polyphase filterbank and integer processing
.br
2: polyphase filterbank and floating point processing (slow, best quality)
.REss
.PD 1
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs "mplayer \-af resample=44100:0:0"
would set the output frequency of the resample filter to 44100Hz using
exact output frequency scaling and linear interpolation.
.RE
.PD 1
.
.TP
.B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
Changes the sample rate of the audio stream to an integer <srate> in Hz.
It only supports the 16-bit native-endian format.
.br
.I NOTE:
With MEncoder, you need to also use \-srate <srate>.
.PD 0
.RSs
.IPs <srate>
the output sample rate
.IPs <length>
length of the filter with respect to the lower sampling rate (default: 16)
.IPs <linear>
if 1 then filters will be linearly interpolated between polyphase entries
.IPs <count>
log2 of the number of polyphase entries
(..., 10->1024, 11->2048, 12->4096, ...)
(default: 10->1024)
.IPs <cutoff>
cutoff frequency (0.0\-1.0), default set depending upon filter length
.RE
.PD 1
.
.TP
.B lavcac3enc[=tospdif[:bitrate[:minchn]]]
Encode multi-channel audio to AC-3 at runtime using libavcodec.
Supports 16-bit native-endian input format, maximum 6 channels.
The output is big-endian when outputting a raw AC-3 stream,
native-endian when outputting to S/PDIF.
The output sample rate of this filter is same with the input sample rate.
When input sample rate is 48kHz, 44.1kHz, or 32kHz, this filter directly use it.
Otherwise a resampling filter is auto-inserted before this filter to make
the input and output sample rate be 48kHz.
You need to specify '\-channels N' to make the decoder decode audio into
N-channel, then the filter can encode the N-channel input to AC-3.
.br
.PD 0
.RSs
.IPs <tospdif>
Output raw AC-3 stream if zero or not set,
output to S/PDIF for passthrough when <tospdif> is set non-zero.
.IPs <bitrate>
The bitrate to encode the AC-3 stream.
Set it to either 384 or 384000 to get 384kbits.
Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256,
              320, 384, 448, 512, 576, 640
Default bitrate is based on the input channel number:
1ch: 96,  2ch: 192,  3ch: 224,  4ch: 384,  5ch: 448,  6ch: 448
.IPs <minchn>
If the input channel number is less than <minchn>, the filter will
detach itself (default: 5).
.RE
.PD 1
.
.TP
.B sweep[=speed]
Produces a sine sweep.
.PD 0
.RSs
.IPs <0.0\-1.0>
Sine function delta, use very low values to hear the sweep.
.RE
.PD 1
.
.TP
.B sinesuppress[=freq:decay]
Remove a sine at the specified frequency.
Useful to get rid of the 50/60Hz noise on low quality audio equipment.
It probably only works on mono input.
.PD 0
.RSs
.IPs <freq>
The frequency of the sine which should be removed (in Hz) (default: 50)
.IPs <decay>
Controls the adaptivity (a larger value will make the filter adapt to
amplitude and phase changes quicker, a smaller value will make the
adaptation slower) (default: 0.0001).
Reasonable values are around 0.001.
.RE
.PD 1
.
.TP
.B hrtf[=flag]
Head-related transfer function: Converts multichannel audio to
2 channel output for headphones, preserving the spatiality of the sound.
.sp 1
.PD 0
.RS
.IPs "Flag  Meaning"
.IPs "m     matrix decoding of the rear channel"
.IPs "s     2-channel matrix decoding"
.IPs "0     no matrix decoding (default)"
.RE
.PD 1
.
.TP
.B equalizer=[g1:g2:g3:...:g10]
10 octave band graphic equalizer, implemented using 10 IIR band pass filters.
This means that it works regardless of what type of audio is being played back.
The center frequencies for the 10 bands are:
.sp 1
.PD 0
.RS
.IPs "No. frequency"
.IPs "0    31.25 Hz"
.IPs "1    62.50 Hz"
.IPs "2   125.00 Hz"
.IPs "3   250.00 Hz"
.IPs "4   500.00 Hz"
.IPs "5    1.00 kHz"
.IPs "6    2.00 kHz"
.IPs "7    4.00 kHz"
.IPs "8    8.00 kHz"
.IPs "9   16.00 kHz"
.RE
.PD 1
.sp 1
.RS
If the sample rate of the sound being played is lower than the center
frequency for a frequency band, then that band will be disabled.
A known bug with this filter is that the characteristics for the
uppermost band are not completely symmetric if the sample
rate is close to the center frequency of that band.
This problem can be worked around by upsampling the sound
using the resample filter before it reaches this filter.
.RE
.PD 0
.RSs
.IPs <g1>:<g2>:<g3>:...:<g10>
floating point numbers representing the gain in dB
for each frequency band (\-12\-12)
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af equalizer=11:11:10:5:0:\-12:0:5:12:12 media.avi"
Would amplify the sound in the upper and lower frequency region
while canceling it almost completely around 1kHz.
.RE
.PD 1
.
.TP
.B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...]
Can be used for adding, removing, routing and copying audio channels.
If only <nch> is given the default routing is used, it works as
follows: If the number of output channels is bigger than the number of
input channels empty channels are inserted (except mixing from mono to
stereo, then the mono channel is repeated in both of the output
channels).
If the number of output channels is smaller than the number
of input channels the exceeding channels are truncated.
.PD 0
.RSs
.IPs <nch>
number of output channels (1\-6)
.IPs "<nr>\ "
number of routes (1\-6)
.IPs <from1:to1:from2:to2:from3:to3:...>
Pairs of numbers between 0 and 5 that define where to route each channel.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af channels=4:4:0:1:1:0:2:2:3:3 media.avi"
Would change the number of channels to 4 and set up 4 routes that
swap channel 0 and channel 1 and leave channel 2 and 3 intact.
Observe that if media containing two channels was played back, channels
2 and 3 would contain silence but 0 and 1 would still be swapped.
.IPs "mplayer \-af channels=6:4:0:0:0:1:0:2:0:3 media.avi"
Would change the number of channels to 6 and set up 4 routes
that copy channel 0 to channels 0 to 3.
Channel 4 and 5 will contain silence.
.RE
.PD 1
.
.TP
.B format[=format] (also see \-format)
Convert between different sample formats.
Automatically enabled when needed by the sound card or another filter.
.PD 0
.RSs
.IPs <format>
Sets the desired format.
The general form is 'sbe', where 's' denotes the sign (either 's' for signed
or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32)
and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian
and 'ne' the endianness of the computer MPlayer is running on).
Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'.
Exceptions to this rule that are also valid format specifiers: u8, s8,
floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm.
.RE
.PD 1
.
.TP
.B volume[=v[:sc]]
Implements software volume control.
Use this filter with caution since it can reduce the signal
to noise ratio of the sound.
In most cases it is best to set the level for the PCM sound to max,
leave this filter out and control the output level to your
speakers with the master volume control of the mixer.
In case your sound card has a digital PCM mixer instead of an analog
one, and you hear distortion, use the MASTER mixer instead.
If there is an external amplifier connected to the computer (this
is almost always the case), the noise level can be minimized by
adjusting the master level and the volume knob on the amplifier
until the hissing noise in the background is gone.
.br
This filter has a second feature: It measures the overall maximum
sound level and prints out that level when MPlayer exits.
This volume estimate can be used for setting the sound level in
MEncoder such that the maximum dynamic range is utilized.
.br
.I NOTE:
This filter is not reentrant and can therefore only be enabled
once for every audio stream.
.PD 0
.RSs
.IPs "<v>\ \ "
Sets the desired gain in dB for all channels in the stream
from \-200dB to +60dB, where \-200dB mutes the sound
completely and +60dB equals a gain of 1000 (default: 0).
.IPs "<sc>\ "
Turns soft clipping on (1) or off (0).
Soft-clipping can make the sound more smooth if very
high volume levels are used.
Enable this option if the dynamic range of the
loudspeakers is very low.
.br
.I WARNING:
This feature creates distortion and should be considered a last resort.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af volume=10.1:0 media.avi"
Would amplify the sound by 10.1dB and hard-clip if the
sound level is too high.
.RE
.PD 1
.
.TP
.B pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...]
Mixes channels arbitrarily.
Basically a combination of the volume and the channels filter
that can be used to down-mix many channels to only a few,
e.g.\& stereo to mono or vary the "width" of the center
speaker in a surround sound system.
This filter is hard to use, and will require some tinkering
before the desired result is obtained.
The number of options for this filter depends on
the number of output channels.
An example how to downmix a six-channel file to two channels with
this filter can be found in the examples section near the end.
.PD 0
.RSs
.IPs "<n>\ \ "
number of output channels (1\-6)
.IPs <Lij>
How much of input channel i is mixed into output channel j (0\-1).
So in principle you first have n numbers saying what to do with the
first input channel, then n numbers that act on the second input channel
etc.
If you do not specify any numbers for some input channels, 0 is assumed.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af pan=1:0.5:0.5 media.avi"
Would down-mix from stereo to mono.
.IPs "mplayer \-af pan=3:1:0:0.5:0:1:0.5 media.avi"
Would give 3 channel output leaving channels 0 and 1 intact,
and mix channels 0 and 1 into output channel 2 (which could
be sent to a subwoofer for example).
.RE
.PD 1
.
.TP
.B sub[=fc:ch]
Adds a subwoofer channel to the audio stream.
The audio data used for creating the subwoofer channel is
an average of the sound in channel 0 and channel 1.
The resulting sound is then low-pass filtered by a 4th order
Butterworth filter with a default cutoff frequency of 60Hz
and added to a separate channel in the audio stream.
.br
.I Warning:
Disable this filter when you are playing DVDs with Dolby
Digital 5.1 sound, otherwise this filter will disrupt
the sound to the subwoofer.
.PD 0
.RSs
.IPs "<fc>\ "
cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz)
For the best result try setting the cutoff frequency as low as possible.
This will improve the stereo or surround sound experience.
.IPs "<ch>\ "
Determines the channel number in which to insert the sub-channel audio.
Channel number can be between 0 and 5 (default: 5).
Observe that the number of channels will automatically
be increased to <ch> if necessary.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af sub=100:4 \-channels 5 media.avi"
Would add a sub-woofer channel with a cutoff frequency of
100Hz to output channel 4.
.RE
.PD 1
.
.TP
.B "center\ "
Creates a center channel from the front channels.
May currently be low quality as it does not implement a
high-pass filter for proper extraction yet, but averages and
halves the channels instead.
.PD 0
.RSs
.IPs "<ch>\ "
Determines the channel number in which to insert the center channel.
Channel number can be between 0 and 5 (default: 5).
Observe that the number of channels will automatically
be increased to <ch> if necessary.
.RE
.PD 1
.
.TP
.B surround[=delay]
Decoder for matrix encoded surround sound like Dolby Surround.
Many files with 2 channel audio actually contain matrixed surround sound.
Requires a sound card supporting at least 4 channels.
.PD 0
.RSs
.IPs <delay>
delay time in ms for the rear speakers (0 to 1000) (default: 20)
This delay should be set as follows: If d1 is the distance
from the listening position to the front speakers and d2 is the distance
from the listening position to the rear speakers, then the delay should
be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af surround=15 \-channels 4 media.avi"
Would add surround sound decoding with 15ms delay for the sound to the
rear speakers.
.RE
.PD 1
.
.TP
.B delay[=ch1:ch2:...]
Delays the sound to the loudspeakers such that the sound from the
different channels arrives at the listening position simultaneously.
It is only useful if you have more than 2 loudspeakers.
.PD 0
.RSs
.IPs ch1,ch2,...
The delay in ms that should be imposed on each channel
(floating point number between 0 and 1000).
.RE
.PD 1
.sp 1
.RS
To calculate the required delay for the different channels do as follows:
.IP 1. 3
Measure the distance to the loudspeakers in meters in relation
to your listening position, giving you the distances s1 to s5
(for a 5.1 system).
There is no point in compensating for the subwoofer (you will not hear the
difference anyway).
.IP 2. 3
Subtract the distances s1 to s5 from the maximum distance,
i.e.\& s[i] = max(s) \- s[i]; i = 1...5.
.IP 3.
Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5.
.RE
.PD 0
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi"
Would delay front left and right by 10.5ms, the two rear channels
and the sub by 0ms and the center channel by 7ms.
.RE
.PD 1
.
.TP
.B export[=mmapped_file[:nsamples]]
Exports the incoming signal to other processes using memory mapping (mmap()).
Memory mapped areas contain a header:
.sp 1
.nf
int nch                      /*number of channels*/
int size                     /*buffer size*/
unsigned long long counter   /*Used to keep sync, updated every
                               time new data is exported.*/
.fi
.sp 1
The rest is payload (non-interleaved) 16 bit data.
.PD 0
.RSs
.IPs <mmapped_file>
file to map data to (default: ~/.mplayer/\:mplayer-af_export)
.IPs <nsamples>
number of samples per channel (default: 512)
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi"
Would export 1024 samples per channel to '/tmp/mplayer-af_export'.
.RE
.PD 1
.
.TP
.B extrastereo[=mul]
(Linearly) increases the difference between left and right channels
which adds some sort of "live" effect to playback.
.PD 0
.RSs
.IPs <mul>
Sets the difference coefficient (default: 2.5).
0.0 means mono sound (average of both channels), with 1.0 sound will be
unchanged, with \-1.0 left and right channels will be swapped.
.RE
.PD 1
.
.TP
.B volnorm[=method:target]
Maximizes the volume without distorting the sound.
.PD 0
.RSs
.IPs <method>
Sets the used method.
.RSss
1: Use a single sample to smooth the variations via the standard
weighted mean over past samples (default).
.br
2: Use several samples to smooth the variations via the standard
weighted mean over past samples.
.REss
.IPs <target>
Sets the target amplitude as a fraction of the maximum for the
sample type (default: 0.25).
.RE
.PD 1
.
.TP
.B ladspa=file:label[:controls...]
Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
This filter is reentrant, so multiple LADSPA plugins can be used at once.
.PD 0
.RSs
.IPs <file>
Specifies the LADSPA plugin library file.
If LADSPA_PATH is set, it searches for the specified file.
If it is not set, you must supply a fully specified pathname.
.IPs <label>
Specifies the filter within the library.
Some libraries contain only one filter, but others contain many of them.
Entering 'help' here, will list all available filters within the specified
library, which eliminates the use of 'listplugins' from the LADSPA SDK.
.IPs <controls>
Controls are zero or more floating point values that determine the
behavior of the loaded plugin (for example delay, threshold or gain).
In verbose mode (add \-v to the MPlayer command line), all available controls
and their valid ranges are printed.
This eliminates the use of 'analyseplugin' from the LADSPA SDK.
.RE
.PD 1
.
.TP
.B "comp\ \ \ "
Compressor/expander filter usable for microphone input.
Prevents artifacts on very loud sound and raises the volume on
very low sound.
This filter is untested, maybe even unusable.
.
.TP
.B "gate\ \ \ "
Noise gate filter similar to the comp audio filter.
This filter is untested, maybe even unusable.
.
.TP
.B karaoke
Simple voice removal filter exploiting the fact that voice is
usually recorded with mono gear and later 'center' mixed onto
the final audio stream.
Beware that this filter will turn your signal into mono.
Works well for 2 channel tracks; do not bother trying it
on anything but 2 channel stereo.
.
.TP
.B scaletempo[=option1:option2:...]
Scales audio tempo without altering pitch, optionally synced to playback
speed (default).
.br
This works by playing \'stride\' ms of audio at normal speed then
consuming \'stride*scale\' ms of input audio.
It pieces the strides together by blending \'overlap\'% of stride with
audio following the previous stride.
It optionally performs a short statistical analysis on the next \'search\'
ms of audio to determine the best overlap position.
.PD 0
.RSs
.IPs scale=<amount>
Nominal amount to scale tempo.
Scales this amount in addition to speed.
(default: 1.0)
.IPs stride=<amount>
Length in milliseconds to output each stride.
Too high of value will cause noticable skips at high scale amounts and
an echo at low scale amounts.
Very low values will alter pitch.
Increasing improves performance.
(default: 60)
.IPs overlap=<percent>
Percentage of stride to overlap.
Decreasing improves performance.
(default: .20)
.IPs search=<amount>
Length in milliseconds to search for best overlap position.
Decreasing improves performance greatly.
On slow systems, you will probably want to set this very low.
(default: 14)
.IPs speed=<tempo|pitch|both|none>
Set response to speed change.
.RSss
.IPs tempo
Scale tempo in sync with speed (default).
.IPs pitch
Reverses effect of filter.
Scales pitch without altering tempo.
Add \'[ speed_mult 0.9438743126816935\' and \'] speed_mult 1.059463094352953\'
to your input.conf to step by musical semi-tones.
.I WARNING:
Loses sync with video.
.IPs both
Scale both tempo and pitch.
.IPs none
Ignore speed changes.
.RE
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.IPs "mplayer \-af scaletempo \-speed 1.2 media.ogg"
Would playback media at 1.2x normal speed, with audio at normal pitch.
Changing playback speed, would change audio tempo to match.
.IPs "mplayer \-af scaletempo=scale=1.2:speed=none \-speed 1.2 media.ogg"
Would playback media at 1.2x normal speed, with audio at normal pitch,
but changing playback speed has no effect on audio tempo.
.IPs "mplayer \-af scaletempo=stride=30:overlap=.50:search=10 media.ogg"
Would tweak the quality and performace parameters.
.IPs "mplayer \-af format=floatne,scaletempo media.ogg"
Would make scaletempo use float code.
Maybe faster on some platforms.
.IPs "mplayer \-af scaletempo=scale=1.2:speed=pitch audio.ogg"
Would playback audio file at 1.2x normal speed, with audio at normal pitch.
Changing playback speed, would change pitch, leaving audio tempo at 1.2x.
.RE
.PD 1
.
.TP
.B "stats\ \ "
Collects and prints statistics about the audio stream, especially the volume.
These statistics are especially intended to help adjusting the volume while
avoiding clipping.
The volumes are printed in dB and compatible with the volume audio filter.
.
.
.
.SH "VIDEO FILTERS"
Video filters allow you to modify the video stream and its properties.
The syntax is:
.
.TP
.B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
Setup a chain of video filters.
.PP
Many parameters are optional and set to default values if omitted.
To explicitly use a default value set a parameter to '\-1'.
Parameters w:h means width x height in pixels, x:y means x;y position counted
from the upper left corner of the bigger image.
.br
.I NOTE:
To get a full list of available video filters, see \-vf help.
.sp 1
Video filters are managed in lists.
There are a few commands to manage the filter list.
.
.TP
.B \-vf\-add <filter1[,filter2,...]>
Appends the filters given as arguments to the filter list.
.
.TP
.B \-vf\-pre <filter1[,filter2,...]>
Prepends the filters given as arguments to the filter list.
.
.TP
.B \-vf\-del <index1[,index2,...]>
Deletes the filters at the given indexes.
Index numbers start at 0, negative numbers address the end of the
list (\-1 is the last).
.
.TP
.B \-vf\-clr
Completely empties the filter list.
.PP
With filters that support it, you can access parameters by their name.
.
.TP
.B \-vf <filter>=help
Prints the parameter names and parameter value ranges for a particular
filter.
.
.TP
.B \-vf <filter=named_parameter1=value1[:named_parameter2=value2:...]>
Sets a named parameter to the given value.
Use on and off or yes and no to set flag parameters.
.PP
Available filters are:
.
.TP
.B crop[=w:h:x:y]
Crops the given part of the image and discards the rest.
Useful to remove black bands from widescreen movies.
.PD 0
.RSs
.IPs <w>,<h>
Cropped width and height, defaults to original width and height.
.IPs <x>,<y>
Position of the cropped picture, defaults to center.
.RE
.PD 1
.
.TP
.B cropdetect[=limit:round]
Calculates necessary cropping parameters and prints the recommended parameters
to stdout.
.PD 0
.RSs
.IPs <limit>
Threshold, which can be optionally specified from nothing (0) to
everything (255) (default: 24).
.br
.IPs <round>
Value which the width/\:height should be divisible by (default: 16).
The offset is automatically adjusted to center the video.
Use 2 to get only even dimensions (needed for 4:2:2 video).
16 is best when encoding to most video codecs.
.RE
.PD 1
.
.TP
.B rectangle[=w:h:x:y]
Draws a rectangle of the requested width and height at the specified
coordinates over the image and prints current rectangle parameters
to the console.
This can be used to find optimal cropping parameters.
If you bind the input.conf directive 'change_rectangle' to keystrokes,
you can move and resize the rectangle on the fly.
.PD 0
.RSs
.IPs <w>,<h>
width and height (default: \-1, maximum possible width where boundaries
are still visible.)
.IPs <x>,<y>
top left corner position (default: \-1, uppermost leftmost)
.RE
.PD 1
.
.TP
.B expand[=w:h:x:y:o:a:r]
Expands (not scales) movie resolution to the given value and places the
unscaled original at coordinates x, y.
Can be used for placing subtitles/\:OSD in the resulting black bands.
.RSs
.IPs <w>,<h>
Expanded width,height (default: original width,height).
Negative values for w and h are treated as offsets to the original size.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IP expand=0:\-50:0:0
Adds a 50 pixel border to the bottom of the picture.
.RE
.PD 1
.IPs <x>,<y>
position of original image on the expanded image (default: center)
.IPs "<o>\ \ "
OSD/\:subtitle rendering
.RSss
0: disable (default)
.br
1: enable
.REss
.IPs "<a>\ \ "
Expands to fit an aspect instead of a resolution (default: 0).
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IP expand=800:::::4/3
Expands to 800x600, unless the source is higher resolution, in which
case it expands to fill a 4/3 aspect.
.RE
.PD 1
.IPs "<r>\ \ "
Rounds up to make both width and height divisible by <r> (default: 1).
.RE
.
.TP
.B flip (also see \-flip)
Flips the image upside down.
.
.TP
.B "mirror\ "
Mirrors the image on the Y axis.
.
.TP
.B rotate[=<0\-7>]
Rotates the image by 90 degrees and optionally flips it.
For values between 4\-7 rotation is only done if the movie geometry is
portrait and not landscape.
.RSs
.IPs 0
Rotate by 90 degrees clockwise and flip (default).
.IPs 1
Rotate by 90 degrees clockwise.
.IPs 2
Rotate by 90 degrees counterclockwise.
.IPs 3
Rotate by 90 degrees counterclockwise and flip.
.RE
.
.TP
.B scale[=w:h[:ilaced[:chr_drop[:par[:par2[:presize[:noup[:arnd]]]]]]]]
Scales the image with the software scaler (slow) and performs a YUV<\->RGB
colorspace conversion (also see \-sws).
.RSs
.IPs <w>,<h>
scaled width/\:height (default: original width/\:height)
.br
.I NOTE:
If \-zoom is used, and underlying filters (including libvo) are
incapable of scaling, it defaults to d_width/\:d_height!
.RSss
 0:   scaled d_width/\:d_height
.br
\-1:   original width/\:height
.br
\-2:   Calculate w/h using the other dimension and the prescaled aspect ratio.
.br
\-3:   Calculate w/h using the other dimension and the original aspect ratio.
.br
\-(n+8): Like \-n above, but rounding the dimension to the closest multiple of 16.
.REss
.IPs <ilaced>
Toggle interlaced scaling.
.RSss
0: off (default)
.br
1: on
.REss
.IPs <chr_drop>
chroma skipping
.RSss
0: Use all available input lines for chroma.
.br
1: Use only every 2. input line for chroma.
.br
2: Use only every 4. input line for chroma.
.br
3: Use only every 8. input line for chroma.
.REss
.IPs "<par>[:<par2>] (also see \-sws)"
Set some scaling parameters depending on the type of scaler selected
with \-sws.
.RSss
\-sws 2 (bicubic):  B (blurring) and C (ringing)
.br
0.00:0.60 default
.br
0.00:0.75 VirtualDub's "precise bicubic"
.br
0.00:0.50 Catmull-Rom spline
.br
0.33:0.33 Mitchell-Netravali spline
.br
1.00:0.00 cubic B-spline
.br
\-sws 7 (gaussian): sharpness (0 (soft) \- 100 (sharp))
.br
\-sws 9 (lanczos):  filter length (1\-10)
.REss
.IPs <presize>
Scale to preset sizes.
.RSss
qntsc:   352x240 (NTSC quarter screen)
.br
qpal:    352x288 (PAL quarter screen)
.br
ntsc:    720x480 (standard NTSC)
.br
pal:     720x576 (standard PAL)
.br
sntsc:   640x480 (square pixel NTSC)
.br
spal:    768x576 (square pixel PAL)
.REss
.IPs <noup>
Disallow upscaling past the original dimensions.
.RSss
0: Allow upscaling (default).
.br
1: Disallow upscaling if one dimension exceeds its original value.
.br
2: Disallow upscaling if both dimensions exceed their original values.
.REss
.IPs <arnd>
Accurate rounding for the vertical scaler, which may be faster
or slower than the default rounding.
.RSss
0: Disable accurate rounding (default).
.br
1: Enable accurate rounding.
.REss
.RE
.
.TP
.B dsize[=aspect|w:h:aspect-method:r]
Changes the intended display size/\:aspect at an arbitrary point in the
filter chain.
Aspect can be given as a fraction (4/3) or floating point number
(1.33).
Alternatively, you may specify the exact display width and height
desired.
Note that this filter does
.B not
do any scaling itself; it just affects
what later scalers (software or hardware) will do when auto-scaling to
correct aspect.
.RSs
.IPs <w>,<h>
New display width and height.
Can also be these special values:
.RSss
 0:   original display width and height
.br
\-1:   original video width and height (default)
.br
\-2:   Calculate w/h using the other dimension and the original display
aspect ratio.
.br
\-3:   Calculate w/h using the other dimension and the original video
aspect ratio.
.REss
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IP dsize=800:\-2
Specifies a display resolution of 800x600 for a 4/3 aspect video, or
800x450 for a 16/9 aspect video.
.RE
.IPs <aspect-method>
Modifies width and height according to original aspect ratios.
.RSss
\-1: Ignore original aspect ratio (default).
.br
 0: Keep display aspect ratio by using <w> and <h> as maximum
resolution.
.br
 1: Keep display aspect ratio by using <w> and <h> as minimum
resolution.
.br
 2: Keep video aspect ratio by using <w> and <h> as maximum
resolution.
.br
 3: Keep video aspect ratio by using <w> and <h> as minimum
resolution.
.REss
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IP dsize=800:600:0
Specifies a display resolution of at most 800x600, or smaller, in order
to keep aspect.
.RE
.PD 1
.IPs "<r>\ \ "
Rounds up to make both width and height divisible by <r> (default: 1).
.RE
.
.TP
.B "yuy2\ \ \ "
Forces software YV12/\:I420/\:422P to YUY2 conversion.
Useful for video cards/\:drivers with slow YV12 but fast YUY2 support.
.
.TP
.B "yvu9\ \ \ "
Forces software YVU9 to YV12 colorspace conversion.
Deprecated in favor of the software scaler.
.
.TP
.B "yuvcsp\ "
Clamps YUV color values to the CCIR 601 range without doing real conversion.
.
.TP
.B rgb2bgr[=swap]
RGB 24/32 <\-> BGR 24/32 colorspace conversion.
.PD 0
.RSs
.IPs "swap\ "
Also perform  R <\-> B swapping.
.RE
.PD 1
.
.TP
.B palette
RGB/BGR 8 \-> 15/16/24/32bpp colorspace conversion using palette.
.
.TP
.B format[=fourcc]
Restricts the colorspace for the next filter without doing any conversion.
Use together with the scale filter for a real conversion.
.br
.I NOTE:
For a list of available formats see format=fmt=help.
.PD 0
.RSs
.IPs <fourcc>
format name like rgb15, bgr24, yv12, etc (default: yuy2)
.RE
.PD 1
.
.TP
.B noformat[=fourcc]
Restricts the colorspace for the next filter without doing any conversion.
Unlike the format filter, this will allow any colorspace
.B except
the one you specify.
.br
.I NOTE:
For a list of available formats see noformat=fmt=help.
.PD 0
.RSs
.IPs <fourcc>
format name like rgb15, bgr24, yv12, etc (default: yv12)
.RE
.PD 1
.
.TP
.B pp[=filter1[:option1[:option2...]]/[\-]filter2...] (also see \-pphelp)
Enables the specified chain of postprocessing subfilters.
Subfilters must be separated by '/' and can be disabled by
prepending a '\-'.
Each subfilter and some options have a short and a long name that can be
used interchangeably, i.e.\& dr/dering are the same.
All subfilters share common options to determine their scope:
.PD 0
.RSs
.IPs a/autoq
Automatically switch the subfilter off if the CPU is too slow.
.IPs c/chrom
Do chrominance filtering, too (default).
.IPs y/nochrom
Do luminance filtering only (no chrominance).
.IPs n/noluma
Do chrominance filtering only (no luminance).
.RE
.PD 1
.sp 1
.RS
.br
.I NOTE:
\-pphelp shows a list of available subfilters.
.sp 1
Available subfilters are
.RE
.RSs
.IPs hb/hdeblock[:difference[:flatness]]
horizontal deblocking filter
.RSss
<difference>: Difference factor where higher values mean
more deblocking (default: 32).
.br
<flatness>: Flatness threshold where lower values mean
more deblocking (default: 39).
.REss
.IPs vb/vdeblock[:difference[:flatness]]
vertical deblocking filter
.RSss
<difference>: Difference factor where higher values mean
more deblocking (default: 32).
.br
<flatness>: Flatness threshold where lower values mean
more deblocking (default: 39).
.REss
.IPs ha/hadeblock[:difference[:flatness]]
accurate horizontal deblocking filter
.RSss
<difference>: Difference factor where higher values mean
more deblocking (default: 32).
.br
<flatness>: Flatness threshold where lower values mean
more deblocking (default: 39).
.REss
.IPs va/vadeblock[:difference[:flatness]]
accurate vertical deblocking filter
.RSss
<difference>: Difference factor where higher values mean
more deblocking (default: 32).
.br
<flatness>: Flatness threshold where lower values mean
more deblocking (default: 39).
.REss
.sp 1
The horizontal and vertical deblocking filters share the
difference and flatness values so you cannot set
different horizontal and vertical thresholds.
.sp 1
.IPs h1/x1hdeblock
experimental horizontal deblocking filter
.IPs v1/x1vdeblock
experimental vertical deblocking filter
.IPs dr/dering
deringing filter
.IPs tn/tmpnoise[:threshold1[:threshold2[:threshold3]]]
temporal noise reducer
.RSss
<threshold1>: larger -> stronger filtering
.br
<threshold2>: larger -> stronger filtering
.br
<threshold3>: larger -> stronger filtering
.REss
.IPs al/autolevels[:f/fullyrange]
automatic brightness / contrast correction
.RSss
f/fullyrange: Stretch luminance to (0\-255).
.REss
.IPs lb/linblenddeint
Linear blend deinterlacing filter that deinterlaces the given block
by filtering all lines with a (1 2 1) filter.
.IPs li/linipoldeint
Linear interpolating deinterlacing filter that deinterlaces the given block
by linearly interpolating every second line.
.IPs ci/cubicipoldeint
Cubic interpolating deinterlacing filter deinterlaces the given block
by cubically interpolating every second line.
.IPs md/mediandeint
Median deinterlacing filter that deinterlaces the given block
by applying a median filter to every second line.
.IPs fd/ffmpegdeint
FFmpeg deinterlacing filter that deinterlaces the given block
by filtering every second line with a (\-1 4 2 4 \-1) filter.
.IPs l5/lowpass5
Vertically applied FIR lowpass deinterlacing filter that deinterlaces
the given block by filtering all lines with a (\-1 2 6 2 \-1) filter.
.IPs fq/forceQuant[:quantizer]
Overrides the quantizer table from the input with the constant
quantizer you specify.
.RSss
<quantizer>: quantizer to use
.REss
.IPs de/default
default pp filter combination (hb:a,vb:a,dr:a)
.IPs fa/fast
fast pp filter combination (h1:a,v1:a,dr:a)
.IPs "ac\ \ \ "
high quality pp filter combination (ha:a:128:7,va:a,dr:a)
.RE
.RS
.sp 1
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs "\-vf pp=hb/vb/dr/al"
horizontal and vertical deblocking, deringing and automatic
brightness/\:contrast
.IPs "\-vf pp=de/\-al"
default filters without brightness/\:contrast correction
.IPs "\-vf pp=default/tmpnoise:1:2:3"
Enable default filters & temporal denoiser.
.IPs "\-vf pp=hb:y/vb:a"
Horizontal deblocking on luminance only, and switch vertical deblocking
on or off automatically depending on available CPU time.
.RE
.PD 1
.
.TP
.B spp[=quality[:qp[:mode]]]
Simple postprocessing filter that compresses and decompresses the
image at several (or \- in the case of quality level 6 \- all)
shifts and averages the results.
.RSs
.IPs <quality>
0\-6 (default: 3)
.IPs "<qp>\ "
Force quantization parameter (default: 0, use QP from video).
.IPs <mode>
0: hard thresholding (default)
.br
1: soft thresholding (better deringing, but blurrier)
.br
4: like 0, but also use B-frames' QP (may cause flicker)
.br
5: like 1, but also use B-frames' QP (may cause flicker)
.RE
.
.TP
.B uspp[=quality[:qp]]
Ultra simple & slow postprocessing filter that compresses and
decompresses the image at several (or \- in the case of quality
level 8 \- all) shifts and averages the results.
The way this differs from the behavior of spp is that uspp actually
encodes & decodes each case with libavcodec Snow, whereas spp uses
a simplified intra only 8x8 DCT similar to MJPEG.
.RSs
.IPs <quality>
0\-8 (default: 3)
.IPs "<qp>\ "
Force quantization parameter (default: 0, use QP from video).
.RE
.
.TP
.B fspp[=quality[:qp[:strength[:bframes]]]]
faster version of the simple postprocessing filter
.RSs
.IPs <quality>
4\-5 (equivalent to spp; default: 4)
.IPs "<qp>\ "
Force quantization parameter (default: 0, use QP from video).
.IPs <\-15\-32>
Filter strength, lower values mean more details but also more artifacts,
while higher values make the image smoother but also blurrier (default:
0 \- PSNR optimal).
.IPs <bframes>
0: do not use QP from B-frames (default)
.br
1: use QP from B-frames too (may cause flicker)
.RE
.
.TP
.B pp7[=qp[:mode]]
Variant of the spp filter, similar to spp=6 with 7 point DCT where
only the center sample is used after IDCT.
.RSs
.IPs "<qp>\ "
Force quantization parameter (default: 0, use QP from video).
.IPs <mode>
0: hard thresholding
.br
1: soft thresholding (better deringing, but blurrier)
.br
2: medium thresholding (default, good results)
.RE
.
.TP
.B qp=equation
quantization parameter (QP) change filter
.RSs
.IPs <equation>
some equation like "2+2*sin(PI*qp)"
.RE
.
.TP
.B geq=equation
generic equation change filter
.RSs
.IPs <equation>
Some equation, e.g.\&  'p(W-X\\,Y)' to flip the image horizontally.
You can use whitespace to make the equation more readable.
There are a couple of constants that can be used in the equation:
.RSss
PI: the number pi
.br
E: the number e
.br
X / Y: the coordinates of the current sample
.br
W / H: width and height of the image
.br
SW / SH: width/height scale depending on the currently filtered plane, e.g.\&
1,1 and 0.5,0.5 for YUV 4:2:0.
.br
p(x,y): returns the value of the pixel at location x/y of the current plane.
.REss
.RE
.
.TP
.B "test\ \ \ "
Generate various test patterns.
.
.TP
.B rgbtest[=width:height]
Generate an RGB test pattern useful for detecting RGB vs BGR issues.
You should see a red, green and blue stripe from top to bottom.
.RSs
.IPs <width>
Desired width of generated image (default: 0).
0 means width of input image.
.br
.IPs <height>
Desired height of generated image (default: 0).
0 means height of input image.
.RE
.
.TP
.B lavc[=quality:fps]
Fast software YV12 to MPEG-1 conversion with libavcodec for use with DVB/\:DXR3/\:IVTV/\:V4L2.
.RSs
.IPs <quality>
1\-31: fixed qscale
.br
32\-:  fixed bitrate in kbits
.IPs <fps>
force output fps (float value) (default: 0, autodetect based on height)
.RE
.
.TP
.B dvbscale[=aspect]
Set up optimal scaling for DVB cards, scaling the x axis in hardware and
calculating the y axis scaling in software to keep aspect.
Only useful together with expand and scale.
.RSs
.IPs <aspect>
Control aspect ratio, calculate as DVB_HEIGHT*ASPECTRATIO (default:
576*4/3=768), set it to 576*(16/9)=1024 for a 16:9 TV.
.RE
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs "\-vf dvbscale,scale=\-1:0,expand=\-1:576:\-1:\-1:1,lavc"
FIXME: Explain what this does.
.RE
.PD 1
.
.TP
.B noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]]
Adds noise.
.PD 0
.RSs
.IPs <0\-100>
luma noise
.IPs <0\-100>
chroma noise
.IPs u
uniform noise (gaussian otherwise)
.IPs t
temporal noise (noise pattern changes between frames)
.IPs a
averaged temporal noise (smoother, but a lot slower)
.IPs h
high quality (slightly better looking, slightly slower)
.IPs p
mix random noise with a (semi)regular pattern
.RE
.PD 1
.
.TP
.B denoise3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
This filter aims to reduce image noise producing smooth images and making still
images really still (This should enhance compressibility.).
.PD 0
.RSs
.IPs <luma_spatial>
spatial luma strength (default: 4)
.IPs <chroma_spatial>
spatial chroma strength (default: 3)
.IPs <luma_tmp>
luma temporal strength (default: 6)
.IPs <chroma_tmp>
chroma temporal strength (default: luma_tmp*chroma_spatial/luma_spatial)
.RE
.PD 1
.
.TP
.B hqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
High precision/\:quality version of the denoise3d filter.
Parameters and usage are the same.
.
.TP
.B ow[=depth[:luma_strength[:chroma_strength]]]
Overcomplete Wavelet denoiser.
.PD 0
.RSs
.IPs <depth>
Larger depth values will denoise lower frequency components more, but
slow down filtering (default: 8).
.IPs <luma_strength>
luma strength (default: 1.0)
.IPs <chroma_strength>
chroma strength (default: 1.0)
.RE
.PD 1
.
.TP
.B eq[=brightness:contrast] (OBSOLETE)
Software equalizer with interactive controls just like the hardware
equalizer, for cards/\:drivers that do not support brightness and
contrast controls in hardware.
Might also be useful with MEncoder, either for fixing poorly captured
movies, or for slightly reducing contrast to mask artifacts and get by
with lower bitrates.
.PD 0
.RSs
.IPs <\-100\-100>
initial brightness
.IPs <\-100\-100>
initial contrast
.RE
.PD 1
.
.TP
.B eq2[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]
Alternative software equalizer that uses lookup tables (very slow),
allowing gamma correction in addition to simple brightness
and contrast adjustment.
Note that it uses the same MMX optimized code as \-vf eq if all
gamma values are 1.0.
The parameters are given as floating point values.
.PD 0
.RSs
.IPs <0.1\-10>
initial gamma value (default: 1.0)
.IPs <\-2\-2>
initial contrast, where negative values result in a
negative image (default: 1.0)
.IPs <\-1\-1>
initial brightness (default: 0.0)
.IPs <0\-3>
initial saturation (default: 1.0)
.IPs <0.1\-10>
gamma value for the red component (default: 1.0)
.IPs <0.1\-10>
gamma value for the green component (default: 1.0)
.IPs <0.1\-10>
gamma value for the blue component (default: 1.0)
.IPs <0\-1>
The weight parameter can be used to reduce the effect of a high gamma value on
bright image areas, e.g.\& keep them from getting overamplified and just plain
white.
A value of 0.0 turns the gamma correction all the way down while 1.0 leaves it
at its full strength (default: 1.0).
.RE
.PD 1
.
.TP
.B hue[=hue:saturation]
Software equalizer with interactive controls just like the hardware
equalizer, for cards/\:drivers that do not support hue and
saturation controls in hardware.
.PD 0
.RSs
.IPs <\-180\-180>
initial hue (default: 0.0)
.IPs <\-100\-100>
initial saturation, where negative values result
in a negative chroma (default: 1.0)
.RE
.PD 1
.
.TP
.B halfpack[=f]
Convert planar YUV 4:2:0 to half-height packed 4:2:2, downsampling luma but
keeping all chroma samples.
Useful for output to low-resolution display devices when hardware downscaling
is poor quality or is not available.
Can also be used as a primitive luma-only deinterlacer with very low CPU
usage.
.PD 0
.RSs
.IPs "<f>\ \ "
By default, halfpack averages pairs of lines when downsampling.
Any value different from 0 or 1 gives the default (averaging) behavior.
.RSss
0: Only use even lines when downsampling.
.br
1: Only use odd lines when downsampling.
.REss
.RE
.PD 1
.
.TP
.B ilpack[=mode]
When interlaced video is stored in YUV 4:2:0 formats, chroma
interlacing does not line up properly due to vertical downsampling of
the chroma channels.
This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format with
the chroma lines in their proper locations, so that in any given
scanline, the luma and chroma data both come from the same field.
.PD 0
.RSs
.IPs <mode>
Select the sampling mode.
.RSss
0: nearest-neighbor sampling, fast but incorrect
.br
1: linear interpolation (default)
.REss
.RE
.PD 1
.
.TP
.B harddup
Only useful with MEncoder.
If harddup is used when encoding, it will force duplicate frames to be
encoded in the output.
This uses slightly more space, but is necessary for output to MPEG
files or if you plan to demux and remux the video stream after
encoding.
Should be placed at or near the end of the filter chain unless you
have a good reason to do otherwise.
.
.TP
.B softskip
Only useful with MEncoder.
Softskip moves the frame skipping (dropping) step of encoding from
before the filter chain to some point during the filter chain.
This allows filters which need to see all frames (inverse telecine,
temporal denoising, etc.) to function properly.
Should be placed after the filters which need to see all frames and
before any subsequent filters that are CPU-intensive.
.
.TP
.B decimate[=max:hi:lo:frac]
Drops frames that do not differ greatly from the previous frame in
order to reduce framerate.
The main use of this filter is for very-low-bitrate encoding (e.g.\&
streaming over dialup modem), but it could in theory be used for
fixing movies that were inverse-telecined incorrectly.
.PD 0
.RSs
.IPs <max>
Sets the maximum number of consecutive frames which can be
dropped (if positive), or the minimum interval between
dropped frames (if negative).
.IPs <hi>,<lo>,<frac>
A frame is a candidate for dropping if no 8x8 region differs by more
than a threshold of <hi>, and if not more than <frac> portion (1
meaning the whole image) differs by more than a threshold of <lo>.
Values of <hi> and <lo> are for 8x8 pixel blocks and represent actual
pixel value differences, so a threshold of 64 corresponds to 1 unit of
difference for each pixel, or the same spread out differently over the
block.
.RE
.PD 1
.
.TP
.B dint[=sense:level]
The drop-deinterlace (dint) filter detects and drops the first from a set
of interlaced video frames.
.PD 0
.RSs
.IPs <0.0\-1.0>
relative difference between neighboring pixels (default: 0.1)
.IPs <0.0\-1.0>
What part of the image has to be detected as interlaced to
drop the frame (default: 0.15).
.RE
.PD 1
.
.TP
.B lavcdeint (OBSOLETE)
FFmpeg deinterlacing filter, same as \-vf pp=fd
.
.TP
.B kerndeint[=thresh[:map[:order[:sharp[:twoway]]]]]
Donald Graft's adaptive kernel deinterlacer.
Deinterlaces parts of a video if a configurable threshold is exceeded.
.PD 0
.RSs
.IPs <0\-255>
threshold (default: 10)
.IPs <map>
.RSss
0: Ignore pixels exceeding the threshold (default).
.br
1: Paint pixels exceeding the threshold white.
.REss
.IPs <order>
.RSss
0: Leave fields alone (default).
.br
1: Swap fields.
.REss
.IPs <sharp>
.RSss
0: Disable additional sharpening (default).
.br
1: Enable additional sharpening.
.REss
.IPs <twoway>
.RSss
0: Disable twoway sharpening (default).
.br
1: Enable twoway sharpening.
.REss
.RE
.PD 1
.
.TP
.B unsharp[=l|cWxH:amount[:l|cWxH:amount]]
unsharp mask / gaussian blur
.RSs
.IPs "l\ \ \ \ "
Apply effect on luma component.
.IPs "c\ \ \ \ "
Apply effect on chroma components.
.IPs <width>x<height>
width and height of the matrix, odd sized in both directions
(min = 3x3, max = 13x11 or 11x13, usually something between 3x3 and 7x7)
.IPs amount
Relative amount of sharpness/\:blur to add to the image
(a sane range should be \-1.5\-1.5).
.RSss
<0: blur
.br
>0: sharpen
.REss
.RE
.
.TP
.B "swapuv\ "
Swap U & V plane.
.
.TP
.B il[=d|i][s][:[d|i][s]]
(De)interleaves lines.
The goal of this filter is to add the ability to process interlaced images
pre-field without deinterlacing them.
You can filter your interlaced DVD and play it on a TV without breaking the
interlacing.
While deinterlacing (with the postprocessing filter) removes interlacing
permanently (by smoothing, averaging, etc) deinterleaving splits the frame into
2 fields (so called half pictures), so you can process (filter) them
independently and then re-interleave them.
.PD 0
.RSs
.IPs d
deinterleave (placing one above the other)
.IPs i
interleave
.IPs s
swap fields (exchange even & odd lines)
.RE
.PD 1
.
.TP
.B fil[=i|d]
(De)interleaves lines.
This filter is very similar to the il filter but much faster, the main
disadvantage is that it does not always work.
Especially if combined with other filters it may produce randomly messed
up images, so be happy if it works but do not complain if it does not for
your combination of filters.
.PD 0
.RSs
.IPs d
Deinterleave fields, placing them side by side.
.IPs i
Interleave fields again (reversing the effect of fil=d).
.RE
.PD 1
.
.TP
.B field[=n]
Extracts a single field from an interlaced image using stride arithmetic
to avoid wasting CPU time.
The optional argument n specifies whether to extract the even or the odd
field (depending on whether n is even or odd).
.
.TP
.B detc[=var1=value1:var2=value2:...]
Attempts to reverse the 'telecine' process to recover a clean,
non-interlaced stream at film framerate.
This was the first and most primitive inverse telecine filter to be
added to MPlayer/\:MEncoder.
It works by latching onto the telecine 3:2 pattern and following it as
long as possible.
This makes it suitable for perfectly-telecined material, even in the
presence of a fair degree of noise, but it will fail in the presence
of complex post-telecine edits.
Development on this filter is no longer taking place, as ivtc, pullup,
and filmdint are better for most applications.
The following arguments (see syntax above) may be used to control
detc's behavior:
.RSs
.IPs "<dr>\ "
Set the frame dropping mode.
.RSss
0: Do not drop frames to maintain fixed output framerate (default).
.br
1: Always drop a frame when there have been no drops or telecine
merges in the past 5 frames.
.br
2: Always maintain exact 5:4 input to output frame ratio.
.br
.I NOTE:
Use mode 1 or 2 with MEncoder.
.REss
.IPs "<am>\ "
Analysis mode.
.RSss
0: Fixed pattern with initial frame number specified by <fr>.
.br
1: aggressive search for telecine pattern (default)
.REss
.IPs "<fr>\ "
Set initial frame number in sequence.
0\-2 are the three clean progressive frames; 3 and 4 are the two
interlaced frames.
The default, \-1, means 'not in telecine sequence'.
The number specified here is the type for the imaginary previous
frame before the movie starts.
.IPs "<t0>, <t1>, <t2>, <t3>"
Threshold values to be used in certain modes.
.RE
.
.TP
.B ivtc[=1]
Experimental 'stateless' inverse telecine filter.
Rather than trying to lock on to a pattern like the detc filter does,
ivtc makes its decisions independently for each frame.
This will give much better results for material that has undergone
heavy editing after telecine was applied, but as a result it is not as
forgiving of noisy input, for example TV capture.
The optional parameter (ivtc=1) corresponds to the dr=1 option for the
detc filter, and should be used with MEncoder but not with MPlayer.
As with detc, you must specify the correct output framerate (\-ofps
24000/1001) when using MEncoder.
Further development on ivtc has stopped, as the pullup and filmdint
filters appear to be much more accurate.
.
.TP
.B pullup[=jl:jr:jt:jb:sb:mp]
Third-generation pulldown reversal (inverse telecine) filter,
capable of handling mixed hard-telecine, 24000/1001 fps progressive, and 30000/1001
fps progressive content.
The pullup filter is designed to be much more robust than detc or
ivtc, by taking advantage of future context in making its decisions.
Like ivtc, pullup is stateless in the sense that it does not lock onto
a pattern to follow, but it instead looks forward to the following
fields in order to identify matches and rebuild progressive frames.
It is still under development, but believed to be quite accurate.
.RSs
.IPs "jl, jr, jt, and jb"
These options set the amount of "junk" to ignore at
the left, right, top, and bottom of the image, respectively.
Left/\:right are in units of 8 pixels, while top/\:bottom are in units of
2 lines.
The default is 8 pixels on each side.
.br
.IPs "sb (strict breaks)"
Setting this option to 1 will reduce the chances of
pullup generating an occasional mismatched frame, but it may also
cause an excessive number of frames to be dropped during high motion
sequences.
Conversely, setting it to \-1 will make pullup match fields more
easily.
This may help processing of video where there is slight blurring
between the fields, but may also cause there to be interlaced frames
in the output.
.br
.IPs "mp (metric plane)"
This option may be set to 1 or 2 to use a chroma
plane instead of the luma plane for doing pullup's computations.
This may improve accuracy on very clean source material, but more
likely will decrease accuracy, especially if there is chroma noise
(rainbow effect) or any grayscale video.
The main purpose of setting mp to a chroma plane is to reduce CPU load
and make pullup usable in realtime on slow machines.
.REss
.RS
.sp 1
.I NOTE:
Always follow pullup with the softskip filter when encoding to ensure
that pullup is able to see each frame.
Failure to do so will lead to incorrect output and will usually crash,
due to design limitations in the codec/\:filter layer.
.REss
.
.TP
.B filmdint[=options]
Inverse telecine filter, similar to the pullup filter above.
It is designed to handle any pulldown pattern, including mixed soft and
hard telecine and limited support for movies that are slowed down or sped
up from their original framerate for TV.
Only the luma plane is used to find the frame breaks.
If a field has no match, it is deinterlaced with simple linear
approximation.
If the source is MPEG-2, this must be the first filter to allow
access to the field-flags set by the MPEG-2 decoder.
Depending on the source MPEG, you may be fine ignoring this advice, as
long as you do not see lots of "Bottom-first field" warnings.
With no options it does normal inverse telecine, and should be used
together with mencoder \-fps 30000/1001 \-ofps 24000/1001.
When this filter is used with MPlayer, it will result in an uneven
framerate during playback, but it is still generally better than using
pp=lb or no deinterlacing at all.
Multiple options can be specified separated by /.
.RSs
.IPs crop=<w>:<h>:<x>:<y>
Just like the crop filter, but faster, and works on mixed hard and soft
telecined content as well as when y is not a multiple of 4.
If x or y would require cropping fractional pixels from the chroma
planes, the crop area is extended.
This usually means that x and y must be even.
.IPs io=<ifps>:<ofps>
For each ifps input frames the filter will output ofps frames.
The ratio of ifps/\:ofps should match the \-fps/\-ofps ratio.
This could be used to filter movies that are broadcast on TV at a frame
rate different from their original framerate.
.IPs luma_only=<n>
If n is nonzero, the chroma plane is copied unchanged.
This is useful for YV12 sampled TV, which discards one of the chroma
fields.
.IPs mmx2=<n>
On x86, if n=1, use MMX2 optimized functions, if n=2, use 3DNow!
optimized functions, otherwise, use plain C.
If this option is not specified, MMX2 and 3DNow! are auto-detected, use
this option to override auto-detection.
.IPs fast=<n>
The larger n will speed up the filter at the expense of accuracy.
The default value is n=3.
If n is odd, a frame immediately following a frame marked with the
REPEAT_FIRST_FIELD MPEG flag is assumed to be progressive, thus filter
will not spend any time on soft-telecined MPEG-2 content.
This is the only effect of this flag if MMX2 or 3DNow! is available.
Without MMX2 and 3DNow, if n=0 or 1, the same calculations will be used
as with n=2 or 3.
If n=2 or 3, the number of luma levels used to find the frame breaks is
reduced from 256 to 128, which results in a faster filter without losing
much accuracy.
If n=4 or 5, a faster, but much less accurate metric will be used to
find the frame breaks, which is more likely to misdetect high vertical
detail as interlaced content.
.IPs verbose=<n>
If n is nonzero, print the detailed metrics for each frame.
Useful for debugging.
.IPs dint_thres=<n>
Deinterlace threshold.
Used during de-interlacing of unmatched frames.
Larger value means less deinterlacing, use n=256 to completely turn off
deinterlacing.
Default is n=8.
.IPs comb_thres=<n>
Threshold for comparing a top and bottom fields.
Defaults to 128.
.IPs diff_thres=<n>
Threshold to detect temporal change of a field.
Default is 128.
.IPs sad_thres=<n>
Sum of Absolute Difference threshold, default is 64.
.RE
.
.TP
.B softpulldown
This filter works only correct with MEncoder and acts on the MPEG-2 flags
used for soft 3:2 pulldown (soft telecine).
If you want to use the ivtc or detc filter on movies that are partly soft
telecined, inserting this filter before them should make them more reliable.
.
.TP
.B divtc[=options]
Inverse telecine for deinterlaced video.
If 3:2-pulldown telecined video has lost one of the fields or is deinterlaced
using a method that keeps one field and interpolates the other, the result is
a juddering video that has every fourth frame duplicated.
This filter is intended to find and drop those duplicates and restore the
original film framerate.
When using this filter, you must specify \-ofps that is 4/5 of
the fps of the input file and place the softskip later in the
filter chain to make sure that divtc sees all the frames.
Two different modes are available:
One pass mode is the default and is straightforward to use,
but has the disadvantage that any changes in the telecine
phase (lost frames or bad edits) cause momentary judder
until the filter can resync again.
Two pass mode avoids this by analyzing the whole video
beforehand so it will have forward knowledge about the
phase changes and can resync at the exact spot.
These passes do
.B not
correspond to pass one and two of the encoding process.
You must run an extra pass using divtc pass one before the
actual encoding throwing the resulting video away.
Use \-nosound \-ovc raw \-o /dev/null to avoid
wasting CPU power for this pass.
You may add something like crop=2:2:0:0 after divtc
to speed things up even more.
Then use divtc pass two for the actual encoding.
If you use multiple encoder passes, use divtc
pass two for all of them.
The options are:
.RSs
.IPs pass=1|2
Use two pass mode.
.IPs file=<filename>
Set the two pass log filename (default: "framediff.log").
.IPs threshold=<value>
Set the minimum strength the telecine pattern must have for the filter to
believe in it (default: 0.5).
This is used to avoid recognizing false pattern from the parts of the video
that are very dark or very still.
.IPs window=<numframes>
Set the number of past frames to look at when searching for pattern
(default: 30).
Longer window improves the reliability of the pattern search, but shorter
window improves the reaction time to the changes in the telecine phase.
This only affects the one pass mode.
The two pass mode currently uses fixed window that extends to both future
and past.
.IPs phase=0|1|2|3|4
Sets the initial telecine phase for one pass mode (default: 0).
The two pass mode can see the future, so it is able to use the correct
phase from the beginning, but one pass mode can only guess.
It catches the correct phase when it finds it, but this option can be used
to fix the possible juddering at the beginning.
The first pass of the two pass mode also uses this, so if you save the output
from the first pass, you get constant phase result.
.IPs deghost=<value>
Set the deghosting threshold (0\-255 for one pass mode, \-255\-255 for two pass
mode, default 0).
If nonzero, deghosting mode is used.
This is for video that has been deinterlaced by blending the fields
together instead of dropping one of the fields.
Deghosting amplifies any compression artifacts in the blended frames, so the
parameter value is used as a threshold to exclude those pixels from
deghosting that differ from the previous frame less than specified value.
If two pass mode is used, then negative value can be used to make the
filter analyze the whole video in the beginning of pass-2 to determine
whether it needs deghosting or not and then select either zero or the
absolute value of the parameter.
Specify this option for pass-2, it makes no difference on pass-1.
.RE
.
.TP
.B phase[=t|b|p|a|u|T|B|A|U][:v]
Delay interlaced video by one field time so that the field order
changes.
The intended use is to fix PAL movies that have been captured with the
opposite field order to the film-to-video transfer.
The options are:
.RSs
.IPs t
Capture field order top-first, transfer bottom-first.
Filter will delay the bottom field.
.IPs b
Capture bottom-first, transfer top-first.
Filter will delay the top field.
.IPs p
Capture and transfer with the same field order.
This mode only exists for the documentation of the other options to refer to,
but if you actually select it, the filter will faithfully do nothing ;-)
.IPs a
Capture field order determined automatically by field flags, transfer opposite.
Filter selects among t and b modes on a frame by frame basis using field flags.
If no field information is available, then this works just like u.
.IPs u
Capture unknown or varying, transfer opposite.
Filter selects among t and b on a frame by frame basis by analyzing the
images and selecting the alternative that produces best match between the
fields.
.IPs T
Capture top-first, transfer unknown or varying.
Filter selects among t and p using image analysis.
.IPs B
Capture bottom-first, transfer unknown or varying.
Filter selects among b and p using image analysis.
.IPs A
Capture determined by field flags, transfer unknown or varying.
Filter selects among t, b and p using field flags and image analysis.
If no field information is available, then this works just like U.
This is the default mode.
.IPs U
Both capture and transfer unknown or varying.
Filter selects among t, b and p using image analysis only.
.IPs v
Verbose operation.
Prints the selected mode for each frame and the average squared difference
between fields for t, b, and p alternatives.
.RE
.
.TP
.B telecine[=start]
Apply 3:2 'telecine' process to increase framerate by 20%.
This most likely will not work correctly with MPlayer, but it can
be used with 'mencoder \-fps 30000/1001 \-ofps 30000/1001 \-vf telecine'.
Both fps options are essential!
(A/V sync will break if they are wrong.)
The optional start parameter tells the filter where in the telecine
pattern to start (0\-3).
.
.TP
.B tinterlace[=mode]
Temporal field interlacing \- merge pairs of frames into an interlaced
frame, halving the framerate.
Even frames are moved into the upper field, odd frames to the lower field.
This can be used to fully reverse the effect of the tfields filter (in mode 0).
Available modes are:
.PD 0
.RSs
.IPs 0
Move odd frames into the upper field, even into the lower field, generating
a full-height frame at half framerate.
.IPs 1
Only output odd frames, even frames are dropped; height unchanged.
.IPs 2
Only output even frames, odd frames are dropped; height unchanged.
.IPs 3
Expand each frame to full height, but pad alternate lines with black;
framerate unchanged.
.IPs 4
Interleave even lines from even frames with odd lines from odd frames.
Height unchanged at half framerate.
.RE
.PD 1
.
.TP
.B tfields[=mode[:field_dominance]]
Temporal field separation \- split fields into frames, doubling the
output framerate.
Like the telecine filter, tfields will only work properly with
MEncoder, and only if both \-fps and \-ofps are set to the
desired (double) framerate!
.PD 0
.RSs
.IPs <mode>
0: Leave fields unchanged (will jump/\:flicker).
.br
1: Interpolate missing lines. (The algorithm used might not be so good.)
.br
2: Translate fields by 1/4 pixel with linear interpolation (no jump).
.br
4: Translate fields by 1/4 pixel with 4tap filter (higher quality) (default).
.IPs <field_dominance>\ (DEPRECATED)
\-1: auto (default)
Only works if the decoder exports the appropriate information and
no other filters which discard that information come before tfields
in the filter chain, otherwise it falls back to 0 (top field first).
.br
0: top field first
.br
1: bottom field first
.br
.I NOTE:
This option will possibly be removed in a future version.
Use \-field\-dominance instead.
.RE
.PD 1
.
.TP
.B yadif=[mode[:field_dominance]]
Yet another deinterlacing filter
.PD 0
.RSs
.IPs <mode>
0: Output 1 frame for each frame.
.br
1: Output 1 frame for each field.
.br
2: Like 0 but skips spatial interlacing check.
.br
3: Like 1 but skips spatial interlacing check.
.IPs <field_dominance>\ (DEPRECATED)
Operates like tfields.
.br
.I NOTE:
This option will possibly be removed in a future version.
Use \-field\-dominance instead.
.RE
.PD 1
.
.TP
.B mcdeint=[mode[:parity[:qp]]]
Motion compensating deinterlacer.
It needs one field per frame as input and must thus be used together
with tfields=1 or yadif=1/3 or equivalent.
.PD 0
.RSs
.IPs <mode>
0: fast
.br
1: medium
.br
2: slow, iterative motion estimation
.br
3: extra slow, like 2 plus multiple reference frames
.IPs <parity>
0 or 1 selects which field to use (note: no autodetection yet!).
.IPs "<qp>\ "
Higher values should result in a smoother motion vector
field but less optimal individual vectors.
.RE
.PD 1
.
.TP
.B boxblur=radius:power[:radius:power]
box blur
.PD 0
.RSs
.IPs <radius>
blur filter strength
.IPs <power>
number of filter applications
.RE
.PD 1
.
.TP
.B sab=radius:pf:colorDiff[:radius:pf:colorDiff]
shape adaptive blur
.PD 0
.RSs
.IPs <radius>
blur filter strength (~0.1\-4.0) (slower if larger)
.IPs "<pf>\ "
prefilter strength (~0.1\-2.0)
.IPs <colorDiff>
maximum difference between pixels to still be considered (~0.1\-100.0)
.RE
.PD 1
.
.TP
.B smartblur=radius:strength:threshold[:radius:strength:threshold]
smart blur
.PD 0
.RSs
.IPs <radius>
blur filter strength (~0.1\-5.0) (slower if larger)
.IPs <strength>
blur (0.0\-1.0) or sharpen (\-1.0\-0.0)
.IPs <threshold>
filter all (0), filter flat areas (0\-30) or filter edges (\-30\-0)
.RE
.PD 1
.
.TP
.B perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
Correct the perspective of movies not filmed perpendicular to the screen.
.PD 0
.RSs
.IPs <x0>,<y0>,...
coordinates of the top left, top right, bottom left, bottom right corners
.IPs "<t>\ \ "
linear (0) or cubic resampling (1)
.RE
.PD 1
.
.TP
.B "2xsai\ \ "
Scale and smooth the image with the 2x scale and interpolate algorithm.
.
.TP
.B "1bpp\ \ \ "
1bpp bitmap to YUV/\:BGR 8/\:15/\:16/\:32 conversion
.
.TP
.B down3dright[=lines]
Reposition and resize stereoscopic images.
Extracts both stereo fields and places them side by side, resizing
them to maintain the original movie aspect.
.PD 0
.RSs
.IPs <lines>
number of lines to select from the middle of the image (default: 12)
.RE
.PD 1
.
.TP
.B bmovl=hidden:opaque:fifo
The bitmap overlay filter reads bitmaps from a FIFO and displays them
on top of the movie, allowing some transformations on the image.
Also see TOOLS/bmovl-test.c for a small bmovl test program.
.PD 0
.RSs
.IPs <hidden>
Set the default value of the 'hidden' flag (0=visible, 1=hidden).
.IPs <opaque>
Set the default value of the 'opaque' flag (0=transparent, 1=opaque).
.IPs <fifo>
path/\:filename for the FIFO (named pipe connecting 'mplayer \-vf bmovl' to the
controlling application)
.RE
.PD 1
.sp 1
.RS
FIFO commands are:
.RE
.PD 0
.RSs
.IPs "RGBA32 width height xpos ypos alpha clear"
followed by width*height*4 Bytes of raw RGBA32 data.
.IPs "ABGR32 width height xpos ypos alpha clear"
followed by width*height*4 Bytes of raw ABGR32 data.
.IPs "RGB24 width height xpos ypos alpha clear"
followed by width*height*3 Bytes of raw RGB24 data.
.IPs "BGR24 width height xpos ypos alpha clear"
followed by width*height*3 Bytes of raw BGR24 data.
.IPs "ALPHA width height xpos ypos alpha"
Change alpha transparency of the specified area.
.IPs "CLEAR width height xpos ypos"
Clear area.
.IPs OPAQUE
Disable all alpha transparency.
Send "ALPHA 0 0 0 0 0" to enable it again.
.IPs "HIDE\ "
Hide bitmap.
.IPs "SHOW\ "
Show bitmap.
.RE
.PD 1
.sp 1
.RS
Arguments are:
.RE
.PD 0
.RSs
.IPs "<width>, <height>"
image/area size
.IPs "<xpos>, <ypos>"
Start blitting at position x/y.
.IPs <alpha>
Set alpha difference.
If you set this to \-255 you can then send a sequence of ALPHA-commands to set
the area to \-225, \-200, \-175 etc for a nice fade-in-effect! ;)
.RSss
0:    same as original
.br
255:  Make everything opaque.
.br
\-255: Make everything transparent.
.REss
.IPs <clear>
Clear the framebuffer before blitting.
.RSss
0: The image will just be blitted on top of the old one, so you do not need to
send 1.8MB of RGBA32 data every time a small part of the screen is updated.
.br
1: clear
.REss
.RE
.PD 1
.
.TP
.B framestep=I|[i]step
Renders only every nth frame or every intra frame (keyframe).
.sp 1
If you call the filter with I (uppercase) as the parameter, then
.B only
keyframes are rendered.
For DVDs it generally means one in every 15/12 frames (IBBPBBPBBPBBPBB),
for AVI it means every scene change or every keyint value (see \-lavcopts
keyint= value if you use MEncoder to encode the video).
.sp 1
When a keyframe is found, an 'I!' string followed by a newline character is
printed, leaving the current line of MPlayer/\:MEncoder output on the screen,
because it contains the time (in seconds) and frame number of the keyframe
(You can use this information to split the AVI.).
.sp 1
If you call the filter with a numeric parameter 'step' then only one in
every 'step' frames is rendered.
.sp 1
If you put an 'i' (lowercase) before the number then an 'I!' is printed
(like the I parameter).
.sp 1
If you give only the i then nothing is done to the frames, only I! is
printed.
.
.TP
.B tile=xtiles:ytiles:output:start:delta
Tile a series of images into a single, bigger image.
If you omit a parameter or use a value less than 0, then the default
value is used.
You can also stop when you are satisfied (... \-vf tile=10:5 ...).
It is probably a good idea to put the scale filter before the tile :-)
.sp 1
The parameters are:
.sp 1
.PD 0
.RSs
.IPs <xtiles>
number of tiles on the x axis (default: 5)
.IPs <ytiles>
number of tiles on the y axis (default: 5)
.IPs <output>
Render the tile when 'output' number of frames are reached, where 'output'
should be a number less than xtile * ytile.
Missing tiles are left blank.
You could, for example, write an 8 * 7 tile every 50 frames to have one
image every 2 seconds @ 25 fps.
.IPs <start>
outer border thickness in pixels (default: 2)
.IPs <delta>
inner border thickness in pixels (default: 4)
.RE
.PD 1
.
.TP
.B delogo[=x:y:w:h:t]
Suppresses a TV station logo by a simple interpolation of the
surrounding pixels.
Just set a rectangle covering the logo and watch it disappear (and
sometimes something even uglier appear \- your mileage may vary).
.PD 0
.RSs
.IPs <x>,<y>
top left corner of the logo
.IPs <w>,<h>
width and height of the cleared rectangle
.IPs <t>
Thickness of the fuzzy edge of the rectangle (added to w and h).
When set to \-1, a green rectangle is drawn on the screen to
simplify finding the right x,y,w,h parameters.
.RE
.PD 1
.
.TP
.B remove\-logo=/path/to/logo_bitmap_file_name.pgm
Suppresses a TV station logo, using a PGM or PPM image
file to determine which pixels comprise the logo.
The width and height of the image file must match
those of the video stream being processed.
Uses the filter image and a circular blur
algorithm to remove the logo.
.RSs
.IPs /path/to/logo_bitmap_file_name.pgm
[path] + filename of the filter image.
.RE
.
.TP
.B zrmjpeg[=options]
Software YV12 to MJPEG encoder for use with the zr2 video
output device.
.RSs
.IPs maxheight=<h>|maxwidth=<w>
These options set the maximum width and height the zr card
can handle (the MPlayer filter layer currently cannot query those).
.IPs {dc10+,dc10,buz,lml33}-{PAL|NTSC}
Use these options to set maxwidth and maxheight automatically to the
values known for card/\:mode combo.
For example, valid options are: dc10-PAL and buz-NTSC (default: dc10+PAL)
.IPs color|bw
Select color or black and white encoding.
Black and white encoding is faster.
Color is the default.
.IPs hdec={1,2,4}
Horizontal decimation 1, 2 or 4.
.IPs vdec={1,2,4}
Vertical decimation 1, 2 or 4.
.IPs quality=1\-20
Set JPEG compression quality [BEST] 1 \- 20 [VERY BAD].
.IPs fd|nofd
By default, decimation is only performed if the Zoran hardware
can upscale the resulting MJPEG images to the original size.
The option fd instructs the filter to always perform the requested
decimation (ugly).
.RE
.
.TP
.B screenshot
Allows acquiring screenshots of the movie using slave mode
commands that can be bound to keypresses.
See the slave mode documentation and the INTERACTIVE CONTROL
section for details.
Files named 'shotNNNN.png' will be saved in the working directory,
using the first available number \- no files will be overwritten.
The filter has no overhead when not used and accepts an arbitrary
colorspace, so it is safe to add it to the configuration file.
.RE
.
.TP
.B "ass\ \ \ \ "
Moves SSA/ASS subtitle rendering to an arbitrary point in the filter chain.
Only useful with the \-ass option.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-vf ass,screenshot"
Moves SSA/ASS rendering before the screenshot filter.
Screenshots taken this way will contain subtitles.
.RE
.PD 1
.
.TP
.B blackframe[=amount:threshold]
Detect frames that are (almost) completely black.
Can be useful to detect chapter transitions or commercials.
Output lines consist of the frame number of the detected frame, the
percentage of blackness, the frame type and the frame number of the last
encountered keyframe.
.RSs
.IPs <amount>
Percentage of the pixels that have to be below the threshold (default: 98).
.IPs <threshold>
Threshold below which a pixel value is considered black (default: 32).
.RE
.
.
.
.SH "GENERAL ENCODING OPTIONS (MENCODER ONLY)"
.
.TP
.B \-audio\-delay <any floating-point number>
Delays either audio or video by setting a delay field in the header
(default: 0.0).
This does not delay either stream while encoding, but the player will
see the delay field and compensate accordingly.
Positive values delay the audio, and negative values delay the video.
Note that this is the exact opposite of the \-delay option.
For example, if a video plays correctly with \-delay 0.2, you can
fix the video with MEncoder by using \-audio\-delay \-0.2.
.sp 1
Currently, this option only works with the default muxer (\-of avi).
If you are using a different muxer, then you must use \-delay instead.
.
.TP
.B \-audio\-density <1\-50>
Number of audio chunks per second (default is 2 for 0.5s long audio chunks).
.br
.I NOTE:
CBR only, VBR ignores this as it puts each packet in a new chunk.
.
.TP
.B \-audio\-preload <0.0\-2.0>
Sets up the audio buffering time interval (default: 0.5s).
.
.TP
.B \-fafmttag <format>
Can be used to override the audio format tag of the output file.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-fafmttag 0x55"
Will have the output file contain 0x55 (mp3) as audio format tag.
.RE
.PD 1
.
.TP
.B \-ffourcc <fourcc>
Can be used to override the video fourcc of the output file.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-ffourcc div3"
Will have the output file contain 'div3' as video fourcc.
.RE
.PD 1
.
.TP
.B \-force\-avi\-aspect <0.2\-3.0>
Override the aspect stored in the AVI OpenDML vprp header.
This can be used to change the aspect ratio with '\-ovc copy'.
.
.TP
.B \-frameno\-file <filename> (DEPRECATED)
Specify the name of the audio file with framenumber mappings created in
the first (audio only) pass of a special three pass encoding mode.
.br
.I NOTE:
Using this mode will most likely give you A-V desync.
Do not use it.
It is kept for backwards compatibility only and will possibly
be removed in a future version.
.
.TP
.B \-hr\-edl\-seek
Use a more precise, but much slower method for skipping areas.
Areas marked for skipping are not seeked over, instead all
frames are decoded, but only the necessary frames are encoded.
This allows starting at non-keyframe boundaries.
.br
.I NOTE:
Not guaranteed to work right with '\-ovc copy'.
.
.TP
.B \-info <option1:option2:...> (AVI only)
Specify the info header of the resulting AVI file.
.sp 1
Available options are:
.RSs
.IPs "help\ "
Show this description.
.IPs name=<value>
title of the work
.IPs artist=<value>
artist or author of the work
.IPs genre=<value>
original work category
.IPs subject=<value>
contents of the work
.IPs copyright=<value>
copyright information
.IPs srcform=<value>
original format of the digitized material
.IPs comment=<value>
general comments about the work
.RE
.
.TP
.B \-noautoexpand
Do not automatically insert the expand filter into the MEncoder filter chain.
Useful to control at which point of the filter chain subtitles are rendered
when hardcoding subtitles onto a movie.
.
.TP
.B \-noencodedups
Do not attempt to encode duplicate frames in duplicate; always output
zero-byte frames to indicate duplicates.
Zero-byte frames will be written anyway unless a filter or encoder
capable of doing duplicate encoding is loaded.
Currently the only such filter is harddup.
.
.TP
.B \-noodml (\-of avi only)
Do not write OpenDML index for AVI files >1GB.
.
.TP
.B \-noskip
Do not skip frames.
.
.TP
.B \-o <filename>
Outputs to the given filename.
.br
If you want a default output filename, you can put this option in the
MEncoder config file.
.
.TP
.B \-oac <codec name>
Encode with the given audio codec (no default set).
.br
.I NOTE:
Use \-oac help to get a list of available audio codecs.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-oac copy"
no encoding, just streamcopy
.IPs "\-oac pcm"
Encode to uncompressed PCM.
.IPs "\-oac mp3lame"
Encode to MP3 (using LAME).
.IPs "\-oac lavc"
Encode with a libavcodec codec.
.RE
.PD 1
.
.TP
.B \-of <format> (BETA CODE!)
Encode to the specified container format (default: AVI).
.br
.I NOTE:
Use \-of help to get a list of available container formats.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-of avi"
Encode to AVI.
.IPs "\-of mpeg"
Encode to MPEG (also see \-mpegopts).
.IPs "\-of lavf"
Encode with libavformat muxers (also see \-lavfopts).
.IPs "\-of rawvideo"
raw video stream (no muxing \- one video stream only)
.IPs "\-of rawaudio"
raw audio stream (no muxing \- one audio stream only)
.RE
.PD 1
.
.TP
.B \-ofps <fps>
Specify a frames per second (fps) value for the output file,
which can be different from that of the source material.
Must be set for variable fps (ASF, some MOV) and progressive
(30000/1001 fps telecined MPEG) files.
.
.TP
.B \-ovc <codec name>
Encode with the given video codec (no default set).
.br
.I NOTE:
Use \-ovc help to get a list of available video codecs.
.sp 1
.I EXAMPLE:
.PD 0
.RSs
.IPs "\-ovc copy"
no encoding, just streamcopy
.IPs "\-ovc raw"
Encode to an arbitrary uncompressed format (use '\-vf format' to select).
.IPs "\-ovc lavc"
Encode with a libavcodec codec.
.RE
.PD 1
.
.TP
.B \-passlogfile <filename>
Dump first pass information to <filename> instead of the default divx2pass.log
in two pass encoding mode.
.
.TP
.B \-skiplimit <value>
Specify the maximum number of frames that may be skipped after
encoding one frame (\-noskiplimit for unlimited).
.
.TP
.B \-vobsubout <basename>
Specify the basename for the output .idx and .sub files.
This turns off subtitle rendering in the encoded movie and diverts it to
VOBsub subtitle files.
.
.TP
.B \-vobsuboutid <langid>
Specify the language two letter code for the subtitles.
This overrides what is read from the DVD or the .ifo file.
.
.TP
.B \-vobsuboutindex <index>
Specify the index of the subtitles in the output files (default: 0).
.
.
.
.SH "CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY)"
You can specify codec specific encoding parameters using the following
syntax:
.
.TP
.B \-<codec>opts <option1[=value1]:option2[=value2]:...>
.
.PP
Where <codec> may be: lavc, xvidenc, mp3lame, toolame, twolame,
nuv, xvfw, faac, x264enc, mpeg, lavf.
.
.
.SS mp3lame (\-lameopts)
.
.TP
.B "help\ \ \ "
get help
.
.TP
.B vbr=<0\-4>
variable bitrate method
.PD 0
.RSs
.IPs 0
cbr
.IPs 1
mt
.IPs 2
rh (default)
.IPs 3
abr
.IPs 4
mtrh
.RE
.PD 1
.
.TP
.B "abr\ \ \ \ "
average bitrate
.
.TP
.B "cbr\ \ \ \ "
constant bitrate
Also forces CBR mode encoding on subsequent ABR presets modes.
.
.TP
.B br=<0\-1024>
bitrate in kbps (CBR and ABR only)
.
.TP
.B q=<0\-9>
quality (0 \- highest, 9 \- lowest) (VBR only)
.
.TP
.B aq=<0\-9>
algorithmic quality (0 \- best/slowest, 9 \- worst/fastest)
.
.TP
.B ratio=<1\-100>
compression ratio
.
.TP
.B vol=<0\-10>
audio input gain
.
.TP
.B mode=<0\-3>
(default: auto)
.PD 0
.RSs
.IPs 0
stereo
.IPs 1
joint-stereo
.IPs 2
dualchannel
.IPs 3
mono
.RE
.PD 1
.
.TP
.B padding=<0\-2>
.PD 0
.RSs
.IPs 0
none
.IPs 1
all
.IPs 2
adjust
.RE
.PD 1
.
.TP
.B "fast\ \ \ "
Switch on faster encoding on subsequent VBR presets modes.
This results in slightly lower quality and higher bitrates.
.
.TP
.B highpassfreq=<freq>
Set a highpass filtering frequency in Hz.
Frequencies below the specified one will be cut off.
A value of \-1 will disable filtering, a value of 0
will let LAME choose values automatically.
.
.TP
.B lowpassfreq=<freq>
Set a lowpass filtering frequency in Hz.
Frequencies above the specified one will be cut off.
A value of \-1 will disable filtering, a value of 0
will let LAME choose values automatically.
.
.TP
.B preset=<value>
preset values
.RSs
.IPs "help\ "
Print additional options and information about presets settings.
.IPs medium
VBR encoding, good quality, 150\-180 kbps bitrate range
.IPs standard
VBR encoding, high quality, 170\-210 kbps bitrate range
.IPs extreme
VBR encoding, very high quality, 200\-240 kbps bitrate range
.IPs insane
CBR encoding, highest preset quality, 320 kbps bitrate
.IPs <8\-320>
ABR encoding at average given kbps bitrate
.RE
.sp 1
.RS
.I EXAMPLES:
.RE
.PD 0
.RSs
.IPs fast:preset=standard
suitable for most people and most music types and already quite high quality
.IPs cbr:preset=192
Encode with ABR presets at a 192 kbps forced constant bitrate.
.IPs preset=172
Encode with ABR presets at a 172 kbps average bitrate.
.IPs preset=extreme
for people with extremely good hearing and similar equipment
.RE
.PD 1
.
.
.SS toolame and twolame (\-toolameopts and \-twolameopts respectively)
.
.TP
.B br=<32\-384>
In CBR mode this parameter indicates the bitrate in kbps,
when in VBR mode it is the minimum bitrate allowed per frame.
VBR mode will not work with a value below 112.
.
.TP
.B vbr=<\-50\-50> (VBR only)
variability range; if negative the encoder shifts the average bitrate
towards the lower limit, if positive towards the higher.
When set to 0 CBR is used (default).
.
.TP
.B maxvbr=<32\-384> (VBR only)
maximum bitrate allowed per frame, in kbps
.
.TP
.B mode=<stereo  |  jstereo  |  mono  |  dual>
(default: mono for 1-channel audio, stereo otherwise)
.
.TP
.B psy=<\-1\-4>
psychoacoustic model (default: 2)
.
.TP
.B errprot=<0 | 1>
Include error protection.
.
.TP
.B debug=<0\-10>
debug level
.RE
.PD 1
.
.
.SS faac (\-faacopts)
.
.TP
.B br=<bitrate>
average bitrate in kbps (mutually exclusive with quality)
.
.TP
.B quality=<1\-1000>
quality mode, the higher the better (mutually exclusive with br)
.
.TP
.B object=<1\-4>
object type complexity
.PD 0
.RSs
.IPs 1
MAIN (default)
.IPs 2
LOW
.IPs 3
SSR
.IPs 4
LTP (extremely slow)
.RE
.PD 1
.
.TP
.B mpeg=<2|4>
MPEG version (default: 4)
.
.TP
.B "tns\ \ \ \ "
Enables temporal noise shaping.
.
.TP
.B cutoff=<0\-sampling_rate/2>
cutoff frequency (default: sampling_rate/2)
.
.TP
.B "raw\ \ \ \ "
Stores the bitstream as raw payload with extradata in the container header
(default: 0, corresponds to ADTS).
Do not set this flag if not explicitly required or you will not be able to
remux the audio stream later on.
.RE
.PD 1
.
.
.SS lavc (\-lavcopts)
.
Many libavcodec (lavc for short) options are tersely documented.
Read the source for full details.
.PP
.I EXAMPLE:
.PD 0
.RSs
.IPs vcodec=msmpeg4:vbitrate=1800:vhq:keyint=250
.RE
.PD 1
.
.TP
.B o=<key>=<value>[,<key>=<value>[,...]]
Pass AVOptions to libavcodec encoder.
Note, a patch to make the o= unneeded and pass all unknown options through
the AVOption system is welcome.
A full list of AVOptions can be found in the FFmpeg manual.
Note that some AVOptions may conflict with MEncoder options.
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.PD 0
.IPs o=bt=100k
.PD 1
.RE
.
.TP
.B acodec=<value>
audio codec (default: mp2)
.PD 0
.RSs
.IPs "ac3\ \ "
Dolby Digital (AC-3)
.IPs adpcm_*
Adaptive PCM formats \- see the HTML documentation for details.
.IPs "flac\ "
Free Lossless Audio Codec (FLAC)
.IPs "g726\ "
G.726 ADPCM
.IPs libamr_nb
3GPP Adaptive Multi-Rate (AMR) narrow-band
.IPs libamr_wb
3GPP Adaptive Multi-Rate (AMR) wide-band
.IPs libfaac
Advanced Audio Coding (AAC) \- using FAAC
.IPs libmp3lame
MPEG-1 audio layer 3 (MP3) \- using LAME
.IPs "mp2\ \ "
MPEG-1 audio layer 2 (MP2)
.IPs pcm_*
PCM formats \- see the HTML documentation for details.
.IPs roq_dpcm
Id Software RoQ DPCM
.IPs sonic
experimental simple lossy codec
.IPs sonicls
experimental simple lossless codec
.IPs vorbis
Vorbis
.IPs wmav1
Windows Media Audio v1
.IPs wmav2
Windows Media Audio v2
.RE
.PD 1
.
.TP
.B abitrate=<value>
audio bitrate in kbps (default: 224)
.
.TP
.B atag=<value>
Use the specified Windows audio format tag (e.g.\& atag=0x55).
.
.TP
.B bit_exact
Use only bit exact algorithms (except (I)DCT).
Additionally bit_exact disables several optimizations and thus
should only be used for regression tests, which need binary
identical files even if the encoder version changes.
This also suppresses the user_data header in MPEG-4 streams.
Do not use this option unless you know exactly what you are doing.
.
.TP
.B threads=<1\-8>
Maximum number of threads to use (default: 1).
May have a slight negative effect on motion estimation.
.RE
.
.TP
.B vcodec=<value>
Employ the specified codec (default: mpeg4).
.PD 0
.RSs
.IPs "asv1\ "
ASUS Video v1
.IPs "asv2\ "
ASUS Video v2
.IPs dvvideo
Sony Digital Video
.IPs "ffv1\ "
FFmpeg's lossless video codec
.IPs ffvhuff
nonstandard 20% smaller HuffYUV using YV12
.IPs "flv\ \ "
Sorenson H.263 used in Flash Video
.IPs "h261\ "
H.261
.IPs "h263\ "
H.263
.IPs h263p
H.263+
.IPs huffyuv
HuffYUV
.IPs libtheora
Theora
.IPs libx264
x264 H.264/AVC MPEG-4 Part 10
.IPs libxvid
Xvid MPEG-4 Part 2 (ASP)
.IPs ljpeg
Lossless JPEG
.IPs mjpeg
Motion JPEG
.IPs mpeg1video
MPEG-1 video
.IPs mpeg2video
MPEG-2 video
.IPs mpeg4
MPEG-4 (DivX 4/5)
.IPs msmpeg4
DivX 3
.IPs msmpeg4v2
MS MPEG4v2
.IPs roqvideo
ID Software RoQ Video
.IPs "rv10\ "
an old RealVideo codec
.IPs "snow (also see: vstrict)"
FFmpeg's experimental wavelet-based codec
.IPs "svq1\ "
Apple Sorenson Video 1
.IPs "wmv1\ "
Windows Media Video, version 1 (AKA WMV7)
.IPs "wmv2\ "
Windows Media Video, version 2 (AKA WMV8)
.RE
.PD 1
.
.TP
.B vqmin=<1\-31>
minimum quantizer
.RSs
.IPs 1
Not recommended (much larger file, little quality difference and weird side
effects: msmpeg4, h263 will be very low quality, ratecontrol will be confused
resulting in lower quality and some decoders will not be able to decode it).
.IPs 2
Recommended for normal mpeg4/\:mpeg1video encoding (default).
.IPs 3
Recommended for h263(p)/\:msmpeg4.
The reason for preferring 3 over 2 is that 2 could lead to overflows.
(This will be fixed for h263(p) by changing the quantizer per MB in
the future, msmpeg4 cannot be fixed as it does not support that.)
.RE
.
.TP
.B lmin=<0.01\-255.0>
Minimum frame-level Lagrange multiplier for ratecontrol (default: 2.0).
Lavc will rarely use quantizers below the value of lmin.
Lowering lmin will make lavc more likely to choose lower quantizers for
some frames, but not lower than the value of vqmin.
Likewise, raising lmin will make lavc less likely to choose low
quantizers, even if vqmin would have allowed them.
You probably want to set lmin approximately equal to vqmin.
When adaptive quantization is in use, changing lmin/lmax may have less
of an effect; see mblmin/mblmax.
.RE
.
.TP
.B lmax=<0.01\-255.0>
maximum Lagrange multiplier for ratecontrol (default: 31.0)
.RE
.
.TP
.B mblmin=<0.01\-255.0>
Minimum macroblock-level Lagrange multiplier for ratecontrol
(default:2.0).
This parameter affects adaptive quantization options like qprd,
lumi_mask, etc..
.RE
.
.TP
.B mblmax=<0.01\-255.0>
Maximum macroblock-level Lagrange multiplier for ratecontrol
(default: 31.0).
.RE
.
.TP
.B vqscale=<0\-31>
Constant quantizer /\: constant quality encoding (selects fixed quantizer mode).
A lower value means better quality but larger files (default: \-1).
In case of snow codec, value 0 means lossless encoding.
Since the other codecs do not support this, vqscale=0 will have an undefined
effect.
1 is not recommended (see vqmin for details).
.
.TP
.B vqmax=<1\-31>
Maximum quantizer, 10\-31 should be a sane range (default: 31).
.
.TP
.B mbqmin=<1\-31>
obsolete, use vqmin
.
.TP
.B mbqmax=<1\-31>
obsolete, use vqmax
.
.TP
.B vqdiff=<1\-31>
maximum quantizer difference between consecutive I- or P-frames
(default: 3)
.
.TP
.B vmax_b_frames=<0\-4>
maximum number of B-frames between non-B-frames:
.PD 0
.RSs
.IPs 0
no B-frames (default)
.IPs 0\-2
sane range for MPEG-4
.RE
.PD 1
.
.TP
.B vme=<0\-5>
motion estimation method.
Available methods are:
.PD 0
.RSs
.IPs 0
none (very low quality)
.IPs 1
full (slow, currently unmaintained and disabled)
.IPs 2
log (low quality, currently unmaintained and disabled)
.IPs 3
phods (low quality, currently unmaintained and disabled)
.IPs 4
EPZS: size=1 diamond, size can be adjusted with the *dia options
(default)
.IPs 5
X1 (experimental, currently aliased to EPZS)
.IPs 8
iter (iterative overlapped block, only used in snow)
.RE
.PD 1
.sp 1
.RS
.br
.I NOTE:
0\-3 currently ignores the amount of bits spent,
so quality may be low.
.RE
.
.TP
.B me_range=<0\-9999>
motion estimation search range (default: 0 (unlimited))
.
.TP
.B mbd=<0\-2> (also see *cmp, qpel)
Macroblock decision algorithm (high quality mode), encode each macro
block in all modes and choose the best.
This is slow but results in better quality and file size.
When mbd is set to 1 or 2, the value of mbcmp is ignored when comparing
macroblocks (the mbcmp value is still used in other places though, in particular
the motion search algorithms).
If any comparison setting (precmp, subcmp, cmp, or mbcmp) is nonzero,
however, a slower but better half-pel motion search will be used,
regardless of what mbd is set to.
If qpel is set, quarter-pel motion search will be used regardless.
.PD 0
.RSs
.IPs 0
Use comparison function given by mbcmp (default).
.IPs 1
Select the MB mode which needs the fewest bits (=vhq).
.IPs 2
Select the MB mode which has the best rate distortion.
.RE
.PD 1
.
.TP
.B "vhq\ \ \ \ "
Same as mbd=1, kept for compatibility reasons.
.
.TP
.B "v4mv\ \ \ "
Allow 4 motion vectors per macroblock (slightly better quality).
Works better if used with mbd>0.
.
.TP
.B "obmc\ \ \ "
overlapped block motion compensation (H.263+)
.
.TP
.B "loop\ \ \ "
loop filter (H.263+)
note, this is broken
.
.TP
.B inter_threshold <\-1000\-1000>
Does absolutely nothing at the moment.
.
.TP
.B keyint=<0\-300>
maximum interval between keyframes in frames (default: 250 or one
keyframe every ten seconds in a 25fps movie.
This is the recommended default for MPEG-4).
Most codecs require regular keyframes in order to limit the accumulation of mismatch error.
Keyframes are also needed for seeking, as seeking is only possible to a keyframe \- but
keyframes need more space than other frames, so larger numbers here mean
slightly smaller files but less precise seeking.
0 is equivalent to 1, which makes every frame a keyframe.
Values >300 are not recommended as the quality might be bad depending upon
decoder, encoder and luck.
It is common for MPEG-1/2 to use values <=30.
.
.TP
.B sc_threshold=<\-1000000000\-1000000000>
Threshold for scene change detection.
A keyframe is inserted by libavcodec when it detects a scene change.
You can specify the sensitivity of the detection with this option.
\-1000000000 means there is a scene change detected at every frame,
1000000000 means no scene changes are detected (default: 0).
.
.TP
.B sc_factor=<any positive integer>
Causes frames with higher quantizers to be more likely to trigger a
scene change detection and make libavcodec use an I-frame (default: 1).
1\-16 is a sane range.
Values between 2 and 6 may yield increasing PSNR (up to approximately
0.04 dB) and better placement of I-frames in high-motion scenes.
Higher values than 6 may give very slightly better PSNR (approximately
0.01 dB more than sc_factor=6), but noticably worse visual quality.
.
.TP
.B vb_strategy=<0\-2> (pass one only)
strategy to choose between I/P/B-frames:
.PD 0
.RSs
.IPs 0
Always use the maximum number of B-frames (default).
.IPs 1
Avoid B-frames in high motion scenes.
See the b_sensitivity option to tune this strategy.
.IPs 2
Places B-frames more or less optimally to yield maximum quality (slower).
You may want to reduce the speed impact of this option by tuning the
option brd_scale.
.RE
.PD 1
.
.TP
.B b_sensitivity=<any integer greater than 0>
Adjusts how sensitively vb_strategy=1 detects motion and avoids using
B-frames (default: 40).
Lower sensitivities will result in more B-frames.
Using more B-frames usually improves PSNR, but too many B-frames can
hurt quality in high-motion scenes.
Unless there is an extremely high amount of motion, b_sensitivity can
safely be lowered below the default; 10 is a reasonable value in most
cases.
.
.TP
.B brd_scale=<0\-10>
Downscales frames for dynamic B-frame decision (default: 0).
Each time brd_scale is increased by one, the frame dimensions are
divided by two, which improves speed by a factor of four.
Both dimensions of the fully downscaled frame must be even numbers, so
brd_scale=1 requires the original dimensions to be multiples of four,
brd_scale=2 requires multiples of eight, etc.
In other words, the dimensions of the original frame must both be
divisible by 2^(brd_scale+1) with no remainder.
.
.TP
.B bidir_refine=<0\-4>
Refine the two motion vectors used in bidirectional macroblocks,
rather than re-using vectors from the forward and backward searches.
This option has no effect without B-frames.
.PD 0
.RSs
.IPs 0
Disabled (default).
.IPs 1\-4
Use a wider search (larger values are slower).
.RE
.PD 1
.
.TP
.B vpass=<1\-3>
Activates internal two (or more) pass mode, only specify if you wish to
use two (or more) pass encoding.
.PD 0
.RSs
.IPs 1
first pass (also see turbo)
.IPs 2
second pass
.IPs 3
Nth pass (second and subsequent passes of N-pass encoding)
.RE
.RS
Here is how it works, and how to use it:
.br
The first pass (vpass=1) writes the statistics file.
You might want to deactivate some CPU-hungry options, like "turbo"
mode does.
.br
In two pass mode, the second pass (vpass=2) reads the statistics file and
bases ratecontrol decisions on it.
.br
In N-pass mode, the second pass (vpass=3, that is not a typo)
does both: It first reads the statistics, then overwrites them.
You might want to backup divx2pass.log before doing this if there is
any possibility that you will have to cancel MEncoder.
You can use all encoding options, except very CPU-hungry options like "qns".
.br
You can run this same pass over and over to refine the encode.
Each subsequent pass will use the statistics from the previous pass to improve.
The final pass can include any CPU-hungry encoding options.
.br
If you want a 2 pass encode, use first vpass=1, and then vpass=2.
.br
If you want a 3 or more pass encode, use vpass=1 for the first pass
and then vpass=3 and then vpass=3 again and again until you are
satisfied with the encode.
.RE
.PD 1
.sp 1
.RS
huffyuv:
.RE
.PD 0
.RSs
.IPs "pass 1"
Saves statistics.
.IPs "pass 2"
Encodes with an optimal Huffman table based upon statistics
from the first pass.
.RE
.PD 1
.
.TP
.B turbo (two pass only)
Dramatically speeds up pass one using faster algorithms and disabling
CPU-intensive options.
This will probably reduce global PSNR a little bit (around 0.01dB) and
change individual frame type and PSNR a little bit more (up to 0.03dB).
.
.TP
.B aspect=<x/y>
Store movie aspect internally, just like with MPEG files.
Much nicer than rescaling, because quality is not decreased.
Only MPlayer will play these files correctly, other players will display
them with wrong aspect.
The aspect parameter can be given as a ratio or a floating point number.
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.PD 0
.IPs "aspect=16/9 or aspect=1.78"
.PD 1
.RE
.
.TP
.B autoaspect
Same as the aspect option, but automatically computes aspect, taking
into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
filter chain.
Does not incur a performance penalty, so you can safely leave it
always on.
.
.TP
.B vbitrate=<value>
Specify bitrate (default: 800).
.br
.I WARNING:
1kbit = 1000 bits
.PD 0
.RSs
.IPs 4\-16000
(in kbit)
.IPs 16001\-24000000
(in bit)
.RE
.PD 1
.
.TP
.B vratetol=<value>
approximated file size tolerance in kbit.
1000\-100000 is a sane range.
(warning: 1kbit = 1000 bits)
(default: 8000)
.br
.I NOTE:
vratetol should not be too large during the second pass or there might
be problems if vrc_(min|max)rate is used.
.
.TP
.B vrc_maxrate=<value>
maximum bitrate in kbit/\:sec
(default: 0, unlimited)
.
.TP
.B vrc_minrate=<value>
minimum bitrate in kbit/\:sec
(default: 0, unlimited)
.
.TP
.B vrc_buf_size=<value>
buffer size in kbit
For MPEG-1/2 this also sets the vbv buffer size, use 327 for VCD,
917 for SVCD and 1835 for DVD.
.
.TP
.B vrc_buf_aggressivity
currently useless
.
.TP
.B vrc_strategy
Ratecontrol method.
Note that some of the ratecontrol-affecting options will have no effect
if vrc_strategy is not set to 0.
.PD 0
.RSs
.IPs 0
Use internal lavc ratecontrol (default).
.IPs 1
Use Xvid ratecontrol (experimental; requires MEncoder to be compiled
with support for Xvid 1.1 or higher).
.RE
.PD 1
.
.TP
.B vb_qfactor=<\-31.0\-31.0>
quantizer factor between B- and non-B-frames (default: 1.25)
.
.TP
.B vi_qfactor=<\-31.0\-31.0>
quantizer factor between I- and non-I-frames (default: 0.8)
.
.TP
.B vb_qoffset=<\-31.0\-31.0>
quantizer offset between B- and non-B-frames (default: 1.25)
.
.TP
.B vi_qoffset=<\-31.0\-31.0>
(default: 0.0)
.br
if v{b|i}_qfactor > 0
.br
I/B-frame quantizer = P-frame quantizer * v{b|i}_qfactor + v{b|i}_qoffset
.br
else
.br
do normal ratecontrol (do not lock to next P-frame quantizer) and
set q= \-q * v{b|i}_qfactor + v{b|i}_qoffset
.br
.I HINT:
To do constant quantizer encoding with different quantizers for
I/P- and B-frames you can use:
lmin= <ip_quant>:lmax= <ip_quant>:vb_qfactor= <b_quant/\:ip_quant>.
.
.TP
.B vqblur=<0.0\-1.0> (pass one)
Quantizer blur (default: 0.5), larger values will average the
quantizer more over time (slower change).
.PD 0
.RSs
.IPs 0.0
Quantizer blur disabled.
.IPs 1.0
Average the quantizer over all previous frames.
.RE
.PD 1
.
.TP
.B vqblur=<0.0\-99.0> (pass two)
Quantizer gaussian blur (default: 0.5), larger values will average
the quantizer more over time (slower change).
.
.TP
.B vqcomp=<0.0\-1.0>
Quantizer compression, vrc_eq depends upon this (default: 0.5).
.I NOTE:
Perceptual quality will be optimal somewhere in between the range's extremes.
.
.TP
.B vrc_eq=<equation>
main ratecontrol equation
.RE
.RSs
.IPs 1+(tex/\:avgTex-1)*qComp
approximately the equation of the old ratecontrol code
.IPs tex^qComp
with qcomp 0.5 or something like that (default)
.RE
.PP
.RS
infix operators:
.RE
.RSs
.IPs +,\-,*,/,^
.RE
.PP
.RS
variables:
.RE
.RSs
.IPs "tex\ \ "
texture complexity
.IPs iTex,pTex
intra, non-intra texture complexity
.IPs avgTex
average texture complexity
.IPs avgIITex
average intra texture complexity in I-frames
.IPs avgPITex
average intra texture complexity in P-frames
.IPs avgPPTex
average non-intra texture complexity in P-frames
.IPs avgBPTex
average non-intra texture complexity in B-frames
.IPs "mv\ \ \ "
bits used for motion vectors
.IPs fCode
maximum length of motion vector in log2 scale
.IPs iCount
number of intra macroblocks / number of macroblocks
.IPs "var\ \ "
spatial complexity
.IPs mcVar
temporal complexity
.IPs qComp
qcomp from the command line
.IPs "isI, isP, isB"
Is 1 if picture type is I/P/B else 0.
.IPs "Pi,E\ "
See your favorite math book.
.RE
.PP
.RS
functions:
.RE
.RSs
.IPs max(a,b),min(a,b)
maximum / minimum
.IPs gt(a,b)
is 1 if a>b, 0 otherwise
.IPs lt(a,b)
is 1 if a<b, 0 otherwise
.IPs eq(a,b)
is 1 if a==b, 0 otherwise
.IPs "sin, cos, tan, sinh, cosh, tanh, exp, log, abs"
.RE
.
.TP
.B vrc_override=<options>
User specified quality for specific parts (ending, credits, ...).
The options are <start-frame>, <end-frame>, <quality>[/<start-frame>,
<end-frame>, <quality>[/...]]:
.PD 0
.RSs
.IPs "quality (2\-31)"
quantizer
.IPs "quality (\-500\-0)"
quality correction in %
.RE
.PD 1
.
.TP
.B vrc_init_cplx=<0\-1000>
initial complexity (pass 1)
.
.TP
.B vrc_init_occupancy=<0.0\-1.0>
initial buffer occupancy, as a fraction of vrc_buf_size (default: 0.9)
.
.TP
.B vqsquish=<0|1>
Specify how to keep the quantizer between qmin and qmax.
.PD 0
.RSs
.IPs 0
Use clipping.
.IPs 1
Use a nice differentiable function (default).
.RE
.PD 1
.
.TP
.B vlelim=<\-1000\-1000>
Sets single coefficient elimination threshold for luminance.
Negative values will also consider the DC coefficient (should be at least \-4
or lower for encoding at quant=1):
.PD 0
.RSs
.IPs 0
disabled (default)
.IPs \-4
JVT recommendation
.RE
.PD 1
.
.TP
.B vcelim=<\-1000\-1000>
Sets single coefficient elimination threshold for chrominance.
Negative values will also consider the DC coefficient (should be at least \-4
or lower for encoding at quant=1):
.PD 0
.RSs
.IPs 0
disabled (default)
.IPs 7
JVT recommendation
.RE
.PD 1
.
.TP
.B vstrict=<\-2|\-1|0|1>
strict standard compliance
.PD 0
.RSs
.IPs 0
disabled
.IPs 1
Only recommended if you want to feed the output into the
MPEG-4 reference decoder.
.IPs \-1
Allow libavcodec specific extensions (default).
.IPs \-2
Enables experimental codecs and features which may not be playable
with future MPlayer versions (snow).
.RE
.PD 1
.
.TP
.B "vdpart\ "
Data partitioning.
Adds 2 Bytes per video packet, improves error-resistance when transferring over
unreliable channels (e.g.\& streaming over the internet).
Each video packet will be encoded in 3 separate partitions:
.PD 0
.RSs
.IPs "1. MVs"
movement
.IPs "2. DC coefficients"
low res picture
.IPs "3. AC coefficients"
details
.RE
.PD 1
.RS
MV & DC are most important, losing them looks far worse than losing
the AC and the 1. & 2. partition.
(MV & DC) are far smaller than the 3. partition (AC) meaning that errors
will hit the AC partition much more often than the MV & DC partitions.
Thus, the picture will look better with partitioning than without,
as without partitioning an error will trash AC/\:DC/\:MV equally.
.RE
.
.TP
.B vpsize=<0\-10000> (also see vdpart)
Video packet size, improves error-resistance.
.PD 0
.RSs
.IPs "0\ \ \ \ "
disabled (default)
.IPs 100\-1000
good choice
.RE
.PD 1
.
.TP
.B "ss\ \ \ \ \ "
slice structured mode for H.263+
.
.TP
.B "gray\ \ \ "
grayscale only encoding (faster)
.
.TP
.B vfdct=<0\-10>
DCT algorithm
.PD 0
.RSs
.IPs 0
Automatically select a good one (default).
.IPs 1
fast integer
.IPs 2
accurate integer
.IPs 3
MMX
.IPs 4
mlib
.IPs 5
AltiVec
.IPs 6
floating point AAN
.RE
.PD 1
.
.TP
.B idct=<0\-99>
IDCT algorithm
.br
.I NOTE:
To the best of our knowledge all these IDCTs do pass the IEEE1180 tests.
.PD 0
.RSs
.IPs 0
Automatically select a good one (default).
.IPs 1
JPEG reference integer
.IPs 2
simple
.IPs 3
simplemmx
.IPs 4
libmpeg2mmx (inaccurate, do not use for encoding with keyint >100)
.IPs 5
ps2
.IPs 6
mlib
.IPs 7
arm
.IPs 8
AltiVec
.IPs 9
sh4
.IPs 10
simplearm
.IPs 11
H.264
.IPs 12
VP3
.IPs 13
IPP
.IPs 14
xvidmmx
.IPs 15
CAVS
.IPs 16
simplearmv5te
.IPs 17
simplearmv6
.RE
.PD 1
.
.TP
.B lumi_mask=<0.0\-1.0>
Luminance masking is a 'psychosensory' setting that is supposed to
make use of the fact that the human eye tends to notice fewer details
in very bright parts of the picture.
Luminance masking compresses bright areas stronger than medium ones,
so it will save bits that can be spent again on other frames, raising
overall subjective quality, while possibly reducing PSNR.
.br
.I WARNING:
Be careful, overly large values can cause disastrous things.
.br
.I WARNING:
Large values might look good on some monitors but may look horrible
on other monitors.
.PD 0
.RSs
.IPs "0.0\ \ "
disabled (default)
.IPs 0.0\-0.3
sane range
.RE
.PD 1
.
.TP
.B dark_mask=<0.0\-1.0>
Darkness masking is a 'psychosensory' setting that is supposed to
make use of the fact that the human eye tends to notice fewer details
in very dark parts of the picture.
Darkness masking compresses dark areas stronger than medium ones,
so it will save bits that can be spent again on other frames, raising
overall subjective quality, while possibly reducing PSNR.
.br
.I WARNING:
Be careful, overly large values can cause disastrous things.
.br
.I WARNING:
Large values might look good on some monitors but may look horrible
on other monitors / TV / TFT.
.PD 0
.RSs
.IPs "0.0\ \ "
disabled (default)
.IPs 0.0\-0.3
sane range
.RE
.PD 1
.
.TP
.B tcplx_mask=<0.0\-1.0>
Temporal complexity masking (default: 0.0 (disabled)).
Imagine a scene with a bird flying across the whole scene; tcplx_mask
will raise the quantizers of the bird's macroblocks (thus decreasing their
quality), as the human eye usually does not have time to see all the bird's
details.
Be warned that if the masked object stops (e.g.\& the bird lands) it is
likely to look horrible for a short period of time, until the encoder
figures out that the object is not moving and needs refined blocks.
The saved bits will be spent on other parts of the video, which may increase
subjective quality, provided that tcplx_mask is carefully chosen.
.
.TP
.B scplx_mask=<0.0\-1.0>
Spatial complexity masking.
Larger values help against blockiness, if no deblocking filter is used for
decoding, which is maybe not a good idea.
.br
Imagine a scene with grass (which usually has great spatial complexity),
a blue sky and a house; scplx_mask will raise the quantizers of the grass'
macroblocks, thus decreasing its quality, in order to spend more bits on
the sky and the house.
.br
.I HINT:
Crop any black borders completely as they will reduce the quality
of the macroblocks (also applies without scplx_mask).
.PD 0
.RSs
.IPs "0.0\ \ "
disabled (default)
.IPs 0.0\-0.5
sane range
.RE
.PD 1
.sp 1
.RS
.I NOTE:
This setting does not have the same effect as using a custom matrix that
would compress high frequencies harder, as scplx_mask will reduce the
quality of P blocks even if only DC is changing.
The result of scplx_mask will probably not look as good.
.RE
.
.TP
.B p_mask=<0.0\-1.0> (also see vi_qfactor)
Reduces the quality of inter blocks.
This is equivalent to increasing the quality of intra blocks, because the
same average bitrate will be distributed by the rate controller to the
whole video sequence (default: 0.0 (disabled)).
p_mask=1.0 doubles the bits allocated to each intra block.
.
.TP
.B border_mask=<0.0\-1.0>
border-processing for MPEG-style encoders.
Border processing increases the quantizer for macroblocks which are less
than 1/5th of the frame width/height away from the frame border,
since they are often visually less important.
.
.TP
.B "naq\ \ \ \ "
Normalize adaptive quantization (experimental).
When using adaptive quantization (*_mask), the average per-MB quantizer may no
longer match the requested frame-level quantizer.
Naq will attempt to adjust the per-MB quantizers to maintain the proper
average.
.
.TP
.B "ildct\ \ "
Use interlaced DCT.
.
.TP
.B "ilme\ \ \ "
Use interlaced motion estimation (mutually exclusive with qpel).
.
.TP
.B "alt\ \ \ \ "
Use alternative scantable.
.
.TP
.B "top=<\-1\-1>\ \ \ "
.PD 0
.RSs
.IPs \-1
automatic
.IPs 0
bottom field first
.IPs 1
top field first
.RE
.PD 1
.
.TP
.B format=<value>
.PD 0
.RSs
.IPs "YV12\ "
default
.IPs "444P\ "
for ffv1
.IPs "422P\ "
for HuffYUV, lossless JPEG, dv and ffv1
.IPs "411P\ "
for lossless JPEG, dv and ffv1
.IPs "YVU9\ "
for lossless JPEG, ffv1 and svq1
.IPs "BGR32"
for lossless JPEG and ffv1
.RE
.PD 1
.
.TP
.B "pred\ \ \ "
(for HuffYUV)
.PD 0
.RSs
.IPs 0
left prediction
.IPs 1
plane/\:gradient prediction
.IPs 2
median prediction
.RE
.PD 1
.
.TP
.B "pred\ \ \ "
(for lossless JPEG)
.PD 0
.RSs
.IPs 0
left prediction
.IPs 1
top prediction
.IPs 2
topleft prediction
.IPs 3
plane/\:gradient prediction
.IPs 6
mean prediction
.RE
.PD 1
.
.TP
.B "coder\ \ "
(for ffv1)
.PD 0
.RSs
.IPs 0
vlc coding (Golomb-Rice)
.IPs 1
arithmetic coding (CABAC)
.RE
.PD 1
.
.TP
.B context
(for ffv1)
.PD 0
.RSs
.IPs 0
small context model
.IPs 1
large context model
.RE
.PD 1
.sp 1
.RS
(for ffvhuff)
.RE
.PD 0
.RSs
.IPs 0
predetermined Huffman tables (builtin or two pass)
.IPs 1
adaptive Huffman tables
.RE
.PD 1
.
.TP
.B "qpel\ \ \ "
Use quarter pel motion compensation (mutually exclusive with ilme).
.br
.I HINT:
This seems only useful for high bitrate encodings.
.
.TP
.B mbcmp=<0\-2000>
Sets the comparison function for the macroblock decision, has only
an effect if mbd=0.
This is also used for some motion search functions, in which case
it has an effect regardless of mbd setting.
.PD 0
.RSs
.IPs "0 (SAD)"
sum of absolute differences, fast (default)
.IPs "1 (SSE)"
sum of squared errors
.IPs "2 (SATD)"
sum of absolute Hadamard transformed differences
.IPs "3 (DCT)"
sum of absolute DCT transformed differences
.IPs "4 (PSNR)"
sum of squared quantization errors (avoid, low quality)
.IPs "5 (BIT)"
number of bits needed for the block
.IPs "6 (RD)"
rate distortion optimal, slow
.IPs "7 (ZERO)"
0
.IPs "8 (VSAD)"
sum of absolute vertical differences
.IPs "9 (VSSE)"
sum of squared vertical differences
.IPs "10 (NSSE)"
noise preserving sum of squared differences
.IPs "11 (W53)"
5/3 wavelet, only used in snow
.IPs "12 (W97)"
9/7 wavelet, only used in snow
.IPs "+256\ "
Also use chroma, currently does not work (correctly) with B-frames.
.RE
.PD 1
.
.TP
.B ildctcmp=<0\-2000>
Sets the comparison function for interlaced DCT decision
(see mbcmp for available comparison functions).
.
.TP
.B precmp=<0\-2000>
Sets the comparison function for motion estimation pre pass
(see mbcmp for available comparison functions) (default: 0).
.
.TP
.B cmp=<0\-2000>
Sets the comparison function for full pel motion estimation
(see mbcmp for available comparison functions) (default: 0).
.
.TP
.B subcmp=<0\-2000>
Sets the comparison function for sub pel motion estimation
(see mbcmp for available comparison functions) (default: 0).
.
.TP
.B skipcmp=<0\-2000>
FIXME: Document this.
.
.TP
.B nssew=<0\-1000000>
This setting controls NSSE weight, where larger weights will result in
more noise.
0 NSSE is identical to SSE
You may find this useful if you prefer to keep some noise in your encoded
video rather than filtering it away before encoding (default: 8).
.
.TP
.B predia=<\-99\-6>
diamond type and size for motion estimation pre-pass
.
.TP
.B dia=<\-99\-6>
Diamond type & size for motion estimation.
Motion search is an iterative process.
Using a small diamond does not limit the search to finding only small
motion vectors.
It is just somewhat more likely to stop before finding the very best motion
vector, especially when noise is involved.
Bigger diamonds allow a wider search for the best motion vector, thus are
slower but result in better quality.
.br
Big normal diamonds are better quality than shape-adaptive diamonds.
.br
Shape-adaptive diamonds are a good tradeoff between speed and quality.
.br
.I NOTE:
The sizes of the normal diamonds and shape adaptive ones do not have
the same meaning.
.RSs
.IPs \-3
shape adaptive (fast) diamond with size 3
.IPs \-2
shape adaptive (fast) diamond with size 2
.IPs \-1
uneven multi-hexagon search (slow)
.IPs  1
normal size=1 diamond (default) =EPZS type diamond
.nf
.ne
      0
     000
      0
.fi
.IPs 2
normal size=2 diamond
.nf
.ne
      0
     000
    00000
     000
      0
.fi
.RE
.
.TP
.B "trell\ \ "
Trellis searched quantization.
This will find the optimal encoding for each 8x8 block.
Trellis searched quantization is quite simply an optimal quantization in
the PSNR versus bitrate sense (Assuming that there would be no rounding
errors introduced by the IDCT, which is obviously not the case.).
It simply finds a block for the minimum of error and lambda*bits.
.PD 0
.RSs
.IPs lambda
quantization parameter (QP) dependent constant
.IPs "bits\ "
amount of bits needed to encode the block
.IPs error
sum of squared errors of the quantization
.RE
.PD 1
.
.TP
.B "cbp\ \ \ \ "
Rate distorted optimal coded block pattern.
Will select the coded block pattern which minimizes distortion + lambda*rate.
This can only be used together with trellis quantization.
.
.TP
.B "mv0\ \ \ \ "
Try to encode each MB with MV=<0,0> and choose the better one.
This has no effect if mbd=0.
.
.TP
.B mv0_threshold=<any non-negative integer>
When surrounding motion vectors are <0,0> and the motion estimation
score of the current block is less than mv0_threshold, <0,0> is used for
the motion vector and further motion estimation is skipped (default:
256).
Lowering mv0_threshold to 0 can give a slight (0.01dB) PSNR increase and
possibly make the encoded video look slightly better; raising
mv0_threshold past 320 results in diminished PSNR and visual quality.
Higher values speed up encoding very slightly (usually less than 1%,
depending on the other options used).
.br
.I NOTE:
This option does not require mv0 to be enabled.
.
.TP
.B qprd (mbd=2 only)
rate distorted optimal quantization parameter (QP) for the given
lambda of each macroblock
.
.TP
.B last_pred=<0\-99>
amount of motion predictors from the previous frame
.PD 0
.RSs
.IPs 0
(default)
.IPs a
Will use 2a+1 x 2a+1 macroblock square of motion vector predictors from the
previous frame.
.RE
.PD 1
.
.TP
.B preme=<0\-2>
motion estimation pre-pass
.PD 0
.RSs
.IPs 0
disabled
.IPs 1
only after I-frames (default)
.IPs 2
always
.RE
.PD 1
.
.TP
.B subq=<1\-8>
subpel refinement quality (for qpel) (default: 8 (high quality))
.br
.I NOTE:
This has a significant effect on speed.
.
.TP
.B refs=<1\-8>
number of reference frames to consider for motion compensation
(Snow only) (default: 1)
.
.TP
.B "psnr\ \ \ "
print the PSNR (peak signal to noise ratio) for the whole video after encoding
and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
Returned values are in dB (decibel), the higher the better.
.
.TP
.B mpeg_quant
Use MPEG quantizers instead of H.263.
.
.TP
.B "aic\ \ \ \ "
Enable AC prediction for MPEG-4 or advanced intra prediction for H.263+.
This will improve quality very slightly (around 0.02 dB PSNR) and slow
down encoding very slightly (about 1%).
.br
.I NOTE:
vqmin should be 8 or larger for H.263+ AIC.
.
.TP
.B "aiv\ \ \ \ "
alternative inter vlc for H.263+
.
.TP
.B "umv\ \ \ \ "
unlimited MVs (H.263+ only)
Allows encoding of arbitrarily long MVs.
.
.TP
.B ibias=<\-256\-256>
intra quantizer bias (256 equals 1.0, MPEG style quantizer default: 96,
H.263 style quantizer default: 0)
.br
.I NOTE:
The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
.
.TP
.B pbias=<\-256\-256>
inter quantizer bias (256 equals 1.0, MPEG style quantizer default: 0,
H.263 style quantizer default: \-64)
.br
.I NOTE:
The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
.br
.I HINT:
A more positive bias (\-32 \- \-16 instead of \-64) seems to improve the PSNR.
.
.TP
.B nr=<0\-100000>
Noise reduction, 0 means disabled.
0\-600 is a useful range for typical content, but you may want to turn it
up a bit more for very noisy content (default: 0).
Given its small impact on speed, you might want to prefer to use this over
filtering noise away with video filters like denoise3d or hqdn3d.
.
.TP
.B qns=<0\-3>
Quantizer noise shaping.
Rather than choosing quantization to most closely match the source video
in the PSNR sense, it chooses quantization such that noise (usually ringing)
will be masked by similar-frequency content in the image.
Larger values are slower but may not result in better quality.
This can and should be used together with trellis quantization, in which case
the trellis quantization (optimal for constant weight) will be used as
startpoint for the iterative search.
.PD 0
.RSs
.IPs 0
disabled (default)
.IPs 1
Only lower the absolute value of coefficients.
.IPs 2
Only change coefficients before the last non-zero coefficient + 1.
.IPs 3
Try all.
.RE
.PD 1
.
.TP
.B inter_matrix=<comma separated matrix>
Use custom inter matrix.
It needs a comma separated string of 64 integers.
.
.TP
.B intra_matrix=<comma separated matrix>
Use custom intra matrix.
It needs a comma separated string of 64 integers.
.
.TP
.B vqmod_amp
experimental quantizer modulation
.
.TP
.B vqmod_freq
experimental quantizer modulation
.
.TP
.B "dc\ \ \ \ \ "
intra DC precision in bits (default: 8).
If you specify vcodec=mpeg2video this value can be 8, 9, 10 or 11.
.
.TP
.B cgop (also see sc_threshold)
Close all GOPs.
Currently it only works if scene change detection is disabled
(sc_threshold=1000000000).
.
.TP
.B "gmc\ \ \ \ "
Enable Global Motion Compensation.
.
.TP
.B (no)lowdelay
Sets the low delay flag for MPEG-1/2 (disables B-frames).
.
.TP
.B vglobal=<0\-3>
Control writing global video headers.
.PD 0
.RSs
.IPs 0
Codec decides where to write global headers (default).
.IPs 1
Write global headers only in extradata (needed for .mp4/MOV/NUT).
.IPs 2
Write global headers only in front of keyframes.
.IPs 3
Combine 1 and 2.
.RE
.PD 1
.
.TP
.B aglobal=<0\-3>
Same as vglobal for audio headers.
.
.TP
.B level=<value>
Set CodecContext Level.
Use 31 or 41 to play video on a Playstation 3.
.
.TP
.B skip_exp=<0\-1000000>
FIXME: Document this.
.
.TP
.B skip_factor=<0\-1000000>
FIXME: Document this.
.
.TP
.B skip_threshold=<0\-1000000>
FIXME: Document this.
.
.
.SS nuv (\-nuvopts)
.
Nuppel video is based on RTJPEG and LZO.
By default frames are first encoded with RTJPEG and then compressed with LZO,
but it is possible to disable either or both of the two passes.
As a result, you can in fact output raw i420, LZO compressed i420, RTJPEG,
or the default LZO compressed RTJPEG.
.br
.I NOTE:
The nuvrec documentation contains some advice and examples about the
settings to use for the most common TV encodings.
.
.TP
.B c=<0\-20>
chrominance threshold (default: 1)
.
.TP
.B l=<0\-20>
luminance threshold (default: 1)
.
.TP
.B "lzo\ \ \ \ "
Enable LZO compression (default).
.
.TP
.B "nolzo\ \ "
Disable LZO compression.
.
.TP
.B q=<3\-255>
quality level (default: 255)
.
.TP
.B "raw \ \ \ "
Disable RTJPEG encoding.
.
.TP
.B "rtjpeg\ "
Enable RTJPEG encoding (default).
.
.
.SS xvidenc (\-xvidencopts)
.
There are three modes available: constant bitrate (CBR), fixed quantizer and
two pass.
.
.TP
.B pass=<1|2>
Specify the pass in two pass mode.
.
.TP
.B turbo (two pass only)
Dramatically speeds up pass one using faster algorithms and disabling
CPU-intensive options.
This will probably reduce global PSNR a little bit and change individual
frame type and PSNR a little bit more.
.
.TP
.B bitrate=<value> (CBR or two pass mode)
Sets the bitrate to be used in kbits/\:second if <16000 or in bits/\:second
if >16000.
If <value> is negative, Xvid will use its absolute value as the target size
(in kBytes) of the video and compute the associated bitrate automagically
(default: 687 kbits/s).
.
.TP
.B fixed_quant=<1\-31>
Switch to fixed quantizer mode and specify the quantizer to be used.
.
.TP
.B zones=<zone0>[/<zone1>[/...]] (CBR or two pass mode)
User specified quality for specific parts (ending, credits, ...).
Each zone is <start-frame>,<mode>,<value> where <mode> may be
.PD 0
.RSs
.IPs "q"
Constant quantizer override, where value=<2.0\-31.0>
represents the quantizer value.
.IPs "w"
Ratecontrol weight override, where value=<0.01\-2.00>
represents the quality correction in %.
.RE
.PD 1
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs zones=90000,q,20
Encodes all frames starting with frame 90000 at constant quantizer 20.
.IPs zones=0,w,0.1/10001,w,1.0/90000,q,20
Encode frames 0\-10000 at 10% bitrate, encode frames 90000
up to the end at constant quantizer 20.
Note that the second zone is needed to delimit the first zone, as
without it everything up until frame 89999 would be encoded at 10%
bitrate.
.RE
.PD 1
.
.TP
.B me_quality=<0\-6>
This option controls the motion estimation subsystem.
The higher the value, the more precise the estimation should be (default: 6).
The more precise the motion estimation is, the more bits can be saved.
Precision is gained at the expense of CPU time so decrease this setting if
you need realtime encoding.
.
.TP
.B (no)qpel
MPEG-4 uses a half pixel precision for its motion search by default.
The standard proposes a mode where encoders are allowed to use quarter
pixel precision.
This option usually results in a sharper image.
Unfortunately it has a great impact on bitrate and sometimes the
higher bitrate use will prevent it from giving a better image
quality at a fixed bitrate.
It is better to test with and without this option and see whether it
is worth activating.
.
.TP
.B (no)gmc
Enable Global Motion Compensation, which makes Xvid generate special
frames (GMC-frames) which are well suited for Pan/\:Zoom/\:Rotating images.
Whether or not the use of this option will save bits is highly
dependent on the source material.
.
.TP
.B (no)trellis
Trellis Quantization is a kind of adaptive quantization method that
saves bits by modifying quantized coefficients to make them more
compressible by the entropy encoder.
Its impact on quality is good, and if VHQ uses too much CPU for you,
this setting can be a good alternative to save a few bits (and gain
quality at fixed bitrate) at a lesser cost than with VHQ (default: on).
.
.TP
.B (no)cartoon
Activate this if your encoded sequence is an anime/\:cartoon.
It modifies some Xvid internal thresholds so Xvid takes better decisions on
frame types and motion vectors for flat looking cartoons.
.
.TP
.B (no)chroma_me
The usual motion estimation algorithm uses only the luminance information to
find the best motion vector.
However for some video material, using the chroma planes can help find
better vectors.
This setting toggles the use of chroma planes for motion estimation
(default: on).
.
.TP
.B (no)chroma_opt
Enable a chroma optimizer prefilter.
It will do some extra magic on color information to minimize the
stepped-stairs effect on edges.
It will improve quality at the cost of encoding speed.
It reduces PSNR by nature, as the mathematical deviation to the original
picture will get bigger, but the subjective image quality will raise.
Since it works with color information, you might want to turn it off when
encoding in grayscale.
.
.TP
.B (no)hq_ac
Activates high-quality prediction of AC coefficients for intra frames from
neighbor blocks (default: on).
.
.TP
.B vhq=<0\-4>
The motion search algorithm is based on a search in the usual color domain
and tries to find a motion vector that minimizes the difference between the
reference frame and the encoded frame.
With this setting activated, Xvid will also use the frequency domain (DCT)
to search for a motion vector that minimizes not only the spatial
difference but also the encoding length of the block.
Fastest to slowest:
.PD 0
.RSs
.IPs 0
off
.IPs 1
mode decision (inter/\:intra MB) (default)
.IPs 2
limited search
.IPs 3
medium search
.IPs 4
wide search
.RE
.PD 1
.
.TP
.B (no)lumi_mask
Adaptive quantization allows the macroblock quantizers to vary inside
each frame.
This is a 'psychosensory' setting that is supposed to make use of the
fact that the human eye tends to notice fewer details in very bright
and very dark parts of the picture.
It compresses those areas more strongly than medium ones, which will
save bits that can be spent again on other frames, raising overall
subjective quality and possibly reducing PSNR.
.
.TP
.B (no)grayscale
Make Xvid discard chroma planes so the encoded video is grayscale only.
Note that this does not speed up encoding, it just prevents chroma data
from being written in the last stage of encoding.
.
.TP
.B (no)interlacing
Encode the fields of interlaced video material.
Turn this option on for interlaced content.
.br
.I NOTE:
Should you rescale the video, you would need an interlace-aware resizer,
which you can activate with \-vf scale=<width>:<height>:1.
.
.TP
.B min_iquant=<0\-31>
minimum I-frame quantizer (default: 2)
.
.TP
.B max_iquant=<0\-31>
maximum I-frame quantizer (default: 31)
.
.TP
.B min_pquant=<0\-31>
minimum P-frame quantizer (default: 2)
.
.TP
.B max_pquant=<0\-31>
maximum P-frame quantizer (default: 31)
.
.TP
.B min_bquant=<0\-31>
minimum B-frame quantizer (default: 2)
.
.TP
.B max_bquant=<0\-31>
maximum B-frame quantizer (default: 31)
.
.TP
.B min_key_interval=<value> (two pass only)
minimum interval between keyframes (default: 0)
.
.TP
.B max_key_interval=<value>
maximum interval between keyframes (default: 10*fps)
.
.TP
.B quant_type=<h263|mpeg>
Sets the type of quantizer to use.
For high bitrates, you will find that MPEG quantization preserves more detail.
For low bitrates, the smoothing of H.263 will give you less block noise.
When using custom matrices, MPEG quantization
.B must
be used.
.
.TP
.B quant_intra_matrix=<filename>
Load a custom intra matrix file.
You can build such a file with xvid4conf's matrix editor.
.
.TP
.B quant_inter_matrix=<filename>
Load a custom inter matrix file.
You can build such a file with xvid4conf's matrix editor.
.
.TP
.B keyframe_boost=<0\-1000> (two pass mode only)
Shift some bits from the pool for other frame types to intra frames,
thus improving keyframe quality.
This amount is an extra percentage, so a value of 10 will give
your keyframes 10% more bits than normal
(default: 0).
.
.TP
.B kfthreshold=<value> (two pass mode only)
Works together with kfreduction.
Determines the minimum distance below which you consider that
two frames are considered consecutive and treated differently
according to kfreduction
(default: 10).
.
.TP
.B kfreduction=<0\-100> (two pass mode only)
The above two settings can be used to adjust the size of keyframes that
you consider too close to the first (in a row).
kfthreshold sets the range in which keyframes are reduced, and
kfreduction determines the bitrate reduction they get.
The last I-frame will get treated normally
(default: 30).
.
.TP
.B max_bframes=<0\-4>
Maximum number of B-frames to put between I/P-frames (default: 2).
.
.TP
.B bquant_ratio=<0\-1000>
quantizer ratio between B- and non-B-frames, 150=1.50 (default: 150)
.
.TP
.B bquant_offset=<\-1000\-1000>
quantizer offset between B- and non-B-frames, 100=1.00 (default: 100)
.
.TP
.B bf_threshold=<\-255\-255>
This setting allows you to specify what priority to place on the use of
B-frames.
The higher the value, the higher the probability of B-frames being used
(default: 0).
Do not forget that B-frames usually have a higher quantizer, and therefore
aggressive production of B-frames may cause worse visual quality.
.
.TP
.B (no)closed_gop
This option tells Xvid to close every GOP (Group Of Pictures bounded
by two I-frames), which makes GOPs independent from each other.
This just implies that the last frame of the GOP is either a P-frame or a
N-frame but not a B-frame.
It is usually a good idea to turn this option on (default: on).
.
.TP
.B (no)packed
This option is meant to solve frame-order issues when encoding to
container formats like AVI that cannot cope with out-of-order frames.
In practice, most decoders (both software and hardware) are able to deal
with frame-order themselves, and may get confused when this option is
turned on, so you can safely leave if off, unless you really know what
you are doing.
.br
.I WARNING:
This will generate an illegal bitstream, and will not be
decodable by ISO-MPEG-4 decoders except DivX/\:libavcodec/\:Xvid.
.br
.I WARNING:
This will also store a fake DivX version in the file so the bug
autodetection of some decoders might be confused.
.
.TP
.B frame_drop_ratio=<0\-100> (max_bframes=0 only)
This setting allows the creation of variable framerate video streams.
The value of the setting specifies a threshold under which, if the
difference of the following frame to the previous frame is below or equal
to this threshold, a frame gets not coded (a so called n-vop is placed
in the stream).
On playback, when reaching an n-vop the previous frame will be displayed.
.br
.I WARNING:
Playing with this setting may result in a jerky video, so use it at your
own risks!
.
.TP
.B rc_reaction_delay_factor=<value>
This parameter controls the number of frames the CBR rate controller
will wait before reacting to bitrate changes and compensating for them
to obtain a constant bitrate over an averaging range of frames.
.
.TP
.B rc_averaging_period=<value>
Real CBR is hard to achieve.
Depending on the video material, bitrate can be variable, and hard to predict.
Therefore Xvid uses an averaging period for which it guarantees a given
amount of bits (minus a small variation).
This settings expresses the "number of frames" for which Xvid averages
bitrate and tries to achieve CBR.
.
.TP
.B rc_buffer=<value>
size of the rate control buffer
.
.TP
.B curve_compression_high=<0\-100>
This setting allows Xvid to take a certain percentage of bits away from
high bitrate scenes and give them back to the bit reservoir.
You could also use this if you have a clip with so many bits allocated
to high-bitrate scenes that the low(er)-bitrate scenes start to look bad
(default: 0).
.
.TP
.B curve_compression_low=<0\-100>
This setting allows Xvid to give a certain percentage of extra bits to the
low bitrate scenes, taking a few bits from the entire clip.
This might come in handy if you have a few low-bitrate scenes that are
still blocky (default: 0).
.
.TP
.B overflow_control_strength=<0\-100>
During pass one of two pass encoding, a scaled bitrate curve is computed.
The difference between that expected curve and the result obtained during
encoding is called overflow.
Obviously, the two pass rate controller tries to compensate for that overflow,
distributing it over the next frames.
This setting controls how much of the overflow is distributed every time
there is a new frame.
Low values allow lazy overflow control, big rate bursts are compensated for
more slowly (could lead to lack of precision for small clips).
Higher values will make changes in bit redistribution more abrupt, possibly
too abrupt if you set it too high, creating artifacts (default: 5).
.br
.I NOTE:
This setting impacts quality a lot, play with it carefully!
.
.TP
.B max_overflow_improvement=<0\-100>
During the frame bit allocation, overflow control may increase the frame
size.
This parameter specifies the maximum percentage by which the overflow
control is allowed to increase the frame size, compared to the ideal curve
allocation
(default: 5).
.
.TP
.B max_overflow_degradation=<0\-100>
During the frame bit allocation, overflow control may decrease the frame
size.
This parameter specifies the maximum percentage by which the overflow
control is allowed to decrease the frame size, compared to the ideal curve
allocation
(default: 5).
.
.TP
.B container_frame_overhead=<0...>
Specifies a frame average overhead per frame, in bytes.
Most of the time users express their target bitrate for video w/o taking
care of the video container overhead.
This small but (mostly) constant overhead can cause the target file size
to be exceeded.
Xvid allows users to set the amount of overhead per frame the
container generates (give only an average per frame).
0 has a special meaning, it lets Xvid use its own default values
(default: 24 \- AVI average overhead).
.
.TP
.B profile=<profile_name>
Restricts options and VBV (peak bitrate over a short period) according to
the Simple, Advanced Simple and DivX profiles.
The resulting videos should be playable on standalone players adhering to these
profile specifications.
.PD 0
.RSs
.IPs unrestricted
no restrictions (default)
.IPs "sp0\ \ "
simple profile at level 0
.IPs "sp1\ \ "
simple profile at level 1
.IPs "sp2\ \ "
simple profile at level 2
.IPs "sp3\ \ "
simple profile at level 3
.IPs "asp0\ "
advanced simple profile at level 0
.IPs "asp1\ "
advanced simple profile at level 1
.IPs "asp2\ "
advanced simple profile at level 2
.IPs "asp3\ "
advanced simple profile at level 3
.IPs "asp4\ "
advanced simple profile at level 4
.IPs "asp5\ "
advanced simple profile at level 5
.IPs dxnhandheld
DXN handheld profile
.IPs dxnportntsc
DXN portable NTSC profile
.IPs dxnportpal
DXN portable PAL profile
.IPs dxnhtntsc
DXN home theater NTSC profile
.IPs dxnhtpal
DXN home theater PAL profile
.IPs dxnhdtv
DXN HDTV profile
.RE
.PD 1
.RS
.I NOTE:
These profiles should be used in conjunction with an appropriate \-ffourcc.
Generally DX50 is applicable, as some players do not recognize Xvid but
most recognize DivX.
.RE
.
.TP
.B par=<mode>
Specifies the Pixel Aspect Ratio mode (not to be confused with DAR,
the Display Aspect Ratio).
PAR is the ratio of the width and height of a single pixel.
So both are related like this: DAR = PAR * (width/height).
.br
MPEG-4 defines 5 pixel aspect ratios and one extended
one, giving the opportunity to specify a specific pixel aspect
ratio.
5 standard modes can be specified:
.PD 0
.RSs
.IPs vga11
It is the usual PAR for PC content.
Pixels are a square unit.
.IPs pal43
PAL standard 4:3 PAR.
Pixels are rectangles.
.IPs pal169
same as above
.IPs ntsc43
same as above
.IPs ntsc169
same as above (Do not forget to give the exact ratio.)
.IPs "ext\ \ "
Allows you to specify your own pixel aspect ratio with par_width and
par_height.
.RE
.PD 1
.RS
.I NOTE:
In general, setting aspect and autoaspect options is enough.
.RE
.
.TP
.B par_width=<1\-255> (par=ext only)
Specifies the width of the custom pixel aspect ratio.
.
.TP
.B par_height=<1\-255> (par=ext only)
Specifies the height of the custom pixel aspect ratio.
.
.TP
.B aspect=<x/y | f (float value)>
Store movie aspect internally, just like MPEG files.
Much nicer solution than rescaling, because quality is not decreased.
MPlayer and a few others players will play these files correctly, others
will display them with the wrong aspect.
The aspect parameter can be given as a ratio or a floating point number.
.
.TP
.B (no)autoaspect
Same as the aspect option, but automatically computes aspect, taking
into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
filter chain.
.
.TP
.B "psnr\ \ \ "
Print the PSNR (peak signal to noise ratio) for the whole video after encoding
and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
the current directory.
Returned values are in dB (decibel), the higher the better.
.
.TP
.B "debug\ \ "
Save per-frame statistics in ./xvid.dbg. (This is not the two pass control
file.)
.RE
.
.PP
.sp 1
The following option is only available in Xvid 1.1.x.
.
.TP
.B bvhq=<0|1>
This setting allows vector candidates for B-frames to be used for
the encoding chosen using a rate distortion optimized operator,
which is what is done for P-frames by the vhq option.
This produces nicer-looking B-frames while incurring almost no
performance penalty (default: 1).
.
.PP
.sp 1
The following option is only available in the 1.2.x version of Xvid.
.
.TP
.B threads=<0\-n>
Create n threads to run the motion estimation (default: 0).
The maximum number of threads that can be used is the picture height
divided by 16.
.
.
.SS x264enc (\-x264encopts)
.
.TP
.B bitrate=<value>
Sets the average bitrate to be used in kbits/\:second (default: off).
Since local bitrate may vary, this average may be inaccurate for
very short videos (see ratetol).
Constant bitrate can be achieved by combining this with vbv_maxrate,
at significant reduction in quality.
.
.TP
.B qp=<0\-51>
This selects the quantizer to use for P-frames.
I- and B-frames are offset from this value by ip_factor and pb_factor, respectively.
20\-40 is a useful range.
Lower values result in better fidelity, but higher bitrates.
0 is lossless.
Note that quantization in H.264 works differently from MPEG-1/2/4:
H.264's quantization parameter (QP) is on a logarithmic scale.
The mapping is approximately H264QP = 12 + 6*log2(MPEGQP).
For example, MPEG at QP=2 is equivalent to H.264 at QP=18.
.
.TP
.B crf=<1.0\-50.0>
Enables constant quality mode, and selects the quality.
The scale is similar to QP.
Like the bitrate-based modes, this allows each frame to use a
different QP based on the frame's complexity.
.
.TP
.B pass=<1\-3>
Enable 2 or 3-pass mode.
It is recommended to always encode in 2 or 3-pass mode as it leads to a
better bit distribution and improves overall quality.
.PD 0
.RSs
.IPs 1
first pass
.IPs 2
second pass (of two pass encoding)
.IPs 3
Nth pass (second and third passes of three pass encoding)
.RE
.RS
Here is how it works, and how to use it:
.br
The first pass (pass=1) collects statistics on the video and writes them
to a file.
You might want to deactivate some CPU-hungry options, apart from the ones
that are on by default.
.br
In two pass mode, the second pass (pass=2) reads the statistics file and
bases ratecontrol decisions on it.
.br
In three pass mode, the second pass (pass=3, that is not a typo)
does both: It first reads the statistics, then overwrites them.
You can use all encoding options, except very CPU-hungry options.
.br
The third pass (pass=3) is the same as the second pass, except that it has
the second pass' statistics to work from.
You can use all encoding options, including CPU-hungry ones.
.br
The first pass may use either average bitrate or constant quantizer.
ABR is recommended, since it does not require guessing a quantizer.
Subsequent passes are ABR, and must specify bitrate.
.REss
.
.TP
.B turbo=<0\-2>
Fast first pass mode.
During the first pass of a two or more pass encode it is possible to gain
speed by disabling some options with negligible or even no impact on the
final pass output quality.
.PD 0
.RSs
.IPs 0
disabled (default)
.IPs 1
Reduce subq, frameref and disable some inter-macroblock partition analysis
modes.
.IPs 2
Reduce subq and frameref to 1, use a diamond ME search and disable all
partition analysis modes.
.RE
.RS
Level 1 can increase first pass speed up to 2x with no change in the global
PSNR of the final pass compared to a full quality first pass.
.br
Level 2 can increase first pass speed up to 4x with about +/\- 0.05dB change
in the global PSNR of the final pass compared to a full quality first pass.
.REss
.
.TP
.B keyint=<value>
Sets maximum interval between IDR-frames (default: 250).
Larger values save bits, thus improve quality, at the cost of seeking
precision.
Unlike MPEG-1/2/4, H.264 does not suffer from DCT drift with large
values of keyint.
.
.TP
.B keyint_min=<1\-keyint/2>
Sets minimum interval between IDR-frames (default: 25).
If scenecuts appear within this interval, they are still encoded as
I-frames, but do not start a new GOP.
In H.264, I-frames do not necessarily bound a closed GOP because it is
allowable for a P-frame to be predicted from more frames than just the one
frame before it (also see frameref).
Therefore, I-frames are not necessarily seekable.
IDR-frames restrict subsequent P-frames from referring to any frame
prior to the IDR-frame.
.
.TP
.B scenecut=<\-1\-100>
Controls how aggressively to insert extra I-frames (default: 40).
With small values of scenecut, the codec often has to force an I-frame
when it would exceed keyint.
Good values of scenecut may find a better location for the I-frame.
Large values use more I-frames than necessary, thus wasting bits.
\-1 disables scene-cut detection, so I-frames are inserted only once
every other keyint frames, even if a scene-cut occurs earlier.
This is not recommended and wastes bitrate as scenecuts encoded as P-frames
are just as big as I-frames, but do not reset the "keyint counter".
.
.TP
.B frameref=<1\-16>
Number of previous frames used as predictors in B- and P-frames (default: 1).
This is effective in anime, but in live-action material the improvements
usually drop off very rapidly above 6 or so reference frames.
This has no effect on decoding speed, but does increase the memory needed for
decoding.
Some decoders can only handle a maximum of 15 reference frames.
.
.TP
.B bframes=<0\-16>
maximum number of consecutive B-frames between I- and P-frames (default: 0)
.
.TP
.B (no)b_adapt
Automatically decides when to use B-frames and how many, up to the maximum
specified above (default: on).
If this option is disabled, then the maximum number of B-frames is used.
.
.TP
.B b_bias=<\-100\-100>
Controls the decision performed by b_adapt.
A higher b_bias produces more B-frames (default: 0).
.
.TP
.B (no)b_pyramid
Allows B-frames to be used as references for predicting other frames.
For example, consider 3 consecutive B-frames: I0 B1 B2 B3 P4.
Without this option, B-frames follow the same pattern as MPEG-[124].
So they are coded in the order I0 P4 B1 B2 B3, and all the B-frames
are predicted from I0 and P4.
With this option, they are coded as I0 P4 B2 B1 B3.
B2 is the same as above, but B1 is predicted from I0 and B2, and
B3 is predicted from B2 and P4.
This usually results in slightly improved compression, at almost no
speed cost.
However, this is an experimental option: it is not fully tuned and
may not always help.
Requires bframes >= 2.
Disadvantage: increases decoding delay to 2 frames.
.
.TP
.B (no)deblock
Use deblocking filter (default: on).
As it takes very little time compared to its quality gain, it is not
recommended to disable it.
.
.TP
.B deblock=<\-6\-6>,<\-6\-6>
The first parameter is AlphaC0 (default: 0).
This adjusts thresholds for the H.264 in-loop deblocking filter.
First, this parameter adjusts the maximum amount of change that the filter is
allowed to cause on any one pixel.
Secondly, this parameter affects the threshold for difference across the
edge being filtered.
A positive value reduces blocking artifacts more, but will also smear details.
.br
The second parameter is Beta (default: 0).
This affects the detail threshold.
Very detailed blocks are not filtered, since the smoothing caused by the
filter would be more noticeable than the original blocking.
.br
The default behavior of the filter almost always achieves optimal quality,
so it is best to either leave it alone, or make only small adjustments.
However, if your source material already has some blocking or noise which
you would like to remove, it may be a good idea to turn it up a little bit.
.
.TP
.B (no)cabac
Use CABAC (Context-Adaptive Binary Arithmetic Coding) (default: on).
Slightly slows down encoding and decoding, but should save 10\-15% bitrate.
Unless you are looking for decoding speed, you should not disable it.
.
.TP
.B qp_min=<1\-51> (ABR or two pass)
Minimum quantizer, 10\-30 seems to be a useful range (default: 10).
.
.TP
.B qp_max=<1\-51> (ABR or two pass)
maximum quantizer (default: 51)
.
.TP
.B qp_step=<1\-50> (ABR or two pass)
maximum value by which the quantizer may be incremented/decremented between
frames (default: 4)
.
.TP
.B ratetol=<0.1\-100.0> (ABR or two pass)
allowed variance in average bitrate (no particular units) (default: 1.0)
.
.TP
.B vbv_maxrate=<value> (ABR or two pass)
maximum local bitrate, in kbits/\:second (default: disabled)
.
.TP
.B vbv_bufsize=<value> (ABR or two pass)
averaging period for vbv_maxrate, in kbits
(default: none, must be specified if vbv_maxrate is enabled)
.
.TP
.B vbv_init=<0.0\-1.0> (ABR or two pass)
initial buffer occupancy, as a fraction of vbv_bufsize (default: 0.9)
.
.TP
.B ip_factor=<value>
quantizer factor between I- and P-frames (default: 1.4)
.
.TP
.B pb_factor=<value>
quantizer factor between P- and B-frames (default: 1.3)
.
.TP
.B qcomp=<0\-1> (ABR or two pass)
quantizer compression (default: 0.6).
A lower value makes the bitrate more constant,
while a higher value makes the quantization parameter more constant.
.
.TP
.B cplx_blur=<0\-999> (two pass only)
Temporal blur of the estimated frame complexity, before curve compression
(default: 20).
Lower values allow the quantizer value to jump around more,
higher values force it to vary more smoothly.
cplx_blur ensures that each I-frame has quality comparable to the following
P-frames, and ensures that alternating high and low complexity frames
(e.g.\& low fps animation) do not waste bits on fluctuating quantizer.
.
.TP
.B qblur=<0\-99> (two pass only)
Temporal blur of the quantization parameter, after curve compression
(default: 0.5).
Lower values allow the quantizer value to jump around more,
higher values force it to vary more smoothly.
.
.TP
.B zones=<zone0>[/<zone1>[/...]]
User specified quality for specific parts (ending, credits, ...).
Each zone is <start-frame>,<end-frame>,<option> where option may be
.PD 0
.RSs
.IPs "q=<0\-51>"
quantizer
.IPs "b=<0.01\-100.0>"
bitrate multiplier
.RE
.PD 1
.RS
.I NOTE:
The quantizer option is not strictly enforced.
It affects only the planning stage of ratecontrol, and is still subject
to overflow compensation and qp_min/qp_max.
.RE
.
.TP
.B direct_pred=<name>
Determines the type of motion prediction used for direct macroblocks
in B-frames.
.PD 0
.RSs
.IPs none
Direct macroblocks are not used.
.IPs spatial
Motion vectors are extrapolated from neighboring blocks.
(default)
.IPs temporal
Motion vectors are extrapolated from the following P-frame.
.IPs auto
The codec selects between spatial and temporal for each frame.
.RE
.PD 1
.RS
Spatial and temporal are approximately the same speed and PSNR,
the choice between them depends on the video content.
Auto is slightly better, but slower.
Auto is most effective when combined with multipass.
direct_pred=none is both slower and lower quality.
.RE
.
.TP
.B (no)weight_b
Use weighted prediction in B-frames.
Without this option, bidirectionally predicted macroblocks give
equal weight to each reference frame.
With this option, the weights are determined by the temporal position
of the B-frame relative to the references.
Requires bframes > 1.
.
.TP
.B partitions=<list>
Enable some optional macroblock types (default: p8x8,b8x8,i8x8,i4x4).
.PD 0
.RSs
.IPs p8x8
Enable types p16x8, p8x16, p8x8.
.IPs p4x4
Enable types p8x4, p4x8, p4x4.
p4x4 is recommended only with subq >= 5, and only at low resolutions.
.IPs b8x8
Enable types b16x8, b8x16, b8x8.
.IPs i8x8
Enable type i8x8.
i8x8 has no effect unless 8x8dct is enabled.
.IPs i4x4
Enable type i4x4.
.IPs all
Enable all of the above types.
.IPs none
Disable all of the above types.
.RE
.PD 1
.RS
Regardless of this option, macroblock types p16x16, b16x16, and i16x16
are always enabled.
.br
The idea is to find the type and size that best describe a certain area
of the picture.
For example, a global pan is better represented by 16x16 blocks, while
small moving objects are better represented by smaller blocks.
.RE
.
.TP
.B (no)8x8dct
Adaptive spatial transform size: allows macroblocks to choose between
4x4 and 8x8 DCT.
Also allows the i8x8 macroblock type.
Without this option, only 4x4 DCT is used.
.
.TP
.B me=<name>
Select fullpixel motion estimation algorithm.
.PD 0
.RSs
.IPs dia
diamond search, radius 1 (fast)
.IPs hex
hexagon search, radius 2 (default)
.IPs umh
uneven multi-hexagon search (slow)
.IPs esa
exhaustive search (very slow, and no better than umh)
.RE
.PD 1
.
.TP
.B me_range=<4\-64>
radius of exhaustive or multi-hexagon motion search (default: 16)
.
.TP
.B subq=<0\-9>
Adjust subpel refinement quality.
This parameter controls quality versus speed tradeoffs involved in the motion
estimation decision process.
subq=5 can compress up to 10% better than subq=1.
.PD 0
.RSs
.IPs 0
Runs fullpixel precision motion estimation on all candidate
macroblock types.
Then selects the best type with SAD metric (faster than subq=1, not recommended
unless you're looking for ultra-fast encoding).
.IPs 1
Does as 0, then refines the motion of that type to fast quarterpixel precision
(fast).
.IPs 2
Runs halfpixel precision motion estimation on all candidate macroblock types.
Then selects the best type with SATD metric.
Then refines the motion of that type to fast quarterpixel precision.
.IPs 3
As 2, but uses a slower quarterpixel refinement.
.IPs 4
Runs fast quarterpixel precision motion estimation on all candidate
macroblock types.
Then selects the best type with SATD metric.
Then finishes the quarterpixel refinement for that type.
.IPs 5
Runs best quality quarterpixel precision motion estimation on all
candidate macroblock types, before selecting the best type.
Also refines the two motion vectors used in bidirectional macroblocks with
SATD metric, rather than reusing vectors from the forward and backward
searches.
.IPs 6
Enables rate-distortion optimization of macroblock types in
I- and P-frames (default).
.IPs 7
Enables rate-distortion optimization of macroblock types in all frames.
.IPs 8
Enables rate-distortion optimization of motion vectors and intra prediction modes in I- and P-frames.
.IPs 9
Enables rate-distortion optimization of motion vectors and intra prediction modes in all frames (best).
.RE
.PD 1
.RS
In the above, "all candidates" does not exactly mean all enabled types:
4x4, 4x8, 8x4 are tried only if 8x8 is better than 16x16.
.RE
.
.TP
.B (no)chroma_me
Takes into account chroma information during subpixel motion search
(default: enabled).
Requires subq>=5.
.
.TP
.B (no)mixed_refs
Allows each 8x8 or 16x8 motion partition to independently select a
reference frame.
Without this option, a whole macroblock must use the same reference.
Requires frameref>1.
.
.TP
.B trellis=<0\-2> (cabac only)
rate-distortion optimal quantization
.PD 0
.RSs
.IPs 0
disabled (default)
.IPs 1
enabled only for the final encode
.IPs 2
enabled during all mode decisions (slow, requires subq>=6)
.RE
.PD 1
.
.TP
.B psy-rd=rd[,trell]
Sets the strength of the psychovisual optimization.
.PD 0
.RSs
.IPs rd=<0.0\-10.0>
psy optimization strength (requires subq>=6) (default: 1.0)
.IPs trell=<0.0\-10.0>
trellis (requires trellis, experimental) (default: 0.0)
.RE
.PD 1
.
.
.TP
.B deadzone_inter=<0\-32>
Set the size of the inter luma quantization deadzone for non-trellis
quantization (default: 21).
Lower values help to preserve fine details and film grain (typically useful
for high bitrate/quality encode), while higher values help filter out
these details to save bits that can be spent again on other macroblocks
and frames (typically useful for bitrate-starved encodes).
It is recommended that you start by tweaking deadzone_intra before changing
this parameter.
.
.TP
.B deadzone_intra=<0\-32>
Set the size of the intra luma quantization deadzone for non-trellis
quantization (default: 11).
This option has the same effect as deadzone_inter except that it affects
intra frames.
It is recommended that you start by tweaking this parameter before changing
deadzone_inter.
.
.TP
.B (no)fast_pskip
Performs early skip detection in P-frames (default: enabled).
This usually improves speed at no cost, but it can sometimes produce
artifacts in areas with no details, like sky.
.
.TP
.B (no)dct_decimate
Eliminate dct blocks in P-frames containing only a small single coefficient
(default: enabled).
This will remove some details, so it will save bits that can be spent
again on other frames, hopefully raising overall subjective quality.
If you are compressing non-anime content with a high target bitrate, you
may want to disable this to preserve as much detail as possible.
.
.TP
.B nr=<0\-100000>
Noise reduction, 0 means disabled.
100\-1000 is a useful range for typical content, but you may want to turn it
up a bit more for very noisy content (default: 0).
Given its small impact on speed, you might want to prefer to use this over
filtering noise away with video filters like denoise3d or hqdn3d.
.
.TP
.B chroma_qp_offset=<\-12\-12>
Use a different quantizer for chroma as compared to luma.
Useful values are in the range <\-2\-2> (default: 0).
.
.TP
.B aq_mode=<0\-2>
Defines how adaptive quantization (AQ) distributes bits:
.PD 0
.RSs
.IPs 0
disabled
.IPs 1
Avoid moving bits between frames.
.IPs 2
Move bits between frames (by default).
.RE
.PD 1
.
.TP
.B aq_strength=<positive float value>
Controls how much adaptive quantization (AQ) reduces blocking and blurring
in flat and textured areas (default: 1.0).
A value of 0.5 will lead to weak AQ and less details, when a value of 1.5
will lead to strong AQ and more details.
.
.TP
.B cqm=<flat|jvt|<filename>>
Either uses a predefined custom quantization matrix or loads a JM format
matrix file.
.PD 0
.RSs
.IPs "flat\ "
Use the predefined flat 16 matrix (default).
.IPs "jvt\ \ "
Use the predefined JVT matrix.
.IPs <filename>
Use the provided JM format matrix file.
.PD 1
.RE
.RS
.I NOTE:
Windows CMD.EXE users may experience problems with parsing the command line
if they attempt to use all the CQM lists.
This is due to a command line length limitation.
In this case it is recommended the lists be put into a JM format CQM
file and loaded as specified above.
.RE
.
.TP
.B cqm4iy=<list> (also see cqm)
Custom 4x4 intra luminance matrix, given as a list of 16 comma separated
values in the 1\-255 range.
.
.TP
.B cqm4ic=<list> (also see cqm)
Custom 4x4 intra chrominance matrix, given as a list of 16 comma
separated values in the 1\-255 range.
.
.TP
.B cqm4py=<list> (also see cqm)
Custom 4x4 inter luminance matrix, given as a list of 16 comma separated
values in the 1\-255 range.
.
.TP
.B cqm4pc=<list> (also see cqm)
Custom 4x4 inter chrominance matrix, given as a list of 16 comma
separated values in the 1\-255 range.
.
.TP
.B cqm8iy=<list> (also see cqm)
Custom 8x8 intra luminance matrix, given as a list of 64 comma separated
values in the 1\-255 range.
.
.TP
.B cqm8py=<list> (also see cqm)
Custom 8x8 inter luminance matrix, given as a list of 64 comma separated
values in the 1\-255 range.
.
.TP
.B level_idc=<10\-51>
Set the bitstream's level as defined by annex A of the H.264 standard
(default: 51 \- level 5.1).
This is used for telling the decoder what capabilities it needs to support.
Use this parameter only if you know what it means,
and you have a need to set it.
.
.TP
.B threads=<0\-16>
Spawn threads to encode in parallel on multiple CPUs (default: 1).
This has a slight penalty to compression quality.
0 or 'auto' tells x264 to detect how many CPUs you have and pick an
appropriate number of threads.
.
.TP
.B (no)global_header
Causes SPS and PPS to appear only once, at the beginning of the bitstream
(default: disabled).
Some players, such as the Sony PSP, require the use of this option.
The default behavior causes SPS and PPS to repeat prior to each IDR frame.
.
.TP
.B (no)interlaced
Treat the video content as interlaced.
.
.TP
.B log=<\-1\-3>
Adjust the amount of logging info printed to the screen.
.PD 0
.RSs
.IPs "\-1"
none
.IPs " 0"
Print errors only.
.IPs " 1"
warnings
.IPs " 2"
PSNR and other analysis statistics when the encode finishes (default)
.IPs " 3"
PSNR, QP, frametype, size, and other statistics for every frame
.RE
.PD 1
.
.TP
.B (no)psnr
Print signal-to-noise ratio statistics.
.br
.I NOTE:
The 'Y', 'U', 'V', and 'Avg' PSNR fields in the summary are not
mathematically sound (they are simply the average of per-frame PSNRs).
They are kept only for comparison to the JM reference codec.
For all other purposes, please use either the 'Global' PSNR, or the per-frame
PSNRs printed by log=3.
.
.TP
.B (no)ssim
Print the Structural Similarity Metric results.
This is an alternative to PSNR, and may be better correlated with the
perceived quality of the compressed video.
.
.TP
.B (no)visualize
Enable x264 visualizations during encoding.
If the x264 on your system supports it, a new window will be opened during
the encoding process, in which x264 will attempt to present an overview of
how each frame gets encoded.
Each block type on the visualized movie will be colored as follows:
.PD 0
.RSs
.IPs red/pink
intra block
.IPs "blue\ "
inter block
.IPs green
skip block
.IPs yellow
B-block
.RE
.PD 1
.RS
This feature can be considered experimental and subject to change.
In particular, it depends on x264 being compiled with visualizations enabled.
Note that as of writing this, x264 pauses after encoding and visualizing
each frame, waiting for the user to press a key, at which point the next
frame will be encoded.
.RE
.
.
.SS xvfw (\-xvfwopts)
.
Encoding with Video for Windows codecs is mostly obsolete unless you wish
to encode to some obscure fringe codec.
.
.TP
.B codec=<name>
The name of the binary codec file with which to encode.
.
.TP
.B compdata=<file>
The name of the codec settings file (like firstpass.mcf) created by vfw2menc.
.
.
.SS MPEG muxer (\-mpegopts)
.
The MPEG muxer can generate 5 types of streams, each of which has reasonable
default parameters that the user can override.
Generally, when generating MPEG files, it is advisable to disable
MEncoder's frame-skip code (see \-noskip, \-mc as well as the
harddup and softskip video filters).
.PP
.I EXAMPLE:
.PD 0
.RSs
.IPs format=mpeg2:tsaf:vbitrate=8000
.RE
.PD 1
.
.TP
.B format=<mpeg1 | mpeg2 | xvcd | xsvcd | dvd | pes1 | pes2>
stream format (default: mpeg2).
pes1 and pes2 are very broken formats (no pack header and no padding),
but VDR uses them; do not choose them unless you know exactly what you
are doing.
.
.TP
.B size=<up to 65535>
Pack size in bytes, do not change unless you know exactly what
you are doing (default: 2048).
.
.TP
.B muxrate=<int>
Nominal muxrate in kbit/s used in the pack headers (default: 1800 kb/s).
Will be updated as necessary in the case of 'format=mpeg1' or 'mpeg2'.
.
.TP
.B "tsaf\ \ \ "
Sets timestamps on all frames, if possible; recommended when format=dvd.
If dvdauthor complains with a message like "..audio sector out of range...",
you probably did not enable this option.
.
.TP
.B interleaving2
Uses a better algorithm to interleave audio and video packets, based on the
principle that the muxer will always try to fill the stream with the largest
percentage of free space.
.
.TP
.B vdelay=<1\-32760>
Initial video delay time, in milliseconds (default: 0),
use it if you want to delay video with respect to audio.
It doesn't work with :drop.
.
.TP
.B adelay=<1\-32760>
Initial audio delay time, in milliseconds (default: 0),
use it if you want to delay audio with respect to video.
.
.TP
.B "drop\ \ \ "
When used with vdelay the muxer drops the part of audio that was
anticipated.
.
.TP
.B vwidth, vheight=<1\-4095>
Set the video width and height when video is MPEG-1/2.
.
.TP
.B vpswidth, vpsheight=<1\-4095>
Set pan and scan video width and height when video is MPEG-2.
.
.TP
.B vaspect=<1 | 4/3 | 16/9 | 221/100>
Sets the display aspect ratio for MPEG-2 video.
Do not use it on MPEG-1 or the resulting aspect ratio will be completely wrong.
.
.TP
.B vbitrate=<int>
Sets the video bitrate in kbit/s for MPEG-1/2 video.
.
.TP
.B vframerate=<24000/1001 | 24 | 25 | 30000/1001 | 30 | 50 | 60000/1001 | 60 >
Sets the framerate for MPEG-1/2 video.
This option will be ignored if used with the telecine option.
.
.TP
.B telecine
Enables 3:2 pulldown soft telecine mode: The muxer will make the
video stream look like it was encoded at 30000/1001 fps.
It only works with MPEG-2 video when the output framerate is
24000/1001 fps, convert it with \-ofps if necessary.
Any other framerate is incompatible with this option.
.
.TP
.B film2pal
Enables FILM to PAL and NTSC to PAL soft telecine mode: The muxer
will make the video stream look like it was encoded at 25 fps.
It only works with MPEG-2 video when the output framerate is
24000/1001 fps, convert it with \-ofps if necessary.
Any other framerate is incompatible with this option.
.
.TP
.B tele_src and tele_dest
Enables arbitrary telecining using Donand Graft's DGPulldown code.
You need to specify the original and the desired framerate; the
muxer will make the video stream look like it was encoded at
the desired framerate.
It only works with MPEG-2 video when the input framerate is smaller
than the output framerate and the framerate increase is <= 1.5.
.sp 1
.RS
.I EXAMPLE:
.RE
.PD 0
.RSs
.IPs tele_src=25,tele_dest=30000/1001
PAL to NTSC telecining
.RE
.PD 1
.
.TP
.B vbuf_size=<40\-1194>
Sets the size of the video decoder's buffer, expressed in kilobytes.
Specify it only if the bitrate of the video stream is too high for
the chosen format and if you know perfectly well what you are doing.
A too high value may lead to an unplayable movie, depending on the player's
capabilities.
When muxing HDTV video a value of 400 should suffice.
.
.TP
.B abuf_size=<4\-64>
Sets the size of the audio decoder's buffer, expressed in kilobytes.
The same principle as for vbuf_size applies.
.
.
.SS FFmpeg libavformat demuxers (\-lavfdopts)
.
.TP
.B analyzeduration=<value>
Maximum length in seconds to analyze the stream properties.
.
.TP
.B format=<value>
Force a specific libavformat demuxer.
.
.TP
.B o=<key>=<value>[,<key>=<value>[,...]]
Pass AVOptions to libavformat demuxer.
Note, a patch to make the o= unneeded and pass all unknown options through
the AVOption system is welcome.
A full list of AVOptions can be found in the FFmpeg manual.
Note that some options may conflict with MPlayer/MEncoder options.
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.PD 0
.IPs o=ignidx
.PD 1
.RE
.
.TP
.B probesize=<value>
Maximum amount of data to probe during the detection phase.
In the case of MPEG-TS this value identifies the maximum number
of TS packets to scan.
.
.TP
.B cryptokey=<hexstring>
Encryption key the demuxer should use.
This is the raw binary data of the key converted to a hexadecimal string.
.
.
.SS FFmpeg libavformat muxers (\-lavfopts) (also see \-of lavf)
.
.TP
.B delay=<value>
Currently only meaningful for MPEG[12]: Maximum allowed distance,
in seconds, between the reference timer of the output stream (SCR)
and the decoding timestamp (DTS) for any stream present
(demux to decode delay).
Default is 0.7 (as mandated by the standards defined by MPEG).
Higher values require larger buffers and must not be used.
.
.TP
.B format=<container_format>
Override which container format to mux into
(default: autodetect from output file extension).
.PD 0
.RSs
.IPs "mpg\ \ "
MPEG-1 systems and MPEG-2 PS
.IPs "asf\ \ "
Advanced Streaming Format
.IPs "avi\ \ "
Audio Video Interleave file
.IPs "wav\ \ "
Waveform Audio
.IPs "swf\ \ "
Macromedia Flash
.IPs "flv\ \ "
Macromedia Flash video files
.IPs "rm\ \ \ "
RealAudio and RealVideo
.IPs "au\ \ \ "
SUN AU format
.IPs "nut\ \ "
NUT open container format (experimental)
.IPs "mov\ \ "
QuickTime
.IPs "mp4\ \ "
MPEG-4 format
.IPs "ipod\ "
MPEG-4 format with extra header flags required by Apple iPod firmware
.IPs "dv\ \ \ "
Sony Digital Video container
.IPs "matroska\ \ \ "
Matroska
.RE
.PD 1
.TP
.B muxrate=<rate>
Nominal bitrate of the multiplex, in bits per second;
currently it is meaningful only for MPEG[12].
Sometimes raising it is necessary in order to avoid "buffer underflows".
.
.TP
.B o=<key>=<value>[,<key>=<value>[,...]]
Pass AVOptions to libavformat muxer.
Note, a patch to make the o= unneeded and pass all unknown options through
the AVOption system is welcome.
A full list of AVOptions can be found in the FFmpeg manual.
Note that some options may conflict with MEncoder options.
.sp 1
.RS
.I EXAMPLE:
.RE
.RSs
.PD 0
.IPs o=packetsize=100
.PD 1
.RE
.
.TP
.B packetsize=<size>
Size, expressed in bytes, of the unitary packet for the chosen format.
When muxing to MPEG[12] implementations the default values are:
2324 for [S]VCD, 2048 for all others formats.
.
.TP
.B preload=<distance>
Currently only meaningful for MPEG[12]: Initial distance,
in seconds, between the reference timer of the output stream (SCR)
and the decoding timestamp (DTS) for any stream present
(demux to decode delay).
.
.
.
.\" --------------------------------------------------------------------------
.\" environment variables
.\" --------------------------------------------------------------------------
.
.SH ENVIRONMENT VARIABLES
.
There are a number of environment variables that can be used to
control the behavior of MPlayer and MEncoder.
.
.TP
.B MPLAYER_CHARSET (also see \-msgcharset)
Convert console messages to the specified charset (default: autodetect).
A value of "noconv" means no conversion.
.
.TP
.B MPLAYER_HOME
Directory where MPlayer looks for user settings.
.
.TP
.B MPLAYER_VERBOSE (also see \-v and \-msglevel)
Set the initial verbosity level across all message modules (default: 0).
The resulting verbosity corresponds to that of \-msglevel 5 plus the
value of MPLAYER_VERBOSE.
.
.SS libaf:
.
.TP
.B LADSPA_PATH
If LADSPA_PATH is set, it searches for the specified file.
If it is not set, you must supply a fully specified pathname.
FIXME: This is also mentioned in the ladspa section.
.
.SS libdvdcss:
.
.TP
.B DVDCSS_CACHE
Specify a directory in which to store title key values.
This will speed up descrambling of DVDs which are in the cache.
The DVDCSS_CACHE directory is created if it does not exist,
and a subdirectory is created named after the DVD's title
or manufacturing date.
If DVDCSS_CACHE is not set or is empty, libdvdcss will use
the default value which is "${HOME}/.dvdcss/" under Unix and
"C:\\Documents and Settings\\$USER\\Application Data\\dvdcss\\" under Win32.
The special value "off" disables caching.
.
.TP
.B DVDCSS_METHOD
Sets the authentication and decryption method that
libdvdcss will use to read scrambled discs.
Can be one of title, key or disc.
.PD 0
.RSs
.IPs "key\ \ "
is the default method.
libdvdcss will use a set of calculated player keys to try and get the disc key.
This can fail if the drive does not recognize any of the player keys.
.IPs "disc\ "
is a fallback method when key has failed.
Instead of using player keys, libdvdcss will crack the disc key using
a brute force algorithm.
This process is CPU intensive and requires 64 MB of memory to store
temporary data.
.IPs title
is the fallback when all other methods have failed.
It does not rely on a key exchange with the DVD drive, but rather uses
a crypto attack to guess the title key.
On rare cases this may fail because there is not enough encrypted data
on the disc to perform a statistical attack, but in the other hand it
is the only way to decrypt a DVD stored on a hard disc, or a DVD with
the wrong region on an RPC2 drive.
.RE
.PD 1
.
.TP
.B DVDCSS_RAW_DEVICE
Specify the raw device to use.
Exact usage will depend on your operating system, the Linux
utility to set up raw devices is raw(8) for instance.
Please note that on most operating systems, using a raw device
requires highly aligned buffers: Linux requires a 2048 bytes
alignment (which is the size of a DVD sector).
.
.TP
.B DVDCSS_VERBOSE
Sets the libdvdcss verbosity level.
.PD 0
.RSs
.IPs 0
Outputs no messages at all.
.IPs 1
Outputs error messages to stderr.
.IPs 2
Outputs error messages and debug messages to stderr.
.RE
.PD 1
.
.TP
.B DVDREAD_NOKEYS
Skip retrieving all keys on startup.
Currently disabled.
.
.TP
.B HOME
FIXME: Document this.
.
.SS libao2:
.
.TP
.B AO_SUN_DISABLE_SAMPLE_TIMING
FIXME: Document this.
.
.TP
.B AUDIODEV
FIXME: Document this.
.
.TP
.B AUDIOSERVER
Specifies the Network Audio System server to which the
nas audio output driver should connect and the transport
that should be used.
If unset DISPLAY is used instead.
The transport can be one of tcp and unix.
Syntax is tcp/<somehost>:<someport>, <somehost>:<instancenumber>
or [unix]:<instancenumber>.
The NAS base port is 8000 and <instancenumber> is added to that.
.sp 1
.RS
.I EXAMPLES:
.RE
.PD 0
.RSs
.IPs AUDIOSERVER=somehost:0
Connect to NAS server on somehost using default port and transport.
.IPs AUDIOSERVER=tcp/somehost:8000
Connect to NAS server on somehost listening on TCP port 8000.
.IPs AUDIOSERVER=(unix)?:0
Connect to NAS server instance 0 on localhost using unix domain sockets.
.RE
.PD 1
.
.TP
.B DISPLAY
FIXME: Document this.
.
.SS vidix:
.
.TP
.B VIDIX_CRT
FIXME: Document this.
.
.TP
.B VIDIXIVTVALPHA
Set this to 'disable' in order to stop the VIDIX driver from controlling
alphablending settings.
You can then manipulate it yourself with 'ivtvfbctl'.
.
.SS osdep:
.
.TP
.B TERM
FIXME: Document this.
.
.SS libvo:
.
.TP
.B DISPLAY
FIXME: Document this.
.
.TP
.B FRAMEBUFFER
FIXME: Document this.
.
.TP
.B HOME
FIXME: Document this.
.
.SS libmpdemux:
.
.TP
.B HOME
FIXME: Document this.
.
.TP
.B HOMEPATH
FIXME: Document this.
.
.TP
.B http_proxy
FIXME: Document this.
.
.TP
.B LOGNAME
FIXME: Document this.
.
.TP
.B USERPROFILE
FIXME: Document this.
.
.SS libmpcodecs:
.
.TP
.B XANIM_MOD_DIR
FIXME: Document this.
.
.SS GUI:
.
.TP
.B CHARSET
FIXME: Document this.
.
.TP
.B DISPLAY
FIXME: Document this.
.
.TP
.B HOME
FIXME: Document this.
.
.SS libavformat:
.
.TP
.B AUDIO_FLIP_LEFT
FIXME: Document this.
.
.TP
.B BKTR_DEV
FIXME: Document this.
.
.TP
.B BKTR_FORMAT
FIXME: Document this.
.
.TP
.B BKTR_FREQUENCY
FIXME: Document this.
.
.TP
.B http_proxy
FIXME: Document this.
.
.TP
.B no_proxy
FIXME: Document this.
.
.
.
.\" --------------------------------------------------------------------------
.\" Files
.\" --------------------------------------------------------------------------
.
.SH FILES
.
.TP
/usr/\:local/\:etc/\:mplayer/\:mplayer.conf
MPlayer system-wide settings
.
.TP
/usr/\:local/\:etc/\:mplayer/\:mencoder.conf
MEncoder system-wide settings
.
.TP
~/.mplayer/\:config
MPlayer user settings
.
.TP
~/.mplayer/\:mencoder.conf
MEncoder user settings
.
.TP
~/.mplayer/\:input.conf
input bindings (see '\-input keylist' for the full list)
.
.TP
~/.mplayer/\:gui.conf
GUI configuration file
.
.TP
~/.mplayer/\:gui.pl
GUI playlist
.
.TP
~/.mplayer/\:font/
font directory (There must be a font.desc file and files with .RAW extension.)
.
.TP
~/.mplayer/\:DVDkeys/
cached CSS keys
.
.TP
Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
in this order:
.RS
/path/\:to/\:movie.sub
.br
~/.mplayer/\:sub/\:movie.sub
.RE
.PD 1
.
.
.\" --------------------------------------------------------------------------
.\" Examples
.\" --------------------------------------------------------------------------
.
.SH EXAMPLES OF MPLAYER USAGE
.
.PP
.B Quickstart DVD playing:
.nf
mplayer dvd://1
.fi
.
.PP
.B Play in Japanese with English subtitles:
.nf
mplayer dvd://1 \-alang ja \-slang en
.fi
.
.PP
.B Play only chapters 5, 6, 7:
.nf
mplayer dvd://1 \-chapter 5\-7
.fi
.
.PP
.B Play only titles 5, 6, 7:
.nf
mplayer dvd://5\-7
.fi
.
.PP
.B Play a multiangle DVD:
.nf
mplayer dvd://1 \-dvdangle 2
.fi
.
.PP
.B Play from a different DVD device:
.nf
mplayer dvd://1 \-dvd\-device /dev/\:dvd2
.fi
.
.PP
.B Play DVD video from a directory with VOB files:
.nf
mplayer dvd://1 \-dvd\-device /path/\:to/\:directory/
.fi
.
.PP
.B Copy a DVD title to hard disk, saving to file "title1.vob":
.nf
mplayer dvd://1 \-dumpstream \-dumpfile title1.vob
.fi
.
.PP
.B Play a DVD with dvdnav from path /dev/sr1:
.nf
mplayer dvdnav:////dev/sr1
.fi
.
.PP
.B Stream from HTTP:
.nf
mplayer http://mplayer.hq/example.avi
.fi
.
.PP
.B Stream using RTSP:
.nf
mplayer rtsp://server.example.com/streamName
.fi
.
.PP
.B Convert subtitles to MPsub format:
.nf
mplayer dummy.avi \-sub source.sub \-dumpmpsub
.fi
.
.PP
.B Convert subtitles to MPsub format without watching the movie:
.nf
mplayer /dev/\:zero \-rawvideo pal:fps=xx \-demuxer rawvideo \-vc null \-vo null \-noframedrop \-benchmark \-sub source.sub \-dumpmpsub
.fi
.
.PP
.B input from standard V4L:
.nf
mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420 \-vo xv
.fi
.
.PP
.B Playback on Zoran cards (old style, deprecated):
.nf
mplayer \-vo zr \-vf scale=352:288 file.avi
.fi
.
.PP
.B Playback on Zoran cards (new style):
.nf
mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
.fi
.
.PP
.B Play DTS-CD with passthrough:
.nf
mplayer \-ac hwdts \-rawaudio format=0x2001 \-cdrom\-device /dev/cdrom cdda://
.fi
.br
You can also use \-afm hwac3 instead of \-ac hwdts.
Adjust '/dev/cdrom' to match the CD-ROM device on your system.
If your external receiver supports decoding raw DTS streams,
you can directly play it via cdda:// without setting format, hwac3 or hwdts.
.
.PP
.B Play a 6-channel AAC file with only two speakers:
.nf
mplayer \-rawaudio format=0xff \-demuxer rawaudio \-af pan=2:.32:.32:.39:.06:.06:.39:.17:-.17:-.17:.17:.33:.33 adts_he-aac160_51.aac
.fi
.br
You might want to play a bit with the pan values (e.g multiply with a value) to
increase volume or avoid clipping.
.
.PP
.B checkerboard invert with geq filter:
.nf
mplayer \-vf geq='128+(p(X\,Y)\-128)*(0.5\-gt(mod(X/SW\,128)\,64))*(0.5\-gt(mod(Y/SH\,128)\,64))*4'
.fi
.
.
.SH EXAMPLES OF MENCODER USAGE
.
.PP
.B Encode DVD title #2, only selected chapters:
.nf
mencoder dvd://2 \-chapter 10\-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
.fi
.
.PP
.B Encode DVD title #2, resizing to 640x480:
.nf
mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
.fi
.
.PP
.B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
.nf
mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
.fi
.
.PP
.B The same, but with bitrate set to 1800kbit and optimized macroblocks:
.nf
mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
.fi
.
.PP
.B The same, but with MJPEG compression:
.nf
mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800
.fi
.
.PP
.B Encode all *.jpg files in the current directory:
.nf
mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
.fi
.
.PP
.B Encode from a tuner (specify a format with \-vf format):
.nf
mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
.fi
.
.PP
.B Encode from a pipe:
.nf
rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
.fi
.
.
.\" --------------------------------------------------------------------------
.\" Bugs, authors, standard disclaimer
.\" --------------------------------------------------------------------------
.
.SH BUGS
Don't panic.
If you find one, report it to us, but please make sure you have read all
of the documentation first.
Also look out for smileys. :)
Many bugs are the result of incorrect setup or parameter usage.
The bug reporting section of the documentation
(http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:bugreports.html)
explains how to create useful bug reports.
.
.
.
.SH AUTHORS
MPlayer was initially written by Arpad Gereoffy.
See the AUTHORS file for a list of some of the many other contributors.
.PP
MPlayer is (C) 2000\-2009 The MPlayer Team
.PP
This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
It is maintained by Diego Biurrun.
Please send mails about it to the MPlayer-DOCS mailing list.
Translation specific mails belong on the MPlayer-translations mailing list.
.\" end of file