2 .\" MPlayer (C) 2000-2008 MPlayer Team
3 .\" This man page was/is done by Gabucino, Diego Biurrun, Jonas Jermann
5 .\" --------------------------------------------------------------------------
7 .\" --------------------------------------------------------------------------
9 .\" define indentation for suboptions
15 .\" begin of first level suboptions, end with .RE
19 .\" begin of 2nd level suboptions
24 .\" end of 2nd level suboptions
30 .\" --------------------------------------------------------------------------
32 .\" --------------------------------------------------------------------------
34 .TH MPlayer 1 "2008-01-01" "The MPlayer Project" "The Movie Player"
37 mplayer \- movie player
39 mencoder \- movie encoder
41 .\" --------------------------------------------------------------------------
43 .\" --------------------------------------------------------------------------
49 [options] [file|URL|playlist|\-]
54 [specific options] [file2] [specific options]
59 {group of files and options}
60 [group-specific options]
64 [dvd|dvdnav]://[title|[start_title]\-end_title][/device]
73 tv://[channel][/input_id]
78 radio://[channel|frequency][/capture]
88 dvb://[card_number@]channel
93 mf://[filemask|@listfile]
94 [\-mf options] [options]
98 [cdda|cddb]://track[\-endtrack][:speed][/device]
108 [file|mms[t]|http|http_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]://
109 [user:pass@]URL[:port] [options]
118 mpst://host[:port]/URL
123 tivo://host/[list|llist|fsid]
134 [file|URL|\-] [\-o file | file://file | smb://[user:pass@]host/filepath]
139 [specific options] [file2] [specific options]
143 .\" --------------------------------------------------------------------------
145 .\" --------------------------------------------------------------------------
149 is a movie player for Linux (runs on many other platforms and CPU
150 architectures, see the documentation).
151 It plays most MPEG/\:VOB, AVI, ASF/\:WMA/\:WMV, RM, QT/\:MOV/\:MP4, Ogg/\:OGM,
152 MKV, VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, supported by many
153 native and binary codecs.
154 You can watch VCD, SVCD, DVD, 3ivx, DivX 3/4/5, WMV and even H.264 movies,
157 MPlayer supports a wide range of video and audio output drivers.
158 It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, AAlib, libcaca, DirectFB,
159 Quartz, Mac OS X CoreVideo, but you can also use GGI, SDL (and all their drivers),
160 VESA (on every VESA-compatible card, even without X11), some low-level
161 card-specific drivers (for Matrox, 3dfx and ATI) and some hardware MPEG decoder
162 boards, such as the Siemens DVB, Hauppauge PVR (IVTV), DXR2 and DXR3/\:Hollywood+.
163 Most of them support software or hardware scaling, so you can enjoy movies in
166 MPlayer has an onscreen display (OSD) for status information, nice big
167 antialiased shaded subtitles and visual feedback for keyboard controls.
168 European/\:ISO8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean
169 fonts are supported along with 12 subtitle formats (MicroDVD, SubRip, OGM,
170 SubViewer, Sami, VPlayer, RT, SSA, AQTitle, JACOsub, PJS and our own: MPsub) and
171 DVD subtitles (SPU streams, VOBsub and Closed Captions).
174 (MPlayer's Movie Encoder) is a simple movie encoder, designed to encode
175 MPlayer-playable movies (see above) to other MPlayer-playable formats (see
177 It encodes to MPEG-4 (DivX/Xvid), one of the libavcodec codecs and
178 PCM/\:MP3/\:VBRMP3 audio in 1, 2 or 3 passes.
179 Furthermore it has stream copying abilities, a powerful filter system (crop,
180 expand, flip, postprocess, rotate, scale, noise, RGB/\:YUV conversion) and
184 is MPlayer with a graphical user interface.
185 It has the same options as MPlayer.
187 Usage examples to get you started quickly can be found at the end
190 .B Also see the HTML documentation!
193 .\" --------------------------------------------------------------------------
194 .\" interactive control
195 .\" --------------------------------------------------------------------------
197 .SH "INTERACTIVE CONTROL"
198 MPlayer has a fully configurable, command-driven control layer
199 which allows you to control MPlayer using keyboard, mouse, joystick
200 or remote control (with LIRC).
201 See the \-input option for ways to customize it.
208 Seek backward/\:forward 10 seconds.
210 Seek forward/\:backward 1 minute.
211 .IPs "pgup and pgdown"
212 Seek forward/\:backward 10 minutes.
214 Decrease/increase current playback speed by 10%.
216 Halve/double current playback speed.
218 Reset playback speed to normal.
220 Go backward/\:forward in the playlist.
222 Go forward in the playlist, even over the end.
224 next/\:previous playtree entry in the parent list
225 .IPs "INS and DEL (ASX playlist only)"
226 next/\:previous alternative source.
228 Pause (pressing again unpauses).
231 Pressing once will pause movie, every consecutive press will play one frame
232 and then go into pause mode again (any other key unpauses).
234 Stop playing and quit.
236 Stop playing (and quit if \-idle is not used).
238 Adjust audio delay by +/\- 0.1 seconds.
240 Decrease/\:increase volume.
242 Decrease/\:increase volume.
244 Adjust audio balance in favor of left/\:right channel.
247 .IPs "_ (MPEG-TS, AVI and libavformat only)"
248 Cycle through the available video tracks.
249 .IPs "# (DVD, MPEG, Matroska, AVI and libavformat only)"
250 Cycle through the available audio tracks.
251 .IPs "TAB (MPEG-TS and libavformat only)"
252 Cycle through the available programs.
254 Toggle fullscreen (also see \-fs).
256 Toggle stay-on-top (also see \-ontop).
258 Decrease/\:increase pan-and-scan range.
260 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
262 Toggle frame dropping states: none / skip display / skip decoding
263 (see \-framedrop and \-hardframedrop).
265 Toggle subtitle visibility.
267 Cycle through the available subtitles.
269 Step forward/backward in the subtitle list.
271 Toggle displaying "forced subtitles".
273 Toggle subtitle alignment: top / middle / bottom.
275 Adjust subtitle delay by +/\- 0.1 seconds.
277 Move subtitles up/down.
278 .IPs "i (\-edlout mode only)"
279 Set start or end of an EDL skip and write it out to the given file.
280 .IPs "s (\-vf screenshot only)"
282 .IPs "S (\-vf screenshot only)"
283 Start/stop taking screenshots.
285 Show filename on the OSD.
287 Seek to the beginning of the previous/next chapter.
288 .IPs "D (\-vo xvmc, \-vf yadif, \-vf kerndeint only)"
289 Activate/deactivate deinterlacer.
291 Cycle through the available DVD angles.
296 (The following keys are valid only when using a hardware accelerated video
297 output (xv, (x)vidix, (x)mga, etc), the software equalizer
298 (\-vf eq or \-vf eq2) or hue filter (\-vf hue).)
315 (The following keys are valid only when using the quartz or macosx
316 video output driver.)
322 Resize movie window to half its original size.
324 Resize movie window to its original size.
326 Resize movie window to double its original size.
328 Toggle fullscreen (also see \-fs).
329 .IPs "command + [ and command + ]"
330 Set movie window alpha.
335 (The following keys are valid only when using the sdl
336 video output driver.)
342 Cycle through available fullscreen modes.
344 Restore original mode.
349 (The following keys are valid if you have a keyboard
350 with multimedia keys.)
358 Stop playing and quit.
359 .IPs "PREVIOUS and NEXT"
360 Seek backward/\:forward 1 minute.
365 (The following keys are only valid if GUI support is compiled in
366 and will take precedence over the keys defined above.)
389 (The following keys are only valid if you compiled with TV or DVB input
390 support and will take precedence over the keys defined above.)
396 Select previous/\:next channel.
405 (The following keys are only valid if you compiled with dvdnav
406 support: They are used to navigate the menus.)
422 Return to nearest menu (the order of preference is: chapter->title->root).
430 (The following keys are only valid if teletext support is enabled during
431 compilation: They are used for controlling TV teletext.)
437 Switch teletext on/\:off.
439 Go to next/\:prev teletext page.
449 .IPs "button 3 and button 4"
450 Seek backward/\:forward 1 minute.
451 .IPs "button 5 and button 6"
452 Decrease/\:increase volume.
460 .IPs "left and right"
461 Seek backward/\:forward 10 seconds.
463 Seek forward/\:backward 1 minute.
467 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
468 .IPs "button 3 and button 4"
469 Decrease/\:increase volume.
474 .\" --------------------------------------------------------------------------
476 .\" --------------------------------------------------------------------------
479 Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the
480 \-fs option is \-nofs.
482 If an option is marked as (XXX only), it will only work in combination with
483 the XXX option or if XXX is compiled in.
486 The suboption parser (used for example for \-ao pcm suboptions) supports
487 a special kind of string-escaping intended for use with external GUIs.
489 It has the following format:
491 %n%string_of_length_n
495 mplayer \-ao pcm:file=%10%C:test.wav test.avi
499 mplayer \-ao pcm:file=%`expr length "$NAME"`%"$NAME" test.avi
502 .\" --------------------------------------------------------------------------
503 .\" Configuration files
504 .\" --------------------------------------------------------------------------
506 .SH "CONFIGURATION FILES"
507 You can put all of the options in configuration files which will be read
508 every time MPlayer/MEncoder is run.
509 The system-wide configuration file 'mplayer.conf' is in your configuration
510 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user
511 specific one is '~/\:.mplayer/\:config'.
512 The configuration file for MEncoder is 'mencoder.conf' in your configuration
513 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the
514 user specific one is '~/\:.mplayer/\:mencoder.conf'.
515 User specific options override system-wide options and options given on the
516 command line override either.
517 The syntax of the configuration files is 'option=<value>', everything after
518 a '#' is considered a comment.
519 Options that work without values can be enabled by setting them to 'yes'
520 or '1' or 'true' and disabled by setting them to 'no' or '0' or 'false'.
521 Even suboptions can be specified in this way.
523 You can also write file-specific configuration files.
524 If you wish to have a configuration file for a file called 'movie.avi', create a file
525 named 'movie.avi.conf' with the file-specific options in it and put it in
527 You can also put the configuration file in the same directory as the file to
528 be played, as long as you give the \-use\-filedir\-conf option (either on the
529 command line or in your global config file).
531 .I EXAMPLE MPLAYER CONFIGURATION FILE:
534 # Use Matrox driver by default.
536 # I love practicing handstands while watching videos.
538 # Decode/encode multiple files from PNG,
539 # start with mf://filemask
541 # Eerie negative images are cool.
545 .I "EXAMPLE MENCODER CONFIGURATION FILE:"
548 # Make MEncoder output to a default filename.
550 # The next 4 lines allow mencoder tv:// to start capturing immediately.
553 lavcopts=vcodec=mjpeg
554 tv=driver=v4l2:input=1:width=768:height=576:device=/dev/video0:audiorate=48000
555 # more complex default encoding option set
556 lavcopts=vcodec=mpeg4:autoaspect=1
560 passlogfile=pass1stats.log
570 .\" --------------------------------------------------------------------------
572 .\" --------------------------------------------------------------------------
575 To ease working with different configurations profiles can be defined in the
577 A profile starts with its name between square brackets, e.g.\& '[my-profile]'.
578 All following options will be part of the profile.
579 A description (shown by \-profile help) can be defined with the profile-desc
581 To end the profile, start another one or use the profile name 'default'
582 to continue with normal options.
585 .I "EXAMPLE MPLAYER PROFILE:"
590 profile-desc="profile for dvd:// streams"
595 profile-desc="profile for dvdnav:// streams"
600 profile-desc="profile for .flv files"
610 .I "EXAMPLE MENCODER PROFILE:"
615 profile-desc="MPEG4 encoding"
617 lavcopts=vcodec=mpeg4:vbitrate=1200
620 profile-desc="HQ MPEG4 encoding"
622 lavcopts=mbd=2:trell=yes:v4mv=yes
625 .\" --------------------------------------------------------------------------
627 .\" --------------------------------------------------------------------------
629 .SH "GENERAL OPTIONS"
632 .B \-codecs\-file <filename> (also see \-afm, \-ac, \-vfm, \-vc)
633 Override the standard search path and use the specified file
634 instead of the builtin codecs.conf.
637 .B \-include <configuration file>
638 Specify configuration file to be parsed after the default ones.
642 Prints all available options.
645 .B \-msgcharset <charset>
646 Convert console messages to the specified character set (default: autodetect).
647 Text will be in the encoding specified with the \-\-charset configure option.
648 Set this to "noconv" to disable conversion (for e.g.\& iconv problems).
651 The option takes effect after command line parsing has finished.
652 The MPLAYER_CHARSET environment variable can help you get rid of
653 the first lines of garbled output.
657 Enable colorful console output on terminals that support ANSI color.
660 .B \-msglevel <all=<level>:<module>=<level>:...>
661 Control verbosity directly for each module.
662 The 'all' module changes the verbosity of all the modules not
663 explicitly specified on the command line.
664 See '\-msglevel help' for a list of all modules.
667 Some messages are printed before the command line is parsed and are
668 therefore not affected by \-msglevel.
669 To control these messages you have to use the MPLAYER_VERBOSE environment
670 variable, see its description below for details.
686 informational messages
688 status messages (default)
702 Prepend module name in front of each console message.
705 .B \-noconfig <options>
706 Do not parse selected configuration files.
709 If \-include or \-use\-filedir\-conf options are
710 specified at the command line, they will be honoured.
712 Available options are:
716 all configuration files
717 .IPs "gui (GUI only)"
718 GUI configuration file
720 system configuration file
722 user configuration file
728 Make console output less verbose; in particular, prevents the status line
729 (i.e.\& A: 0.7 V: 0.6 A-V: 0.068 ...) from being displayed.
730 Particularly useful on slow terminals or broken ones which do not properly
731 handle carriage return (i.e.\& \\r).
734 .B \-priority <prio> (Windows only)
735 Set process priority for MPlayer according to the predefined
736 priorities available under Windows.
737 Possible values of <prio>:
739 idle|belownormal|normal|abovenormal|high|realtime
744 Using realtime priority can cause system lockup.
748 .B \-profile <profile1,profile2,...>
749 Use the given profile(s), \-profile help displays a list of the defined profiles.
752 .B \-really\-quiet (also see \-quiet)
753 Display even less output and status messages than with \-quiet.
754 Also suppresses the GUI error message boxes.
757 .B \-show\-profile <profile>
758 Show the description and content of a profile.
761 .B \-use\-filedir\-conf
762 Look for a file-specific configuration file in the same directory as
763 the file that is being played.
766 May be dangerous if playing from untrusted media.
770 Increment verbosity level, one level for each \-v
771 found on the command line.
775 .SH "PLAYER OPTIONS (MPLAYER ONLY)"
778 .B \-autoq <quality> (use with \-vf [s]pp)
779 Dynamically changes the level of postprocessing depending on the available spare
781 The number you specify will be the maximum level used.
782 Usually you can use some big number.
783 You have to use \-vf [s]pp without parameters in order for this to work.
786 .B \-autosync <factor>
787 Gradually adjusts the A/V sync based on audio delay measurements.
788 Specifying \-autosync 0, the default, will cause frame timing to be based
789 entirely on audio delay measurements.
790 Specifying \-autosync 1 will do the same, but will subtly change the A/V
791 correction algorithm.
792 An uneven video framerate in a movie which plays fine with \-nosound can
793 often be helped by setting this to an integer value greater than 1.
794 The higher the value, the closer the timing will be to \-nosound.
795 Try \-autosync 30 to smooth out problems with sound drivers which do
796 not implement a perfect audio delay measurement.
797 With this value, if large A/V sync offsets occur, they will only take about
798 1 or 2 seconds to settle out.
799 This delay in reaction time to sudden A/V offsets should be the only
800 side-effect of turning this option on, for all sound drivers.
804 Prints some statistics on CPU usage and dropped frames at the end of playback.
805 Use in combination with \-nosound and \-vo null for benchmarking only the
809 With this option MPlayer will also ignore frame duration when playing
810 only video (you can think of that as infinite fps).
813 .B \-colorkey <number>
814 Changes the colorkey to an RGB value of your choice.
815 0x000000 is black and 0xffffff is white.
816 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
817 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
822 Disables colorkeying.
823 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
824 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
828 .B \-correct\-pts (EXPERIMENTAL)
829 Switches MPlayer to an experimental mode where timestamps for video frames
830 are calculated differently and video filters which add new frames or
831 modify timestamps of existing ones are supported.
832 The more accurate timestamps can be visible for example when playing
833 subtitles timed to scene changes with the \-ass option.
834 Without \-correct\-pts the subtitle timing will typically be off by some frames.
835 This option does not work correctly with some demuxers and codecs.
838 .B \-crash\-debug (DEBUG CODE)
839 Automatically attaches gdb upon crash or SIGTRAP.
840 Support must be compiled in by configuring with \-\-enable\-crash\-debug.
843 .B \-doubleclick\-time
844 Time in milliseconds to recognize two consecutive button presses as
845 a double-click (default: 300).
846 Set to 0 to let your windowing system decide what a double-click is
850 You will get slightly different behaviour depending on whether you bind
851 MOUSE_BTN0_DBL or MOUSE_BTN0\-MOUSE_BTN0_DBL.
854 .B \-edlout <filename>
855 Creates a new file and writes edit decision list (EDL) records to it.
856 During playback, the user hits 'i' to mark the start or end of a skip block.
857 This provides a starting point from which the user can fine-tune EDL entries
859 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details.
862 .B \-enqueue (GUI only)
863 Enqueue files given on the command line in the playlist instead of playing them
868 Enforces a fixed video system for multiple files (one (un)initialization for
870 Therefore only one window will be opened for all files.
871 Currently the following drivers are fixed-vo compliant: gl, gl2, mga, svga, x11,
872 xmga, xv, xvidix and dfbmga.
875 .B \-framedrop (also see \-hardframedrop, experimental without \-nocorrect\-pts)
876 Skip displaying some frames to maintain A/V sync on slow systems.
877 Video filters are not applied to such frames.
878 For B-frames even decoding is skipped completely.
882 Enable or disable the GUI interface (default depends on binary name).
883 Only works as the first argument on the command line.
884 Does not work as a config-file option.
887 .B \-h, \-help, \-\-help
888 Show short summary of options.
891 .B \-hardframedrop (experimental without \-nocorrect\-pts)
892 More intense frame dropping (breaks decoding).
893 Leads to image distortion!
894 Note that especially the libmpeg2 decoder may crash with this,
895 so consider using "\-vc ffmpeg12,".
899 Command that is executed every 30 seconds during playback via system() -
900 i.e.\& using the shell.
903 MPlayer uses this command without any checking, it is your responsibility
904 to ensure it does not cause security problems (e.g.\& make sure to use full
905 paths if "." is in your path like on Windows).
907 This can be "misused" to disable screensavers that do not support the proper
908 X API (also see \-stop\-xscreensaver).
909 If you think this is too complicated, ask the author of the screensaver
910 program to support the proper X APIs.
912 .I EXAMPLE for xscreensaver:
913 mplayer \-heartbeat\-cmd "xscreensaver\-command \-deactivate" file
915 .I EXAMPLE for GNOME screensaver:
916 mplayer \-heartbeat\-cmd "gnome\-screensaver\-command \-p" file
922 Shorthand for \-msglevel identify=4.
923 Show file parameters in an easily parseable format.
924 Also prints more detailed information about subtitle and audio
925 track languages and IDs.
926 In some cases you can get more information by using \-msglevel identify=6.
927 For example, for a DVD it will list the chapters and time length of each title,
928 as well as a disk ID.
929 Combine this with \-frames 0 to suppress all output.
930 The wrapper script TOOLS/\:midentify.sh suppresses the other MPlayer output and
931 (hopefully) shellescapes the filenames.
934 .B \-idle (also see \-slave)
935 Makes MPlayer wait idly instead of quitting when there is no file to play.
936 Mostly useful in slave mode where MPlayer can be controlled
937 through input commands.
940 .B \-input <commands>
941 This option can be used to configure certain parts of the input system.
942 Paths are relative to ~/.mplayer/.
945 Autorepeat is currently only supported by joysticks.
947 Available commands are:
952 Specify input configuration file other than the default
953 ~/\:.mplayer/\:input.conf.
954 ~/\:.mplayer/\:<filename> is assumed if no full path is given.
956 Device to be used for Apple IR Remote (default is autodetected, Linux only).
958 Delay in milliseconds before we start to autorepeat a key (0 to disable).
960 Number of key presses to generate per second on autorepeat.
962 Prints all keys that can be bound to commands.
964 Prints all commands that can be bound to keys.
966 Specifies the joystick device to use (default: /dev/\:input/\:js0).
968 Read commands from the given file.
969 Mostly useful with a FIFO.
972 When the given file is a FIFO MPlayer opens both ends so you can do
973 several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
978 .B \-key\-fifo\-size <2\-65000>
979 Specify the size of the FIFO that buffers key events (default: 7).
980 A FIFO of size n can buffer (n\-1) events.
981 If it is too small some events may be lost
982 (leading to "stuck mouse buttons" and similar effects).
983 If it is too big, MPlayer may seem to hang while it
984 processes the buffered events.
985 To get the same behavior as before this option was introduced,
986 set it to 2 for Linux or 1024 for Windows.
989 .B \-lircconf <filename> (LIRC only)
990 Specifies a configuration file for LIRC (default: ~/.lircrc).
993 .B \-list\-properties
994 Print a list of the available properties.
998 Loops movie playback <number> times.
1002 .B \-menu (OSD menu only)
1003 Turn on OSD menu support.
1006 .B \-menu\-cfg <filename> (OSD menu only)
1007 Use an alternative menu.conf.
1010 .B \-menu\-chroot <path> (OSD menu only)
1011 Chroot the file selection menu to a specific location.
1016 .IPs "\-menu\-chroot /home"
1017 Will restrict the file selection menu to /\:home and downward (i.e.\& no
1018 access to / will be possible, but /home/user_name will).
1023 .B \-menu\-keepdir (OSD menu only)
1024 File browser starts from the last known location instead of current directory.
1027 .B \-menu\-root <value> (OSD menu only)
1028 Specify the main menu.
1031 .B \-menu\-startup (OSD menu only)
1032 Display the main menu at MPlayer startup.
1035 .B \-mouse\-movements
1036 Permit MPlayer to receive pointer events reported by the video
1037 output driver (currently only derivatives of X11 are supported).
1038 Necessary to select the buttons in DVD menus.
1042 Turns off AppleIR remote support.
1045 .B \-noconsolecontrols
1046 Prevent MPlayer from reading key events from standard input.
1047 Useful when reading data from standard input.
1048 This is automatically enabled when \- is found on the command line.
1049 There are situations where you have to set it manually, e.g.\&
1050 if you open /dev/\:stdin (or the equivalent on your system), use stdin
1051 in a playlist or intend to read from stdin later on via the loadfile or
1052 loadlist slave commands.
1056 Turns off joystick support.
1060 Turns off LIRC support.
1064 Disable mouse button press/\:release input (mozplayerxp's context menu relies
1069 Turns on usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
1071 This wakes up the process every 1/1024 seconds to check the current time.
1072 Useless with modern Linux kernels configured for desktop use as they already
1073 wake up the process with similar accuracy when using normal timed sleep.
1076 .B \-playing\-msg <string>
1077 Print out a string before starting playback.
1078 The following expansions are supported:
1081 Expand to the value of the property NAME.
1083 Expand TEXT only if the property NAME is available.
1085 Expand TEXT only if the property NAME is not available.
1089 .B \-playlist <filename>
1090 Play files according to a playlist file (ASX, Winamp, SMIL, or
1091 one-file-per-line format).
1094 This option is considered an entry so options found after it will apply
1095 only to the elements of this playlist.
1097 FIXME: This needs to be clarified and documented thoroughly.
1100 .B \-rtc\-device <device>
1101 Use the specified device for RTC timing.
1105 Play files in random order.
1108 .B \-skin <name> (GUI only)
1109 Loads a skin from the directory given as parameter below the default skin
1110 directories, /usr/\:local/\:share/\:mplayer/\:skins/\: and ~/.mplayer/\:skins/.
1115 .IPs "\-skin fittyfene"
1116 Tries /usr/\:local/\:share/\:mplayer/\:skins/\:fittyfene
1117 and afterwards ~/.mplayer/\:skins/\:fittyfene.
1122 .B \-slave (also see \-input)
1123 Switches on slave mode, in which MPlayer works as a backend for other programs.
1124 Instead of intercepting keyboard events, MPlayer will read commands separated
1125 by a newline (\\n) from stdin.
1128 See \-input cmdlist for a list of slave commands and DOCS/tech/slave.txt
1129 for their description.
1133 Time frames by repeatedly checking the current time instead of asking the
1134 kernel to wake up MPlayer at the correct time.
1135 Useful if your kernel timing is imprecise and you cannot use the RTC either.
1136 Comes at the price of higher CPU consumption.
1140 Skip <sec> seconds after every frame.
1141 The normal framerate of the movie is kept, so playback is accelerated.
1142 Since MPlayer can only seek to the next keyframe this may be inexact.
1146 .SH "DEMUXER/STREAM OPTIONS"
1150 Select the Dynamic Range Compression level for AC-3 audio streams.
1151 <level> is a float value ranging from 0 to 1, where 0 means no compression
1152 and 1 (which is the default) means full compression (make loud passages more
1153 silent and vice versa).
1154 This option only shows an effect if the AC-3 stream contains the required range
1155 compression information.
1158 .B \-aid <ID> (also see \-alang)
1159 Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
1160 VOB(AC-3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
1161 MPlayer prints the available audio IDs when run in verbose (\-v) mode.
1162 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1163 (if present) with the chosen audio stream.
1166 .B \-alang <language code[,language code,...]> (also see \-aid)
1167 Specify a priority list of audio languages to use.
1168 Different container formats employ different language codes.
1169 DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT
1170 use ISO 639-2 three letter language codes while OGM uses a free-form identifier.
1171 MPlayer prints the available languages when run in verbose (\-v) mode.
1176 .IPs "mplayer dvd://1 \-alang hu,en"
1177 Chooses the Hungarian language track on a DVD and falls back on English if
1178 Hungarian is not available.
1179 .IPs "mplayer \-alang jpn example.mkv"
1180 Plays a Matroska file in Japanese.
1185 .B \-audio\-demuxer <[+]name> (\-audiofile only)
1186 Force audio demuxer type for \-audiofile.
1187 Use a '+' before the name to force it, this will skip some checks!
1188 Give the demuxer name as printed by \-audio\-demuxer help.
1189 For backward compatibility it also accepts the demuxer ID as defined in
1190 libmpdemux/\:demuxer.h.
1191 \-audio\-demuxer audio or \-audio\-demuxer 17 forces MP3.
1194 .B \-audiofile <filename>
1195 Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
1199 .B \-audiofile\-cache <kBytes>
1200 Enables caching for the stream used by \-audiofile, using the specified
1204 .B \-reuse\-socket (udp:// only)
1205 Allows a socket to be reused by other processes as soon as it is closed.
1208 .B \-bandwidth <value> (network only)
1209 Specify the maximum bandwidth for network streaming (for servers that are
1210 able to send content in different bitrates).
1211 Useful if you want to watch live streamed media behind a slow connection.
1212 With Real RTSP streaming, it is also used to set the maximum delivery
1213 bandwidth allowing faster cache filling and stream dumping.
1217 This option specifies how much memory (in kBytes) to use when precaching a
1219 Especially useful on slow media.
1226 .B \-cache\-min <percentage>
1227 Playback will start when the cache has been filled up to <percentage>
1231 .B \-cache\-seek\-min <percentage>
1232 If a seek is to be made to a position within <percentage> of the cache size
1233 from the current position, MPlayer will wait for the cache to be filled to
1234 this position rather than performing a stream seek (default: 50).
1237 .B \-cdda <option1:option2> (CDDA only)
1238 This option can be used to tune the CD Audio reading feature of MPlayer.
1240 Available options are:
1244 .IPs paranoia=<0\-2>
1246 Values other than 0 seem to break playback of anything but the first track.
1248 0: disable checking (default)
1250 1: overlap checking only
1252 2: full data correction and verification
1254 .IPs generic-dev=<value>
1255 Use specified generic SCSI device.
1256 .IPs sector-size=<value>
1257 Set atomic read size.
1258 .IPs overlap=<value>
1259 Force minimum overlap search during verification to <value> sectors.
1261 Assume that the beginning offset of track 1 as reported in the TOC will be
1263 Some Toshiba drives need this for getting track boundaries correct.
1264 .IPs toc-offset=<value>
1265 Add <value> sectors to the values reported when addressing tracks.
1268 (Never) accept imperfect data reconstruction.
1272 .B \-cdrom\-device <path to device>
1273 Specify the CD-ROM device (default: /dev/\:cdrom).
1276 .B \-channels <number> (also see \-af channels)
1277 Request the number of playback channels (default: 2).
1278 MPlayer asks the decoder to decode the audio into as many channels as
1280 Then it is up to the decoder to fulfill the requirement.
1281 This is usually only important when playing videos with AC-3 audio (like DVDs).
1282 In that case liba52 does the decoding by default and correctly downmixes the
1283 audio into the requested number of channels.
1284 To directly control the number of output channels independently of how many
1285 channels are decoded, use the channels filter.
1288 This option is honored by codecs (AC-3 only), filters (surround) and audio
1289 output drivers (OSS at least).
1291 Available options are:
1305 .B \-chapter <chapter ID>[\-<endchapter ID>] (dvd:// and dvdnav:// only)
1306 Specify which chapter to start playing at.
1307 Optionally specify which chapter to end playing at (default: 1).
1310 .B \-cookies (network only)
1311 Send cookies when making HTTP requests.
1314 .B \-cookies\-file <filename> (network only)
1315 Read HTTP cookies from <filename> (default: ~/.mozilla/ and ~/.netscape/)
1316 and skip reading from default locations.
1317 The file is assumed to be in Netscape format.
1321 audio delay in seconds (positive or negative float value)
1323 Negative values delay the audio, and positive values delay the video.
1324 Note that this is the exact opposite of the \-audio\-delay MEncoder option.
1327 When used with MEncoder, this is not guaranteed to work correctly
1328 with \-ovc copy; use \-audio\-delay instead.
1332 Ignore the specified starting time for streams in AVI files.
1333 In MPlayer, this nullifies stream delays in files encoded with
1334 the \-audio\-delay option.
1335 During encoding, this option prevents MEncoder from transferring
1336 original stream start times to the new file; the \-audio\-delay option is
1338 Note that MEncoder sometimes adjusts stream starting times
1339 automatically to compensate for anticipated decoding delays, so do not
1340 use this option for encoding without testing it first.
1343 .B \-demuxer <[+]name>
1345 Use a '+' before the name to force it, this will skip some checks!
1346 Give the demuxer name as printed by \-demuxer help.
1347 For backward compatibility it also accepts the demuxer ID as defined in
1348 libmpdemux/\:demuxer.h.
1351 .B \-dumpaudio (MPlayer only)
1352 Dumps raw compressed audio stream to ./stream.dump (useful with MPEG/\:AC-3,
1353 in most other cases the resulting file will not be playable).
1354 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1355 on the command line only the last one will work.
1358 .B \-dumpfile <filename> (MPlayer only)
1359 Specify which file MPlayer should dump to.
1360 Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream.
1363 .B \-dumpstream (MPlayer only)
1364 Dumps the raw stream to ./stream.dump.
1365 Useful when ripping from DVD or network.
1366 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1367 on the command line only the last one will work.
1370 .B \-dumpvideo (MPlayer only)
1371 Dump raw compressed video stream to ./stream.dump (not very usable).
1372 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1373 on the command line only the last one will work.
1376 .B \-dvbin <options> (DVB only)
1377 Pass the following parameters to the DVB input module, in order to override
1383 Specifies using card number 1\-4 (default: 1).
1384 .IPs file=<filename>
1385 Instructs MPlayer to read the channels list from <filename>.
1386 Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl,atsc} (based on your card type)
1387 or ~/.mplayer/\:channels.conf as a last resort.
1388 .IPs timeout=<1\-30>
1389 Maximum number of seconds to wait when trying to tune a
1390 frequency before giving up (default: 30).
1395 .B \-dvd\-device <path to device> (DVD only)
1396 Specify the DVD device or .iso filename (default: /dev/\:dvd).
1397 You can also specify a directory that contains files previously copied directly
1398 from a DVD (with e.g.\& vobcopy).
1401 .B \-dvd\-speed <factor or speed in KB/s> (DVD only)
1402 Try to limit DVD speed (default: 0, no change).
1403 DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to
1405 Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be
1406 quiet and fast enough.
1407 MPlayer resets the speed to the drive default value on close.
1408 Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd\-speed 8 selects
1412 You need write access to the DVD device to change the speed.
1415 .B \-dvdangle <angle ID> (DVD only)
1416 Some DVD discs contain scenes that can be viewed from multiple angles.
1417 Here you can tell MPlayer which angles to use (default: 1).
1421 Enables edit decision list (EDL) actions during playback.
1422 Video will be skipped over and audio will be muted and unmuted according to
1423 the entries in the given file.
1424 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details
1428 .B \-endpos <[[hh:]mm:]ss[.ms]|size[b|kb|mb]> (also see \-ss and \-sb)
1429 Stop at given time or byte position.
1432 Byte position is enabled only for MEncoder and will not be accurate, as it can
1433 only stop at a frame boundary.
1434 When used in conjunction with \-ss option, \-endpos time will shift forward by
1435 seconds specified with \-ss.
1442 .IPs "\-endpos 01:10:00"
1443 Stop at 1 hour 10 minutes.
1444 .IPs "\-ss 10 \-endpos 56"
1445 Stop at 1 minute 6 seconds.
1446 .IPs "\-endpos 100mb"
1453 Force index rebuilding.
1454 Useful for files with broken index (A/V desync, etc).
1455 This will enable seeking in files where seeking was not possible.
1456 You can fix the index permanently with MEncoder (see the documentation).
1459 This option only works if the underlying media supports seeking
1460 (i.e.\& not with stdin, pipe, etc).
1463 .B \-fps <float value>
1464 Override video framerate.
1465 Useful if the original value is wrong or missing.
1468 .B \-frames <number>
1469 Play/\:convert only first <number> frames, then quit.
1472 .B \-hr\-mp3\-seek (MP3 only)
1474 Enabled when playing from an external MP3 file, as we need to seek
1475 to the very exact position to keep A/V sync.
1476 Can be slow especially when seeking backwards since it has to rewind
1477 to the beginning to find an exact frame position.
1480 .B \-idx (also see \-forceidx)
1481 Rebuilds index of files if no index was found, allowing seeking.
1482 Useful with broken/\:incomplete downloads, or badly created files.
1485 This option only works if the underlying media supports seeking
1486 (i.e.\& not with stdin, pipe, etc).
1490 Skip rebuilding index file.
1491 MEncoder skips writing the index with this option.
1494 .B \-ipv4\-only\-proxy (network only)
1495 Skip the proxy for IPv6 addresses.
1496 It will still be used for IPv4 connections.
1499 .B \-loadidx <index file>
1500 The file from which to read the video index data saved by \-saveidx.
1501 This index will be used for seeking, overriding any index data
1502 contained in the AVI itself.
1503 MPlayer will not prevent you from loading an index file generated
1504 from a different AVI, but this is sure to cause unfavorable results.
1507 This option is obsolete now that MPlayer has OpenDML support.
1510 .B \-mc <seconds/frame>
1511 maximum A-V sync correction per frame (in seconds)
1514 .B \-mf <option1:option2:...>
1515 Used when decoding from multiple PNG or JPEG files.
1517 Available options are:
1522 input file width (default: autodetect)
1524 input file height (default: autodetect)
1526 output fps (default: 25)
1528 input file type (available: jpeg, png, tga, sgi)
1534 Force usage of non-interleaved AVI parser (fixes playback
1535 of some bad AVI files).
1538 .B \-nobps (AVI only)
1539 Do not use average byte/\:second value for A-V sync.
1540 Helps with some AVI files with broken header.
1544 Disables extension-based demuxer selection.
1545 By default, when the file type (demuxer) cannot be detected reliably
1546 (the file has no header or it is not reliable enough), the filename
1547 extension is used to select the demuxer.
1548 Always falls back on content-based demuxer selection.
1551 .B \-passwd <password> (also see \-user) (network only)
1552 Specify password for HTTP authentication.
1555 .B \-prefer\-ipv4 (network only)
1556 Use IPv4 on network connections.
1557 Falls back on IPv6 automatically.
1560 .B \-prefer\-ipv6 (IPv6 network only)
1561 Use IPv6 on network connections.
1562 Falls back on IPv4 automatically.
1565 .B \-psprobe <byte position>
1566 When playing an MPEG-PS or MPEG-PES streams, this option lets you specify
1567 how many bytes in the stream you want MPlayer to scan in order to identify
1568 the video codec used.
1569 This option is needed to play EVO or VDR files containing H.264 streams.
1572 .B \-pvr <option1:option2:...> (PVR only)
1573 This option tunes various encoding properties of the PVR capture module.
1574 It has to be used with any hardware MPEG encoder based card supported by the
1576 The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV based
1577 cards are known as PVR capture cards.
1578 Be aware that only Linux 2.6.18 kernel
1579 and above is able to handle MPEG stream through V4L2 layer.
1580 For hardware capture of an MPEG stream and watching it with
1581 MPlayer/MEncoder, use 'pvr://' as a movie URL.
1583 Available options are:
1586 Specify input aspect ratio:
1596 .IPs arate=<32000\-48000>
1597 Specify encoding audio rate (default: 48000 Hz, available: 32000, 44100
1600 Specify MPEG audio layer encoding (default: 2).
1601 .IPs abitrate=<32\-448>
1602 Specify audio encoding bitrate in kbps (default: 384).
1604 Specify audio encoding mode.
1605 Available preset values are 'stereo', 'joint_stereo', 'dual' and 'mono' (default: stereo).
1606 .IPs vbitrate=<value>
1607 Specify average video bitrate encoding in Mbps (default: 6).
1609 Specify video encoding mode:
1611 vbr: Variable BitRate (default)
1613 cbr: Constant BitRate
1616 Specify peak video bitrate encoding in Mbps
1617 (only useful for VBR encoding, default: 9.6).
1619 Choose an MPEG format for encoding:
1621 ps: MPEG-2 Program Stream (default)
1623 ts: MPEG-2 Transport Stream
1625 mpeg1: MPEG-1 System Stream
1627 vcd: Video CD compatible stream
1629 svcd: Super Video CD compatible stream
1631 dvd: DVD compatible stream
1637 .B \-radio <option1:option2:...> (radio only)
1638 These options set various parameters of the radio capture module.
1639 For listening to radio with MPlayer use 'radio://<frequency>'
1640 (if channels option is not given) or 'radio://<channel_number>'
1641 (if channels option is given) as a movie URL.
1642 You can see allowed frequency range by running MPlayer with '\-v'.
1643 To start the grabbing subsystem, use 'radio://<frequency or channel>/capture'.
1644 If the capture keyword is not given you can listen to radio
1645 using the line-in cable only.
1646 Using capture to listen is not recommended due to synchronization
1647 problems, which makes this process uncomfortable.
1649 Available options are:
1652 Radio device to use (default: /dev/radio0 for Linux and /dev/tuner0 for *BSD).
1654 Radio driver to use (default: v4l2 if available, otherwise v4l).
1655 Currently, v4l and v4l2 drivers are supported.
1656 .IPs volume=<0..100>
1657 sound volume for radio device (default 100)
1658 .IPs "freq_min=<value> (*BSD BT848 only)"
1659 minimum allowed frequency (default: 87.50)
1660 .IPs "freq_max=<value> (*BSD BT848 only)"
1661 maximum allowed frequency (default: 108.00)
1662 .IPs channels=<frequency>\-<name>,<frequency>\-<name>,...
1664 Use _ for spaces in names (or play with quoting ;-).
1665 The channel names will then be written using OSD and the slave commands
1666 radio_step_channel and radio_set_channel will be usable for
1667 a remote control (see LIRC).
1668 If given, number in movie URL will be treated as channel position in
1672 radio://1, radio://104.4, radio_set_channel 1
1673 .IPs "adevice=<value> (radio capture only)"
1674 Name of device to capture sound from.
1675 Without such a name capture will be disabled,
1676 even if the capture keyword appears in the URL.
1677 For ALSA devices use it in the form hw=<card>.<device>.
1678 If the device name contains a '=', the module will use
1679 ALSA to capture, otherwise OSS.
1680 .IPs "arate=<value> (radio capture only)"
1681 Rate in samples per second (default: 44100).
1684 When using audio capture set also \-rawaudio rate=<value> option
1685 with the same value as arate.
1686 If you have problems with sound speed (runs too quickly), try to play
1687 with different rate values (e.g.\& 48000,44100,32000,...).
1688 .IPs "achannels=<value> (radio capture only)"
1689 Number of audio channels to capture.
1693 .B \-rawaudio <option1:option2:...>
1694 This option lets you play raw audio files.
1695 You have to use \-demuxer rawaudio as well.
1696 It may also be used to play audio CDs which are not 44kHz 16-bit stereo.
1697 For playing raw AC-3 streams use \-rawaudio format=0x2000 \-demuxer rawaudio.
1699 Available options are:
1703 .IPs channels=<value>
1706 rate in samples per second
1707 .IPs samplesize=<value>
1708 sample size in bytes
1709 .IPs bitrate=<value>
1710 bitrate for rawaudio files
1717 .B \-rawvideo <option1:option2:...>
1718 This option lets you play raw video files.
1719 You have to use \-demuxer rawvideo as well.
1721 Available options are:
1726 rate in frames per second (default: 25.0)
1727 .IPs sqcif|qcif|cif|4cif|pal|ntsc
1728 set standard image size
1730 image width in pixels
1732 image height in pixels
1733 .IPs i420|yv12|yuy2|y8
1736 colorspace (fourcc) in hex or string constant.
1737 Use \-rawvideo format=help for a list of possible strings.
1747 .IPs "mplayer foreman.qcif -demuxer rawvideo -rawvideo qcif"
1748 Play the famous "foreman" sample video.
1749 .IPs "mplayer sample-720x576.yuv -demuxer rawvideo -rawvideo w=720:h=576"
1750 Play a raw YUV sample.
1756 Used with 'rtsp://' URLs to force the client's port number.
1757 This option may be useful if you are behind a router and want to forward
1758 the RTSP stream from the server to a specific client.
1761 .B \-rtsp\-destination
1762 Used with 'rtsp://' URLs to force the destination IP address to be bound.
1763 This option may be useful with some RTSP server which do not
1764 send RTP packets to the right interface.
1765 If the connection to the RTSP server fails, use \-v to see
1766 which IP address MPlayer tries to bind to and try to force
1767 it to one assigned to your computer instead.
1770 .B \-rtsp\-stream\-over\-tcp (LIVE555 and NEMESI only)
1771 Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP
1772 packets be streamed over TCP (using the same TCP connection as RTSP).
1773 This option may be useful if you have a broken internet connection that does
1774 not pass incoming UDP packets (see http://www.live555.com/\:mplayer/).
1777 .B \-saveidx <filename>
1778 Force index rebuilding and dump the index to <filename>.
1779 Currently this only works with AVI files.
1782 This option is obsolete now that MPlayer has OpenDML support.
1785 .B \-sb <byte position> (also see \-ss)
1786 Seek to byte position.
1787 Useful for playback from CD-ROM images or VOB files with junk at the beginning.
1790 .B \-speed <0.01\-100>
1791 Slow down or speed up playback by the factor given as parameter.
1792 Not guaranteed to work correctly with \-oac copy.
1796 Selects the output sample rate to be used
1797 (of course sound cards have limits on this).
1798 If the sample frequency selected is different from that
1799 of the current media, the resample or lavcresample audio filter will be inserted
1800 into the audio filter layer to compensate for the difference.
1801 The type of resampling can be controlled by the \-af\-adv option.
1802 The default is fast resampling that may cause distortion.
1805 .B \-ss <time> (also see \-sb)
1806 Seek to given time position.
1812 Seeks to 56 seconds.
1813 .IPs "\-ss 01:10:00"
1814 Seeks to 1 hour 10 min.
1820 Tells MPlayer not to discard TS packets reported as broken in the stream.
1821 Sometimes needed to play corrupted MPEG-TS files.
1824 .B \-tsprobe <byte position>
1825 When playing an MPEG-TS stream, this option lets you specify how many
1826 bytes in the stream you want MPlayer to search for the desired
1827 audio and video IDs.
1830 .B \-tsprog <1\-65534>
1831 When playing an MPEG-TS stream, you can specify with this option which
1832 program (if present) you want to play.
1833 Can be used with \-vid and \-aid.
1836 .B \-tv <option1:option2:...> (TV/\:PVR only)
1837 This option tunes various properties of the TV capture module.
1838 For watching TV with MPlayer, use 'tv://' or 'tv://<channel_number>'
1839 or even 'tv://<channel_name> (see option channels for channel_name below)
1841 You can also use 'tv:///<input_id>' to start watching a
1842 movie from a composite or S-Video input (see option input for details).
1844 Available options are:
1848 .IPs "automute=<0\-255> (v4l and v4l2 only)"
1849 If signal strength reported by device is less than this value,
1850 audio and video will be muted.
1851 In most cases automute=100 will be enough.
1852 Default is 0 (automute disabled).
1854 See \-tv driver=help for a list of compiled-in TV input drivers.
1855 available: dummy, v4l, v4l2, bsdbt848 (default: autodetect)
1857 Specify TV device (default: /dev/\:video0).
1859 For the bsdbt848 driver you can provide both bktr and tuner device
1860 names separating them with a comma, tuner after
1861 bktr (e.g.\& -tv device=/dev/bktr1,/dev/tuner1).
1863 Specify input (default: 0 (TV), see console output for available inputs).
1865 Specify the frequency to set the tuner to (e.g.\& 511.250).
1866 Not compatible with the channels parameter.
1868 Specify the output format of the tuner with a preset value supported by the
1869 V4L driver (yv12, rgb32, rgb24, rgb16, rgb15, uyvy, yuy2, i420) or an
1870 arbitrary format given as hex value.
1871 Try outfmt=help for a list of all available formats.
1875 output window height
1877 framerate at which to capture video (frames per second)
1878 .IPs buffersize=<value>
1879 maximum size of the capture buffer in megabytes (default: dynamical)
1881 For bsdbt848 and v4l, PAL, SECAM, NTSC are available.
1882 For v4l2, see the console output for a list of all available norms,
1883 also see the normid option below.
1884 .IPs "normid=<value> (v4l2 only)"
1885 Sets the TV norm to the given numeric ID.
1886 The TV norm depends on the capture card.
1887 See the console output for a list of available TV norms.
1888 .IPs channel=<value>
1889 Set tuner to <value> channel.
1890 .IPs chanlist=<value>
1891 available: europe-east, europe-west, us-bcast, us-cable, etc
1892 .IPs channels=<channel>\-<name>[=<norm>],<channel>\-<name>[=<norm>],...
1893 Set names for channels.
1895 If <channel> is an integer greater than 1000, it will be treated as frequency (in kHz)
1896 rather than channel name from frequency table.
1898 Use _ for spaces in names (or play with quoting ;-).
1899 The channel names will then be written using OSD, and the slave commands
1900 tv_step_channel, tv_set_channel and tv_last_channel will be usable for
1901 a remote control (see LIRC).
1902 Not compatible with the frequency parameter.
1905 The channel number will then be the position in the 'channels' list,
1909 tv://1, tv://TV1, tv_set_channel 1, tv_set_channel TV1
1910 .IPs [brightness|contrast|hue|saturation]=<\-100\-100>
1911 Set the image equalizer on the card.
1912 .IPs audiorate=<value>
1913 Set audio capture bitrate.
1915 Capture audio even if there are no audio sources reported by v4l.
1919 Choose an audio mode:
1929 .IPs forcechan=<1\-2>
1930 By default, the count of recorded audio channels is determined automatically
1931 by querying the audio mode from the TV card.
1932 This option allows forcing stereo/\:mono recording regardless of the amode
1933 option and the values returned by v4l.
1934 This can be used for troubleshooting when the TV card is unable to report the
1936 .IPs adevice=<value>
1937 Set an audio device.
1938 <value> should be /dev/\:xxx for OSS and a hardware ID for ALSA.
1939 You must replace any ':' by a '.' in the hardware ID for ALSA.
1940 .IPs audioid=<value>
1941 Choose an audio output of the capture card, if it has more than one.
1942 .IPs "[volume|bass|treble|balance]=<0\-65535> (v4l1)"
1943 .IPs "[volume|bass|treble|balance]=<0\-100> (v4l2)"
1944 These options set parameters of the mixer on the video capture card.
1945 They will have no effect, if your card does not have one.
1946 For v4l2 50 maps to the default value of the
1947 control, as reported by the driver.
1948 .IPs "gain=<0\-100> (v4l2)"
1949 Set gain control for video devices (usually webcams) to the desired
1950 value and switch off automatic control.
1951 A value of 0 enables automatic control.
1952 If this option is omitted, gain control will not be modified.
1953 .IPs immediatemode=<bool>
1954 A value of 0 means capture and buffer audio and video together
1955 (default for MEncoder).
1956 A value of 1 (default for MPlayer) means to do video capture only and let the
1957 audio go through a loopback cable from the TV card to the sound card.
1959 Use hardware MJPEG compression (if the card supports it).
1960 When using this option, you do not need to specify the width and height
1961 of the output window, because MPlayer will determine it automatically
1962 from the decimation value (see below).
1963 .IPs decimation=<1|2|4>
1964 choose the size of the picture that will be compressed by hardware
1979 .IPs quality=<0\-100>
1980 Choose the quality of the JPEG compression
1981 (< 60 recommended for full size).
1982 .IPs tdevice=<value>
1983 Specify TV teletext device (example: /dev/\:vbi0) (default: none).
1984 .IPs tformat=<format>
1985 Specify TV teletext display format (default: 0):
1991 2: opaque with inverted colors
1993 3: transparent with inverted colors
1995 .IPs tpage=<100\-899>
1996 Specify initial TV teletext page number (default: 100).
1997 .IPs tlang=<\-1\-127>
1998 Specify default teletext language code (default: 0), which will be used
1999 as primary language until a type 28 packet is received.
2000 Useful when the teletext system uses a non-latin character set, but language
2001 codes are not transmitted via teletext type 28 packets for some reason.
2002 To see a list of supported language codes set this option to \-1.
2003 .IPs "hidden_video_renderer (dshow only)"
2004 Terminate stream with video renderer instead of Null renderer (default: off).
2005 Will help if video freezes but audio does not.
2007 May not work with \-vo directx and \-vf crop combination.
2008 .IPs "hidden_vp_renderer (dshow only)"
2009 Terminate VideoPort pin stream with video renderer
2010 instead of removing it from the graph (default: off).
2011 Useful if your card has a VideoPort pin and video is choppy.
2013 May not work with \-vo directx and \-vf crop combination.
2014 .IPs "system_clock (dshow only)"
2015 Use the system clock as sync source instead of the default graph clock
2016 (usually the clock from one of the live sources in graph).
2017 .IPs "normalize_audio_chunks (dshow only)"
2018 Create audio chunks with a time length equal to
2019 video frame time length (default: off).
2020 Some audio cards create audio chunks about 0.5s in size, resulting in
2021 choppy video when using immediatemode=0.
2025 .B \-tvscan <option1:option2:...> (TV and MPlayer only)
2026 Tune the TV channel scanner.
2027 MPlayer will also print value for "-tv channels=" option,
2028 including existing and just found channels.
2030 Available suboptions are:
2033 Begin channel scanning immediately after startup (default: disabled).
2034 .IPs period=<0.1\-2.0>
2035 Specify delay in seconds before switching to next channel (default: 0.5).
2036 Lower values will cause faster scanning, but can detect
2037 inactive TV channels as active.
2038 .IPs threshold=<1\-100>
2039 Threshold value for the signal strength (in percent), as reported
2040 by the device (default: 50).
2041 A signal strength higher than this value will indicate that the
2042 currently scanning channel is active.
2046 .B \-user <username> (also see \-passwd) (network only)
2047 Specify username for HTTP authentication.
2050 .B \-user\-agent <string>
2051 Use <string> as user agent for HTTP streaming.
2055 Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
2056 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
2057 (if present) with the chosen video stream.
2060 .B \-vivo <suboption> (DEBUG CODE)
2061 Force audio parameters for the VIVO demuxer (for debugging purposes).
2062 FIXME: Document this.
2066 .SH "OSD/SUBTITLE OPTIONS"
2068 Also see \-vf expand.
2071 .B \-ass (FreeType only)
2072 Turn on SSA/ASS subtitle rendering.
2073 With this option, libass will be used for SSA/ASS
2074 external subtitles and Matroska tracks.
2075 You may also want to use \-embeddedfonts.
2078 When fontconfig is compiled-in, \-ass turns on \-fontconfig
2079 unless explicitly turned off with \-nofontconfig.
2082 .B \-ass\-border\-color <value>
2083 Sets the border (outline) color for text subtitles.
2084 The color format is RRGGBBAA.
2087 .B \-ass\-bottom\-margin <value>
2088 Adds a black band at the bottom of the frame.
2089 The SSA/ASS renderer can place subtitles there (with \-ass\-use\-margins).
2092 .B \-ass\-color <value>
2093 Sets the color for text subtitles.
2094 The color format is RRGGBBAA.
2097 .B \-ass\-font\-scale <value>
2098 Set the scale coefficient to be used for fonts in the SSA/ASS renderer.
2101 .B \-ass\-force\-style <[Style.]Param=Value[,...]>
2102 Override some style or script info parameters.
2107 \-ass\-force\-style FontName=Arial,Default.Bold=1
2109 \-ass\-force\-style PlayResY=768
2114 .B \-ass\-hinting <type>
2122 FreeType autohinter, light mode
2124 FreeType autohinter, normal mode
2128 The same, but hinting will only be performed if the OSD is rendered at
2129 screen resolution and will therefore not be scaled.
2132 The default value is 7 (use native hinter for unscaled OSD and no hinting otherwise).
2137 .B \-ass\-line\-spacing <value>
2138 Set line spacing value for SSA/ASS renderer.
2141 .B \-ass\-styles <filename>
2142 Load all SSA/ASS styles found in the specified file and use them for
2143 rendering text subtitles.
2144 The syntax of the file is exactly like the
2145 [V4 Styles] / [V4+ Styles] section of SSA/ASS.
2148 .B \-ass\-top\-margin <value>
2149 Adds a black band at the top of the frame.
2150 The SSA/ASS renderer can place toptitles there (with \-ass\-use\-margins).
2153 .B \-ass\-use\-margins
2154 Enables placing toptitles and subtitles in black borders when they
2158 .B \-dumpjacosub (MPlayer only)
2159 Convert the given subtitle (specified with the \-sub option) to the time-based
2160 JACOsub subtitle format.
2161 Creates a dumpsub.js file in the current directory.
2164 .B \-dumpmicrodvdsub (MPlayer only)
2165 Convert the given subtitle (specified with the \-sub option) to the
2166 MicroDVD subtitle format.
2167 Creates a dumpsub.sub file in the current directory.
2170 .B \-dumpmpsub (MPlayer only)
2171 Convert the given subtitle (specified with the \-sub option) to MPlayer's
2172 subtitle format, MPsub.
2173 Creates a dump.mpsub file in the current directory.
2176 .B \-dumpsami (MPlayer only)
2177 Convert the given subtitle (specified with the \-sub option) to the time-based
2178 SAMI subtitle format.
2179 Creates a dumpsub.smi file in the current directory.
2182 .B \-dumpsrtsub (MPlayer only)
2183 Convert the given subtitle (specified with the \-sub option) to the time-based
2184 SubViewer (SRT) subtitle format.
2185 Creates a dumpsub.srt file in the current directory.
2188 Some broken hardware players choke on SRT subtitle files with Unix
2190 If you are unlucky enough to have such a box, pass your subtitle
2191 files through unix2dos or a similar program to replace Unix line
2192 endings with DOS/Windows line endings.
2195 .B \-dumpsub (MPlayer only) (BETA CODE)
2196 Dumps the subtitle substream from VOB streams.
2197 Also see the \-dump*sub and \-vobsubout* options.
2200 .B \-embeddedfonts (FreeType only)
2201 Enables extraction of Matroska embedded fonts (default: disabled).
2202 These fonts can be used for SSA/ASS subtitle
2203 rendering (\-ass option).
2204 Font files are created in the ~/.mplayer/\:fonts directory.
2207 With FontConfig 2.4.2 or newer, embedded fonts are opened directly from memory,
2208 and this option is enabled by default.
2211 .B \-ffactor <number>
2212 Resample the font alphamap.
2219 very narrow black outline (default)
2221 narrow black outline
2228 .B \-flip\-hebrew (FriBiDi only)
2229 Turns on flipping subtitles using FriBiDi.
2232 .B \-noflip\-hebrew\-commas
2233 Change FriBiDi's assumptions about the placements of commas in subtitles.
2234 Use this if commas in subtitles are shown at the start of a sentence
2235 instead of at the end.
2238 .B \-font <path to font.desc file>
2239 Search for the OSD/\:SUB fonts in an alternative directory (default for normal
2240 fonts: ~/\:.mplayer/\:font/\:font.desc, default for FreeType fonts:
2241 ~/.mplayer/\:subfont.ttf).
2244 With FreeType, this option determines the path to the text font file.
2245 With fontconfig, this option determines the fontconfig font name.
2250 \-font ~/\:.mplayer/\:arial-14/\:font.desc
2252 \-font ~/\:.mplayer/\:arialuni.ttf
2254 \-font 'Bitstream Vera Sans'
2259 .B \-fontconfig (fontconfig only)
2260 Enables the usage of fontconfig managed fonts.
2263 \-ass automatically turns this on unless explicitly overridden
2264 with \-nofontconfig.
2268 Display only forced subtitles for the DVD subtitle stream selected by e.g.\&
2272 .B \-fribidi\-charset <charset name> (FriBiDi only)
2273 Specifies the character set that will be passed to FriBiDi when
2274 decoding non-UTF-8 subtitles (default: ISO8859-8).
2277 .B \-ifo <VOBsub IFO file>
2278 Indicate the file that will be used to load palette and frame size for VOBsub
2283 Turns off automatic subtitle file loading.
2286 .B \-osd\-duration <time>
2287 Set the duration of the OSD messages in ms (default: 1000).
2290 .B \-osdlevel <0\-3> (MPlayer only)
2291 Specifies which mode the OSD should start in.
2297 volume + seek (default)
2299 volume + seek + timer + percentage
2301 volume + seek + timer + percentage + total time
2307 Allows the next subtitle to be displayed while the current one is
2308 still visible (default is to enable the support only for specific
2312 .B \-sid <ID> (also see \-slang, \-vobsubid)
2313 Display the subtitle stream specified by <ID> (0\-31).
2314 MPlayer prints the available subtitle IDs when run in verbose (\-v) mode.
2315 If you cannot select one of the subtitles on a DVD, also try \-vobsubid.
2318 .B \-slang <language code[,language code,...]> (also see \-sid)
2319 Specify a priority list of subtitle languages to use.
2320 Different container formats employ different language codes.
2321 DVDs use ISO 639-1 two letter language codes, Matroska uses ISO 639-2
2322 three letter language codes while OGM uses a free-form identifier.
2323 MPlayer prints the available languages when run in verbose (\-v) mode.
2328 .IPs "mplayer dvd://1 \-slang hu,en"
2329 Chooses the Hungarian subtitle track on a DVD and falls back on English if
2330 Hungarian is not available.
2331 .IPs "mplayer \-slang jpn example.mkv"
2332 Plays a Matroska file with Japanese subtitles.
2338 Antialiasing/\:scaling mode for DVD/\:VOBsub.
2339 A value of 16 may be added to <mode> in order to force scaling even
2340 when original and scaled frame size already match.
2341 This can be employed to e.g.\& smooth subtitles with gaussian blur.
2342 Available modes are:
2346 none (fastest, very ugly)
2348 approximate (broken?)
2352 bilinear (default, fast and not too bad)
2354 uses swscaler gaussian blur (looks very good)
2359 .B \-spualign <\-1\-2>
2360 Specify how SPU (DVD/\:VOBsub) subtitles should be aligned.
2366 Align at top (original behavior, default).
2375 .B \-spugauss <0.0\-3.0>
2376 Variance parameter of gaussian used by \-spuaa 4.
2377 Higher means more blur (default: 1.0).
2380 .B \-sub <subtitlefile1,subtitlefile2,...>
2381 Use/\:display these subtitle files.
2382 Only one file can be displayed at the same time.
2385 .B \-sub\-bg\-alpha <0\-255>
2386 Specify the alpha channel value for subtitles and OSD backgrounds.
2387 Big values mean more transparency.
2388 0 means completely transparent.
2391 .B \-sub\-bg\-color <0\-255>
2392 Specify the color value for subtitles and OSD backgrounds.
2393 Currently subtitles are grayscale so this value is equivalent to the
2394 intensity of the color.
2395 255 means white and 0 black.
2398 .B \-sub\-demuxer <[+]name> (\-subfile only) (BETA CODE)
2399 Force subtitle demuxer type for \-subfile.
2400 Use a '+' before the name to force it, this will skip some checks!
2401 Give the demuxer name as printed by \-sub\-demuxer help.
2402 For backward compatibility it also accepts the demuxer ID as defined in
2406 .B \-sub\-fuzziness <mode>
2407 Adjust matching fuzziness when searching for subtitles:
2413 Load all subs containing movie name.
2415 Load all subs in the current directory.
2420 .B \-sub\-no\-text\-pp
2421 Disables any kind of text post processing done after loading the subtitles.
2422 Used for debug purposes.
2425 .B \-subalign <0\-2>
2426 Specify which edge of the subtitles should be aligned at the height
2431 Align subtitle top edge (original behavior).
2433 Align subtitle center.
2435 Align subtitle bottom edge (default).
2441 Display DVD Closed Caption (CC) subtitles.
2444 the VOB subtitles, these are special ASCII subtitles for the
2445 hearing impaired encoded in the VOB userdata stream on most region 1 DVDs.
2446 CC subtitles have not been spotted on DVDs from other regions so far.
2449 .B \-subcp <codepage> (iconv only)
2450 If your system supports iconv(3), you can use this option to
2451 specify the subtitle codepage.
2463 .B \-subcp enca:<language>:<fallback codepage> (ENCA only)
2464 You can specify your language using a two letter language code to
2465 make ENCA detect the codepage automatically.
2466 If unsure, enter anything and watch mplayer \-v output for available
2468 Fallback codepage specifies the codepage to use, when autodetection fails.
2473 .IPs "\-subcp enca:cs:latin2"
2474 Guess the encoding, assuming the subtitles are Czech, fall back on
2475 latin 2, if the detection fails.
2476 .IPs "\-subcp enca:pl:cp1250"
2477 Guess the encoding for Polish, fall back on cp1250.
2483 Delays subtitles by <sec> seconds.
2487 .B \-subfile <filename> (BETA CODE)
2489 Same as \-audiofile, but for subtitle streams (OggDS?).
2492 .B \-subfont <filename> (FreeType only)
2493 Sets the subtitle font.
2494 If no \-subfont is given, \-font is used.
2497 .B \-subfont\-autoscale <0\-3> (FreeType only)
2498 Sets the autoscale mode.
2501 0 means that text scale and OSD scale are font heights in points.
2510 proportional to movie height
2512 proportional to movie width
2514 proportional to movie diagonal (default)
2519 .B \-subfont\-blur <0\-8> (FreeType only)
2520 Sets the font blur radius (default: 2).
2523 .B \-subfont\-encoding <value> (FreeType only)
2524 Sets the font encoding.
2525 When set to 'unicode', all the glyphs from the font file will be rendered and
2526 unicode will be used (default: unicode).
2529 .B \-subfont\-osd\-scale <0\-100> (FreeType only)
2530 Sets the autoscale coefficient of the OSD elements (default: 6).
2533 .B \-subfont\-outline <0\-8> (FreeType only)
2534 Sets the font outline thickness (default: 2).
2537 .B \-subfont\-text\-scale <0\-100> (FreeType only)
2538 Sets the subtitle text autoscale coefficient as percentage of the
2539 screen size (default: 5).
2543 Specify the framerate of the subtitle file (default: movie fps).
2546 <rate> > movie fps speeds the subtitles up for frame-based subtitle files and
2547 slows them down for time-based ones.
2550 .B \-subpos <0\-100> (useful with \-vf expand)
2551 Specify the position of subtitles on the screen.
2552 The value is the vertical position of the subtitle in % of the screen height.
2555 .B \-subwidth <10\-100>
2556 Specify the maximum width of subtitles on the screen.
2558 The value is the width of the subtitle in % of the screen width.
2562 Disable the display of OSD messages on the console when no video output is
2566 .B \-term\-osd\-esc <escape sequence>
2567 Specify the escape sequence to use before writing an OSD message on the
2569 The escape sequence should move the pointer to the beginning of the line
2570 used for the OSD and clear it (default: ^[[A\\r^[[K).
2574 Tells MPlayer to handle the subtitle file as unicode.
2577 .B \-unrarexec <path to unrar executable> (not supported on MingW)
2578 Specify the path to the unrar executable so MPlayer can use it to access
2579 rar-compressed VOBsub files (default: not set, so the feature is off).
2580 The path must include the executable's filename, i.e.\& /usr/local/bin/unrar.
2584 Tells MPlayer to handle the subtitle file as UTF-8.
2587 .B \-vobsub <VOBsub file without extension>
2588 Specify a VOBsub file to use for subtitles.
2589 Has to be the full pathname without extension, i.e.\& without
2590 the '.idx', '.ifo' or '.sub'.
2593 .B \-vobsubid <0\-31>
2594 Specify the VOBsub subtitle ID.
2598 .SH "AUDIO OUTPUT OPTIONS (MPLAYER ONLY)"
2601 .B \-abs <value> (\-ao oss only) (OBSOLETE)
2602 Override audio driver/\:card buffer size detection.
2605 .B \-format <format> (also see the format audio filter)
2606 Select the sample format used for output from the audio filter
2607 layer to the sound card.
2608 The values that <format> can adopt are listed below in the
2609 description of the format audio filter.
2613 Use a mixer device different from the default /dev/\:mixer.
2614 For ALSA this is the mixer name.
2617 .B \-mixer\-channel <mixer line>[,mixer index] (\-ao oss and \-ao alsa only)
2618 This option will tell MPlayer to use a different channel for controlling
2619 volume than the default PCM.
2620 Options for OSS include
2622 For a complete list of options look for SOUND_DEVICE_NAMES in
2623 /usr/\:include/\:linux/\:soundcard.h.
2624 For ALSA you can use the names e.g.\& alsamixer displays, like
2625 .B Master, Line, PCM.
2628 ALSA mixer channel names followed by a number must be specified in the
2629 <name,number> format, i.e.\& a channel labeled 'PCM 1' in alsamixer must
2635 Force the use of the software mixer, instead of using the sound card
2639 .B \-softvol\-max <10.0\-10000.0>
2640 Set the maximum amplification level in percent (default: 110).
2641 A value of 200 will allow you to adjust the volume up to a maximum of
2642 double the current level.
2643 With values below 100 the initial volume (which is 100%) will be above
2644 the maximum, which e.g.\& the OSD cannot display correctly.
2647 .B \-volstep <0\-100>
2648 Set the step size of mixer volume changes in percent of the whole range
2652 .B \-volume <-1\-100> (also see \-af volume)
2653 Set the startup volume in the mixer, either hardware or software (if
2654 used with \-softvol).
2655 A value of -1 (the default) will not change the volume.
2659 .SH "AUDIO OUTPUT DRIVERS (MPLAYER ONLY)"
2660 Audio output drivers are interfaces to different audio output facilities.
2664 .B \-ao <driver1[:suboption1[=value]:...],driver2,...[,]>
2665 Specify a priority list of audio output drivers to be used.
2667 If the list has a trailing ',' MPlayer will fall back on drivers not
2668 contained in the list.
2669 Suboptions are optional and can mostly be omitted.
2672 See \-ao help for a list of compiled-in audio output drivers.
2677 .IPs "\-ao alsa,oss,"
2678 Try the ALSA driver, then the OSS driver, then others.
2679 .IPs "\-ao alsa:noblock:device=hw=0.3"
2680 Sets noblock-mode and the device-name as first card, fourth device.
2684 Available audio output drivers are:
2688 ALSA 0.9/1.x audio output driver
2693 .IPs device=<device>
2694 Sets the device name.
2695 Replace any ',' with '.' and any ':' with '=' in the ALSA device name.
2696 For hwac3 output via S/PDIF, use an "iec958" or "spdif" device, unless
2697 you really know how to set it correctly.
2703 ALSA 0.5 audio output driver
2707 OSS audio output driver
2711 Sets the audio output device (default: /dev/\:dsp).
2713 Sets the audio mixer device (default: /dev/\:mixer).
2714 .IPs <mixer-channel>
2715 Sets the audio mixer channel (default: pcm).
2721 highly platform independent SDL (Simple Directmedia Layer) library
2726 Explicitly choose the SDL audio driver to use (default: let SDL choose).
2732 audio output through the aRts daemon
2736 audio output through the ESD daemon
2740 Explicitly choose the ESD server to use (default: localhost).
2746 audio output through JACK (Jack Audio Connection Kit)
2750 Connects to the ports with the given name (default: physical ports).
2751 .IPs name=<client name>
2752 Client name that is passed to JACK (default: MPlayer [<PID>]).
2753 Useful if you want to have certain connections established automatically.
2755 Estimate the audio delay, supposed to make the video playback smoother
2762 audio output through NAS
2765 .B macosx (Mac OS X only)
2766 native Mac OS X audio output driver
2770 Experimental OpenAL audio output driver
2774 PulseAudio audio output driver
2777 .IPs "[<host>][:<output sink>]"
2778 Specify the host and optionally output sink to use.
2779 An empty <host> string uses a local connection, "localhost"
2780 uses network transfer (most likely not what you want).
2786 native SGI audio output driver
2789 .IPs "<output device name>"
2790 Explicitly choose the output device/\:interface to use
2791 (default: system-wide default).
2792 For example, 'Analog Out' or 'Digital Out'.
2798 native Sun audio output driver
2802 Explicitly choose the audio device to use (default: /dev/\:audio).
2807 .B win32 (Windows only)
2808 native Windows waveout audio output driver
2811 .B dsound (Windows only)
2812 DirectX DirectSound audio output driver
2815 .IPs device=<devicenum>
2816 Sets the device number to use.
2817 Playing a file with \-v will show a list of available devices.
2822 .B dxr2 (also see \-dxr2) (DXR2 only)
2823 Creative DXR2 specific output driver
2827 IVTV specific MPEG audio output driver.
2828 Works with \-ac hwmpa only.
2831 .B v4l2 (requires Linux 2.6.22+ kernel)
2832 Audio output driver for V4L2 cards with hardware MPEG decoder.
2835 .B mpegpes (DVB only)
2836 Audio output driver for DVB cards that writes the output to an MPEG-PES
2837 file if no DVB card is installed.
2841 DVB card to use if more than one card is present.
2842 If not specified mplayer will search the first usable card.
2843 .IPs file=<filename>
2850 Produces no audio output but maintains video playback speed.
2851 Use \-nosound for benchmarking.
2855 raw PCM/wave file writer audio output
2859 Include or do not include the wave header (default: included).
2860 When not included, raw PCM will be generated.
2861 .IPs file=<filename>
2862 Write the sound to <filename> instead of the default
2864 If nowaveheader is specified, the default is audiodump.pcm.
2866 Try to dump faster than realtime.
2867 Make sure the output does not get truncated (usually with
2868 "Too many video packets in buffer" message).
2869 It is normal that you get a "Your system is too SLOW to play this!" message.
2875 plugin audio output driver
2879 .SH "VIDEO OUTPUT OPTIONS (MPLAYER ONLY)"
2882 .B \-adapter <value>
2883 Set the graphics card that will receive the image.
2884 You can get a list of available cards when you run this option with \-v.
2885 Currently only works with the directx video output driver.
2889 Override the autodetected color depth.
2890 Only supported by the fbdev, dga, svga, vesa video output drivers.
2894 Play movie with window border and decorations.
2895 Since this is on by default, use \-noborder to disable the standard window
2899 .B \-brightness <\-100\-100>
2900 Adjust the brightness of the video signal (default: 0).
2901 Not supported by all video output drivers.
2904 .B \-contrast <\-100\-100>
2905 Adjust the contrast of the video signal (default: 0).
2906 Not supported by all video output drivers.
2909 .B \-display <name> (X11 only)
2910 Specify the hostname and display number of the X server you want to display
2916 \-display xtest.localdomain:0
2922 Turns on direct rendering (not supported by all codecs and video outputs)
2925 May cause OSD/SUB corruption!
2928 .B \-dxr2 <option1:option2:...>
2929 This option is used to control the dxr2 video output driver.
2931 .IPs ar-mode=<value>
2932 aspect ratio mode (0 = normal, 1 = pan-and-scan, 2 = letterbox (default))
2934 Set iec958 output mode to encoded.
2936 Set iec958 output mode to decoded (default).
2937 .IPs macrovision=<value>
2938 macrovision mode (0 = off (default), 1 = agc, 2 = agc 2 colorstripe,
2939 3 = agc 4 colorstripe)
2945 path to the microcode
2953 enable 7.5 IRE output mode
2955 disable 7.5 IRE output mode (default)
2959 color TV output (default)
2961 interlaced TV output (default)
2963 disable interlaced TV output
2965 TV norm (ntsc (default), pal, pal60, palm, paln, palnc)
2967 set pixel mode to square
2969 set pixel mode to ccir601
2976 .IPs cr-left=<0\-500>
2977 Set the left cropping value (default: 50).
2978 .IPs cr-right=<0\-500>
2979 Set the right cropping value (default: 300).
2980 .IPs cr-top=<0\-500>
2981 Set the top cropping value (default: 0).
2982 .IPs cr-bottom=<0\-500>
2983 Set the bottom cropping value (default: 0).
2984 .IPs ck-[r|g|b]=<0\-255>
2985 Set the r(ed), g(reen) or b(lue) gain of the overlay color-key.
2986 .IPs ck-[r|g|b]min=<0\-255>
2987 minimum value for the respective color key
2988 .IPs ck-[r|g|b]max=<0\-255>
2989 maximum value for the respective color key
2991 Ignore cached overlay settings.
2993 Update cached overlay settings.
2995 Enable overlay onscreen display.
2997 Disable overlay onscreen display (default).
2998 .IPs ol[h|w|x|y]-cor=<\-20\-20>
2999 Adjust the overlay size (h,w) and position (x,y) in case it does not
3000 match the window perfectly (default: 0).
3002 Activate overlay (default).
3005 .IPs overlay-ratio=<1\-2500>
3006 Tune the overlay (default: 1000).
3010 .B \-fbmode <modename> (\-vo fbdev only)
3011 Change video mode to the one that is labeled as <modename> in
3015 VESA framebuffer does not support mode changing.
3018 .B \-fbmodeconfig <filename> (\-vo fbdev only)
3019 Override framebuffer mode configuration file (default: /etc/\:fb.modes).
3022 .B \-fs (also see \-zoom)
3023 Fullscreen playback (centers movie, and paints black bands around it).
3024 Not supported by all video output drivers.
3027 .B \-fsmode\-dontuse <0\-31> (OBSOLETE, use the \-fs option)
3028 Try this option if you still experience fullscreen problems.
3031 .B \-fstype <type1,type2,...> (X11 only)
3032 Specify a priority list of fullscreen modes to be used.
3033 You can negate the modes by prefixing them with '\-'.
3034 If you experience problems like the fullscreen window being covered
3035 by other windows try using a different order.
3038 See \-fstype help for a full list of available modes.
3040 The available types are:
3045 Use the _NETWM_STATE_ABOVE hint if available.
3047 Use the _NETWM_STATE_BELOW hint if available.
3049 Use the _NETWM_STATE_FULLSCREEN hint if available.
3051 Use the _WIN_LAYER hint with the default layer.
3053 Use the _WIN_LAYER hint with the given layer number.
3057 Do not set fullscreen window layer.
3059 Use _NETWM_STATE_STAYS_ON_TOP hint if available.
3067 .IPs layer,stays_on_top,above,fullscreen
3068 Default order, will be used as a fallback if incorrect or
3069 unsupported modes are specified.
3071 Fixes fullscreen switching on OpenBox 1.x.
3076 .B \-geometry x[%][:y[%]] or [WxH][+x+y]
3077 Adjust where the output is on the screen initially.
3078 The x and y specifications are in pixels measured from the top-left of the
3079 screen to the top-left of the image being displayed, however if a percentage
3080 sign is given after the argument it turns the value into a percentage of the
3081 screen size in that direction.
3082 It also supports the standard X11 \-geometry option format.
3083 If an external window is specified using the \-wid option, then the x and
3084 y coordinates are relative to the top-left corner of the window rather
3088 This option is only supported by the x11, xmga, xv, xvmc, xvidix,
3089 gl, gl2, directx, fbdev and tdfxfb video output drivers.
3095 Places the window at x=50, y=40.
3097 Places the window in the middle of the screen.
3099 Places the window at the middle of the right edge of the screen.
3101 Places the window at the bottom right corner of the screen.
3106 .B \-guiwid <window ID> (also see \-wid) (GUI only)
3107 This tells the GUI to also use an X11 window and stick itself to the bottom
3108 of the video, which is useful to embed a mini-GUI in a browser (with the
3109 MPlayer plugin for instance).
3112 .B \-hue <\-100\-100>
3113 Adjust the hue of the video signal (default: 0).
3114 You can get a colored negative of the image with this option.
3115 Not supported by all video output drivers.
3118 .B \-monitor\-dotclock <range[,range,...]> (\-vo fbdev and vesa only)
3119 Specify the dotclock or pixelclock range of the monitor.
3122 .B \-monitor\-hfreq <range[,range,...]> (\-vo fbdev and vesa only)
3123 Specify the horizontal frequency range of the monitor.
3126 .B \-monitor\-vfreq <range[,range,...]> (\-vo fbdev and vesa only)
3127 Specify the vertical frequency range of the monitor.
3130 .B \-monitoraspect <ratio> (also see \-aspect)
3131 Set the aspect ratio of your monitor or TV screen.
3132 A value of 0 disables a previous setting (e.g.\& in the config file).
3133 Overrides the \-monitorpixelaspect setting if enabled.
3138 \-monitoraspect 4:3 or 1.3333
3140 \-monitoraspect 16:9 or 1.7777
3145 .B \-monitorpixelaspect <ratio> (also see \-aspect)
3146 Set the aspect of a single pixel of your monitor or TV screen (default: 1).
3147 A value of 1 means square pixels
3148 (correct for (almost?) all LCDs).
3152 Disables double buffering, mostly for debugging purposes.
3153 Double buffering fixes flicker by storing two frames in memory, and
3154 displaying one while decoding another.
3155 It can affect OSD negatively, but often removes OSD flickering.
3159 Do not grab the mouse pointer after a video mode change (\-vm).
3160 Useful for multihead setups.
3164 Do not keep window aspect ratio when resizing windows.
3165 Only works with the x11, xv, xmga, xvidix, directx video output drivers.
3166 Furthermore under X11 your window manager has to honor window aspect hints.
3170 Makes the player window stay on top of other windows.
3171 Supported by video output drivers which use X11, except SDL,
3172 as well as directx, macosx, quartz, ggi and gl2.
3175 .B \-panscan <0.0\-1.0>
3176 Enables pan-and-scan functionality (cropping the sides of e.g.\& a 16:9
3177 movie to make it fit a 4:3 display without black bands).
3178 The range controls how much of the image is cropped.
3179 Only works with the xv, xmga, mga, gl, gl2, quartz, macosx and xvidix
3180 video output drivers.
3183 Values between \-1 and 0 are allowed as well, but highly experimental
3184 and may crash or worse.
3185 Use at your own risk!
3188 .B \-panscanrange <\-19.0\-99.0> (experimental)
3189 Change the range of the pan-and-scan functionality (default: 1).
3190 Positive values mean multiples of the default range.
3191 Negative numbers mean you can zoom in up to a factor of \-panscanrange+1.
3192 E.g. \-panscanrange \-3 allows a zoom factor of up to 4.
3193 This feature is experimental.
3194 Do not report bugs unless you are using \-vo gl.
3197 .B \-refreshrate <Hz>
3198 Set the monitor refreshrate in Hz.
3199 Currently only supported by \-vo directx combined with the \-vm option.
3203 Play movie in the root window (desktop background).
3204 Desktop background images may cover the movie window, though.
3205 Only works with the x11, xv, xmga, xvidix, quartz, macosx and directx video output drivers.
3208 .B \-saturation <\-100\-100>
3209 Adjust the saturation of the video signal (default: 0).
3210 You can get grayscale output with this option.
3211 Not supported by all video output drivers.
3214 .B \-screenh <pixels>
3215 Specify the screen height for video output drivers which
3216 do not know the screen resolution like fbdev, x11 and TV-out.
3219 .B \-screenw <pixels>
3220 Specify the screen width for video output drivers which
3221 do not know the screen resolution like fbdev, x11 and TV-out.
3224 .B \-stop\-xscreensaver (X11 only)
3225 Turns off xscreensaver at startup and turns it on again on exit.
3226 If your screensaver supports neither the XSS nor XResetScreenSaver
3227 API please use \-heartbeat\-cmd instead.
3231 Try to change to a different video mode.
3232 Supported by the dga, x11, xv, sdl and directx video output drivers.
3233 If used with the directx video output driver the \-screenw,
3234 \-screenh, \-bpp and \-refreshrate options can be used to set
3235 the new display mode.
3239 Enables VBI for the vesa, dfbmga and svga video output drivers.
3242 .B \-wid <window ID> (also see \-guiwid) (X11, OpenGL and DirectX only)
3243 This tells MPlayer to attach to an existing window.
3244 Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
3247 .B \-xineramascreen <\-2\-...>
3248 In Xinerama configurations (i.e.\& a single desktop that spans across multiple
3249 displays) this option tells MPlayer which screen to display the movie on.
3250 A value of \-2 means fullscreen across the whole virtual display (in this case
3251 Xinerama information is completely ignored), \-1 means
3252 fullscreen on the display the window currently is on.
3253 The initial position set via the \-geometry option is relative to the
3255 Will usually only work with "\-fstype \-fullscreen" or "\-fstype none".
3256 This option is not suitable to only set the startup screen (because
3257 it will always display on the given screen in fullscreen mode),
3258 \-geometry is the best that is available for that purpose
3260 Supported by the gl, gl2, x11, and xv video output drivers.
3263 .B \-zrbw (\-vo zr only)
3264 Display in black and white.
3265 For optimal performance, this can be combined with '\-lavdopts gray'.
3268 .B \-zrcrop <[width]x[height]+[x offset]+[y offset]> (\-vo zr only)
3269 Select a part of the input image to display, multiple occurrences
3270 of this option switch on cinerama mode.
3271 In cinerama mode the movie is distributed over more than one TV
3272 (or beamer) to create a larger image.
3273 Options appearing after the n-th \-zrcrop apply to the n-th MJPEG card, each
3274 card should at least have a \-zrdev in addition to the \-zrcrop.
3275 For examples, see the output of \-zrhelp and the Zr section of the
3279 .B \-zrdev <device> (\-vo zr only)
3280 Specify the device special file that belongs to your MJPEG card, by default
3281 the zr video output driver takes the first v4l device it can find.
3284 .B \-zrfd (\-vo zr only)
3285 Force decimation: Decimation, as specified by \-zrhdec and \-zrvdec, only
3286 happens if the hardware scaler can stretch the image to its original size.
3287 Use this option to force decimation.
3290 .B \-zrhdec <1|2|4> (\-vo zr only)
3291 Horizontal decimation: Ask the driver to send only every 2nd or 4th
3292 line/\:pixel of the input image to the MJPEG card and use the scaler
3293 of the MJPEG card to stretch the image to its original size.
3296 .B \-zrhelp (\-vo zr only)
3297 Display a list of all \-zr* options, their default values and a
3298 cinerama mode example.
3301 .B \-zrnorm <norm> (\-vo zr only)
3302 Specify the TV norm as PAL or NTSC (default: no change).
3305 .B \-zrquality <1\-20> (\-vo zr only)
3306 A number from 1 (best) to 20 (worst) representing the JPEG encoding quality.
3309 .B \-zrvdec <1|2|4> (\-vo zr only)
3310 Vertical decimation: Ask the driver to send only every 2nd or 4th
3311 line/\:pixel of the input image to the MJPEG card and use the scaler
3312 of the MJPEG card to stretch the image to its original size.
3315 .B \-zrxdoff <x display offset> (\-vo zr only)
3316 If the movie is smaller than the TV screen, this option specifies the x
3317 offset from the upper-left corner of the TV screen (default: centered).
3320 .B \-zrydoff <y display offset> (\-vo zr only)
3321 If the movie is smaller than the TV screen, this option specifies the y
3322 offset from the upper-left corner of the TV screen (default: centered).
3326 .SH "VIDEO OUTPUT DRIVERS (MPLAYER ONLY)"
3327 Video output drivers are interfaces to different video output facilities.
3331 .B \-vo <driver1[:suboption1[=value]:...],driver2,...[,]>
3332 Specify a priority list of video output drivers to be used.
3334 If the list has a trailing ',' MPlayer will fall back on drivers not
3335 contained in the list.
3336 Suboptions are optional and can mostly be omitted.
3339 See \-vo help for a list of compiled-in video output drivers.
3344 .IPs "\-vo xmga,xv,"
3345 Try the Matrox X11 driver, then the Xv driver, then others.
3346 .IPs "\-vo directx:noaccel"
3347 Uses the DirectX driver with acceleration features turned off.
3351 Available video output drivers are:
3355 Uses the XVideo extension of XFree86 4.x to enable hardware
3356 accelerated playback.
3357 If you cannot use a hardware specific driver, this is probably
3359 For information about what colorkey is used and how it is drawn run MPlayer
3360 with \-v option and look out for the lines tagged with [xv common] at the
3364 .IPs adaptor=<number>
3365 Select a specific XVideo adaptor (check xvinfo results).
3367 Select a specific XVideo port.
3368 .IPs ck=<cur|use|set>
3369 Select the source from which the colorkey is taken (default: cur).
3372 The default takes the colorkey currently set in Xv.
3374 Use but do not set the colorkey from MPlayer (use \-colorkey option to change
3377 Same as use but also sets the supplied colorkey.
3379 .IPs ck-method=<man|bg|auto>
3380 Sets the colorkey drawing method (default: man).
3383 Draw the colorkey manually (reduces flicker in some cases).
3385 Set the colorkey as window background.
3387 Let Xv draw the colorkey.
3394 Shared memory video output driver without hardware acceleration that
3395 works whenever X11 is present.
3399 Adds X11 support to all overlay based video output drivers.
3400 Currently only supported by tdfx_vid.
3404 Select the driver to use as source to overlay on top of X11.
3409 .B xvmc (X11 with \-vc ffmpeg12mc only)
3410 Video output driver that uses the XvMC (X Video Motion Compensation)
3411 extension of XFree86 4.x to speed up MPEG-1/2 and VCR2 decoding.
3414 .IPs adaptor=<number>
3415 Select a specific XVideo adaptor (check xvinfo results).
3417 Select a specific XVideo port.
3419 Disables image display.
3420 Necessary for proper benchmarking of drivers that change
3421 image buffers on monitor retrace only (nVidia).
3422 Default is not to disable image display (nobenchmark).
3424 Very simple deinterlacer.
3425 Might not look better than \-vf tfields=1,
3426 but it is the only deinterlacer for xvmc (default: nobobdeint).
3428 Queue frames for display to allow more parallel work of the video hardware.
3429 May add a small (not noticeable) constant A/V desync (default: noqueue).
3431 Use sleep function while waiting for rendering to finish
3432 (not recommended on Linux) (default: nosleep).
3434 Same as \-vo xv:ck (see \-vo xv).
3435 .IPs ck-method=man|bg|auto
3436 Same as \-vo xv:ck-method (see \-vo xv).
3442 Play video through the XFree86 Direct Graphics Access extension.
3443 Considered obsolete.
3447 Highly platform independent SDL (Simple Directmedia Layer) library
3448 video output driver.
3449 Since SDL uses its own X11 layer, MPlayer X11 options do not have
3453 .IPs driver=<driver>
3454 Explicitly choose the SDL driver to use.
3456 Use XVideo through the sdl video output driver (default: forcexv).
3458 Use hardware accelerated scaler (default: hwaccel).
3464 VIDIX (VIDeo Interface for *niX) is an interface to the
3465 video acceleration features of different graphics cards.
3466 Very fast video output driver on cards that support it.
3470 Explicitly choose the VIDIX subdevice driver to use.
3471 Available subdevice drivers are cyberblade, ivtv, mach64,
3472 mga_crtc2, mga, nvidia, pm2, pm3, radeon, rage128, s3, sh_veu,
3473 sis_vid and unichrome.
3478 .B xvidix (X11 only)
3479 X11 frontend for VIDIX
3489 Generic and platform independent VIDIX frontend, can even run in a
3490 text console with nVidia cards.
3499 .B winvidix (Windows only)
3500 Windows frontend for VIDIX
3509 .B direct3d (Windows only) (BETA CODE!)
3510 Video output driver that uses the Direct3D interface (useful for Vista).
3513 .B directx (Windows only)
3514 Video output driver that uses the DirectX interface.
3518 Turns off hardware acceleration.
3519 Try this option if you have display problems.
3524 .B quartz (Mac OS X only)
3525 Mac OS X Quartz video output driver.
3526 Under some circumstances, it might be more efficient to force a
3527 packed YUV output format, with e.g.\& \-vf format=yuy2.
3530 .IPs device_id=<number>
3531 Choose the display device to use in fullscreen.
3532 .IPs fs_res=<width>:<height>
3533 Specify the fullscreen resolution (useful on slow systems).
3538 .B macosx (Mac OS X 10.4 or 10.3.9 with QuickTime 7)
3539 Mac OS X CoreVideo video output driver
3542 .IPs device_id=<number>
3543 Choose the display device to use in fullscreen.
3548 .B fbdev (Linux only)
3549 Uses the kernel framebuffer to play video.
3553 Explicitly choose the fbdev device name to use (e.g.\& /dev/\:fb0) or the
3554 name of the VIDIX subdevice if the device name starts with 'vidix'
3555 (e.g.\& 'vidixsis_vid' for the sis driver).
3560 .B fbdev2 (Linux only)
3561 Uses the kernel framebuffer to play video,
3562 alternative implementation.
3566 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3572 Very general video output driver that should work on any VESA VBE 2.0
3577 Turns DGA mode on or off (default: on).
3579 Activate the NeoMagic TV out and set it to PAL norm.
3581 Activate the NeoMagic TV out and set it to NTSC norm.
3583 Use the VIDIX driver.
3585 Activate the Linux Video Overlay on top of VESA mode.
3591 Play video using the SVGA library.
3595 Specify video mode to use.
3596 The mode can be given in a <width>x<height>x<colors> format,
3597 e.g.\& 640x480x16M or be a graphics mode number, e.g.\& 84.
3599 Draw OSD into black bands below the movie (slower).
3601 Use only native drawing functions.
3602 This avoids direct rendering, OSD and hardware acceleration.
3604 Force frame switch on vertical retrace.
3605 Usable only with \-double.
3606 It has the same effect as the \-vsync option.
3608 Try to select a video mode with square pixels.
3610 Use svga with VIDIX.
3616 OpenGL video output driver, simple version.
3617 Video size must be smaller than
3618 the maximum texture size of your OpenGL implementation.
3619 Intended to work even with the most basic OpenGL implementations,
3620 but also makes use of newer extensions, which allow support for more
3621 colorspaces and direct rendering.
3622 For optimal speed try something similar to
3624 \-vo gl:yuv=2:force\-pbo:ati\-hack \-dr \-noslices
3626 The code performs very few checks, so if a feature does not work, this
3627 might be because it is not supported by your card/OpenGL implementation
3628 even if you do not get any error message.
3629 Use glxinfo or a similar tool to display the supported OpenGL extensions.
3633 ATI drivers may give a corrupted image when PBOs are used (when using \-dr
3635 This option fixes this, at the expense of using a bit more memory.
3637 Always uses PBOs to transfer textures even if this involves an extra copy.
3638 Currently this gives a little extra speed with NVidia drivers and a lot more
3639 speed with ATI drivers.
3640 May need \-noslices and the ati\-hack suboption to work correctly.
3642 Changes the way the OSD behaves when the size of the
3643 window changes (default: disabled).
3644 When enabled behaves more like the other video output drivers,
3645 which is better for fixed-size fonts.
3646 Disabled looks much better with FreeType fonts and uses the
3647 borders in fullscreen mode.
3648 Does not work correctly with ass subtitles (see \-ass), you can instead
3649 render them without OpenGL support via \-vf ass.
3650 .IPs osdcolor=<0xAARRGGBB>
3651 Color for OSD (default: 0x00ffffff, corresponds to non-transparent white).
3652 .IPs rectangle=<0,1,2>
3653 Select usage of rectangular textures which saves video RAM, but often is
3654 slower (default: 0).
3656 0: Use power-of-two textures (default).
3658 1: Use the GL_ARB_texture_rectangle extension.
3660 2: Use the GL_ARB_texture_non_power_of_two extension.
3661 In some cases only supported in software and thus very slow.
3663 .IPs swapinterval=<n>
3664 Minimum interval between two buffer swaps, counted in
3665 displayed frames (default: 1).
3666 1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
3667 Values below 0 will leave it at the system default.
3668 This limits the framerate to (horizontal refresh rate / n).
3669 Requires GLX_SGI_swap_control support to work.
3670 With some (most/all?) implementations this only works in fullscreen mode.
3672 Select the type of YUV to RGB conversion.
3674 0: Use software conversion (default).
3675 Compatible with all OpenGL versions.
3676 Provides brightness, contrast and saturation control.
3678 1: Use register combiners.
3679 This uses an nVidia-specific extension (GL_NV_register_combiners).
3680 At least three texture units are needed.
3681 Provides saturation and hue control.
3682 This method is fast but inexact.
3684 2: Use a fragment program.
3685 Needs the GL_ARB_fragment_program extension and at least three texture units.
3686 Provides brightness, contrast, saturation and hue control.
3688 3: Use a fragment program using the POW instruction.
3689 Needs the GL_ARB_fragment_program extension and at least three texture units.
3690 Provides brightness, contrast, saturation, hue and gamma control.
3691 Gamma can also be set independently for red, green and blue.
3692 Method 4 is usually faster.
3694 4: Use a fragment program with additional lookup.
3695 Needs the GL_ARB_fragment_program extension and at least four texture units.
3696 Provides brightness, contrast, saturation, hue and gamma control.
3697 Gamma can also be set independently for red, green and blue.
3699 5: Use ATI-specific method (for older cards).
3700 This uses an ATI-specific extension (GL_ATI_fragment_shader \- not
3701 GL_ARB_fragment_shader!).
3702 At least three texture units are needed.
3703 Provides saturation and hue control.
3704 This method is fast but inexact.
3706 6: Use a 3D texture to do conversion via lookup.
3707 Needs the GL_ARB_fragment_program extension and at least four texture units.
3708 Extremely slow (software emulation) on some (all?) ATI cards since it uses
3709 a texture with border pixels.
3710 Provides brightness, contrast, saturation, hue and gamma control.
3711 Gamma can also be set independently for red, green and blue.
3712 Speed depends more on GPU memory bandwidth than other methods.
3715 Select the scaling function to use for luminance scaling.
3716 Only valid for yuv modes 2, 3, 4 and 6.
3718 0: Use simple linear filtering (default).
3720 1: Use bicubic B-spline filtering (better quality).
3721 Needs one additional texture unit.
3722 Older cards will not be able to handle this for chroma at least in fullscreen mode.
3724 2: Use cubic filtering in horizontal, linear filtering in vertical direction.
3725 Works on a few more cards than method 1.
3727 3: Same as 1 but does not use a lookup texture.
3728 Might be faster on some cards.
3730 4: Use experimental unsharp masking with 3x3 support and a strength of 0.5.
3732 5: Use experimental unsharp masking with 5x5 support and a strength of 0.5.
3735 Select the scaling function to use for chrominance scaling.
3736 For details see lscale.
3737 .IPs customprog=<filename>
3738 Load a custom fragment program from <filename>.
3739 See TOOLS/edgedect.fp for an example.
3740 .IPs customtex=<filename>
3741 Load a custom "gamma ramp" texture from <filename>.
3742 This can be used in combination with yuv=4 or with the customprog option.
3744 If enabled (default) use GL_LINEAR interpolation, otherwise use GL_NEAREST
3745 for customtex texture.
3746 .IPs (no)customtrect
3747 If enabled, use texture_rectangle for customtex texture.
3748 Default is disabled.
3752 Normally there is no reason to use the following options, they mostly
3753 exist for testing purposes.
3758 Call glFinish() before swapping buffers.
3759 Slower but in some cases more correct output (default: disabled).
3761 Enables support for more (RGB and BGR) color formats (default: enabled).
3762 Needs OpenGL version >= 1.2.
3763 .IPs slice-height=<0\-...>
3764 Number of lines copied to texture in one piece (default: 0).
3768 If YUV colorspace is used (see yuv suboption), special rules apply:
3770 If the decoder uses slice rendering (see \-noslices), this setting
3771 has no effect, the size of the slices as provided by the decoder is used.
3773 If the decoder does not use slice rendering, the default is 16.
3776 Enable or disable support for OSD rendering via OpenGL (default: enabled).
3777 This option is for testing; to disable the OSD use \-osdlevel 0 instead.
3779 Enable or disable aspect scaling and pan-and-scan support (default: enabled).
3780 Disabling might increase speed.
3787 Variant of the OpenGL video output driver.
3788 Supports videos larger than the maximum texture size but lacks many of the
3789 advanced features and optimizations of the gl driver and is unlikely to be
3794 same as gl (default: enabled)
3796 Select the type of YUV to RGB conversion.
3797 If set to anything except 0 OSD will be disabled and brightness, contrast and
3798 gamma setting is only available via the global X server settings.
3799 Apart from this the values have the same meaning as for \-vo gl.
3804 Produces no video output.
3805 Useful for benchmarking.
3809 ASCII art video output driver that works on a text console.
3810 You can get a list and an explanation of available suboptions
3811 by executing 'mplayer \-vo aa:help'.
3814 The driver does not handle \-aspect correctly.
3817 You probably have to specify \-monitorpixelaspect.
3818 Try 'mplayer \-vo aa \-monitorpixelaspect 0.5'.
3822 Color ASCII art video output driver that works on a text console.
3826 Video playback using the Blinkenlights UDP protocol.
3827 This driver is highly hardware specific.
3831 Explicitly choose the Blinkenlights subdevice driver to use.
3832 It is something like arcade:host=localhost:2323 or
3833 hdl:file=name1,file=name2.
3834 You must specify a subdevice.
3840 GGI graphics system video output driver
3844 Explicitly choose the GGI driver to use.
3845 Replace any ',' that would appear in the driver string by a '.'.
3851 Play video using the DirectFB library.
3855 Use the DirectFB instead of the MPlayer keyboard code (default: enabled).
3856 .IPs buffermode=single|double|triple
3857 Double and triple buffering give best results if you want to avoid tearing issues.
3858 Triple buffering is more efficient than double buffering as it does
3859 not block MPlayer while waiting for the vertical retrace.
3860 Single buffering should be avoided (default: single).
3861 .IPs fieldparity=top|bottom
3862 Control the output order for interlaced frames (default: disabled).
3863 Valid values are top = top fields first, bottom = bottom fields first.
3864 This option does not have any effect on progressive film material
3865 like most MPEG movies are.
3866 You need to enable this option if you have tearing issues or unsmooth
3867 motions watching interlaced film material.
3869 Will force layer with ID N for playback (default: \-1 \- auto).
3871 Specify a parameter list for DirectFB.
3877 Matrox G400/\:G450/\:G550 specific video output driver that uses the
3878 DirectFB library to make use of special hardware features.
3879 Enables CRTC2 (second head), displaying video independently of the first head.
3883 same as directfb (default: disabled)
3884 .IPs buffermode=single|double|triple
3885 same as directfb (default: triple)
3886 .IPs fieldparity=top|bottom
3889 Enable the use of the Matrox BES (backend scaler) (default: disabled).
3890 Gives very good results concerning speed and output quality as interpolated
3891 picture processing is done in hardware.
3892 Works only on the primary head.
3894 Make use of the Matrox sub picture layer to display the OSD (default: enabled).
3896 Turn on TV-out on the second head (default: enabled).
3897 The output quality is amazing as it is a full interlaced picture
3898 with proper sync to every odd/\:even field.
3899 .IPs tvnorm=pal|ntsc|auto
3900 Will set the TV norm of the Matrox card without the need
3901 for modifying /etc/\:directfbrc (default: disabled).
3902 Valid norms are pal = PAL, ntsc = NTSC.
3903 Special norm is auto (auto-adjust using PAL/\:NTSC) because it decides
3904 which norm to use by looking at the framerate of the movie.
3910 Matrox specific video output driver that makes use of the YUV back
3911 end scaler on Gxxx cards through a kernel module.
3912 If you have a Matrox card, this is the fastest option.
3916 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3921 .B xmga (Linux, X11 only)
3922 The mga video output driver, running in an X11 window.
3926 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3931 .B s3fb (Linux only) (also see \-vf yuv2 and \-dr)
3932 S3 Virge specific video output driver.
3933 This driver supports the card's YUV conversion and scaling, double
3934 buffering and direct rendering features.
3935 Use \-vf yuy2 to get hardware-accelerated YUY2 rendering, which is
3936 much faster than YV12 on this card.
3940 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3946 Nintendo Wii/GameCube specific video output driver.
3949 .B 3dfx (Linux only)
3950 3dfx-specific video output driver that directly uses
3951 the hardware on top of X11.
3952 Only 16 bpp are supported.
3955 .B tdfxfb (Linux only)
3956 This driver employs the tdfxfb framebuffer driver to play movies with
3957 YUV acceleration on 3dfx cards.
3961 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3966 .B tdfx_vid (Linux only)
3967 3dfx-specific video output driver that works in combination with
3968 the tdfx_vid kernel module.
3972 Explicitly choose the device name to use (default: /dev/\:tdfx_vid).
3977 .B dxr2 (also see \-dxr2) (DXR2 only)
3978 Creative DXR2 specific video output driver.
3982 Output video subdriver to use as overlay (x11, xv).
3988 Sigma Designs em8300 MPEG decoder chip (Creative DXR3, Sigma Designs
3989 Hollywood Plus) specific video output driver.
3990 Also see the lavc video filter.
3994 Activates the overlay instead of TV-out.
3996 Turns on prebuffering.
3998 Will turn on the new sync-engine.
4000 Specifies the TV norm.
4002 0: Does not change current norm (default).
4004 1: Auto-adjust using PAL/\:NTSC.
4006 2: Auto-adjust using PAL/\:PAL-60.
4015 Specifies the device number to use if you have more than one em8300 card.
4021 Conexant CX23415 (iCompression iTVC15) or Conexant CX23416 (iCompression
4022 iTVC16) MPEG decoder chip (Hauppauge WinTV PVR-150/250/350/500)
4023 specific video output driver for TV-out.
4024 Also see the lavc video filter.
4028 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
4030 Explicitly choose the TV-out output to be used for the video signal.
4035 .B v4l2 (requires Linux 2.6.22+ kernel)
4036 Video output driver for V4L2 compliant cards with built-in hardware MPEG decoder.
4037 Also see the lavc video filter.
4041 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
4043 Explicitly choose the TV-out output to be used for the video signal.
4048 .B mpegpes (DVB only)
4049 Video output driver for DVB cards that writes the output to an MPEG-PES file
4050 if no DVB card is installed.
4054 Specifies the device number to use if you have more than one DVB output card
4055 (V3 API only, such as 1.x.y series drivers).
4056 If not specified mplayer will search the first usable card.
4058 output filename (default: ./grab.mpg)
4063 .B zr (also see \-zr* and \-zrhelp)
4064 Video output driver for a number of MJPEG capture/\:playback cards.
4067 .B zr2 (also see the zrmjpeg video filter)
4068 Video output driver for a number of MJPEG capture/\:playback cards,
4073 Specifies the video device to use.
4074 .IPs norm=<PAL|NTSC|SECAM|auto>
4075 Specifies the video norm to use (default: auto).
4077 (De)Activate prebuffering, not yet supported.
4083 Calculate MD5 sums of each frame and write them to a file.
4084 Supports RGB24 and YV12 colorspaces.
4085 Useful for debugging.
4088 .IPs outfile=<value>
4089 Specify the output filename (default: ./md5sums).
4095 Transforms the video stream into a sequence of uncompressed YUV 4:2:0
4096 images and stores it in a file (default: ./stream.yuv).
4097 The format is the same as the one employed by mjpegtools, so this is
4098 useful if you want to process the video with the mjpegtools suite.
4099 It supports the YV12, RGB (24 bpp) and BGR (24 bpp) format.
4100 You can combine it with the \-fixed\-vo option to concatenate files
4101 with the same dimensions and fps value.
4105 Write the output as interlaced frames, top field first.
4107 Write the output as interlaced frames, bottom field first.
4108 .IPs file=<filename>
4109 Write the output to <filename> instead of the default stream.yuv.
4115 If you do not specify any option the output is progressive
4116 (i.e.\& not interlaced).
4121 Output each frame into a single animated GIF file in the current directory.
4122 It supports only RGB format with 24 bpp and the output is converted to 256
4127 Float value to specify framerate (default: 5.0).
4129 Specify the output filename (default: ./out.gif).
4135 You must specify the framerate before the filename or the framerate will
4136 be part of the filename.
4142 mplayer video.nut \-vo gif89a:fps=15:output=test.gif
4148 Output each frame into a JPEG file in the current directory.
4149 Each file takes the frame number padded with leading zeros as name.
4152 .IPs [no]progressive
4153 Specify standard or progressive JPEG (default: noprogressive).
4155 Specify use of baseline or not (default: baseline).
4156 .IPs optimize=<0\-100>
4157 optimization factor (default: 100)
4158 .IPs smooth=<0\-100>
4159 smooth factor (default: 0)
4160 .IPs quality=<0\-100>
4161 quality factor (default: 75)
4162 .IPs outdir=<dirname>
4163 Specify the directory to save the JPEG files to (default: ./).
4164 .IPs subdirs=<prefix>
4165 Create numbered subdirectories with the specified prefix to
4166 save the files in instead of the current directory.
4167 .IPs "maxfiles=<value> (subdirs only)"
4168 Maximum number of files to be saved per subdirectory.
4169 Must be equal to or larger than 1 (default: 1000).
4175 Output each frame into a PNM file in the current directory.
4176 Each file takes the frame number padded with leading zeros as name.
4177 It supports PPM, PGM and PGMYUV files in both raw and ASCII mode.
4178 Also see pnm(5), ppm(5) and pgm(5).
4182 Write PPM files (default).
4187 PGMYUV is like PGM, but it also contains the U and V plane, appended at the
4188 bottom of the picture.
4190 Write PNM files in raw mode (default).
4192 Write PNM files in ASCII mode.
4193 .IPs outdir=<dirname>
4194 Specify the directory to save the PNM files to (default: ./).
4195 .IPs subdirs=<prefix>
4196 Create numbered subdirectories with the specified prefix to
4197 save the files in instead of the current directory.
4198 .IPs "maxfiles=<value> (subdirs only)"
4199 Maximum number of files to be saved per subdirectory.
4200 Must be equal to or larger than 1 (default: 1000).
4206 Output each frame into a PNG file in the current directory.
4207 Each file takes the frame number padded with leading zeros as name.
4208 24bpp RGB and BGR formats are supported.
4212 Specifies the compression level.
4213 0 is no compression, 9 is maximum compression.
4219 Output each frame into a Targa file in the current directory.
4220 Each file takes the frame number padded with leading zeros as name.
4221 The purpose of this video output driver is to have a simple lossless
4222 image writer to use without any external library.
4223 It supports the BGR[A] color format, with 15, 24 and 32 bpp.
4224 You can force a particular format with the format video filter.
4230 mplayer video.nut \-vf format=bgr15 \-vo tga
4236 .SH "DECODING/FILTERING OPTIONS"
4239 .B \-ac <[\-|+]codec1,[\-|+]codec2,...[,]>
4240 Specify a priority list of audio codecs to be used, according to their codec
4241 name in codecs.conf.
4242 Use a '\-' before the codec name to omit it.
4243 Use a '+' before the codec name to force it, this will likely crash!
4244 If the list has a trailing ',' MPlayer will fall back on codecs not
4245 contained in the list.
4248 See \-ac help for a full list of available codecs.
4254 Force the l3codeca.acm MP3 codec.
4256 Try libmad first, then fall back on others.
4257 .IPs "\-ac hwac3,a52,"
4258 Try hardware AC-3 passthrough, software AC-3, then others.
4260 Try hardware DTS passthrough, then fall back on others.
4261 .IPs "\-ac \-ffmp3,"
4262 Skip FFmpeg's MP3 decoder.
4267 .B \-af\-adv <force=(0\-7):list=(filters)> (also see \-af)
4268 Specify advanced audio filter options:
4271 Forces the insertion of audio filters to one of the following:
4273 0: Use completely automatic filter insertion.
4275 1: Optimize for accuracy (default).
4277 2: Optimize for speed.
4279 Some features in the audio filters may silently fail,
4280 and the sound quality may drop.
4282 3: Use no automatic insertion of filters and no optimization.
4284 It may be possible to crash MPlayer using this setting.
4286 4: Use automatic insertion of filters according to 0 above,
4287 but use floating point processing when possible.
4289 5: Use automatic insertion of filters according to 1 above,
4290 but use floating point processing when possible.
4292 6: Use automatic insertion of filters according to 2 above,
4293 but use floating point processing when possible.
4295 7: Use no automatic insertion of filters according to 3 above,
4296 and use floating point processing when possible.
4303 .B \-afm <driver1,driver2,...>
4304 Specify a priority list of audio codec families to be used, according
4305 to their codec name in codecs.conf.
4306 Falls back on the default codecs if none of the given codec families work.
4309 See \-afm help for a full list of available codec families.
4315 Try FFmpeg's libavcodec codecs first.
4316 .IPs "\-afm acm,dshow"
4317 Try Win32 codecs first.
4322 .B \-aspect <ratio> (also see \-zoom)
4323 Override movie aspect ratio, in case aspect information is
4324 incorrect or missing in the file being played.
4329 \-aspect 4:3 or \-aspect 1.3333
4331 \-aspect 16:9 or \-aspect 1.7777
4337 Disable automatic movie aspect ratio compensation.
4340 .B "\-field\-dominance <\-1\-1>"
4341 Set first field for interlaced content.
4342 Useful for deinterlacers that double the framerate: \-vf tfields=1,
4343 \-vf yadif=1 and \-vo xvmc:bobdeint.
4347 auto (default): If the decoder does not export the appropriate information,
4348 it falls back to 0 (top field first).
4358 Flip image upside-down.
4361 .B \-lavdopts <option1:option2:...> (DEBUG CODE)
4362 Specify libavcodec decoding parameters.
4363 Separate multiple options with a colon.
4368 \-lavdopts gray:skiploopfilter=all:skipframe=nonref
4373 Available options are:
4377 Only use bit-exact algorithms in all decoding steps (for codec testing).
4379 Manually work around encoder bugs.
4383 1: autodetect bugs (default)
4385 2 (msmpeg4v3): some old lavc generated msmpeg4v3 files (no autodetection)
4387 4 (mpeg4): Xvid interlacing bug (autodetected if fourcc==XVIX)
4389 8 (mpeg4): UMP4 (autodetected if fourcc==UMP4)
4391 16 (mpeg4): padding bug (autodetected)
4393 32 (mpeg4): illegal vlc bug (autodetected per fourcc)
4395 64 (mpeg4): Xvid and DivX qpel bug (autodetected per fourcc/\:version)
4397 128 (mpeg4): old standard qpel (autodetected per fourcc/\:version)
4399 256 (mpeg4): another qpel bug (autodetected per fourcc/\:version)
4401 512 (mpeg4): direct-qpel-blocksize bug (autodetected per fourcc/\:version)
4403 1024 (mpeg4): edge padding bug (autodetected per fourcc/\:version)
4406 Display debugging information.
4417 8: macroblock (MB) type
4419 16: per-block quantization parameter (QP)
4423 0x0040: motion vector visualization (use \-noslices)
4425 0x0080: macroblock (MB) skip
4431 0x0400: error resilience
4433 0x0800: memory management control operations (H.264)
4437 0x2000: Visualize quantization parameter (QP), lower QP are tinted greener.
4439 0x4000: Visualize block types.
4442 Set error concealment strategy.
4444 1: Use strong deblock filter for damaged MBs.
4446 2: iterative motion vector (MV) search (slow)
4451 Set error resilience strategy.
4456 1: careful (Should work with broken encoders.)
4458 2: normal (default) (Works with compliant encoders.)
4460 3: aggressive (More checks, but might cause problems even for valid bitstreams.)
4464 .IPs "fast (MPEG-2, MPEG-4, and H.264 only)"
4465 Enable optimizations which do not comply to the specification and might
4466 potentially cause problems, like simpler dequantization, simpler motion
4467 compensation, assuming use of the default quantization matrix, assuming
4468 YUV 4:2:0 and skipping a few checks to detect damaged bitstreams.
4470 grayscale only decoding (a bit faster than with color)
4471 .IPs "idct=<0\-99> (see \-lavcopts)"
4472 For best decoding quality use the same IDCT algorithm for decoding and encoding.
4473 This may come at a price in accuracy, though.
4474 .IPs lowres=<number>[,<w>]
4475 Decode at lower resolutions.
4476 Low resolution decoding is not supported by all codecs, and it will
4477 often result in ugly artifacts.
4478 This is not a bug, but a side effect of not decoding at full resolution.
4490 If <w> is specified lowres decoding will be used only if the width of the
4491 video is major than or equal to <w>.
4493 .B o=<key>=<value>[,<key>=<value>[,...]]
4494 Pass AVOptions to libavcodec decoder.
4495 Note, a patch to make the o= unneeded and pass all unknown options through
4496 the AVOption system is welcome.
4497 A full list of AVOptions can be found in the FFmpeg manual.
4498 Note that some options may conflict with MEncoder options.
4508 .IPs "sb=<number> (MPEG-2 only)"
4509 Skip the given number of macroblock rows at the bottom.
4510 .IPs "st=<number> (MPEG-2 only)"
4511 Skip the given number of macroblock rows at the top.
4512 .IPs "skiploopfilter=<skipvalue> (H.264 only)"
4513 Skips the loop filter (AKA deblocking) during H.264 decoding.
4514 Since the filtered frame is supposed to be used as reference
4515 for decoding dependent frames this has a worse effect on quality
4516 than not doing deblocking on e.g.\& MPEG-2 video.
4517 But at least for high bitrate HDTV this provides a big speedup with
4518 no visible quality loss.
4520 <skipvalue> can be either one of the following:
4525 default: Skip useless processing steps (e.g.\& 0 size packets in AVI).
4527 nonref: Skip frames that are not referenced (i.e.\& not used for
4528 decoding other frames, the error cannot "build up").
4530 bidir: Skip B-Frames.
4532 nonkey: Skip all frames except keyframes.
4534 all: Skip all frames.
4536 .IPs "skipidct=<skipvalue> (MPEG-1/2 only)"
4537 Skips the IDCT step.
4538 This degrades quality a lot of in almost all cases
4539 (see skiploopfilter for available skip values).
4540 .IPs skipframe=<skipvalue>
4541 Skips decoding of frames completely.
4542 Big speedup, but jerky motion and sometimes bad artifacts
4543 (see skiploopfilter for available skip values).
4544 .IPs "threads=<1\-8> (MPEG-1/2 and H.264 only)"
4545 number of threads to use for decoding (default: 1)
4547 Visualize motion vectors.
4552 1: Visualize forward predicted MVs of P-frames.
4554 2: Visualize forward predicted MVs of B-frames.
4556 4: Visualize backward predicted MVs of B-frames.
4559 Prints some statistics and stores them in ./vstats_*.log.
4564 Disable drawing video by 16-pixel height slices/\:bands, instead draws the
4565 whole frame in a single run.
4566 May be faster or slower, depending on video card and available cache.
4567 It has effect only with libmpeg2 and libavcodec codecs.
4571 Do not play/\:encode sound.
4572 Useful for benchmarking.
4576 Do not play/\:encode video.
4577 In many cases this will not work, use \-vc null \-vo null instead.
4580 .B \-pp <quality> (also see \-vf pp)
4581 Set the DLL postprocess level.
4582 This option is no longer usable with \-vf pp.
4583 It only works with Win32 DirectShow DLLs with internal postprocessing routines.
4584 The valid range of \-pp values varies by codec, it is mostly
4585 0\-6, where 0=disable, 6=slowest/\:best.
4588 .B \-pphelp (also see \-vf pp)
4589 Show a summary about the available postprocess filters and their usage.
4593 Specifies software scaler parameters.
4598 \-vf scale \-ssf lgb=3.0
4604 gaussian blur filter (luma)
4606 gaussian blur filter (chroma)
4607 .IPs ls=<\-100\-100>
4608 sharpen filter (luma)
4609 .IPs cs=<\-100\-100>
4610 sharpen filter (chroma)
4612 chroma horizontal shifting
4614 chroma vertical shifting
4620 Select type of MP2/\:MP3 stereo output.
4633 .B \-sws <software scaler type> (also see \-vf scale and \-zoom)
4634 Specify the software scaler algorithm to be used with the \-zoom option.
4635 This affects video output drivers which lack hardware acceleration, e.g.\& x11.
4637 Available types are:
4646 bicubic (good quality) (default)
4650 nearest neighbor (bad quality)
4654 luma bicubic / chroma bilinear
4662 natural bicubic spline
4668 Some \-sws options are tunable.
4669 The description of the scale video filter has further information.
4673 .B \-vc <[\-|+]codec1,[\-|+]codec2,...[,]>
4674 Specify a priority list of video codecs to be used, according to their codec
4675 name in codecs.conf.
4676 Use a '\-' before the codec name to omit it.
4677 Use a '+' before the codec name to force it, this will likely crash!
4678 If the list has a trailing ',' MPlayer will fall back on codecs not
4679 contained in the list.
4682 See \-vc help for a full list of available codecs.
4688 Force Win32/\:VfW DivX codec, no fallback.
4689 .IPs "\-vc \-divxds,\-divx,"
4690 Skip Win32 DivX codecs.
4691 .IPs "\-vc ffmpeg12,mpeg12,"
4692 Try libavcodec's MPEG-1/2 codec, then libmpeg2, then others.
4697 .B \-vfm <driver1,driver2,...>
4698 Specify a priority list of video codec families to be used, according
4699 to their names in codecs.conf.
4700 Falls back on the default codecs if none of the given codec families work.
4703 See \-vfm help for a full list of available codec families.
4708 .IPs "\-vfm ffmpeg,dshow,vfw"
4709 Try the libavcodec, then Directshow, then VfW codecs and fall back
4710 on others, if they do not work.
4712 Try XAnim codecs first.
4717 .B \-x <x> (also see \-zoom) (MPlayer only)
4718 Scale image to width <x> (if software/\:hardware scaling is available).
4719 Disables aspect calculations.
4722 .B \-xvidopts <option1:option2:...>
4723 Specify additional parameters when decoding with Xvid.
4726 Since libavcodec is faster than Xvid you might want to use the libavcodec
4727 postprocessing filter (\-vf pp) and decoder (\-vfm ffmpeg) instead.
4729 Xvid's internal postprocessing filters:
4732 .IPs "deblock-chroma (also see \-vf pp)"
4733 chroma deblock filter
4734 .IPs "deblock-luma (also see \-vf pp)"
4736 .IPs "dering-luma (also see \-vf pp)"
4737 luma deringing filter
4738 .IPs "dering-chroma (also see \-vf pp)"
4739 chroma deringing filter
4740 .IPs "filmeffect (also see \-vf noise)"
4741 Adds artificial film grain to the video.
4742 May increase perceived quality, while lowering true quality.
4751 Activate direct rendering method 2.
4753 Deactivate direct rendering method 2.
4758 .B \-xy <value> (also see \-zoom)
4762 Scale image by factor <value>.
4764 Set width to value and calculate height to keep correct aspect ratio.
4769 .B \-y <y> (also see \-zoom) (MPlayer only)
4770 Scale image to height <y> (if software/\:hardware scaling is available).
4771 Disables aspect calculations.
4775 Allow software scaling, where available.
4776 This will allow scaling with output drivers (like x11, fbdev) that
4777 do not support hardware scaling where MPlayer disables scaling by
4778 default for performance reasons.
4783 Audio filters allow you to modify the audio stream and its properties.
4787 .B \-af <filter1[=parameter1:parameter2:...],filter2,...>
4788 Setup a chain of audio filters.
4791 To get a full list of available audio filters, see \-af help.
4793 Audio filters are managed in lists.
4794 There are a few commands to manage the filter list.
4797 .B \-af\-add <filter1[,filter2,...]>
4798 Appends the filters given as arguments to the filter list.
4801 .B \-af\-pre <filter1[,filter2,...]>
4802 Prepends the filters given as arguments to the filter list.
4805 .B \-af\-del <index1[,index2,...]>
4806 Deletes the filters at the given indexes.
4807 Index numbers start at 0, negative numbers address the end of the
4808 list (\-1 is the last).
4812 Completely empties the filter list.
4814 Available filters are:
4817 .B resample[=srate[:sloppy[:type]]]
4818 Changes the sample rate of the audio stream.
4819 Can be used if you have a fixed frequency sound card or if you are
4820 stuck with an old sound card that is only capable of max 44.1kHz.
4821 This filter is automatically enabled if necessary.
4822 It only supports 16-bit integer and float in native-endian format as input.
4825 With MEncoder, you need to also use \-srate <srate>.
4829 output sample frequency in Hz.
4830 The valid range for this parameter is 8000 to 192000.
4831 If the input and output sample frequency are the same or if this
4832 parameter is omitted the filter is automatically unloaded.
4833 A high sample frequency normally improves the audio quality,
4834 especially when used in combination with other filters.
4836 Allow (1) or disallow (0) the output frequency to differ slightly
4837 from the frequency given by <srate> (default: 1).
4838 Can be used if the startup of the playback is extremely slow.
4840 Selects which resampling method to use.
4842 0: linear interpolation (fast, poor quality especially when upsampling)
4844 1: polyphase filterbank and integer processing
4846 2: polyphase filterbank and floating point processing (slow, best quality)
4856 .IPs "mplayer \-af resample=44100:0:0"
4857 would set the output frequency of the resample filter to 44100Hz using
4858 exact output frequency scaling and linear interpolation.
4863 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
4864 Changes the sample rate of the audio stream to an integer <srate> in Hz.
4865 It only supports the 16-bit native-endian format.
4868 With MEncoder, you need to also use \-srate <srate>.
4872 the output sample rate
4874 length of the filter with respect to the lower sampling rate (default: 16)
4876 if 1 then filters will be linearly interpolated between polyphase entries
4878 log2 of the number of polyphase entries
4879 (..., 10->1024, 11->2048, 12->4096, ...)
4882 cutoff frequency (0.0\-1.0), default set depending upon filter length
4887 .B lavcac3enc[=tospdif[:bitrate[:minchn]]]
4888 Encode multi-channel audio to AC-3 at runtime using libavcodec.
4889 Supports 16-bit native-endian input format, maximum 6 channels.
4890 The output is big-endian when outputting a raw AC-3 stream,
4891 native-endian when outputting to S/PDIF.
4892 The output sample rate of this filter is same with the input sample rate.
4893 When input sample rate is 48kHz, 44.1kHz, or 32kHz, this filter directly use it.
4894 Otherwise a resampling filter is auto-inserted before this filter to make
4895 the input and output sample rate be 48kHz.
4896 You need to specify '\-channels N' to make the decoder decode audio into
4897 N-channel, then the filter can encode the N-channel input to AC-3.
4902 Output raw AC-3 stream if zero or not set,
4903 output to S/PDIF for passthrough when <tospdif> is set non-zero.
4905 The bitrate to encode the AC-3 stream.
4906 Set it to either 384 or 384000 to get 384kbits.
4907 Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256,
4908 320, 384, 448, 512, 576, 640
4909 Default bitrate is based on the input channel number:
4910 1ch: 96, 2ch: 192, 3ch: 224, 4ch: 384, 5ch: 448, 6ch: 448
4912 If the input channel number is less than <minchn>, the filter will
4913 detach itself (default: 5).
4919 Produces a sine sweep.
4923 Sine function delta, use very low values to hear the sweep.
4928 .B sinesuppress[=freq:decay]
4929 Remove a sine at the specified frequency.
4930 Useful to get rid of the 50/60Hz noise on low quality audio equipment.
4931 It probably only works on mono input.
4935 The frequency of the sine which should be removed (in Hz) (default: 50)
4937 Controls the adaptivity (a larger value will make the filter adapt to
4938 amplitude and phase changes quicker, a smaller value will make the
4939 adaptation slower) (default: 0.0001).
4940 Reasonable values are around 0.001.
4946 Head-related transfer function: Converts multichannel audio to
4947 2 channel output for headphones, preserving the spatiality of the sound.
4952 .IPs "m matrix decoding of the rear channel"
4953 .IPs "s 2-channel matrix decoding"
4954 .IPs "0 no matrix decoding (default)"
4959 .B equalizer=[g1:g2:g3:...:g10]
4960 10 octave band graphic equalizer, implemented using 10 IIR band pass filters.
4961 This means that it works regardless of what type of audio is being played back.
4962 The center frequencies for the 10 bands are:
4966 .IPs "No. frequency"
4981 If the sample rate of the sound being played is lower than the center
4982 frequency for a frequency band, then that band will be disabled.
4983 A known bug with this filter is that the characteristics for the
4984 uppermost band are not completely symmetric if the sample
4985 rate is close to the center frequency of that band.
4986 This problem can be worked around by upsampling the sound
4987 using the resample filter before it reaches this filter.
4991 .IPs <g1>:<g2>:<g3>:...:<g10>
4992 floating point numbers representing the gain in dB
4993 for each frequency band (\-12\-12)
5000 .IPs "mplayer \-af equalizer=11:11:10:5:0:\-12:0:5:12:12 media.avi"
5001 Would amplify the sound in the upper and lower frequency region
5002 while canceling it almost completely around 1kHz.
5007 .B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...]
5008 Can be used for adding, removing, routing and copying audio channels.
5009 If only <nch> is given the default routing is used, it works as
5010 follows: If the number of output channels is bigger than the number of
5011 input channels empty channels are inserted (except mixing from mono to
5012 stereo, then the mono channel is repeated in both of the output
5014 If the number of output channels is smaller than the number
5015 of input channels the exceeding channels are truncated.
5019 number of output channels (1\-6)
5021 number of routes (1\-6)
5022 .IPs <from1:to1:from2:to2:from3:to3:...>
5023 Pairs of numbers between 0 and 5 that define where to route each channel.
5030 .IPs "mplayer \-af channels=4:4:0:1:1:0:2:2:3:3 media.avi"
5031 Would change the number of channels to 4 and set up 4 routes that
5032 swap channel 0 and channel 1 and leave channel 2 and 3 intact.
5033 Observe that if media containing two channels was played back, channels
5034 2 and 3 would contain silence but 0 and 1 would still be swapped.
5035 .IPs "mplayer \-af channels=6:4:0:0:0:1:0:2:0:3 media.avi"
5036 Would change the number of channels to 6 and set up 4 routes
5037 that copy channel 0 to channels 0 to 3.
5038 Channel 4 and 5 will contain silence.
5043 .B format[=format] (also see \-format)
5044 Convert between different sample formats.
5045 Automatically enabled when needed by the sound card or another filter.
5049 Sets the desired format.
5050 The general form is 'sbe', where 's' denotes the sign (either 's' for signed
5051 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32)
5052 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian
5053 and 'ne' the endianness of the computer MPlayer is running on).
5054 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'.
5055 Exceptions to this rule that are also valid format specifiers: u8, s8,
5056 floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm.
5062 Implements software volume control.
5063 Use this filter with caution since it can reduce the signal
5064 to noise ratio of the sound.
5065 In most cases it is best to set the level for the PCM sound to max,
5066 leave this filter out and control the output level to your
5067 speakers with the master volume control of the mixer.
5068 In case your sound card has a digital PCM mixer instead of an analog
5069 one, and you hear distortion, use the MASTER mixer instead.
5070 If there is an external amplifier connected to the computer (this
5071 is almost always the case), the noise level can be minimized by
5072 adjusting the master level and the volume knob on the amplifier
5073 until the hissing noise in the background is gone.
5075 This filter has a second feature: It measures the overall maximum
5076 sound level and prints out that level when MPlayer exits.
5077 This volume estimate can be used for setting the sound level in
5078 MEncoder such that the maximum dynamic range is utilized.
5081 This filter is not reentrant and can therefore only be enabled
5082 once for every audio stream.
5086 Sets the desired gain in dB for all channels in the stream
5087 from \-200dB to +60dB, where \-200dB mutes the sound
5088 completely and +60dB equals a gain of 1000 (default: 0).
5090 Turns soft clipping on (1) or off (0).
5091 Soft-clipping can make the sound more smooth if very
5092 high volume levels are used.
5093 Enable this option if the dynamic range of the
5094 loudspeakers is very low.
5097 This feature creates distortion and should be considered a last resort.
5104 .IPs "mplayer \-af volume=10.1:0 media.avi"
5105 Would amplify the sound by 10.1dB and hard-clip if the
5106 sound level is too high.
5111 .B pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...]
5112 Mixes channels arbitrarily.
5113 Basically a combination of the volume and the channels filter
5114 that can be used to down-mix many channels to only a few,
5115 e.g.\& stereo to mono or vary the "width" of the center
5116 speaker in a surround sound system.
5117 This filter is hard to use, and will require some tinkering
5118 before the desired result is obtained.
5119 The number of options for this filter depends on
5120 the number of output channels.
5121 An example how to downmix a six-channel file to two channels with
5122 this filter can be found in the examples section near the end.
5126 number of output channels (1\-6)
5128 How much of input channel i is mixed into output channel j (0\-1).
5129 So in principle you first have n numbers saying what to do with the
5130 first input channel, then n numbers that act on the second input channel
5132 If you do not specify any numbers for some input channels, 0 is assumed.
5139 .IPs "mplayer \-af pan=1:0.5:0.5 media.avi"
5140 Would down-mix from stereo to mono.
5141 .IPs "mplayer \-af pan=3:1:0:0.5:0:1:0.5 media.avi"
5142 Would give 3 channel output leaving channels 0 and 1 intact,
5143 and mix channels 0 and 1 into output channel 2 (which could
5144 be sent to a subwoofer for example).
5150 Adds a subwoofer channel to the audio stream.
5151 The audio data used for creating the subwoofer channel is
5152 an average of the sound in channel 0 and channel 1.
5153 The resulting sound is then low-pass filtered by a 4th order
5154 Butterworth filter with a default cutoff frequency of 60Hz
5155 and added to a separate channel in the audio stream.
5158 Disable this filter when you are playing DVDs with Dolby
5159 Digital 5.1 sound, otherwise this filter will disrupt
5160 the sound to the subwoofer.
5164 cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz)
5165 For the best result try setting the cutoff frequency as low as possible.
5166 This will improve the stereo or surround sound experience.
5168 Determines the channel number in which to insert the sub-channel audio.
5169 Channel number can be between 0 and 5 (default: 5).
5170 Observe that the number of channels will automatically
5171 be increased to <ch> if necessary.
5178 .IPs "mplayer \-af sub=100:4 \-channels 5 media.avi"
5179 Would add a sub-woofer channel with a cutoff frequency of
5180 100Hz to output channel 4.
5186 Creates a center channel from the front channels.
5187 May currently be low quality as it does not implement a
5188 high-pass filter for proper extraction yet, but averages and
5189 halves the channels instead.
5193 Determines the channel number in which to insert the center channel.
5194 Channel number can be between 0 and 5 (default: 5).
5195 Observe that the number of channels will automatically
5196 be increased to <ch> if necessary.
5202 Decoder for matrix encoded surround sound like Dolby Surround.
5203 Many files with 2 channel audio actually contain matrixed surround sound.
5204 Requires a sound card supporting at least 4 channels.
5208 delay time in ms for the rear speakers (0 to 1000) (default: 20)
5209 This delay should be set as follows: If d1 is the distance
5210 from the listening position to the front speakers and d2 is the distance
5211 from the listening position to the rear speakers, then the delay should
5212 be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2.
5219 .IPs "mplayer \-af surround=15 \-channels 4 media.avi"
5220 Would add surround sound decoding with 15ms delay for the sound to the
5226 .B delay[=ch1:ch2:...]
5227 Delays the sound to the loudspeakers such that the sound from the
5228 different channels arrives at the listening position simultaneously.
5229 It is only useful if you have more than 2 loudspeakers.
5233 The delay in ms that should be imposed on each channel
5234 (floating point number between 0 and 1000).
5239 To calculate the required delay for the different channels do as follows:
5241 Measure the distance to the loudspeakers in meters in relation
5242 to your listening position, giving you the distances s1 to s5
5244 There is no point in compensating for the subwoofer (you will not hear the
5247 Subtract the distances s1 to s5 from the maximum distance,
5248 i.e.\& s[i] = max(s) \- s[i]; i = 1...5.
5250 Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5.
5258 .IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi"
5259 Would delay front left and right by 10.5ms, the two rear channels
5260 and the sub by 0ms and the center channel by 7ms.
5265 .B export[=mmapped_file[:nsamples]]
5266 Exports the incoming signal to other processes using memory mapping (mmap()).
5267 Memory mapped areas contain a header:
5270 int nch /*number of channels*/
5271 int size /*buffer size*/
5272 unsigned long long counter /*Used to keep sync, updated every
5273 time new data is exported.*/
5276 The rest is payload (non-interleaved) 16 bit data.
5280 file to map data to (default: ~/.mplayer/\:mplayer-af_export)
5282 number of samples per channel (default: 512)
5289 .IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi"
5290 Would export 1024 samples per channel to '/tmp/mplayer-af_export'.
5295 .B extrastereo[=mul]
5296 (Linearly) increases the difference between left and right channels
5297 which adds some sort of "live" effect to playback.
5301 Sets the difference coefficient (default: 2.5).
5302 0.0 means mono sound (average of both channels), with 1.0 sound will be
5303 unchanged, with \-1.0 left and right channels will be swapped.
5308 .B volnorm[=method:target]
5309 Maximizes the volume without distorting the sound.
5313 Sets the used method.
5315 1: Use a single sample to smooth the variations via the standard
5316 weighted mean over past samples (default).
5318 2: Use several samples to smooth the variations via the standard
5319 weighted mean over past samples.
5322 Sets the target amplitude as a fraction of the maximum for the
5323 sample type (default: 0.25).
5328 .B ladspa=file:label[:controls...]
5329 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
5330 This filter is reentrant, so multiple LADSPA plugins can be used at once.
5334 Specifies the LADSPA plugin library file.
5335 If LADSPA_PATH is set, it searches for the specified file.
5336 If it is not set, you must supply a fully specified pathname.
5338 Specifies the filter within the library.
5339 Some libraries contain only one filter, but others contain many of them.
5340 Entering 'help' here, will list all available filters within the specified
5341 library, which eliminates the use of 'listplugins' from the LADSPA SDK.
5343 Controls are zero or more floating point values that determine the
5344 behavior of the loaded plugin (for example delay, threshold or gain).
5345 In verbose mode (add \-v to the MPlayer command line), all available controls
5346 and their valid ranges are printed.
5347 This eliminates the use of 'analyseplugin' from the LADSPA SDK.
5353 Compressor/expander filter usable for microphone input.
5354 Prevents artifacts on very loud sound and raises the volume on
5356 This filter is untested, maybe even unusable.
5360 Noise gate filter similar to the comp audio filter.
5361 This filter is untested, maybe even unusable.
5365 Simple voice removal filter exploiting the fact that voice is
5366 usually recorded with mono gear and later 'center' mixed onto
5367 the final audio stream.
5368 Beware that this filter will turn your signal into mono.
5369 Works well for 2 channel tracks; do not bother trying it
5370 on anything but 2 channel stereo.
5373 .B scaletempo[=option1:option2:...]
5374 Scales audio tempo without altering pitch, optionally synced to playback
5377 This works by playing \'stride\' ms of audio at normal speed then
5378 consuming \'stride*scale\' ms of input audio.
5379 It pieces the strides together by blending \'overlap\'% of stride with
5380 audio following the previous stride.
5381 It optionally performs a short statistical analysis on the next \'search\'
5382 ms of audio to determine the best overlap position.
5386 Nominal amount to scale tempo.
5387 Scales this amount in addition to speed.
5389 .IPs stride=<amount>
5390 Length in milliseconds to output each stride.
5391 Too high of value will cause noticable skips at high scale amounts and
5392 an echo at low scale amounts.
5393 Very low values will alter pitch.
5394 Increasing improves performance.
5396 .IPs overlap=<percent>
5397 Percentage of stride to overlap.
5398 Decreasing improves performance.
5400 .IPs search=<amount>
5401 Length in milliseconds to search for best overlap position.
5402 Decreasing improves performance greatly.
5403 On slow systems, you will probably want to set this very low.
5405 .IPs speed=<tempo|pitch|both|none>
5406 Set response to speed change.
5409 Scale tempo in sync with speed (default).
5411 Reverses effect of filter.
5412 Scales pitch without altering tempo.
5413 Add \'[ speed_mult 0.9438743126816935\' and \'] speed_mult 1.059463094352953\'
5414 to your input.conf to step by musical semi-tones.
5416 Loses sync with video.
5418 Scale both tempo and pitch.
5420 Ignore speed changes.
5428 .IPs "mplayer \-af scaletempo \-speed 1.2 media.ogg"
5429 Would playback media at 1.2x normal speed, with audio at normal pitch.
5430 Changing playback speed, would change audio tempo to match.
5431 .IPs "mplayer \-af scaletempo=scale=1.2:speed=none \-speed 1.2 media.ogg"
5432 Would playback media at 1.2x normal speed, with audio at normal pitch,
5433 but changing playback speed has no effect on audio tempo.
5434 .IPs "mplayer \-af scaletempo=stride=30:overlap=.50:search=10 media.ogg"
5435 Would tweak the quality and performace parameters.
5436 .IPs "mplayer \-af format=floatne,scaletempo media.ogg"
5437 Would make scaletempo use float code.
5438 Maybe faster on some platforms.
5439 .IPs "mplayer \-af scaletempo=scale=1.2:speed=pitch audio.ogg"
5440 Would playback audio file at 1.2x normal speed, with audio at normal pitch.
5441 Changing playback speed, would change pitch, leaving audio tempo at 1.2x.
5448 Video filters allow you to modify the video stream and its properties.
5452 .B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
5453 Setup a chain of video filters.
5455 Many parameters are optional and set to default values if omitted.
5456 To explicitly use a default value set a parameter to '\-1'.
5457 Parameters w:h means width x height in pixels, x:y means x;y position counted
5458 from the upper left corner of the bigger image.
5461 To get a full list of available video filters, see \-vf help.
5463 Video filters are managed in lists.
5464 There are a few commands to manage the filter list.
5467 .B \-vf\-add <filter1[,filter2,...]>
5468 Appends the filters given as arguments to the filter list.
5471 .B \-vf\-pre <filter1[,filter2,...]>
5472 Prepends the filters given as arguments to the filter list.
5475 .B \-vf\-del <index1[,index2,...]>
5476 Deletes the filters at the given indexes.
5477 Index numbers start at 0, negative numbers address the end of the
5478 list (\-1 is the last).
5482 Completely empties the filter list.
5484 With filters that support it, you can access parameters by their name.
5487 .B \-vf <filter>=help
5488 Prints the parameter names and parameter value ranges for a particular
5492 .B \-vf <filter=named_parameter1=value1[:named_parameter2=value2:...]>
5493 Sets a named parameter to the given value.
5494 Use on and off or yes and no to set flag parameters.
5496 Available filters are:
5500 Crops the given part of the image and discards the rest.
5501 Useful to remove black bands from widescreen movies.
5505 Cropped width and height, defaults to original width and height.
5507 Position of the cropped picture, defaults to center.
5512 .B cropdetect[=limit:round]
5513 Calculates necessary cropping parameters and prints the recommended parameters
5518 Threshold, which can be optionally specified from nothing (0) to
5519 everything (255) (default: 24).
5522 Value which the width/\:height should be divisible by (default: 16).
5523 The offset is automatically adjusted to center the video.
5524 Use 2 to get only even dimensions (needed for 4:2:2 video).
5525 16 is best when encoding to most video codecs.
5530 .B rectangle[=w:h:x:y]
5531 Draws a rectangle of the requested width and height at the specified
5532 coordinates over the image and prints current rectangle parameters
5534 This can be used to find optimal cropping parameters.
5535 If you bind the input.conf directive 'change_rectangle' to keystrokes,
5536 you can move and resize the rectangle on the fly.
5540 width and height (default: \-1, maximum possible width where boundaries
5543 top left corner position (default: \-1, uppermost leftmost)
5548 .B expand[=w:h:x:y:o:a:r]
5549 Expands (not scales) movie resolution to the given value and places the
5550 unscaled original at coordinates x, y.
5551 Can be used for placing subtitles/\:OSD in the resulting black bands.
5554 Expanded width,height (default: original width,height).
5555 Negative values for w and h are treated as offsets to the original size.
5560 .IP expand=0:\-50:0:0
5561 Adds a 50 pixel border to the bottom of the picture.
5565 position of original image on the expanded image (default: center)
5567 OSD/\:subtitle rendering
5569 0: disable (default)
5574 Expands to fit an aspect instead of a resolution (default: 0).
5579 .IP expand=800:::::4/3
5580 Expands to 800x600, unless the source is higher resolution, in which
5581 case it expands to fill a 4/3 aspect.
5585 Rounds up to make both width and height divisible by <r> (default: 1).
5589 .B flip (also see \-flip)
5590 Flips the image upside down.
5594 Mirrors the image on the Y axis.
5598 Rotates the image by 90 degrees and optionally flips it.
5599 For values between 4\-7 rotation is only done if the movie geometry is
5600 portrait and not landscape.
5603 Rotate by 90 degrees clockwise and flip (default).
5605 Rotate by 90 degrees clockwise.
5607 Rotate by 90 degrees counterclockwise.
5609 Rotate by 90 degrees counterclockwise and flip.
5613 .B scale[=w:h[:ilaced[:chr_drop[:par[:par2[:presize[:noup[:arnd]]]]]]]]
5614 Scales the image with the software scaler (slow) and performs a YUV<\->RGB
5615 colorspace conversion (also see \-sws).
5618 scaled width/\:height (default: original width/\:height)
5621 If \-zoom is used, and underlying filters (including libvo) are
5622 incapable of scaling, it defaults to d_width/\:d_height!
5624 0: scaled d_width/\:d_height
5626 \-1: original width/\:height
5628 \-2: Calculate w/h using the other dimension and the prescaled aspect ratio.
5630 \-3: Calculate w/h using the other dimension and the original aspect ratio.
5632 \-(n+8): Like \-n above, but rounding the dimension to the closest multiple of 16.
5635 Toggle interlaced scaling.
5644 0: Use all available input lines for chroma.
5646 1: Use only every 2. input line for chroma.
5648 2: Use only every 4. input line for chroma.
5650 3: Use only every 8. input line for chroma.
5652 .IPs "<par>[:<par2>] (also see \-sws)"
5653 Set some scaling parameters depending on the type of scaler selected
5656 \-sws 2 (bicubic): B (blurring) and C (ringing)
5660 0.00:0.75 VirtualDub's "precise bicubic"
5662 0.00:0.50 Catmull-Rom spline
5664 0.33:0.33 Mitchell-Netravali spline
5666 1.00:0.00 cubic B-spline
5668 \-sws 7 (gaussian): sharpness (0 (soft) \- 100 (sharp))
5670 \-sws 9 (lanczos): filter length (1\-10)
5673 Scale to preset sizes.
5675 qntsc: 352x240 (NTSC quarter screen)
5677 qpal: 352x288 (PAL quarter screen)
5679 ntsc: 720x480 (standard NTSC)
5681 pal: 720x576 (standard PAL)
5683 sntsc: 640x480 (square pixel NTSC)
5685 spal: 768x576 (square pixel PAL)
5688 Disallow upscaling past the original dimensions.
5690 0: Allow upscaling (default).
5692 1: Disallow upscaling if one dimension exceeds its original value.
5694 2: Disallow upscaling if both dimensions exceed their original values.
5697 Accurate rounding for the vertical scaler, which may be faster
5698 or slower than the default rounding.
5700 0: Disable accurate rounding (default).
5702 1: Enable accurate rounding.
5707 .B dsize[=aspect|w:h:aspect-method:r]
5708 Changes the intended display size/\:aspect at an arbitrary point in the
5710 Aspect can be given as a fraction (4/3) or floating point number
5712 Alternatively, you may specify the exact display width and height
5714 Note that this filter does
5716 do any scaling itself; it just affects
5717 what later scalers (software or hardware) will do when auto-scaling to
5721 New display width and height.
5722 Can also be these special values:
5724 0: original display width and height
5726 \-1: original video width and height (default)
5728 \-2: Calculate w/h using the other dimension and the original display
5731 \-3: Calculate w/h using the other dimension and the original video
5739 Specifies a display resolution of 800x600 for a 4/3 aspect video, or
5740 800x450 for a 16/9 aspect video.
5742 .IPs <aspect-method>
5743 Modifies width and height according to original aspect ratios.
5745 \-1: Ignore original aspect ratio (default).
5747 0: Keep display aspect ratio by using <w> and <h> as maximum
5750 1: Keep display aspect ratio by using <w> and <h> as minimum
5753 2: Keep video aspect ratio by using <w> and <h> as maximum
5756 3: Keep video aspect ratio by using <w> and <h> as minimum
5764 Specifies a display resolution of at most 800x600, or smaller, in order
5769 Rounds up to make both width and height divisible by <r> (default: 1).
5774 Forces software YV12/\:I420/\:422P to YUY2 conversion.
5775 Useful for video cards/\:drivers with slow YV12 but fast YUY2 support.
5779 Forces software YVU9 to YV12 colorspace conversion.
5780 Deprecated in favor of the software scaler.
5784 Clamps YUV color values to the CCIR 601 range without doing real conversion.
5788 RGB 24/32 <\-> BGR 24/32 colorspace conversion.
5792 Also perform R <\-> B swapping.
5798 RGB/BGR 8 \-> 15/16/24/32bpp colorspace conversion using palette.
5802 Restricts the colorspace for the next filter without doing any conversion.
5803 Use together with the scale filter for a real conversion.
5806 For a list of available formats see format=fmt=help.
5810 format name like rgb15, bgr24, yv12, etc (default: yuy2)
5815 .B noformat[=fourcc]
5816 Restricts the colorspace for the next filter without doing any conversion.
5817 Unlike the format filter, this will allow any colorspace
5819 the one you specify.
5822 For a list of available formats see noformat=fmt=help.
5826 format name like rgb15, bgr24, yv12, etc (default: yv12)
5831 .B pp[=filter1[:option1[:option2...]]/[\-]filter2...] (also see \-pphelp)
5832 Enables the specified chain of postprocessing subfilters.
5833 Subfilters must be separated by '/' and can be disabled by
5835 Each subfilter and some options have a short and a long name that can be
5836 used interchangeably, i.e.\& dr/dering are the same.
5837 All subfilters share common options to determine their scope:
5841 Automatically switch the subfilter off if the CPU is too slow.
5843 Do chrominance filtering, too (default).
5845 Do luminance filtering only (no chrominance).
5847 Do chrominance filtering only (no luminance).
5854 \-pphelp shows a list of available subfilters.
5856 Available subfilters are
5859 .IPs hb/hdeblock[:difference[:flatness]]
5860 horizontal deblocking filter
5862 <difference>: Difference factor where higher values mean
5863 more deblocking (default: 32).
5865 <flatness>: Flatness threshold where lower values mean
5866 more deblocking (default: 39).
5868 .IPs vb/vdeblock[:difference[:flatness]]
5869 vertical deblocking filter
5871 <difference>: Difference factor where higher values mean
5872 more deblocking (default: 32).
5874 <flatness>: Flatness threshold where lower values mean
5875 more deblocking (default: 39).
5877 .IPs ha/hadeblock[:difference[:flatness]]
5878 accurate horizontal deblocking filter
5880 <difference>: Difference factor where higher values mean
5881 more deblocking (default: 32).
5883 <flatness>: Flatness threshold where lower values mean
5884 more deblocking (default: 39).
5886 .IPs va/vadeblock[:difference[:flatness]]
5887 accurate vertical deblocking filter
5889 <difference>: Difference factor where higher values mean
5890 more deblocking (default: 32).
5892 <flatness>: Flatness threshold where lower values mean
5893 more deblocking (default: 39).
5896 The horizontal and vertical deblocking filters share the
5897 difference and flatness values so you cannot set
5898 different horizontal and vertical thresholds.
5901 experimental horizontal deblocking filter
5903 experimental vertical deblocking filter
5906 .IPs tn/tmpnoise[:threshold1[:threshold2[:threshold3]]]
5907 temporal noise reducer
5909 <threshold1>: larger -> stronger filtering
5911 <threshold2>: larger -> stronger filtering
5913 <threshold3>: larger -> stronger filtering
5915 .IPs al/autolevels[:f/fullyrange]
5916 automatic brightness / contrast correction
5918 f/fullyrange: Stretch luminance to (0\-255).
5920 .IPs lb/linblenddeint
5921 Linear blend deinterlacing filter that deinterlaces the given block
5922 by filtering all lines with a (1 2 1) filter.
5923 .IPs li/linipoldeint
5924 Linear interpolating deinterlacing filter that deinterlaces the given block
5925 by linearly interpolating every second line.
5926 .IPs ci/cubicipoldeint
5927 Cubic interpolating deinterlacing filter deinterlaces the given block
5928 by cubically interpolating every second line.
5930 Median deinterlacing filter that deinterlaces the given block
5931 by applying a median filter to every second line.
5933 FFmpeg deinterlacing filter that deinterlaces the given block
5934 by filtering every second line with a (\-1 4 2 4 \-1) filter.
5936 Vertically applied FIR lowpass deinterlacing filter that deinterlaces
5937 the given block by filtering all lines with a (\-1 2 6 2 \-1) filter.
5938 .IPs fq/forceQuant[:quantizer]
5939 Overrides the quantizer table from the input with the constant
5940 quantizer you specify.
5942 <quantizer>: quantizer to use
5945 default pp filter combination (hb:a,vb:a,dr:a)
5947 fast pp filter combination (h1:a,v1:a,dr:a)
5949 high quality pp filter combination (ha:a:128:7,va:a,dr:a)
5957 .IPs "\-vf pp=hb/vb/dr/al"
5958 horizontal and vertical deblocking, deringing and automatic
5959 brightness/\:contrast
5960 .IPs "\-vf pp=de/\-al"
5961 default filters without brightness/\:contrast correction
5962 .IPs "\-vf pp=default/tmpnoise:1:2:3"
5963 Enable default filters & temporal denoiser.
5964 .IPs "\-vf pp=hb:y/vb:a"
5965 Horizontal deblocking on luminance only, and switch vertical deblocking
5966 on or off automatically depending on available CPU time.
5971 .B spp[=quality[:qp[:mode]]]
5972 Simple postprocessing filter that compresses and decompresses the
5973 image at several (or \- in the case of quality level 6 \- all)
5974 shifts and averages the results.
5979 Force quantization parameter (default: 0, use QP from video).
5981 0: hard thresholding (default)
5983 1: soft thresholding (better deringing, but blurrier)
5985 4: like 0, but also use B-frames' QP (may cause flicker)
5987 5: like 1, but also use B-frames' QP (may cause flicker)
5991 .B uspp[=quality[:qp]]
5992 Ultra simple & slow postprocessing filter that compresses and
5993 decompresses the image at several (or \- in the case of quality
5994 level 8 \- all) shifts and averages the results.
5995 The way this differs from the behavior of spp is that uspp actually
5996 encodes & decodes each case with libavcodec Snow, whereas spp uses
5997 a simplified intra only 8x8 DCT similar to MJPEG.
6002 Force quantization parameter (default: 0, use QP from video).
6006 .B fspp[=quality[:qp[:strength[:bframes]]]]
6007 faster version of the simple postprocessing filter
6010 4\-5 (equivalent to spp; default: 4)
6012 Force quantization parameter (default: 0, use QP from video).
6014 Filter strength, lower values mean more details but also more artifacts,
6015 while higher values make the image smoother but also blurrier (default:
6018 0: do not use QP from B-frames (default)
6020 1: use QP from B-frames too (may cause flicker)
6025 Variant of the spp filter, similar to spp=6 with 7 point DCT where
6026 only the center sample is used after IDCT.
6029 Force quantization parameter (default: 0, use QP from video).
6031 0: hard thresholding
6033 1: soft thresholding (better deringing, but blurrier)
6035 2: medium thresholding (default, good results)
6040 quantization parameter (QP) change filter
6043 some equation like "2+2*sin(PI*qp)"
6048 generic equation change filter
6051 Some equation, e.g.\& 'p(W-X\\,Y)' to flip the image horizontally.
6052 You can use whitespace to make the equation more readable.
6053 There are a couple of constants that can be used in the equation:
6059 X / Y: the coordinates of the current sample
6061 W / H: width and height of the image
6063 SW / SH: width/height scale depending on the currently filtered plane, e.g.\&
6064 1,1 and 0.5,0.5 for YUV 4:2:0.
6066 p(x,y): returns the value of the pixel at location x/y of the current plane.
6072 Generate various test patterns.
6075 .B rgbtest[=width:height]
6076 Generate an RGB test pattern useful for detecting RGB vs BGR issues.
6077 You should see a red, green and blue stripe from top to bottom.
6080 Desired width of generated image (default: 0).
6081 0 means width of input image.
6084 Desired height of generated image (default: 0).
6085 0 means height of input image.
6089 .B lavc[=quality:fps]
6090 Fast software YV12 to MPEG-1 conversion with libavcodec for use with DVB/\:DXR3/\:IVTV/\:V4L2.
6095 32\-: fixed bitrate in kbits
6097 force output fps (float value) (default: 0, autodetect based on height)
6101 .B dvbscale[=aspect]
6102 Set up optimal scaling for DVB cards, scaling the x axis in hardware and
6103 calculating the y axis scaling in software to keep aspect.
6104 Only useful together with expand and scale.
6107 Control aspect ratio, calculate as DVB_HEIGHT*ASPECTRATIO (default:
6108 576*4/3=768), set it to 576*(16/9)=1024 for a 16:9 TV.
6116 .IPs "\-vf dvbscale,scale=\-1:0,expand=\-1:576:\-1:\-1:1,lavc"
6117 FIXME: Explain what this does.
6122 .B noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]]
6131 uniform noise (gaussian otherwise)
6133 temporal noise (noise pattern changes between frames)
6135 averaged temporal noise (smoother, but a lot slower)
6137 high quality (slightly better looking, slightly slower)
6139 mix random noise with a (semi)regular pattern
6144 .B denoise3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
6145 This filter aims to reduce image noise producing smooth images and making still
6146 images really still (This should enhance compressibility.).
6150 spatial luma strength (default: 4)
6151 .IPs <chroma_spatial>
6152 spatial chroma strength (default: 3)
6154 luma temporal strength (default: 6)
6156 chroma temporal strength (default: luma_tmp*chroma_spatial/luma_spatial)
6161 .B hqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
6162 High precision/\:quality version of the denoise3d filter.
6163 Parameters and usage are the same.
6166 .B ow[=depth[:luma_strength[:chroma_strength]]]
6167 Overcomplete Wavelet denoiser.
6171 Larger depth values will denoise lower frequency components more, but
6172 slow down filtering (default: 8).
6173 .IPs <luma_strength>
6174 luma strength (default: 1.0)
6175 .IPs <chroma_strength>
6176 chroma strength (default: 1.0)
6181 .B eq[=brightness:contrast] (OBSOLETE)
6182 Software equalizer with interactive controls just like the hardware
6183 equalizer, for cards/\:drivers that do not support brightness and
6184 contrast controls in hardware.
6185 Might also be useful with MEncoder, either for fixing poorly captured
6186 movies, or for slightly reducing contrast to mask artifacts and get by
6187 with lower bitrates.
6198 .B eq2[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]
6199 Alternative software equalizer that uses lookup tables (very slow),
6200 allowing gamma correction in addition to simple brightness
6201 and contrast adjustment.
6202 Note that it uses the same MMX optimized code as \-vf eq if all
6203 gamma values are 1.0.
6204 The parameters are given as floating point values.
6208 initial gamma value (default: 1.0)
6210 initial contrast, where negative values result in a
6211 negative image (default: 1.0)
6213 initial brightness (default: 0.0)
6215 initial saturation (default: 1.0)
6217 gamma value for the red component (default: 1.0)
6219 gamma value for the green component (default: 1.0)
6221 gamma value for the blue component (default: 1.0)
6223 The weight parameter can be used to reduce the effect of a high gamma value on
6224 bright image areas, e.g.\& keep them from getting overamplified and just plain
6226 A value of 0.0 turns the gamma correction all the way down while 1.0 leaves it
6227 at its full strength (default: 1.0).
6232 .B hue[=hue:saturation]
6233 Software equalizer with interactive controls just like the hardware
6234 equalizer, for cards/\:drivers that do not support hue and
6235 saturation controls in hardware.
6239 initial hue (default: 0.0)
6241 initial saturation, where negative values result
6242 in a negative chroma (default: 1.0)
6248 Convert planar YUV 4:2:0 to half-height packed 4:2:2, downsampling luma but
6249 keeping all chroma samples.
6250 Useful for output to low-resolution display devices when hardware downscaling
6251 is poor quality or is not available.
6252 Can also be used as a primitive luma-only deinterlacer with very low CPU
6257 By default, halfpack averages pairs of lines when downsampling.
6258 Any value different from 0 or 1 gives the default (averaging) behavior.
6260 0: Only use even lines when downsampling.
6262 1: Only use odd lines when downsampling.
6269 When interlaced video is stored in YUV 4:2:0 formats, chroma
6270 interlacing does not line up properly due to vertical downsampling of
6271 the chroma channels.
6272 This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format with
6273 the chroma lines in their proper locations, so that in any given
6274 scanline, the luma and chroma data both come from the same field.
6278 Select the sampling mode.
6280 0: nearest-neighbor sampling, fast but incorrect
6282 1: linear interpolation (default)
6289 Only useful with MEncoder.
6290 If harddup is used when encoding, it will force duplicate frames to be
6291 encoded in the output.
6292 This uses slightly more space, but is necessary for output to MPEG
6293 files or if you plan to demux and remux the video stream after
6295 Should be placed at or near the end of the filter chain unless you
6296 have a good reason to do otherwise.
6300 Only useful with MEncoder.
6301 Softskip moves the frame skipping (dropping) step of encoding from
6302 before the filter chain to some point during the filter chain.
6303 This allows filters which need to see all frames (inverse telecine,
6304 temporal denoising, etc.) to function properly.
6305 Should be placed after the filters which need to see all frames and
6306 before any subsequent filters that are CPU-intensive.
6309 .B decimate[=max:hi:lo:frac]
6310 Drops frames that do not differ greatly from the previous frame in
6311 order to reduce framerate.
6312 The main use of this filter is for very-low-bitrate encoding (e.g.\&
6313 streaming over dialup modem), but it could in theory be used for
6314 fixing movies that were inverse-telecined incorrectly.
6318 Sets the maximum number of consecutive frames which can be
6319 dropped (if positive), or the minimum interval between
6320 dropped frames (if negative).
6321 .IPs <hi>,<lo>,<frac>
6322 A frame is a candidate for dropping if no 8x8 region differs by more
6323 than a threshold of <hi>, and if not more than <frac> portion (1
6324 meaning the whole image) differs by more than a threshold of <lo>.
6325 Values of <hi> and <lo> are for 8x8 pixel blocks and represent actual
6326 pixel value differences, so a threshold of 64 corresponds to 1 unit of
6327 difference for each pixel, or the same spread out differently over the
6333 .B dint[=sense:level]
6334 The drop-deinterlace (dint) filter detects and drops the first from a set
6335 of interlaced video frames.
6339 relative difference between neighboring pixels (default: 0.1)
6341 What part of the image has to be detected as interlaced to
6342 drop the frame (default: 0.15).
6347 .B lavcdeint (OBSOLETE)
6348 FFmpeg deinterlacing filter, same as \-vf pp=fd
6351 .B kerndeint[=thresh[:map[:order[:sharp[:twoway]]]]]
6352 Donald Graft's adaptive kernel deinterlacer.
6353 Deinterlaces parts of a video if a configurable threshold is exceeded.
6357 threshold (default: 10)
6360 0: Ignore pixels exceeding the threshold (default).
6362 1: Paint pixels exceeding the threshold white.
6366 0: Leave fields alone (default).
6372 0: Disable additional sharpening (default).
6374 1: Enable additional sharpening.
6378 0: Disable twoway sharpening (default).
6380 1: Enable twoway sharpening.
6386 .B unsharp[=l|cWxH:amount[:l|cWxH:amount]]
6387 unsharp mask / gaussian blur
6390 Apply effect on luma component.
6392 Apply effect on chroma components.
6393 .IPs <width>x<height>
6394 width and height of the matrix, odd sized in both directions
6395 (min = 3x3, max = 13x11 or 11x13, usually something between 3x3 and 7x7)
6397 Relative amount of sharpness/\:blur to add to the image
6398 (a sane range should be \-1.5\-1.5).
6411 .B il[=d|i][s][:[d|i][s]]
6412 (De)interleaves lines.
6413 The goal of this filter is to add the ability to process interlaced images
6414 pre-field without deinterlacing them.
6415 You can filter your interlaced DVD and play it on a TV without breaking the
6417 While deinterlacing (with the postprocessing filter) removes interlacing
6418 permanently (by smoothing, averaging, etc) deinterleaving splits the frame into
6419 2 fields (so called half pictures), so you can process (filter) them
6420 independently and then re-interleave them.
6424 deinterleave (placing one above the other)
6428 swap fields (exchange even & odd lines)
6434 (De)interleaves lines.
6435 This filter is very similar to the il filter but much faster, the main
6436 disadvantage is that it does not always work.
6437 Especially if combined with other filters it may produce randomly messed
6438 up images, so be happy if it works but do not complain if it does not for
6439 your combination of filters.
6443 Deinterleave fields, placing them side by side.
6445 Interleave fields again (reversing the effect of fil=d).
6451 Extracts a single field from an interlaced image using stride arithmetic
6452 to avoid wasting CPU time.
6453 The optional argument n specifies whether to extract the even or the odd
6454 field (depending on whether n is even or odd).
6457 .B detc[=var1=value1:var2=value2:...]
6458 Attempts to reverse the 'telecine' process to recover a clean,
6459 non-interlaced stream at film framerate.
6460 This was the first and most primitive inverse telecine filter to be
6461 added to MPlayer/\:MEncoder.
6462 It works by latching onto the telecine 3:2 pattern and following it as
6464 This makes it suitable for perfectly-telecined material, even in the
6465 presence of a fair degree of noise, but it will fail in the presence
6466 of complex post-telecine edits.
6467 Development on this filter is no longer taking place, as ivtc, pullup,
6468 and filmdint are better for most applications.
6469 The following arguments (see syntax above) may be used to control
6473 Set the frame dropping mode.
6475 0: Do not drop frames to maintain fixed output framerate (default).
6477 1: Always drop a frame when there have been no drops or telecine
6478 merges in the past 5 frames.
6480 2: Always maintain exact 5:4 input to output frame ratio.
6483 Use mode 1 or 2 with MEncoder.
6488 0: Fixed pattern with initial frame number specified by <fr>.
6490 1: aggressive search for telecine pattern (default)
6493 Set initial frame number in sequence.
6494 0\-2 are the three clean progressive frames; 3 and 4 are the two
6496 The default, \-1, means 'not in telecine sequence'.
6497 The number specified here is the type for the imaginary previous
6498 frame before the movie starts.
6499 .IPs "<t0>, <t1>, <t2>, <t3>"
6500 Threshold values to be used in certain modes.
6505 Experimental 'stateless' inverse telecine filter.
6506 Rather than trying to lock on to a pattern like the detc filter does,
6507 ivtc makes its decisions independently for each frame.
6508 This will give much better results for material that has undergone
6509 heavy editing after telecine was applied, but as a result it is not as
6510 forgiving of noisy input, for example TV capture.
6511 The optional parameter (ivtc=1) corresponds to the dr=1 option for the
6512 detc filter, and should be used with MEncoder but not with MPlayer.
6513 As with detc, you must specify the correct output framerate (\-ofps
6514 24000/1001) when using MEncoder.
6515 Further development on ivtc has stopped, as the pullup and filmdint
6516 filters appear to be much more accurate.
6519 .B pullup[=jl:jr:jt:jb:sb:mp]
6520 Third-generation pulldown reversal (inverse telecine) filter,
6521 capable of handling mixed hard-telecine, 24000/1001 fps progressive, and 30000/1001
6522 fps progressive content.
6523 The pullup filter is designed to be much more robust than detc or
6524 ivtc, by taking advantage of future context in making its decisions.
6525 Like ivtc, pullup is stateless in the sense that it does not lock onto
6526 a pattern to follow, but it instead looks forward to the following
6527 fields in order to identify matches and rebuild progressive frames.
6528 It is still under development, but believed to be quite accurate.
6530 .IPs "jl, jr, jt, and jb"
6531 These options set the amount of "junk" to ignore at
6532 the left, right, top, and bottom of the image, respectively.
6533 Left/\:right are in units of 8 pixels, while top/\:bottom are in units of
6535 The default is 8 pixels on each side.
6537 .IPs "sb (strict breaks)"
6538 Setting this option to 1 will reduce the chances of
6539 pullup generating an occasional mismatched frame, but it may also
6540 cause an excessive number of frames to be dropped during high motion
6542 Conversely, setting it to \-1 will make pullup match fields more
6544 This may help processing of video where there is slight blurring
6545 between the fields, but may also cause there to be interlaced frames
6548 .IPs "mp (metric plane)"
6549 This option may be set to 1 or 2 to use a chroma
6550 plane instead of the luma plane for doing pullup's computations.
6551 This may improve accuracy on very clean source material, but more
6552 likely will decrease accuracy, especially if there is chroma noise
6553 (rainbow effect) or any grayscale video.
6554 The main purpose of setting mp to a chroma plane is to reduce CPU load
6555 and make pullup usable in realtime on slow machines.
6560 Always follow pullup with the softskip filter when encoding to ensure
6561 that pullup is able to see each frame.
6562 Failure to do so will lead to incorrect output and will usually crash,
6563 due to design limitations in the codec/\:filter layer.
6567 .B filmdint[=options]
6568 Inverse telecine filter, similar to the pullup filter above.
6569 It is designed to handle any pulldown pattern, including mixed soft and
6570 hard telecine and limited support for movies that are slowed down or sped
6571 up from their original framerate for TV.
6572 Only the luma plane is used to find the frame breaks.
6573 If a field has no match, it is deinterlaced with simple linear
6575 If the source is MPEG-2, this must be the first filter to allow
6576 access to the field-flags set by the MPEG-2 decoder.
6577 Depending on the source MPEG, you may be fine ignoring this advice, as
6578 long as you do not see lots of "Bottom-first field" warnings.
6579 With no options it does normal inverse telecine, and should be used
6580 together with mencoder \-fps 30000/1001 \-ofps 24000/1001.
6581 When this filter is used with mplayer, it will result in an uneven
6582 framerate during playback, but it is still generally better than using
6583 pp=lb or no deinterlacing at all.
6584 Multiple options can be specified separated by /.
6586 .IPs crop=<w>:<h>:<x>:<y>
6587 Just like the crop filter, but faster, and works on mixed hard and soft
6588 telecined content as well as when y is not a multiple of 4.
6589 If x or y would require cropping fractional pixels from the chroma
6590 planes, the crop area is extended.
6591 This usually means that x and y must be even.
6592 .IPs io=<ifps>:<ofps>
6593 For each ifps input frames the filter will output ofps frames.
6594 The ratio of ifps/\:ofps should match the \-fps/\-ofps ratio.
6595 This could be used to filter movies that are broadcast on TV at a frame
6596 rate different from their original framerate.
6598 If n is nonzero, the chroma plane is copied unchanged.
6599 This is useful for YV12 sampled TV, which discards one of the chroma
6602 On x86, if n=1, use MMX2 optimized functions, if n=2, use 3DNow!
6603 optimized functions, otherwise, use plain C.
6604 If this option is not specified, MMX2 and 3DNow! are auto-detected, use
6605 this option to override auto-detection.
6607 The larger n will speed up the filter at the expense of accuracy.
6608 The default value is n=3.
6609 If n is odd, a frame immediately following a frame marked with the
6610 REPEAT_FIRST_FIELD MPEG flag is assumed to be progressive, thus filter
6611 will not spend any time on soft-telecined MPEG-2 content.
6612 This is the only effect of this flag if MMX2 or 3DNow! is available.
6613 Without MMX2 and 3DNow, if n=0 or 1, the same calculations will be used
6615 If n=2 or 3, the number of luma levels used to find the frame breaks is
6616 reduced from 256 to 128, which results in a faster filter without losing
6618 If n=4 or 5, a faster, but much less accurate metric will be used to
6619 find the frame breaks, which is more likely to misdetect high vertical
6620 detail as interlaced content.
6622 If n is nonzero, print the detailed metrics for each frame.
6623 Useful for debugging.
6625 Deinterlace threshold.
6626 Used during de-interlacing of unmatched frames.
6627 Larger value means less deinterlacing, use n=256 to completely turn off
6631 Threshold for comparing a top and bottom fields.
6634 Threshold to detect temporal change of a field.
6637 Sum of Absolute Difference threshold, default is 64.
6642 This filter works only correct with MEncoder and acts on the MPEG-2 flags
6643 used for soft 3:2 pulldown (soft telecine).
6644 If you want to use the ivtc or detc filter on movies that are partly soft
6645 telecined, inserting this filter before them should make them more reliable.
6649 Inverse telecine for deinterlaced video.
6650 If 3:2-pulldown telecined video has lost one of the fields or is deinterlaced
6651 using a method that keeps one field and interpolates the other, the result is
6652 a juddering video that has every fourth frame duplicated.
6653 This filter is intended to find and drop those duplicates and restore the
6654 original film framerate.
6655 When using this filter, you must specify \-ofps that is 4/5 of
6656 the fps of the input file and place the softskip later in the
6657 filter chain to make sure that divtc sees all the frames.
6658 Two different modes are available:
6659 One pass mode is the default and is straightforward to use,
6660 but has the disadvantage that any changes in the telecine
6661 phase (lost frames or bad edits) cause momentary judder
6662 until the filter can resync again.
6663 Two pass mode avoids this by analyzing the whole video
6664 beforehand so it will have forward knowledge about the
6665 phase changes and can resync at the exact spot.
6668 correspond to pass one and two of the encoding process.
6669 You must run an extra pass using divtc pass one before the
6670 actual encoding throwing the resulting video away.
6671 Use \-nosound \-ovc raw \-o /dev/null to avoid
6672 wasting CPU power for this pass.
6673 You may add something like crop=2:2:0:0 after divtc
6674 to speed things up even more.
6675 Then use divtc pass two for the actual encoding.
6676 If you use multiple encoder passes, use divtc
6677 pass two for all of them.
6682 .IPs file=<filename>
6683 Set the two pass log filename (default: "framediff.log").
6684 .IPs threshold=<value>
6685 Set the minimum strength the telecine pattern must have for the filter to
6686 believe in it (default: 0.5).
6687 This is used to avoid recognizing false pattern from the parts of the video
6688 that are very dark or very still.
6689 .IPs window=<numframes>
6690 Set the number of past frames to look at when searching for pattern
6692 Longer window improves the reliability of the pattern search, but shorter
6693 window improves the reaction time to the changes in the telecine phase.
6694 This only affects the one pass mode.
6695 The two pass mode currently uses fixed window that extends to both future
6697 .IPs phase=0|1|2|3|4
6698 Sets the initial telecine phase for one pass mode (default: 0).
6699 The two pass mode can see the future, so it is able to use the correct
6700 phase from the beginning, but one pass mode can only guess.
6701 It catches the correct phase when it finds it, but this option can be used
6702 to fix the possible juddering at the beginning.
6703 The first pass of the two pass mode also uses this, so if you save the output
6704 from the first pass, you get constant phase result.
6705 .IPs deghost=<value>
6706 Set the deghosting threshold (0\-255 for one pass mode, \-255\-255 for two pass
6708 If nonzero, deghosting mode is used.
6709 This is for video that has been deinterlaced by blending the fields
6710 together instead of dropping one of the fields.
6711 Deghosting amplifies any compression artifacts in the blended frames, so the
6712 parameter value is used as a threshold to exclude those pixels from
6713 deghosting that differ from the previous frame less than specified value.
6714 If two pass mode is used, then negative value can be used to make the
6715 filter analyze the whole video in the beginning of pass-2 to determine
6716 whether it needs deghosting or not and then select either zero or the
6717 absolute value of the parameter.
6718 Specify this option for pass-2, it makes no difference on pass-1.
6722 .B phase[=t|b|p|a|u|T|B|A|U][:v]
6723 Delay interlaced video by one field time so that the field order
6725 The intended use is to fix PAL movies that have been captured with the
6726 opposite field order to the film-to-video transfer.
6730 Capture field order top-first, transfer bottom-first.
6731 Filter will delay the bottom field.
6733 Capture bottom-first, transfer top-first.
6734 Filter will delay the top field.
6736 Capture and transfer with the same field order.
6737 This mode only exists for the documentation of the other options to refer to,
6738 but if you actually select it, the filter will faithfully do nothing ;-)
6740 Capture field order determined automatically by field flags, transfer opposite.
6741 Filter selects among t and b modes on a frame by frame basis using field flags.
6742 If no field information is available, then this works just like u.
6744 Capture unknown or varying, transfer opposite.
6745 Filter selects among t and b on a frame by frame basis by analyzing the
6746 images and selecting the alternative that produces best match between the
6749 Capture top-first, transfer unknown or varying.
6750 Filter selects among t and p using image analysis.
6752 Capture bottom-first, transfer unknown or varying.
6753 Filter selects among b and p using image analysis.
6755 Capture determined by field flags, transfer unknown or varying.
6756 Filter selects among t, b and p using field flags and image analysis.
6757 If no field information is available, then this works just like U.
6758 This is the default mode.
6760 Both capture and transfer unknown or varying.
6761 Filter selects among t, b and p using image analysis only.
6764 Prints the selected mode for each frame and the average squared difference
6765 between fields for t, b, and p alternatives.
6770 Apply 3:2 'telecine' process to increase framerate by 20%.
6771 This most likely will not work correctly with MPlayer, but it can
6772 be used with 'mencoder \-fps 30000/1001 \-ofps 30000/1001 \-vf telecine'.
6773 Both fps options are essential!
6774 (A/V sync will break if they are wrong.)
6775 The optional start parameter tells the filter where in the telecine
6776 pattern to start (0\-3).
6779 .B tinterlace[=mode]
6780 Temporal field interlacing \- merge pairs of frames into an interlaced
6781 frame, halving the framerate.
6782 Even frames are moved into the upper field, odd frames to the lower field.
6783 This can be used to fully reverse the effect of the tfields filter (in mode 0).
6784 Available modes are:
6788 Move odd frames into the upper field, even into the lower field, generating
6789 a full-height frame at half framerate.
6791 Only output odd frames, even frames are dropped; height unchanged.
6793 Only output even frames, odd frames are dropped; height unchanged.
6795 Expand each frame to full height, but pad alternate lines with black;
6796 framerate unchanged.
6798 Interleave even lines from even frames with odd lines from odd frames.
6799 Height unchanged at half framerate.
6804 .B tfields[=mode[:field_dominance]]
6805 Temporal field separation \- split fields into frames, doubling the
6807 Like the telecine filter, tfields will only work properly with
6808 MEncoder, and only if both \-fps and \-ofps are set to the
6809 desired (double) framerate!
6813 0: Leave fields unchanged (will jump/\:flicker).
6815 1: Interpolate missing lines. (The algorithm used might not be so good.)
6817 2: Translate fields by 1/4 pixel with linear interpolation (no jump).
6819 4: Translate fields by 1/4 pixel with 4tap filter (higher quality) (default).
6820 .IPs <field_dominance>\ (DEPRECATED)
6822 Only works if the decoder exports the appropriate information and
6823 no other filters which discard that information come before tfields
6824 in the filter chain, otherwise it falls back to 0 (top field first).
6828 1: bottom field first
6831 This option will possibly be removed in a future version.
6832 Use \-field\-dominance instead.
6837 .B yadif=[mode[:field_dominance]]
6838 Yet another deinterlacing filter
6842 0: Output 1 frame for each frame.
6844 1: Output 1 frame for each field.
6846 2: Like 0 but skips spatial interlacing check.
6848 3: Like 1 but skips spatial interlacing check.
6849 .IPs <field_dominance>\ (DEPRECATED)
6850 Operates like tfields.
6853 This option will possibly be removed in a future version.
6854 Use \-field\-dominance instead.
6859 .B mcdeint=[mode[:parity[:qp]]]
6860 Motion compensating deinterlacer.
6861 It needs one field per frame as input and must thus be used together
6862 with tfields=1 or yadif=1/3 or equivalent.
6870 2: slow, iterative motion estimation
6872 3: extra slow, like 2 plus multiple reference frames
6874 0 or 1 selects which field to use (note: no autodetection yet!).
6876 Higher values should result in a smoother motion vector
6877 field but less optimal individual vectors.
6882 .B boxblur=radius:power[:radius:power]
6887 blur filter strength
6889 number of filter applications
6894 .B sab=radius:pf:colorDiff[:radius:pf:colorDiff]
6899 blur filter strength (~0.1\-4.0) (slower if larger)
6901 prefilter strength (~0.1\-2.0)
6903 maximum difference between pixels to still be considered (~0.1\-100.0)
6908 .B smartblur=radius:strength:threshold[:radius:strength:threshold]
6913 blur filter strength (~0.1\-5.0) (slower if larger)
6915 blur (0.0\-1.0) or sharpen (\-1.0\-0.0)
6917 filter all (0), filter flat areas (0\-30) or filter edges (\-30\-0)
6922 .B perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
6923 Correct the perspective of movies not filmed perpendicular to the screen.
6927 coordinates of the top left, top right, bottom left, bottom right corners
6929 linear (0) or cubic resampling (1)
6935 Scale and smooth the image with the 2x scale and interpolate algorithm.
6939 1bpp bitmap to YUV/\:BGR 8/\:15/\:16/\:32 conversion
6942 .B down3dright[=lines]
6943 Reposition and resize stereoscopic images.
6944 Extracts both stereo fields and places them side by side, resizing
6945 them to maintain the original movie aspect.
6949 number of lines to select from the middle of the image (default: 12)
6954 .B bmovl=hidden:opaque:fifo
6955 The bitmap overlay filter reads bitmaps from a FIFO and displays them
6956 on top of the movie, allowing some transformations on the image.
6957 Also see TOOLS/bmovl-test.c for a small bmovl test program.
6961 Set the default value of the 'hidden' flag (0=visible, 1=hidden).
6963 Set the default value of the 'opaque' flag (0=transparent, 1=opaque).
6965 path/\:filename for the FIFO (named pipe connecting 'mplayer \-vf bmovl' to the
6966 controlling application)
6975 .IPs "RGBA32 width height xpos ypos alpha clear"
6976 followed by width*height*4 Bytes of raw RGBA32 data.
6977 .IPs "ABGR32 width height xpos ypos alpha clear"
6978 followed by width*height*4 Bytes of raw ABGR32 data.
6979 .IPs "RGB24 width height xpos ypos alpha clear"
6980 followed by width*height*3 Bytes of raw RGB24 data.
6981 .IPs "BGR24 width height xpos ypos alpha clear"
6982 followed by width*height*3 Bytes of raw BGR24 data.
6983 .IPs "ALPHA width height xpos ypos alpha"
6984 Change alpha transparency of the specified area.
6985 .IPs "CLEAR width height xpos ypos"
6988 Disable all alpha transparency.
6989 Send "ALPHA 0 0 0 0 0" to enable it again.
7002 .IPs "<width>, <height>"
7004 .IPs "<xpos>, <ypos>"
7005 Start blitting at position x/y.
7007 Set alpha difference.
7008 If you set this to \-255 you can then send a sequence of ALPHA-commands to set
7009 the area to \-225, \-200, \-175 etc for a nice fade-in-effect! ;)
7013 255: Make everything opaque.
7015 \-255: Make everything transparent.
7018 Clear the framebuffer before blitting.
7020 0: The image will just be blitted on top of the old one, so you do not need to
7021 send 1.8MB of RGBA32 data every time a small part of the screen is updated.
7029 .B framestep=I|[i]step
7030 Renders only every nth frame or every intra frame (keyframe).
7032 If you call the filter with I (uppercase) as the parameter, then
7034 keyframes are rendered.
7035 For DVDs it generally means one in every 15/12 frames (IBBPBBPBBPBBPBB),
7036 for AVI it means every scene change or every keyint value (see \-lavcopts
7037 keyint= value if you use MEncoder to encode the video).
7039 When a keyframe is found, an 'I!' string followed by a newline character is
7040 printed, leaving the current line of MPlayer/\:MEncoder output on the screen,
7041 because it contains the time (in seconds) and frame number of the keyframe
7042 (You can use this information to split the AVI.).
7044 If you call the filter with a numeric parameter 'step' then only one in
7045 every 'step' frames is rendered.
7047 If you put an 'i' (lowercase) before the number then an 'I!' is printed
7048 (like the I parameter).
7050 If you give only the i then nothing is done to the frames, only I! is
7054 .B tile=xtiles:ytiles:output:start:delta
7055 Tile a series of images into a single, bigger image.
7056 If you omit a parameter or use a value less than 0, then the default
7058 You can also stop when you are satisfied (... \-vf tile=10:5 ...).
7059 It is probably a good idea to put the scale filter before the tile :-)
7066 number of tiles on the x axis (default: 5)
7068 number of tiles on the y axis (default: 5)
7070 Render the tile when 'output' number of frames are reached, where 'output'
7071 should be a number less than xtile * ytile.
7072 Missing tiles are left blank.
7073 You could, for example, write an 8 * 7 tile every 50 frames to have one
7074 image every 2 seconds @ 25 fps.
7076 outer border thickness in pixels (default: 2)
7078 inner border thickness in pixels (default: 4)
7083 .B delogo[=x:y:w:h:t]
7084 Suppresses a TV station logo by a simple interpolation of the
7086 Just set a rectangle covering the logo and watch it disappear (and
7087 sometimes something even uglier appear \- your mileage may vary).
7091 top left corner of the logo
7093 width and height of the cleared rectangle
7095 Thickness of the fuzzy edge of the rectangle (added to w and h).
7096 When set to \-1, a green rectangle is drawn on the screen to
7097 simplify finding the right x,y,w,h parameters.
7102 .B remove\-logo=/path/to/logo_bitmap_file_name.pgm
7103 Suppresses a TV station logo, using a PGM or PPM image
7104 file to determine which pixels comprise the logo.
7105 The width and height of the image file must match
7106 those of the video stream being processed.
7107 Uses the filter image and a circular blur
7108 algorithm to remove the logo.
7110 .IPs /path/to/logo_bitmap_file_name.pgm
7111 [path] + filename of the filter image.
7115 .B zrmjpeg[=options]
7116 Software YV12 to MJPEG encoder for use with the zr2 video
7119 .IPs maxheight=<h>|maxwidth=<w>
7120 These options set the maximum width and height the zr card
7121 can handle (the MPlayer filter layer currently cannot query those).
7122 .IPs {dc10+,dc10,buz,lml33}-{PAL|NTSC}
7123 Use these options to set maxwidth and maxheight automatically to the
7124 values known for card/\:mode combo.
7125 For example, valid options are: dc10-PAL and buz-NTSC (default: dc10+PAL)
7127 Select color or black and white encoding.
7128 Black and white encoding is faster.
7129 Color is the default.
7131 Horizontal decimation 1, 2 or 4.
7133 Vertical decimation 1, 2 or 4.
7135 Set JPEG compression quality [BEST] 1 \- 20 [VERY BAD].
7137 By default, decimation is only performed if the Zoran hardware
7138 can upscale the resulting MJPEG images to the original size.
7139 The option fd instructs the filter to always perform the requested
7145 Allows acquiring screenshots of the movie using slave mode
7146 commands that can be bound to keypresses.
7147 See the slave mode documentation and the INTERACTIVE CONTROL
7148 section for details.
7149 Files named 'shotNNNN.png' will be saved in the working directory,
7150 using the first available number \- no files will be overwritten.
7151 The filter has no overhead when not used and accepts an arbitrary
7152 colorspace, so it is safe to add it to the configuration file.
7157 Moves SSA/ASS subtitle rendering to an arbitrary point in the filter chain.
7158 Only useful with the \-ass option.
7163 .IPs "\-vf ass,screenshot"
7164 Moves SSA/ASS rendering before the screenshot filter.
7165 Screenshots taken this way will contain subtitles.
7170 .B blackframe[=amount:threshold]
7171 Detect frames that are (almost) completely black.
7172 Can be useful to detect chapter transitions or commercials.
7173 Output lines consist of the frame number of the detected frame, the
7174 percentage of blackness, the frame type and the frame number of the last
7175 encountered keyframe.
7178 Percentage of the pixels that have to be below the threshold (default: 98).
7180 Threshold below which a pixel value is considered black (default: 32).
7185 .SH "GENERAL ENCODING OPTIONS (MENCODER ONLY)"
7188 .B \-audio\-delay <any floating-point number>
7189 Delays either audio or video by setting a delay field in the header
7191 This does not delay either stream while encoding, but the player will
7192 see the delay field and compensate accordingly.
7193 Positive values delay the audio, and negative values delay the video.
7194 Note that this is the exact opposite of the \-delay option.
7195 For example, if a video plays correctly with \-delay 0.2, you can
7196 fix the video with MEncoder by using \-audio\-delay \-0.2.
7198 Currently, this option only works with the default muxer (\-of avi).
7199 If you are using a different muxer, then you must use \-delay instead.
7202 .B \-audio\-density <1\-50>
7203 Number of audio chunks per second (default is 2 for 0.5s long audio chunks).
7206 CBR only, VBR ignores this as it puts each packet in a new chunk.
7209 .B \-audio\-preload <0.0\-2.0>
7210 Sets up the audio buffering time interval (default: 0.5s).
7213 .B \-fafmttag <format>
7214 Can be used to override the audio format tag of the output file.
7219 .IPs "\-fafmttag 0x55"
7220 Will have the output file contain 0x55 (mp3) as audio format tag.
7225 .B \-ffourcc <fourcc>
7226 Can be used to override the video fourcc of the output file.
7231 .IPs "\-ffourcc div3"
7232 Will have the output file contain 'div3' as video fourcc.
7237 .B \-force\-avi\-aspect <0.2\-3.0>
7238 Override the aspect stored in the AVI OpenDML vprp header.
7239 This can be used to change the aspect ratio with '\-ovc copy'.
7242 .B \-frameno\-file <filename> (DEPRECATED)
7243 Specify the name of the audio file with framenumber mappings created in
7244 the first (audio only) pass of a special three pass encoding mode.
7247 Using this mode will most likely give you A-V desync.
7249 It is kept for backwards compatibility only and will possibly
7250 be removed in a future version.
7254 Use a more precise, but much slower method for skipping areas.
7255 Areas marked for skipping are not seeked over, instead all
7256 frames are decoded, but only the necessary frames are encoded.
7257 This allows starting at non-keyframe boundaries.
7260 Not guaranteed to work right with '\-ovc copy'.
7263 .B \-info <option1:option2:...> (AVI only)
7264 Specify the info header of the resulting AVI file.
7266 Available options are:
7269 Show this description.
7273 artist or author of the work
7275 original work category
7276 .IPs subject=<value>
7277 contents of the work
7278 .IPs copyright=<value>
7279 copyright information
7280 .IPs srcform=<value>
7281 original format of the digitized material
7282 .IPs comment=<value>
7283 general comments about the work
7288 Do not automatically insert the expand filter into the MEncoder filter chain.
7289 Useful to control at which point of the filter chain subtitles are rendered
7290 when hardcoding subtitles onto a movie.
7294 Do not attempt to encode duplicate frames in duplicate; always output
7295 zero-byte frames to indicate duplicates.
7296 Zero-byte frames will be written anyway unless a filter or encoder
7297 capable of doing duplicate encoding is loaded.
7298 Currently the only such filter is harddup.
7301 .B \-noodml (\-of avi only)
7302 Do not write OpenDML index for AVI files >1GB.
7310 Outputs to the given filename.
7312 If you want a default output filename, you can put this option in the
7313 MEncoder config file.
7316 .B \-oac <codec name>
7317 Encode with the given audio codec (no default set).
7320 Use \-oac help to get a list of available audio codecs.
7326 no encoding, just streamcopy
7328 Encode to uncompressed PCM.
7329 .IPs "\-oac mp3lame"
7330 Encode to MP3 (using LAME).
7332 Encode with a libavcodec codec.
7337 .B \-of <format> (BETA CODE!)
7338 Encode to the specified container format (default: AVI).
7341 Use \-of help to get a list of available container formats.
7349 Encode to MPEG (also see \-mpegopts).
7351 Encode with libavformat muxers (also see \-lavfopts).
7352 .IPs "\-of rawvideo"
7353 raw video stream (no muxing \- one video stream only)
7354 .IPs "\-of rawaudio"
7355 raw audio stream (no muxing \- one audio stream only)
7361 Specify a frames per second (fps) value for the output file,
7362 which can be different from that of the source material.
7363 Must be set for variable fps (ASF, some MOV) and progressive
7364 (30000/1001 fps telecined MPEG) files.
7367 .B \-ovc <codec name>
7368 Encode with the given video codec (no default set).
7371 Use \-ovc help to get a list of available video codecs.
7377 no encoding, just streamcopy
7379 Encode to an arbitrary uncompressed format (use '\-vf format' to select).
7381 Encode with a libavcodec codec.
7386 .B \-passlogfile <filename>
7387 Dump first pass information to <filename> instead of the default divx2pass.log
7388 in two pass encoding mode.
7391 .B \-skiplimit <value>
7392 Specify the maximum number of frames that may be skipped after
7393 encoding one frame (\-noskiplimit for unlimited).
7396 .B \-vobsubout <basename>
7397 Specify the basename for the output .idx and .sub files.
7398 This turns off subtitle rendering in the encoded movie and diverts it to
7399 VOBsub subtitle files.
7402 .B \-vobsuboutid <langid>
7403 Specify the language two letter code for the subtitles.
7404 This overrides what is read from the DVD or the .ifo file.
7407 .B \-vobsuboutindex <index>
7408 Specify the index of the subtitles in the output files (default: 0).
7412 .SH "CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY)"
7413 You can specify codec specific encoding parameters using the following
7417 .B \-<codec>opts <option1[=value1]:option2[=value2]:...>
7420 Where <codec> may be: lavc, xvidenc, mp3lame, toolame, twolame,
7421 nuv, xvfw, faac, x264enc, mpeg, lavf.
7424 .SS mp3lame (\-lameopts)
7432 variable bitrate method
7455 Also forces CBR mode encoding on subsequent ABR presets modes.
7459 bitrate in kbps (CBR and ABR only)
7463 quality (0 \- highest, 9 \- lowest) (VBR only)
7467 algorithmic quality (0 \- best/slowest, 9 \- worst/fastest)
7508 Switch on faster encoding on subsequent VBR presets modes.
7509 This results in slightly lower quality and higher bitrates.
7512 .B highpassfreq=<freq>
7513 Set a highpass filtering frequency in Hz.
7514 Frequencies below the specified one will be cut off.
7515 A value of \-1 will disable filtering, a value of 0
7516 will let LAME choose values automatically.
7519 .B lowpassfreq=<freq>
7520 Set a lowpass filtering frequency in Hz.
7521 Frequencies above the specified one will be cut off.
7522 A value of \-1 will disable filtering, a value of 0
7523 will let LAME choose values automatically.
7530 Print additional options and information about presets settings.
7532 VBR encoding, good quality, 150\-180 kbps bitrate range
7534 VBR encoding, high quality, 170\-210 kbps bitrate range
7536 VBR encoding, very high quality, 200\-240 kbps bitrate range
7538 CBR encoding, highest preset quality, 320 kbps bitrate
7540 ABR encoding at average given kbps bitrate
7548 .IPs fast:preset=standard
7549 suitable for most people and most music types and already quite high quality
7551 Encode with ABR presets at a 192 kbps forced constant bitrate.
7553 Encode with ABR presets at a 172 kbps average bitrate.
7555 for people with extremely good hearing and similar equipment
7560 .SS toolame and twolame (\-toolameopts and \-twolameopts respectively)
7564 In CBR mode this parameter indicates the bitrate in kbps,
7565 when in VBR mode it is the minimum bitrate allowed per frame.
7566 VBR mode will not work with a value below 112.
7569 .B vbr=<\-50\-50> (VBR only)
7570 variability range; if negative the encoder shifts the average bitrate
7571 towards the lower limit, if positive towards the higher.
7572 When set to 0 CBR is used (default).
7575 .B maxvbr=<32\-384> (VBR only)
7576 maximum bitrate allowed per frame, in kbps
7579 .B mode=<stereo | jstereo | mono | dual>
7580 (default: mono for 1-channel audio, stereo otherwise)
7584 psychoacoustic model (default: 2)
7588 Include error protection.
7597 .SS faac (\-faacopts)
7601 average bitrate in kbps (mutually exclusive with quality)
7604 .B quality=<1\-1000>
7605 quality mode, the higher the better (mutually exclusive with br)
7609 object type complexity
7619 LTP (extremely slow)
7625 MPEG version (default: 4)
7629 Enables temporal noise shaping.
7632 .B cutoff=<0\-sampling_rate/2>
7633 cutoff frequency (default: sampling_rate/2)
7637 Stores the bitstream as raw payload with extradata in the container header
7638 (default: 0, corresponds to ADTS).
7639 Do not set this flag if not explicitly required or you will not be able to
7640 remux the audio stream later on.
7645 .SS lavc (\-lavcopts)
7647 Many libavcodec (lavc for short) options are tersely documented.
7648 Read the source for full details.
7653 .IPs vcodec=msmpeg4:vbitrate=1800:vhq:keyint=250
7658 .B o=<key>=<value>[,<key>=<value>[,...]]
7659 Pass AVOptions to libavcodec encoder.
7660 Note, a patch to make the o= unneeded and pass all unknown options through
7661 the AVOption system is welcome.
7662 A full list of AVOptions can be found in the FFmpeg manual.
7663 Note that some AVOptions may conflict with MEncoder options.
7676 audio codec (default: mp2)
7680 Dolby Digital (AC-3)
7682 Adaptive PCM formats \- see the HTML documentation for details.
7684 Free Lossless Audio Codec (FLAC)
7688 3GPP Adaptive Multi-Rate (AMR) narrow-band
7690 3GPP Adaptive Multi-Rate (AMR) wide-band
7692 Advanced Audio Coding (AAC) \- using FAAC
7694 MPEG-1 audio layer 3 (MP3) \- using LAME
7696 MPEG-1 audio layer 2 (MP2)
7698 PCM formats \- see the HTML documentation for details.
7700 Id Software RoQ DPCM
7702 experimental simple lossy codec
7704 experimental simple lossless codec
7708 Windows Media Audio v1
7710 Windows Media Audio v2
7716 audio bitrate in kbps (default: 224)
7720 Use the specified Windows audio format tag (e.g.\& atag=0x55).
7724 Use only bit exact algorithms (except (I)DCT).
7725 Additionally bit_exact disables several optimizations and thus
7726 should only be used for regression tests, which need binary
7727 identical files even if the encoder version changes.
7728 This also suppresses the user_data header in MPEG-4 streams.
7729 Do not use this option unless you know exactly what you are doing.
7733 Maximum number of threads to use (default: 1).
7734 May have a slight negative effect on motion estimation.
7739 Employ the specified codec (default: mpeg4).
7749 FFmpeg's lossless video codec
7751 nonstandard 20% smaller HuffYUV using YV12
7753 Sorenson H.263 used in Flash Video
7765 x264 H.264/AVC MPEG-4 Part 10
7767 Xvid MPEG-4 Part 2 (ASP)
7783 ID Software RoQ Video
7785 an old RealVideo codec
7786 .IPs "snow (also see: vstrict)"
7787 FFmpeg's experimental wavelet-based codec
7789 Apple Sorenson Video 1
7791 Windows Media Video, version 1 (AKA WMV7)
7793 Windows Media Video, version 2 (AKA WMV8)
7802 Not recommended (much larger file, little quality difference and weird side
7803 effects: msmpeg4, h263 will be very low quality, ratecontrol will be confused
7804 resulting in lower quality and some decoders will not be able to decode it).
7806 Recommended for normal mpeg4/\:mpeg1video encoding (default).
7808 Recommended for h263(p)/\:msmpeg4.
7809 The reason for preferring 3 over 2 is that 2 could lead to overflows.
7810 (This will be fixed for h263(p) by changing the quantizer per MB in
7811 the future, msmpeg4 cannot be fixed as it does not support that.)
7815 .B lmin=<0.01\-255.0>
7816 Minimum frame-level Lagrange multiplier for ratecontrol (default: 2.0).
7817 Lavc will rarely use quantizers below the value of lmin.
7818 Lowering lmin will make lavc more likely to choose lower quantizers for
7819 some frames, but not lower than the value of vqmin.
7820 Likewise, raising lmin will make lavc less likely to choose low
7821 quantizers, even if vqmin would have allowed them.
7822 You probably want to set lmin approximately equal to vqmin.
7823 When adaptive quantization is in use, changing lmin/lmax may have less
7824 of an effect; see mblmin/mblmax.
7828 .B lmax=<0.01\-255.0>
7829 maximum Lagrange multiplier for ratecontrol (default: 31.0)
7833 .B mblmin=<0.01\-255.0>
7834 Minimum macroblock-level Lagrange multiplier for ratecontrol
7836 This parameter affects adaptive quantization options like qprd,
7841 .B mblmax=<0.01\-255.0>
7842 Maximum macroblock-level Lagrange multiplier for ratecontrol
7848 Constant quantizer /\: constant quality encoding (selects fixed quantizer mode).
7849 A lower value means better quality but larger files (default: \-1).
7850 In case of snow codec, value 0 means lossless encoding.
7851 Since the other codecs do not support this, vqscale=0 will have an undefined
7853 1 is not recommended (see vqmin for details).
7857 Maximum quantizer, 10\-31 should be a sane range (default: 31).
7869 maximum quantizer difference between consecutive I- or P-frames
7873 .B vmax_b_frames=<0\-4>
7874 maximum number of B-frames between non-B-frames:
7878 no B-frames (default)
7880 sane range for MPEG-4
7886 motion estimation method.
7887 Available methods are:
7891 none (very low quality)
7893 full (slow, currently unmaintained and disabled)
7895 log (low quality, currently unmaintained and disabled)
7897 phods (low quality, currently unmaintained and disabled)
7899 EPZS: size=1 diamond, size can be adjusted with the *dia options
7902 X1 (experimental, currently aliased to EPZS)
7904 iter (iterative overlapped block, only used in snow)
7911 0\-3 currently ignores the amount of bits spent,
7912 so quality may be low.
7916 .B me_range=<0\-9999>
7917 motion estimation search range (default: 0 (unlimited))
7920 .B mbd=<0\-2> (also see *cmp, qpel)
7921 Macroblock decision algorithm (high quality mode), encode each macro
7922 block in all modes and choose the best.
7923 This is slow but results in better quality and file size.
7924 When mbd is set to 1 or 2, the value of mbcmp is ignored when comparing
7925 macroblocks (the mbcmp value is still used in other places though, in particular
7926 the motion search algorithms).
7927 If any comparison setting (precmp, subcmp, cmp, or mbcmp) is nonzero,
7928 however, a slower but better half-pel motion search will be used,
7929 regardless of what mbd is set to.
7930 If qpel is set, quarter-pel motion search will be used regardless.
7934 Use comparison function given by mbcmp (default).
7936 Select the MB mode which needs the fewest bits (=vhq).
7938 Select the MB mode which has the best rate distortion.
7944 Same as mbd=1, kept for compatibility reasons.
7948 Allow 4 motion vectors per macroblock (slightly better quality).
7949 Works better if used with mbd>0.
7953 overlapped block motion compensation (H.263+)
7957 loop filter (H.263+)
7958 note, this is broken
7961 .B inter_threshold <\-1000\-1000>
7962 Does absolutely nothing at the moment.
7966 maximum interval between keyframes in frames (default: 250 or one
7967 keyframe every ten seconds in a 25fps movie.
7968 This is the recommended default for MPEG-4).
7969 Most codecs require regular keyframes in order to limit the accumulation of mismatch error.
7970 Keyframes are also needed for seeking, as seeking is only possible to a keyframe \- but
7971 keyframes need more space than other frames, so larger numbers here mean
7972 slightly smaller files but less precise seeking.
7973 0 is equivalent to 1, which makes every frame a keyframe.
7974 Values >300 are not recommended as the quality might be bad depending upon
7975 decoder, encoder and luck.
7976 It is common for MPEG-1/2 to use values <=30.
7979 .B sc_threshold=<\-1000000000\-1000000000>
7980 Threshold for scene change detection.
7981 A keyframe is inserted by libavcodec when it detects a scene change.
7982 You can specify the sensitivity of the detection with this option.
7983 \-1000000000 means there is a scene change detected at every frame,
7984 1000000000 means no scene changes are detected (default: 0).
7987 .B sc_factor=<any positive integer>
7988 Causes frames with higher quantizers to be more likely to trigger a
7989 scene change detection and make libavcodec use an I-frame (default: 1).
7990 1\-16 is a sane range.
7991 Values between 2 and 6 may yield increasing PSNR (up to approximately
7992 0.04 dB) and better placement of I-frames in high-motion scenes.
7993 Higher values than 6 may give very slightly better PSNR (approximately
7994 0.01 dB more than sc_factor=6), but noticably worse visual quality.
7997 .B vb_strategy=<0\-2> (pass one only)
7998 strategy to choose between I/P/B-frames:
8002 Always use the maximum number of B-frames (default).
8004 Avoid B-frames in high motion scenes.
8005 See the b_sensitivity option to tune this strategy.
8007 Places B-frames more or less optimally to yield maximum quality (slower).
8008 You may want to reduce the speed impact of this option by tuning the
8014 .B b_sensitivity=<any integer greater than 0>
8015 Adjusts how sensitively vb_strategy=1 detects motion and avoids using
8016 B-frames (default: 40).
8017 Lower sensitivities will result in more B-frames.
8018 Using more B-frames usually improves PSNR, but too many B-frames can
8019 hurt quality in high-motion scenes.
8020 Unless there is an extremely high amount of motion, b_sensitivity can
8021 safely be lowered below the default; 10 is a reasonable value in most
8025 .B brd_scale=<0\-10>
8026 Downscales frames for dynamic B-frame decision (default: 0).
8027 Each time brd_scale is increased by one, the frame dimensions are
8028 divided by two, which improves speed by a factor of four.
8029 Both dimensions of the fully downscaled frame must be even numbers, so
8030 brd_scale=1 requires the original dimensions to be multiples of four,
8031 brd_scale=2 requires multiples of eight, etc.
8032 In other words, the dimensions of the original frame must both be
8033 divisible by 2^(brd_scale+1) with no remainder.
8036 .B bidir_refine=<0\-4>
8037 Refine the two motion vectors used in bidirectional macroblocks,
8038 rather than re-using vectors from the forward and backward searches.
8039 This option has no effect without B-frames.
8045 Use a wider search (larger values are slower).
8051 Activates internal two (or more) pass mode, only specify if you wish to
8052 use two (or more) pass encoding.
8056 first pass (also see turbo)
8060 Nth pass (second and subsequent passes of N-pass encoding)
8063 Here is how it works, and how to use it:
8065 The first pass (vpass=1) writes the statistics file.
8066 You might want to deactivate some CPU-hungry options, like "turbo"
8069 In two pass mode, the second pass (vpass=2) reads the statistics file and
8070 bases ratecontrol decisions on it.
8072 In N-pass mode, the second pass (vpass=3, that is not a typo)
8073 does both: It first reads the statistics, then overwrites them.
8074 You might want to backup divx2pass.log before doing this if there is
8075 any possibility that you will have to cancel MEncoder.
8076 You can use all encoding options, except very CPU-hungry options like "qns".
8078 You can run this same pass over and over to refine the encode.
8079 Each subsequent pass will use the statistics from the previous pass to improve.
8080 The final pass can include any CPU-hungry encoding options.
8082 If you want a 2 pass encode, use first vpass=1, and then vpass=2.
8084 If you want a 3 or more pass encode, use vpass=1 for the first pass
8085 and then vpass=3 and then vpass=3 again and again until you are
8086 satisfied with the encode.
8098 Encodes with an optimal Huffman table based upon statistics
8099 from the first pass.
8104 .B turbo (two pass only)
8105 Dramatically speeds up pass one using faster algorithms and disabling
8106 CPU-intensive options.
8107 This will probably reduce global PSNR a little bit (around 0.01dB) and
8108 change individual frame type and PSNR a little bit more (up to 0.03dB).
8112 Store movie aspect internally, just like with MPEG files.
8113 Much nicer than rescaling, because quality is not decreased.
8114 Only MPlayer will play these files correctly, other players will display
8115 them with wrong aspect.
8116 The aspect parameter can be given as a ratio or a floating point number.
8123 .IPs "aspect=16/9 or aspect=1.78"
8129 Same as the aspect option, but automatically computes aspect, taking
8130 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
8132 Does not incur a performance penalty, so you can safely leave it
8137 Specify bitrate (default: 800).
8145 .IPs 16001\-24000000
8152 approximated file size tolerance in kbit.
8153 1000\-100000 is a sane range.
8154 (warning: 1kbit = 1000 bits)
8158 vratetol should not be too large during the second pass or there might
8159 be problems if vrc_(min|max)rate is used.
8162 .B vrc_maxrate=<value>
8163 maximum bitrate in kbit/\:sec
8164 (default: 0, unlimited)
8167 .B vrc_minrate=<value>
8168 minimum bitrate in kbit/\:sec
8169 (default: 0, unlimited)
8172 .B vrc_buf_size=<value>
8174 For MPEG-1/2 this also sets the vbv buffer size, use 327 for VCD,
8175 917 for SVCD and 1835 for DVD.
8178 .B vrc_buf_aggressivity
8184 Note that some of the ratecontrol-affecting options will have no effect
8185 if vrc_strategy is not set to 0.
8189 Use internal lavc ratecontrol (default).
8191 Use Xvid ratecontrol (experimental; requires MEncoder to be compiled
8192 with support for Xvid 1.1 or higher).
8197 .B vb_qfactor=<\-31.0\-31.0>
8198 quantizer factor between B- and non-B-frames (default: 1.25)
8201 .B vi_qfactor=<\-31.0\-31.0>
8202 quantizer factor between I- and non-I-frames (default: 0.8)
8205 .B vb_qoffset=<\-31.0\-31.0>
8206 quantizer offset between B- and non-B-frames (default: 1.25)
8209 .B vi_qoffset=<\-31.0\-31.0>
8212 if v{b|i}_qfactor > 0
8214 I/B-frame quantizer = P-frame quantizer * v{b|i}_qfactor + v{b|i}_qoffset
8218 do normal ratecontrol (do not lock to next P-frame quantizer) and
8219 set q= \-q * v{b|i}_qfactor + v{b|i}_qoffset
8222 To do constant quantizer encoding with different quantizers for
8223 I/P- and B-frames you can use:
8224 lmin= <ip_quant>:lmax= <ip_quant>:vb_qfactor= <b_quant/\:ip_quant>.
8227 .B vqblur=<0.0\-1.0> (pass one)
8228 Quantizer blur (default: 0.5), larger values will average the
8229 quantizer more over time (slower change).
8233 Quantizer blur disabled.
8235 Average the quantizer over all previous frames.
8240 .B vqblur=<0.0\-99.0> (pass two)
8241 Quantizer gaussian blur (default: 0.5), larger values will average
8242 the quantizer more over time (slower change).
8245 .B vqcomp=<0.0\-1.0>
8246 Quantizer compression, vrc_eq depends upon this (default: 0.5).
8248 Perceptual quality will be optimal somewhere in between the range's extremes.
8251 .B vrc_eq=<equation>
8252 main ratecontrol equation
8255 .IPs 1+(tex/\:avgTex-1)*qComp
8256 approximately the equation of the old ratecontrol code
8258 with qcomp 0.5 or something like that (default)
8275 intra, non-intra texture complexity
8277 average texture complexity
8279 average intra texture complexity in I-frames
8281 average intra texture complexity in P-frames
8283 average non-intra texture complexity in P-frames
8285 average non-intra texture complexity in B-frames
8287 bits used for motion vectors
8289 maximum length of motion vector in log2 scale
8291 number of intra macroblocks / number of macroblocks
8297 qcomp from the command line
8298 .IPs "isI, isP, isB"
8299 Is 1 if picture type is I/P/B else 0.
8301 See your favorite math book.
8308 .IPs max(a,b),min(a,b)
8311 is 1 if a>b, 0 otherwise
8313 is 1 if a<b, 0 otherwise
8315 is 1 if a==b, 0 otherwise
8316 .IPs "sin, cos, tan, sinh, cosh, tanh, exp, log, abs"
8320 .B vrc_override=<options>
8321 User specified quality for specific parts (ending, credits, ...).
8322 The options are <start-frame>, <end-frame>, <quality>[/<start-frame>,
8323 <end-frame>, <quality>[/...]]:
8326 .IPs "quality (2\-31)"
8328 .IPs "quality (\-500\-0)"
8329 quality correction in %
8334 .B vrc_init_cplx=<0\-1000>
8335 initial complexity (pass 1)
8338 .B vrc_init_occupancy=<0.0\-1.0>
8339 initial buffer occupancy, as a fraction of vrc_buf_size (default: 0.9)
8343 Specify how to keep the quantizer between qmin and qmax.
8349 Use a nice differentiable function (default).
8354 .B vlelim=<\-1000\-1000>
8355 Sets single coefficient elimination threshold for luminance.
8356 Negative values will also consider the DC coefficient (should be at least \-4
8357 or lower for encoding at quant=1):
8368 .B vcelim=<\-1000\-1000>
8369 Sets single coefficient elimination threshold for chrominance.
8370 Negative values will also consider the DC coefficient (should be at least \-4
8371 or lower for encoding at quant=1):
8382 .B vstrict=<\-2|\-1|0|1>
8383 strict standard compliance
8389 Only recommended if you want to feed the output into the
8390 MPEG-4 reference decoder.
8392 Allow libavcodec specific extensions (default).
8394 Enables experimental codecs and features which may not be playable
8395 with future MPlayer versions (snow).
8402 Adds 2 Bytes per video packet, improves error-resistance when transferring over
8403 unreliable channels (e.g.\& streaming over the internet).
8404 Each video packet will be encoded in 3 separate partitions:
8409 .IPs "2. DC coefficients"
8411 .IPs "3. AC coefficients"
8416 MV & DC are most important, losing them looks far worse than losing
8417 the AC and the 1. & 2. partition.
8418 (MV & DC) are far smaller than the 3. partition (AC) meaning that errors
8419 will hit the AC partition much more often than the MV & DC partitions.
8420 Thus, the picture will look better with partitioning than without,
8421 as without partitioning an error will trash AC/\:DC/\:MV equally.
8425 .B vpsize=<0\-10000> (also see vdpart)
8426 Video packet size, improves error-resistance.
8438 slice structured mode for H.263+
8442 grayscale only encoding (faster)
8450 Automatically select a good one (default).
8471 To the best of our knowledge all these IDCTs do pass the IEEE1180 tests.
8475 Automatically select a good one (default).
8477 JPEG reference integer
8483 libmpeg2mmx (inaccurate, do not use for encoding with keyint >100)
8514 .B lumi_mask=<0.0\-1.0>
8515 Luminance masking is a 'psychosensory' setting that is supposed to
8516 make use of the fact that the human eye tends to notice fewer details
8517 in very bright parts of the picture.
8518 Luminance masking compresses bright areas stronger than medium ones,
8519 so it will save bits that can be spent again on other frames, raising
8520 overall subjective quality, while possibly reducing PSNR.
8523 Be careful, overly large values can cause disastrous things.
8526 Large values might look good on some monitors but may look horrible
8538 .B dark_mask=<0.0\-1.0>
8539 Darkness masking is a 'psychosensory' setting that is supposed to
8540 make use of the fact that the human eye tends to notice fewer details
8541 in very dark parts of the picture.
8542 Darkness masking compresses dark areas stronger than medium ones,
8543 so it will save bits that can be spent again on other frames, raising
8544 overall subjective quality, while possibly reducing PSNR.
8547 Be careful, overly large values can cause disastrous things.
8550 Large values might look good on some monitors but may look horrible
8551 on other monitors / TV / TFT.
8562 .B tcplx_mask=<0.0\-1.0>
8563 Temporal complexity masking (default: 0.0 (disabled)).
8564 Imagine a scene with a bird flying across the whole scene; tcplx_mask
8565 will raise the quantizers of the bird's macroblocks (thus decreasing their
8566 quality), as the human eye usually does not have time to see all the bird's
8568 Be warned that if the masked object stops (e.g.\& the bird lands) it is
8569 likely to look horrible for a short period of time, until the encoder
8570 figures out that the object is not moving and needs refined blocks.
8571 The saved bits will be spent on other parts of the video, which may increase
8572 subjective quality, provided that tcplx_mask is carefully chosen.
8575 .B scplx_mask=<0.0\-1.0>
8576 Spatial complexity masking.
8577 Larger values help against blockiness, if no deblocking filter is used for
8578 decoding, which is maybe not a good idea.
8580 Imagine a scene with grass (which usually has great spatial complexity),
8581 a blue sky and a house; scplx_mask will raise the quantizers of the grass'
8582 macroblocks, thus decreasing its quality, in order to spend more bits on
8583 the sky and the house.
8586 Crop any black borders completely as they will reduce the quality
8587 of the macroblocks (also applies without scplx_mask).
8599 This setting does not have the same effect as using a custom matrix that
8600 would compress high frequencies harder, as scplx_mask will reduce the
8601 quality of P blocks even if only DC is changing.
8602 The result of scplx_mask will probably not look as good.
8606 .B p_mask=<0.0\-1.0> (also see vi_qfactor)
8607 Reduces the quality of inter blocks.
8608 This is equivalent to increasing the quality of intra blocks, because the
8609 same average bitrate will be distributed by the rate controller to the
8610 whole video sequence (default: 0.0 (disabled)).
8611 p_mask=1.0 doubles the bits allocated to each intra block.
8614 .B border_mask=<0.0\-1.0>
8615 border-processing for MPEG-style encoders.
8616 Border processing increases the quantizer for macroblocks which are less
8617 than 1/5th of the frame width/height away from the frame border,
8618 since they are often visually less important.
8622 Normalize adaptive quantization (experimental).
8623 When using adaptive quantization (*_mask), the average per-MB quantizer may no
8624 longer match the requested frame-level quantizer.
8625 Naq will attempt to adjust the per-MB quantizers to maintain the proper
8634 Use interlaced motion estimation (mutually exclusive with qpel).
8638 Use alternative scantable.
8641 .B "top=<\-1\-1>\ \ \ "
8662 for HuffYUV, lossless JPEG, dv and ffv1
8664 for lossless JPEG, dv and ffv1
8666 for lossless JPEG, ffv1 and svq1
8668 for lossless JPEG and ffv1
8680 plane/\:gradient prediction
8698 plane/\:gradient prediction
8710 vlc coding (Golomb-Rice)
8712 arithmetic coding (CABAC)
8734 predetermined Huffman tables (builtin or two pass)
8736 adaptive Huffman tables
8742 Use quarter pel motion compensation (mutually exclusive with ilme).
8745 This seems only useful for high bitrate encodings.
8749 Sets the comparison function for the macroblock decision, has only
8751 This is also used for some motion search functions, in which case
8752 it has an effect regardless of mbd setting.
8756 sum of absolute differences, fast (default)
8758 sum of squared errors
8760 sum of absolute Hadamard transformed differences
8762 sum of absolute DCT transformed differences
8764 sum of squared quantization errors (avoid, low quality)
8766 number of bits needed for the block
8768 rate distortion optimal, slow
8772 sum of absolute vertical differences
8774 sum of squared vertical differences
8776 noise preserving sum of squared differences
8778 5/3 wavelet, only used in snow
8780 9/7 wavelet, only used in snow
8782 Also use chroma, currently does not work (correctly) with B-frames.
8787 .B ildctcmp=<0\-2000>
8788 Sets the comparison function for interlaced DCT decision
8789 (see mbcmp for available comparison functions).
8793 Sets the comparison function for motion estimation pre pass
8794 (see mbcmp for available comparison functions) (default: 0).
8798 Sets the comparison function for full pel motion estimation
8799 (see mbcmp for available comparison functions) (default: 0).
8803 Sets the comparison function for sub pel motion estimation
8804 (see mbcmp for available comparison functions) (default: 0).
8807 .B skipcmp=<0\-2000>
8808 FIXME: Document this.
8811 .B nssew=<0\-1000000>
8812 This setting controls NSSE weight, where larger weights will result in
8814 0 NSSE is identical to SSE
8815 You may find this useful if you prefer to keep some noise in your encoded
8816 video rather than filtering it away before encoding (default: 8).
8820 diamond type and size for motion estimation pre-pass
8824 Diamond type & size for motion estimation.
8825 Motion search is an iterative process.
8826 Using a small diamond does not limit the search to finding only small
8828 It is just somewhat more likely to stop before finding the very best motion
8829 vector, especially when noise is involved.
8830 Bigger diamonds allow a wider search for the best motion vector, thus are
8831 slower but result in better quality.
8833 Big normal diamonds are better quality than shape-adaptive diamonds.
8835 Shape-adaptive diamonds are a good tradeoff between speed and quality.
8838 The sizes of the normal diamonds and shape adaptive ones do not have
8842 shape adaptive (fast) diamond with size 3
8844 shape adaptive (fast) diamond with size 2
8846 uneven multi-hexagon search (slow)
8848 normal size=1 diamond (default) =EPZS type diamond
8856 normal size=2 diamond
8869 Trellis searched quantization.
8870 This will find the optimal encoding for each 8x8 block.
8871 Trellis searched quantization is quite simply an optimal quantization in
8872 the PSNR versus bitrate sense (Assuming that there would be no rounding
8873 errors introduced by the IDCT, which is obviously not the case.).
8874 It simply finds a block for the minimum of error and lambda*bits.
8878 quantization parameter (QP) dependent constant
8880 amount of bits needed to encode the block
8882 sum of squared errors of the quantization
8888 Rate distorted optimal coded block pattern.
8889 Will select the coded block pattern which minimizes distortion + lambda*rate.
8890 This can only be used together with trellis quantization.
8894 Try to encode each MB with MV=<0,0> and choose the better one.
8895 This has no effect if mbd=0.
8898 .B mv0_threshold=<any non-negative integer>
8899 When surrounding motion vectors are <0,0> and the motion estimation
8900 score of the current block is less than mv0_threshold, <0,0> is used for
8901 the motion vector and further motion estimation is skipped (default:
8903 Lowering mv0_threshold to 0 can give a slight (0.01dB) PSNR increase and
8904 possibly make the encoded video look slightly better; raising
8905 mv0_threshold past 320 results in diminished PSNR and visual quality.
8906 Higher values speed up encoding very slightly (usually less than 1%,
8907 depending on the other options used).
8910 This option does not require mv0 to be enabled.
8913 .B qprd (mbd=2 only)
8914 rate distorted optimal quantization parameter (QP) for the given
8915 lambda of each macroblock
8918 .B last_pred=<0\-99>
8919 amount of motion predictors from the previous frame
8925 Will use 2a+1 x 2a+1 macroblock square of motion vector predictors from the
8932 motion estimation pre-pass
8938 only after I-frames (default)
8946 subpel refinement quality (for qpel) (default: 8 (high quality))
8949 This has a significant effect on speed.
8953 number of reference frames to consider for motion compensation
8954 (Snow only) (default: 1)
8958 print the PSNR (peak signal to noise ratio) for the whole video after encoding
8959 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
8960 Returned values are in dB (decibel), the higher the better.
8964 Use MPEG quantizers instead of H.263.
8968 Enable AC prediction for MPEG-4 or advanced intra prediction for H.263+.
8969 This will improve quality very slightly (around 0.02 dB PSNR) and slow
8970 down encoding very slightly (about 1%).
8973 vqmin should be 8 or larger for H.263+ AIC.
8977 alternative inter vlc for H.263+
8981 unlimited MVs (H.263+ only)
8982 Allows encoding of arbitrarily long MVs.
8985 .B ibias=<\-256\-256>
8986 intra quantizer bias (256 equals 1.0, MPEG style quantizer default: 96,
8987 H.263 style quantizer default: 0)
8990 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
8991 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
8994 .B pbias=<\-256\-256>
8995 inter quantizer bias (256 equals 1.0, MPEG style quantizer default: 0,
8996 H.263 style quantizer default: \-64)
8999 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
9000 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
9003 A more positive bias (\-32 \- \-16 instead of \-64) seems to improve the PSNR.
9007 Noise reduction, 0 means disabled.
9008 0\-600 is a useful range for typical content, but you may want to turn it
9009 up a bit more for very noisy content (default: 0).
9010 Given its small impact on speed, you might want to prefer to use this over
9011 filtering noise away with video filters like denoise3d or hqdn3d.
9015 Quantizer noise shaping.
9016 Rather than choosing quantization to most closely match the source video
9017 in the PSNR sense, it chooses quantization such that noise (usually ringing)
9018 will be masked by similar-frequency content in the image.
9019 Larger values are slower but may not result in better quality.
9020 This can and should be used together with trellis quantization, in which case
9021 the trellis quantization (optimal for constant weight) will be used as
9022 startpoint for the iterative search.
9028 Only lower the absolute value of coefficients.
9030 Only change coefficients before the last non-zero coefficient + 1.
9037 .B inter_matrix=<comma separated matrix>
9038 Use custom inter matrix.
9039 It needs a comma separated string of 64 integers.
9042 .B intra_matrix=<comma separated matrix>
9043 Use custom intra matrix.
9044 It needs a comma separated string of 64 integers.
9048 experimental quantizer modulation
9052 experimental quantizer modulation
9056 intra DC precision in bits (default: 8).
9057 If you specify vcodec=mpeg2video this value can be 8, 9, 10 or 11.
9060 .B cgop (also see sc_threshold)
9062 Currently it only works if scene change detection is disabled
9063 (sc_threshold=1000000000).
9067 Sets the low delay flag for MPEG-1/2 (disables B-frames).
9071 Control writing global video headers.
9075 Codec decides where to write global headers (default).
9077 Write global headers only in extradata (needed for .mp4/MOV/NUT).
9079 Write global headers only in front of keyframes.
9087 Same as vglobal for audio headers.
9091 Set CodecContext Level.
9092 Use 31 or 41 to play video on a Playstation 3.
9095 .B skip_exp=<0\-1000000>
9096 FIXME: Document this.
9099 .B skip_factor=<0\-1000000>
9100 FIXME: Document this.
9103 .B skip_threshold=<0\-1000000>
9104 FIXME: Document this.
9109 Nuppel video is based on RTJPEG and LZO.
9110 By default frames are first encoded with RTJPEG and then compressed with LZO,
9111 but it is possible to disable either or both of the two passes.
9112 As a result, you can in fact output raw i420, LZO compressed i420, RTJPEG,
9113 or the default LZO compressed RTJPEG.
9116 The nuvrec documentation contains some advice and examples about the
9117 settings to use for the most common TV encodings.
9121 chrominance threshold (default: 1)
9125 luminance threshold (default: 1)
9129 Enable LZO compression (default).
9133 Disable LZO compression.
9137 quality level (default: 255)
9141 Disable RTJPEG encoding.
9145 Enable RTJPEG encoding (default).
9148 .SS xvidenc (\-xvidencopts)
9150 There are three modes available: constant bitrate (CBR), fixed quantizer and
9155 Specify the pass in two pass mode.
9158 .B turbo (two pass only)
9159 Dramatically speeds up pass one using faster algorithms and disabling
9160 CPU-intensive options.
9161 This will probably reduce global PSNR a little bit and change individual
9162 frame type and PSNR a little bit more.
9165 .B bitrate=<value> (CBR or two pass mode)
9166 Sets the bitrate to be used in kbits/\:second if <16000 or in bits/\:second
9168 If <value> is negative, Xvid will use its absolute value as the target size
9169 (in kBytes) of the video and compute the associated bitrate automagically
9170 (default: 687 kbits/s).
9173 .B fixed_quant=<1\-31>
9174 Switch to fixed quantizer mode and specify the quantizer to be used.
9177 .B zones=<zone0>[/<zone1>[/...]] (CBR or two pass mode)
9178 User specified quality for specific parts (ending, credits, ...).
9179 Each zone is <start-frame>,<mode>,<value> where <mode> may be
9183 Constant quantizer override, where value=<2.0\-31.0>
9184 represents the quantizer value.
9186 Ratecontrol weight override, where value=<0.01\-2.00>
9187 represents the quality correction in %.
9196 .IPs zones=90000,q,20
9197 Encodes all frames starting with frame 90000 at constant quantizer 20.
9198 .IPs zones=0,w,0.1/10001,w,1.0/90000,q,20
9199 Encode frames 0\-10000 at 10% bitrate, encode frames 90000
9200 up to the end at constant quantizer 20.
9201 Note that the second zone is needed to delimit the first zone, as
9202 without it everything up until frame 89999 would be encoded at 10%
9208 .B me_quality=<0\-6>
9209 This option controls the motion estimation subsystem.
9210 The higher the value, the more precise the estimation should be (default: 6).
9211 The more precise the motion estimation is, the more bits can be saved.
9212 Precision is gained at the expense of CPU time so decrease this setting if
9213 you need realtime encoding.
9217 MPEG-4 uses a half pixel precision for its motion search by default.
9218 The standard proposes a mode where encoders are allowed to use quarter
9220 This option usually results in a sharper image.
9221 Unfortunately it has a great impact on bitrate and sometimes the
9222 higher bitrate use will prevent it from giving a better image
9223 quality at a fixed bitrate.
9224 It is better to test with and without this option and see whether it
9225 is worth activating.
9229 Enable Global Motion Compensation, which makes Xvid generate special
9230 frames (GMC-frames) which are well suited for Pan/\:Zoom/\:Rotating images.
9231 Whether or not the use of this option will save bits is highly
9232 dependent on the source material.
9236 Trellis Quantization is a kind of adaptive quantization method that
9237 saves bits by modifying quantized coefficients to make them more
9238 compressible by the entropy encoder.
9239 Its impact on quality is good, and if VHQ uses too much CPU for you,
9240 this setting can be a good alternative to save a few bits (and gain
9241 quality at fixed bitrate) at a lesser cost than with VHQ (default: on).
9245 Activate this if your encoded sequence is an anime/\:cartoon.
9246 It modifies some Xvid internal thresholds so Xvid takes better decisions on
9247 frame types and motion vectors for flat looking cartoons.
9251 The usual motion estimation algorithm uses only the luminance information to
9252 find the best motion vector.
9253 However for some video material, using the chroma planes can help find
9255 This setting toggles the use of chroma planes for motion estimation
9260 Enable a chroma optimizer prefilter.
9261 It will do some extra magic on color information to minimize the
9262 stepped-stairs effect on edges.
9263 It will improve quality at the cost of encoding speed.
9264 It reduces PSNR by nature, as the mathematical deviation to the original
9265 picture will get bigger, but the subjective image quality will raise.
9266 Since it works with color information, you might want to turn it off when
9267 encoding in grayscale.
9271 Activates high-quality prediction of AC coefficients for intra frames from
9272 neighbor blocks (default: on).
9276 The motion search algorithm is based on a search in the usual color domain
9277 and tries to find a motion vector that minimizes the difference between the
9278 reference frame and the encoded frame.
9279 With this setting activated, Xvid will also use the frequency domain (DCT)
9280 to search for a motion vector that minimizes not only the spatial
9281 difference but also the encoding length of the block.
9288 mode decision (inter/\:intra MB) (default)
9300 Adaptive quantization allows the macroblock quantizers to vary inside
9302 This is a 'psychosensory' setting that is supposed to make use of the
9303 fact that the human eye tends to notice fewer details in very bright
9304 and very dark parts of the picture.
9305 It compresses those areas more strongly than medium ones, which will
9306 save bits that can be spent again on other frames, raising overall
9307 subjective quality and possibly reducing PSNR.
9311 Make Xvid discard chroma planes so the encoded video is grayscale only.
9312 Note that this does not speed up encoding, it just prevents chroma data
9313 from being written in the last stage of encoding.
9317 Encode the fields of interlaced video material.
9318 Turn this option on for interlaced content.
9321 Should you rescale the video, you would need an interlace-aware resizer,
9322 which you can activate with \-vf scale=<width>:<height>:1.
9325 .B min_iquant=<0\-31>
9326 minimum I-frame quantizer (default: 2)
9329 .B max_iquant=<0\-31>
9330 maximum I-frame quantizer (default: 31)
9333 .B min_pquant=<0\-31>
9334 minimum P-frame quantizer (default: 2)
9337 .B max_pquant=<0\-31>
9338 maximum P-frame quantizer (default: 31)
9341 .B min_bquant=<0\-31>
9342 minimum B-frame quantizer (default: 2)
9345 .B max_bquant=<0\-31>
9346 maximum B-frame quantizer (default: 31)
9349 .B min_key_interval=<value> (two pass only)
9350 minimum interval between keyframes (default: 0)
9353 .B max_key_interval=<value>
9354 maximum interval between keyframes (default: 10*fps)
9357 .B quant_type=<h263|mpeg>
9358 Sets the type of quantizer to use.
9359 For high bitrates, you will find that MPEG quantization preserves more detail.
9360 For low bitrates, the smoothing of H.263 will give you less block noise.
9361 When using custom matrices, MPEG quantization
9366 .B quant_intra_matrix=<filename>
9367 Load a custom intra matrix file.
9368 You can build such a file with xvid4conf's matrix editor.
9371 .B quant_inter_matrix=<filename>
9372 Load a custom inter matrix file.
9373 You can build such a file with xvid4conf's matrix editor.
9376 .B keyframe_boost=<0\-1000> (two pass mode only)
9377 Shift some bits from the pool for other frame types to intra frames,
9378 thus improving keyframe quality.
9379 This amount is an extra percentage, so a value of 10 will give
9380 your keyframes 10% more bits than normal
9384 .B kfthreshold=<value> (two pass mode only)
9385 Works together with kfreduction.
9386 Determines the minimum distance below which you consider that
9387 two frames are considered consecutive and treated differently
9388 according to kfreduction
9392 .B kfreduction=<0\-100> (two pass mode only)
9393 The above two settings can be used to adjust the size of keyframes that
9394 you consider too close to the first (in a row).
9395 kfthreshold sets the range in which keyframes are reduced, and
9396 kfreduction determines the bitrate reduction they get.
9397 The last I-frame will get treated normally
9401 .B max_bframes=<0\-4>
9402 Maximum number of B-frames to put between I/P-frames (default: 2).
9405 .B bquant_ratio=<0\-1000>
9406 quantizer ratio between B- and non-B-frames, 150=1.50 (default: 150)
9409 .B bquant_offset=<\-1000\-1000>
9410 quantizer offset between B- and non-B-frames, 100=1.00 (default: 100)
9413 .B bf_threshold=<\-255\-255>
9414 This setting allows you to specify what priority to place on the use of
9416 The higher the value, the higher the probability of B-frames being used
9418 Do not forget that B-frames usually have a higher quantizer, and therefore
9419 aggressive production of B-frames may cause worse visual quality.
9423 This option tells Xvid to close every GOP (Group Of Pictures bounded
9424 by two I-frames), which makes GOPs independent from each other.
9425 This just implies that the last frame of the GOP is either a P-frame or a
9426 N-frame but not a B-frame.
9427 It is usually a good idea to turn this option on (default: on).
9431 This option is meant to solve frame-order issues when encoding to
9432 container formats like AVI that cannot cope with out-of-order frames.
9433 In practice, most decoders (both software and hardware) are able to deal
9434 with frame-order themselves, and may get confused when this option is
9435 turned on, so you can safely leave if off, unless you really know what
9439 This will generate an illegal bitstream, and will not be
9440 decodable by ISO-MPEG-4 decoders except DivX/\:libavcodec/\:Xvid.
9443 This will also store a fake DivX version in the file so the bug
9444 autodetection of some decoders might be confused.
9447 .B frame_drop_ratio=<0\-100> (max_bframes=0 only)
9448 This setting allows the creation of variable framerate video streams.
9449 The value of the setting specifies a threshold under which, if the
9450 difference of the following frame to the previous frame is below or equal
9451 to this threshold, a frame gets not coded (a so called n-vop is placed
9453 On playback, when reaching an n-vop the previous frame will be displayed.
9456 Playing with this setting may result in a jerky video, so use it at your
9460 .B rc_reaction_delay_factor=<value>
9461 This parameter controls the number of frames the CBR rate controller
9462 will wait before reacting to bitrate changes and compensating for them
9463 to obtain a constant bitrate over an averaging range of frames.
9466 .B rc_averaging_period=<value>
9467 Real CBR is hard to achieve.
9468 Depending on the video material, bitrate can be variable, and hard to predict.
9469 Therefore Xvid uses an averaging period for which it guarantees a given
9470 amount of bits (minus a small variation).
9471 This settings expresses the "number of frames" for which Xvid averages
9472 bitrate and tries to achieve CBR.
9475 .B rc_buffer=<value>
9476 size of the rate control buffer
9479 .B curve_compression_high=<0\-100>
9480 This setting allows Xvid to take a certain percentage of bits away from
9481 high bitrate scenes and give them back to the bit reservoir.
9482 You could also use this if you have a clip with so many bits allocated
9483 to high-bitrate scenes that the low(er)-bitrate scenes start to look bad
9487 .B curve_compression_low=<0\-100>
9488 This setting allows Xvid to give a certain percentage of extra bits to the
9489 low bitrate scenes, taking a few bits from the entire clip.
9490 This might come in handy if you have a few low-bitrate scenes that are
9491 still blocky (default: 0).
9494 .B overflow_control_strength=<0\-100>
9495 During pass one of two pass encoding, a scaled bitrate curve is computed.
9496 The difference between that expected curve and the result obtained during
9497 encoding is called overflow.
9498 Obviously, the two pass rate controller tries to compensate for that overflow,
9499 distributing it over the next frames.
9500 This setting controls how much of the overflow is distributed every time
9501 there is a new frame.
9502 Low values allow lazy overflow control, big rate bursts are compensated for
9503 more slowly (could lead to lack of precision for small clips).
9504 Higher values will make changes in bit redistribution more abrupt, possibly
9505 too abrupt if you set it too high, creating artifacts (default: 5).
9508 This setting impacts quality a lot, play with it carefully!
9511 .B max_overflow_improvement=<0\-100>
9512 During the frame bit allocation, overflow control may increase the frame
9514 This parameter specifies the maximum percentage by which the overflow
9515 control is allowed to increase the frame size, compared to the ideal curve
9520 .B max_overflow_degradation=<0\-100>
9521 During the frame bit allocation, overflow control may decrease the frame
9523 This parameter specifies the maximum percentage by which the overflow
9524 control is allowed to decrease the frame size, compared to the ideal curve
9529 .B container_frame_overhead=<0...>
9530 Specifies a frame average overhead per frame, in bytes.
9531 Most of the time users express their target bitrate for video w/o taking
9532 care of the video container overhead.
9533 This small but (mostly) constant overhead can cause the target file size
9535 Xvid allows users to set the amount of overhead per frame the
9536 container generates (give only an average per frame).
9537 0 has a special meaning, it lets Xvid use its own default values
9538 (default: 24 \- AVI average overhead).
9541 .B profile=<profile_name>
9542 Restricts options and VBV (peak bitrate over a short period) according to
9543 the Simple, Advanced Simple and DivX profiles.
9544 The resulting videos should be playable on standalone players adhering to these
9545 profile specifications.
9549 no restrictions (default)
9551 simple profile at level 0
9553 simple profile at level 1
9555 simple profile at level 2
9557 simple profile at level 3
9559 advanced simple profile at level 0
9561 advanced simple profile at level 1
9563 advanced simple profile at level 2
9565 advanced simple profile at level 3
9567 advanced simple profile at level 4
9569 advanced simple profile at level 5
9571 DXN handheld profile
9573 DXN portable NTSC profile
9575 DXN portable PAL profile
9577 DXN home theater NTSC profile
9579 DXN home theater PAL profile
9586 These profiles should be used in conjunction with an appropriate \-ffourcc.
9587 Generally DX50 is applicable, as some players do not recognize Xvid but
9588 most recognize DivX.
9593 Specifies the Pixel Aspect Ratio mode (not to be confused with DAR,
9594 the Display Aspect Ratio).
9595 PAR is the ratio of the width and height of a single pixel.
9596 So both are related like this: DAR = PAR * (width/height).
9598 MPEG-4 defines 5 pixel aspect ratios and one extended
9599 one, giving the opportunity to specify a specific pixel aspect
9601 5 standard modes can be specified:
9605 It is the usual PAR for PC content.
9606 Pixels are a square unit.
9608 PAL standard 4:3 PAR.
9609 Pixels are rectangles.
9615 same as above (Do not forget to give the exact ratio.)
9617 Allows you to specify your own pixel aspect ratio with par_width and
9623 In general, setting aspect and autoaspect options is enough.
9627 .B par_width=<1\-255> (par=ext only)
9628 Specifies the width of the custom pixel aspect ratio.
9631 .B par_height=<1\-255> (par=ext only)
9632 Specifies the height of the custom pixel aspect ratio.
9635 .B aspect=<x/y | f (float value)>
9636 Store movie aspect internally, just like MPEG files.
9637 Much nicer solution than rescaling, because quality is not decreased.
9638 MPlayer and a few others players will play these files correctly, others
9639 will display them with the wrong aspect.
9640 The aspect parameter can be given as a ratio or a floating point number.
9644 Same as the aspect option, but automatically computes aspect, taking
9645 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
9650 Print the PSNR (peak signal to noise ratio) for the whole video after encoding
9651 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
9652 the current directory.
9653 Returned values are in dB (decibel), the higher the better.
9657 Save per-frame statistics in ./xvid.dbg. (This is not the two pass control
9663 The following option is only available in Xvid 1.1.x.
9667 This setting allows vector candidates for B-frames to be used for
9668 the encoding chosen using a rate distortion optimized operator,
9669 which is what is done for P-frames by the vhq option.
9670 This produces nicer-looking B-frames while incurring almost no
9671 performance penalty (default: 1).
9675 The following option is only available in the 1.2.x version of Xvid.
9679 Create n threads to run the motion estimation (default: 0).
9680 The maximum number of threads that can be used is the picture height
9684 .SS x264enc (\-x264encopts)
9688 Sets the average bitrate to be used in kbits/\:second (default: off).
9689 Since local bitrate may vary, this average may be inaccurate for
9690 very short videos (see ratetol).
9691 Constant bitrate can be achieved by combining this with vbv_maxrate,
9692 at significant reduction in quality.
9696 This selects the quantizer to use for P-frames.
9697 I- and B-frames are offset from this value by ip_factor and pb_factor, respectively.
9698 20\-40 is a useful range.
9699 Lower values result in better fidelity, but higher bitrates.
9701 Note that quantization in H.264 works differently from MPEG-1/2/4:
9702 H.264's quantization parameter (QP) is on a logarithmic scale.
9703 The mapping is approximately H264QP = 12 + 6*log2(MPEGQP).
9704 For example, MPEG at QP=2 is equivalent to H.264 at QP=18.
9708 Enables constant quality mode, and selects the quality.
9709 The scale is similar to QP.
9710 Like the bitrate-based modes, this allows each frame to use a
9711 different QP based on the frame's complexity.
9715 Enable 2 or 3-pass mode.
9716 It is recommended to always encode in 2 or 3-pass mode as it leads to a
9717 better bit distribution and improves overall quality.
9723 second pass (of two pass encoding)
9725 Nth pass (second and third passes of three pass encoding)
9728 Here is how it works, and how to use it:
9730 The first pass (pass=1) collects statistics on the video and writes them
9732 You might want to deactivate some CPU-hungry options, apart from the ones
9733 that are on by default.
9735 In two pass mode, the second pass (pass=2) reads the statistics file and
9736 bases ratecontrol decisions on it.
9738 In three pass mode, the second pass (pass=3, that is not a typo)
9739 does both: It first reads the statistics, then overwrites them.
9740 You can use all encoding options, except very CPU-hungry options.
9742 The third pass (pass=3) is the same as the second pass, except that it has
9743 the second pass' statistics to work from.
9744 You can use all encoding options, including CPU-hungry ones.
9746 The first pass may use either average bitrate or constant quantizer.
9747 ABR is recommended, since it does not require guessing a quantizer.
9748 Subsequent passes are ABR, and must specify bitrate.
9753 Fast first pass mode.
9754 During the first pass of a two or more pass encode it is possible to gain
9755 speed by disabling some options with negligible or even no impact on the
9756 final pass output quality.
9762 Reduce subq, frameref and disable some inter-macroblock partition analysis
9765 Reduce subq and frameref to 1, use a diamond ME search and disable all
9766 partition analysis modes.
9769 Level 1 can increase first pass speed up to 2x with no change in the global
9770 PSNR of the final pass compared to a full quality first pass.
9772 Level 2 can increase first pass speed up to 4x with about +/\- 0.05dB change
9773 in the global PSNR of the final pass compared to a full quality first pass.
9778 Sets maximum interval between IDR-frames (default: 250).
9779 Larger values save bits, thus improve quality, at the cost of seeking
9781 Unlike MPEG-1/2/4, H.264 does not suffer from DCT drift with large
9785 .B keyint_min=<1\-keyint/2>
9786 Sets minimum interval between IDR-frames (default: 25).
9787 If scenecuts appear within this interval, they are still encoded as
9788 I-frames, but do not start a new GOP.
9789 In H.264, I-frames do not necessarily bound a closed GOP because it is
9790 allowable for a P-frame to be predicted from more frames than just the one
9791 frame before it (also see frameref).
9792 Therefore, I-frames are not necessarily seekable.
9793 IDR-frames restrict subsequent P-frames from referring to any frame
9794 prior to the IDR-frame.
9797 .B scenecut=<\-1\-100>
9798 Controls how aggressively to insert extra I-frames (default: 40).
9799 With small values of scenecut, the codec often has to force an I-frame
9800 when it would exceed keyint.
9801 Good values of scenecut may find a better location for the I-frame.
9802 Large values use more I-frames than necessary, thus wasting bits.
9803 \-1 disables scene-cut detection, so I-frames are inserted only once
9804 every other keyint frames, even if a scene-cut occurs earlier.
9805 This is not recommended and wastes bitrate as scenecuts encoded as P-frames
9806 are just as big as I-frames, but do not reset the "keyint counter".
9810 Number of previous frames used as predictors in B- and P-frames (default: 1).
9811 This is effective in anime, but in live-action material the improvements
9812 usually drop off very rapidly above 6 or so reference frames.
9813 This has no effect on decoding speed, but does increase the memory needed for
9815 Some decoders can only handle a maximum of 15 reference frames.
9819 maximum number of consecutive B-frames between I- and P-frames (default: 0)
9823 Automatically decides when to use B-frames and how many, up to the maximum
9824 specified above (default: on).
9825 If this option is disabled, then the maximum number of B-frames is used.
9828 .B b_bias=<\-100\-100>
9829 Controls the decision performed by b_adapt.
9830 A higher b_bias produces more B-frames (default: 0).
9834 Allows B-frames to be used as references for predicting other frames.
9835 For example, consider 3 consecutive B-frames: I0 B1 B2 B3 P4.
9836 Without this option, B-frames follow the same pattern as MPEG-[124].
9837 So they are coded in the order I0 P4 B1 B2 B3, and all the B-frames
9838 are predicted from I0 and P4.
9839 With this option, they are coded as I0 P4 B2 B1 B3.
9840 B2 is the same as above, but B1 is predicted from I0 and B2, and
9841 B3 is predicted from B2 and P4.
9842 This usually results in slightly improved compression, at almost no
9844 However, this is an experimental option: it is not fully tuned and
9845 may not always help.
9846 Requires bframes >= 2.
9847 Disadvantage: increases decoding delay to 2 frames.
9851 Use deblocking filter (default: on).
9852 As it takes very little time compared to its quality gain, it is not
9853 recommended to disable it.
9856 .B deblock=<\-6\-6>,<\-6\-6>
9857 The first parameter is AlphaC0 (default: 0).
9858 This adjusts thresholds for the H.264 in-loop deblocking filter.
9859 First, this parameter adjusts the maximum amount of change that the filter is
9860 allowed to cause on any one pixel.
9861 Secondly, this parameter affects the threshold for difference across the
9862 edge being filtered.
9863 A positive value reduces blocking artifacts more, but will also smear details.
9865 The second parameter is Beta (default: 0).
9866 This affects the detail threshold.
9867 Very detailed blocks are not filtered, since the smoothing caused by the
9868 filter would be more noticeable than the original blocking.
9870 The default behavior of the filter almost always achieves optimal quality,
9871 so it is best to either leave it alone, or make only small adjustments.
9872 However, if your source material already has some blocking or noise which
9873 you would like to remove, it may be a good idea to turn it up a little bit.
9877 Use CABAC (Context-Adaptive Binary Arithmetic Coding) (default: on).
9878 Slightly slows down encoding and decoding, but should save 10\-15% bitrate.
9879 Unless you are looking for decoding speed, you should not disable it.
9882 .B qp_min=<1\-51> (ABR or two pass)
9883 Minimum quantizer, 10\-30 seems to be a useful range (default: 10).
9886 .B qp_max=<1\-51> (ABR or two pass)
9887 maximum quantizer (default: 51)
9890 .B qp_step=<1\-50> (ABR or two pass)
9891 maximum value by which the quantizer may be incremented/decremented between
9895 .B ratetol=<0.1\-100.0> (ABR or two pass)
9896 allowed variance in average bitrate (no particular units) (default: 1.0)
9899 .B vbv_maxrate=<value> (ABR or two pass)
9900 maximum local bitrate, in kbits/\:second (default: disabled)
9903 .B vbv_bufsize=<value> (ABR or two pass)
9904 averaging period for vbv_maxrate, in kbits
9905 (default: none, must be specified if vbv_maxrate is enabled)
9908 .B vbv_init=<0.0\-1.0> (ABR or two pass)
9909 initial buffer occupancy, as a fraction of vbv_bufsize (default: 0.9)
9912 .B ip_factor=<value>
9913 quantizer factor between I- and P-frames (default: 1.4)
9916 .B pb_factor=<value>
9917 quantizer factor between P- and B-frames (default: 1.3)
9920 .B qcomp=<0\-1> (ABR or two pass)
9921 quantizer compression (default: 0.6).
9922 A lower value makes the bitrate more constant,
9923 while a higher value makes the quantization parameter more constant.
9926 .B cplx_blur=<0\-999> (two pass only)
9927 Temporal blur of the estimated frame complexity, before curve compression
9929 Lower values allow the quantizer value to jump around more,
9930 higher values force it to vary more smoothly.
9931 cplx_blur ensures that each I-frame has quality comparable to the following
9932 P-frames, and ensures that alternating high and low complexity frames
9933 (e.g. low fps animation) do not waste bits on fluctuating quantizer.
9936 .B qblur=<0\-99> (two pass only)
9937 Temporal blur of the quantization parameter, after curve compression
9939 Lower values allow the quantizer value to jump around more,
9940 higher values force it to vary more smoothly.
9943 .B zones=<zone0>[/<zone1>[/...]]
9944 User specified quality for specific parts (ending, credits, ...).
9945 Each zone is <start-frame>,<end-frame>,<option> where option may be
9950 .IPs "b=<0.01\-100.0>"
9956 The quantizer option is not strictly enforced.
9957 It affects only the planning stage of ratecontrol, and is still subject
9958 to overflow compensation and qp_min/qp_max.
9962 .B direct_pred=<name>
9963 Determines the type of motion prediction used for direct macroblocks
9968 Direct macroblocks are not used.
9970 Motion vectors are extrapolated from neighboring blocks.
9973 Motion vectors are extrapolated from the following P-frame.
9975 The codec selects between spatial and temporal for each frame.
9979 Spatial and temporal are approximately the same speed and PSNR,
9980 the choice between them depends on the video content.
9981 Auto is slightly better, but slower.
9982 Auto is most effective when combined with multipass.
9983 direct_pred=none is both slower and lower quality.
9988 Use weighted prediction in B-frames.
9989 Without this option, bidirectionally predicted macroblocks give
9990 equal weight to each reference frame.
9991 With this option, the weights are determined by the temporal position
9992 of the B-frame relative to the references.
9993 Requires bframes > 1.
9996 .B partitions=<list>
9997 Enable some optional macroblock types (default: p8x8,b8x8,i8x8,i4x4).
10001 Enable types p16x8, p8x16, p8x8.
10003 Enable types p8x4, p4x8, p4x4.
10004 p4x4 is recommended only with subq >= 5, and only at low resolutions.
10006 Enable types b16x8, b8x16, b8x8.
10009 i8x8 has no effect unless 8x8dct is enabled.
10013 Enable all of the above types.
10015 Disable all of the above types.
10019 Regardless of this option, macroblock types p16x16, b16x16, and i16x16
10020 are always enabled.
10022 The idea is to find the type and size that best describe a certain area
10024 For example, a global pan is better represented by 16x16 blocks, while
10025 small moving objects are better represented by smaller blocks.
10030 Adaptive spatial transform size: allows macroblocks to choose between
10032 Also allows the i8x8 macroblock type.
10033 Without this option, only 4x4 DCT is used.
10037 Select fullpixel motion estimation algorithm.
10041 diamond search, radius 1 (fast)
10043 hexagon search, radius 2 (default)
10045 uneven multi-hexagon search (slow)
10047 exhaustive search (very slow, and no better than umh)
10052 .B me_range=<4\-64>
10053 radius of exhaustive or multi-hexagon motion search (default: 16)
10057 Adjust subpel refinement quality.
10058 This parameter controls quality versus speed tradeoffs involved in the motion
10059 estimation decision process.
10060 subq=5 can compress up to 10% better than subq=1.
10064 Runs fullpixel precision motion estimation on all candidate
10066 Then selects the best type with SAD metric (faster than subq=1, not recommended
10067 unless you're looking for ultra-fast encoding).
10069 Does as 0, then refines the motion of that type to fast quarterpixel precision
10072 Runs halfpixel precision motion estimation on all candidate macroblock types.
10073 Then selects the best type with SATD metric.
10074 Then refines the motion of that type to fast quarterpixel precision.
10076 As 2, but uses a slower quarterpixel refinement.
10078 Runs fast quarterpixel precision motion estimation on all candidate
10080 Then selects the best type with SATD metric.
10081 Then finishes the quarterpixel refinement for that type.
10083 Runs best quality quarterpixel precision motion estimation on all
10084 candidate macroblock types, before selecting the best type.
10085 Also refines the two motion vectors used in bidirectional macroblocks with
10086 SATD metric, rather than reusing vectors from the forward and backward
10089 Enables rate-distortion optimization of macroblock types in
10090 I- and P-frames (default).
10092 Enables rate-distortion optimization of macroblock types in all frames.
10094 Enables rate-distortion optimization of motion vectors and intra prediction modes in I- and P-frames.
10096 Enables rate-distortion optimization of motion vectors and intra prediction modes in all frames (best).
10100 In the above, "all candidates" does not exactly mean all enabled types:
10101 4x4, 4x8, 8x4 are tried only if 8x8 is better than 16x16.
10106 Takes into account chroma information during subpixel motion search
10107 (default: enabled).
10112 Allows each 8x8 or 16x8 motion partition to independently select a
10114 Without this option, a whole macroblock must use the same reference.
10115 Requires frameref>1.
10118 .B trellis=<0\-2> (cabac only)
10119 rate-distortion optimal quantization
10125 enabled only for the final encode
10127 enabled during all mode decisions (slow, requires subq>=6)
10132 .B psy-rd=rd[,trell]
10133 Sets the strength of the psychovisual optimization.
10136 .IPs rd=<0.0\-10.0>
10137 psy optimization strength (requires subq>=6) (default: 1.0)
10138 .IPs trell=<0.0\-10.0>
10139 trellis (requires trellis, experimental) (default: 0.0)
10145 .B deadzone_inter=<0\-32>
10146 Set the size of the inter luma quantization deadzone for non-trellis
10147 quantization (default: 21).
10148 Lower values help to preserve fine details and film grain (typically useful
10149 for high bitrate/quality encode), while higher values help filter out
10150 these details to save bits that can be spent again on other macroblocks
10151 and frames (typically useful for bitrate-starved encodes).
10152 It is recommended that you start by tweaking deadzone_intra before changing
10156 .B deadzone_intra=<0\-32>
10157 Set the size of the intra luma quantization deadzone for non-trellis
10158 quantization (default: 11).
10159 This option has the same effect as deadzone_inter except that it affects
10161 It is recommended that you start by tweaking this parameter before changing
10166 Performs early skip detection in P-frames (default: enabled).
10167 This usually improves speed at no cost, but it can sometimes produce
10168 artifacts in areas with no details, like sky.
10171 .B (no)dct_decimate
10172 Eliminate dct blocks in P-frames containing only a small single coefficient
10173 (default: enabled).
10174 This will remove some details, so it will save bits that can be spent
10175 again on other frames, hopefully raising overall subjective quality.
10176 If you are compressing non-anime content with a high target bitrate, you
10177 may want to disable this to preserve as much detail as possible.
10181 Noise reduction, 0 means disabled.
10182 100\-1000 is a useful range for typical content, but you may want to turn it
10183 up a bit more for very noisy content (default: 0).
10184 Given its small impact on speed, you might want to prefer to use this over
10185 filtering noise away with video filters like denoise3d or hqdn3d.
10188 .B chroma_qp_offset=<\-12\-12>
10189 Use a different quantizer for chroma as compared to luma.
10190 Useful values are in the range <\-2\-2> (default: 0).
10194 Defines how adaptive quantization (AQ) distributes bits:
10200 Avoid moving bits between frames.
10202 Move bits between frames (by default).
10207 .B aq_strength=<positive float value>
10208 Controls how much adaptive quantization (AQ) reduces blocking and blurring
10209 in flat and textured areas (default: 1.0).
10210 A value of 0.5 will lead to weak AQ and less details, when a value of 1.5
10211 will lead to strong AQ and more details.
10214 .B cqm=<flat|jvt|<filename>>
10215 Either uses a predefined custom quantization matrix or loads a JM format
10220 Use the predefined flat 16 matrix (default).
10222 Use the predefined JVT matrix.
10224 Use the provided JM format matrix file.
10229 Windows CMD.EXE users may experience problems with parsing the command line
10230 if they attempt to use all the CQM lists.
10231 This is due to a command line length limitation.
10232 In this case it is recommended the lists be put into a JM format CQM
10233 file and loaded as specified above.
10237 .B cqm4iy=<list> (also see cqm)
10238 Custom 4x4 intra luminance matrix, given as a list of 16 comma separated
10239 values in the 1\-255 range.
10242 .B cqm4ic=<list> (also see cqm)
10243 Custom 4x4 intra chrominance matrix, given as a list of 16 comma
10244 separated values in the 1\-255 range.
10247 .B cqm4py=<list> (also see cqm)
10248 Custom 4x4 inter luminance matrix, given as a list of 16 comma separated
10249 values in the 1\-255 range.
10252 .B cqm4pc=<list> (also see cqm)
10253 Custom 4x4 inter chrominance matrix, given as a list of 16 comma
10254 separated values in the 1\-255 range.
10257 .B cqm8iy=<list> (also see cqm)
10258 Custom 8x8 intra luminance matrix, given as a list of 64 comma separated
10259 values in the 1\-255 range.
10262 .B cqm8py=<list> (also see cqm)
10263 Custom 8x8 inter luminance matrix, given as a list of 64 comma separated
10264 values in the 1\-255 range.
10267 .B level_idc=<10\-51>
10268 Set the bitstream's level as defined by annex A of the H.264 standard
10269 (default: 51 \- level 5.1).
10270 This is used for telling the decoder what capabilities it needs to support.
10271 Use this parameter only if you know what it means,
10272 and you have a need to set it.
10276 Spawn threads to encode in parallel on multiple CPUs (default: 1).
10277 This has a slight penalty to compression quality.
10278 0 or 'auto' tells x264 to detect how many CPUs you have and pick an
10279 appropriate number of threads.
10282 .B (no)global_header
10283 Causes SPS and PPS to appear only once, at the beginning of the bitstream
10284 (default: disabled).
10285 Some players, such as the Sony PSP, require the use of this option.
10286 The default behavior causes SPS and PPS to repeat prior to each IDR frame.
10290 Treat the video content as interlaced.
10294 Adjust the amount of logging info printed to the screen.
10304 PSNR and other analysis statistics when the encode finishes (default)
10306 PSNR, QP, frametype, size, and other statistics for every frame
10312 Print signal-to-noise ratio statistics.
10315 The 'Y', 'U', 'V', and 'Avg' PSNR fields in the summary are not
10316 mathematically sound (they are simply the average of per-frame PSNRs).
10317 They are kept only for comparison to the JM reference codec.
10318 For all other purposes, please use either the 'Global' PSNR, or the per-frame
10319 PSNRs printed by log=3.
10323 Print the Structural Similarity Metric results.
10324 This is an alternative to PSNR, and may be better correlated with the
10325 perceived quality of the compressed video.
10329 Enable x264 visualizations during encoding.
10330 If the x264 on your system supports it, a new window will be opened during
10331 the encoding process, in which x264 will attempt to present an overview of
10332 how each frame gets encoded.
10333 Each block type on the visualized movie will be colored as follows:
10347 This feature can be considered experimental and subject to change.
10348 In particular, it depends on x264 being compiled with visualizations enabled.
10349 Note that as of writing this, x264 pauses after encoding and visualizing
10350 each frame, waiting for the user to press a key, at which point the next
10351 frame will be encoded.
10355 .SS xvfw (\-xvfwopts)
10357 Encoding with Video for Windows codecs is mostly obsolete unless you wish
10358 to encode to some obscure fringe codec.
10362 The name of the binary codec file with which to encode.
10366 The name of the codec settings file (like firstpass.mcf) created by vfw2menc.
10369 .SS MPEG muxer (\-mpegopts)
10371 The MPEG muxer can generate 5 types of streams, each of which has reasonable
10372 default parameters that the user can override.
10373 Generally, when generating MPEG files, it is advisable to disable
10374 MEncoder's frame-skip code (see \-noskip, \-mc as well as the
10375 harddup and softskip video filters).
10380 .IPs format=mpeg2:tsaf:vbitrate=8000
10385 .B format=<mpeg1 | mpeg2 | xvcd | xsvcd | dvd | pes1 | pes2>
10386 stream format (default: mpeg2).
10387 pes1 and pes2 are very broken formats (no pack header and no padding),
10388 but VDR uses them; do not choose them unless you know exactly what you
10392 .B size=<up to 65535>
10393 Pack size in bytes, do not change unless you know exactly what
10394 you are doing (default: 2048).
10398 Nominal muxrate in kbit/s used in the pack headers (default: 1800 kb/s).
10399 Will be updated as necessary in the case of 'format=mpeg1' or 'mpeg2'.
10403 Sets timestamps on all frames, if possible; recommended when format=dvd.
10404 If dvdauthor complains with a message like "..audio sector out of range...",
10405 you probably did not enable this option.
10409 Uses a better algorithm to interleave audio and video packets, based on the
10410 principle that the muxer will always try to fill the stream with the largest
10411 percentage of free space.
10414 .B vdelay=<1\-32760>
10415 Initial video delay time, in milliseconds (default: 0),
10416 use it if you want to delay video with respect to audio.
10417 It doesn't work with :drop.
10420 .B adelay=<1\-32760>
10421 Initial audio delay time, in milliseconds (default: 0),
10422 use it if you want to delay audio with respect to video.
10426 When used with vdelay the muxer drops the part of audio that was
10430 .B vwidth, vheight=<1\-4095>
10431 Set the video width and height when video is MPEG-1/2.
10434 .B vpswidth, vpsheight=<1\-4095>
10435 Set pan and scan video width and height when video is MPEG-2.
10438 .B vaspect=<1 | 4/3 | 16/9 | 221/100>
10439 Sets the display aspect ratio for MPEG-2 video.
10440 Do not use it on MPEG-1 or the resulting aspect ratio will be completely wrong.
10444 Sets the video bitrate in kbit/s for MPEG-1/2 video.
10447 .B vframerate=<24000/1001 | 24 | 25 | 30000/1001 | 30 | 50 | 60000/1001 | 60 >
10448 Sets the framerate for MPEG-1/2 video.
10449 This option will be ignored if used with the telecine option.
10453 Enables 3:2 pulldown soft telecine mode: The muxer will make the
10454 video stream look like it was encoded at 30000/1001 fps.
10455 It only works with MPEG-2 video when the output framerate is
10456 24000/1001 fps, convert it with \-ofps if necessary.
10457 Any other framerate is incompatible with this option.
10461 Enables FILM to PAL and NTSC to PAL soft telecine mode: The muxer
10462 will make the video stream look like it was encoded at 25 fps.
10463 It only works with MPEG-2 video when the output framerate is
10464 24000/1001 fps, convert it with \-ofps if necessary.
10465 Any other framerate is incompatible with this option.
10468 .B tele_src and tele_dest
10469 Enables arbitrary telecining using Donand Graft's DGPulldown code.
10470 You need to specify the original and the desired framerate; the
10471 muxer will make the video stream look like it was encoded at
10472 the desired framerate.
10473 It only works with MPEG-2 video when the input framerate is smaller
10474 than the output framerate and the framerate increase is <= 1.5.
10481 .IPs tele_src=25,tele_dest=30000/1001
10482 PAL to NTSC telecining
10487 .B vbuf_size=<40\-1194>
10488 Sets the size of the video decoder's buffer, expressed in kilobytes.
10489 Specify it only if the bitrate of the video stream is too high for
10490 the chosen format and if you know perfectly well what you are doing.
10491 A too high value may lead to an unplayable movie, depending on the player's
10493 When muxing HDTV video a value of 400 should suffice.
10496 .B abuf_size=<4\-64>
10497 Sets the size of the audio decoder's buffer, expressed in kilobytes.
10498 The same principle as for vbuf_size applies.
10501 .SS FFmpeg libavformat demuxers (\-lavfdopts)
10504 .B analyzeduration=<value>
10505 Maximum length in seconds to analyze the stream properties.
10509 Force a specific libavformat demuxer.
10512 .B o=<key>=<value>[,<key>=<value>[,...]]
10513 Pass AVOptions to libavformat demuxer.
10514 Note, a patch to make the o= unneeded and pass all unknown options through
10515 the AVOption system is welcome.
10516 A full list of AVOptions can be found in the FFmpeg manual.
10517 Note that some options may conflict with MPlayer/MEncoder options.
10529 .B probesize=<value>
10530 Maximum amount of data to probe during the detection phase.
10531 In the case of MPEG-TS this value identifies the maximum number
10532 of TS packets to scan.
10535 .B cryptokey=<hexstring>
10536 Encryption key the demuxer should use.
10537 This is the raw binary data of the key converted to a hexadecimal string.
10540 .SS FFmpeg libavformat muxers (\-lavfopts) (also see \-of lavf)
10544 Currently only meaningful for MPEG[12]: Maximum allowed distance,
10545 in seconds, between the reference timer of the output stream (SCR)
10546 and the decoding timestamp (DTS) for any stream present
10547 (demux to decode delay).
10548 Default is 0.7 (as mandated by the standards defined by MPEG).
10549 Higher values require larger buffers and must not be used.
10552 .B format=<container_format>
10553 Override which container format to mux into
10554 (default: autodetect from output file extension).
10558 MPEG-1 systems and MPEG-2 PS
10560 Advanced Streaming Format
10562 Audio Video Interleave file
10568 Macromedia Flash video files
10570 RealAudio and RealVideo
10574 NUT open container format (experimental)
10580 MPEG-4 format with extra header flags required by Apple iPod firmware
10582 Sony Digital Video container
10583 .IPs "matroska\ \ \ "
10589 Nominal bitrate of the multiplex, in bits per second;
10590 currently it is meaningful only for MPEG[12].
10591 Sometimes raising it is necessary in order to avoid "buffer underflows".
10594 .B o=<key>=<value>[,<key>=<value>[,...]]
10595 Pass AVOptions to libavformat muxer.
10596 Note, a patch to make the o= unneeded and pass all unknown options through
10597 the AVOption system is welcome.
10598 A full list of AVOptions can be found in the FFmpeg manual.
10599 Note that some options may conflict with MEncoder options.
10606 .IPs o=packetsize=100
10611 .B packetsize=<size>
10612 Size, expressed in bytes, of the unitary packet for the chosen format.
10613 When muxing to MPEG[12] implementations the default values are:
10614 2324 for [S]VCD, 2048 for all others formats.
10617 .B preload=<distance>
10618 Currently only meaningful for MPEG[12]: Initial distance,
10619 in seconds, between the reference timer of the output stream (SCR)
10620 and the decoding timestamp (DTS) for any stream present
10621 (demux to decode delay).
10625 .\" --------------------------------------------------------------------------
10626 .\" environment variables
10627 .\" --------------------------------------------------------------------------
10629 .SH ENVIRONMENT VARIABLES
10631 There are a number of environment variables that can be used to
10632 control the behavior of MPlayer and MEncoder.
10635 .B MPLAYER_CHARSET (also see \-msgcharset)
10636 Convert console messages to the specified charset (default: autodetect).
10637 A value of "noconv" means no conversion.
10641 Directory where MPlayer looks for user settings.
10644 .B MPLAYER_VERBOSE (also see \-v and \-msglevel)
10645 Set the initial verbosity level across all message modules (default: 0).
10646 The resulting verbosity corresponds to that of \-msglevel 5 plus the
10647 value of MPLAYER_VERBOSE.
10653 If LADSPA_PATH is set, it searches for the specified file.
10654 If it is not set, you must supply a fully specified pathname.
10655 FIXME: This is also mentioned in the ladspa section.
10661 Specify a directory in which to store title key values.
10662 This will speed up descrambling of DVDs which are in the cache.
10663 The DVDCSS_CACHE directory is created if it does not exist,
10664 and a subdirectory is created named after the DVD's title
10665 or manufacturing date.
10666 If DVDCSS_CACHE is not set or is empty, libdvdcss will use
10667 the default value which is "${HOME}/.dvdcss/" under Unix and
10668 "C:\\Documents and Settings\\$USER\\Application Data\\dvdcss\\" under Win32.
10669 The special value "off" disables caching.
10673 Sets the authentication and decryption method that
10674 libdvdcss will use to read scrambled discs.
10675 Can be one of title, key or disc.
10679 is the default method.
10680 libdvdcss will use a set of calculated player keys to try and get the disc key.
10681 This can fail if the drive does not recognize any of the player keys.
10683 is a fallback method when key has failed.
10684 Instead of using player keys, libdvdcss will crack the disc key using
10685 a brute force algorithm.
10686 This process is CPU intensive and requires 64 MB of memory to store
10689 is the fallback when all other methods have failed.
10690 It does not rely on a key exchange with the DVD drive, but rather uses
10691 a crypto attack to guess the title key.
10692 On rare cases this may fail because there is not enough encrypted data
10693 on the disc to perform a statistical attack, but in the other hand it
10694 is the only way to decrypt a DVD stored on a hard disc, or a DVD with
10695 the wrong region on an RPC2 drive.
10700 .B DVDCSS_RAW_DEVICE
10701 Specify the raw device to use.
10702 Exact usage will depend on your operating system, the Linux
10703 utility to set up raw devices is raw(8) for instance.
10704 Please note that on most operating systems, using a raw device
10705 requires highly aligned buffers: Linux requires a 2048 bytes
10706 alignment (which is the size of a DVD sector).
10710 Sets the libdvdcss verbosity level.
10714 Outputs no messages at all.
10716 Outputs error messages to stderr.
10718 Outputs error messages and debug messages to stderr.
10724 Skip retrieving all keys on startup.
10725 Currently disabled.
10729 FIXME: Document this.
10734 .B AO_SUN_DISABLE_SAMPLE_TIMING
10735 FIXME: Document this.
10739 FIXME: Document this.
10743 Specifies the Network Audio System server to which the
10744 nas audio output driver should connect and the transport
10745 that should be used.
10746 If unset DISPLAY is used instead.
10747 The transport can be one of tcp and unix.
10748 Syntax is tcp/<somehost>:<someport>, <somehost>:<instancenumber>
10749 or [unix]:<instancenumber>.
10750 The NAS base port is 8000 and <instancenumber> is added to that.
10757 .IPs AUDIOSERVER=somehost:0
10758 Connect to NAS server on somehost using default port and transport.
10759 .IPs AUDIOSERVER=tcp/somehost:8000
10760 Connect to NAS server on somehost listening on TCP port 8000.
10761 .IPs AUDIOSERVER=(unix)?:0
10762 Connect to NAS server instance 0 on localhost using unix domain sockets.
10768 FIXME: Document this.
10774 FIXME: Document this.
10778 Set this to 'disable' in order to stop the VIDIX driver from controlling
10779 alphablending settings.
10780 You can then manipulate it yourself with 'ivtvfbctl'.
10786 FIXME: Document this.
10792 FIXME: Document this.
10796 FIXME: Document this.
10800 FIXME: Document this.
10806 FIXME: Document this.
10810 FIXME: Document this.
10814 FIXME: Document this.
10818 FIXME: Document this.
10822 FIXME: Document this.
10828 FIXME: Document this.
10834 FIXME: Document this.
10838 FIXME: Document this.
10842 FIXME: Document this.
10848 FIXME: Document this.
10852 FIXME: Document this.
10856 FIXME: Document this.
10860 FIXME: Document this.
10864 FIXME: Document this.
10868 FIXME: Document this.
10872 .\" --------------------------------------------------------------------------
10874 .\" --------------------------------------------------------------------------
10879 /usr/\:local/\:etc/\:mplayer/\:mplayer.conf
10880 MPlayer system-wide settings
10883 /usr/\:local/\:etc/\:mplayer/\:mencoder.conf
10884 MEncoder system-wide settings
10887 ~/.mplayer/\:config
10888 MPlayer user settings
10891 ~/.mplayer/\:mencoder.conf
10892 MEncoder user settings
10895 ~/.mplayer/\:input.conf
10896 input bindings (see '\-input keylist' for the full list)
10899 ~/.mplayer/\:gui.conf
10900 GUI configuration file
10903 ~/.mplayer/\:gui.pl
10908 font directory (There must be a font.desc file and files with .RAW extension.)
10911 ~/.mplayer/\:DVDkeys/
10915 Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
10918 /path/\:to/\:movie.sub
10920 ~/.mplayer/\:sub/\:movie.sub
10925 .\" --------------------------------------------------------------------------
10927 .\" --------------------------------------------------------------------------
10929 .SH EXAMPLES OF MPLAYER USAGE
10932 .B Quickstart DVD playing:
10938 .B Play in Japanese with English subtitles:
10940 mplayer dvd://1 \-alang ja \-slang en
10944 .B Play only chapters 5, 6, 7:
10946 mplayer dvd://1 \-chapter 5\-7
10950 .B Play only titles 5, 6, 7:
10956 .B Play a multiangle DVD:
10958 mplayer dvd://1 \-dvdangle 2
10962 .B Play from a different DVD device:
10964 mplayer dvd://1 \-dvd\-device /dev/\:dvd2
10968 .B Play DVD video from a directory with VOB files:
10970 mplayer dvd://1 \-dvd\-device /path/\:to/\:directory/
10974 .B Copy a DVD title to hard disk, saving to file "title1.vob":
10976 mplayer dvd://1 \-dumpstream \-dumpfile title1.vob
10980 .B Play a DVD with dvdnav from path /dev/sr1:
10982 mplayer dvdnav:////dev/sr1
10986 .B Stream from HTTP:
10988 mplayer http://mplayer.hq/example.avi
10992 .B Stream using RTSP:
10994 mplayer rtsp://server.example.com/streamName
10998 .B Convert subtitles to MPsub format:
11000 mplayer dummy.avi \-sub source.sub \-dumpmpsub
11004 .B Convert subtitles to MPsub format without watching the movie:
11006 mplayer /dev/\:zero \-rawvideo pal:fps=xx \-demuxer rawvideo \-vc null \-vo null \-noframedrop \-benchmark \-sub source.sub \-dumpmpsub
11010 .B input from standard V4L:
11012 mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420 \-vo xv
11016 .B Playback on Zoran cards (old style, deprecated):
11018 mplayer \-vo zr \-vf scale=352:288 file.avi
11022 .B Playback on Zoran cards (new style):
11024 mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
11028 .B Play DTS-CD with passthrough:
11030 mplayer \-ac hwdts \-rawaudio format=0x2001 \-cdrom\-device /dev/cdrom cdda://
11033 You can also use \-afm hwac3 instead of \-ac hwdts.
11034 Adjust '/dev/cdrom' to match the CD-ROM device on your system.
11035 If your external receiver supports decoding raw DTS streams,
11036 you can directly play it via cdda:// without setting format, hwac3 or hwdts.
11039 .B Play a 6-channel AAC file with only two speakers:
11041 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
11044 You might want to play a bit with the pan values (e.g multiply with a value) to
11045 increase volume or avoid clipping.
11048 .B checkerboard invert with geq filter:
11050 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'
11054 .SH EXAMPLES OF MENCODER USAGE
11057 .B Encode DVD title #2, only selected chapters:
11059 mencoder dvd://2 \-chapter 10\-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11063 .B Encode DVD title #2, resizing to 640x480:
11065 mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11069 .B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
11071 mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11075 .B The same, but with bitrate set to 1800kbit and optimized macroblocks:
11077 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
11081 .B The same, but with MJPEG compression:
11083 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800
11087 .B Encode all *.jpg files in the current directory:
11089 mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
11093 .B Encode from a tuner (specify a format with \-vf format):
11095 mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
11099 .B Encode from a pipe:
11101 rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
11105 .\" --------------------------------------------------------------------------
11106 .\" Bugs, authors, standard disclaimer
11107 .\" --------------------------------------------------------------------------
11111 If you find one, report it to us, but please make sure you have read all
11112 of the documentation first.
11113 Also look out for smileys. :)
11114 Many bugs are the result of incorrect setup or parameter usage.
11115 The bug reporting section of the documentation
11116 (http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:bugreports.html)
11117 explains how to create useful bug reports.
11122 MPlayer was initially written by Arpad Gereoffy.
11123 See the AUTHORS file for a list of some of the many other contributors.
11125 MPlayer is (C) 2000\-2008 The MPlayer Team
11127 This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
11128 It is maintained by Diego Biurrun.
11129 Please send mails about it to the MPlayer-DOCS mailing list.
11130 Translation specific mails belong on the MPlayer-translations mailing list.