2 .\" MPlayer (C) 2000-2007 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 "2007-06-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]
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|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 Video CD, SVCD, DVD, 3ivx, DivX 3/4/5 and even WMV 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 Adjust audio delay by +/- 0.1 seconds.
238 Decrease/\:increase volume.
240 Decrease/\:increase volume.
242 Adjust audio balance in favor of left/\:right channel.
245 .IPs "_ (MPEG-TS, AVI and libavformat only)"
246 Cycle through the available video tracks.
247 .IPs "# (DVD, MPEG, Matroska, AVI and libavformat only)"
248 Cycle through the available audio tracks.
249 .IPs "TAB (MPEG-TS only)"
250 Cycle through the available programs.
252 Toggle fullscreen (also see \-fs).
254 Toggle stay-on-top (also see \-ontop).
256 Decrease/\:increase pan-and-scan range.
258 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
260 Toggle frame dropping states: none / skip display / skip decoding
261 (see \-framedrop and \-hardframedrop).
263 Toggle subtitle visibility.
265 Cycle through the available subtitles.
267 Step forward/backward in the subtitle list.
269 Toggle displaying "forced subtitles".
271 Toggle subtitle alignment: top / middle / bottom.
273 Adjust subtitle delay by +/- 0.1 seconds.
275 Move subtitles up/down.
276 .IPs "i (\-edlout mode only)"
277 Set start or end of an EDL skip and write it out to the given file.
278 .IPs "s (\-vf screenshot only)"
280 .IPs "S (\-vf screenshot only)"
281 Start/stop taking screenshots.
283 Show filename on the OSD.
285 Seek to the beginning of the previous/next chapter.
286 .IPs "D (\-vo xvmc, \-vf yadif, \-vf kerndeint only)"
287 Activate/deactivate deinterlacer.
292 (The following keys are valid only when using a hardware accelerated video
293 output (xv, (x)vidix, (x)mga, etc), the software equalizer
294 (\-vf eq or \-vf eq2) or hue filter (\-vf hue).)
311 (The following keys are valid only when using the quartz or macosx
312 video output driver.)
318 Resize movie window to half its original size.
320 Resize movie window to its original size.
322 Resize movie window to double its original size.
324 Toggle fullscreen (also see \-fs).
325 .IPs "command + [ and command + ]"
326 Set movie window alpha.
331 (The following keys are valid only when using the sdl
332 video output driver.)
338 Cycle through available fullscreen modes.
340 Restore original mode.
345 (The following keys are valid if you have a keyboard
346 with multimedia keys.)
354 Stop playing and quit.
355 .IPs "PREVIOUS and NEXT"
356 Seek backward/\:forward 1 minute.
361 (The following keys are only valid if GUI support is compiled in
362 and will take precedence over the keys defined above.)
385 (The following keys are only valid if you compiled with TV or DVB input
386 support and will take precedence over the keys defined above.)
392 Select previous/\:next channel.
401 (The following keys are only valid if you compiled with dvdnav
402 support: They are used to navigate the menus.)
418 Return to nearest menu (the order of preference is: chapter->title->root).
426 (The following keys are only valid if teletext support is enabled during
427 compilation: They are used for controlling TV teletext.)
433 Switch teletext on/\:off.
435 Go to next/\:prev teletext page.
445 .IPs "button 3 and button 4"
446 Seek backward/\:forward 1 minute.
447 .IPs "button 5 and button 6"
448 Decrease/\:increase volume.
456 .IPs "left and right"
457 Seek backward/\:forward 10 seconds.
459 Seek forward/\:backward 1 minute.
463 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
464 .IPs "button 3 and button 4"
465 Decrease/\:increase volume.
470 .\" --------------------------------------------------------------------------
472 .\" --------------------------------------------------------------------------
475 Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the
476 \-fs option is \-nofs.
478 If an option is marked as (XXX only), it will only work in combination with
479 the XXX option or if XXX is compiled in.
482 The suboption parser (used for example for \-ao pcm suboptions) supports
483 a special kind of string-escaping intended for use with external GUIs.
485 It has the following format:
487 %n%string_of_length_n
491 mplayer \-ao pcm:file=%10%C:test.wav test.avi
495 mplayer \-ao pcm:file=%`expr length "$NAME"`%"$NAME" test.avi
498 .\" --------------------------------------------------------------------------
499 .\" Configuration files
500 .\" --------------------------------------------------------------------------
502 .SH "CONFIGURATION FILES"
503 You can put all of the options in configuration files which will be read
504 every time MPlayer/MEncoder is run.
505 The system-wide configuration file 'mplayer.conf' is in your configuration
506 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user
507 specific one is '~/\:.mplayer/\:config'.
508 The configuration file for MEncoder is 'mencoder.conf' in your configuration
509 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the
510 user specific one is '~/\:.mplayer/\:mencoder.conf.
511 User specific options override system-wide options and options given on the
512 command line override either.
513 The syntax of the configuration files is 'option=<value>', everything after
514 a '#' is considered a comment.
515 Options that work without values can be enabled by setting them to 'yes'
516 or '1' or 'true' and disabled by setting them to 'no' or '0' or 'false'.
517 Even suboptions can be specified in this way.
519 You can also write file-specific configuration files.
520 If you wish to have a configuration file for a file called 'movie.avi', create a file
521 named 'movie.avi.conf' with the file-specific options in it and put it in
523 You can also put the configuration file in the same directory as the file to
524 be played, as long as you give the \-use-filedir-conf option (either on the
525 command line or in your global config file).
527 .I EXAMPLE MPLAYER CONFIGURATION FILE:
530 # Use Matrox driver by default.
532 # I love practicing handstands while watching videos.
534 # Decode/encode multiple files from PNG,
535 # start with mf://filemask
537 # Eerie negative images are cool.
541 .I "EXAMPLE MENCODER CONFIGURATION FILE:"
544 # Make MEncoder output to a default filename.
546 # The next 4 lines allow mencoder tv:// to start capturing immediately.
549 lavcopts=vcodec=mjpeg
550 tv=driver=v4l2:input=1:width=768:height=576:device=/dev/video0:audiorate=48000
551 # more complex default encoding option set
552 lavcopts=vcodec=mpeg4:autoaspect=1
556 passlogfile=pass1stats.log
566 .\" --------------------------------------------------------------------------
568 .\" --------------------------------------------------------------------------
571 To ease working with different configurations profiles can be defined in the
573 A profile starts with its name between square brackets, e.g.\& '[my-profile]'.
574 All following options will be part of the profile.
575 A description (shown by \-profile help) can be defined with the profile-desc
577 To end the profile, start another one or use the profile name 'default'
578 to continue with normal options.
581 .I "EXAMPLE MENCODER PROFILE:"
586 profile-desc="MPEG4 encoding"
588 lavcopts=vcodec=mpeg4:vbitrate=1200
591 profile-desc="HQ MPEG4 encoding"
593 lavcopts=mbd=2:trell=yes:v4mv=yes
596 .\" --------------------------------------------------------------------------
598 .\" --------------------------------------------------------------------------
600 .SH "GENERAL OPTIONS"
603 .B \-codecs-file <filename> (also see \-afm, \-ac, \-vfm, \-vc)
604 Override the standard search path and use the specified file
605 instead of the builtin codecs.conf.
608 .B \-include <configuration file>
609 Specify configuration file to be parsed after the default ones.
613 Prints all available options.
616 .B \-msgcharset <charset>
617 Convert console messages to the specified character set (default: autodetect).
618 Text will be in the encoding specified with the \-\-charset configure option.
619 Set this to "noconv" to disable conversion (for e.g.\& iconv problems).
622 The option takes effect after command line parsing has finished.
623 The MPLAYER_CHARSET environment variable can help you get rid of
624 the first lines of garbled output.
627 .B \-msglevel <all=<level>:<module>=<level>:...>
628 Control verbosity directly for each module.
629 The 'all' module changes the verbosity of all the modules not
630 explicitly specified on the command line.
631 See '\-msglevel help' for a list of all modules.
634 Some messages are printed before the command line is parsed and are
635 therefore not affected by \-msglevel.
636 To control these messages you have to use the MPLAYER_VERBOSE environment
637 variable, see its description below for details.
653 informational messages
655 status messages (default)
669 Make console output less verbose; in particular, prevents the status line
670 (i.e.\& A: 0.7 V: 0.6 A-V: 0.068 ...) from being displayed.
671 Particularly useful on slow terminals or broken ones which do not properly
672 handle carriage return (i.e.\& \\r).
675 .B \-priority <prio> (Windows only)
676 Set process priority for MPlayer according to the predefined
677 priorities available under Windows.
678 Possible values of <prio>:
680 idle|belownormal|normal|abovenormal|high|realtime
685 Using realtime priority can cause system lockup.
689 .B \-profile <profile1,profile2,...>
690 Use the given profile(s), \-profile help displays a list of the defined profiles.
693 .B \-really-quiet (also see \-quiet)
694 Display even less output and status messages than with \-quiet.
695 Also suppresses the GUI error message boxes.
698 .B \-show-profile <profile>
699 Show the description and content of a profile.
702 .B \-use-filedir-conf
703 Look for a file-specific configuration file in the same directory as
704 the file that is being played.
707 May be dangerous if playing from untrusted media.
711 Increment verbosity level, one level for each \-v
712 found on the command line.
716 .SH "PLAYER OPTIONS (MPLAYER ONLY)"
719 .B \-autoq <quality> (use with \-vf [s]pp)
720 Dynamically changes the level of postprocessing depending on the available spare
722 The number you specify will be the maximum level used.
723 Usually you can use some big number.
724 You have to use \-vf [s]pp without parameters in order for this to work.
727 .B \-autosync <factor>
728 Gradually adjusts the A/V sync based on audio delay measurements.
729 Specifying \-autosync 0, the default, will cause frame timing to be based
730 entirely on audio delay measurements.
731 Specifying \-autosync 1 will do the same, but will subtly change the A/V
732 correction algorithm.
733 An uneven video framerate in a movie which plays fine with \-nosound can
734 often be helped by setting this to an integer value greater than 1.
735 The higher the value, the closer the timing will be to \-nosound.
736 Try \-autosync 30 to smooth out problems with sound drivers which do
737 not implement a perfect audio delay measurement.
738 With this value, if large A/V sync offsets occur, they will only take about
739 1 or 2 seconds to settle out.
740 This delay in reaction time to sudden A/V offsets should be the only
741 side-effect of turning this option on, for all sound drivers.
745 Prints some statistics on CPU usage and dropped frames at the end of playback.
746 Use in combination with \-nosound and \-vo null for benchmarking only the
750 With this option MPlayer will also ignore frame duration when playing
751 only video (you can think of that as infinite fps).
754 .B \-colorkey <number>
755 Changes the colorkey to an RGB value of your choice.
756 0x000000 is black and 0xffffff is white.
757 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
758 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
763 Disables colorkeying.
764 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
765 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
769 .B \-correct-pts (experimental)
770 Switches MPlayer to an experimental mode where timestamps for video frames
771 are calculated differently and video filters which add new frames or
772 modify timestamps of existing ones are supported.
773 The more accurate timestamps can be visible for example when playing
774 subtitles timed to scene changes with the \-ass option.
775 Without \-correct-pts the subtitle timing will typically be off by some frames.
776 This option does not work correctly with some demuxers and codecs.
779 .B \-crash-debug (DEBUG CODE)
780 Automatically attaches gdb upon crash or SIGTRAP.
781 Support must be compiled in by configuring with \-\-enable-crash-debug.
784 .B \-doubleclick-time
785 Time in milliseconds to recognize two consecutive button presses as
786 a double-click (default: 300).
787 Set to 0 to let your windowing system decide what a double-click is
791 You will get slightly different behaviour depending on whether you bind
792 MOUSE_BTN0_DBL or MOUSE_BTN0\-MOUSE_BTN0_DBL.
795 .B \-edlout <filename>
796 Creates a new file and writes edit decision list (EDL) records to it.
797 During playback, the user hits 'i' to mark the start or end of a skip block.
798 This provides a starting point from which the user can fine-tune EDL entries
800 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details.
803 .B \-enqueue (GUI only)
804 Enqueue files given on the command line in the playlist instead of playing them
809 Enforces a fixed video system for multiple files (one (un)initialization for
811 Therefore only one window will be opened for all files.
812 Currently the following drivers are fixed-vo compliant: gl, gl2, mga, svga, x11,
813 xmga, xv, xvidix and dfbmga.
816 .B \-framedrop (also see \-hardframedrop)
817 Skip displaying some frames to maintain A/V sync on slow systems.
818 Video filters are not applied to such frames.
819 For B-frames even decoding is skipped completely.
823 Enable or disable the GUI interface (default depends on binary name).
824 Only works as the first argument on the command line.
825 Does not work as a config-file option.
828 .B \-h, \-help, \-\-help
829 Show short summary of options.
833 More intense frame dropping (breaks decoding).
834 Leads to image distortion!
838 Shorthand for \-msglevel identify=4.
839 Show file parameters in an easily parseable format.
840 Also prints more detailed information about subtitle and audio
841 track languages and IDs.
842 In some cases you can get more information by using \-msglevel identify=6.
843 For example, for a DVD it will list the time length of each title, as well
845 The wrapper script TOOLS/\:midentify suppresses the other MPlayer output and
846 (hopefully) shellescapes the filenames.
849 .B \-idle (also see \-slave)
850 Makes MPlayer wait idly instead of quitting when there is no file to play.
851 Mostly useful in slave mode where MPlayer can be controlled
852 through input commands.
855 .B \-input <commands>
856 This option can be used to configure certain parts of the input system.
857 Paths are relative to ~/.mplayer/.
860 Autorepeat is currently only supported by joysticks.
862 Available commands are:
867 Specify input configuration file other than the default
868 ~/\:.mplayer/\:input.conf.
869 ~/\:.mplayer/\:<filename> is assumed if no full path is given.
871 Delay in milliseconds before we start to autorepeat a key (0 to disable).
873 Number of key presses to generate per second on autorepeat.
875 Prints all keys that can be bound to commands.
877 Prints all commands that can be bound to keys.
879 Specifies the joystick device to use (default: /dev/\:input/\:js0).
881 Read commands from the given file.
882 Mostly useful with a FIFO.
885 When the given file is a FIFO MPlayer opens both ends so you can do
886 several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
891 .B \-key-fifo-size <2\-65000>
892 Specify the size of the FIFO that buffers key events (default: 7).
893 A FIFO of size n can buffer (n-1) events.
894 If it is too small some events may be lost
895 (leading to "stuck mouse buttons" and similar effects).
896 If it is too big, MPlayer may seem to hang while it
897 processes the buffered events.
898 To get the same behavior as before this option was introduced,
899 set it to 2 for Linux or 1024 for Windows.
902 .B \-lircconf <filename> (LIRC only)
903 Specifies a configuration file for LIRC (default: ~/.lircrc).
907 Print a list of the available properties.
911 Loops movie playback <number> times.
915 .B \-menu (OSD menu only)
916 Turn on OSD menu support.
919 .B \-menu-cfg <filename> (OSD menu only)
920 Use an alternative menu.conf.
923 .B \-menu-chroot <path> (OSD menu only)
924 Chroot the file selection menu to a specific location.
929 .IPs "\-menu-chroot=/home"
930 Will restrict the file selection menu to /\:home and downward (i.e.\& no
931 access to / will be possible, but /home/user_name will).
936 .B \-menu-keepdir (OSD menu only)
937 File browser starts from the last known location instead of current directory.
940 .B \-menu-root <value> (OSD menu only)
941 Specify the main menu.
944 .B \-menu-startup (OSD menu only)
945 Display the main menu at MPlayer startup.
949 Permit MPlayer to receive pointer events reported by the video
950 output driver (currently only derivatives of X11 are supported).
951 Necessary to select the buttons in DVD menus.
954 .B \-noconsolecontrols
955 Prevent MPlayer from reading key events from standard input.
956 Useful when reading data from standard input.
957 This is automatically enabled when \- is found on the command line.
958 There are situations where you have to set it manually, e.g.\&
959 if you open /dev/\:stdin (or the equivalent on your system), use stdin
960 in a playlist or intend to read from stdin later on via the loadfile or
961 loadlist slave commands.
965 Turns off joystick support.
969 Turns off LIRC support.
973 Disable mouse button press/\:release input (mozplayerxp's context menu relies
978 Turns on usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
980 This wakes up the process every 1/1024 seconds to check the current time.
981 Useless with modern Linux kernels configured for desktop use as they already
982 wake up the process with similar accuracy when using normal timed sleep.
985 .B \-playing-msg <string>
986 Print out a string before starting playback.
987 The following expansions are supported:
990 Expand to the value of the property NAME.
992 Expand TEXT only if the property NAME is available.
996 .B \-playlist <filename>
997 Play files according to a playlist file (ASX, Winamp, SMIL, or
998 one-file-per-line format).
1001 This option is considered an entry so options found after it will apply
1002 only to the elements of this playlist.
1004 FIXME: This needs to be clarified and documented thoroughly.
1007 .B \-rtc-device <device>
1008 Use the specified device for RTC timing.
1012 Play files in random order.
1015 .B \-skin <name> (GUI only)
1016 Loads a skin from the directory given as parameter below the default skin
1017 directories, /usr/\:local/\:share/\:mplayer/\:skins/\: and ~/.mplayer/\:skins/.
1022 .IPs "\-skin fittyfene"
1023 Tries /usr/\:local/\:share/\:mplayer/\:skins/\:fittyfene
1024 and afterwards ~/.mplayer/\:skins/\:fittyfene.
1029 .B \-slave (also see \-input)
1030 Switches on slave mode, in which MPlayer works as a backend for other programs.
1031 Instead of intercepting keyboard events, MPlayer will read commands separated
1032 by a newline (\\n) from stdin.
1035 See \-input cmdlist for a list of slave commands and DOCS/tech/slave.txt
1036 for their description.
1040 Time frames by repeatedly checking the current time instead of asking the
1041 kernel to wake up MPlayer at the correct time.
1042 Useful if your kernel timing is imprecise and you cannot use the RTC either.
1043 Comes at the price of higher CPU consumption.
1047 Skip <sec> seconds after every frame.
1048 The normal framerate of the movie is kept, so playback is accelerated.
1049 Since MPlayer can only seek to the next keyframe this may be inexact.
1053 .SH "DEMUXER/STREAM OPTIONS"
1057 Select the Dynamic Range Compression level for AC-3 audio streams.
1058 <level> is a float value ranging from 0 to 1, where 0 means no compression
1059 and 1 (which is the default) means full compression (make loud passages more
1060 silent and vice versa).
1061 This option only shows an effect if the AC-3 stream contains the required range
1062 compression information.
1065 .B \-aid <ID> (also see \-alang)
1066 Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
1067 VOB(AC-3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
1068 MPlayer prints the available audio IDs when run in verbose (\-v) mode.
1069 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1070 (if present) with the chosen audio stream.
1073 .B \-alang <language code[,language code,...]> (also see \-aid)
1074 Specify a priority list of audio languages to use.
1075 Different container formats employ different language codes.
1076 DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT
1077 use ISO 639-2 three letter language codes while OGM uses a free-form identifier.
1078 MPlayer prints the available languages when run in verbose (\-v) mode.
1083 .IPs "mplayer dvd://1 \-alang hu,en"
1084 Chooses the Hungarian language track on a DVD and falls back on English if
1085 Hungarian is not available.
1086 .IPs "mplayer \-alang jpn example.mkv"
1087 Plays a Matroska file in Japanese.
1092 .B \-audio-demuxer <[+]name> (\-audiofile only)
1093 Force audio demuxer type for \-audiofile.
1094 Use a '+' before the name to force it, this will skip some checks!
1095 Give the demuxer name as printed by \-audio-demuxer help.
1096 For backward compatibility it also accepts the demuxer ID as defined in
1097 libmpdemux/\:demuxer.h.
1098 \-audio-demuxer audio or \-audio-demuxer 17 forces MP3.
1101 .B \-audiofile <filename>
1102 Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
1106 .B \-audiofile-cache <kBytes>
1107 Enables caching for the stream used by \-audiofile, using the specified
1111 .B \-reuse-socket (udp:// only)
1112 Allows a socket to be reused by other processes as soon as it is closed.
1115 .B \-bandwidth <value> (network only)
1116 Specify the maximum bandwidth for network streaming (for servers that are
1117 able to send content in different bitrates).
1118 Useful if you want to watch live streamed media behind a slow connection.
1119 With Real RTSP streaming, it is also used to set the maximum delivery
1120 bandwidth allowing faster cache filling and stream dumping.
1124 This option specifies how much memory (in kBytes) to use when precaching a
1126 Especially useful on slow media.
1133 .B \-cache-min <percentage>
1134 Playback will start when the cache has been filled up to <percentage>
1138 .B \-cache-seek-min <percentage>
1139 If a seek is to be made to a position within <percentage> of the cache size
1140 from the current position, MPlayer will wait for the cache to be filled to
1141 this position rather than performing a stream seek (default: 50).
1144 .B \-cdda <option1:option2> (CDDA only)
1145 This option can be used to tune the CD Audio reading feature of MPlayer.
1147 Available options are:
1151 .IPs paranoia=<0\-2>
1153 Values other than 0 seem to break playback of anything but the first track.
1155 0: disable checking (default)
1157 1: overlap checking only
1159 2: full data correction and verification
1161 .IPs generic-dev=<value>
1162 Use specified generic SCSI device.
1163 .IPs sector-size=<value>
1164 Set atomic read size.
1165 .IPs overlap=<value>
1166 Force minimum overlap search during verification to <value> sectors.
1168 Assume that the beginning offset of track 1 as reported in the TOC will be
1170 Some Toshiba drives need this for getting track boundaries correct.
1171 .IPs toc-offset=<value>
1172 Add <value> sectors to the values reported when addressing tracks.
1175 (Never) accept imperfect data reconstruction.
1179 .B \-cdrom-device <path to device>
1180 Specify the CD-ROM device (default: /dev/\:cdrom).
1183 .B \-channels <number> (also see \-af channels)
1184 Request the number of playback channels (default: 2).
1185 MPlayer asks the decoder to decode the audio into as many channels as
1187 Then it is up to the decoder to fulfill the requirement.
1188 This is usually only important when playing videos with AC-3 audio (like DVDs).
1189 In that case liba52 does the decoding by default and correctly downmixes the
1190 audio into the requested number of channels.
1191 To directly control the number of output channels independently of how many
1192 channels are decoded, use the channels filter.
1195 This option is honored by codecs (AC-3 only), filters (surround) and audio
1196 output drivers (OSS at least).
1198 Available options are:
1212 .B \-chapter <chapter ID>[\-<endchapter ID>] (dvd:// and dvdnav:// only)
1213 Specify which chapter to start playing at.
1214 Optionally specify which chapter to end playing at (default: 1).
1217 .B \-cookies (network only)
1218 Send cookies when making HTTP requests.
1221 .B \-cookies-file <filename> (network only)
1222 Read HTTP cookies from <filename> (default: ~/.mozilla/ and ~/.netscape/)
1223 and skip reading from default locations.
1224 The file is assumed to be in Netscape format.
1228 audio delay in seconds (positive or negative float value)
1230 Negative values delay the audio, and positive values delay the video.
1231 Note that this is the exact opposite of the \-audio-delay MEncoder option.
1234 When used with MEncoder, this is not guaranteed to work correctly
1235 with \-ovc copy; use \-audio-delay instead.
1239 Ignore the specified starting time for streams in AVI files.
1240 In MPlayer, this nullifies stream delays in files encoded with
1241 the \-audio-delay option.
1242 During encoding, this option prevents MEncoder from transferring
1243 original stream start times to the new file; the \-audio-delay option is
1245 Note that MEncoder sometimes adjusts stream starting times
1246 automatically to compensate for anticipated decoding delays, so do not
1247 use this option for encoding without testing it first.
1250 .B \-demuxer <[+]name>
1252 Use a '+' before the name to force it, this will skip some checks!
1253 Give the demuxer name as printed by \-demuxer help.
1254 For backward compatibility it also accepts the demuxer ID as defined in
1255 libmpdemux/\:demuxer.h.
1258 .B \-dumpaudio (MPlayer only)
1259 Dumps raw compressed audio stream to ./stream.dump (useful with MPEG/\:AC-3,
1260 in most other cases the resulting file will not be playable).
1261 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1262 on the command line only the last one will work.
1265 .B \-dumpfile <filename> (MPlayer only)
1266 Specify which file MPlayer should dump to.
1267 Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream.
1270 .B \-dumpstream (MPlayer only)
1271 Dumps the raw stream to ./stream.dump.
1272 Useful when ripping from DVD or network.
1273 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1274 on the command line only the last one will work.
1277 .B \-dumpvideo (MPlayer only)
1278 Dump raw compressed video stream to ./stream.dump (not very usable).
1279 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1280 on the command line only the last one will work.
1283 .B \-dvbin <options> (DVB only)
1284 Pass the following parameters to the DVB input module, in order to override
1290 Specifies using card number 1\-4 (default: 1).
1291 .IPs file=<filename>
1292 Instructs MPlayer to read the channels list from <filename>.
1293 Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl,atsc} (based on your card type)
1294 or ~/.mplayer/\:channels.conf as a last resort.
1295 .IPs timeout=<1\-30>
1296 Maximum number of seconds to wait when trying to tune a
1297 frequency before giving up (default: 30).
1302 .B \-dvd-device <path to device> (DVD only)
1303 Specify the DVD device (default: /dev/\:dvd).
1304 You can also specify a directory that contains files previously copied directly
1305 from a DVD (with e.g.\& vobcopy).
1306 Note that using \-dumpstream is usually a better way to
1307 copy DVD titles in the first place (see the examples).
1310 .B \-dvd-speed <factor or speed in KB/s> (DVD only)
1311 Try to limit DVD speed (default: 0, no change).
1312 DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to
1314 Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be
1315 quiet and fast enough.
1316 MPlayer resets the speed to the drive default value on close.
1317 Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd-speed 8 selects
1321 You need write access to the DVD device to change the speed.
1324 .B \-dvdangle <angle ID> (DVD only)
1325 Some DVD discs contain scenes that can be viewed from multiple angles.
1326 Here you can tell MPlayer which angles to use (default: 1).
1330 Enables edit decision list (EDL) actions during playback.
1331 Video will be skipped over and audio will be muted and unmuted according to
1332 the entries in the given file.
1333 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details
1337 .B \-endpos <[[hh:]mm:]ss[.ms]|size[b|kb|mb]> (also see \-ss and \-sb)
1338 Stop at given time or byte position.
1341 Byte position is enabled only for MEncoder and will not be accurate, as it can
1342 only stop at a frame boundary.
1343 When used in conjunction with \-ss option, \-endpos time will shift forward by
1344 seconds specified with \-ss.
1351 .IPs "\-endpos 01:10:00"
1352 Stop at 1 hour 10 minutes.
1353 .IPs "\-ss 10 \-endpos 56"
1354 Stop at 1 minute 6 seconds.
1355 .IPs "\-endpos 100mb"
1362 Force index rebuilding.
1363 Useful for files with broken index (A/V desync, etc).
1364 This will enable seeking in files where seeking was not possible.
1365 You can fix the index permanently with MEncoder (see the documentation).
1368 This option only works if the underlying media supports seeking
1369 (i.e.\& not with stdin, pipe, etc).
1372 .B \-fps <float value>
1373 Override video framerate.
1374 Useful if the original value is wrong or missing.
1377 .B \-frames <number>
1378 Play/\:convert only first <number> frames, then quit.
1381 .B \-hr-mp3-seek (MP3 only)
1383 Enabled when playing from an external MP3 file, as we need to seek
1384 to the very exact position to keep A/V sync.
1385 Can be slow especially when seeking backwards since it has to rewind
1386 to the beginning to find an exact frame position.
1389 .B \-idx (also see \-forceidx)
1390 Rebuilds index of files if no index was found, allowing seeking.
1391 Useful with broken/\:incomplete downloads, or badly created files.
1394 This option only works if the underlying media supports seeking
1395 (i.e.\& not with stdin, pipe, etc).
1399 Skip rebuilding index file.
1400 MEncoder skips writing the index with this option.
1403 .B \-ipv4-only-proxy (network only)
1404 Skip the proxy for IPv6 addresses.
1405 It will still be used for IPv4 connections.
1408 .B \-loadidx <index file>
1409 The file from which to read the video index data saved by \-saveidx.
1410 This index will be used for seeking, overriding any index data
1411 contained in the AVI itself.
1412 MPlayer will not prevent you from loading an index file generated
1413 from a different AVI, but this is sure to cause unfavorable results.
1416 This option is obsolete now that MPlayer has OpenDML support.
1419 .B \-mc <seconds/frame>
1420 maximum A-V sync correction per frame (in seconds)
1423 .B \-mf <option1:option2:...>
1424 Used when decoding from multiple PNG or JPEG files.
1426 Available options are:
1431 input file width (default: autodetect)
1433 input file height (default: autodetect)
1435 output fps (default: 25)
1437 input file type (available: jpeg, png, tga, sgi)
1443 Force usage of non-interleaved AVI parser (fixes playback
1444 of some bad AVI files).
1447 .B \-nobps (AVI only)
1448 Do not use average byte/\:second value for A-V sync.
1449 Helps with some AVI files with broken header.
1453 Disables extension-based demuxer selection.
1454 By default, when the file type (demuxer) cannot be detected reliably
1455 (the file has no header or it is not reliable enough), the filename
1456 extension is used to select the demuxer.
1457 Always falls back on content-based demuxer selection.
1460 .B \-passwd <password> (also see \-user) (network only)
1461 Specify password for HTTP authentication.
1464 .B \-prefer-ipv4 (network only)
1465 Use IPv4 on network connections.
1466 Falls back on IPv6 automatically.
1469 .B \-prefer-ipv6 (IPv6 network only)
1470 Use IPv6 on network connections.
1471 Falls back on IPv4 automatically.
1474 .B \-psprobe <byte position>
1475 When playing an MPEG-PS stream, this option lets you specify how many
1476 bytes in the stream you want MPlayer to scan in order to identify the
1478 This option is needed to play EVO files containing H.264 streams.
1481 .B \-pvr <option1:option2:...> (PVR only)
1482 This option tunes various encoding properties of the PVR capture module.
1483 It has to be used with any hardware MPEG encoder based card supported by the
1485 The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV based
1486 cards are known as PVR capture cards.
1487 Be aware that only Linux 2.6.18 kernel
1488 and above is able to handle MPEG stream through V4L2 layer.
1489 For hardware capture of an MPEG stream and watching it with
1490 MPlayer/MEncoder, use 'pvr://' as a movie URL.
1492 Available options are:
1495 Specify input aspect ratio:
1505 .IPs arate=<32000\-48000>
1506 Specify encoding audio rate (default: 48000 Hz, available: 32000, 44100
1509 Specify MPEG audio layer encoding (default: 2).
1510 .IPs abitrate=<32\-448>
1511 Specify audio encoding bitrate in kbps (default: 384).
1513 Specify audio encoding mode.
1514 Available preset values are 'stereo', 'joint_stereo', 'dual' and 'mono' (default: stereo).
1515 .IPs vbitrate=<value>
1516 Specify average video bitrate encoding in Mbps (default: 6).
1518 Specify video encoding mode:
1520 vbr: Variable BitRate (default)
1522 cbr: Constant BitRate
1525 Specify peak video bitrate encoding in Mbps
1526 (only useful for VBR encoding, default: 9.6).
1528 Choose an MPEG format for encoding:
1530 ps: MPEG-2 Program Stream (default)
1532 ts: MPEG-2 Transport Stream
1534 mpeg1: MPEG-1 System Stream
1536 vcd: Video CD compatible stream
1538 svcd: Super Video CD compatible stream
1540 dvd: DVD compatible stream
1546 .B \-radio <option1:option2:...> (radio only)
1547 These options set various parameters of the radio capture module.
1548 For listening to radio with MPlayer use 'radio://<frequency>'
1549 (if channels option is not given) or 'radio://<channel_number>'
1550 (if channels option is given) as a movie URL.
1551 You can see allowed frequency range by running MPlayer with '\-v'.
1552 To start the grabbing subsystem, use 'radio://<frequency or channel>/capture'.
1553 If the capture keyword is not given you can listen to radio
1554 using the line-in cable only.
1555 Using capture to listen is not recommended due to synchronization
1556 problems, which makes this process uncomfortable.
1558 Available options are:
1561 Radio device to use (default: /dev/radio0 for Linux and /dev/tuner0 for *BSD).
1563 Radio driver to use (default: v4l2 if available, otherwise v4l).
1564 Currently, v4l and v4l2 drivers are supported.
1565 .IPs volume=<0..100>
1566 sound volume for radio device (default 100)
1567 .IPs "freq_min=<value> (*BSD BT848 only)"
1568 minimum allowed frequency (default: 87.50)
1569 .IPs "freq_max=<value> (*BSD BT848 only)"
1570 maximum allowed frequency (default: 108.00)
1571 .IPs channels=<frequency>\-<name>,<frequency>\-<name>,...
1573 Use _ for spaces in names (or play with quoting ;-).
1574 The channel names will then be written using OSD and the slave commands
1575 radio_step_channel and radio_set_channel will be usable for
1576 a remote control (see LIRC).
1577 If given, number in movie URL will be treated as channel position in
1581 radio://1, radio://104.4, radio_set_channel 1
1582 .IPs "adevice=<value> (radio capture only)"
1583 Name of device to capture sound from.
1584 Without such a name capture will be disabled,
1585 even if the capture keyword appears in the URL.
1586 For ALSA devices use it in the form hw=<card>.<device>.
1587 If the device name contains a '=', the module will use
1588 ALSA to capture, otherwise OSS.
1589 .IPs "arate=<value> (radio capture only)"
1590 Rate in samples per second (default: 44100).
1593 When using audio capture set also \-rawaudio rate=<value> option
1594 with the same value as arate.
1595 If you have problems with sound speed (runs too quickly), try to play
1596 with different rate values (e.g.\& 48000,44100,32000,...).
1597 .IPs "achannels=<value> (radio capture only)"
1598 Number of audio channels to capture.
1602 .B \-rawaudio <option1:option2:...>
1603 This option lets you play raw audio files.
1604 You have to use \-demuxer rawaudio as well.
1605 It may also be used to play audio CDs which are not 44kHz 16-bit stereo.
1606 For playing raw AC-3 streams use \-rawaudio format=0x2000 \-demuxer rawaudio.
1608 Available options are:
1612 .IPs channels=<value>
1615 rate in samples per second
1616 .IPs samplesize=<value>
1617 sample size in bytes
1618 .IPs bitrate=<value>
1619 bitrate for rawaudio files
1626 .B \-rawvideo <option1:option2:...>
1627 This option lets you play raw video files.
1628 You have to use \-demuxer rawvideo as well.
1630 Available options are:
1635 rate in frames per second (default: 25.0)
1636 .IPs sqcif|qcif|cif|4cif|pal|ntsc
1637 set standard image size
1639 image width in pixels
1641 image height in pixels
1642 .IPs i420|yv12|yuy2|y8
1645 colorspace (fourcc) in hex or string constant.
1646 Use \-rawvideo format=help for a list of possible strings.
1656 .IPs "mplayer foreman.qcif -demuxer rawvideo -rawvideo qcif"
1657 Play the famous "foreman" sample video.
1658 .IPs "mplayer sample-720x576.yuv -demuxer rawvideo -rawvideo w=720:h=576"
1659 Play a raw YUV sample.
1665 Used with 'rtsp://' URLs to force the client's port number.
1666 This option may be useful if you are behind a router and want to forward
1667 the RTSP stream from the server to a specific client.
1670 .B \-rtsp-destination
1671 Used with 'rtsp://' URLs to force the destination IP address to be bound.
1672 This option may be useful with some RTSP server which do not
1673 send RTP packets to the right interface.
1674 If the connection to the RTSP server fails, use \-v to see
1675 which IP address MPlayer tries to bind to and try to force
1676 it to one assigned to your computer instead.
1679 .B \-rtsp-stream-over-tcp (LIVE555 and NEMESI only)
1680 Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP
1681 packets be streamed over TCP (using the same TCP connection as RTSP).
1682 This option may be useful if you have a broken internet connection that does
1683 not pass incoming UDP packets (see http://www.live555.com/\:mplayer/).
1686 .B \-saveidx <filename>
1687 Force index rebuilding and dump the index to <filename>.
1688 Currently this only works with AVI files.
1691 This option is obsolete now that MPlayer has OpenDML support.
1694 .B \-sb <byte position> (also see \-ss)
1695 Seek to byte position.
1696 Useful for playback from CD-ROM images or VOB files with junk at the beginning.
1699 .B \-speed <0.01\-100>
1700 Slow down or speed up playback by the factor given as parameter.
1701 Not guaranteed to work correctly with \-oac copy.
1705 Selects the output sample rate to be used
1706 (of course sound cards have limits on this).
1707 If the sample frequency selected is different from that
1708 of the current media, the resample or lavcresample audio filter will be inserted
1709 into the audio filter layer to compensate for the difference.
1710 The type of resampling can be controlled by the \-af-adv option.
1711 The default is fast resampling that may cause distortion.
1714 .B \-ss <time> (also see \-sb)
1715 Seek to given time position.
1721 Seeks to 56 seconds.
1722 .IPs "\-ss 01:10:00"
1723 Seeks to 1 hour 10 min.
1729 Tells MPlayer not to discard TS packets reported as broken in the stream.
1730 Sometimes needed to play corrupted MPEG-TS files.
1733 .B \-tsprobe <byte position>
1734 When playing an MPEG-TS stream, this option lets you specify how many
1735 bytes in the stream you want MPlayer to search for the desired
1736 audio and video IDs.
1739 .B \-tsprog <1\-65534>
1740 When playing an MPEG-TS stream, you can specify with this option which
1741 program (if present) you want to play.
1742 Can be used with \-vid and \-aid.
1745 .B \-tv <option1:option2:...> (TV/\:PVR only)
1746 This option tunes various properties of the TV capture module.
1747 For watching TV with MPlayer, use 'tv://' or 'tv://<channel_number>'
1748 or even 'tv://<channel_name> (see option channels for channel_name below)
1750 You can also use 'tv:///<input_id>' to start watching a
1751 movie from a composite or S-Video input (see option input for details).
1753 Available options are:
1757 .IPs "automute=<0-255> (v4l and v4l2 only)"
1758 If signal strength reported by device is less than this value,
1759 audio and video will be muted.
1760 In most cases automute=100 will be enough.
1761 Default is 0 (automute disabled).
1763 See \-tv driver=help for a list of compiled-in TV input drivers.
1764 available: dummy, v4l, v4l2, bsdbt848 (default: autodetect)
1766 Specify TV device (default: /dev/\:video0).
1768 For the bsdbt848 driver you can provide both bktr and tuner device
1769 names separating them with a comma, tuner after
1770 bktr (e.g.\& -tv device=/dev/bktr1,/dev/tuner1).
1772 Specify input (default: 0 (TV), see console output for available inputs).
1774 Specify the frequency to set the tuner to (e.g.\& 511.250).
1775 Not compatible with the channels parameter.
1777 Specify the output format of the tuner with a preset value supported by the
1778 V4L driver (yv12, rgb32, rgb24, rgb16, rgb15, uyvy, yuy2, i420) or an
1779 arbitrary format given as hex value.
1780 Try outfmt=help for a list of all available formats.
1784 output window height
1786 framerate at which to capture video (frames per second)
1787 .IPs buffersize=<value>
1788 maximum size of the capture buffer in megabytes (default: dynamical)
1790 For bsdbt848 and v4l, PAL, SECAM, NTSC are available.
1791 For v4l2, see the console output for a list of all available norms,
1792 also see the normid option below.
1793 .IPs "normid=<value> (v4l2 only)"
1794 Sets the TV norm to the given numeric ID.
1795 The TV norm depends on the capture card.
1796 See the console output for a list of available TV norms.
1797 .IPs channel=<value>
1798 Set tuner to <value> channel.
1799 .IPs chanlist=<value>
1800 available: europe-east, europe-west, us-bcast, us-cable, etc
1801 .IPs channels=<channel>\-<name>,<channel>\-<name>,...
1802 Set names for channels.
1804 If <channel> is an integer greater than 1000, it will be treated as frequency (in kHz)
1805 rather than channel name from frequency table.
1807 Use _ for spaces in names (or play with quoting ;-).
1808 The channel names will then be written using OSD, and the slave commands
1809 tv_step_channel, tv_set_channel and tv_last_channel will be usable for
1810 a remote control (see LIRC).
1811 Not compatible with the frequency parameter.
1814 The channel number will then be the position in the 'channels' list,
1818 tv://1, tv://TV1, tv_set_channel 1, tv_set_channel TV1
1819 .IPs [brightness|contrast|hue|saturation]=<-100\-100>
1820 Set the image equalizer on the card.
1821 .IPs audiorate=<value>
1822 Set audio capture bitrate.
1824 Capture audio even if there are no audio sources reported by v4l.
1828 Choose an audio mode:
1838 .IPs forcechan=<1\-2>
1839 By default, the count of recorded audio channels is determined automatically
1840 by querying the audio mode from the TV card.
1841 This option allows forcing stereo/\:mono recording regardless of the amode
1842 option and the values returned by v4l.
1843 This can be used for troubleshooting when the TV card is unable to report the
1845 .IPs adevice=<value>
1846 Set an audio device.
1847 <value> should be /dev/\:xxx for OSS and a hardware ID for ALSA.
1848 You must replace any ':' by a '.' in the hardware ID for ALSA.
1849 .IPs audioid=<value>
1850 Choose an audio output of the capture card, if it has more than one.
1851 .IPs "[volume|bass|treble|balance]=<0\-65535> (v4l1)"
1852 .IPs "[volume|bass|treble|balance]=<0\-100> (v4l2)"
1853 These options set parameters of the mixer on the video capture card.
1854 They will have no effect, if your card does not have one.
1855 For v4l2 50 maps to the default value of the
1856 control, as reported by the driver.
1857 .IPs "gain=<0\-100> (v4l2)"
1858 Set gain control for video devices (usually webcams) to the desired
1859 value and switch off automatic control.
1860 A value of 0 enables automatic control.
1861 If this option is omitted, gain control will not be modified.
1862 .IPs immediatemode=<bool>
1863 A value of 0 means capture and buffer audio and video together
1864 (default for MEncoder).
1865 A value of 1 (default for MPlayer) means to do video capture only and let the
1866 audio go through a loopback cable from the TV card to the sound card.
1868 Use hardware MJPEG compression (if the card supports it).
1869 When using this option, you do not need to specify the width and height
1870 of the output window, because MPlayer will determine it automatically
1871 from the decimation value (see below).
1872 .IPs decimation=<1|2|4>
1873 choose the size of the picture that will be compressed by hardware
1888 .IPs quality=<0\-100>
1889 Choose the quality of the JPEG compression
1890 (< 60 recommended for full size).
1891 .IPs tdevice=<value>
1892 Specify TV teletext device (example: /dev/\:vbi0) (default: none).
1893 .IPs tformat=<format>
1894 Specify TV teletext display format (default: 0):
1900 2: opaque with inverted colors
1902 3: transparent with inverted colors
1904 .IPs tpage=<100-899>
1905 Specify initial TV teletext page number (default: 100).
1906 .IPs tlang=<\-1\-127>
1907 Specify default teletext language code (default: 0), which will be used
1908 as primary language until a type 28 packet is received.
1909 Useful when the teletext system uses a non-latin character set, but language
1910 codes are not transmitted via teletext type 28 packets for some reason.
1911 To see a list of supported language codes set this option to \-1.
1915 .B \-tvscan <option1:option2:...> (TV and MPlayer only)
1916 Tune the TV channel scanner.
1917 MPlayer will also print value for "-tv channels=" option,
1918 including existing and just found channels.
1920 Available suboptions are:
1923 Begin channel scanning immediately after startup (default: disabled).
1924 .IPs period=<0.1-2.0>
1925 Specify delay in seconds before switching to next channel (default: 0.5).
1926 Lower values will cause faster scanning, but can detect
1927 inactive TV channels as active.
1928 .IPs threshold=<1-100>
1929 Threshold value for the signal strength (in percent), as reported
1930 by the device (default: 50).
1931 A signal strength higher than this value will indicate that the
1932 currently scanning channel is active.
1936 .B \-user <username> (also see \-passwd) (network only)
1937 Specify username for HTTP authentication.
1940 .B \-user-agent <string>
1941 Use <string> as user agent for HTTP streaming.
1945 Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
1946 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1947 (if present) with the chosen video stream.
1950 .B \-vivo <suboption> (DEBUG CODE)
1951 Force audio parameters for the VIVO demuxer (for debugging purposes).
1952 FIXME: Document this.
1956 .SH "OSD/SUBTITLE OPTIONS"
1958 Also see \-vf expand.
1961 .B \-ass (FreeType only)
1962 Turn on SSA/ASS subtitle rendering.
1963 With this option, libass will be used for SSA/ASS
1964 external subtitles and Matroska tracks.
1965 You may also want to use \-embeddedfonts.
1968 .B \-ass-border-color <value>
1969 Sets the border (outline) color for text subtitles.
1970 The color format is RRGGBBAA.
1973 .B \-ass-bottom-margin <value>
1974 Adds a black band at the bottom of the frame.
1975 The SSA/ASS renderer can place subtitles there (with \-ass-use-margins).
1978 .B \-ass-color <value>
1979 Sets the color for text subtitles.
1980 The color format is RRGGBBAA.
1983 .B \-ass-font-scale <value>
1984 Set the scale coefficient to be used for fonts in the SSA/ASS renderer.
1987 .B \-ass-force-style <[Style.]Param=Value[,...]>
1988 Override some style parameters.
1993 \-ass-force-style FontName=Arial,Default.Bold=1
1998 .B \-ass-hinting <type>
2005 1: FreeType autohinter, light mode.
2007 2: FreeType autohinter, normal mode.
2009 3: Font native hinter.
2011 0-3 + 4: The same, but hinting will only be performed if OSD is rendered at
2012 screen resolution and, therefore, will not be scaled.
2014 The default value is 7 (use native hinter for unscaled OSD and no hinting otherwise).
2019 .B \-ass-line-spacing <value>
2020 Set line spacing value for SSA/ASS renderer.
2023 .B \-ass-styles <filename>
2024 Load all SSA/ASS styles found in the specified file and use them for
2025 rendering text subtitles.
2026 The syntax of the file is exactly like the
2027 [V4 Styles] / [V4+ Styles] section of SSA/ASS.
2030 .B \-ass-top-margin <value>
2031 Adds a black band at the top of the frame.
2032 The SSA/ASS renderer can place toptitles there (with \-ass-use-margins).
2035 .B \-ass-use-margins
2036 Enables placing toptitles and subtitles in black borders when they
2040 .B \-dumpjacosub (MPlayer only)
2041 Convert the given subtitle (specified with the \-sub option) to the time-based
2042 JACOsub subtitle format.
2043 Creates a dumpsub.js file in the current directory.
2046 .B \-dumpmicrodvdsub (MPlayer only)
2047 Convert the given subtitle (specified with the \-sub option) to the
2048 MicroDVD subtitle format.
2049 Creates a dumpsub.sub file in the current directory.
2052 .B \-dumpmpsub (MPlayer only)
2053 Convert the given subtitle (specified with the \-sub option) to MPlayer's
2054 subtitle format, MPsub.
2055 Creates a dump.mpsub file in the current directory.
2058 .B \-dumpsami (MPlayer only)
2059 Convert the given subtitle (specified with the \-sub option) to the time-based
2060 SAMI subtitle format.
2061 Creates a dumpsub.smi file in the current directory.
2064 .B \-dumpsrtsub (MPlayer only)
2065 Convert the given subtitle (specified with the \-sub option) to the time-based
2066 SubViewer (SRT) subtitle format.
2067 Creates a dumpsub.srt file in the current directory.
2070 Some broken hardware players choke on SRT subtitle files with Unix
2072 If you are unlucky enough to have such a box, pass your subtitle
2073 files through unix2dos or a similar program to replace Unix line
2074 endings with DOS/Windows line endings.
2077 .B \-dumpsub (MPlayer only) (BETA CODE)
2078 Dumps the subtitle substream from VOB streams.
2079 Also see the \-dump*sub and \-vobsubout* options.
2082 .B \-embeddedfonts (FreeType only)
2083 Enables extraction of Matroska embedded fonts (default: disabled).
2084 These fonts can be used for SSA/ASS subtitle
2085 rendering (\-ass option).
2086 Font files are created in the ~/.mplayer/\:fonts directory.
2089 With FontConfig 2.4.2 or newer, embedded fonts are opened directly from memory,
2090 and this option is enabled by default.
2093 .B \-ffactor <number>
2094 Resample the font alphamap.
2101 very narrow black outline (default)
2103 narrow black outline
2110 .B \-flip-hebrew (FriBiDi only)
2111 Turns on flipping subtitles using FriBiDi.
2114 .B \-noflip-hebrew-commas
2115 Change FriBiDi's assumptions about the placements of commas in subtitles.
2116 Use this if commas in subtitles are shown at the start of a sentence
2117 instead of at the end.
2120 .B \-font <path to font.desc file>
2121 Search for the OSD/\:SUB fonts in an alternative directory (default for normal
2122 fonts: ~/\:.mplayer/\:font/\:font.desc, default for FreeType fonts:
2123 ~/.mplayer/\:subfont.ttf).
2126 With FreeType, this option determines the path to the text font file.
2127 With fontconfig, this option determines the fontconfig font name.
2132 \-font ~/\:.mplayer/\:arial-14/\:font.desc
2134 \-font ~/\:.mplayer/\:arialuni.ttf
2136 \-font 'Bitstream Vera Sans'
2141 .B \-fontconfig (fontconfig only)
2142 Enables the usage of fontconfig managed fonts.
2146 Display only forced subtitles for the DVD subtitle stream selected by e.g.\&
2150 .B \-fribidi-charset <charset name> (FriBiDi only)
2151 Specifies the character set that will be passed to FriBiDi when
2152 decoding non-UTF-8 subtitles (default: ISO8859-8).
2155 .B \-ifo <VOBsub IFO file>
2156 Indicate the file that will be used to load palette and frame size for VOBsub
2161 Turns off automatic subtitle file loading.
2164 .B \-osd-duration <time>
2165 Set the duration of the OSD messages in ms (default: 1000).
2168 .B \-osdlevel <0\-3> (MPlayer only)
2169 Specifies which mode the OSD should start in.
2175 volume + seek (default)
2177 volume + seek + timer + percentage
2179 volume + seek + timer + percentage + total time
2185 Allows the next subtitle to be displayed while the current one is
2186 still visible (default is to enable the support only for specific
2190 .B \-sid <ID> (also see \-slang, \-vobsubid)
2191 Display the subtitle stream specified by <ID> (0\-31).
2192 MPlayer prints the available subtitle IDs when run in verbose (\-v) mode.
2193 If you cannot select one of the subtitles on a DVD, also try \-vobsubid.
2196 .B \-slang <language code[,language code,...]> (also see \-sid)
2197 Specify a priority list of subtitle languages to use.
2198 Different container formats employ different language codes.
2199 DVDs use ISO 639-1 two letter language codes, Matroska uses ISO 639-2
2200 three letter language codes while OGM uses a free-form identifier.
2201 MPlayer prints the available languages when run in verbose (\-v) mode.
2206 .IPs "mplayer dvd://1 \-slang hu,en"
2207 Chooses the Hungarian subtitle track on a DVD and falls back on English if
2208 Hungarian is not available.
2209 .IPs "mplayer \-slang jpn example.mkv"
2210 Plays a Matroska file with Japanese subtitles.
2216 Antialiasing/\:scaling mode for DVD/\:VOBsub.
2217 A value of 16 may be added to <mode> in order to force scaling even
2218 when original and scaled frame size already match.
2219 This can be employed to e.g.\& smooth subtitles with gaussian blur.
2220 Available modes are:
2224 none (fastest, very ugly)
2226 approximate (broken?)
2230 bilinear (default, fast and not too bad)
2232 uses swscaler gaussian blur (looks very good)
2237 .B \-spualign <-1\-2>
2238 Specify how SPU (DVD/\:VOBsub) subtitles should be aligned.
2244 Align at top (original behavior, default).
2253 .B \-spugauss <0.0\-3.0>
2254 Variance parameter of gaussian used by \-spuaa 4.
2255 Higher means more blur (default: 1.0).
2258 .B \-sub <subtitlefile1,subtitlefile2,...>
2259 Use/\:display these subtitle files.
2260 Only one file can be displayed at the same time.
2263 .B \-sub-bg-alpha <0\-255>
2264 Specify the alpha channel value for subtitles and OSD backgrounds.
2265 Big values mean more transparency.
2266 0 means completely transparent.
2269 .B \-sub-bg-color <0\-255>
2270 Specify the color value for subtitles and OSD backgrounds.
2271 Currently subtitles are grayscale so this value is equivalent to the
2272 intensity of the color.
2273 255 means white and 0 black.
2276 .B \-sub-demuxer <[+]name> (\-subfile only) (BETA CODE)
2277 Force subtitle demuxer type for \-subfile.
2278 Use a '+' before the name to force it, this will skip some checks!
2279 Give the demuxer name as printed by \-sub-demuxer help.
2280 For backward compatibility it also accepts the demuxer ID as defined in
2284 .B \-sub-fuzziness <mode>
2285 Adjust matching fuzziness when searching for subtitles:
2291 Load all subs containing movie name.
2293 Load all subs in the current directory.
2299 Disables any kind of text post processing done after loading the subtitles.
2300 Used for debug purposes.
2303 .B \-subalign <0\-2>
2304 Specify which edge of the subtitles should be aligned at the height
2309 Align subtitle top edge (original behavior).
2311 Align subtitle center.
2313 Align subtitle bottom edge (default).
2319 Display DVD Closed Caption (CC) subtitles.
2322 the VOB subtitles, these are special ASCII subtitles for the
2323 hearing impaired encoded in the VOB userdata stream on most region 1 DVDs.
2324 CC subtitles have not been spotted on DVDs from other regions so far.
2327 .B \-subcp <codepage> (iconv only)
2328 If your system supports iconv(3), you can use this option to
2329 specify the subtitle codepage.
2341 .B \-subcp enca:<language>:<fallback codepage> (ENCA only)
2342 You can specify your language using a two letter language code to
2343 make ENCA detect the codepage automatically.
2344 If unsure, enter anything and watch mplayer \-v output for available
2346 Fallback codepage specifies the codepage to use, when autodetection fails.
2351 .IPs "\-subcp enca:cs:latin2"
2352 Guess the encoding, assuming the subtitles are Czech, fall back on
2353 latin 2, if the detection fails.
2354 .IPs "\-subcp enca:pl:cp1250"
2355 Guess the encoding for Polish, fall back on cp1250.
2361 Delays subtitles by <sec> seconds.
2365 .B \-subfile <filename> (BETA CODE)
2367 Same as \-audiofile, but for subtitle streams (OggDS?).
2370 .B \-subfont <filename> (FreeType only)
2371 Sets the subtitle font.
2372 If no \-subfont is given, \-font is used.
2375 .B \-subfont-autoscale <0\-3> (FreeType only)
2376 Sets the autoscale mode.
2379 0 means that text scale and OSD scale are font heights in points.
2388 proportional to movie height
2390 proportional to movie width
2392 proportional to movie diagonal (default)
2397 .B \-subfont-blur <0\-8> (FreeType only)
2398 Sets the font blur radius (default: 2).
2401 .B \-subfont-encoding <value> (FreeType only)
2402 Sets the font encoding.
2403 When set to 'unicode', all the glyphs from the font file will be rendered and
2404 unicode will be used (default: unicode).
2407 .B \-subfont-osd-scale <0\-100> (FreeType only)
2408 Sets the autoscale coefficient of the OSD elements (default: 6).
2411 .B \-subfont-outline <0\-8> (FreeType only)
2412 Sets the font outline thickness (default: 2).
2415 .B \-subfont-text-scale <0\-100> (FreeType only)
2416 Sets the subtitle text autoscale coefficient as percentage of the
2417 screen size (default: 5).
2421 Specify the framerate of the subtitle file (default: movie fps).
2424 <rate> > movie fps speeds the subtitles up for frame-based subtitle files and
2425 slows them down for time-based ones.
2428 .B \-subpos <0\-100> (useful with \-vf expand)
2429 Specify the position of subtitles on the screen.
2430 The value is the vertical position of the subtitle in % of the screen height.
2433 .B \-subwidth <10\-100>
2434 Specify the maximum width of subtitles on the screen.
2436 The value is the width of the subtitle in % of the screen width.
2440 Disable the display of OSD messages on the console when no video output is
2444 .B \-term-osd-esc <escape sequence>
2445 Specify the escape sequence to use before writing an OSD message on the
2447 The escape sequence should move the pointer to the beginning of the line
2448 used for the OSD and clear it (default: ^[[A\\r^[[K).
2452 Tells MPlayer to handle the subtitle file as unicode.
2456 Tells MPlayer to handle the subtitle file as UTF-8.
2459 .B \-vobsub <VOBsub file without extension>
2460 Specify a VOBsub file to use for subtitles.
2461 Has to be the full pathname without extension, i.e.\& without
2462 the '.idx', '.ifo' or '.sub'.
2465 .B \-vobsubid <0\-31>
2466 Specify the VOBsub subtitle ID.
2470 .SH "AUDIO OUTPUT OPTIONS (MPLAYER ONLY)"
2473 .B \-abs <value> (\-ao oss only) (OBSOLETE)
2474 Override audio driver/\:card buffer size detection.
2477 .B \-format <format> (also see the format audio filter)
2478 Select the sample format used for output from the audio filter
2479 layer to the sound card.
2480 The values that <format> can adopt are listed below in the
2481 description of the format audio filter.
2485 Use a mixer device different from the default /dev/\:mixer.
2486 For ALSA this is the mixer name.
2489 .B \-mixer-channel <mixer line>[,mixer index] (\-ao oss and \-ao alsa only)
2490 This option will tell MPlayer to use a different channel for controlling
2491 volume than the default PCM.
2492 Options for OSS include
2494 For a complete list of options look for SOUND_DEVICE_NAMES in
2495 /usr/\:include/\:linux/\:soundcard.h.
2496 For ALSA you can use the names e.g.\& alsamixer displays, like
2497 .B Master, Line, PCM.
2500 ALSA mixer channel names followed by a number must be specified in the
2501 <name,number> format, i.e.\& a channel labeled 'PCM 1' in alsamixer must
2507 Force the use of the software mixer, instead of using the sound card
2511 .B \-softvol-max <10.0\-10000.0>
2512 Set the maximum amplification level in percent (default: 110).
2513 A value of 200 will allow you to adjust the volume up to a maximum of
2514 double the current level.
2515 With values below 100 the initial volume (which is 100%) will be above
2516 the maximum, which e.g.\& the OSD cannot display correctly.
2519 .B \-volstep <0\-100>
2520 Set the step size of mixer volume changes in percent of the whole range
2525 .SH "AUDIO OUTPUT DRIVERS (MPLAYER ONLY)"
2526 Audio output drivers are interfaces to different audio output facilities.
2530 .B \-ao <driver1[:suboption1[=value]:...],driver2,...[,]>
2531 Specify a priority list of audio output drivers to be used.
2533 If the list has a trailing ',' MPlayer will fall back on drivers not
2534 contained in the list.
2535 Suboptions are optional and can mostly be omitted.
2538 See \-ao help for a list of compiled-in audio output drivers.
2543 .IPs "\-ao alsa,oss,"
2544 Try the ALSA driver, then the OSS driver, then others.
2545 .IPs "\-ao alsa:noblock:device=hw=0.3"
2546 Sets noblock-mode and the device-name as first card, fourth device.
2550 Available audio output drivers are:
2554 ALSA 0.9/1.x audio output driver
2559 .IPs device=<device>
2560 Sets the device name.
2561 Replace any ',' with '.' and any ':' with '=' in the ALSA device name.
2562 For hwac3 output via S/PDIF, use an "iec958" or "spdif" device, unless
2563 you really know how to set it correctly.
2569 ALSA 0.5 audio output driver
2573 OSS audio output driver
2577 Sets the audio output device (default: /dev/\:dsp).
2579 Sets the audio mixer device (default: /dev/\:mixer).
2580 .IPs <mixer-channel>
2581 Sets the audio mixer channel (default: pcm).
2587 highly platform independent SDL (Simple Directmedia Layer) library
2592 Explicitly choose the SDL audio driver to use (default: let SDL choose).
2598 audio output through the aRts daemon
2602 audio output through the ESD daemon
2606 Explicitly choose the ESD server to use (default: localhost).
2612 audio output through JACK (Jack Audio Connection Kit)
2616 Connects to the ports with the given name (default: physical ports).
2617 .IPs name=<client name>
2618 Client name that is passed to JACK (default: MPlayer [<PID>]).
2619 Useful if you want to have certain connections established automatically.
2621 Estimate the audio delay, supposed to make the video playback smoother
2628 audio output through NAS
2631 .B macosx (Mac OS X only)
2632 native Mac OS X audio output driver
2636 Experimental, unfinished (will downmix to mono) OpenAL audio output driver
2640 native SGI audio output driver
2643 .IPs "<output device name>"
2644 Explicitly choose the output device/\:interface to use
2645 (default: system-wide default).
2646 For example, 'Analog Out' or 'Digital Out'.
2652 native Sun audio output driver
2656 Explicitly choose the audio device to use (default: /dev/\:audio).
2661 .B win32 (Windows only)
2662 native Windows waveout audio output driver
2665 .B dsound (Windows only)
2666 DirectX DirectSound audio output driver
2669 .IPs device=<devicenum>
2670 Sets the device number to use.
2671 Playing a file with \-v will show a list of available devices.
2676 .B dxr2 (also see \-dxr2) (DXR2 only)
2677 Creative DXR2 specific output driver
2681 IVTV specific MPEG audio output driver.
2682 Works with \-ac hwmpa only.
2685 .B v4l2 (requires Linux 2.6.22+ kernel)
2686 Audio output driver for V4L2 cards with hardware MPEG decoder.
2689 .B mpegpes (DVB only)
2690 Audio output driver for DVB cards that writes the output to an MPEG-PES
2691 file if no DVB card is installed.
2695 DVB card to use if more than one card is present.
2696 .IPs file=<filename>
2703 Produces no audio output but maintains video playback speed.
2704 Use \-nosound for benchmarking.
2708 raw PCM/wave file writer audio output
2712 Include or do not include the wave header (default: included).
2713 When not included, raw PCM will be generated.
2714 .IPs file=<filename>
2715 Write the sound to <filename> instead of the default
2717 If nowaveheader is specified, the default is audiodump.pcm.
2719 Try to dump faster than realtime.
2720 Make sure the output does not get truncated (usually with
2721 "Too many video packets in buffer" message).
2722 It is normal that you get a "Your system is too SLOW to play this!" message.
2728 plugin audio output driver
2732 .SH "VIDEO OUTPUT OPTIONS (MPLAYER ONLY)"
2735 .B \-adapter <value>
2736 Set the graphics card that will receive the image.
2737 You can get a list of available cards when you run this option with \-v.
2738 Currently only works with the directx video output driver.
2742 Override the autodetected color depth.
2743 Only supported by the fbdev, dga, svga, vesa video output drivers.
2747 Play movie with window border and decorations.
2748 Since this is on by default, use \-noborder to disable the standard window
2750 Supported by the directx video output driver.
2753 .B \-brightness <-100\-100>
2754 Adjust the brightness of the video signal (default: 0).
2755 Not supported by all video output drivers.
2758 .B \-contrast <-100\-100>
2759 Adjust the contrast of the video signal (default: 0).
2760 Not supported by all video output drivers.
2763 .B \-display <name> (X11 only)
2764 Specify the hostname and display number of the X server you want to display
2770 \-display xtest.localdomain:0
2776 Turns on direct rendering (not supported by all codecs and video outputs)
2779 May cause OSD/SUB corruption!
2782 .B \-dxr2 <option1:option2:...>
2783 This option is used to control the dxr2 video output driver.
2785 .IPs ar-mode=<value>
2786 aspect ratio mode (0 = normal, 1 = pan-and-scan, 2 = letterbox (default))
2788 Set iec958 output mode to encoded.
2790 Set iec958 output mode to decoded (default).
2791 .IPs macrovision=<value>
2792 macrovision mode (0 = off (default), 1 = agc, 2 = agc 2 colorstripe,
2793 3 = agc 4 colorstripe)
2799 path to the microcode
2807 enable 7.5 IRE output mode
2809 disable 7.5 IRE output mode (default)
2813 color TV output (default)
2815 interlaced TV output (default)
2817 disable interlaced TV output
2819 TV norm (ntsc (default), pal, pal60, palm, paln, palnc)
2821 set pixel mode to square
2823 set pixel mode to ccir601
2830 .IPs cr-left=<0\-500>
2831 Set the left cropping value (default: 50).
2832 .IPs cr-right=<0\-500>
2833 Set the right cropping value (default: 300).
2834 .IPs cr-top=<0\-500>
2835 Set the top cropping value (default: 0).
2836 .IPs cr-bottom=<0\-500>
2837 Set the bottom cropping value (default: 0).
2838 .IPs ck-[r|g|b]=<0\-255>
2839 Set the r(ed), g(reen) or b(lue) gain of the overlay color-key.
2840 .IPs ck-[r|g|b]min=<0\-255>
2841 minimum value for the respective color key
2842 .IPs ck-[r|g|b]max=<0\-255>
2843 maximum value for the respective color key
2845 Ignore cached overlay settings.
2847 Update cached overlay settings.
2849 Enable overlay onscreen display.
2851 Disable overlay onscreen display (default).
2852 .IPs ol[h|w|x|y]-cor=<-20\-20>
2853 Adjust the overlay size (h,w) and position (x,y) in case it does not
2854 match the window perfectly (default: 0).
2856 Activate overlay (default).
2859 .IPs overlay-ratio=<1\-2500>
2860 Tune the overlay (default: 1000).
2864 .B \-fbmode <modename> (\-vo fbdev only)
2865 Change video mode to the one that is labeled as <modename> in
2869 VESA framebuffer does not support mode changing.
2872 .B \-fbmodeconfig <filename> (\-vo fbdev only)
2873 Override framebuffer mode configuration file (default: /etc/\:fb.modes).
2876 .B \-fs (also see \-zoom)
2877 Fullscreen playback (centers movie, and paints black bands around it).
2878 Not supported by all video output drivers.
2881 .B \-fsmode-dontuse <0\-31> (OBSOLETE, use the \-fs option)
2882 Try this option if you still experience fullscreen problems.
2885 .B \-fstype <type1,type2,...> (X11 only)
2886 Specify a priority list of fullscreen modes to be used.
2887 You can negate the modes by prefixing them with '\-'.
2888 If you experience problems like the fullscreen window being covered
2889 by other windows try using a different order.
2892 See \-fstype help for a full list of available modes.
2894 The available types are:
2899 Use the _NETWM_STATE_ABOVE hint if available.
2901 Use the _NETWM_STATE_BELOW hint if available.
2903 Use the _NETWM_STATE_FULLSCREEN hint if available.
2905 Use the _WIN_LAYER hint with the default layer.
2907 Use the _WIN_LAYER hint with the given layer number.
2911 Do not set fullscreen window layer.
2913 Use _NETWM_STATE_STAYS_ON_TOP hint if available.
2921 .IPs layer,stays_on_top,above,fullscreen
2922 Default order, will be used as a fallback if incorrect or
2923 unsupported modes are specified.
2925 Fixes fullscreen switching on OpenBox 1.x.
2930 .B \-geometry x[%][:y[%]] or [WxH][+x+y]
2931 Adjust where the output is on the screen initially.
2932 The x and y specifications are in pixels measured from the top-left of the
2933 screen to the top-left of the image being displayed, however if a percentage
2934 sign is given after the argument it turns the value into a percentage of the
2935 screen size in that direction.
2936 It also supports the standard X11 \-geometry option format.
2937 If an external window is specified using the \-wid option, then the x and
2938 y coordinates are relative to the top-left corner of the window rather
2942 This option is only supported by the x11, xmga, xv, xvmc, xvidix,
2943 gl, gl2, directx and tdfxfb video output drivers.
2949 Places the window at x=50, y=40.
2951 Places the window in the middle of the screen.
2953 Places the window at the middle of the right edge of the screen.
2955 Places the window at the bottom right corner of the screen.
2960 .B \-guiwid <window ID> (also see \-wid) (GUI only)
2961 This tells the GUI to also use an X11 window and stick itself to the bottom
2962 of the video, which is useful to embed a mini-GUI in a browser (with the
2963 MPlayer plugin for instance).
2966 .B \-hue <-100\-100>
2967 Adjust the hue of the video signal (default: 0).
2968 You can get a colored negative of the image with this option.
2969 Not supported by all video output drivers.
2972 .B \-monitor-dotclock <range[,range,...]> (\-vo fbdev and vesa only)
2973 Specify the dotclock or pixelclock range of the monitor.
2976 .B \-monitor-hfreq <range[,range,...]> (\-vo fbdev and vesa only)
2977 Specify the horizontal frequency range of the monitor.
2980 .B \-monitor-vfreq <range[,range,...]> (\-vo fbdev and vesa only)
2981 Specify the vertical frequency range of the monitor.
2984 .B \-monitoraspect <ratio> (also see \-aspect)
2985 Set the aspect ratio of your monitor or TV screen.
2986 A value of 0 disables a previous setting (e.g.\& in the config file).
2987 Overrides the \-monitorpixelaspect setting if enabled.
2992 \-monitoraspect 4:3 or 1.3333
2994 \-monitoraspect 16:9 or 1.7777
2999 .B \-monitorpixelaspect <ratio> (also see \-aspect)
3000 Set the aspect of a single pixel of your monitor or TV screen (default: 1).
3001 A value of 1 means square pixels
3002 (correct for (almost?) all LCDs).
3006 Disables double buffering, mostly for debugging purposes.
3007 Double buffering fixes flicker by storing two frames in memory, and
3008 displaying one while decoding another.
3009 It can affect OSD negatively, but often removes OSD flickering.
3013 Do not grab the mouse pointer after a video mode change (\-vm).
3014 Useful for multihead setups.
3018 Do not keep window aspect ratio when resizing windows.
3019 Only works with the x11, xv, xmga, xvidix, directx video output drivers.
3020 Furthermore under X11 your window manager has to honor window aspect hints.
3024 Makes the player window stay on top of other windows.
3025 Supported by video output drivers which use X11, except SDL,
3026 as well as directx, macosx, quartz, ggi and gl2.
3029 .B \-panscan <0.0\-1.0>
3030 Enables pan-and-scan functionality (cropping the sides of e.g.\& a 16:9
3031 movie to make it fit a 4:3 display without black bands).
3032 The range controls how much of the image is cropped.
3033 Only works with the xv, xmga, mga, gl, gl2, quartz, macosx and xvidix
3034 video output drivers.
3037 Values between -1 and 0 are allowed as well, but highly experimental
3038 and may crash or worse.
3039 Use at your own risk!
3042 .B \-panscanrange <-19.0\-99.0> (experimental)
3043 Change the range of the pan-and-scan functionality (default: 1).
3044 Positive values mean multiples of the default range.
3045 Negative numbers mean you can zoom in up to a factor of \-panscanrange+1.
3046 E.g. \-panscanrange -3 allows a zoom factor of up to 4.
3047 This feature is experimental.
3048 Do not report bugs unless you are using \-vo gl.
3051 .B \-refreshrate <Hz>
3052 Set the monitor refreshrate in Hz.
3053 Currently only supported by \-vo directx combined with the \-vm option.
3057 Play movie in the root window (desktop background).
3058 Desktop background images may cover the movie window, though.
3059 Only works with the x11, xv, xmga, xvidix, quartz, macosx and directx video output drivers.
3062 .B \-saturation <-100\-100>
3063 Adjust the saturation of the video signal (default: 0).
3064 You can get grayscale output with this option.
3065 Not supported by all video output drivers.
3068 .B \-screenh <pixels>
3069 Specify the vertical screen resolution for video output drivers which
3070 do not know the screen resolution like fbdev, x11 and TVout.
3073 .B \-screenw <pixels>
3074 Specify the horizontal screen resolution for video output drivers which
3075 do not know the screen resolution like fbdev, x11 and TVout.
3078 .B \-stop-xscreensaver (X11 only)
3079 Turns off xscreensaver at startup and turns it on again on exit.
3083 Try to change to a different video mode.
3084 Supported by the dga, x11, xv, sdl and directx video output drivers.
3085 If used with the directx video output driver the \-screenw,
3086 \-screenh, \-bpp and \-refreshrate options can be used to set
3087 the new display mode.
3091 Enables VBI for the vesa, dfbmga and svga video output drivers.
3094 .B \-wid <window ID> (also see \-guiwid) (X11, OpenGL and DirectX only)
3095 This tells MPlayer to attach to an existing window.
3096 Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
3099 .B \-xineramascreen <\-2\-...> (X11 only)
3100 In Xinerama configurations (i.e.\& a single desktop that spans across multiple
3101 displays) this option tells MPlayer which screen to display the movie on.
3102 A value of \-2 means fullscreen across the whole virtual display (in this case
3103 Xinerama information is completely ignored), \-1 means
3104 fullscreen on the display the window currently is on.
3105 The initial position set via the \-geometry option is relative to the
3107 Will usually only work with "\-fstype \-fullscreen" or "\-fstype none".
3110 .B \-zrbw (\-vo zr only)
3111 Display in black and white.
3112 For optimal performance, this can be combined with '\-lavdopts gray'.
3115 .B \-zrcrop <[width]x[height]+[x offset]+[y offset]> (\-vo zr only)
3116 Select a part of the input image to display, multiple occurrences
3117 of this option switch on cinerama mode.
3118 In cinerama mode the movie is distributed over more than one TV
3119 (or beamer) to create a larger image.
3120 Options appearing after the n-th \-zrcrop apply to the n-th MJPEG card, each
3121 card should at least have a \-zrdev in addition to the \-zrcrop.
3122 For examples, see the output of \-zrhelp and the Zr section of the
3126 .B \-zrdev <device> (\-vo zr only)
3127 Specify the device special file that belongs to your MJPEG card, by default
3128 the zr video output driver takes the first v4l device it can find.
3131 .B \-zrfd (\-vo zr only)
3132 Force decimation: Decimation, as specified by \-zrhdec and \-zrvdec, only
3133 happens if the hardware scaler can stretch the image to its original size.
3134 Use this option to force decimation.
3137 .B \-zrhdec <1|2|4> (\-vo zr only)
3138 Horizontal decimation: Ask the driver to send only every 2nd or 4th
3139 line/\:pixel of the input image to the MJPEG card and use the scaler
3140 of the MJPEG card to stretch the image to its original size.
3143 .B \-zrhelp (\-vo zr only)
3144 Display a list of all \-zr* options, their default values and a
3145 cinerama mode example.
3148 .B \-zrnorm <norm> (\-vo zr only)
3149 Specify the TV norm as PAL or NTSC (default: no change).
3152 .B \-zrquality <1\-20> (\-vo zr only)
3153 A number from 1 (best) to 20 (worst) representing the JPEG encoding quality.
3156 .B \-zrvdec <1|2|4> (\-vo zr only)
3157 Vertical decimation: Ask the driver to send only every 2nd or 4th
3158 line/\:pixel of the input image to the MJPEG card and use the scaler
3159 of the MJPEG card to stretch the image to its original size.
3162 .B \-zrxdoff <x display offset> (\-vo zr only)
3163 If the movie is smaller than the TV screen, this option specifies the x
3164 offset from the upper-left corner of the TV screen (default: centered).
3167 .B \-zrydoff <y display offset> (\-vo zr only)
3168 If the movie is smaller than the TV screen, this option specifies the y
3169 offset from the upper-left corner of the TV screen (default: centered).
3173 .SH "VIDEO OUTPUT DRIVERS (MPLAYER ONLY)"
3174 Video output drivers are interfaces to different video output facilities.
3178 .B \-vo <driver1[:suboption1[=value]:...],driver2,...[,]>
3179 Specify a priority list of video output drivers to be used.
3181 If the list has a trailing ',' MPlayer will fall back on drivers not
3182 contained in the list.
3183 Suboptions are optional and can mostly be omitted.
3186 See \-vo help for a list of compiled-in video output drivers.
3191 .IPs "\-vo xmga,xv,"
3192 Try the Matrox X11 driver, then the Xv driver, then others.
3193 .IPs "\-vo directx:noaccel"
3194 Uses the DirectX driver with acceleration features turned off.
3198 Available video output drivers are:
3202 Uses the XVideo extension of XFree86 4.x to enable hardware
3203 accelerated playback.
3204 If you cannot use a hardware specific driver, this is probably
3206 For information about what colorkey is used and how it is drawn run MPlayer
3207 with \-v option and look out for the lines tagged with [xv common] at the
3212 Select a specific XVideo port.
3213 .IPs ck=<cur|use|set>
3214 Select the source from which the colorkey is taken (default: cur).
3217 The default takes the colorkey currently set in Xv.
3219 Use but do not set the colorkey from MPlayer (use \-colorkey option to change
3222 Same as use but also sets the supplied colorkey.
3224 .IPs ck-method=<man|bg|auto>
3225 Sets the colorkey drawing method (default: man).
3228 Draw the colorkey manually (reduces flicker in some cases).
3230 Set the colorkey as window background.
3232 Let Xv draw the colorkey.
3239 Shared memory video output driver without hardware acceleration that
3240 works whenever X11 is present.
3244 Adds X11 support to all overlay based video output drivers.
3245 Currently only supported by tdfx_vid.
3249 Select the driver to use as source to overlay on top of X11.
3254 .B xvmc (X11 with \-vc ffmpeg12mc only)
3255 Video output driver that uses the XvMC (X Video Motion Compensation)
3256 extension of XFree86 4.x to speed up MPEG-1/2 and VCR2 decoding.
3260 Select a specific XVideo port.
3262 Disables image display.
3263 Necessary for proper benchmarking of drivers that change
3264 image buffers on monitor retrace only (nVidia).
3265 Default is not to disable image display (nobenchmark).
3267 Very simple deinterlacer.
3268 Might not look better than \-vf tfields=1,
3269 but it is the only deinterlacer for xvmc (default: nobobdeint).
3271 Queue frames for display to allow more parallel work of the video hardware.
3272 May add a small (not noticeable) constant A/V desync (default: noqueue).
3274 Use sleep function while waiting for rendering to finish
3275 (not recommended on Linux) (default: nosleep).
3277 Same as \-vo xv:ck (see \-vo xv).
3278 .IPs ck-method=man|bg|auto
3279 Same as \-vo xv:ck-method (see \-vo xv).
3285 Play video through the XFree86 Direct Graphics Access extension.
3286 Considered obsolete.
3290 Highly platform independent SDL (Simple Directmedia Layer) library
3291 video output driver.
3292 Since SDL uses its own X11 layer, MPlayer X11 options do not have
3296 .IPs driver=<driver>
3297 Explicitly choose the SDL driver to use.
3299 Use XVideo through the sdl video output driver (default: forcexv).
3301 Use hardware accelerated scaler (default: hwaccel).
3307 VIDIX (VIDeo Interface for *niX) is an interface to the
3308 video acceleration features of different graphics cards.
3309 Very fast video output driver on cards that support it.
3313 Explicitly choose the VIDIX subdevice driver to use.
3314 Available subdevice drivers are cyberblade, mach64,
3315 mga_crtc2, mga, nvidia, pm2, pm3, radeon, rage128, sis_vid and unichrome.
3320 .B xvidix (X11 only)
3321 X11 frontend for VIDIX
3331 Generic and platform independent VIDIX frontend, can even run in a
3332 text console with nVidia cards.
3341 .B winvidix (Windows only)
3342 Windows frontend for VIDIX
3351 .B directx (Windows only)
3352 Video output driver that uses the DirectX interface.
3356 Turns off hardware acceleration.
3357 Try this option if you have display problems.
3362 .B quartz (Mac OS X only)
3363 Mac OS X Quartz video output driver.
3364 Under some circumstances, it might be more efficient to force a
3365 packed YUV output format, with e.g.\& \-vf format=yuy2.
3368 .IPs device_id=<number>
3369 Choose the display device to use in fullscreen.
3370 .IPs fs_res=<width>:<height>
3371 Specify the fullscreen resolution (useful on slow systems).
3376 .B macosx (Mac OS X 10.4 or 10.3.9 with QuickTime 7)
3377 Mac OS X CoreVideo video output driver
3380 .IPs device_id=<number>
3381 Choose the display device to use in fullscreen.
3386 .B fbdev (Linux only)
3387 Uses the kernel framebuffer to play video.
3391 Explicitly choose the fbdev device name to use (e.g.\& /dev/\:fb0) or the
3392 name of the VIDIX subdevice if the device name starts with 'vidix'
3393 (e.g.\& 'vidixsis_vid' for the sis driver).
3398 .B fbdev2 (Linux only)
3399 Uses the kernel framebuffer to play video,
3400 alternative implementation.
3404 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3410 Very general video output driver that should work on any VESA VBE 2.0
3415 Turns DGA mode on or off (default: on).
3417 Activate the NeoMagic TV out and set it to PAL norm.
3419 Activate the NeoMagic TV out and set it to NTSC norm.
3421 Use the VIDIX driver.
3423 Activate the Linux Video Overlay on top of VESA mode.
3429 Play video using the SVGA library.
3433 Specify video mode to use.
3434 The mode can be given in a <width>x<height>x<colors> format,
3435 e.g.\& 640x480x16M or be a graphics mode number, e.g.\& 84.
3437 Draw OSD into black bands below the movie (slower).
3439 Use only native drawing functions.
3440 This avoids direct rendering, OSD and hardware acceleration.
3442 Force frame switch on vertical retrace.
3443 Usable only with \-double.
3444 It has the same effect as the \-vsync option.
3446 Try to select a video mode with square pixels.
3448 Use svga with VIDIX.
3454 OpenGL video output driver, simple version.
3455 Video size must be smaller than
3456 the maximum texture size of your OpenGL implementation.
3457 Intended to work even with the most basic OpenGL implementations,
3458 but also makes use of newer extensions, which allow support for more
3459 colorspaces and direct rendering.
3460 Please use \-dr if it works with your OpenGL implementation,
3461 since for higher resolutions this provides a
3464 The code performs very few checks, so if a feature does not work, this
3465 might be because it is not supported by your card/OpenGL implementation
3466 even if you do not get any error message.
3467 Use glxinfo or a similar tool to display the supported OpenGL extensions.
3471 Changes the way the OSD behaves when the size of the
3472 window changes (default: disabled).
3473 When enabled behaves more like the other video output drivers,
3474 which is better for fixed-size fonts.
3475 Disabled looks much better with FreeType fonts and uses the
3476 borders in fullscreen mode.
3477 Does not work correctly with ass subtitles (see \-ass), you can instead
3478 render them without OpenGL support via \-vf ass.
3479 .IPs osdcolor=<0xRRGGBB>
3480 Color for OSD (default: 0xffffff, corresponds to white).
3481 .IPs rectangle=<0,1,2>
3482 Select usage of rectangular textures which saves video RAM, but often is
3483 slower (default: 0).
3485 0: Use power-of-two textures (default).
3487 1: Use the GL_ARB_texture_rectangle extension.
3489 2: Use the GL_ARB_texture_non_power_of_two extension.
3490 In some cases only supported in software and thus very slow.
3492 .IPs swapinterval=<n>
3493 Minimum interval between two buffer swaps, counted in
3494 displayed frames (default: 1).
3495 1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
3496 Values below 0 will leave it at the system default.
3497 This limits the framerate to (horizontal refresh rate / n).
3498 Requires GLX_SGI_swap_control support to work.
3499 With some (most/all?) implementations this only works in fullscreen mode.
3501 Select the type of YUV to RGB conversion.
3503 0: Use software conversion (default).
3504 Compatible with all OpenGL versions.
3505 Provides brightness, contrast and saturation control.
3507 1: Use register combiners.
3508 This uses an nVidia-specific extension (GL_NV_register_combiners).
3509 At least three texture units are needed.
3510 Provides saturation and hue control.
3511 This method is fast but inexact.
3513 2: Use a fragment program.
3514 Needs the GL_ARB_fragment_program extension and at least three texture units.
3515 Provides brightness, contrast, saturation and hue control.
3517 3: Use a fragment program using the POW instruction.
3518 Needs the GL_ARB_fragment_program extension and at least three texture units.
3519 Provides brightness, contrast, saturation, hue and gamma control.
3520 Gamma can also be set independently for red, green and blue.
3521 Method 4 is usually faster.
3523 4: Use a fragment program with additional lookup.
3524 Needs the GL_ARB_fragment_program extension and at least four texture units.
3525 Provides brightness, contrast, saturation, hue and gamma control.
3526 Gamma can also be set independently for red, green and blue.
3528 5: Use ATI-specific method (for older cards).
3529 This uses an ATI-specific extension (GL_ATI_fragment_shader - not
3530 GL_ARB_fragment_shader!).
3531 At least three texture units are needed.
3532 Provides saturation and hue control.
3533 This method is fast but inexact.
3535 6: Use a 3D texture to do conversion via lookup.
3536 Needs the GL_ARB_fragment_program extension and at least four texture units.
3537 Extremely slow (software emulation) on some (all?) ATI cards since it uses
3538 a texture with border pixels.
3539 Provides brightness, contrast, saturation, hue and gamma control.
3540 Gamma can also be set independently for red, green and blue.
3541 Speed depends more on GPU memory bandwidth than other methods.
3544 Select the scaling function to use for luminance scaling.
3545 Only valid for yuv modes 2, 3, 4 and 6.
3547 0: Use simple linear filtering (default).
3549 1: Use bicubic filtering (better quality).
3550 Needs one additional texture unit.
3551 Older cards will not be able to handle this for chroma at least in fullscreen mode.
3553 2: Use cubic filtering in horizontal, linear filtering in vertical direction.
3554 Works on a few more cards than method 1.
3557 Select the scaling function to use for chrominance scaling.
3558 For details see lscale.
3559 .IPs customprog=<filename>
3560 Load a custom fragment program from <filename>.
3561 See TOOLS/edgedect.fp for an example.
3562 .IPs customtex=<filename>
3563 Load a custom "gamma ramp" texture from <filename>.
3564 This can be used in combination with yuv=4 or with the customprog option.
3566 If enabled (default) use GL_LINEAR interpolation, otherwise use GL_NEAREST
3567 for customtex texture.
3568 .IPs (no)customtrect
3569 If enabled, use texture_rectangle for customtex texture.
3570 Default is disabled.
3574 Normally there is no reason to use the following options, they mostly
3575 exist for testing purposes.
3580 Call glFinish() before swapping buffers.
3581 Slower but in some cases more correct output (default: disabled).
3583 Enables support for more (RGB and BGR) color formats (default: enabled).
3584 Needs OpenGL version >= 1.2.
3585 .IPs slice-height=<0\-...>
3586 Number of lines copied to texture in one piece (default: 0).
3590 If YUV colorspace is used (see yuv suboption), special rules apply:
3592 If the decoder uses slice rendering (see \-noslices), this setting
3593 has no effect, the size of the slices as provided by the decoder is used.
3595 If the decoder does not use slice rendering, the default is 16.
3598 Enable or disable support for OSD rendering via OpenGL (default: enabled).
3599 This option is for testing; to disable the OSD use \-osdlevel 0 instead.
3601 Enable or disable aspect scaling and pan-and-scan support (default: enabled).
3602 Disabling might increase speed.
3609 OpenGL video output driver, second generation.
3610 Supports OSD and videos larger than the maximum texture size.
3614 same as gl (default: enabled)
3616 Select the type of YUV to RGB conversion.
3617 If set to anything except 0 OSD will be disabled and brightness, contrast and
3618 gamma setting is only available via the global X server settings.
3619 Apart from this the values have the same meaning as for \-vo gl.
3624 Produces no video output.
3625 Useful for benchmarking.
3629 ASCII art video output driver that works on a text console.
3630 You can get a list and an explanation of available suboptions executing
3631 .I mplayer \-vo aa:help
3634 Driver does not not handle \-aspect correctly.
3637 You probably have to specify \-monitorpixelaspect. Try
3638 .I mplayer -vo aa -monitorpixelaspect 8/15.
3642 Color ASCII art video output driver that works on a text console.
3646 Video playback using the Blinkenlights UDP protocol.
3647 This driver is highly hardware specific.
3651 Explicitly choose the Blinkenlights subdevice driver to use.
3652 It is something like arcade:host=localhost:2323 or
3653 hdl:file=name1,file=name2.
3654 You must specify a subdevice.
3660 GGI graphics system video output driver
3664 Explicitly choose the GGI driver to use.
3665 Replace any ',' that would appear in the driver string by a '.'.
3671 Play video using the DirectFB library.
3675 Use the DirectFB instead of the MPlayer keyboard code (default: enabled).
3676 .IPs buffermode=single|double|triple
3677 Double and triple buffering give best results if you want to avoid tearing issues.
3678 Triple buffering is more efficient than double buffering as it does
3679 not block MPlayer while waiting for the vertical retrace.
3680 Single buffering should be avoided (default: single).
3681 .IPs fieldparity=top|bottom
3682 Control the output order for interlaced frames (default: disabled).
3683 Valid values are top = top fields first, bottom = bottom fields first.
3684 This option does not have any effect on progressive film material
3685 like most MPEG movies are.
3686 You need to enable this option if you have tearing issues or unsmooth
3687 motions watching interlaced film material.
3689 Will force layer with ID N for playback (default: -1 - auto).
3691 Specify a parameter list for DirectFB.
3697 Matrox G400/\:G450/\:G550 specific video output driver that uses the
3698 DirectFB library to make use of special hardware features.
3699 Enables CRTC2 (second head), displaying video independently of the first head.
3703 same as directfb (default: disabled)
3704 .IPs buffermode=single|double|triple
3705 same as directfb (default: triple)
3706 .IPs fieldparity=top|bottom
3709 Enable the use of the Matrox BES (backend scaler) (default: disabled).
3710 Gives very good results concerning speed and output quality as interpolated
3711 picture processing is done in hardware.
3712 Works only on the primary head.
3714 Make use of the Matrox sub picture layer to display the OSD (default: enabled).
3716 Turn on TV-out on the second head (default: enabled).
3717 The output quality is amazing as it is a full interlaced picture
3718 with proper sync to every odd/\:even field.
3719 .IPs tvnorm=pal|ntsc|auto
3720 Will set the TV norm of the Matrox card without the need
3721 for modifying /etc/\:directfbrc (default: disabled).
3722 Valid norms are pal = PAL, ntsc = NTSC.
3723 Special norm is auto (auto-adjust using PAL/\:NTSC) because it decides
3724 which norm to use by looking at the framerate of the movie.
3730 Matrox specific video output driver that makes use of the YUV back
3731 end scaler on Gxxx cards through a kernel module.
3732 If you have a Matrox card, this is the fastest option.
3736 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3741 .B xmga (Linux, X11 only)
3742 The mga video output driver, running in an X11 window.
3746 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3751 .B s3fb (Linux only) (see also \-vf yuv2 and \-dr)
3752 S3 Virge specific video output driver.
3753 This driver supports the card's YUV conversion and scaling, double
3754 buffering and direct rendering features.
3755 Use \-vf yuy2 to get hardware-accelerated YUY2 rendering, which is
3756 much faster than YV12 on this card.
3760 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3765 .B 3dfx (Linux only)
3766 3dfx-specific video output driver that directly uses
3767 the hardware on top of X11.
3768 Only 16 bpp are supported.
3771 .B tdfxfb (Linux only)
3772 This driver employs the tdfxfb framebuffer driver to play movies with
3773 YUV acceleration on 3dfx cards.
3777 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3782 .B tdfx_vid (Linux only)
3783 3dfx-specific video output driver that works in combination with
3784 the tdfx_vid kernel module.
3788 Explicitly choose the device name to use (default: /dev/\:tdfx_vid).
3793 .B dxr2 (also see \-dxr2) (DXR2 only)
3794 Creative DXR2 specific video output driver.
3798 Output video subdriver to use as overlay (x11, xv).
3804 Sigma Designs em8300 MPEG decoder chip (Creative DXR3, Sigma Designs
3805 Hollywood Plus) specific video output driver.
3806 Also see the lavc video filter.
3810 Activates the overlay instead of TVOut.
3812 Turns on prebuffering.
3814 Will turn on the new sync-engine.
3816 Specifies the TV norm.
3818 0: Does not change current norm (default).
3820 1: Auto-adjust using PAL/\:NTSC.
3822 2: Auto-adjust using PAL/\:PAL-60.
3831 Specifies the device number to use if you have more than one em8300 card.
3837 Conexant CX23415 (iCompression iTVC15) or Conexant CX23416 (iCompression
3838 iTVC16) MPEG decoder chip (Hauppauge WinTV PVR-150/250/350/500)
3839 specific video output driver for TV-Out.
3840 Also see the lavc video filter.
3844 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
3846 Explicitly choose the TV-Out output to be used for the video signal.
3851 .B v4l2 (requires Linux 2.6.22+ kernel)
3852 Video output driver for V4L2 compliant cards with built-in hardware MPEG decoder.
3853 Also see the lavc video filter.
3857 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
3859 Explicitly choose the TV-Out output to be used for the video signal.
3864 .B mpegpes (DVB only)
3865 Video output driver for DVB cards that writes the output to an MPEG-PES file
3866 if no DVB card is installed.
3870 Specifies the device number to use if you have more than one DVB output card
3871 (V3 API only, such as 1.x.y series drivers).
3873 output filename (default: ./grab.mpg)
3878 .B zr (also see \-zr* and \-zrhelp)
3879 Video output driver for a number of MJPEG capture/\:playback cards.
3882 .B zr2 (also see the zrmjpeg video filter)
3883 Video output driver for a number of MJPEG capture/\:playback cards,
3888 Specifies the video device to use.
3889 .IPs norm=<PAL|NTSC|SECAM|auto>
3890 Specifies the video norm to use (default: auto).
3892 (De)Activate prebuffering, not yet supported.
3898 Calculate MD5 sums of each frame and write them to a file.
3899 Supports RGB24 and YV12 colorspaces.
3900 Useful for debugging.
3903 .IPs outfile=<value>
3904 Specify the output filename (default: ./md5sums).
3910 Transforms the video stream into a sequence of uncompressed YUV 4:2:0
3911 images and stores it in a file (default: ./stream.yuv).
3912 The format is the same as the one employed by mjpegtools, so this is
3913 useful if you want to process the video with the mjpegtools suite.
3914 It supports the YV12, RGB (24 bpp) and BGR (24 bpp) format.
3915 You can combine it with the \-fixed-vo option to concatenate files
3916 with the same dimensions and fps value.
3920 Write the output as interlaced frames, top field first.
3922 Write the output as interlaced frames, bottom field first.
3923 .IPs file=<filename>
3924 Write the output to <filename> instead of the default stream.yuv.
3930 If you do not specify any option the output is progressive
3931 (i.e.\& not interlaced).
3936 Output each frame into a single animated GIF file in the current directory.
3937 It supports only RGB format with 24 bpp and the output is converted to 256
3942 Float value to specify framerate (default: 5.0).
3944 Specify the output filename (default: ./out.gif).
3950 You must specify the framerate before the filename or the framerate will
3951 be part of the filename.
3957 mplayer video.nut \-vo gif89a:fps=15:output=test.gif
3963 Output each frame into a JPEG file in the current directory.
3964 Each file takes the frame number padded with leading zeros as name.
3967 .IPs [no]progressive
3968 Specify standard or progressive JPEG (default: noprogressive).
3970 Specify use of baseline or not (default: baseline).
3971 .IPs optimize=<0\-100>
3972 optimization factor (default: 100)
3973 .IPs smooth=<0\-100>
3974 smooth factor (default: 0)
3975 .IPs quality=<0\-100>
3976 quality factor (default: 75)
3977 .IPs outdir=<dirname>
3978 Specify the directory to save the JPEG files to (default: ./).
3979 .IPs subdirs=<prefix>
3980 Create numbered subdirectories with the specified prefix to
3981 save the files in instead of the current directory.
3982 .IPs "maxfiles=<value> (subdirs only)"
3983 Maximum number of files to be saved per subdirectory.
3984 Must be equal to or larger than 1 (default: 1000).
3990 Output each frame into a PNM file in the current directory.
3991 Each file takes the frame number padded with leading zeros as name.
3992 It supports PPM, PGM and PGMYUV files in both raw and ASCII mode.
3993 Also see pnm(5), ppm(5) and pgm(5).
3997 Write PPM files (default).
4002 PGMYUV is like PGM, but it also contains the U and V plane, appended at the
4003 bottom of the picture.
4005 Write PNM files in raw mode (default).
4007 Write PNM files in ASCII mode.
4008 .IPs outdir=<dirname>
4009 Specify the directory to save the PNM files to (default: ./).
4010 .IPs subdirs=<prefix>
4011 Create numbered subdirectories with the specified prefix to
4012 save the files in instead of the current directory.
4013 .IPs "maxfiles=<value> (subdirs only)"
4014 Maximum number of files to be saved per subdirectory.
4015 Must be equal to or larger than 1 (default: 1000).
4021 Output each frame into a PNG file in the current directory.
4022 Each file takes the frame number padded with leading zeros as name.
4023 24bpp RGB and BGR formats are supported.
4027 Specifies the compression level.
4028 0 is no compression, 9 is maximum compression.
4034 Output each frame into a Targa file in the current directory.
4035 Each file takes the frame number padded with leading zeros as name.
4036 The purpose of this video output driver is to have a simple lossless
4037 image writer to use without any external library.
4038 It supports the BGR[A] color format, with 15, 24 and 32 bpp.
4039 You can force a particular format with the format video filter.
4045 mplayer video.nut \-vf format=bgr15 \-vo tga
4051 .SH "DECODING/FILTERING OPTIONS"
4054 .B \-ac <[-|+]codec1,[-|+]codec2,...[,]>
4055 Specify a priority list of audio codecs to be used, according to their codec
4056 name in codecs.conf.
4057 Use a '-' before the codec name to omit it.
4058 Use a '+' before the codec name to force it, this will likely crash!
4059 If the list has a trailing ',' MPlayer will fall back on codecs not
4060 contained in the list.
4063 See \-ac help for a full list of available codecs.
4069 Force the l3codeca.acm MP3 codec.
4071 Try libmad first, then fall back on others.
4072 .IPs "\-ac hwac3,a52,"
4073 Try hardware AC-3 passthrough, software AC-3, then others.
4075 Try hardware DTS passthrough, then fall back on others.
4077 Skip FFmpeg's MP3 decoder.
4082 .B \-af-adv <force=(0\-7):list=(filters)> (also see \-af)
4083 Specify advanced audio filter options:
4086 Forces the insertion of audio filters to one of the following:
4088 0: Use completely automatic filter insertion.
4090 1: Optimize for accuracy (default).
4092 2: Optimize for speed.
4094 Some features in the audio filters may silently fail,
4095 and the sound quality may drop.
4097 3: Use no automatic insertion of filters and no optimization.
4099 It may be possible to crash MPlayer using this setting.
4101 4: Use automatic insertion of filters according to 0 above,
4102 but use floating point processing when possible.
4104 5: Use automatic insertion of filters according to 1 above,
4105 but use floating point processing when possible.
4107 6: Use automatic insertion of filters according to 2 above,
4108 but use floating point processing when possible.
4110 7: Use no automatic insertion of filters according to 3 above,
4111 and use floating point processing when possible.
4118 .B \-afm <driver1,driver2,...>
4119 Specify a priority list of audio codec families to be used, according
4120 to their codec name in codecs.conf.
4121 Falls back on the default codecs if none of the given codec families work.
4124 See \-afm help for a full list of available codec families.
4130 Try FFmpeg's libavcodec codecs first.
4131 .IPs "\-afm acm,dshow"
4132 Try Win32 codecs first.
4137 .B \-aspect <ratio> (also see \-zoom)
4138 Override movie aspect ratio, in case aspect information is
4139 incorrect or missing in the file being played.
4144 \-aspect 4:3 or \-aspect 1.3333
4146 \-aspect 16:9 or \-aspect 1.7777
4152 Disable automatic movie aspect ratio compensation.
4155 .B "\-field-dominance <-1\-1>"
4156 Set first field for interlaced content.
4157 Useful for deinterlacers that double the framerate: \-vf tfields=1,
4158 \-vf yadif=1 and \-vo xvmc:bobdeint.
4162 auto (default): If the decoder does not export the appropriate information,
4163 it falls back to 0 (top field first).
4173 Flip image upside-down.
4176 .B \-lavdopts <option1:option2:...> (DEBUG CODE)
4177 Specify libavcodec decoding parameters.
4178 Separate multiple options with a colon.
4183 \-lavdopts gray:skiploopfilter=all:skipframe=nonref
4188 Available options are:
4192 Only use bit-exact algorithms in all decoding steps (for codec testing).
4194 Manually work around encoder bugs.
4198 1: autodetect bugs (default)
4200 2 (msmpeg4v3): some old lavc generated msmpeg4v3 files (no autodetection)
4202 4 (mpeg4): Xvid interlacing bug (autodetected if fourcc==XVIX)
4204 8 (mpeg4): UMP4 (autodetected if fourcc==UMP4)
4206 16 (mpeg4): padding bug (autodetected)
4208 32 (mpeg4): illegal vlc bug (autodetected per fourcc)
4210 64 (mpeg4): Xvid and DivX qpel bug (autodetected per fourcc/\:version)
4212 128 (mpeg4): old standard qpel (autodetected per fourcc/\:version)
4214 256 (mpeg4): another qpel bug (autodetected per fourcc/\:version)
4216 512 (mpeg4): direct-qpel-blocksize bug (autodetected per fourcc/\:version)
4218 1024 (mpeg4): edge padding bug (autodetected per fourcc/\:version)
4221 Display debugging information.
4232 8: macroblock (MB) type
4234 16: per-block quantization parameter (QP)
4238 0x0040: motion vector visualization (use \-noslices)
4240 0x0080: macroblock (MB) skip
4246 0x0400: error resilience
4248 0x0800: memory management control operations (H.264)
4252 0x2000: Visualize quantization parameter (QP), lower QP are tinted greener.
4254 0x4000: Visualize block types.
4257 Set error concealment strategy.
4259 1: Use strong deblock filter for damaged MBs.
4261 2: iterative motion vector (MV) search (slow)
4266 Set error resilience strategy.
4271 1: careful (Should work with broken encoders.)
4273 2: normal (default) (Works with compliant encoders.)
4275 3: aggressive (More checks, but might cause problems even for valid bitstreams.)
4279 .IPs "fast (MPEG-2, MPEG-4, and H.264 only)"
4280 Enable optimizations which do not comply to the specification and might
4281 potentially cause problems, like simpler dequantization, simpler motion
4282 compensation, assuming use of the default quantization matrix, assuming
4283 YUV 4:2:0 and skipping a few checks to detect damaged bitstreams.
4285 grayscale only decoding (a bit faster than with color)
4286 .IPs "idct=<0\-99> (see \-lavcopts)"
4287 For best decoding quality use the same IDCT algorithm for decoding and encoding.
4288 This may come at a price in accuracy, though.
4289 .IPs lowres=<number>[,<w>]
4290 Decode at lower resolutions.
4291 Low resolution decoding is not supported by all codecs, and it will
4292 often result in ugly artifacts.
4293 This is not a bug, but a side effect of not decoding at full resolution.
4305 If <w> is specified lowres decoding will be used only if the width of the
4306 video is major than or equal to <w>.
4308 .IPs "sb=<number> (MPEG-2 only)"
4309 Skip the given number of macroblock rows at the bottom.
4310 .IPs "st=<number> (MPEG-2 only)"
4311 Skip the given number of macroblock rows at the top.
4312 .IPs "skiploopfilter=<skipvalue> (H.264 only)"
4313 Skips the loop filter (AKA deblocking) during H.264 decoding.
4314 Since the filtered frame is supposed to be used as reference
4315 for decoding dependent frames this has a worse effect on quality
4316 than not doing deblocking on e.g.\& MPEG-2 video.
4317 But at least for high bitrate HDTV this provides a big speedup with
4318 no visible quality loss.
4320 <skipvalue> can be either one of the following:
4325 default: Skip useless processing steps (e.g.\& 0 size packets in AVI).
4327 nonref: Skip frames that are not referenced (i.e.\& not used for
4328 decoding other frames, the error cannot "build up").
4330 bidir: Skip B-Frames.
4332 nonkey: Skip all frames except keyframes.
4334 all: Skip all frames.
4336 .IPs "skipidct=<skipvalue> (MPEG-1/2 only)"
4337 Skips the IDCT step.
4338 This degrades quality a lot of in almost all cases
4339 (see skiploopfilter for available skip values).
4340 .IPs skipframe=<skipvalue>
4341 Skips decoding of frames completely.
4342 Big speedup, but jerky motion and sometimes bad artifacts
4343 (see skiploopfilter for available skip values).
4344 .IPs "threads=<1\-8> (MPEG-1/2 only)"
4345 number of threads to use for decoding (default: 1)
4347 Visualize motion vectors.
4352 1: Visualize forward predicted MVs of P-frames.
4354 2: Visualize forward predicted MVs of B-frames.
4356 4: Visualize backward predicted MVs of B-frames.
4359 Prints some statistics and stores them in ./vstats_*.log.
4364 Disable drawing video by 16-pixel height slices/\:bands, instead draws the
4365 whole frame in a single run.
4366 May be faster or slower, depending on video card and available cache.
4367 It has effect only with libmpeg2 and libavcodec codecs.
4371 Do not play/\:encode sound.
4372 Useful for benchmarking.
4376 Do not play/\:encode video.
4377 In many cases this will not work, use \-vc null \-vo null instead.
4380 .B \-pp <quality> (also see \-vf pp)
4381 Set the DLL postprocess level.
4382 This option is no longer usable with \-vf pp.
4383 It only works with Win32 DirectShow DLLs with internal postprocessing routines.
4384 The valid range of \-pp values varies by codec, it is mostly
4385 0\-6, where 0=disable, 6=slowest/\:best.
4388 .B \-pphelp (also see \-vf pp)
4389 Show a summary about the available postprocess filters and their usage.
4393 Specifies software scaler parameters.
4398 \-vf scale \-ssf lgb=3.0
4404 gaussian blur filter (luma)
4406 gaussian blur filter (chroma)
4408 sharpen filter (luma)
4410 sharpen filter (chroma)
4412 chroma horizontal shifting
4414 chroma vertical shifting
4420 Select type of MP2/\:MP3 stereo output.
4433 .B \-sws <software scaler type> (also see \-vf scale and \-zoom)
4434 Specify the software scaler algorithm to be used with the \-zoom option.
4435 This affects video output drivers which lack hardware acceleration, e.g.\& x11.
4437 Available types are:
4446 bicubic (good quality) (default)
4450 nearest neighbor (bad quality)
4454 luma bicubic / chroma bilinear
4462 natural bicubic spline
4468 Some \-sws options are tunable.
4469 The description of the scale video filter has further information.
4473 .B \-vc <[-|+]codec1,[-|+]codec2,...[,]>
4474 Specify a priority list of video codecs to be used, according to their codec
4475 name in codecs.conf.
4476 Use a '-' before the codec name to omit it.
4477 Use a '+' before the codec name to force it, this will likely crash!
4478 If the list has a trailing ',' MPlayer will fall back on codecs not
4479 contained in the list.
4482 See \-vc help for a full list of available codecs.
4488 Force Win32/\:VfW DivX codec, no fallback.
4489 .IPs "\-vc -divxds,-divx,"
4490 Skip Win32 DivX codecs.
4491 .IPs "\-vc ffmpeg12,mpeg12,"
4492 Try libavcodec's MPEG-1/2 codec, then libmpeg2, then others.
4497 .B \-vfm <driver1,driver2,...>
4498 Specify a priority list of video codec families to be used, according
4499 to their names in codecs.conf.
4500 Falls back on the default codecs if none of the given codec families work.
4503 See \-vfm help for a full list of available codec families.
4508 .IPs "\-vfm ffmpeg,dshow,vfw"
4509 Try the libavcodec, then Directshow, then VfW codecs and fall back
4510 on others, if they do not work.
4512 Try XAnim codecs first.
4517 .B \-x <x> (also see \-zoom) (MPlayer only)
4518 Scale image to width <x> (if software/\:hardware scaling is available).
4519 Disables aspect calculations.
4522 .B \-xvidopts <option1:option2:...>
4523 Specify additional parameters when decoding with Xvid.
4526 Since libavcodec is faster than Xvid you might want to use the libavcodec
4527 postprocessing filter (\-vf pp) and decoder (\-vfm ffmpeg) instead.
4529 Xvid's internal postprocessing filters:
4532 .IPs "deblock-chroma (also see \-vf pp)"
4533 chroma deblock filter
4534 .IPs "deblock-luma (also see \-vf pp)"
4536 .IPs "dering-luma (also see \-vf pp)"
4537 luma deringing filter
4538 .IPs "dering-chroma (also see \-vf pp)"
4539 chroma deringing filter
4540 .IPs "filmeffect (also see \-vf noise)"
4541 Adds artificial film grain to the video.
4542 May increase perceived quality, while lowering true quality.
4551 Activate direct rendering method 2.
4553 Deactivate direct rendering method 2.
4558 .B \-xy <value> (also see \-zoom)
4562 Scale image by factor <value>.
4564 Set width to value and calculate height to keep correct aspect ratio.
4569 .B \-y <y> (also see \-zoom) (MPlayer only)
4570 Scale image to height <y> (if software/\:hardware scaling is available).
4571 Disables aspect calculations.
4575 Allow software scaling, where available.
4576 This will allow scaling with output drivers (like x11, fbdev) that
4577 do not support hardware scaling where MPlayer disables scaling by
4578 default for performance reasons.
4583 Audio filters allow you to modify the audio stream and its properties.
4587 .B \-af <filter1[=parameter1:parameter2:...],filter2,...>
4588 Setup a chain of audio filters.
4591 To get a full list of available audio filters, see \-af help.
4593 Available filters are:
4596 .B resample[=srate[:sloppy[:type]]]
4597 Changes the sample rate of the audio stream.
4598 Can be used if you have a fixed frequency sound card or if you are
4599 stuck with an old sound card that is only capable of max 44.1kHz.
4600 This filter is automatically enabled if necessary.
4601 It only supports 16-bit integer and float in native-endian format as input.
4604 With MEncoder, you need to also use \-srate <srate>.
4608 output sample frequency in Hz.
4609 The valid range for this parameter is 8000 to 192000.
4610 If the input and output sample frequency are the same or if this
4611 parameter is omitted the filter is automatically unloaded.
4612 A high sample frequency normally improves the audio quality,
4613 especially when used in combination with other filters.
4615 Allow (1) or disallow (0) the output frequency to differ slightly
4616 from the frequency given by <srate> (default: 1).
4617 Can be used if the startup of the playback is extremely slow.
4619 Selects which resampling method to use.
4621 0: linear interpolation (fast, poor quality especially when upsampling)
4623 1: polyphase filterbank and integer processing
4625 2: polyphase filterbank and floating point processing (slow, best quality)
4635 .IPs "mplayer \-af resample=44100:0:0"
4636 would set the output frequency of the resample filter to 44100Hz using
4637 exact output frequency scaling and linear interpolation.
4642 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
4643 Changes the sample rate of the audio stream to an integer <srate> in Hz.
4644 It only supports the 16-bit native-endian format.
4647 With MEncoder, you need to also use \-srate <srate>.
4651 the output sample rate
4653 length of the filter with respect to the lower sampling rate (default: 16)
4655 if 1 then filters will be linearly interpolated between polyphase entries
4657 log2 of the number of polyphase entries
4658 (..., 10->1024, 11->2048, 12->4096, ...)
4661 cutoff frequency (0.0-1.0), default set depending upon filter length
4667 Produces a sine sweep.
4671 Sine function delta, use very low values to hear the sweep.
4676 .B sinesuppress[=freq:decay]
4677 Remove a sine at the specified frequency.
4678 Useful to get rid of the 50/60Hz noise on low quality audio equipment.
4679 It probably only works on mono input.
4683 The frequency of the sine which should be removed (in Hz) (default: 50)
4685 Controls the adaptivity (a larger value will make the filter adapt to
4686 amplitude and phase changes quicker, a smaller value will make the
4687 adaptation slower) (default: 0.0001).
4688 Reasonable values are around 0.001.
4694 Head-related transfer function: Converts multichannel audio to
4695 2 channel output for headphones, preserving the spatiality of the sound.
4700 .IPs "m matrix decoding of the rear channel"
4701 .IPs "s 2-channel matrix decoding"
4702 .IPs "0 no matrix decoding (default)"
4707 .B equalizer=[g1:g2:g3:...:g10]
4708 10 octave band graphic equalizer, implemented using 10 IIR band pass filters.
4709 This means that it works regardless of what type of audio is being played back.
4710 The center frequencies for the 10 bands are:
4714 .IPs "No. frequency"
4729 If the sample rate of the sound being played is lower than the center
4730 frequency for a frequency band, then that band will be disabled.
4731 A known bug with this filter is that the characteristics for the
4732 uppermost band are not completely symmetric if the sample
4733 rate is close to the center frequency of that band.
4734 This problem can be worked around by upsampling the sound
4735 using the resample filter before it reaches this filter.
4739 .IPs <g1>:<g2>:<g3>:...:<g10>
4740 floating point numbers representing the gain in dB
4741 for each frequency band (-12\-12)
4748 .IPs "mplayer \-af equalizer=11:11:10:5:0:-12:0:5:12:12 media.avi"
4749 Would amplify the sound in the upper and lower frequency region
4750 while canceling it almost completely around 1kHz.
4755 .B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...]
4756 Can be used for adding, removing, routing and copying audio channels.
4757 If only <nch> is given the default routing is used, it works as
4758 follows: If the number of output channels is bigger than the number of
4759 input channels empty channels are inserted (except mixing from mono to
4760 stereo, then the mono channel is repeated in both of the output
4762 If the number of output channels is smaller than the number
4763 of input channels the exceeding channels are truncated.
4767 number of output channels (1\-6)
4769 number of routes (1\-6)
4770 .IPs <from1:to1:from2:to2:from3:to3:...>
4771 Pairs of numbers between 0 and 5 that define where to route each channel.
4778 .IPs "mplayer \-af channels=4:4:0:1:1:0:2:2:3:3 media.avi"
4779 Would change the number of channels to 4 and set up 4 routes that
4780 swap channel 0 and channel 1 and leave channel 2 and 3 intact.
4781 Observe that if media containing two channels was played back, channels
4782 2 and 3 would contain silence but 0 and 1 would still be swapped.
4783 .IPs "mplayer \-af channels=6:4:0:0:0:1:0:2:0:3 media.avi"
4784 Would change the number of channels to 6 and set up 4 routes
4785 that copy channel 0 to channels 0 to 3.
4786 Channel 4 and 5 will contain silence.
4787 .IPs "mplayer \-af channels=6:6:0:4:1:0:2:1:3:2:4:3:5:5 media.avi"
4788 Should make the 6-channel ffdca (DTS) output work correctly with ALSA.
4793 .B format[=format] (also see \-format)
4794 Convert between different sample formats.
4795 Automatically enabled when needed by the sound card or another filter.
4799 Sets the desired format.
4800 The general form is 'sbe', where 's' denotes the sign (either 's' for signed
4801 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32)
4802 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian
4803 and 'ne' the endianness of the computer MPlayer is running on).
4804 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'.
4805 Exceptions to this rule that are also valid format specifiers: u8, s8,
4806 floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm.
4812 Implements software volume control.
4813 Use this filter with caution since it can reduce the signal
4814 to noise ratio of the sound.
4815 In most cases it is best to set the level for the PCM sound to max,
4816 leave this filter out and control the output level to your
4817 speakers with the master volume control of the mixer.
4818 In case your sound card has a digital PCM mixer instead of an analog
4819 one, and you hear distortion, use the MASTER mixer instead.
4820 If there is an external amplifier connected to the computer (this
4821 is almost always the case), the noise level can be minimized by
4822 adjusting the master level and the volume knob on the amplifier
4823 until the hissing noise in the background is gone.
4825 This filter has a second feature: It measures the overall maximum
4826 sound level and prints out that level when MPlayer exits.
4827 This volume estimate can be used for setting the sound level in
4828 MEncoder such that the maximum dynamic range is utilized.
4831 This filter is not reentrant and can therefore only be enabled
4832 once for every audio stream.
4836 Sets the desired gain in dB for all channels in the stream
4837 from -200dB to +60dB, where -200dB mutes the sound
4838 completely and +60dB equals a gain of 1000 (default: 0).
4840 Turns soft clipping on (1) or off (0).
4841 Soft-clipping can make the sound more smooth if very
4842 high volume levels are used.
4843 Enable this option if the dynamic range of the
4844 loudspeakers is very low.
4847 This feature creates distortion and should be considered a last resort.
4854 .IPs "mplayer \-af volume=10.1:0 media.avi"
4855 Would amplify the sound by 10.1dB and hard-clip if the
4856 sound level is too high.
4861 .B pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...]
4862 Mixes channels arbitrarily.
4863 Basically a combination of the volume and the channels filter
4864 that can be used to down-mix many channels to only a few,
4865 e.g.\& stereo to mono or vary the "width" of the center
4866 speaker in a surround sound system.
4867 This filter is hard to use, and will require some tinkering
4868 before the desired result is obtained.
4869 The number of options for this filter depends on
4870 the number of output channels.
4871 An example how to downmix a six-channel file to two channels with
4872 this filter can be found in the examples section near the end.
4876 number of output channels (1\-6)
4878 How much of input channel i is mixed into output channel j (0\-1).
4879 So in principle you first have n numbers saying what to do with the
4880 first input channel, then n numbers that act on the second input channel
4882 If you do not specify any numbers for some input channels, 0 is assumed.
4889 .IPs "mplayer \-af pan=1:0.5:0.5 media.avi"
4890 Would down-mix from stereo to mono.
4891 .IPs "mplayer \-af pan=3:1:0:0.5:0:1:0.5 media.avi"
4892 Would give 3 channel output leaving channels 0 and 1 intact,
4893 and mix channels 0 and 1 into output channel 2 (which could
4894 be sent to a subwoofer for example).
4900 Adds a subwoofer channel to the audio stream.
4901 The audio data used for creating the subwoofer channel is
4902 an average of the sound in channel 0 and channel 1.
4903 The resulting sound is then low-pass filtered by a 4th order
4904 Butterworth filter with a default cutoff frequency of 60Hz
4905 and added to a separate channel in the audio stream.
4908 Disable this filter when you are playing DVDs with Dolby
4909 Digital 5.1 sound, otherwise this filter will disrupt
4910 the sound to the subwoofer.
4914 cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz)
4915 For the best result try setting the cutoff frequency as low as possible.
4916 This will improve the stereo or surround sound experience.
4918 Determines the channel number in which to insert the sub-channel audio.
4919 Channel number can be between 0 and 5 (default: 5).
4920 Observe that the number of channels will automatically
4921 be increased to <ch> if necessary.
4928 .IPs "mplayer \-af sub=100:4 \-channels 5 media.avi"
4929 Would add a sub-woofer channel with a cutoff frequency of
4930 100Hz to output channel 4.
4936 Creates a center channel from the front channels.
4937 May currently be low quality as it does not implement a
4938 high-pass filter for proper extraction yet, but averages and
4939 halves the channels instead.
4943 Determines the channel number in which to insert the center channel.
4944 Channel number can be between 0 and 5 (default: 5).
4945 Observe that the number of channels will automatically
4946 be increased to <ch> if necessary.
4952 Decoder for matrix encoded surround sound like Dolby Surround.
4953 Many files with 2 channel audio actually contain matrixed surround sound.
4954 Requires a sound card supporting at least 4 channels.
4958 delay time in ms for the rear speakers (0 to 1000) (default: 20)
4959 This delay should be set as follows: If d1 is the distance
4960 from the listening position to the front speakers and d2 is the distance
4961 from the listening position to the rear speakers, then the delay should
4962 be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2.
4969 .IPs "mplayer \-af surround=15 \-channels 4 media.avi"
4970 Would add surround sound decoding with 15ms delay for the sound to the
4976 .B delay[=ch1:ch2:...]
4977 Delays the sound to the loudspeakers such that the sound from the
4978 different channels arrives at the listening position simultaneously.
4979 It is only useful if you have more than 2 loudspeakers.
4983 The delay in ms that should be imposed on each channel
4984 (floating point number between 0 and 1000).
4989 To calculate the required delay for the different channels do as follows:
4991 Measure the distance to the loudspeakers in meters in relation
4992 to your listening position, giving you the distances s1 to s5
4994 There is no point in compensating for the subwoofer (you will not hear the
4997 Subtract the distances s1 to s5 from the maximum distance,
4998 i.e.\& s[i] = max(s) - s[i]; i = 1...5.
5000 Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5.
5008 .IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi"
5009 Would delay front left and right by 10.5ms, the two rear channels
5010 and the sub by 0ms and the center channel by 7ms.
5015 .B export[=mmapped_file[:nsamples]]
5016 Exports the incoming signal to other processes using memory mapping (mmap()).
5017 Memory mapped areas contain a header:
5020 int nch /*number of channels*/
5021 int size /*buffer size*/
5022 unsigned long long counter /*Used to keep sync, updated every
5023 time new data is exported.*/
5026 The rest is payload (non-interleaved) 16 bit data.
5030 file to map data to (default: ~/.mplayer/\:mplayer-af_export)
5032 number of samples per channel (default: 512)
5039 .IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi"
5040 Would export 1024 samples per channel to '/tmp/mplayer-af_export'.
5045 .B extrastereo[=mul]
5046 (Linearly) increases the difference between left and right channels
5047 which adds some sort of "live" effect to playback.
5051 Sets the difference coefficient (default: 2.5).
5052 0.0 means mono sound (average of both channels), with 1.0 sound will be
5053 unchanged, with -1.0 left and right channels will be swapped.
5058 .B volnorm[=method:target]
5059 Maximizes the volume without distorting the sound.
5063 Sets the used method.
5065 1: Use a single sample to smooth the variations via the standard
5066 weighted mean over past samples (default).
5068 2: Use several samples to smooth the variations via the standard
5069 weighted mean over past samples.
5072 Sets the target amplitude as a fraction of the maximum for the
5073 sample type (default: 0.25).
5078 .B ladspa=file:label[:controls...]
5079 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
5080 This filter is reentrant, so multiple LADSPA plugins can be used at once.
5084 Specifies the LADSPA plugin library file.
5085 If LADSPA_PATH is set, it searches for the specified file.
5086 If it is not set, you must supply a fully specified pathname.
5088 Specifies the filter within the library.
5089 Some libraries contain only one filter, but others contain many of them.
5090 Entering 'help' here, will list all available filters within the specified
5091 library, which eliminates the use of 'listplugins' from the LADSPA SDK.
5093 Controls are zero or more floating point values that determine the
5094 behavior of the loaded plugin (for example delay, threshold or gain).
5095 In verbose mode (add \-v to the MPlayer command line), all available controls
5096 and their valid ranges are printed.
5097 This eliminates the use of 'analyseplugin' from the LADSPA SDK.
5103 Compressor/expander filter usable for microphone input.
5104 Prevents artifacts on very loud sound and raises the volume on
5106 This filter is untested, maybe even unusable.
5110 Noise gate filter similar to the comp audio filter.
5111 This filter is untested, maybe even unusable.
5115 Simple voice removal filter exploiting the fact that voice is
5116 usually recorded with mono gear and later 'center' mixed onto
5117 the final audio stream.
5118 Beware that this filter will turn your signal into mono.
5119 Works well for 2 channel tracks; do not bother trying it
5120 on anything but 2 channel stereo.
5125 Video filters allow you to modify the video stream and its properties.
5129 .B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
5130 Setup a chain of video filters.
5132 Many parameters are optional and set to default values if omitted.
5133 To explicitly use a default value set a parameter to '-1'.
5134 Parameters w:h means width x height in pixels, x:y means x;y position counted
5135 from the upper left corner of the bigger image.
5138 To get a full list of available video filters, see \-vf help.
5140 Video filters are managed in lists.
5141 There are a few commands to manage the filter list.
5144 .B \-vf-add <filter1[,filter2,...]>
5145 Appends the filters given as arguments to the filter list.
5148 .B \-vf-pre <filter1[,filter2,...]>
5149 Prepends the filters given as arguments to the filter list.
5152 .B \-vf-del <index1[,index2,...]>
5153 Deletes the filters at the given indexes.
5154 Index numbers start at 0, negative numbers address the end of the
5155 list (-1 is the last).
5159 Completely empties the filter list.
5161 With filters that support it, you can access parameters by their name.
5164 .B \-vf <filter>=help
5165 Prints the parameter names and parameter value ranges for a particular
5169 .B \-vf <filter=named_parameter1=value1[:named_parameter2=value2:...]>
5170 Sets a named parameter to the given value.
5171 Use on and off or yes and no to set flag parameters.
5173 Available filters are:
5177 Crops the given part of the image and discards the rest.
5178 Useful to remove black bands from widescreen movies.
5182 Cropped width and height, defaults to original width and height.
5184 Position of the cropped picture, defaults to center.
5189 .B cropdetect[=limit:round]
5190 Calculates necessary cropping parameters and prints the recommended parameters
5195 Threshold, which can be optionally specified from nothing (0) to
5196 everything (255) (default: 24).
5199 Value which the width/\:height should be divisible by (default: 16).
5200 The offset is automatically adjusted to center the video.
5201 Use 2 to get only even dimensions (needed for 4:2:2 video).
5202 16 is best when encoding to most video codecs.
5207 .B rectangle[=w:h:x:y]
5208 The plugin responds to the input.conf directive 'change_rectangle'
5209 that takes two parameters.
5213 width and height (default: -1, maximum possible width where boundaries
5216 top left corner position (default: -1, uppermost leftmost)
5221 .B expand[=w:h:x:y:o:a:r]
5222 Expands (not scales) movie resolution to the given value and places the
5223 unscaled original at coordinates x, y.
5224 Can be used for placing subtitles/\:OSD in the resulting black bands.
5227 Expanded width,height (default: original width,height).
5228 Negative values for w and h are treated as offsets to the original size.
5233 .IP expand=0:-50:0:0
5234 Adds a 50 pixel border to the bottom of the picture.
5238 position of original image on the expanded image (default: center)
5240 OSD/\:subtitle rendering
5242 0: disable (default)
5247 Expands to fit an aspect instead of a resolution (default: 0).
5252 .IP expand=800:::::4/3
5253 Expands to 800x600, unless the source is higher resolution, in which
5254 case it expands to fill a 4/3 aspect.
5258 Rounds up to make both width and height divisible by <r> (default: 1).
5262 .B flip (also see \-flip)
5263 Flips the image upside down.
5267 Mirrors the image on the Y axis.
5271 Rotates the image by 90 degrees and optionally flips it.
5272 For values between 4\-7 rotation is only done if the movie geometry is
5273 portrait and not landscape.
5276 Rotate by 90 degrees clockwise and flip (default).
5278 Rotate by 90 degrees clockwise.
5280 Rotate by 90 degrees counterclockwise.
5282 Rotate by 90 degrees counterclockwise and flip.
5286 .B scale[=w:h[:ilaced[:chr_drop[:par[:par2[:presize[:noup[:arnd]]]]]]]]
5287 Scales the image with the software scaler (slow) and performs a YUV<\->RGB
5288 colorspace conversion (also see \-sws).
5291 scaled width/\:height (default: original width/\:height)
5294 If \-zoom is used, and underlying filters (including libvo) are
5295 incapable of scaling, it defaults to d_width/\:d_height!
5297 0: scaled d_width/\:d_height
5299 -1: original width/\:height
5301 -2: Calculate w/h using the other dimension and the prescaled aspect ratio.
5303 -3: Calculate w/h using the other dimension and the original aspect ratio.
5305 -(n+8): Like -n above, but rounding the dimension to the closest multiple of 16.
5308 Toggle interlaced scaling.
5317 0: Use all available input lines for chroma.
5319 1: Use only every 2. input line for chroma.
5321 2: Use only every 4. input line for chroma.
5323 3: Use only every 8. input line for chroma.
5325 .IPs "<par>[:<par2>] (also see \-sws)"
5326 Set some scaling parameters depending on the type of scaler selected
5329 \-sws 2 (bicubic): B (blurring) and C (ringing)
5333 0.00:0.75 VirtualDub's "precise bicubic"
5335 0.00:0.50 Catmull-Rom spline
5337 0.33:0.33 Mitchell-Netravali spline
5339 1.00:0.00 cubic B-spline
5341 \-sws 7 (gaussian): sharpness (0 (soft) \- 100 (sharp))
5343 \-sws 9 (lanczos): filter length (1\-10)
5346 Scale to preset sizes.
5348 qntsc: 352x240 (NTSC quarter screen)
5350 qpal: 352x288 (PAL quarter screen)
5352 ntsc: 720x480 (standard NTSC)
5354 pal: 720x576 (standard PAL)
5356 sntsc: 640x480 (square pixel NTSC)
5358 spal: 768x576 (square pixel PAL)
5361 Disallow upscaling past the original dimensions.
5363 0: Allow upscaling (default).
5365 1: Disallow upscaling if one dimension exceeds its original value.
5367 2: Disallow upscaling if both dimensions exceed their original values.
5370 Accurate rounding for the vertical scaler, which may be faster
5371 or slower than the default rounding.
5373 0: Disable accurate rounding (default).
5375 1: Enable accurate rounding.
5380 .B dsize[=aspect|w:h:aspect-method:r]
5381 Changes the intended display size/\:aspect at an arbitrary point in the
5383 Aspect can be given as a fraction (4/3) or floating point number
5385 Alternatively, you may specify the exact display width and height
5387 Note that this filter does
5389 do any scaling itself; it just affects
5390 what later scalers (software or hardware) will do when auto-scaling to
5394 New display width and height.
5395 Can also be these special values:
5397 0: original display width and height
5399 -1: original video width and height (default)
5401 -2: Calculate w/h using the other dimension and the original display
5404 -3: Calculate w/h using the other dimension and the original video
5412 Specifies a display resolution of 800x600 for a 4/3 aspect video, or
5413 800x450 for a 16/9 aspect video.
5415 .IPs <aspect-method>
5416 Modifies width and height according to original aspect ratios.
5418 -1: Ignore original aspect ratio (default).
5420 0: Keep display aspect ratio by using <w> and <h> as maximum
5423 1: Keep display aspect ratio by using <w> and <h> as minimum
5426 2: Keep video aspect ratio by using <w> and <h> as maximum
5429 3: Keep video aspect ratio by using <w> and <h> as minimum
5437 Specifies a display resolution of at most 800x600, or smaller, in order
5442 Rounds up to make both width and height divisible by <r> (default: 1).
5447 Forces software YV12/\:I420/\:422P to YUY2 conversion.
5448 Useful for video cards/\:drivers with slow YV12 but fast YUY2 support.
5452 Forces software YVU9 to YV12 colorspace conversion.
5453 Deprecated in favor of the software scaler.
5457 Clamps YUV color values to the CCIR 601 range without doing real conversion.
5461 RGB 24/32 <\-> BGR 24/32 colorspace conversion.
5465 Also perform R <-> B swapping.
5471 RGB/BGR 8 \-> 15/16/24/32bpp colorspace conversion using palette.
5475 Restricts the colorspace for the next filter without doing any conversion.
5476 Use together with the scale filter for a real conversion.
5479 For a list of available formats see format=fmt=help.
5483 format name like rgb15, bgr24, yv12, etc (default: yuy2)
5488 .B noformat[=fourcc]
5489 Restricts the colorspace for the next filter without doing any conversion.
5490 Unlike the format filter, this will allow any colorspace
5492 the one you specify.
5495 For a list of available formats see noformat=fmt=help.
5499 format name like rgb15, bgr24, yv12, etc (default: yv12)
5504 .B pp[=filter1[:option1[:option2...]]/[-]filter2...] (also see \-pphelp)
5505 Enables the specified chain of postprocessing subfilters.
5506 Subfilters must be separated by '/' and can be disabled by
5508 Each subfilter and some options have a short and a long name that can be
5509 used interchangeably, i.e.\& dr/dering are the same.
5510 All subfilters share common options to determine their scope:
5514 Automatically switch the subfilter off if the CPU is too slow.
5516 Do chrominance filtering, too (default).
5518 Do luminance filtering only (no chrominance).
5520 Do chrominance filtering only (no luminance).
5527 \-pphelp shows a list of available subfilters.
5529 Available subfilters are
5532 .IPs hb/hdeblock[:difference[:flatness]]
5533 horizontal deblocking filter
5535 <difference>: Difference factor where higher values mean
5536 more deblocking (default: 32).
5538 <flatness>: Flatness threshold where lower values mean
5539 more deblocking (default: 39).
5541 .IPs vb/vdeblock[:difference[:flatness]]
5542 vertical deblocking filter
5544 <difference>: Difference factor where higher values mean
5545 more deblocking (default: 32).
5547 <flatness>: Flatness threshold where lower values mean
5548 more deblocking (default: 39).
5550 .IPs ha/hadeblock[:difference[:flatness]]
5551 accurate horizontal deblocking filter
5553 <difference>: Difference factor where higher values mean
5554 more deblocking (default: 32).
5556 <flatness>: Flatness threshold where lower values mean
5557 more deblocking (default: 39).
5559 .IPs va/vadeblock[:difference[:flatness]]
5560 accurate vertical deblocking filter
5562 <difference>: Difference factor where higher values mean
5563 more deblocking (default: 32).
5565 <flatness>: Flatness threshold where lower values mean
5566 more deblocking (default: 39).
5569 The horizontal and vertical deblocking filters share the
5570 difference and flatness values so you cannot set
5571 different horizontal and vertical thresholds.
5574 experimental horizontal deblocking filter
5576 experimental vertical deblocking filter
5579 .IPs tn/tmpnoise[:threshold1[:threshold2[:threshold3]]]
5580 temporal noise reducer
5582 <threshold1>: larger -> stronger filtering
5584 <threshold2>: larger -> stronger filtering
5586 <threshold3>: larger -> stronger filtering
5588 .IPs al/autolevels[:f/fullyrange]
5589 automatic brightness / contrast correction
5591 f/fullyrange: Stretch luminance to (0\-255).
5593 .IPs lb/linblenddeint
5594 Linear blend deinterlacing filter that deinterlaces the given block
5595 by filtering all lines with a (1 2 1) filter.
5596 .IPs li/linipoldeint
5597 Linear interpolating deinterlacing filter that deinterlaces the given block
5598 by linearly interpolating every second line.
5599 .IPs ci/cubicipoldeint
5600 Cubic interpolating deinterlacing filter deinterlaces the given block
5601 by cubically interpolating every second line.
5603 Median deinterlacing filter that deinterlaces the given block
5604 by applying a median filter to every second line.
5606 FFmpeg deinterlacing filter that deinterlaces the given block
5607 by filtering every second line with a (-1 4 2 4 -1) filter.
5609 Vertically applied FIR lowpass deinterlacing filter that deinterlaces
5610 the given block by filtering all lines with a (-1 2 6 2 -1) filter.
5611 .IPs fq/forceQuant[:quantizer]
5612 Overrides the quantizer table from the input with the constant
5613 quantizer you specify.
5615 <quantizer>: quantizer to use
5618 default pp filter combination (hb:a,vb:a,dr:a)
5620 fast pp filter combination (h1:a,v1:a,dr:a)
5622 high quality pp filter combination (ha:a:128:7,va:a,dr:a)
5630 .IPs "\-vf pp=hb/vb/dr/al"
5631 horizontal and vertical deblocking, deringing and automatic
5632 brightness/\:contrast
5633 .IPs "\-vf pp=de/-al"
5634 default filters without brightness/\:contrast correction
5635 .IPs "\-vf pp=default/tmpnoise:1:2:3"
5636 Enable default filters & temporal denoiser.
5637 .IPs "\-vf pp=hb:y/vb:a"
5638 Horizontal deblocking on luminance only, and switch vertical deblocking
5639 on or off automatically depending on available CPU time.
5644 .B spp[=quality[:qp[:mode]]]
5645 Simple postprocessing filter that compresses and decompresses the
5646 image at several (or \- in the case of quality level 6 \- all)
5647 shifts and averages the results.
5652 Force quantization parameter (default: 0, use QP from video).
5654 0: hard thresholding (default)
5656 1: soft thresholding (better deringing, but blurrier)
5658 4: like 0, but also use B-frames' QP (may cause flicker)
5660 5: like 1, but also use B-frames' QP (may cause flicker)
5664 .B uspp[=quality[:qp]]
5665 Ultra simple & slow postprocessing filter that compresses and
5666 decompresses the image at several (or \- in the case of quality
5667 level 8 \- all) shifts and averages the results.
5668 The way this differs from the behavior of spp is that uspp actually
5669 encodes & decodes each case with libavcodec Snow, whereas spp uses
5670 a simplified intra only 8x8 DCT similar to MJPEG.
5675 Force quantization parameter (default: 0, use QP from video).
5679 .B fspp[=quality[:qp[:strength[:bframes]]]]
5680 faster version of the simple postprocessing filter
5683 4\-5 (equivalent to spp; default: 4)
5685 Force quantization parameter (default: 0, use QP from video).
5687 Filter strength, lower values mean more details but also more artifacts,
5688 while higher values make the image smoother but also blurrier (default:
5691 0: do not use QP from B-frames (default)
5693 1: use QP from B-frames too (may cause flicker)
5698 Variant of the spp filter, similar to spp=6 with 7 point DCT where
5699 only the center sample is used after IDCT.
5702 Force quantization parameter (default: 0, use QP from video).
5704 0: hard thresholding
5706 1: soft thresholding (better deringing, but blurrier)
5708 2: medium thresholding (default, good results)
5713 quantization parameter (QP) change filter
5716 some equation like "2+2*sin(PI*qp)"
5721 generic equation change filter
5724 Some equation, e.g.\& 'p(W-X\\,Y)' to flip the image horizontally.
5725 You can use whitespace to make the equation more readable.
5726 There are a couple of constants that can be used in the equation:
5732 X / Y: the coordinates of the current sample
5734 W / H: width and height of the image
5736 SW / SH: width/height scale depending on the currently filtered plane, e.g.\&
5737 1,1 and 0.5,0.5 for YUV 4:2:0.
5739 p(x,y): returns the value of the pixel at location x/y of the current plane.
5745 Generate various test patterns.
5749 Generate an RGB test pattern useful for detecting RGB vs BGR issues.
5750 You should see a red, green and blue stripe from top to bottom.
5753 .B lavc[=quality:fps]
5754 Fast software YV12 to MPEG-1 conversion with libavcodec for use with DVB/\:DXR3/\:IVTV/\:V4L2.
5759 32\-: fixed bitrate in kbits
5761 force output fps (float value) (default: 0, autodetect based on height)
5765 .B dvbscale[=aspect]
5766 Set up optimal scaling for DVB cards, scaling the x axis in hardware and
5767 calculating the y axis scaling in software to keep aspect.
5768 Only useful together with expand and scale.
5771 Control aspect ratio, calculate as DVB_HEIGHT*ASPECTRATIO (default:
5772 576*4/3=768), set it to 576*(16/9)=1024 for a 16:9 TV.
5780 .IPs "\-vf dvbscale,scale=-1:0,expand=-1:576:-1:-1:1,lavc"
5781 FIXME: Explain what this does.
5786 .B noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]]
5795 uniform noise (gaussian otherwise)
5797 temporal noise (noise pattern changes between frames)
5799 averaged temporal noise (smoother, but a lot slower)
5801 high quality (slightly better looking, slightly slower)
5803 mix random noise with a (semi)regular pattern
5808 .B denoise3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
5809 This filter aims to reduce image noise producing smooth images and making still
5810 images really still (This should enhance compressibility.).
5814 spatial luma strength (default: 4)
5815 .IPs <chroma_spatial>
5816 spatial chroma strength (default: 3)
5818 luma temporal strength (default: 6)
5820 chroma temporal strength (default: luma_tmp*chroma_spatial/luma_spatial)
5825 .B hqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
5826 High precision/\:quality version of the denoise3d filter.
5827 Parameters and usage are the same.
5830 .B eq[=brightness:contrast] (OBSOLETE)
5831 Software equalizer with interactive controls just like the hardware
5832 equalizer, for cards/\:drivers that do not support brightness and
5833 contrast controls in hardware.
5834 Might also be useful with MEncoder, either for fixing poorly captured
5835 movies, or for slightly reducing contrast to mask artifacts and get by
5836 with lower bitrates.
5847 .B eq2[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]
5848 Alternative software equalizer that uses lookup tables (very slow),
5849 allowing gamma correction in addition to simple brightness
5850 and contrast adjustment.
5851 Note that it uses the same MMX optimized code as \-vf eq if all
5852 gamma values are 1.0.
5853 The parameters are given as floating point values.
5857 initial gamma value (default: 1.0)
5859 initial contrast, where negative values result in a
5860 negative image (default: 1.0)
5862 initial brightness (default: 0.0)
5864 initial saturation (default: 1.0)
5866 gamma value for the red component (default: 1.0)
5868 gamma value for the green component (default: 1.0)
5870 gamma value for the blue component (default: 1.0)
5872 The weight parameter can be used to reduce the effect of a high gamma value on
5873 bright image areas, e.g.\& keep them from getting overamplified and just plain
5875 A value of 0.0 turns the gamma correction all the way down while 1.0 leaves it
5876 at its full strength (default: 1.0).
5881 .B hue[=hue:saturation]
5882 Software equalizer with interactive controls just like the hardware
5883 equalizer, for cards/\:drivers that do not support hue and
5884 saturation controls in hardware.
5888 initial hue (default: 0.0)
5890 initial saturation, where negative values result
5891 in a negative chroma (default: 1.0)
5897 Convert planar YUV 4:2:0 to half-height packed 4:2:2, downsampling luma but
5898 keeping all chroma samples.
5899 Useful for output to low-resolution display devices when hardware downscaling
5900 is poor quality or is not available.
5901 Can also be used as a primitive luma-only deinterlacer with very low CPU
5906 By default, halfpack averages pairs of lines when downsampling.
5907 Any value different from 0 or 1 gives the default (averaging) behavior.
5909 0: Only use even lines when downsampling.
5911 1: Only use odd lines when downsampling.
5918 When interlaced video is stored in YUV 4:2:0 formats, chroma
5919 interlacing does not line up properly due to vertical downsampling of
5920 the chroma channels.
5921 This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format with
5922 the chroma lines in their proper locations, so that in any given
5923 scanline, the luma and chroma data both come from the same field.
5927 Select the sampling mode.
5929 0: nearest-neighbor sampling, fast but incorrect
5931 1: linear interpolation (default)
5938 Only useful with MEncoder.
5939 If harddup is used when encoding, it will force duplicate frames to be
5940 encoded in the output.
5941 This uses slightly more space, but is necessary for output to MPEG
5942 files or if you plan to demux and remux the video stream after
5944 Should be placed at or near the end of the filter chain unless you
5945 have a good reason to do otherwise.
5949 Only useful with MEncoder.
5950 Softskip moves the frame skipping (dropping) step of encoding from
5951 before the filter chain to some point during the filter chain.
5952 This allows filters which need to see all frames (inverse telecine,
5953 temporal denoising, etc.) to function properly.
5954 Should be placed after the filters which need to see all frames and
5955 before any subsequent filters that are CPU-intensive.
5958 .B decimate[=max:hi:lo:frac]
5959 Drops frames that do not differ greatly from the previous frame in
5960 order to reduce framerate.
5961 The main use of this filter is for very-low-bitrate encoding (e.g.\&
5962 streaming over dialup modem), but it could in theory be used for
5963 fixing movies that were inverse-telecined incorrectly.
5967 Sets the maximum number of consecutive frames which can be
5968 dropped (if positive), or the minimum interval between
5969 dropped frames (if negative).
5970 .IPs <hi>,<lo>,<frac>
5971 A frame is a candidate for dropping if no 8x8 region differs by more
5972 than a threshold of <hi>, and if not more than <frac> portion (1
5973 meaning the whole image) differs by more than a threshold of <lo>.
5974 Values of <hi> and <lo> are for 8x8 pixel blocks and represent actual
5975 pixel value differences, so a threshold of 64 corresponds to 1 unit of
5976 difference for each pixel, or the same spread out differently over the
5982 .B dint[=sense:level]
5983 The drop-deinterlace (dint) filter detects and drops the first from a set
5984 of interlaced video frames.
5988 relative difference between neighboring pixels (default: 0.1)
5990 What part of the image has to be detected as interlaced to
5991 drop the frame (default: 0.15).
5996 .B lavcdeint (OBSOLETE)
5997 FFmpeg deinterlacing filter, same as \-vf pp=fd
6000 .B kerndeint[=thresh[:map[:order[:sharp[:twoway]]]]]
6001 Donald Graft's adaptive kernel deinterlacer.
6002 Deinterlaces parts of a video if a configurable threshold is exceeded.
6006 threshold (default: 10)
6009 0: Ignore pixels exceeding the threshold (default).
6011 1: Paint pixels exceeding the threshold white.
6015 0: Leave fields alone (default).
6021 0: Disable additional sharpening (default).
6023 1: Enable additional sharpening.
6027 0: Disable twoway sharpening (default).
6029 1: Enable twoway sharpening.
6035 .B unsharp[=l|cWxH:amount[:l|cWxH:amount]]
6036 unsharp mask / gaussian blur
6039 Apply effect on luma component.
6041 Apply effect on chroma components.
6042 .IPs <width>x<height>
6043 width and height of the matrix, odd sized in both directions
6044 (min = 3x3, max = 13x11 or 11x13, usually something between 3x3 and 7x7)
6046 Relative amount of sharpness/\:blur to add to the image
6047 (a sane range should be -1.5\-1.5).
6060 .B il[=d|i][s][:[d|i][s]]
6061 (De)interleaves lines.
6062 The goal of this filter is to add the ability to process interlaced images
6063 pre-field without deinterlacing them.
6064 You can filter your interlaced DVD and play it on a TV without breaking the
6066 While deinterlacing (with the postprocessing filter) removes interlacing
6067 permanently (by smoothing, averaging, etc) deinterleaving splits the frame into
6068 2 fields (so called half pictures), so you can process (filter) them
6069 independently and then re-interleave them.
6073 deinterleave (placing one above the other)
6077 swap fields (exchange even & odd lines)
6083 (De)interleaves lines.
6084 This filter is very similar to the il filter but much faster, the main
6085 disadvantage is that it does not always work.
6086 Especially if combined with other filters it may produce randomly messed
6087 up images, so be happy if it works but do not complain if it does not for
6088 your combination of filters.
6092 Deinterleave fields, placing them side by side.
6094 Interleave fields again (reversing the effect of fil=d).
6100 Extracts a single field from an interlaced image using stride arithmetic
6101 to avoid wasting CPU time.
6102 The optional argument n specifies whether to extract the even or the odd
6103 field (depending on whether n is even or odd).
6106 .B detc[=var1=value1:var2=value2:...]
6107 Attempts to reverse the 'telecine' process to recover a clean,
6108 non-interlaced stream at film framerate.
6109 This was the first and most primitive inverse telecine filter to be
6110 added to MPlayer/\:MEncoder.
6111 It works by latching onto the telecine 3:2 pattern and following it as
6113 This makes it suitable for perfectly-telecined material, even in the
6114 presence of a fair degree of noise, but it will fail in the presence
6115 of complex post-telecine edits.
6116 Development on this filter is no longer taking place, as ivtc, pullup,
6117 and filmdint are better for most applications.
6118 The following arguments (see syntax above) may be used to control
6122 Set the frame dropping mode.
6124 0: Do not drop frames to maintain fixed output framerate (default).
6126 1: Always drop a frame when there have been no drops or telecine
6127 merges in the past 5 frames.
6129 2: Always maintain exact 5:4 input to output frame ratio.
6132 Use mode 1 or 2 with MEncoder.
6137 0: Fixed pattern with initial frame number specified by <fr>.
6139 1: aggressive search for telecine pattern (default)
6142 Set initial frame number in sequence.
6143 0\-2 are the three clean progressive frames; 3 and 4 are the two
6145 The default, -1, means 'not in telecine sequence'.
6146 The number specified here is the type for the imaginary previous
6147 frame before the movie starts.
6148 .IPs "<t0>, <t1>, <t2>, <t3>"
6149 Threshold values to be used in certain modes.
6154 Experimental 'stateless' inverse telecine filter.
6155 Rather than trying to lock on to a pattern like the detc filter does,
6156 ivtc makes its decisions independently for each frame.
6157 This will give much better results for material that has undergone
6158 heavy editing after telecine was applied, but as a result it is not as
6159 forgiving of noisy input, for example TV capture.
6160 The optional parameter (ivtc=1) corresponds to the dr=1 option for the
6161 detc filter, and should be used with MEncoder but not with MPlayer.
6162 As with detc, you must specify the correct output framerate (\-ofps
6163 24000/1001) when using MEncoder.
6164 Further development on ivtc has stopped, as the pullup and filmdint
6165 filters appear to be much more accurate.
6168 .B pullup[=jl:jr:jt:jb:sb:mp]
6169 Third-generation pulldown reversal (inverse telecine) filter,
6170 capable of handling mixed hard-telecine, 24000/1001 fps progressive, and 30000/1001
6171 fps progressive content.
6172 The pullup filter is designed to be much more robust than detc or
6173 ivtc, by taking advantage of future context in making its decisions.
6174 Like ivtc, pullup is stateless in the sense that it does not lock onto
6175 a pattern to follow, but it instead looks forward to the following
6176 fields in order to identify matches and rebuild progressive frames.
6177 It is still under development, but believed to be quite accurate.
6179 .IPs "jl, jr, jt, and jb"
6180 These options set the amount of "junk" to ignore at
6181 the left, right, top, and bottom of the image, respectively.
6182 Left/\:right are in units of 8 pixels, while top/\:bottom are in units of
6184 The default is 8 pixels on each side.
6186 .IPs "sb (strict breaks)"
6187 Setting this option to 1 will reduce the chances of
6188 pullup generating an occasional mismatched frame, but it may also
6189 cause an excessive number of frames to be dropped during high motion
6191 Conversely, setting it to -1 will make pullup match fields more
6193 This may help processing of video where there is slight blurring
6194 between the fields, but may also cause there to be interlaced frames
6197 .IPs "mp (metric plane)"
6198 This option may be set to 1 or 2 to use a chroma
6199 plane instead of the luma plane for doing pullup's computations.
6200 This may improve accuracy on very clean source material, but more
6201 likely will decrease accuracy, especially if there is chroma noise
6202 (rainbow effect) or any grayscale video.
6203 The main purpose of setting mp to a chroma plane is to reduce CPU load
6204 and make pullup usable in realtime on slow machines.
6209 Always follow pullup with the softskip filter when encoding to ensure
6210 that pullup is able to see each frame.
6211 Failure to do so will lead to incorrect output and will usually crash,
6212 due to design limitations in the codec/\:filter layer.
6216 .B filmdint[=options]
6217 Inverse telecine filter, similar to the pullup filter above.
6218 It is designed to handle any pulldown pattern, including mixed soft and
6219 hard telecine and limited support for movies that are slowed down or sped
6220 up from their original framerate for TV.
6221 Only the luma plane is used to find the frame breaks.
6222 If a field has no match, it is deinterlaced with simple linear
6224 If the source is MPEG-2, this must be the first filter to allow
6225 access to the field-flags set by the MPEG-2 decoder.
6226 Depending on the source MPEG, you may be fine ignoring this advice, as
6227 long as you do not see lots of "Bottom-first field" warnings.
6228 With no options it does normal inverse telecine, and should be used
6229 together with mencoder \-fps 30000/1001 \-ofps 24000/1001.
6230 When this filter is used with mplayer, it will result in an uneven
6231 framerate during playback, but it is still generally better than using
6232 pp=lb or no deinterlacing at all.
6233 Multiple options can be specified separated by /.
6235 .IPs crop=<w>:<h>:<x>:<y>
6236 Just like the crop filter, but faster, and works on mixed hard and soft
6237 telecined content as well as when y is not a multiple of 4.
6238 If x or y would require cropping fractional pixels from the chroma
6239 planes, the crop area is extended.
6240 This usually means that x and y must be even.
6241 .IPs io=<ifps>:<ofps>
6242 For each ifps input frames the filter will output ofps frames.
6243 The ratio of ifps/\:ofps should match the \-fps/\-ofps ratio.
6244 This could be used to filter movies that are broadcast on TV at a frame
6245 rate different from their original framerate.
6247 If n is nonzero, the chroma plane is copied unchanged.
6248 This is useful for YV12 sampled TV, which discards one of the chroma
6251 On x86, if n=1, use MMX2 optimized functions, if n=2, use 3DNow!
6252 optimized functions, otherwise, use plain C.
6253 If this option is not specified, MMX2 and 3DNow! are auto-detected, use
6254 this option to override auto-detection.
6256 The larger n will speed up the filter at the expense of accuracy.
6257 The default value is n=3.
6258 If n is odd, a frame immediately following a frame marked with the
6259 REPEAT_FIRST_FIELD MPEG flag is assumed to be progressive, thus filter
6260 will not spend any time on soft-telecined MPEG-2 content.
6261 This is the only effect of this flag if MMX2 or 3DNow! is available.
6262 Without MMX2 and 3DNow, if n=0 or 1, the same calculations will be used
6264 If n=2 or 3, the number of luma levels used to find the frame breaks is
6265 reduced from 256 to 128, which results in a faster filter without losing
6267 If n=4 or 5, a faster, but much less accurate metric will be used to
6268 find the frame breaks, which is more likely to misdetect high vertical
6269 detail as interlaced content.
6271 If n is nonzero, print the detailed metrics for each frame.
6272 Useful for debugging.
6274 Deinterlace threshold.
6275 Used during de-interlacing of unmatched frames.
6276 Larger value means less deinterlacing, use n=256 to completely turn off
6280 Threshold for comparing a top and bottom fields.
6283 Threshold to detect temporal change of a field.
6286 Sum of Absolute Difference threshold, default is 64.
6291 This filter works only correct with MEncoder and acts on the MPEG-2 flags
6292 used for soft 3:2 pulldown (soft telecine).
6293 If you want to use the ivtc or detc filter on movies that are partly soft
6294 telecined, inserting this filter before them should make them more reliable.
6298 Inverse telecine for deinterlaced video.
6299 If 3:2-pulldown telecined video has lost one of the fields or is deinterlaced
6300 using a method that keeps one field and interpolates the other, the result is
6301 a juddering video that has every fourth frame duplicated.
6302 This filter is intended to find and drop those duplicates and restore the
6303 original film framerate.
6304 When using this filter, you must specify \-ofps that is 4/5 of
6305 the fps of the input file and place the softskip later in the
6306 filter chain to make sure that divtc sees all the frames.
6307 Two different modes are available:
6308 One pass mode is the default and is straightforward to use,
6309 but has the disadvantage that any changes in the telecine
6310 phase (lost frames or bad edits) cause momentary judder
6311 until the filter can resync again.
6312 Two pass mode avoids this by analyzing the whole video
6313 beforehand so it will have forward knowledge about the
6314 phase changes and can resync at the exact spot.
6317 correspond to pass one and two of the encoding process.
6318 You must run an extra pass using divtc pass one before the
6319 actual encoding throwing the resulting video away.
6320 Use \-nosound \-ovc raw \-o /dev/null to avoid
6321 wasting CPU power for this pass.
6322 You may add something like crop=2:2:0:0 after divtc
6323 to speed things up even more.
6324 Then use divtc pass two for the actual encoding.
6325 If you use multiple encoder passes, use divtc
6326 pass two for all of them.
6331 .IPs file=<filename>
6332 Set the two pass log filename (default: "framediff.log").
6333 .IPs threshold=<value>
6334 Set the minimum strength the telecine pattern must have for the filter to
6335 believe in it (default: 0.5).
6336 This is used to avoid recognizing false pattern from the parts of the video
6337 that are very dark or very still.
6338 .IPs window=<numframes>
6339 Set the number of past frames to look at when searching for pattern
6341 Longer window improves the reliability of the pattern search, but shorter
6342 window improves the reaction time to the changes in the telecine phase.
6343 This only affects the one pass mode.
6344 The two pass mode currently uses fixed window that extends to both future
6346 .IPs phase=0|1|2|3|4
6347 Sets the initial telecine phase for one pass mode (default: 0).
6348 The two pass mode can see the future, so it is able to use the correct
6349 phase from the beginning, but one pass mode can only guess.
6350 It catches the correct phase when it finds it, but this option can be used
6351 to fix the possible juddering at the beginning.
6352 The first pass of the two pass mode also uses this, so if you save the output
6353 from the first pass, you get constant phase result.
6354 .IPs deghost=<value>
6355 Set the deghosting threshold (0\-255 for one pass mode, -255\-255 for two pass
6357 If nonzero, deghosting mode is used.
6358 This is for video that has been deinterlaced by blending the fields
6359 together instead of dropping one of the fields.
6360 Deghosting amplifies any compression artifacts in the blended frames, so the
6361 parameter value is used as a threshold to exclude those pixels from
6362 deghosting that differ from the previous frame less than specified value.
6363 If two pass mode is used, then negative value can be used to make the
6364 filter analyze the whole video in the beginning of pass-2 to determine
6365 whether it needs deghosting or not and then select either zero or the
6366 absolute value of the parameter.
6367 Specify this option for pass-2, it makes no difference on pass-1.
6371 .B phase[=t|b|p|a|u|T|B|A|U][:v]
6372 Delay interlaced video by one field time so that the field order
6374 The intended use is to fix PAL movies that have been captured with the
6375 opposite field order to the film-to-video transfer.
6379 Capture field order top-first, transfer bottom-first.
6380 Filter will delay the bottom field.
6382 Capture bottom-first, transfer top-first.
6383 Filter will delay the top field.
6385 Capture and transfer with the same field order.
6386 This mode only exists for the documentation of the other options to refer to,
6387 but if you actually select it, the filter will faithfully do nothing ;-)
6389 Capture field order determined automatically by field flags, transfer opposite.
6390 Filter selects among t and b modes on a frame by frame basis using field flags.
6391 If no field information is available, then this works just like u.
6393 Capture unknown or varying, transfer opposite.
6394 Filter selects among t and b on a frame by frame basis by analyzing the
6395 images and selecting the alternative that produces best match between the
6398 Capture top-first, transfer unknown or varying.
6399 Filter selects among t and p using image analysis.
6401 Capture bottom-first, transfer unknown or varying.
6402 Filter selects among b and p using image analysis.
6404 Capture determined by field flags, transfer unknown or varying.
6405 Filter selects among t, b and p using field flags and image analysis.
6406 If no field information is available, then this works just like U.
6407 This is the default mode.
6409 Both capture and transfer unknown or varying.
6410 Filter selects among t, b and p using image analysis only.
6413 Prints the selected mode for each frame and the average squared difference
6414 between fields for t, b, and p alternatives.
6419 Apply 3:2 'telecine' process to increase framerate by 20%.
6420 This most likely will not work correctly with MPlayer, but it can
6421 be used with 'mencoder \-fps 30000/1001 \-ofps 30000/1001 \-vf telecine'.
6422 Both fps options are essential!
6423 (A/V sync will break if they are wrong.)
6424 The optional start parameter tells the filter where in the telecine
6425 pattern to start (0\-3).
6428 .B tinterlace[=mode]
6429 Temporal field interlacing \- merge pairs of frames into an interlaced
6430 frame, halving the framerate.
6431 Even frames are moved into the upper field, odd frames to the lower field.
6432 This can be used to fully reverse the effect of the tfields filter (in mode 0).
6433 Available modes are:
6437 Move odd frames into the upper field, even into the lower field, generating
6438 a full-height frame at half framerate.
6440 Only output odd frames, even frames are dropped; height unchanged.
6442 Only output even frames, odd frames are dropped; height unchanged.
6444 Expand each frame to full height, but pad alternate lines with black;
6445 framerate unchanged.
6447 Interleave even lines from even frames with odd lines from odd frames.
6448 Height unchanged at half framerate.
6453 .B tfields[=mode[:field_dominance]]
6454 Temporal field separation \- split fields into frames, doubling the
6456 Like the telecine filter, tfields will only work properly with
6457 MEncoder, and only if both \-fps and \-ofps are set to the
6458 desired (double) framerate!
6462 0: Leave fields unchanged (will jump/\:flicker).
6464 1: Interpolate missing lines. (The algorithm used might not be so good.)
6466 2: Translate fields by 1/4 pixel with linear interpolation (no jump).
6468 4: Translate fields by 1/4 pixel with 4tap filter (higher quality) (default).
6469 .IPs <field_dominance>\ (DEPRECATED)
6471 Only works if the decoder exports the appropriate information and
6472 no other filters which discard that information come before tfields
6473 in the filter chain, otherwise it falls back to 0 (top field first).
6477 1: bottom field first
6480 This option will possibly be removed in a future version.
6481 Use \-field-dominance instead.
6486 .B yadif=[mode[:field_dominance]]
6487 Yet another deinterlacing filter
6491 0: Output 1 frame for each frame.
6493 1: Output 1 frame for each field.
6495 2: Like 0 but skips spatial interlacing check.
6497 3: Like 1 but skips spatial interlacing check.
6498 .IPs <field_dominance>\ (DEPRECATED)
6499 Operates like tfields.
6502 This option will possibly be removed in a future version.
6503 Use \-field-dominance instead.
6508 .B mcdeint=[mode[:parity[:qp]]]
6509 Motion compensating deinterlacer.
6510 It needs one field per frame as input and must thus be used together
6511 with tfields=1 or yadif=1/3 or equivalent.
6519 2: slow, iterative motion estimation
6521 3: extra slow, like 2 plus multiple reference frames
6523 0 or 1 selects which field to use (note: no autodetection yet!).
6525 Higher values should result in a smoother motion vector
6526 field but less optimal individual vectors.
6531 .B boxblur=radius:power[:radius:power]
6536 blur filter strength
6538 number of filter applications
6543 .B sab=radius:pf:colorDiff[:radius:pf:colorDiff]
6548 blur filter strength (~0.1\-4.0) (slower if larger)
6550 prefilter strength (~0.1\-2.0)
6552 maximum difference between pixels to still be considered (~0.1\-100.0)
6557 .B smartblur=radius:strength:threshold[:radius:strength:threshold]
6562 blur filter strength (~0.1\-5.0) (slower if larger)
6564 blur (0.0\-1.0) or sharpen (-1.0\-0.0)
6566 filter all (0), filter flat areas (0\-30) or filter edges (-30\-0)
6571 .B perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
6572 Correct the perspective of movies not filmed perpendicular to the screen.
6576 coordinates of the top left, top right, bottom left, bottom right corners
6578 linear (0) or cubic resampling (1)
6584 Scale and smooth the image with the 2x scale and interpolate algorithm.
6588 1bpp bitmap to YUV/\:BGR 8/\:15/\:16/\:32 conversion
6591 .B down3dright[=lines]
6592 Reposition and resize stereoscopic images.
6593 Extracts both stereo fields and places them side by side, resizing
6594 them to maintain the original movie aspect.
6598 number of lines to select from the middle of the image (default: 12)
6603 .B bmovl=hidden:opaque:fifo
6604 The bitmap overlay filter reads bitmaps from a FIFO and displays them
6605 on top of the movie, allowing some transformations on the image.
6606 Also see TOOLS/bmovl-test.c for a small bmovl test program.
6610 Set the default value of the 'hidden' flag (0=visible, 1=hidden).
6612 Set the default value of the 'opaque' flag (0=transparent, 1=opaque).
6614 path/\:filename for the FIFO (named pipe connecting 'mplayer \-vf bmovl' to the
6615 controlling application)
6624 .IPs "RGBA32 width height xpos ypos alpha clear"
6625 followed by width*height*4 Bytes of raw RGBA32 data.
6626 .IPs "ABGR32 width height xpos ypos alpha clear"
6627 followed by width*height*4 Bytes of raw ABGR32 data.
6628 .IPs "RGB24 width height xpos ypos alpha clear"
6629 followed by width*height*3 Bytes of raw RGB24 data.
6630 .IPs "BGR24 width height xpos ypos alpha clear"
6631 followed by width*height*3 Bytes of raw BGR24 data.
6632 .IPs "ALPHA width height xpos ypos alpha"
6633 Change alpha transparency of the specified area.
6634 .IPs "CLEAR width height xpos ypos"
6637 Disable all alpha transparency.
6638 Send "ALPHA 0 0 0 0 0" to enable it again.
6651 .IPs "<width>, <height>"
6653 .IPs "<xpos>, <ypos>"
6654 Start blitting at position x/y.
6656 Set alpha difference.
6657 If you set this to -255 you can then send a sequence of ALPHA-commands to set
6658 the area to -225, -200, -175 etc for a nice fade-in-effect! ;)
6662 255: Make everything opaque.
6664 -255: Make everything transparent.
6667 Clear the framebuffer before blitting.
6669 0: The image will just be blitted on top of the old one, so you do not need to
6670 send 1.8MB of RGBA32 data every time a small part of the screen is updated.
6678 .B framestep=I|[i]step
6679 Renders only every nth frame or every intra frame (keyframe).
6681 If you call the filter with I (uppercase) as the parameter, then
6683 keyframes are rendered.
6684 For DVDs it generally means one in every 15/12 frames (IBBPBBPBBPBBPBB),
6685 for AVI it means every scene change or every keyint value (see \-lavcopts
6686 keyint= value if you use MEncoder to encode the video).
6688 When a keyframe is found, an 'I!' string followed by a newline character is
6689 printed, leaving the current line of MPlayer/\:MEncoder output on the screen,
6690 because it contains the time (in seconds) and frame number of the keyframe
6691 (You can use this information to split the AVI.).
6693 If you call the filter with a numeric parameter 'step' then only one in
6694 every 'step' frames is rendered.
6696 If you put an 'i' (lowercase) before the number then an 'I!' is printed
6697 (like the I parameter).
6699 If you give only the i then nothing is done to the frames, only I! is
6703 .B tile=xtiles:ytiles:output:start:delta
6704 Tile a series of images into a single, bigger image.
6705 If you omit a parameter or use a value less than 0, then the default
6707 You can also stop when you are satisfied (... \-vf tile=10:5 ...).
6708 It is probably a good idea to put the scale filter before the tile :-)
6715 number of tiles on the x axis (default: 5)
6717 number of tiles on the y axis (default: 5)
6719 Render the tile when 'output' number of frames are reached, where 'output'
6720 should be a number less than xtile * ytile.
6721 Missing tiles are left blank.
6722 You could, for example, write an 8 * 7 tile every 50 frames to have one
6723 image every 2 seconds @ 25 fps.
6725 outer border thickness in pixels (default: 2)
6727 inner border thickness in pixels (default: 4)
6732 .B delogo[=x:y:w:h:t]
6733 Suppresses a TV station logo by a simple interpolation of the
6735 Just set a rectangle covering the logo and watch it disappear (and
6736 sometimes something even uglier appear \- your mileage may vary).
6740 top left corner of the logo
6742 width and height of the cleared rectangle
6744 Thickness of the fuzzy edge of the rectangle (added to w and h).
6745 When set to -1, a green rectangle is drawn on the screen to
6746 simplify finding the right x,y,w,h parameters.
6751 .B remove-logo=/path/to/logo_bitmap_file_name.pgm
6752 Suppresses a TV station logo, using a PGM or PPM image
6753 file to determine which pixels comprise the logo.
6754 The width and height of the image file must match
6755 those of the video stream being processed.
6756 Uses the filter image and a circular blur
6757 algorithm to remove the logo.
6759 .IPs /path/to/logo_bitmap_file_name.pgm
6760 [path] + filename of the filter image.
6764 .B zrmjpeg[=options]
6765 Software YV12 to MJPEG encoder for use with the zr2 video
6768 .IPs maxheight=<h>|maxwidth=<w>
6769 These options set the maximum width and height the zr card
6770 can handle (the MPlayer filter layer currently cannot query those).
6771 .IPs {dc10+,dc10,buz,lml33}-{PAL|NTSC}
6772 Use these options to set maxwidth and maxheight automatically to the
6773 values known for card/\:mode combo.
6774 For example, valid options are: dc10-PAL and buz-NTSC (default: dc10+PAL)
6776 Select color or black and white encoding.
6777 Black and white encoding is faster.
6778 Color is the default.
6780 Horizontal decimation 1, 2 or 4.
6782 Vertical decimation 1, 2 or 4.
6784 Set JPEG compression quality [BEST] 1 \- 20 [VERY BAD].
6786 By default, decimation is only performed if the Zoran hardware
6787 can upscale the resulting MJPEG images to the original size.
6788 The option fd instructs the filter to always perform the requested
6794 Allows acquiring screenshots of the movie using slave mode
6795 commands that can be bound to keypresses.
6796 See the slave mode documentation and the INTERACTIVE CONTROL
6797 section for details.
6798 Files named 'shotNNNN.png' will be saved in the working directory,
6799 using the first available number - no files will be overwritten.
6800 The filter has no overhead when not used and accepts an arbitrary
6801 colorspace, so it is safe to add it to the configuration file.
6806 Moves SSA/ASS subtitle rendering to an arbitrary point in the filter chain.
6807 Only useful with the \-ass option.
6812 .IPs "\-vf ass,screenshot"
6813 Moves SSA/ASS rendering before the screenshot filter.
6814 Screenshots taken this way will contain subtitles.
6819 .B blackframe[=amount:threshold]
6820 Detect frames that are (almost) completely black.
6821 Can be useful to detect chapter transitions or commercials.
6822 Output lines consist of the frame number of the detected frame, the
6823 percentage of blackness, the frame type and the frame number of the last
6824 encountered keyframe.
6827 Percentage of the pixels that have to be below the threshold (default: 98).
6829 Threshold below which a pixel value is considered black (default: 32).
6834 .SH "GENERAL ENCODING OPTIONS (MENCODER ONLY)"
6837 .B \-audio-delay <any floating-point number>
6838 Delays either audio or video by setting a delay field in the header
6840 This does not delay either stream while encoding, but the player will
6841 see the delay field and compensate accordingly.
6842 Positive values delay the audio, and negative values delay the video.
6843 Note that this is the exact opposite of the \-delay option.
6844 For example, if a video plays correctly with \-delay 0.2, you can
6845 fix the video with MEncoder by using \-audio-delay -0.2.
6847 Currently, this option only works with the default muxer (\-of avi).
6848 If you are using a different muxer, then you must use \-delay instead.
6851 .B \-audio-density <1\-50>
6852 Number of audio chunks per second (default is 2 for 0.5s long audio chunks).
6855 CBR only, VBR ignores this as it puts each packet in a new chunk.
6858 .B \-audio-preload <0.0\-2.0>
6859 Sets up the audio buffering time interval (default: 0.5s).
6862 .B \-fafmttag <format>
6863 Can be used to override the audio format tag of the output file.
6868 .IPs "\-fafmttag 0x55"
6869 Will have the output file contain 0x55 (mp3) as audio format tag.
6874 .B \-ffourcc <fourcc>
6875 Can be used to override the video fourcc of the output file.
6880 .IPs "\-ffourcc div3"
6881 Will have the output file contain 'div3' as video fourcc.
6886 .B \-force-avi-aspect <0.2\-3.0>
6887 Override the aspect stored in the AVI OpenDML vprp header.
6888 This can be used to change the aspect ratio with '\-ovc copy'.
6891 .B \-frameno-file <filename> (DEPRECATED)
6892 Specify the name of the audio file with framenumber mappings created in
6893 the first (audio only) pass of a special three pass encoding mode.
6896 Using this mode will most likely give you A-V desync.
6898 It is kept for backwards compatibility only and will possibly
6899 be removed in a future version.
6903 Use a more precise, but much slower method for skipping areas.
6904 Areas marked for skipping are not seeked over, instead all
6905 frames are decoded, but only the necessary frames are encoded.
6906 This allows starting at non-keyframe boundaries.
6909 Not guaranteed to work right with '\-ovc copy'.
6912 .B \-info <option1:option2:...> (AVI only)
6913 Specify the info header of the resulting AVI file.
6915 Available options are:
6918 Show this description.
6922 artist or author of the work
6924 original work category
6925 .IPs subject=<value>
6926 contents of the work
6927 .IPs copyright=<value>
6928 copyright information
6929 .IPs srcform=<value>
6930 original format of the digitized material
6931 .IPs comment=<value>
6932 general comments about the work
6937 Do not automatically insert the expand filter into the MEncoder filter chain.
6938 Useful to control at which point of the filter chain subtitles are rendered
6939 when hardcoding subtitles onto a movie.
6943 Do not attempt to encode duplicate frames in duplicate; always output
6944 zero-byte frames to indicate duplicates.
6945 Zero-byte frames will be written anyway unless a filter or encoder
6946 capable of doing duplicate encoding is loaded.
6947 Currently the only such filter is harddup.
6950 .B \-noodml (\-of avi only)
6951 Do not write OpenDML index for AVI files >1GB.
6959 Outputs to the given filename.
6961 If you want a default output filename, you can put this option in the
6962 MEncoder config file.
6965 .B \-oac <codec name>
6966 Encode with the given audio codec (no default set).
6969 Use \-oac help to get a list of available audio codecs.
6975 no encoding, just streamcopy
6977 Encode to uncompressed PCM.
6978 .IPs "\-oac mp3lame"
6979 Encode to MP3 (using LAME).
6981 Encode with a libavcodec codec.
6986 .B \-of <format> (BETA CODE!)
6987 Encode to the specified container format (default: AVI).
6990 Use \-of help to get a list of available container formats.
6998 Encode to MPEG (also see \-mpegopts).
7000 Encode with libavformat muxers (also see \-lavfopts).
7001 .IPs "\-of rawvideo"
7002 raw video stream (no muxing \- one video stream only)
7003 .IPs "\-of rawaudio"
7004 raw audio stream (no muxing \- one audio stream only)
7010 Specify a frames per second (fps) value for the output file,
7011 which can be different from that of the source material.
7012 Must be set for variable fps (ASF, some MOV) and progressive
7013 (30000/1001 fps telecined MPEG) files.
7016 .B \-ovc <codec name>
7017 Encode with the given video codec (no default set).
7020 Use \-ovc help to get a list of available video codecs.
7026 no encoding, just streamcopy
7028 Encode to an arbitrary uncompressed format (use '\-vf format' to select).
7030 Encode with a libavcodec codec.
7035 .B \-passlogfile <filename>
7036 Dump first pass information to <filename> instead of the default divx2pass.log
7037 in two pass encoding mode.
7040 .B \-skiplimit <value>
7041 Specify the maximum number of frames that may be skipped after
7042 encoding one frame (\-noskiplimit for unlimited).
7045 .B \-vobsubout <basename>
7046 Specify the basename for the output .idx and .sub files.
7047 This turns off subtitle rendering in the encoded movie and diverts it to
7048 VOBsub subtitle files.
7051 .B \-vobsuboutid <langid>
7052 Specify the language two letter code for the subtitles.
7053 This overrides what is read from the DVD or the .ifo file.
7056 .B \-vobsuboutindex <index>
7057 Specify the index of the subtitles in the output files (default: 0).
7061 .SH "CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY)"
7062 You can specify codec specific encoding parameters using the following
7066 .B \-<codec>opts <option1[=value],option2,...>
7069 Where <codec> may be: lavc, xvidenc, lame, toolame, twolame,
7070 nuv, xvfw, faac, x264enc, mpeg, lavf.
7073 .SS lame (\-lameopts)
7081 variable bitrate method
7104 Also forces CBR mode encoding on subsequent ABR presets modes.
7108 bitrate in kbps (CBR and ABR only)
7112 quality (0 \- highest, 9 \- lowest) (VBR only)
7116 algorithmic quality (0 \- best/slowest, 9 \- worst/fastest)
7157 Switch on faster encoding on subsequent VBR presets modes.
7158 This results in slightly lower quality and higher bitrates.
7161 .B highpassfreq=<freq>
7162 Set a highpass filtering frequency in Hz.
7163 Frequencies below the specified one will be cut off.
7164 A value of -1 will disable filtering, a value of 0
7165 will let LAME choose values automatically.
7168 .B lowpassfreq=<freq>
7169 Set a lowpass filtering frequency in Hz.
7170 Frequencies above the specified one will be cut off.
7171 A value of -1 will disable filtering, a value of 0
7172 will let LAME choose values automatically.
7179 Print additional options and information about presets settings.
7181 VBR encoding, good quality, 150\-180 kbps bitrate range
7183 VBR encoding, high quality, 170\-210 kbps bitrate range
7185 VBR encoding, very high quality, 200\-240 kbps bitrate range
7187 CBR encoding, highest preset quality, 320 kbps bitrate
7189 ABR encoding at average given kbps bitrate
7197 .IPs fast:preset=standard
7198 suitable for most people and most music types and already quite high quality
7200 Encode with ABR presets at a 192 kbps forced constant bitrate.
7202 Encode with ABR presets at a 172 kbps average bitrate.
7204 for people with extremely good hearing and similar equipment
7209 .SS toolame and twolame (\-toolameopts and \-twolameopts respectively)
7213 In CBR mode this parameter indicates the bitrate in kbps,
7214 when in VBR mode it is the minimum bitrate allowed per frame.
7215 VBR mode will not work with a value below 112.
7218 .B vbr=<-50\-50> (VBR only)
7219 variability range; if negative the encoder shifts the average bitrate
7220 towards the lower limit, if positive towards the higher.
7221 When set to 0 CBR is used (default).
7224 .B maxvbr=<32\-384> (VBR only)
7225 maximum bitrate allowed per frame, in kbps
7228 .B mode=<stereo | jstereo | mono | dual>
7229 (default: mono for 1-channel audio, stereo otherwise)
7233 psychoacoustic model (default: 2)
7237 Include error protection.
7246 .SS faac (\-faacopts)
7250 average bitrate in kbps (mutually exclusive with quality)
7253 .B quality=<1\-1000>
7254 quality mode, the higher the better (mutually exclusive with br)
7258 object type complexity
7268 LTP (extremely slow)
7274 MPEG version (default: 4)
7278 Enables temporal noise shaping.
7281 .B cutoff=<0\-sampling_rate/2>
7282 cutoff frequency (default: sampling_rate/2)
7286 Stores the bitstream as raw payload with extradata in the container header
7287 (default: 0, corresponds to ADTS).
7288 Do not set this flag if not explicitly required or you will not be able to
7289 remux the audio stream later on.
7294 .SS lavc (\-lavcopts)
7296 Many libavcodec (lavc for short) options are tersely documented.
7297 Read the source for full details.
7302 .IPs vcodec=msmpeg4:vbitrate=1800:vhq:keyint=250
7308 audio codec (default: mp2)
7312 Dolby Digital (AC-3)
7314 Adaptive PCM formats - see the HTML documentation for details.
7316 Free Lossless Audio Codec (FLAC)
7320 3GPP Adaptive Multi-Rate (AMR) narrow-band
7322 3GPP Adaptive Multi-Rate (AMR) wide-band
7324 Advanced Audio Coding (AAC) - using FAAC
7326 MPEG-1 audio layer 3 (MP3) - using LAME
7328 MPEG-1 audio layer 2 (MP2)
7330 PCM formats - see the HTML documentation for details.
7332 Id Software RoQ DPCM
7334 experimental simple lossy codec
7336 experimental simple lossless codec
7340 Windows Media Audio v1
7342 Windows Media Audio v2
7348 audio bitrate in kbps (default: 224)
7352 Use the specified Windows audio format tag (e.g.\& atag=0x55).
7356 Use only bit exact algorithms (except (I)DCT).
7357 Additionally bit_exact disables several optimizations and thus
7358 should only be used for regression tests, which need binary
7359 identical files even if the encoder version changes.
7360 This also suppresses the user_data header in MPEG-4 streams.
7361 Do not use this option unless you know exactly what you are doing.
7365 Maximum number of threads to use (default: 1).
7366 May have a slight negative effect on motion estimation.
7371 Employ the specified codec (default: mpeg4).
7381 FFmpeg's lossless video codec
7383 nonstandard 20% smaller HuffYUV using YV12
7385 Sorenson H.263 used in Flash Video
7397 x264 H.264/AVC MPEG-4 Part 10
7399 Xvid MPEG-4 Part 2 (ASP)
7415 ID Software RoQ Video
7417 an old RealVideo codec
7418 .IPs "snow (also see: vstrict)"
7419 FFmpeg's experimental wavelet-based codec
7421 Apple Sorenson Video 1
7423 Windows Media Video, version 1 (AKA WMV7)
7425 Windows Media Video, version 2 (AKA WMV8)
7431 minimum quantizer (pass 1/2)
7434 Not recommended (much larger file, little quality difference and weird side
7435 effects: msmpeg4, h263 will be very low quality, ratecontrol will be confused
7436 resulting in lower quality and some decoders will not be able to decode it).
7438 Recommended for normal mpeg4/\:mpeg1video encoding (default).
7440 Recommended for h263(p)/\:msmpeg4.
7441 The reason for preferring 3 over 2 is that 2 could lead to overflows.
7442 (This will be fixed for h263(p) by changing the quantizer per MB in
7443 the future, msmpeg4 cannot be fixed as it does not support that.)
7447 .B lmin=<0.01\-255.0>
7448 Minimum frame-level Lagrange multiplier for ratecontrol (default: 2.0).
7449 Lavc will rarely use quantizers below the value of lmin.
7450 Lowering lmin will make lavc more likely to choose lower quantizers for
7451 some frames, but not lower than the value of vqmin.
7452 Likewise, raising lmin will make lavc less likely to choose low
7453 quantizers, even if vqmin would have allowed them.
7454 You probably want to set lmin approximately equal to vqmin.
7455 When adaptive quantization is in use, changing lmin/lmax may have less
7456 of an effect; see mblmin/mblmax.
7460 .B lmax=<0.01\-255.0>
7461 maximum Lagrange multiplier for ratecontrol (default: 31.0)
7465 .B mblmin=<0.01\-255.0>
7466 Minimum macroblock-level Lagrange multiplier for ratecontrol
7468 This parameter affects adaptive quantization options like qprd,
7473 .B mblmax=<0.01\-255.0>
7474 Maximum macroblock-level Lagrange multiplier for ratecontrol
7480 Constant quantizer /\: constant quality encoding (selects fixed quantizer mode).
7481 A lower value means better quality but larger files (default: -1).
7482 In case of snow codec, value 0 means lossless encoding.
7483 Since the other codecs do not support this, vqscale=0 will have an undefined
7485 1 is not recommended (see vqmin for details).
7489 Maximum quantizer (pass 1/2), 10\-31 should be a sane range (default: 31).
7501 maximum quantizer difference between consecutive I- or P-frames
7502 (pass 1/2) (default: 3)
7505 .B vmax_b_frames=<0\-4>
7506 maximum number of B-frames between non-B-frames:
7510 no B-frames (default)
7512 sane range for MPEG-4
7518 motion estimation method.
7519 Available methods are:
7523 none (very low quality)
7525 full (slow, currently unmaintained and disabled)
7527 log (low quality, currently unmaintained and disabled)
7529 phods (low quality, currently unmaintained and disabled)
7531 EPZS: size=1 diamond, size can be adjusted with the *dia options
7534 X1 (experimental, currently aliased to EPZS)
7536 iter (iterative overlapped block, only used in snow)
7543 0\-3 currently ignores the amount of bits spent,
7544 so quality may be low.
7548 .B me_range=<0\-9999>
7549 motion estimation search range (default: 0 (unlimited))
7552 .B mbd=<0\-2> (see also *cmp, qpel)
7553 Macroblock decision algorithm (high quality mode), encode each macro
7554 block in all modes and choose the best.
7555 This is slow but results in better quality and file size.
7556 When mbd is set to 1 or 2, the value of mbcmp is ignored when comparing
7558 If any comparison setting (precmp, subcmp, cmp, or mbcmp) is nonzero,
7559 however, a slower but better half-pel motion search will be used,
7560 regardless of what mbd is set to.
7561 If qpel is set, quarter-pel motion search will be used regardless.
7565 Use comparison function given by mbcmp (default).
7567 Select the MB mode which needs the fewest bits (=vhq).
7569 Select the MB mode which has the best rate distortion.
7575 Same as mbd=1, kept for compatibility reasons.
7579 Allow 4 motion vectors per macroblock (slightly better quality).
7580 Works better if used with mbd>0.
7584 overlapped block motion compensation (H.263+)
7588 loop filter (H.263+)
7589 note, this is broken
7592 .B inter_threshold <-1000\-1000>
7593 Does absolutely nothing at the moment.
7597 maximum interval between keyframes in frames (default: 250 or one
7598 keyframe every ten seconds in a 25fps movie.
7599 This is the recommended default for MPEG-4).
7600 Most codecs require regular keyframes in order to limit the accumulation of mismatch error.
7601 Keyframes are also needed for seeking, as seeking is only possible to a keyframe - but
7602 keyframes need more space than other frames, so larger numbers here mean
7603 slightly smaller files but less precise seeking.
7604 0 is equivalent to 1, which makes every frame a keyframe.
7605 Values >300 are not recommended as the quality might be bad depending upon
7606 decoder, encoder and luck.
7607 It is a common for MPEG-1/2 to use values <=30.
7610 .B sc_threshold=<-1000000000\-1000000000>
7611 Threshold for scene change detection.
7612 A keyframe is inserted by libavcodec when it detects a scene change.
7613 You can specify the sensitivity of the detection with this option.
7614 -1000000000 means there is a scene change detected at every frame,
7615 1000000000 means no scene changes are detected (default: 0).
7618 .B sc_factor=<any positive integer>
7619 Causes frames with higher quantizers to be more likely to trigger a
7620 scene change detection and make libavcodec use an I-frame (default: 1).
7621 1\-16 is a sane range.
7622 Values between 2 and 6 may yield increasing PSNR (up to approximately
7623 0.04 dB) and better placement of I-frames in high-motion scenes.
7624 Higher values than 6 may give very slightly better PSNR (approximately
7625 0.01 dB more than sc_factor=6), but noticably worse visual quality.
7628 .B vb_strategy=<0\-2> (pass one only)
7629 strategy to choose between I/P/B-frames:
7633 Always use the maximum number of B-frames (default).
7635 Avoid B-frames in high motion scenes.
7636 See the b_sensitivity option to tune this strategy.
7638 Places B-frames more or less optimally to yield maximum quality (slower).
7639 You may want to reduce the speed impact of this option by tuning the
7645 .B b_sensitivity=<any integer greater than 0>
7646 Adjusts how sensitively vb_strategy=1 detects motion and avoids using
7647 B-frames (default: 40).
7648 Lower sensitivities will result in more B-frames.
7649 Using more B-frames usually improves PSNR, but too many B-frames can
7650 hurt quality in high-motion scenes.
7651 Unless there is an extremely high amount of motion, b_sensitivity can
7652 safely be lowered below the default; 10 is a reasonable value in most
7656 .B brd_scale=<0\-10>
7657 Downscales frames for dynamic B-frame decision (default: 0).
7658 Each time brd_scale is increased by one, the frame dimensions are
7659 divided by two, which improves speed by a factor of four.
7660 Both dimensions of the fully downscaled frame must be even numbers, so
7661 brd_scale=1 requires the original dimensions to be multiples of four,
7662 brd_scale=2 requires multiples of eight, etc.
7663 In other words, the dimensions of the original frame must both be
7664 divisible by 2^(brd_scale+1) with no remainder.
7667 .B bidir_refine=<0\-4>
7668 Refine the two motion vectors used in bidirectional macroblocks,
7669 rather than re-using vectors from the forward and backward searches.
7670 This option has no effect without B-frames.
7676 Use a wider search (larger values are slower).
7682 Activates internal two (or more) pass mode, only specify if you wish to
7683 use two (or more) pass encoding.
7687 first pass (also see turbo)
7691 Nth pass (second and subsequent passes of N-pass encoding)
7694 Here is how it works, and how to use it:
7696 The first pass (vpass=1) writes the statistics file.
7697 You might want to deactivate some CPU-hungry options, like "turbo"
7700 In two pass mode, the second pass (vpass=2) reads the statistics file and
7701 bases ratecontrol decisions on it.
7703 In N-pass mode, the second pass (vpass=3, that is not a typo)
7704 does both: It first reads the statistics, then overwrites them.
7705 You might want to backup divx2pass.log before doing this if there is
7706 any possibility that you will have to cancel MEncoder.
7707 You can use all encoding options, except very CPU-hungry options like "qns".
7709 You can run this same pass over and over to refine the encode.
7710 Each subsequent pass will use the statistics from the previous pass to improve.
7711 The final pass can include any CPU-hungry encoding options.
7713 If you want a 2 pass encode, use first vpass=1, and then vpass=2.
7715 If you want a 3 or more pass encode, use vpass=1 for the first pass
7716 and then vpass=3 and then vpass=3 again and again until you are
7717 satisfied with the encode.
7729 Encodes with an optimal Huffman table based upon statistics
7730 from the first pass.
7735 .B turbo (two pass only)
7736 Dramatically speeds up pass one using faster algorithms and disabling
7737 CPU-intensive options.
7738 This will probably reduce global PSNR a little bit (around 0.01dB) and
7739 change individual frame type and PSNR a little bit more (up to 0.03dB).
7743 Store movie aspect internally, just like with MPEG files.
7744 Much nicer than rescaling, because quality is not decreased.
7745 Only MPlayer will play these files correctly, other players will display
7746 them with wrong aspect.
7747 The aspect parameter can be given as a ratio or a floating point number.
7754 .IPs "aspect=16/9 or aspect=1.78"
7760 Same as the aspect option, but automatically computes aspect, taking
7761 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
7763 Does not incur a performance penalty, so you can safely leave it
7768 Specify bitrate (pass 1/2) (default: 800).
7776 .IPs 16001\-24000000
7783 approximated file size tolerance in kbit.
7784 1000\-100000 is a sane range.
7785 (warning: 1kbit = 1000 bits)
7789 vratetol should not be too large during the second pass or there might
7790 be problems if vrc_(min|max)rate is used.
7793 .B vrc_maxrate=<value>
7794 maximum bitrate in kbit/\:sec (pass 1/2)
7795 (default: 0, unlimited)
7798 .B vrc_minrate=<value>
7799 minimum bitrate in kbit/\:sec (pass 1/2)
7800 (default: 0, unlimited)
7803 .B vrc_buf_size=<value>
7804 buffer size in kbit (pass 1/2).
7805 For MPEG-1/2 this also sets the vbv buffer size, use 327 for VCD,
7806 917 for SVCD and 1835 for DVD.
7809 .B vrc_buf_aggressivity
7815 Note that some of the ratecontrol-affecting options will have no effect
7816 if vrc_strategy is not set to 0.
7820 Use internal lavc ratecontrol (default).
7822 Use Xvid ratecontrol (experimental; requires MEncoder to be compiled
7823 with support for Xvid 1.1 or higher).
7828 .B vb_qfactor=<-31.0\-31.0>
7829 quantizer factor between B- and non-B-frames (pass 1/2) (default: 1.25)
7832 .B vi_qfactor=<-31.0\-31.0>
7833 quantizer factor between I- and non-I-frames (pass 1/2) (default: 0.8)
7836 .B vb_qoffset=<-31.0\-31.0>
7837 quantizer offset between B- and non-B-frames (pass 1/2) (default: 1.25)
7840 .B vi_qoffset=<-31.0\-31.0>
7841 (pass 1/2) (default: 0.0)
7843 if v{b|i}_qfactor > 0
7845 I/B-frame quantizer = P-frame quantizer * v{b|i}_qfactor + v{b|i}_qoffset
7849 do normal ratecontrol (do not lock to next P-frame quantizer) and
7850 set q= -q * v{b|i}_qfactor + v{b|i}_qoffset
7853 To do constant quantizer encoding with different quantizers for
7854 I/P- and B-frames you can use:
7855 lmin= <ip_quant>:lmax= <ip_quant>:vb_qfactor= <b_quant/\:ip_quant>.
7858 .B vqblur=<0.0\-1.0> (pass one)
7859 Quantizer blur (default: 0.5), larger values will average the
7860 quantizer more over time (slower change).
7864 Quantizer blur disabled.
7866 Average the quantizer over all previous frames.
7871 .B vqblur=<0.0\-99.0> (pass two)
7872 Quantizer gaussian blur (default: 0.5), larger values will average
7873 the quantizer more over time (slower change).
7876 .B vqcomp=<0.0\-1.0>
7877 Quantizer compression, vrc_eq depends upon this (pass 1/2) (default: 0.5).
7878 For instance, assuming the default rate control equation is used,
7879 if vqcomp=1.0, the ratecontrol allocates to each frame the number of bits
7880 needed to encode them all at the same QP.
7881 If vqcomp=0.0, the ratecontrol allocates the same number of bits to each
7882 frame, i.e. strict CBR.
7884 Those are extreme settings and should never be used.
7885 Perceptual quality will be optimal somewhere in between these two extremes.
7888 .B vrc_eq=<equation>
7889 main ratecontrol equation (pass 1/2)
7896 .IPs 1+(tex/\:avgTex-1)*qComp
7897 approximately the equation of the old ratecontrol code
7899 with qcomp 0.5 or something like that (default)
7916 intra, non-intra texture complexity
7918 average texture complexity
7920 average intra texture complexity in I-frames
7922 average intra texture complexity in P-frames
7924 average non-intra texture complexity in P-frames
7926 average non-intra texture complexity in B-frames
7928 bits used for motion vectors
7930 maximum length of motion vector in log2 scale
7932 number of intra macroblocks / number of macroblocks
7938 qcomp from the command line
7939 .IPs "isI, isP, isB"
7940 Is 1 if picture type is I/P/B else 0.
7942 See your favorite math book.
7949 .IPs max(a,b),min(a,b)
7952 is 1 if a>b, 0 otherwise
7954 is 1 if a<b, 0 otherwise
7956 is 1 if a==b, 0 otherwise
7957 .IPs "sin, cos, tan, sinh, cosh, tanh, exp, log, abs"
7961 .B vrc_override=<options>
7962 User specified quality for specific parts (ending, credits, ...) (pass 1/2).
7963 The options are <start-frame>, <end-frame>, <quality>[/<start-frame>,
7964 <end-frame>, <quality>[/...]]:
7967 .IPs "quality (2\-31)"
7969 .IPs "quality (-500\-0)"
7970 quality correction in %
7975 .B vrc_init_cplx=<0\-1000>
7976 initial complexity (pass 1)
7979 .B vrc_init_occupancy=<0.0\-1.0>
7980 initial buffer occupancy, as a fraction of vrc_buf_size (default: 0.9)
7984 Specify how to keep the quantizer between qmin and qmax (pass 1/2).
7990 Use a nice differentiable function (default).
7995 .B vlelim=<-1000\-1000>
7996 Sets single coefficient elimination threshold for luminance.
7997 Negative values will also consider the DC coefficient (should be at least -4
7998 or lower for encoding at quant=1):
8009 .B vcelim=<-1000\-1000>
8010 Sets single coefficient elimination threshold for chrominance.
8011 Negative values will also consider the DC coefficient (should be at least -4
8012 or lower for encoding at quant=1):
8023 .B vstrict=<-2|-1|0|1>
8024 strict standard compliance
8030 Only recommended if you want to feed the output into the
8031 MPEG-4 reference decoder.
8033 Allow libavcodec specific extensions (default).
8035 Enables experimental codecs and features which may not be playable
8036 with future MPlayer versions (snow).
8043 Adds 2 Bytes per video packet, improves error-resistance when transferring over
8044 unreliable channels (e.g.\& streaming over the internet).
8045 Each video packet will be encoded in 3 separate partitions:
8050 .IPs "2. DC coefficients"
8052 .IPs "3. AC coefficients"
8057 MV & DC are most important, losing them looks far worse than losing
8058 the AC and the 1. & 2. partition.
8059 (MV & DC) are far smaller than the 3. partition (AC) meaning that errors
8060 will hit the AC partition much more often than the MV & DC partitions.
8061 Thus, the picture will look better with partitioning than without,
8062 as without partitioning an error will trash AC/\:DC/\:MV equally.
8066 .B vpsize=<0\-10000> (also see vdpart)
8067 Video packet size, improves error-resistance.
8079 slice structured mode for H.263+
8083 grayscale only encoding (faster)
8091 Automatically select a good one (default).
8112 To the best of our knowledge all these IDCTs do pass the IEEE1180 tests.
8116 Automatically select a good one (default).
8118 JPEG reference integer
8124 libmpeg2mmx (inaccurate, do not use for encoding with keyint >100)
8155 .B lumi_mask=<0.0\-1.0>
8156 Luminance masking is a 'psychosensory' setting that is supposed to
8157 make use of the fact that the human eye tends to notice fewer details
8158 in very bright parts of the picture.
8159 Luminance masking compresses bright areas stronger than medium ones,
8160 so it will save bits that can be spent again on other frames, raising
8161 overall subjective quality, while possibly reducing PSNR.
8164 Be careful, overly large values can cause disastrous things.
8167 Large values might look good on some monitors but may look horrible
8179 .B dark_mask=<0.0\-1.0>
8180 Darkness masking is a 'psychosensory' setting that is supposed to
8181 make use of the fact that the human eye tends to notice fewer details
8182 in very dark parts of the picture.
8183 Darkness masking compresses dark areas stronger than medium ones,
8184 so it will save bits that can be spent again on other frames, raising
8185 overall subjective quality, while possibly reducing PSNR.
8188 Be careful, overly large values can cause disastrous things.
8191 Large values might look good on some monitors but may look horrible
8192 on other monitors / TV / TFT.
8203 .B tcplx_mask=<0.0\-1.0>
8204 Temporal complexity masking (default: 0.0 (disabled)).
8205 Imagine a scene with a bird flying across the whole scene; tcplx_mask
8206 will raise the quantizers of the bird's macroblocks (thus decreasing their
8207 quality), as the human eye usually does not have time to see all the bird's
8209 Be warned that if the masked object stops (e.g.\& the bird lands) it is
8210 likely to look horrible for a short period of time, until the encoder
8211 figures out that the object is not moving and needs refined blocks.
8212 The saved bits will be spent on other parts of the video, which may increase
8213 subjective quality, provided that tcplx_mask is carefully chosen.
8216 .B scplx_mask=<0.0\-1.0>
8217 Spatial complexity masking.
8218 Larger values help against blockiness, if no deblocking filter is used for
8219 decoding, which is maybe not a good idea.
8221 Imagine a scene with grass (which usually has great spatial complexity),
8222 a blue sky and a house; scplx_mask will raise the quantizers of the grass'
8223 macroblocks, thus decreasing its quality, in order to spend more bits on
8224 the sky and the house.
8227 Crop any black borders completely as they will reduce the quality
8228 of the macroblocks (also applies without scplx_mask).
8240 This setting does not have the same effect as using a custom matrix that
8241 would compress high frequencies harder, as scplx_mask will reduce the
8242 quality of P blocks even if only DC is changing.
8243 The result of scplx_mask will probably not look as good.
8247 .B p_mask=<0.0\-1.0> (also see vi_qfactor)
8248 Reduces the quality of inter blocks.
8249 This is equivalent to increasing the quality of intra blocks, because the
8250 same average bitrate will be distributed by the rate controller to the
8251 whole video sequence (default: 0.0 (disabled)).
8252 p_mask=1.0 doubles the bits allocated to each intra block.
8255 .B border_mask=<0.0\-1.0>
8256 border-processing for MPEG-style encoders.
8257 Border processing increases the quantizer for macroblocks which are less
8258 than 1/5th of the frame width/height away from the frame border,
8259 since they are often visually less important.
8263 Normalize adaptive quantization (experimental).
8264 When using adaptive quantization (*_mask), the average per-MB quantizer may no
8265 longer match the requested frame-level quantizer.
8266 Naq will attempt to adjust the per-MB quantizers to maintain the proper
8275 Use interlaced motion estimation (mutually exclusive with qpel).
8279 Use alternative scantable.
8282 .B "top=<-1\-1>\ \ \ "
8303 for HuffYUV, lossless JPEG, dv and ffv1
8305 for lossless JPEG, dv and ffv1
8307 for lossless JPEG, ffv1 and svq1
8309 for lossless JPEG and ffv1
8321 plane/\:gradient prediction
8339 plane/\:gradient prediction
8351 vlc coding (Golomb-Rice)
8353 arithmetic coding (CABAC)
8375 predetermined Huffman tables (builtin or two pass)
8377 adaptive Huffman tables
8383 Use quarter pel motion compensation (mutually exclusive with ilme).
8386 This seems only useful for high bitrate encodings.
8390 Sets the comparison function for the macroblock decision, has only
8395 sum of absolute differences, fast (default)
8397 sum of squared errors
8399 sum of absolute Hadamard transformed differences
8401 sum of absolute DCT transformed differences
8403 sum of squared quantization errors (avoid, low quality)
8405 number of bits needed for the block
8407 rate distortion optimal, slow
8411 sum of absolute vertical differences
8413 sum of squared vertical differences
8415 noise preserving sum of squared differences
8417 5/3 wavelet, only used in snow
8419 9/7 wavelet, only used in snow
8421 Also use chroma, currently does not work (correctly) with B-frames.
8426 .B ildctcmp=<0\-2000>
8427 Sets the comparison function for interlaced DCT decision
8428 (see mbcmp for available comparison functions).
8432 Sets the comparison function for motion estimation pre pass
8433 (see mbcmp for available comparison functions) (default: 0).
8437 Sets the comparison function for full pel motion estimation
8438 (see mbcmp for available comparison functions) (default: 0).
8442 Sets the comparison function for sub pel motion estimation
8443 (see mbcmp for available comparison functions) (default: 0).
8446 .B skipcmp=<0\-2000>
8447 FIXME: Document this.
8450 .B nssew=<0\-1000000>
8451 This setting controls NSSE weight, where larger weights will result in
8453 0 NSSE is identical to SSE
8454 You may find this useful if you prefer to keep some noise in your encoded
8455 video rather than filtering it away before encoding (default: 8).
8459 diamond type and size for motion estimation pre-pass
8463 Diamond type & size for motion estimation.
8464 Motion search is an iterative process.
8465 Using a small diamond does not limit the search to finding only small
8467 It is just somewhat more likely to stop before finding the very best motion
8468 vector, especially when noise is involved.
8469 Bigger diamonds allow a wider search for the best motion vector, thus are
8470 slower but result in better quality.
8472 Big normal diamonds are better quality than shape-adaptive diamonds.
8474 Shape-adaptive diamonds are a good tradeoff between speed and quality.
8477 The sizes of the normal diamonds and shape adaptive ones do not have
8481 shape adaptive (fast) diamond with size 3
8483 shape adaptive (fast) diamond with size 2
8485 uneven multi-hexagon search (slow)
8487 normal size=1 diamond (default) =EPZS type diamond
8495 normal size=2 diamond
8508 Trellis searched quantization.
8509 This will find the optimal encoding for each 8x8 block.
8510 Trellis searched quantization is quite simply an optimal quantization in
8511 the PSNR versus bitrate sense (Assuming that there would be no rounding
8512 errors introduced by the IDCT, which is obviously not the case.).
8513 It simply finds a block for the minimum of error and lambda*bits.
8517 quantization parameter (QP) dependent constant
8519 amount of bits needed to encode the block
8521 sum of squared errors of the quantization
8527 Rate distorted optimal coded block pattern.
8528 Will select the coded block pattern which minimizes distortion + lambda*rate.
8529 This can only be used together with trellis quantization.
8533 Try to encode each MB with MV=<0,0> and choose the better one.
8534 This has no effect if mbd=0.
8537 .B mv0_threshold=<any non-negative integer>
8538 When surrounding motion vectors are <0,0> and the motion estimation
8539 score of the current block is less than mv0_threshold, <0,0> is used for
8540 the motion vector and further motion estimation is skipped (default:
8542 Lowering mv0_threshold to 0 can give a slight (0.01dB) PSNR increase and
8543 possibly make the encoded video look slightly better; raising
8544 mv0_threshold past 320 results in diminished PSNR and visual quality.
8545 Higher values speed up encoding very slightly (usually less than 1%,
8546 depending on the other options used).
8549 This option does not require mv0 to be enabled.
8552 .B qprd (mbd=2 only)
8553 rate distorted optimal quantization parameter (QP) for the given
8554 lambda of each macroblock
8557 .B last_pred=<0\-99>
8558 amount of motion predictors from the previous frame
8564 Will use 2a+1 x 2a+1 macroblock square of motion vector predictors from the
8571 motion estimation pre-pass
8577 only after I-frames (default)
8585 subpel refinement quality (for qpel) (default: 8 (high quality))
8588 This has a significant effect on speed.
8592 number of reference frames to consider for motion compensation
8593 (Snow only) (default: 1)
8597 print the PSNR (peak signal to noise ratio) for the whole video after encoding
8598 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
8599 Returned values are in dB (decibel), the higher the better.
8603 Use MPEG quantizers instead of H.263.
8607 Enable AC prediction for MPEG-4 or advanced intra prediction for H.263+.
8608 This will improve quality very slightly (around 0.02 dB PSNR) and slow
8609 down encoding very slightly (about 1%).
8612 vqmin should be 8 or larger for H.263+ AIC.
8616 alternative inter vlc for H.263+
8620 unlimited MVs (H.263+ only)
8621 Allows encoding of arbitrarily long MVs.
8624 .B ibias=<-256\-256>
8625 intra quantizer bias (256 equals 1.0, MPEG style quantizer default: 96,
8626 H.263 style quantizer default: 0)
8629 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
8630 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
8633 .B pbias=<-256\-256>
8634 inter quantizer bias (256 equals 1.0, MPEG style quantizer default: 0,
8635 H.263 style quantizer default: -64)
8638 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
8639 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
8642 A more positive bias (-32 \- -16 instead of -64) seems to improve the PSNR.
8646 Noise reduction, 0 means disabled.
8647 0\-600 is a useful range for typical content, but you may want to turn it
8648 up a bit more for very noisy content (default: 0).
8649 Given its small impact on speed, you might want to prefer to use this over
8650 filtering noise away with video filters like denoise3d or hqdn3d.
8654 Quantizer noise shaping.
8655 Rather than choosing quantization to most closely match the source video
8656 in the PSNR sense, it chooses quantization such that noise (usually ringing)
8657 will be masked by similar-frequency content in the image.
8658 Larger values are slower but may not result in better quality.
8659 This can and should be used together with trellis quantization, in which case
8660 the trellis quantization (optimal for constant weight) will be used as
8661 startpoint for the iterative search.
8667 Only lower the absolute value of coefficients.
8669 Only change coefficients before the last non-zero coefficient + 1.
8676 .B inter_matrix=<comma separated matrix>
8677 Use custom inter matrix.
8678 It needs a comma separated string of 64 integers.
8681 .B intra_matrix=<comma separated matrix>
8682 Use custom intra matrix.
8683 It needs a comma separated string of 64 integers.
8687 experimental quantizer modulation
8691 experimental quantizer modulation
8695 intra DC precision in bits (default: 8).
8696 If you specify vcodec=mpeg2video this value can be 8, 9, 10 or 11.
8699 .B cgop (also see sc_threshold)
8701 Currently it only works if scene change detection is disabled
8702 (sc_threshold=1000000000).
8706 Sets the low delay flag for MPEG-1/2 (disables B-frames).
8710 Control writing global video headers.
8714 Codec decides where to write global headers (default).
8716 Write global headers only in extradata (needed for .mp4/MOV/NUT).
8718 Write global headers only in front of keyframes.
8726 Same as vglobal for audio headers.
8730 Set CodecContext Level.
8731 Use 31 or 41 to play video on a Playstation 3.
8734 .B skip_exp=<0\-1000000>
8735 FIXME: Document this.
8738 .B skip_factor=<0\-1000000>
8739 FIXME: Document this.
8742 .B skip_threshold=<0\-1000000>
8743 FIXME: Document this.
8748 Nuppel video is based on RTJPEG and LZO.
8749 By default frames are first encoded with RTJPEG and then compressed with LZO,
8750 but it is possible to disable either or both of the two passes.
8751 As a result, you can in fact output raw i420, LZO compressed i420, RTJPEG,
8752 or the default LZO compressed RTJPEG.
8755 The nuvrec documentation contains some advice and examples about the
8756 settings to use for the most common TV encodings.
8760 chrominance threshold (default: 1)
8764 luminance threshold (default: 1)
8768 Enable LZO compression (default).
8772 Disable LZO compression.
8776 quality level (default: 255)
8780 Disable RTJPEG encoding.
8784 Enable RTJPEG encoding (default).
8787 .SS xvidenc (\-xvidencopts)
8789 There are three modes available: constant bitrate (CBR), fixed quantizer and
8794 Specify the pass in two pass mode.
8797 .B turbo (two pass only)
8798 Dramatically speeds up pass one using faster algorithms and disabling
8799 CPU-intensive options.
8800 This will probably reduce global PSNR a little bit and change individual
8801 frame type and PSNR a little bit more.
8804 .B bitrate=<value> (CBR or two pass mode)
8805 Sets the bitrate to be used in kbits/\:second if <16000 or in bits/\:second
8807 If <value> is negative, Xvid will use its absolute value as the target size
8808 (in kBytes) of the video and compute the associated bitrate automagically
8809 (default: 687 kbits/s).
8812 .B fixed_quant=<1\-31>
8813 Switch to fixed quantizer mode and specify the quantizer to be used.
8816 .B zones=<zone0>[/<zone1>[/...]] (CBR or two pass mode)
8817 User specified quality for specific parts (ending, credits, ...).
8818 Each zone is <start-frame>,<mode>,<value> where <mode> may be
8822 Constant quantizer override, where value=<2.0\-31.0>
8823 represents the quantizer value.
8825 Ratecontrol weight override, where value=<0.01\-2.00>
8826 represents the quality correction in %.
8835 .IPs zones=90000,q,20
8836 Encodes all frames starting with frame 90000 at constant quantizer 20.
8837 .IPs zones=0,w,0.1/10001,w,1.0/90000,q,20
8838 Encode frames 0\-10000 at 10% bitrate, encode frames 90000
8839 up to the end at constant quantizer 20.
8840 Note that the second zone is needed to delimit the first zone, as
8841 without it everything up until frame 89999 would be encoded at 10%
8847 .B me_quality=<0\-6>
8848 This option controls the motion estimation subsystem.
8849 The higher the value, the more precise the estimation should be (default: 6).
8850 The more precise the motion estimation is, the more bits can be saved.
8851 Precision is gained at the expense of CPU time so decrease this setting if
8852 you need realtime encoding.
8856 MPEG-4 uses a half pixel precision for its motion search by default.
8857 The standard proposes a mode where encoders are allowed to use quarter
8859 This option usually results in a sharper image.
8860 Unfortunately it has a great impact on bitrate and sometimes the
8861 higher bitrate use will prevent it from giving a better image
8862 quality at a fixed bitrate.
8863 It is better to test with and without this option and see whether it
8864 is worth activating.
8868 Enable Global Motion Compensation, which makes Xvid generate special
8869 frames (GMC-frames) which are well suited for Pan/\:Zoom/\:Rotating images.
8870 Whether or not the use of this option will save bits is highly
8871 dependent on the source material.
8875 Trellis Quantization is a kind of adaptive quantization method that
8876 saves bits by modifying quantized coefficients to make them more
8877 compressible by the entropy encoder.
8878 Its impact on quality is good, and if VHQ uses too much CPU for you,
8879 this setting can be a good alternative to save a few bits (and gain
8880 quality at fixed bitrate) at a lesser cost than with VHQ (default: on).
8884 Activate this if your encoded sequence is an anime/\:cartoon.
8885 It modifies some Xvid internal thresholds so Xvid takes better decisions on
8886 frame types and motion vectors for flat looking cartoons.
8890 The usual motion estimation algorithm uses only the luminance information to
8891 find the best motion vector.
8892 However for some video material, using the chroma planes can help find
8894 This setting toggles the use of chroma planes for motion estimation
8899 Enable a chroma optimizer prefilter.
8900 It will do some extra magic on color information to minimize the
8901 stepped-stairs effect on edges.
8902 It will improve quality at the cost of encoding speed.
8903 It reduces PSNR by nature, as the mathematical deviation to the original
8904 picture will get bigger, but the subjective image quality will raise.
8905 Since it works with color information, you might want to turn it off when
8906 encoding in grayscale.
8910 Activates high-quality prediction of AC coefficients for intra frames from
8911 neighbor blocks (default: on).
8915 The motion search algorithm is based on a search in the usual color domain
8916 and tries to find a motion vector that minimizes the difference between the
8917 reference frame and the encoded frame.
8918 With this setting activated, Xvid will also use the frequency domain (DCT)
8919 to search for a motion vector that minimizes not only the spatial
8920 difference but also the encoding length of the block.
8927 mode decision (inter/\:intra MB) (default)
8939 Adaptive quantization allows the macroblock quantizers to vary inside
8941 This is a 'psychosensory' setting that is supposed to make use of the
8942 fact that the human eye tends to notice fewer details in very bright
8943 and very dark parts of the picture.
8944 It compresses those areas more strongly than medium ones, which will
8945 save bits that can be spent again on other frames, raising overall
8946 subjective quality and possibly reducing PSNR.
8950 Make Xvid discard chroma planes so the encoded video is grayscale only.
8951 Note that this does not speed up encoding, it just prevents chroma data
8952 from being written in the last stage of encoding.
8956 Encode the fields of interlaced video material.
8957 Turn this option on for interlaced content.
8960 Should you rescale the video, you would need an interlace-aware resizer,
8961 which you can activate with \-vf scale=<width>:<height>:1.
8964 .B min_iquant=<0\-31>
8965 minimum I-frame quantizer (default: 2)
8968 .B max_iquant=<0\-31>
8969 maximum I-frame quantizer (default: 31)
8972 .B min_pquant=<0\-31>
8973 minimum P-frame quantizer (default: 2)
8976 .B max_pquant=<0\-31>
8977 maximum P-frame quantizer (default: 31)
8980 .B min_bquant=<0\-31>
8981 minimum B-frame quantizer (default: 2)
8984 .B max_bquant=<0\-31>
8985 maximum B-frame quantizer (default: 31)
8988 .B min_key_interval=<value> (two pass only)
8989 minimum interval between keyframes (default: 0)
8992 .B max_key_interval=<value>
8993 maximum interval between keyframes (default: 10*fps)
8996 .B quant_type=<h263|mpeg>
8997 Sets the type of quantizer to use.
8998 For high bitrates, you will find that MPEG quantization preserves more detail.
8999 For low bitrates, the smoothing of H.263 will give you less block noise.
9000 When using custom matrices, MPEG quantization
9005 .B quant_intra_matrix=<filename>
9006 Load a custom intra matrix file.
9007 You can build such a file with xvid4conf's matrix editor.
9010 .B quant_inter_matrix=<filename>
9011 Load a custom inter matrix file.
9012 You can build such a file with xvid4conf's matrix editor.
9015 .B keyframe_boost=<0\-1000> (two pass mode only)
9016 Shift some bits from the pool for other frame types to intra frames,
9017 thus improving keyframe quality.
9018 This amount is an extra percentage, so a value of 10 will give
9019 your keyframes 10% more bits than normal
9023 .B kfthreshold=<value> (two pass mode only)
9024 Works together with kfreduction.
9025 Determines the minimum distance below which you consider that
9026 two frames are considered consecutive and treated differently
9027 according to kfreduction
9031 .B kfreduction=<0\-100> (two pass mode only)
9032 The above two settings can be used to adjust the size of keyframes that
9033 you consider too close to the first (in a row).
9034 kfthreshold sets the range in which keyframes are reduced, and
9035 kfreduction determines the bitrate reduction they get.
9036 The last I-frame will get treated normally
9040 .B max_bframes=<0\-4>
9041 Maximum number of B-frames to put between I/P-frames (default: 2).
9044 .B bquant_ratio=<0\-1000>
9045 quantizer ratio between B- and non-B-frames, 150=1.50 (default: 150)
9048 .B bquant_offset=<-1000\-1000>
9049 quantizer offset between B- and non-B-frames, 100=1.00 (default: 100)
9052 .B bf_threshold=<-255\-255>
9053 This setting allows you to specify what priority to place on the use of
9055 The higher the value, the higher the probability of B-frames being used
9057 Do not forget that B-frames usually have a higher quantizer, and therefore
9058 aggressive production of B-frames may cause worse visual quality.
9062 This option tells Xvid to close every GOP (Group Of Pictures bounded
9063 by two I-frames), which makes GOPs independent from each other.
9064 This just implies that the last frame of the GOP is either a P-frame or a
9065 N-frame but not a B-frame.
9066 It is usually a good idea to turn this option on (default: on).
9070 This option is meant to solve frame-order issues when encoding to
9071 container formats like AVI that cannot cope with out-of-order frames.
9072 In practice, most decoders (both software and hardware) are able to deal
9073 with frame-order themselves, and may get confused when this option is
9074 turned on, so you can safely leave if off, unless you really know what
9078 This will generate an illegal bitstream, and will not be
9079 decodable by ISO-MPEG-4 decoders except DivX/\:libavcodec/\:Xvid.
9082 This will also store a fake DivX version in the file so the bug
9083 autodetection of some decoders might be confused.
9086 .B frame_drop_ratio=<0\-100> (max_bframes=0 only)
9087 This setting allows the creation of variable framerate video streams.
9088 The value of the setting specifies a threshold under which, if the
9089 difference of the following frame to the previous frame is below or equal
9090 to this threshold, a frame gets not coded (a so called n-vop is placed
9092 On playback, when reaching an n-vop the previous frame will be displayed.
9095 Playing with this setting may result in a jerky video, so use it at your
9099 .B rc_reaction_delay_factor=<value>
9100 This parameter controls the number of frames the CBR rate controller
9101 will wait before reacting to bitrate changes and compensating for them
9102 to obtain a constant bitrate over an averaging range of frames.
9105 .B rc_averaging_period=<value>
9106 Real CBR is hard to achieve.
9107 Depending on the video material, bitrate can be variable, and hard to predict.
9108 Therefore Xvid uses an averaging period for which it guarantees a given
9109 amount of bits (minus a small variation).
9110 This settings expresses the "number of frames" for which Xvid averages
9111 bitrate and tries to achieve CBR.
9114 .B rc_buffer=<value>
9115 size of the rate control buffer
9118 .B curve_compression_high=<0\-100>
9119 This setting allows Xvid to take a certain percentage of bits away from
9120 high bitrate scenes and give them back to the bit reservoir.
9121 You could also use this if you have a clip with so many bits allocated
9122 to high-bitrate scenes that the low(er)-bitrate scenes start to look bad
9126 .B curve_compression_low=<0\-100>
9127 This setting allows Xvid to give a certain percentage of extra bits to the
9128 low bitrate scenes, taking a few bits from the entire clip.
9129 This might come in handy if you have a few low-bitrate scenes that are
9130 still blocky (default: 0).
9133 .B overflow_control_strength=<0\-100>
9134 During pass one of two pass encoding, a scaled bitrate curve is computed.
9135 The difference between that expected curve and the result obtained during
9136 encoding is called overflow.
9137 Obviously, the two pass rate controller tries to compensate for that overflow,
9138 distributing it over the next frames.
9139 This setting controls how much of the overflow is distributed every time
9140 there is a new frame.
9141 Low values allow lazy overflow control, big rate bursts are compensated for
9142 more slowly (could lead to lack of precision for small clips).
9143 Higher values will make changes in bit redistribution more abrupt, possibly
9144 too abrupt if you set it too high, creating artifacts (default: 5).
9147 This setting impacts quality a lot, play with it carefully!
9150 .B max_overflow_improvement=<0\-100>
9151 During the frame bit allocation, overflow control may increase the frame
9153 This parameter specifies the maximum percentage by which the overflow
9154 control is allowed to increase the frame size, compared to the ideal curve
9159 .B max_overflow_degradation=<0\-100>
9160 During the frame bit allocation, overflow control may decrease the frame
9162 This parameter specifies the maximum percentage by which the overflow
9163 control is allowed to decrease the frame size, compared to the ideal curve
9168 .B container_frame_overhead=<0...>
9169 Specifies a frame average overhead per frame, in bytes.
9170 Most of the time users express their target bitrate for video w/o taking
9171 care of the video container overhead.
9172 This small but (mostly) constant overhead can cause the target file size
9174 Xvid allows users to set the amount of overhead per frame the
9175 container generates (give only an average per frame).
9176 0 has a special meaning, it lets Xvid use its own default values
9177 (default: 24 \- AVI average overhead).
9180 .B profile=<profile_name>
9181 Restricts options and VBV (peak bitrate over a short period) according to
9182 the Simple, Advanced Simple and DivX profiles.
9183 The resulting videos should be playable on standalone players adhering to these
9184 profile specifications.
9188 no restrictions (default)
9190 simple profile at level 0
9192 simple profile at level 1
9194 simple profile at level 2
9196 simple profile at level 3
9198 advanced simple profile at level 0
9200 advanced simple profile at level 1
9202 advanced simple profile at level 2
9204 advanced simple profile at level 3
9206 advanced simple profile at level 4
9208 advanced simple profile at level 5
9210 DXN handheld profile
9212 DXN portable NTSC profile
9214 DXN portable PAL profile
9216 DXN home theater NTSC profile
9218 DXN home theater PAL profile
9225 These profiles should be used in conjunction with an appropriate \-ffourcc.
9226 Generally DX50 is applicable, as some players do not recognize Xvid but
9227 most recognize DivX.
9232 Specifies the Pixel Aspect Ratio mode (not to be confused with DAR,
9233 the Display Aspect Ratio).
9234 PAR is the ratio of the width and height of a single pixel.
9235 So both are related like this: DAR = PAR * (width/height).
9237 MPEG-4 defines 5 pixel aspect ratios and one extended
9238 one, giving the opportunity to specify a specific pixel aspect
9240 5 standard modes can be specified:
9244 It is the usual PAR for PC content.
9245 Pixels are a square unit.
9247 PAL standard 4:3 PAR.
9248 Pixels are rectangles.
9254 same as above (Do not forget to give the exact ratio.)
9256 Allows you to specify your own pixel aspect ratio with par_width and
9262 In general, setting aspect and autoaspect options is enough.
9266 .B par_width=<1\-255> (par=ext only)
9267 Specifies the width of the custom pixel aspect ratio.
9270 .B par_height=<1\-255> (par=ext only)
9271 Specifies the height of the custom pixel aspect ratio.
9274 .B aspect=<x/y | f (float value)>
9275 Store movie aspect internally, just like MPEG files.
9276 Much nicer solution than rescaling, because quality is not decreased.
9277 MPlayer and a few others players will play these files correctly, others
9278 will display them with the wrong aspect.
9279 The aspect parameter can be given as a ratio or a floating point number.
9283 Same as the aspect option, but automatically computes aspect, taking
9284 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
9289 Print the PSNR (peak signal to noise ratio) for the whole video after encoding
9290 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
9291 the current directory.
9292 Returned values are in dB (decibel), the higher the better.
9296 Save per-frame statistics in ./xvid.dbg. (This is not the two pass control
9302 The following option is only available in Xvid 1.1.x.
9306 This setting allows vector candidates for B-frames to be used for
9307 the encoding chosen using a rate distortion optimized operator,
9308 which is what is done for P-frames by the vhq option.
9309 This produces nicer-looking B-frames while incurring almost no
9310 performance penalty (default: 1).
9314 The following option is only available in the 1.2.x version of Xvid.
9318 Create n threads to run the motion estimation (default: 0).
9319 The maximum number of threads that can be used is the picture height
9323 .SS x264enc (\-x264encopts)
9327 Sets the average bitrate to be used in kbits/\:second (default: off).
9328 Since local bitrate may vary, this average may be inaccurate for
9329 very short videos (see ratetol).
9330 Constant bitrate can be achieved by combining this with vbv_maxrate,
9331 at significant reduction in quality.
9335 This selects the quantizer to use for P-frames.
9336 I- and B-frames are offset from this value by ip_factor and pb_factor, respectively.
9337 20\-40 is a useful range.
9338 Lower values result in better fidelity, but higher bitrates.
9340 Note that quantization in H.264 works differently from MPEG-1/2/4:
9341 H.264's quantization parameter (QP) is on a logarithmic scale.
9342 The mapping is approximately H264QP = 12 + 6*log2(MPEGQP).
9343 For example, MPEG at QP=2 is equivalent to H.264 at QP=18.
9347 Enables constant quality mode, and selects the quality.
9348 The scale is similar to QP.
9349 Like the bitrate-based modes, this allows each frame to use a
9350 different QP based on the frame's complexity.
9354 Enable 2 or 3-pass mode.
9355 It is recommended to always encode in 2 or 3-pass mode as it leads to a
9356 better bit distribution and improves overall quality.
9362 second pass (of two pass encoding)
9364 Nth pass (second and third passes of three pass encoding)
9367 Here is how it works, and how to use it:
9369 The first pass (pass=1) collects statistics on the video and writes them
9371 You might want to deactivate some CPU-hungry options, apart from the ones
9372 that are on by default.
9374 In two pass mode, the second pass (pass=2) reads the statistics file and
9375 bases ratecontrol decisions on it.
9377 In three pass mode, the second pass (pass=3, that is not a typo)
9378 does both: It first reads the statistics, then overwrites them.
9379 You can use all encoding options, except very CPU-hungry options.
9381 The third pass (pass=3) is the same as the second pass, except that it has
9382 the second pass' statistics to work from.
9383 You can use all encoding options, including CPU-hungry ones.
9385 The first pass may use either average bitrate or constant quantizer.
9386 ABR is recommended, since it does not require guessing a quantizer.
9387 Subsequent passes are ABR, and must specify bitrate.
9392 Fast first pass mode.
9393 During the first pass of a two or more pass encode it is possible to gain
9394 speed by disabling some options with negligible or even no impact on the
9395 final pass output quality.
9401 Reduce subq, frameref and disable some inter-macroblock partition analysis
9404 Reduce subq and frameref to 1, use a diamond ME search and disable all
9405 partition analysis modes.
9408 Level 1 can increase first pass speed up to 2x with no change in the global
9409 PSNR of the final pass compared to a full quality first pass.
9411 Level 2 can increase first pass speed up to 4x with about +/- 0.05dB change
9412 in the global PSNR of the final pass compared to a full quality first pass.
9417 Sets maximum interval between IDR-frames (default: 250).
9418 Larger values save bits, thus improve quality, at the cost of seeking
9420 Unlike MPEG-1/2/4, H.264 does not suffer from DCT drift with large
9424 .B keyint_min=<1\-keyint/2>
9425 Sets minimum interval between IDR-frames (default: 25).
9426 If scenecuts appear within this interval, they are still encoded as
9427 I-frames, but do not start a new GOP.
9428 In H.264, I-frames do not necessarily bound a closed GOP because it is
9429 allowable for a P-frame to be predicted from more frames than just the one
9430 frame before it (also see frameref).
9431 Therefore, I-frames are not necessarily seekable.
9432 IDR-frames restrict subsequent P-frames from referring to any frame
9433 prior to the IDR-frame.
9436 .B scenecut=<-1\-100>
9437 Controls how aggressively to insert extra I-frames (default: 40).
9438 With small values of scenecut, the codec often has to force an I-frame
9439 when it would exceed keyint.
9440 Good values of scenecut may find a better location for the I-frame.
9441 Large values use more I-frames than necessary, thus wasting bits.
9442 -1 disables scene-cut detection, so I-frames are inserted only once
9443 every other keyint frames, even if a scene-cut occurs earlier.
9444 This is not recommended and wastes bitrate as scenecuts encoded as P-frames
9445 are just as big as I-frames, but do not reset the "keyint counter".
9449 Number of previous frames used as predictors in B- and P-frames (default: 1).
9450 This is effective in anime, but in live-action material the improvements
9451 usually drop off very rapidly above 6 or so reference frames.
9452 This has no effect on decoding speed, but does increase the memory needed for
9454 Some decoders can only handle a maximum of 15 reference frames.
9458 maximum number of consecutive B-frames between I- and P-frames (default: 0)
9462 Automatically decides when to use B-frames and how many, up to the maximum
9463 specified above (default: on).
9464 If this option is disabled, then the maximum number of B-frames is used.
9467 .B b_bias=<-100\-100>
9468 Controls the decision performed by b_adapt.
9469 A higher b_bias produces more B-frames (default: 0).
9473 Allows B-frames to be used as references for predicting other frames.
9474 For example, consider 3 consecutive B-frames: I0 B1 B2 B3 P4.
9475 Without this option, B-frames follow the same pattern as MPEG-[124].
9476 So they are coded in the order I0 P4 B1 B2 B3, and all the B-frames
9477 are predicted from I0 and P4.
9478 With this option, they are coded as I0 P4 B2 B1 B3.
9479 B2 is the same as above, but B1 is predicted from I0 and B2, and
9480 B3 is predicted from B2 and P4.
9481 This usually results in slightly improved compression, at almost no
9483 However, this is an experimental option: it is not fully tuned and
9484 may not always help.
9485 Requires bframes >= 2.
9486 Disadvantage: increases decoding delay to 2 frames.
9490 Use deblocking filter (default: on).
9491 As it takes very little time compared to its quality gain, it is not
9492 recommended to disable it.
9495 .B deblock=<-6\-6>,<-6\-6>
9496 The first parameter is AlphaC0 (default: 0).
9497 This adjusts thresholds for the H.264 in-loop deblocking filter.
9498 First, this parameter adjusts the maximum amount of change that the filter is
9499 allowed to cause on any one pixel.
9500 Secondly, this parameter affects the threshold for difference across the
9501 edge being filtered.
9502 A positive value reduces blocking artifacts more, but will also smear details.
9504 The second parameter is Beta (default: 0).
9505 This affects the detail threshold.
9506 Very detailed blocks are not filtered, since the smoothing caused by the
9507 filter would be more noticeable than the original blocking.
9509 The default behavior of the filter almost always achieves optimal quality,
9510 so it is best to either leave it alone, or make only small adjustments.
9511 However, if your source material already has some blocking or noise which
9512 you would like to remove, it may be a good idea to turn it up a little bit.
9516 Use CABAC (Context-Adaptive Binary Arithmetic Coding) (default: on).
9517 Slightly slows down encoding and decoding, but should save 10-15% bitrate.
9518 Unless you are looking for decoding speed, you should not disable it.
9521 .B qp_min=<1\-51> (ABR or two pass)
9522 Minimum quantizer, 10\-30 seems to be a useful range (default: 10).
9525 .B qp_max=<1\-51> (ABR or two pass)
9526 maximum quantizer (default: 51)
9529 .B qp_step=<1\-50> (ABR or two pass)
9530 maximum value by which the quantizer may be incremented/decremented between
9534 .B ratetol=<0.1\-100.0> (ABR or two pass)
9535 allowed variance in average bitrate (no particular units) (default: 1.0)
9538 .B vbv_maxrate=<value> (ABR or two pass)
9539 maximum local bitrate, in kbits/\:second (default: disabled)
9542 .B vbv_bufsize=<value> (ABR or two pass)
9543 averaging period for vbv_maxrate, in kbits
9544 (default: none, must be specified if vbv_maxrate is enabled)
9547 .B vbv_init=<0.0\-1.0> (ABR or two pass)
9548 initial buffer occupancy, as a fraction of vbv_bufsize (default: 0.9)
9551 .B ip_factor=<value>
9552 quantizer factor between I- and P-frames (default: 1.4)
9555 .B pb_factor=<value>
9556 quantizer factor between P- and B-frames (default: 1.3)
9559 .B qcomp=<0\-1> (ABR or two pass)
9560 quantizer compression (default: 0.6).
9561 A lower value makes the bitrate more constant,
9562 while a higher value makes the quantization parameter more constant.
9565 .B cplx_blur=<0\-999> (two pass only)
9566 Temporal blur of the estimated frame complexity, before curve compression
9568 Lower values allow the quantizer value to jump around more,
9569 higher values force it to vary more smoothly.
9570 cplx_blur ensures that each I-frame has quality comparable to the following
9571 P-frames, and ensures that alternating high and low complexity frames
9572 (e.g. low fps animation) do not waste bits on fluctuating quantizer.
9575 .B qblur=<0\-99> (two pass only)
9576 Temporal blur of the quantization parameter, after curve compression
9578 Lower values allow the quantizer value to jump around more,
9579 higher values force it to vary more smoothly.
9582 .B zones=<zone0>[/<zone1>[/...]]
9583 User specified quality for specific parts (ending, credits, ...).
9584 Each zone is <start-frame>,<end-frame>,<option> where option may be
9589 .IPs "b=<0.01\-100.0>"
9595 The quantizer option is not strictly enforced.
9596 It affects only the planning stage of ratecontrol, and is still subject
9597 to overflow compensation and qp_min/qp_max.
9601 .B direct_pred=<name>
9602 Determines the type of motion prediction used for direct macroblocks
9607 Direct macroblocks are not used.
9609 Motion vectors are extrapolated from neighboring blocks.
9612 Motion vectors are interpolated from the following P-frame.
9614 The codec selects between spatial and temporal for each frame.
9618 Spatial and temporal are approximately the same speed and PSNR,
9619 the choice between them depends on the video content.
9620 Auto is slightly better, but slower.
9621 Auto is most effective when combined with multipass.
9622 direct_pred=none is both slower and lower quality.
9627 Use weighted prediction in B-frames.
9628 Without this option, bidirectionally predicted macroblocks give
9629 equal weight to each reference frame.
9630 With this option, the weights are determined by the temporal position
9631 of the B-frame relative to the references.
9632 Requires bframes > 1.
9635 .B partitions=<list>
9636 Enable some optional macroblock types (default: p8x8,b8x8,i8x8,i4x4).
9640 Enable types p16x8, p8x16, p8x8.
9642 Enable types p8x4, p4x8, p4x4.
9643 p4x4 is recommended only with subq >= 5, and only at low resolutions.
9645 Enable types b16x8, b8x16, b8x8.
9648 i8x8 has no effect unless 8x8dct is enabled.
9652 Enable all of the above types.
9654 Disable all of the above types.
9658 Regardless of this option, macroblock types p16x16, b16x16, and i16x16
9661 The idea is to find the type and size that best describe a certain area
9663 For example, a global pan is better represented by 16x16 blocks, while
9664 small moving objects are better represented by smaller blocks.
9669 Adaptive spatial transform size: allows macroblocks to choose between
9671 Also allows the i8x8 macroblock type.
9672 Without this option, only 4x4 DCT is used.
9676 Select fullpixel motion estimation algorithm.
9680 diamond search, radius 1 (fast)
9682 hexagon search, radius 2 (default)
9684 uneven multi-hexagon search (slow)
9686 exhaustive search (very slow, and no better than umh)
9692 radius of exhaustive or multi-hexagon motion search (default: 16)
9696 Adjust subpel refinement quality.
9697 This parameter controls quality versus speed tradeoffs involved in the motion
9698 estimation decision process.
9699 subq=5 can compress up to 10% better than subq=1.
9703 Runs fullpixel precision motion estimation on all candidate
9705 Then selects the best type.
9706 Then refines the motion of that type to fast quarterpixel precision (fastest).
9708 Runs halfpixel precision motion estimation on all candidate macroblock types.
9709 Then selects the best type.
9710 Then refines the motion of that type to fast quarterpixel precision.
9712 As 2, but uses a slower quarterpixel refinement.
9714 Runs fast quarterpixel precision motion estimation on all candidate
9716 Then selects the best type.
9717 Then finishes the quarterpixel refinement for that type.
9719 Runs best quality quarterpixel precision motion estimation on all
9720 candidate macroblock types, before selecting the best type (default).
9722 Enables rate-distortion optimization of macroblock types in
9725 Enables rate-distortion optimization of motion vectors and intra modes. (best)
9729 In the above, "all candidates" does not exactly mean all enabled types:
9730 4x4, 4x8, 8x4 are tried only if 8x8 is better than 16x16.
9735 Takes into account chroma information during subpixel motion search
9741 Allows each 8x8 or 16x8 motion partition to independently select a
9743 Without this option, a whole macroblock must use the same reference.
9744 Requires frameref>1.
9748 Enables rate-distortion optimization of macroblock types in B-frames.
9753 Refine the two motion vectors used in bidirectional macroblocks,
9754 rather than re-using vectors from the forward and backward searches.
9755 This option has no effect without B-frames.
9759 rate-distortion optimal quantization
9765 enabled only for the final encode
9767 enabled during all mode decisions (slow, requires subq>=6)
9772 .B deadzone_inter=<0\-32>
9773 Set the size of the inter luma quantization deadzone for non-trellis
9774 quantization (default: 21).
9775 Lower values help to preserve fine details and film grain (typically useful
9776 for high bitrate/quality encode), while higher values help filter out
9777 these details to save bits that can be spent again on other macroblocks
9778 and frames (typically useful for bitrate-starved encodes).
9779 It is recommended that you start by tweaking deadzone_intra before changing
9783 .B deadzone_intra=<0\-32>
9784 Set the size of the intra luma quantization deadzone for non-trellis
9785 quantization (default: 11).
9786 This option has the same effect as deadzone_inter except that it affects
9788 It is recommended that you start by tweaking this parameter before changing
9793 Performs early skip detection in P-frames (default: enabled).
9794 This usually improves speed at no cost, but it can sometimes produce
9795 artifacts in areas with no details, like sky.
9799 Eliminate dct blocks in P-frames containing only a small single coefficient
9801 This will remove some details, so it will save bits that can be spent
9802 again on other frames, hopefully raising overall subjective quality.
9803 If you are compressing non-anime content with a high target bitrate, you
9804 may want to disable this to preserve as much detail as possible.
9808 Noise reduction, 0 means disabled.
9809 100\-1000 is a useful range for typical content, but you may want to turn it
9810 up a bit more for very noisy content (default: 0).
9811 Given its small impact on speed, you might want to prefer to use this over
9812 filtering noise away with video filters like denoise3d or hqdn3d.
9815 .B chroma_qp_offset=<-12\-12>
9816 Use a different quantizer for chroma as compared to luma.
9817 Useful values are in the range <-2\-2> (default: 0).
9820 .B cqm=<flat|jvt|<filename>>
9821 Either uses a predefined custom quantization matrix or loads a JM format
9826 Use the predefined flat 16 matrix (default).
9828 Use the predefined JVT matrix.
9830 Use the provided JM format matrix file.
9835 Windows CMD.EXE users may experience problems with parsing the command line
9836 if they attempt to use all the CQM lists.
9837 This is due to a command line length limitation.
9838 In this case it is recommended the lists be put into a JM format CQM
9839 file and loaded as specified above.
9843 .B cqm4iy=<list> (also see cqm)
9844 Custom 4x4 intra luminance matrix, given as a list of 16 comma separated
9845 values in the 1\-255 range.
9848 .B cqm4ic=<list> (also see cqm)
9849 Custom 4x4 intra chrominance matrix, given as a list of 16 comma
9850 separated values in the 1\-255 range.
9853 .B cqm4py=<list> (also see cqm)
9854 Custom 4x4 inter luminance matrix, given as a list of 16 comma separated
9855 values in the 1\-255 range.
9858 .B cqm4pc=<list> (also see cqm)
9859 Custom 4x4 inter chrominance matrix, given as a list of 16 comma
9860 separated values in the 1\-255 range.
9863 .B cqm8iy=<list> (also see cqm)
9864 Custom 8x8 intra luminance matrix, given as a list of 64 comma separated
9865 values in the 1\-255 range.
9868 .B cqm8py=<list> (also see cqm)
9869 Custom 8x8 inter luminance matrix, given as a list of 64 comma separated
9870 values in the 1\-255 range.
9873 .B level_idc=<10\-51>
9874 Set the bitstream's level as defined by annex A of the H.264 standard
9875 (default: 51 - Level 5.1).
9876 This is used for telling the decoder what capabilities it needs to support.
9877 Use this parameter only if you know what it means,
9878 and you have a need to set it.
9882 Spawn threads to encode in parallel on multiple CPUs (default: 1).
9883 This has a slight penalty to compression quality.
9884 0 or 'auto' tells x264 to detect how many CPUs you have and pick an
9885 appropriate number of threads.
9888 .B (no)global_header
9889 Causes SPS and PPS to appear only once, at the beginning of the bitstream
9890 (default: disabled).
9891 Some players, such as the Sony PSP, require the use of this option.
9892 The default behavior causes SPS and PPS to repeat prior to each IDR frame.
9896 Treat the video content as interlaced.
9900 Adjust the amount of logging info printed to the screen.
9910 PSNR and other analysis statistics when the encode finishes (default)
9912 PSNR, QP, frametype, size, and other statistics for every frame
9918 Print signal-to-noise ratio statistics.
9921 The 'Y', 'U', 'V', and 'Avg' PSNR fields in the summary are not
9922 mathematically sound (they are simply the average of per-frame PSNRs).
9923 They are kept only for comparison to the JM reference codec.
9924 For all other purposes, please use either the 'Global' PSNR, or the per-frame
9925 PSNRs printed by log=3.
9929 Print the Structural Similarity Metric results.
9930 This is an alternative to PSNR, and may be better correlated with the
9931 perceived quality of the compressed video.
9935 Enable x264 visualizations during encoding.
9936 If the x264 on your system supports it, a new window will be opened during
9937 the encoding process, in which x264 will attempt to present an overview of
9938 how each frame gets encoded.
9939 Each block type on the visualized movie will be colored as follows:
9953 This feature can be considered experimental and subject to change.
9954 In particular, it depends on x264 being compiled with visualizations enabled.
9955 Note that as of writing this, x264 pauses after encoding and visualizing
9956 each frame, waiting for the user to press a key, at which point the next
9957 frame will be encoded.
9961 .SS xvfw (\-xvfwopts)
9963 Encoding with Video for Windows codecs is mostly obsolete unless you wish
9964 to encode to some obscure fringe codec.
9968 The name of the binary codec file with which to encode.
9972 The name of the codec settings file (like firstpass.mcf) created by vfw2menc.
9975 .SS MPEG muxer (\-mpegopts)
9977 The MPEG muxer can generate 5 types of streams, each of which has reasonable
9978 default parameters that the user can override.
9979 Generally, when generating MPEG files, it is advisable to disable
9980 MEncoder's frame-skip code (see \-noskip, \-mc as well as the
9981 harddup and softskip video filters).
9986 .IPs format=mpeg2:tsaf:vbitrate=8000
9991 .B format=<mpeg1 | mpeg2 | xvcd | xsvcd | dvd | pes1 | pes2>
9992 stream format (default: mpeg2).
9993 pes1 and pes2 are very broken formats (no pack header and no padding),
9994 but VDR uses them; do not choose them unless you know exactly what you
9998 .B size=<up to 65535>
9999 Pack size in bytes, do not change unless you know exactly what
10000 you are doing (default: 2048).
10004 Nominal muxrate in kbit/s used in the pack headers (default: 1800 kb/s).
10005 Will be updated as necessary in the case of 'format=mpeg1' or 'mpeg2'.
10009 Sets timestamps on all frames, if possible; recommended when format=dvd.
10010 If dvdauthor complains with a message like "..audio sector out of range...",
10011 you probably did not enable this option.
10015 Uses a better algorithm to interleave audio and video packets, based on the
10016 principle that the muxer will always try to fill the stream with the largest
10017 percentage of free space.
10020 .B vdelay=<1\-32760>
10021 Initial video delay time, in milliseconds (default: 0),
10022 use it if you want to delay video with respect to audio.
10023 It doesn't work with :drop.
10026 .B adelay=<1\-32760>
10027 Initial audio delay time, in milliseconds (default: 0),
10028 use it if you want to delay audio with respect to video.
10032 When used with vdelay the muxer drops the part of audio that was
10036 .B vwidth, vheight=<1\-4095>
10037 Set the video width and height when video is MPEG-1/2.
10040 .B vpswidth, vpsheight=<1\-4095>
10041 Set pan and scan video width and height when video is MPEG-2.
10044 .B vaspect=<1 | 4/3 | 16/9 | 221/100>
10045 Sets the display aspect ratio for MPEG-2 video.
10046 Do not use it on MPEG-1 or the resulting aspect ratio will be completely wrong.
10050 Sets the video bitrate in kbit/s for MPEG-1/2 video.
10053 .B vframerate=<24000/1001 | 24 | 25 | 30000/1001 | 30 | 50 | 60000/1001 | 60 >
10054 Sets the framerate for MPEG-1/2 video.
10055 This option will be ignored if used with the telecine option.
10059 Enables 3:2 pulldown soft telecine mode: The muxer will make the
10060 video stream look like it was encoded at 30000/1001 fps.
10061 It only works with MPEG-2 video when the output framerate is
10062 24000/1001 fps, convert it with \-ofps if necessary.
10063 Any other framerate is incompatible with this option.
10067 Enables FILM to PAL and NTSC to PAL soft telecine mode: The muxer
10068 will make the video stream look like it was encoded at 25 fps.
10069 It only works with MPEG-2 video when the output framerate is
10070 24000/1001 fps, convert it with \-ofps if necessary.
10071 Any other framerate is incompatible with this option.
10074 .B tele_src and tele_dest
10075 Enables arbitrary telecining using Donand Graft's DGPulldown code.
10076 You need to specify the original and the desired framerate; the
10077 muxer will make the video stream look like it was encoded at
10078 the desired framerate.
10079 It only works with MPEG-2 video when the input framerate is smaller
10080 than the output framerate and the framerate increase is <= 1.5.
10087 .IPs tele_src=25,tele_dest=30000/1001
10088 PAL to NTSC telecining
10093 .B vbuf_size=<40\-1194>
10094 Sets the size of the video decoder's buffer, expressed in kilobytes.
10095 Specify it only if the bitrate of the video stream is too high for
10096 the chosen format and if you know perfectly well what you are doing.
10097 A too high value may lead to an unplayable movie, depending on the player's
10099 When muxing HDTV video a value of 400 should suffice.
10102 .B abuf_size=<4\-64>
10103 Sets the size of the audio decoder's buffer, expressed in kilobytes.
10104 The same principle as for vbuf_size applies.
10107 .SS FFmpeg libavformat demuxers (\-lavfdopts)
10110 .B analyzeduration=<value>
10111 Maximum length in seconds to analyze the stream properties.
10115 Force a specific libavformat demuxer.
10118 .B probesize=<value>
10119 Maximum amount of data to probe during the detection phase.
10120 In the case of MPEG-TS this value identifies the maximum number
10121 of TS packets to scan.
10125 .SS FFmpeg libavformat muxers (\-lavfopts) (also see \-of lavf)
10129 Currently only meaningful for MPEG[12]: Maximum allowed distance,
10130 in seconds, between the reference timer of the output stream (SCR)
10131 and the decoding timestamp (DTS) for any stream present
10132 (demux to decode delay).
10133 Default is 0.7 (as mandated by the standards defined by MPEG).
10134 Higher values require larger buffers and must not be used.
10137 .B format=<container_format>
10138 Override which container format to mux into
10139 (default: autodetect from output file extension).
10143 MPEG-1 systems and MPEG-2 PS
10145 Advanced Streaming Format
10147 Audio Video Interleave file
10153 Macromedia Flash video files
10155 RealAudio and RealVideo
10159 NUT open container format (experimental)
10165 Sony Digital Video container
10170 Nominal bitrate of the multiplex, in bits per second;
10171 currently it is meaningful only for MPEG[12].
10172 Sometimes raising it is necessary in order to avoid "buffer underflows".
10175 .B packetsize=<size>
10176 Size, expressed in bytes, of the unitary packet for the chosen format.
10177 When muxing to MPEG[12] implementations the default values are:
10178 2324 for [S]VCD, 2048 for all others formats.
10181 .B preload=<distance>
10182 Currently only meaningful for MPEG[12]: Initial distance,
10183 in seconds, between the reference timer of the output stream (SCR)
10184 and the decoding timestamp (DTS) for any stream present
10185 (demux to decode delay).
10189 .\" --------------------------------------------------------------------------
10190 .\" environment variables
10191 .\" --------------------------------------------------------------------------
10193 .SH ENVIRONMENT VARIABLES
10195 There are a number of environment variables that can be used to
10196 control the behavior of MPlayer and MEncoder.
10199 .B MPLAYER_CHARSET (also see \-msgcharset)
10200 Convert console messages to the specified charset (default: autodetect).
10201 A value of "noconv" means no conversion.
10205 Directory where MPlayer looks for user settings.
10208 .B MPLAYER_VERBOSE (also see \-v and \-msglevel)
10209 Set the initial verbosity level across all message modules (default: 0).
10210 The resulting verbosity corresponds to that of \-msglevel 5 plus the
10211 value of MPLAYER_VERBOSE.
10217 If LADSPA_PATH is set, it searches for the specified file.
10218 If it is not set, you must supply a fully specified pathname.
10219 FIXME: This is also mentioned in the ladspa section.
10225 Specify a directory in which to store title key values.
10226 This will speed up descrambling of DVDs which are in the cache.
10227 The DVDCSS_CACHE directory is created if it does not exist,
10228 and a subdirectory is created named after the DVD's title
10229 or manufacturing date.
10230 If DVDCSS_CACHE is not set or is empty, libdvdcss will use
10231 the default value which is "${HOME}/.dvdcss/" under Unix and
10232 "C:\\Documents and Settings\\$USER\\Application Data\\dvdcss\\" under Win32.
10233 The special value "off" disables caching.
10237 Sets the authentication and decryption method that
10238 libdvdcss will use to read scrambled discs.
10239 Can be one of title, key or disc.
10243 is the default method.
10244 libdvdcss will use a set of calculated player keys to try and get the disc key.
10245 This can fail if the drive does not recognize any of the player keys.
10247 is a fallback method when key has failed.
10248 Instead of using player keys, libdvdcss will crack the disc key using
10249 a brute force algorithm.
10250 This process is CPU intensive and requires 64 MB of memory to store
10253 is the fallback when all other methods have failed.
10254 It does not rely on a key exchange with the DVD drive, but rather uses
10255 a crypto attack to guess the title key.
10256 On rare cases this may fail because there is not enough encrypted data
10257 on the disc to perform a statistical attack, but in the other hand it
10258 is the only way to decrypt a DVD stored on a hard disc, or a DVD with
10259 the wrong region on an RPC2 drive.
10264 .B DVDCSS_RAW_DEVICE
10265 Specify the raw device to use.
10266 Exact usage will depend on your operating system, the Linux
10267 utility to set up raw devices is raw(8) for instance.
10268 Please note that on most operating systems, using a raw device
10269 requires highly aligned buffers: Linux requires a 2048 bytes
10270 alignment (which is the size of a DVD sector).
10274 Sets the libdvdcss verbosity level.
10278 Outputs no messages at all.
10280 Outputs error messages to stderr.
10282 Outputs error messages and debug messages to stderr.
10288 Skip retrieving all keys on startup.
10289 Currently disabled.
10293 FIXME: Document this.
10298 .B AO_SUN_DISABLE_SAMPLE_TIMING
10299 FIXME: Document this.
10303 FIXME: Document this.
10307 Specifies the Network Audio System server to which the
10308 nas audio output driver should connect and the transport
10309 that should be used.
10310 If unset DISPLAY is used instead.
10311 The transport can be one of tcp and unix.
10312 Syntax is tcp/<somehost>:<someport>, <somehost>:<instancenumber>
10313 or [unix]:<instancenumber>.
10314 The NAS base port is 8000 and <instancenumber> is added to that.
10321 .IPs AUDIOSERVER=somehost:0
10322 Connect to NAS server on somehost using default port and transport.
10323 .IPs AUDIOSERVER=tcp/somehost:8000
10324 Connect to NAS server on somehost listening on TCP port 8000.
10325 .IPs AUDIOSERVER=(unix)?:0
10326 Connect to NAS server instance 0 on localhost using unix domain sockets.
10332 FIXME: Document this.
10338 FIXME: Document this.
10344 FIXME: Document this.
10350 FIXME: Document this.
10354 FIXME: Document this.
10358 FIXME: Document this.
10364 FIXME: Document this.
10368 FIXME: Document this.
10372 FIXME: Document this.
10376 FIXME: Document this.
10380 FIXME: Document this.
10386 FIXME: Document this.
10392 FIXME: Document this.
10396 FIXME: Document this.
10400 FIXME: Document this.
10406 FIXME: Document this.
10410 FIXME: Document this.
10414 FIXME: Document this.
10418 FIXME: Document this.
10422 FIXME: Document this.
10426 FIXME: Document this.
10430 .\" --------------------------------------------------------------------------
10432 .\" --------------------------------------------------------------------------
10437 /usr/\:local/\:etc/\:mplayer/\:mplayer.conf
10438 MPlayer system-wide settings
10441 /usr/\:local/\:etc/\:mplayer/\:mencoder.conf
10442 MEncoder system-wide settings
10445 ~/.mplayer/\:config
10446 MPlayer user settings
10449 ~/.mplayer/\:mencoder.conf
10450 MEncoder user settings
10453 ~/.mplayer/\:input.conf
10454 input bindings (see '\-input keylist' for the full list)
10457 ~/.mplayer/\:gui.conf
10458 GUI configuration file
10461 ~/.mplayer/\:gui.pl
10466 font directory (There must be a font.desc file and files with .RAW extension.)
10469 ~/.mplayer/\:DVDkeys/
10473 Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
10476 /path/\:to/\:movie.sub
10478 ~/.mplayer/\:sub/\:movie.sub
10483 .\" --------------------------------------------------------------------------
10485 .\" --------------------------------------------------------------------------
10487 .SH EXAMPLES OF MPLAYER USAGE
10490 .B Quickstart DVD playing:
10496 .B Play in Japanese with English subtitles:
10498 mplayer dvd://1 \-alang ja \-slang en
10502 .B Play only chapters 5, 6, 7:
10504 mplayer dvd://1 \-chapter 5-7
10508 .B Play only titles 5, 6, 7:
10514 .B Play a multiangle DVD:
10516 mplayer dvd://1 \-dvdangle 2
10520 .B Play from a different DVD device:
10522 mplayer dvd://1 \-dvd-device /dev/\:dvd2
10526 .B Play DVD video from a directory with VOB files:
10528 mplayer dvd://1 \-dvd-device /path/\:to/\:directory/
10532 .B Copy a DVD title to hard disk, saving to file "title1.vob":
10534 mplayer dvd://1 \-dumpstream \-dumpfile title1.vob
10538 .B Stream from HTTP:
10540 mplayer http://mplayer.hq/example.avi
10544 .B Stream using RTSP:
10546 mplayer rtsp://server.example.com/streamName
10550 .B Convert subtitles to MPsub format:
10552 mplayer dummy.avi \-sub source.sub \-dumpmpsub
10556 .B Convert subtitles to MPsub format without watching the movie:
10558 mplayer /dev/\:zero \-rawvideo pal:fps=xx \-demuxer rawvideo \-vc null \-vo null \-noframedrop \-benchmark \-sub source.sub \-dumpmpsub
10562 .B input from standard V4L:
10564 mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420 \-vo xv
10568 .B Playback on Zoran cards (old style, deprecated):
10570 mplayer \-vo zr \-vf scale=352:288 file.avi
10574 .B Playback on Zoran cards (new style):
10576 mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
10580 .B Play a 6-channel AAC file with only two speakers:
10582 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
10585 You might want to play a bit with the pan values (e.g multiply with a value) to
10586 increase volume or avoid clipping.
10589 .B checkerboard invert with geq filter:
10591 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'
10595 .SH EXAMPLES OF MENCODER USAGE
10598 .B Encode DVD title #2, only selected chapters:
10600 mencoder dvd://2 \-chapter 10-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10604 .B Encode DVD title #2, resizing to 640x480:
10606 mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10610 .B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
10612 mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10616 .B The same, but with bitrate set to 1800kbit and optimized macroblocks:
10618 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
10622 .B The same, but with MJPEG compression:
10624 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800
10628 .B Encode all *.jpg files in the current directory:
10630 mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
10634 .B Encode from a tuner (specify a format with \-vf format):
10636 mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
10640 .B Encode from a pipe:
10642 rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
10646 .\" --------------------------------------------------------------------------
10647 .\" Bugs, authors, standard disclaimer
10648 .\" --------------------------------------------------------------------------
10652 If you find one, report it to us, but please make sure you have read all
10653 of the documentation first.
10654 Also look out for smileys. :)
10655 Many bugs are the result of incorrect setup or parameter usage.
10656 The bug reporting section of the documentation
10657 (http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:bugreports.html)
10658 explains how to create useful bug reports.
10663 MPlayer was initially written by Arpad Gereoffy.
10664 See the AUTHORS file for a list of some of the many other contributors.
10666 MPlayer is (C) 2000\-2007 The MPlayer Team
10668 This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
10669 It is maintained by Diego Biurrun.
10670 Please send mails about it to the MPlayer-DOCS mailing list.
10671 Translation specific mails belong on the MPlayer-translations mailing list.