2 .\" MPlayer (C) 2000-2009 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 "2009-03-25" "The MPlayer Project" "The Movie Player"
37 mplayer \- movie player
39 mencoder \- movie encoder
41 .\" --------------------------------------------------------------------------
43 .\" --------------------------------------------------------------------------
49 [options] [file|URL|playlist|\-]
54 [specific options] [file2] [specific options]
59 {group of files and options}
60 [group-specific options]
64 [dvd|dvdnav]://[title|[start_title]\-end_title][/device]
73 tv://[channel][/input_id]
78 radio://[channel|frequency][/capture]
88 dvb://[card_number@]channel
93 mf://[filemask|@listfile]
94 [\-mf options] [options]
98 [cdda|cddb]://track[\-endtrack][:speed][/device]
108 [file|mms[t]|http|http_proxy|rt[s]p|ftp|udp|unsv|icyx|noicyx|smb]://
109 [user:pass@]URL[:port] [options]
118 mpst://host[:port]/URL
123 tivo://host/[list|llist|fsid]
129 [file|URL|\-] [\-o file | file://file | smb://[user:pass@]host/filepath]
134 [specific options] [file2] [specific options]
138 .\" --------------------------------------------------------------------------
140 .\" --------------------------------------------------------------------------
144 is a movie player for Linux (runs on many other platforms and CPU
145 architectures, see the documentation).
146 It plays most MPEG/\:VOB, AVI, ASF/\:WMA/\:WMV, RM, QT/\:MOV/\:MP4, Ogg/\:OGM,
147 MKV, VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, supported by many
148 native and binary codecs.
149 You can watch VCD, SVCD, DVD, 3ivx, DivX 3/4/5, WMV and even H.264 movies,
152 MPlayer supports a wide range of video and audio output drivers.
153 It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, AAlib, libcaca, DirectFB,
154 Quartz, Mac OS X CoreVideo, but you can also use GGI, SDL (and all their drivers),
155 VESA (on every VESA-compatible card, even without X11), some low-level
156 card-specific drivers (for Matrox, 3dfx and ATI) and some hardware MPEG decoder
157 boards, such as the Siemens DVB, Hauppauge PVR (IVTV), DXR2 and DXR3/\:Hollywood+.
158 Most of them support software or hardware scaling, so you can enjoy movies in
161 MPlayer has an onscreen display (OSD) for status information, nice big
162 antialiased shaded subtitles and visual feedback for keyboard controls.
163 European/\:ISO8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean
164 fonts are supported along with 12 subtitle formats (MicroDVD, SubRip, OGM,
165 SubViewer, Sami, VPlayer, RT, SSA, AQTitle, JACOsub, PJS and our own: MPsub) and
166 DVD subtitles (SPU streams, VOBsub and Closed Captions).
169 (MPlayer's Movie Encoder) is a simple movie encoder, designed to encode
170 MPlayer-playable movies (see above) to other MPlayer-playable formats (see
172 It encodes to MPEG-4 (DivX/Xvid), one of the libavcodec codecs and
173 PCM/\:MP3/\:VBRMP3 audio in 1, 2 or 3 passes.
174 Furthermore it has stream copying abilities, a powerful filter system (crop,
175 expand, flip, postprocess, rotate, scale, noise, RGB/\:YUV conversion) and
179 is MPlayer with a graphical user interface.
180 It has the same options as MPlayer.
182 Usage examples to get you started quickly can be found at the end
185 .B Also see the HTML documentation!
188 .\" --------------------------------------------------------------------------
189 .\" interactive control
190 .\" --------------------------------------------------------------------------
192 .SH "INTERACTIVE CONTROL"
193 MPlayer has a fully configurable, command-driven control layer
194 which allows you to control MPlayer using keyboard, mouse, joystick
195 or remote control (with LIRC).
196 See the \-input option for ways to customize it.
203 Seek backward/\:forward 10 seconds.
205 Seek forward/\:backward 1 minute.
206 .IPs "pgup and pgdown"
207 Seek forward/\:backward 10 minutes.
209 Decrease/increase current playback speed by 10%.
211 Halve/double current playback speed.
213 Reset playback speed to normal.
215 Go backward/\:forward in the playlist.
217 Go forward in the playlist, even over the end.
219 next/\:previous playtree entry in the parent list
220 .IPs "INS and DEL (ASX playlist only)"
221 next/\:previous alternative source.
223 Pause (pressing again unpauses).
226 Pressing once will pause movie, every consecutive press will play one frame
227 and then go into pause mode again (any other key unpauses).
229 Stop playing and quit.
231 Stop playing (and quit if \-idle is not used).
233 Adjust audio delay by +/\- 0.1 seconds.
235 Decrease/\:increase volume.
237 Decrease/\:increase volume.
239 Adjust audio balance in favor of left/\:right channel.
242 .IPs "_ (MPEG-TS, AVI and libavformat only)"
243 Cycle through the available video tracks.
244 .IPs "# (DVD, MPEG, Matroska, AVI and libavformat only)"
245 Cycle through the available audio tracks.
246 .IPs "TAB (MPEG-TS and libavformat only)"
247 Cycle through the available programs.
249 Toggle fullscreen (also see \-fs).
251 Toggle stay-on-top (also see \-ontop).
253 Decrease/\:increase pan-and-scan range.
255 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
257 Toggle frame dropping states: none / skip display / skip decoding
258 (see \-framedrop and \-hardframedrop).
260 Toggle subtitle visibility.
262 Cycle through the available subtitles.
264 Step forward/backward in the subtitle list.
266 Toggle displaying "forced subtitles".
268 Toggle subtitle alignment: top / middle / bottom.
270 Adjust subtitle delay by +/\- 0.1 seconds.
272 Move subtitles up/down.
273 .IPs "i (\-edlout mode only)"
274 Set start or end of an EDL skip and write it out to the given file.
275 .IPs "s (\-vf screenshot only)"
277 .IPs "S (\-vf screenshot only)"
278 Start/stop taking screenshots.
280 Show filename on the OSD.
282 Seek to the beginning of the previous/next chapter.
283 .IPs "D (\-vo xvmc, \-vo vdpau, \-vf yadif, \-vf kerndeint only)"
284 Activate/deactivate deinterlacer.
286 Cycle through the available DVD angles.
291 (The following keys are valid only when using a hardware accelerated video
292 output (xv, (x)vidix, (x)mga, etc), the software equalizer
293 (\-vf eq or \-vf eq2) or hue filter (\-vf hue).)
310 (The following keys are valid only when using the quartz or corevideo
311 video output driver.)
317 Resize movie window to half its original size.
319 Resize movie window to its original size.
321 Resize movie window to double its original size.
323 Toggle fullscreen (also see \-fs).
324 .IPs "command + [ and command + ]"
325 Set movie window alpha.
330 (The following keys are valid only when using the sdl
331 video output driver.)
337 Cycle through available fullscreen modes.
339 Restore original mode.
344 (The following keys are valid if you have a keyboard
345 with multimedia keys.)
353 Stop playing and quit.
354 .IPs "PREVIOUS and NEXT"
355 Seek backward/\:forward 1 minute.
360 (The following keys are only valid if you compiled with TV or DVB input
361 support and will take precedence over the keys defined above.)
367 Select previous/\:next channel.
376 (The following keys are only valid if you compiled with dvdnav
377 support: They are used to navigate the menus.)
393 Return to nearest menu (the order of preference is: chapter->title->root).
401 (The following keys are only valid if teletext support is enabled during
402 compilation: They are used for controlling TV teletext.)
408 Switch teletext on/\:off.
410 Go to next/\:prev teletext page.
420 .IPs "button 3 and button 4"
421 Seek backward/\:forward 1 minute.
422 .IPs "button 5 and button 6"
423 Decrease/\:increase volume.
431 .IPs "left and right"
432 Seek backward/\:forward 10 seconds.
434 Seek forward/\:backward 1 minute.
438 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
439 .IPs "button 3 and button 4"
440 Decrease/\:increase volume.
445 .\" --------------------------------------------------------------------------
447 .\" --------------------------------------------------------------------------
450 Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the
451 \-fs option is \-nofs.
453 If an option is marked as (XXX only), it will only work in combination with
454 the XXX option or if XXX is compiled in.
457 The suboption parser (used for example for \-ao pcm suboptions) supports
458 a special kind of string-escaping intended for use with external GUIs.
460 It has the following format:
462 %n%string_of_length_n
466 mplayer \-ao pcm:file=%10%C:test.wav test.avi
470 mplayer \-ao pcm:file=%`expr length "$NAME"`%"$NAME" test.avi
473 .\" --------------------------------------------------------------------------
474 .\" Configuration files
475 .\" --------------------------------------------------------------------------
477 .SH "CONFIGURATION FILES"
478 You can put all of the options in configuration files which will be read
479 every time MPlayer/MEncoder is run.
480 The system-wide configuration file 'mplayer.conf' is in your configuration
481 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user
482 specific one is '~/\:.mplayer/\:config'.
483 The configuration file for MEncoder is 'mencoder.conf' in your configuration
484 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the
485 user specific one is '~/\:.mplayer/\:mencoder.conf'.
486 User specific options override system-wide options and options given on the
487 command line override either.
488 The syntax of the configuration files is 'option=<value>', everything after
489 a '#' is considered a comment.
490 Options that work without values can be enabled by setting them to 'yes'
491 or '1' or 'true' and disabled by setting them to 'no' or '0' or 'false'.
492 Even suboptions can be specified in this way.
494 You can also write file-specific configuration files.
495 If you wish to have a configuration file for a file called 'movie.avi', create a file
496 named 'movie.avi.conf' with the file-specific options in it and put it in
498 You can also put the configuration file in the same directory as the file to
499 be played, as long as you give the \-use\-filedir\-conf option (either on the
500 command line or in your global config file).
502 .I EXAMPLE MPLAYER CONFIGURATION FILE:
505 # Use Matrox driver by default.
507 # I love practicing handstands while watching videos.
509 # Decode/encode multiple files from PNG,
510 # start with mf://filemask
512 # Eerie negative images are cool.
516 .I "EXAMPLE MENCODER CONFIGURATION FILE:"
519 # Make MEncoder output to a default filename.
521 # The next 4 lines allow mencoder tv:// to start capturing immediately.
524 lavcopts=vcodec=mjpeg
525 tv=driver=v4l2:input=1:width=768:height=576:device=/dev/video0:audiorate=48000
526 # more complex default encoding option set
527 lavcopts=vcodec=mpeg4:autoaspect=1
531 passlogfile=pass1stats.log
541 .\" --------------------------------------------------------------------------
543 .\" --------------------------------------------------------------------------
546 To ease working with different configurations profiles can be defined in the
548 A profile starts with its name between square brackets, e.g.\& '[my-profile]'.
549 All following options will be part of the profile.
550 A description (shown by \-profile help) can be defined with the profile-desc
552 To end the profile, start another one or use the profile name 'default'
553 to continue with normal options.
556 .I "EXAMPLE MPLAYER PROFILE:"
561 profile-desc="profile for dvd:// streams"
566 profile-desc="profile for dvdnav:// streams"
572 profile-desc="profile for .flv files"
582 .I "EXAMPLE MENCODER PROFILE:"
587 profile-desc="MPEG4 encoding"
589 lavcopts=vcodec=mpeg4:vbitrate=1200
592 profile-desc="HQ MPEG4 encoding"
594 lavcopts=mbd=2:trell=yes:v4mv=yes
597 .\" --------------------------------------------------------------------------
599 .\" --------------------------------------------------------------------------
601 .SH "GENERAL OPTIONS"
604 .B \-codecs\-file <filename> (also see \-afm, \-ac, \-vfm, \-vc)
605 Override the standard search path and use the specified file
606 instead of the builtin codecs.conf.
609 .B \-include <configuration file>
610 Specify configuration file to be parsed after the default ones.
614 Prints all available options.
617 .B \-msgcharset <charset>
618 Convert console messages to the specified character set (default: autodetect).
619 Text will be in the encoding specified with the \-\-charset configure option.
620 Set this to "noconv" to disable conversion (for e.g.\& iconv problems).
623 The option takes effect after command line parsing has finished.
624 The MPLAYER_CHARSET environment variable can help you get rid of
625 the first lines of garbled output.
629 Enable colorful console output on terminals that support ANSI color.
632 .B \-msglevel <all=<level>:<module>=<level>:...>
633 Control verbosity directly for each module.
634 The 'all' module changes the verbosity of all the modules not
635 explicitly specified on the command line.
636 See '\-msglevel help' for a list of all modules.
639 Some messages are printed before the command line is parsed and are
640 therefore not affected by \-msglevel.
641 To control these messages you have to use the MPLAYER_VERBOSE environment
642 variable, see its description below for details.
658 informational messages
660 status messages (default)
674 Prepend module name in front of each console message.
677 .B \-noconfig <options>
678 Do not parse selected configuration files.
681 If \-include or \-use\-filedir\-conf options are
682 specified at the command line, they will be honoured.
684 Available options are:
688 all configuration files
690 system configuration file
692 user configuration file
698 Make console output less verbose; in particular, prevents the status line
699 (i.e.\& A: 0.7 V: 0.6 A-V: 0.068 ...) from being displayed.
700 Particularly useful on slow terminals or broken ones which do not properly
701 handle carriage return (i.e.\& \\r).
704 .B \-priority <prio> (Windows and OS/2 only)
705 Set process priority for MPlayer according to the predefined
706 priorities available under Windows and OS/2.
707 Possible values of <prio>:
709 idle|belownormal|normal|abovenormal|high|realtime
714 Using realtime priority can cause system lockup.
718 .B \-profile <profile1,profile2,...>
719 Use the given profile(s), \-profile help displays a list of the defined profiles.
722 .B \-really\-quiet (also see \-quiet)
723 Display even less output and status messages than with \-quiet.
726 .B \-show\-profile <profile>
727 Show the description and content of a profile.
730 .B \-use\-filedir\-conf
731 Look for a file-specific configuration file in the same directory as
732 the file that is being played.
735 May be dangerous if playing from untrusted media.
739 Increment verbosity level, one level for each \-v
740 found on the command line.
744 .SH "PLAYER OPTIONS (MPLAYER ONLY)"
747 .B \-autoq <quality> (use with \-vf [s]pp)
748 Dynamically changes the level of postprocessing depending on the available spare
750 The number you specify will be the maximum level used.
751 Usually you can use some big number.
752 You have to use \-vf [s]pp without parameters in order for this to work.
755 .B \-autosync <factor>
756 Gradually adjusts the A/V sync based on audio delay measurements.
757 Specifying \-autosync 0, the default, will cause frame timing to be based
758 entirely on audio delay measurements.
759 Specifying \-autosync 1 will do the same, but will subtly change the A/V
760 correction algorithm.
761 An uneven video framerate in a movie which plays fine with \-nosound can
762 often be helped by setting this to an integer value greater than 1.
763 The higher the value, the closer the timing will be to \-nosound.
764 Try \-autosync 30 to smooth out problems with sound drivers which do
765 not implement a perfect audio delay measurement.
766 With this value, if large A/V sync offsets occur, they will only take about
767 1 or 2 seconds to settle out.
768 This delay in reaction time to sudden A/V offsets should be the only
769 side-effect of turning this option on, for all sound drivers.
773 Prints some statistics on CPU usage and dropped frames at the end of playback.
774 Use in combination with \-nosound and \-vo null for benchmarking only the
778 With this option MPlayer will also ignore frame duration when playing
779 only video (you can think of that as infinite fps).
782 .B \-colorkey <number>
783 Changes the colorkey to an RGB value of your choice.
784 0x000000 is black and 0xffffff is white.
785 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
786 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
791 Disables colorkeying.
792 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
793 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
797 .B \-correct\-pts (EXPERIMENTAL)
798 Switches MPlayer to an experimental mode where timestamps for video frames
799 are calculated differently and video filters which add new frames or
800 modify timestamps of existing ones are supported.
801 The more accurate timestamps can be visible for example when playing
802 subtitles timed to scene changes with the \-ass option.
803 Without \-correct\-pts the subtitle timing will typically be off by some frames.
804 This option does not work correctly with some demuxers and codecs.
807 .B \-crash\-debug (DEBUG CODE)
808 Automatically attaches gdb upon crash or SIGTRAP.
809 Support must be compiled in by configuring with \-\-enable\-crash\-debug.
812 .B \-doubleclick\-time
813 Time in milliseconds to recognize two consecutive button presses as
814 a double-click (default: 300).
815 Set to 0 to let your windowing system decide what a double-click is
819 You will get slightly different behaviour depending on whether you bind
820 MOUSE_BTN0_DBL or MOUSE_BTN0\-MOUSE_BTN0_DBL.
823 .B \-edlout <filename>
824 Creates a new file and writes edit decision list (EDL) records to it.
825 During playback, the user hits 'i' to mark the start or end of a skip block.
826 This provides a starting point from which the user can fine-tune EDL entries
828 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details.
832 \-fixed\-vo enforces a fixed video system for multiple files (one
833 (un)initialization for all files).
834 Therefore only one window will be opened for all files.
835 Now enabled by default, use \-nofixed\-vo to disable and create a new window
836 whenever the video stream changes.
837 Currently the following drivers are fixed-vo compliant: gl, gl2, mga, svga, x11,
838 xmga, xv, xvidix and dfbmga.
841 .B \-framedrop (also see \-hardframedrop, experimental without \-nocorrect\-pts)
842 Skip displaying some frames to maintain A/V sync on slow systems.
843 Video filters are not applied to such frames.
844 For B-frames even decoding is skipped completely.
847 .B \-h, \-help, \-\-help
848 Show short summary of options.
851 .B \-hardframedrop (experimental without \-nocorrect\-pts)
852 More intense frame dropping (breaks decoding).
853 Leads to image distortion!
854 Note that especially the libmpeg2 decoder may crash with this,
855 so consider using "\-vc ffmpeg12,".
859 Command that is executed every 30 seconds during playback via system() -
860 i.e.\& using the shell.
863 MPlayer uses this command without any checking, it is your responsibility
864 to ensure it does not cause security problems (e.g.\& make sure to use full
865 paths if "." is in your path like on Windows).
866 It also only works when playing video (i.e.\& not with \-novideo but works with \-vo null).
868 This can be "misused" to disable screensavers that do not support the proper
869 X API (also see \-stop\-xscreensaver).
870 If you think this is too complicated, ask the author of the screensaver
871 program to support the proper X APIs.
873 .I EXAMPLE for xscreensaver:
874 mplayer \-heartbeat\-cmd "xscreensaver\-command \-deactivate" file
876 .I EXAMPLE for GNOME screensaver:
877 mplayer \-heartbeat\-cmd "gnome\-screensaver\-command \-p" file
883 Shorthand for \-msglevel identify=4.
884 Show file parameters in an easily parseable format.
885 Also prints more detailed information about subtitle and audio
886 track languages and IDs.
887 In some cases you can get more information by using \-msglevel identify=6.
888 For example, for a DVD it will list the chapters and time length of each title,
889 as well as a disk ID.
890 Combine this with \-frames 0 to suppress all output.
891 The wrapper script TOOLS/\:midentify.sh suppresses the other MPlayer output and
892 (hopefully) shellescapes the filenames.
895 .B \-idle (also see \-slave)
896 Makes MPlayer wait idly instead of quitting when there is no file to play.
897 Mostly useful in slave mode where MPlayer can be controlled
898 through input commands.
901 .B \-input <commands>
902 This option can be used to configure certain parts of the input system.
903 Paths are relative to ~/.mplayer/.
906 Autorepeat is currently only supported by joysticks.
908 Available commands are:
913 Specify input configuration file other than the default
914 ~/\:.mplayer/\:input.conf.
915 ~/\:.mplayer/\:<filename> is assumed if no full path is given.
917 Device to be used for Apple IR Remote (default is autodetected, Linux only).
919 Delay in milliseconds before we start to autorepeat a key (0 to disable).
921 Number of key presses to generate per second on autorepeat.
922 .IPs (no)default-bindings
923 Use the key bindings that MPlayer ships with by default.
925 Prints all keys that can be bound to commands.
927 Prints all commands that can be bound to keys.
929 Specifies the joystick device to use (default: /dev/\:input/\:js0).
931 Read commands from the given file.
932 Mostly useful with a FIFO.
935 When the given file is a FIFO MPlayer opens both ends so you can do
936 several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
941 .B \-key\-fifo\-size <2\-65000>
942 Specify the size of the FIFO that buffers key events (default: 7).
943 A FIFO of size n can buffer (n\-1) events.
944 If it is too small some events may be lost
945 (leading to "stuck mouse buttons" and similar effects).
946 If it is too big, MPlayer may seem to hang while it
947 processes the buffered events.
948 To get the same behavior as before this option was introduced,
949 set it to 2 for Linux or 1024 for Windows.
952 .B \-lircconf <filename> (LIRC only)
953 Specifies a configuration file for LIRC (default: ~/.lircrc).
956 .B \-list\-properties
957 Print a list of the available properties.
961 Loops movie playback <number> times.
965 .B \-menu (OSD menu only)
966 Turn on OSD menu support.
969 .B \-menu\-cfg <filename> (OSD menu only)
970 Use an alternative menu.conf.
973 .B \-menu\-chroot <path> (OSD menu only)
974 Chroot the file selection menu to a specific location.
979 .IPs "\-menu\-chroot /home"
980 Will restrict the file selection menu to /\:home and downward (i.e.\& no
981 access to / will be possible, but /home/user_name will).
986 .B \-menu\-keepdir (OSD menu only)
987 File browser starts from the last known location instead of current directory.
990 .B \-menu\-root <value> (OSD menu only)
991 Specify the main menu.
994 .B \-menu\-startup (OSD menu only)
995 Display the main menu at MPlayer startup.
998 .B \-mouse\-movements
999 Permit MPlayer to receive pointer events reported by the video
1001 Necessary to select the buttons in DVD menus.
1002 Supported for X11 based VOs (x11, xv, xvmc, etc.) and the gl, gl2, direct3d and
1007 Turns off AppleIR remote support.
1010 .B \-noconsolecontrols
1011 Prevent MPlayer from reading key events from standard input.
1012 Useful when reading data from standard input.
1013 This is automatically enabled when \- is found on the command line.
1014 There are situations where you have to set it manually, e.g.\&
1015 if you open /dev/\:stdin (or the equivalent on your system), use stdin
1016 in a playlist or intend to read from stdin later on via the loadfile or
1017 loadlist slave commands.
1021 Turns off joystick support.
1025 Turns off LIRC support.
1029 Disable mouse button press/\:release input (mozplayerxp's context menu relies
1032 .B \-noorderedchapters
1033 Disable support for Matroska ordered chapters.
1034 MPlayer will not load or search for video segments from other files,
1035 and will also ignore any chapter order specified for the main file.
1039 Turns on usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
1041 This wakes up the process every 1/1024 seconds to check the current time.
1042 Useless with modern Linux kernels configured for desktop use as they already
1043 wake up the process with similar accuracy when using normal timed sleep.
1046 .B \-playing\-msg <string>
1047 Print out a string before starting playback.
1048 The following expansions are supported:
1051 Expand to the value of the property NAME.
1053 Expand TEXT only if the property NAME is available.
1055 Expand TEXT only if the property NAME is not available.
1059 .B \-playlist <filename>
1060 Play files according to a playlist file (ASX, Winamp, SMIL, or
1061 one-file-per-line format).
1064 This option is considered an entry so options found after it will apply
1065 only to the elements of this playlist.
1067 FIXME: This needs to be clarified and documented thoroughly.
1070 .B \-rtc\-device <device>
1071 Use the specified device for RTC timing.
1075 Play files in random order.
1078 .B \-slave (also see \-input)
1079 Switches on slave mode, in which MPlayer works as a backend for other programs.
1080 Instead of intercepting keyboard events, MPlayer will read commands separated
1081 by a newline (\\n) from stdin.
1084 See \-input cmdlist for a list of slave commands and DOCS/tech/slave.txt
1085 for their description.
1086 Also, this is not intended to disable other inputs, e.g.\& via the video window,
1087 use some other method like \-input nodefault\-binds:conf=/dev/null for that.
1091 Time frames by repeatedly checking the current time instead of asking the
1092 kernel to wake up MPlayer at the correct time.
1093 Useful if your kernel timing is imprecise and you cannot use the RTC either.
1094 Comes at the price of higher CPU consumption.
1098 Skip <sec> seconds after every frame.
1099 The normal framerate of the movie is kept, so playback is accelerated.
1100 Since MPlayer can only seek to the next keyframe this may be inexact.
1104 .SH "DEMUXER/STREAM OPTIONS"
1108 Select the Dynamic Range Compression level for AC-3 audio streams.
1109 <level> is a float value ranging from 0 to 1, where 0 means no compression
1110 and 1 (which is the default) means full compression (make loud passages more
1111 silent and vice versa).
1112 This option only shows an effect if the AC-3 stream contains the required range
1113 compression information.
1116 .B \-aid <ID> (also see \-alang)
1117 Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
1118 VOB(AC-3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
1119 MPlayer prints the available audio IDs when run in verbose (\-v) mode.
1120 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1121 (if present) with the chosen audio stream.
1124 .B \-ausid <ID> (also see \-alang)
1125 Select audio substream channel.
1126 Currently the valid range is 0x55..0x75 and applies only to MPEG-TS when handled
1127 by the native demuxer (not by libavformat).
1128 The format type may not be correctly identified because of how this information
1129 (or lack thereof) is embedded in the stream, but it will demux correctly the
1130 audio streams when multiple substreams are present.
1131 MPlayer prints the available substream IDs when run with \-identify.
1134 .B \-alang <language code[,language code,...]> (also see \-aid)
1135 Specify a priority list of audio languages to use.
1136 Different container formats employ different language codes.
1137 DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT
1138 use ISO 639-2 three letter language codes while OGM uses a free-form identifier.
1139 MPlayer prints the available languages when run in verbose (\-v) mode.
1144 .IPs "mplayer dvd://1 \-alang hu,en"
1145 Chooses the Hungarian language track on a DVD and falls back on English if
1146 Hungarian is not available.
1147 .IPs "mplayer \-alang jpn example.mkv"
1148 Plays a Matroska file in Japanese.
1153 .B \-audio\-demuxer <[+]name> (\-audiofile only)
1154 Force audio demuxer type for \-audiofile.
1155 Use a '+' before the name to force it, this will skip some checks!
1156 Give the demuxer name as printed by \-audio\-demuxer help.
1157 For backward compatibility it also accepts the demuxer ID as defined in
1158 libmpdemux/\:demuxer.h.
1159 \-audio\-demuxer audio or \-audio\-demuxer 17 forces MP3.
1162 .B \-audiofile <filename>
1163 Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
1167 .B \-audiofile\-cache <kBytes>
1168 Enables caching for the stream used by \-audiofile, using the specified
1172 .B \-reuse\-socket (udp:// only)
1173 Allows a socket to be reused by other processes as soon as it is closed.
1176 .B \-bandwidth <value> (network only)
1177 Specify the maximum bandwidth for network streaming (for servers that are
1178 able to send content in different bitrates).
1179 Useful if you want to watch live streamed media behind a slow connection.
1180 With Real RTSP streaming, it is also used to set the maximum delivery
1181 bandwidth allowing faster cache filling and stream dumping.
1185 This option specifies how much memory (in kBytes) to use when precaching a
1187 Especially useful on slow media.
1194 .B \-cache\-min <percentage>
1195 Playback will start when the cache has been filled up to <percentage>
1199 .B \-cache\-seek\-min <percentage>
1200 If a seek is to be made to a position within <percentage> of the cache size
1201 from the current position, MPlayer will wait for the cache to be filled to
1202 this position rather than performing a stream seek (default: 50).
1205 .B \-cdda <option1:option2> (CDDA only)
1206 This option can be used to tune the CD Audio reading feature of MPlayer.
1208 Available options are:
1212 .IPs paranoia=<0\-2>
1214 Values other than 0 seem to break playback of anything but the first track.
1216 0: disable checking (default)
1218 1: overlap checking only
1220 2: full data correction and verification
1222 .IPs generic-dev=<value>
1223 Use specified generic SCSI device.
1224 .IPs sector-size=<value>
1225 Set atomic read size.
1226 .IPs overlap=<value>
1227 Force minimum overlap search during verification to <value> sectors.
1229 Assume that the beginning offset of track 1 as reported in the TOC will be
1231 Some Toshiba drives need this for getting track boundaries correct.
1232 .IPs toc-offset=<value>
1233 Add <value> sectors to the values reported when addressing tracks.
1236 (Never) accept imperfect data reconstruction.
1240 .B \-cdrom\-device <path to device>
1241 Specify the CD-ROM device (default: /dev/\:cdrom).
1244 .B \-channels <number> (also see \-af channels)
1245 Request the number of playback channels (default: 2).
1246 MPlayer asks the decoder to decode the audio into as many channels as
1248 Then it is up to the decoder to fulfill the requirement.
1249 This is usually only important when playing videos with AC-3 audio (like DVDs).
1250 In that case liba52 does the decoding by default and correctly downmixes the
1251 audio into the requested number of channels.
1252 To directly control the number of output channels independently of how many
1253 channels are decoded, use the channels filter.
1256 This option is honored by codecs (AC-3 only), filters (surround) and audio
1257 output drivers (OSS at least).
1259 Available options are:
1273 .B \-chapter <chapter ID>[\-<endchapter ID>] (dvd:// and dvdnav:// only)
1274 Specify which chapter to start playing at.
1275 Optionally specify which chapter to end playing at (default: 1).
1278 .B \-cookies (network only)
1279 Send cookies when making HTTP requests.
1282 .B \-cookies\-file <filename> (network only)
1283 Read HTTP cookies from <filename> (default: ~/.mozilla/ and ~/.netscape/)
1284 and skip reading from default locations.
1285 The file is assumed to be in Netscape format.
1289 audio delay in seconds (positive or negative float value)
1291 Negative values delay the audio, and positive values delay the video.
1292 Note that this is the exact opposite of the \-audio\-delay MEncoder option.
1295 When used with MEncoder, this is not guaranteed to work correctly
1296 with \-ovc copy; use \-audio\-delay instead.
1300 Ignore the specified starting time for streams in AVI files.
1301 In MPlayer, this nullifies stream delays in files encoded with
1302 the \-audio\-delay option.
1303 During encoding, this option prevents MEncoder from transferring
1304 original stream start times to the new file; the \-audio\-delay option is
1306 Note that MEncoder sometimes adjusts stream starting times
1307 automatically to compensate for anticipated decoding delays, so do not
1308 use this option for encoding without testing it first.
1311 .B \-demuxer <[+]name>
1313 Use a '+' before the name to force it, this will skip some checks!
1314 Give the demuxer name as printed by \-demuxer help.
1315 For backward compatibility it also accepts the demuxer ID as defined in
1316 libmpdemux/\:demuxer.h.
1319 .B \-dumpaudio (MPlayer only)
1320 Dumps raw compressed audio stream to ./stream.dump (useful with MPEG/\:AC-3,
1321 in most other cases the resulting file will not be playable).
1322 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1323 on the command line only the last one will work.
1326 .B \-dumpfile <filename> (MPlayer only)
1327 Specify which file MPlayer should dump to.
1328 Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream.
1331 .B \-dumpstream (MPlayer only)
1332 Dumps the raw stream to ./stream.dump.
1333 Useful when ripping from DVD or network.
1334 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1335 on the command line only the last one will work.
1338 .B \-dumpvideo (MPlayer only)
1339 Dump raw compressed video stream to ./stream.dump (not very usable).
1340 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1341 on the command line only the last one will work.
1344 .B \-dvbin <options> (DVB only)
1345 Pass the following parameters to the DVB input module, in order to override
1351 Specifies using card number 1\-4 (default: 1).
1352 .IPs file=<filename>
1353 Instructs MPlayer to read the channels list from <filename>.
1354 Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl,atsc} (based on your card type)
1355 or ~/.mplayer/\:channels.conf as a last resort.
1356 .IPs timeout=<1\-30>
1357 Maximum number of seconds to wait when trying to tune a
1358 frequency before giving up (default: 30).
1363 .B \-dvd\-device <path to device> (DVD only)
1364 Specify the DVD device or .iso filename (default: /dev/\:dvd).
1365 You can also specify a directory that contains files previously copied directly
1366 from a DVD (with e.g.\& vobcopy).
1369 .B \-dvd\-speed <factor or speed in KB/s> (DVD only)
1370 Try to limit DVD speed (default: 0, no change).
1371 DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to
1373 Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be
1374 quiet and fast enough.
1375 MPlayer resets the speed to the drive default value on close.
1376 Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd\-speed 8 selects
1380 You need write access to the DVD device to change the speed.
1383 .B \-dvdangle <angle ID> (DVD only)
1384 Some DVD discs contain scenes that can be viewed from multiple angles.
1385 Here you can tell MPlayer which angles to use (default: 1).
1389 Enables edit decision list (EDL) actions during playback.
1390 Video will be skipped over and audio will be muted and unmuted according to
1391 the entries in the given file.
1392 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details
1396 .B \-endpos <[[hh:]mm:]ss[.ms]|size[b|kb|mb]> (also see \-ss and \-sb)
1397 Stop at given time or byte position.
1400 Byte position is enabled only for MEncoder and will not be accurate, as it can
1401 only stop at a frame boundary.
1402 When used in conjunction with \-ss option, \-endpos time will shift forward by
1403 seconds specified with \-ss.
1410 .IPs "\-endpos 01:10:00"
1411 Stop at 1 hour 10 minutes.
1412 .IPs "\-ss 10 \-endpos 56"
1413 Stop at 1 minute 6 seconds.
1414 .IPs "\-endpos 100mb"
1421 Force index rebuilding.
1422 Useful for files with broken index (A/V desync, etc).
1423 This will enable seeking in files where seeking was not possible.
1424 You can fix the index permanently with MEncoder (see the documentation).
1427 This option only works if the underlying media supports seeking
1428 (i.e.\& not with stdin, pipe, etc).
1431 .B \-fps <float value>
1432 Override video framerate.
1433 Useful if the original value is wrong or missing.
1436 .B \-frames <number>
1437 Play/\:convert only first <number> frames, then quit.
1440 .B \-hr\-mp3\-seek (MP3 only)
1442 Enabled when playing from an external MP3 file, as we need to seek
1443 to the very exact position to keep A/V sync.
1444 Can be slow especially when seeking backwards since it has to rewind
1445 to the beginning to find an exact frame position.
1448 .B \-idx (also see \-forceidx)
1449 Rebuilds index of files if no index was found, allowing seeking.
1450 Useful with broken/\:incomplete downloads, or badly created files.
1453 This option only works if the underlying media supports seeking
1454 (i.e.\& not with stdin, pipe, etc).
1458 Skip rebuilding index file.
1459 MEncoder skips writing the index with this option.
1462 .B \-ipv4\-only\-proxy (network only)
1463 Skip the proxy for IPv6 addresses.
1464 It will still be used for IPv4 connections.
1467 .B \-loadidx <index file>
1468 The file from which to read the video index data saved by \-saveidx.
1469 This index will be used for seeking, overriding any index data
1470 contained in the AVI itself.
1471 MPlayer will not prevent you from loading an index file generated
1472 from a different AVI, but this is sure to cause unfavorable results.
1475 This option is obsolete now that MPlayer has OpenDML support.
1478 .B \-mc <seconds/frame>
1479 maximum A-V sync correction per frame (in seconds)
1482 .B \-mf <option1:option2:...>
1483 Used when decoding from multiple PNG or JPEG files.
1485 Available options are:
1490 input file width (default: autodetect)
1492 input file height (default: autodetect)
1494 output fps (default: 25)
1496 input file type (available: jpeg, png, tga, sgi)
1502 Force usage of non-interleaved AVI parser (fixes playback
1503 of some bad AVI files).
1506 .B \-nobps (AVI only)
1507 Do not use average byte/\:second value for A-V sync.
1508 Helps with some AVI files with broken header.
1512 Disables extension-based demuxer selection.
1513 By default, when the file type (demuxer) cannot be detected reliably
1514 (the file has no header or it is not reliable enough), the filename
1515 extension is used to select the demuxer.
1516 Always falls back on content-based demuxer selection.
1519 .B \-passwd <password> (also see \-user) (network only)
1520 Specify password for HTTP authentication.
1523 .B \-prefer\-ipv4 (network only)
1524 Use IPv4 on network connections.
1525 Falls back on IPv6 automatically.
1528 .B \-prefer\-ipv6 (IPv6 network only)
1529 Use IPv6 on network connections.
1530 Falls back on IPv4 automatically.
1533 .B \-psprobe <byte position>
1534 When playing an MPEG-PS or MPEG-PES streams, this option lets you specify
1535 how many bytes in the stream you want MPlayer to scan in order to identify
1536 the video codec used.
1537 This option is needed to play EVO or VDR files containing H.264 streams.
1540 .B \-pvr <option1:option2:...> (PVR only)
1541 This option tunes various encoding properties of the PVR capture module.
1542 It has to be used with any hardware MPEG encoder based card supported by the
1544 The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV based
1545 cards are known as PVR capture cards.
1546 Be aware that only Linux 2.6.18 kernel
1547 and above is able to handle MPEG stream through V4L2 layer.
1548 For hardware capture of an MPEG stream and watching it with
1549 MPlayer/MEncoder, use 'pvr://' as a movie URL.
1551 Available options are:
1554 Specify input aspect ratio:
1564 .IPs arate=<32000\-48000>
1565 Specify encoding audio rate (default: 48000 Hz, available: 32000, 44100
1568 Specify MPEG audio layer encoding (default: 2).
1569 .IPs abitrate=<32\-448>
1570 Specify audio encoding bitrate in kbps (default: 384).
1572 Specify audio encoding mode.
1573 Available preset values are 'stereo', 'joint_stereo', 'dual' and 'mono' (default: stereo).
1574 .IPs vbitrate=<value>
1575 Specify average video bitrate encoding in Mbps (default: 6).
1577 Specify video encoding mode:
1579 vbr: Variable BitRate (default)
1581 cbr: Constant BitRate
1584 Specify peak video bitrate encoding in Mbps
1585 (only useful for VBR encoding, default: 9.6).
1587 Choose an MPEG format for encoding:
1589 ps: MPEG-2 Program Stream (default)
1591 ts: MPEG-2 Transport Stream
1593 mpeg1: MPEG-1 System Stream
1595 vcd: Video CD compatible stream
1597 svcd: Super Video CD compatible stream
1599 dvd: DVD compatible stream
1605 .B \-radio <option1:option2:...> (radio only)
1606 These options set various parameters of the radio capture module.
1607 For listening to radio with MPlayer use 'radio://<frequency>'
1608 (if channels option is not given) or 'radio://<channel_number>'
1609 (if channels option is given) as a movie URL.
1610 You can see allowed frequency range by running MPlayer with '\-v'.
1611 To start the grabbing subsystem, use 'radio://<frequency or channel>/capture'.
1612 If the capture keyword is not given you can listen to radio
1613 using the line-in cable only.
1614 Using capture to listen is not recommended due to synchronization
1615 problems, which makes this process uncomfortable.
1617 Available options are:
1620 Radio device to use (default: /dev/radio0 for Linux and /dev/tuner0 for *BSD).
1622 Radio driver to use (default: v4l2 if available, otherwise v4l).
1623 Currently, v4l and v4l2 drivers are supported.
1624 .IPs volume=<0..100>
1625 sound volume for radio device (default 100)
1626 .IPs "freq_min=<value> (*BSD BT848 only)"
1627 minimum allowed frequency (default: 87.50)
1628 .IPs "freq_max=<value> (*BSD BT848 only)"
1629 maximum allowed frequency (default: 108.00)
1630 .IPs channels=<frequency>\-<name>,<frequency>\-<name>,...
1632 Use _ for spaces in names (or play with quoting ;-).
1633 The channel names will then be written using OSD and the slave commands
1634 radio_step_channel and radio_set_channel will be usable for
1635 a remote control (see LIRC).
1636 If given, number in movie URL will be treated as channel position in
1640 radio://1, radio://104.4, radio_set_channel 1
1641 .IPs "adevice=<value> (radio capture only)"
1642 Name of device to capture sound from.
1643 Without such a name capture will be disabled,
1644 even if the capture keyword appears in the URL.
1645 For ALSA devices use it in the form hw=<card>.<device>.
1646 If the device name contains a '=', the module will use
1647 ALSA to capture, otherwise OSS.
1648 .IPs "arate=<value> (radio capture only)"
1649 Rate in samples per second (default: 44100).
1652 When using audio capture set also \-rawaudio rate=<value> option
1653 with the same value as arate.
1654 If you have problems with sound speed (runs too quickly), try to play
1655 with different rate values (e.g.\& 48000,44100,32000,...).
1656 .IPs "achannels=<value> (radio capture only)"
1657 Number of audio channels to capture.
1661 .B \-rawaudio <option1:option2:...>
1662 This option lets you play raw audio files.
1663 You have to use \-demuxer rawaudio as well.
1664 It may also be used to play audio CDs which are not 44kHz 16-bit stereo.
1665 For playing raw AC-3 streams use \-rawaudio format=0x2000 \-demuxer rawaudio.
1667 Available options are:
1671 .IPs channels=<value>
1674 rate in samples per second
1675 .IPs samplesize=<value>
1676 sample size in bytes
1677 .IPs bitrate=<value>
1678 bitrate for rawaudio files
1685 .B \-rawvideo <option1:option2:...>
1686 This option lets you play raw video files.
1687 You have to use \-demuxer rawvideo as well.
1689 Available options are:
1694 rate in frames per second (default: 25.0)
1695 .IPs sqcif|qcif|cif|4cif|pal|ntsc
1696 set standard image size
1698 image width in pixels
1700 image height in pixels
1701 .IPs i420|yv12|yuy2|y8
1704 colorspace (fourcc) in hex or string constant.
1705 Use \-rawvideo format=help for a list of possible strings.
1715 .IPs "mplayer foreman.qcif -demuxer rawvideo -rawvideo qcif"
1716 Play the famous "foreman" sample video.
1717 .IPs "mplayer sample-720x576.yuv -demuxer rawvideo -rawvideo w=720:h=576"
1718 Play a raw YUV sample.
1724 Used with 'rtsp://' URLs to force the client's port number.
1725 This option may be useful if you are behind a router and want to forward
1726 the RTSP stream from the server to a specific client.
1729 .B \-rtsp\-destination
1730 Used with 'rtsp://' URLs to force the destination IP address to be bound.
1731 This option may be useful with some RTSP server which do not
1732 send RTP packets to the right interface.
1733 If the connection to the RTSP server fails, use \-v to see
1734 which IP address MPlayer tries to bind to and try to force
1735 it to one assigned to your computer instead.
1738 .B \-rtsp\-stream\-over\-tcp (LIVE555 and NEMESI only)
1739 Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP
1740 packets be streamed over TCP (using the same TCP connection as RTSP).
1741 This option may be useful if you have a broken internet connection that does
1742 not pass incoming UDP packets (see http://www.live555.com/\:mplayer/).
1745 .B \-saveidx <filename>
1746 Force index rebuilding and dump the index to <filename>.
1747 Currently this only works with AVI files.
1750 This option is obsolete now that MPlayer has OpenDML support.
1753 .B \-sb <byte position> (also see \-ss)
1754 Seek to byte position.
1755 Useful for playback from CD-ROM images or VOB files with junk at the beginning.
1758 .B \-speed <0.01\-100>
1759 Slow down or speed up playback by the factor given as parameter.
1760 Not guaranteed to work correctly with \-oac copy.
1764 Selects the output sample rate to be used
1765 (of course sound cards have limits on this).
1766 If the sample frequency selected is different from that
1767 of the current media, the resample or lavcresample audio filter will be inserted
1768 into the audio filter layer to compensate for the difference.
1769 The type of resampling can be controlled by the \-af\-adv option.
1770 The default is fast resampling that may cause distortion.
1773 .B \-ss <time> (also see \-sb)
1774 Seek to given time position.
1780 Seeks to 56 seconds.
1781 .IPs "\-ss 01:10:00"
1782 Seeks to 1 hour 10 min.
1788 Tells MPlayer not to discard TS packets reported as broken in the stream.
1789 Sometimes needed to play corrupted MPEG-TS files.
1792 .B \-tsprobe <byte position>
1793 When playing an MPEG-TS stream, this option lets you specify how many
1794 bytes in the stream you want MPlayer to search for the desired
1795 audio and video IDs.
1798 .B \-tsprog <1\-65534>
1799 When playing an MPEG-TS stream, you can specify with this option which
1800 program (if present) you want to play.
1801 Can be used with \-vid and \-aid.
1804 .B \-tv <option1:option2:...> (TV/\:PVR only)
1805 This option tunes various properties of the TV capture module.
1806 For watching TV with MPlayer, use 'tv://' or 'tv://<channel_number>'
1807 or even 'tv://<channel_name> (see option channels for channel_name below)
1809 You can also use 'tv:///<input_id>' to start watching a
1810 movie from a composite or S-Video input (see option input for details).
1812 Available options are:
1816 .IPs "automute=<0\-255> (v4l and v4l2 only)"
1817 If signal strength reported by device is less than this value,
1818 audio and video will be muted.
1819 In most cases automute=100 will be enough.
1820 Default is 0 (automute disabled).
1822 See \-tv driver=help for a list of compiled-in TV input drivers.
1823 available: dummy, v4l, v4l2, bsdbt848 (default: autodetect)
1825 Specify TV device (default: /dev/\:video0).
1827 For the bsdbt848 driver you can provide both bktr and tuner device
1828 names separating them with a comma, tuner after
1829 bktr (e.g.\& -tv device=/dev/bktr1,/dev/tuner1).
1831 Specify input (default: 0 (TV), see console output for available inputs).
1833 Specify the frequency to set the tuner to (e.g.\& 511.250).
1834 Not compatible with the channels parameter.
1836 Specify the output format of the tuner with a preset value supported by the
1837 V4L driver (yv12, rgb32, rgb24, rgb16, rgb15, uyvy, yuy2, i420) or an
1838 arbitrary format given as hex value.
1839 Try outfmt=help for a list of all available formats.
1843 output window height
1845 framerate at which to capture video (frames per second)
1846 .IPs buffersize=<value>
1847 maximum size of the capture buffer in megabytes (default: dynamical)
1849 For bsdbt848 and v4l, PAL, SECAM, NTSC are available.
1850 For v4l2, see the console output for a list of all available norms,
1851 also see the normid option below.
1852 .IPs "normid=<value> (v4l2 only)"
1853 Sets the TV norm to the given numeric ID.
1854 The TV norm depends on the capture card.
1855 See the console output for a list of available TV norms.
1856 .IPs channel=<value>
1857 Set tuner to <value> channel.
1858 .IPs chanlist=<value>
1859 available: europe-east, europe-west, us-bcast, us-cable, etc
1860 .IPs channels=<chan>\-<name>[=<norm>],<chan>\-<name>[=<norm>],...
1861 Set names for channels.
1863 If <chan> is an integer greater than 1000, it will be treated as frequency (in kHz)
1864 rather than channel name from frequency table.
1866 Use _ for spaces in names (or play with quoting ;-).
1867 The channel names will then be written using OSD, and the slave commands
1868 tv_step_channel, tv_set_channel and tv_last_channel will be usable for
1869 a remote control (see LIRC).
1870 Not compatible with the frequency parameter.
1873 The channel number will then be the position in the 'channels' list,
1877 tv://1, tv://TV1, tv_set_channel 1, tv_set_channel TV1
1878 .IPs [brightness|contrast|hue|saturation]=<\-100\-100>
1879 Set the image equalizer on the card.
1880 .IPs audiorate=<value>
1881 Set audio capture bitrate.
1883 Capture audio even if there are no audio sources reported by v4l.
1887 Choose an audio mode:
1897 .IPs forcechan=<1\-2>
1898 By default, the count of recorded audio channels is determined automatically
1899 by querying the audio mode from the TV card.
1900 This option allows forcing stereo/\:mono recording regardless of the amode
1901 option and the values returned by v4l.
1902 This can be used for troubleshooting when the TV card is unable to report the
1904 .IPs adevice=<value>
1905 Set an audio device.
1906 <value> should be /dev/\:xxx for OSS and a hardware ID for ALSA.
1907 You must replace any ':' by a '.' in the hardware ID for ALSA.
1908 .IPs audioid=<value>
1909 Choose an audio output of the capture card, if it has more than one.
1910 .IPs "[volume|bass|treble|balance]=<0\-65535> (v4l1)"
1911 .IPs "[volume|bass|treble|balance]=<0\-100> (v4l2)"
1912 These options set parameters of the mixer on the video capture card.
1913 They will have no effect, if your card does not have one.
1914 For v4l2 50 maps to the default value of the
1915 control, as reported by the driver.
1916 .IPs "gain=<0\-100> (v4l2)"
1917 Set gain control for video devices (usually webcams) to the desired
1918 value and switch off automatic control.
1919 A value of 0 enables automatic control.
1920 If this option is omitted, gain control will not be modified.
1921 .IPs immediatemode=<bool>
1922 A value of 0 means capture and buffer audio and video together
1923 (default for MEncoder).
1924 A value of 1 (default for MPlayer) means to do video capture only and let the
1925 audio go through a loopback cable from the TV card to the sound card.
1927 Use hardware MJPEG compression (if the card supports it).
1928 When using this option, you do not need to specify the width and height
1929 of the output window, because MPlayer will determine it automatically
1930 from the decimation value (see below).
1931 .IPs decimation=<1|2|4>
1932 choose the size of the picture that will be compressed by hardware
1947 .IPs quality=<0\-100>
1948 Choose the quality of the JPEG compression
1949 (< 60 recommended for full size).
1950 .IPs tdevice=<value>
1951 Specify TV teletext device (example: /dev/\:vbi0) (default: none).
1952 .IPs tformat=<format>
1953 Specify TV teletext display format (default: 0):
1959 2: opaque with inverted colors
1961 3: transparent with inverted colors
1963 .IPs tpage=<100\-899>
1964 Specify initial TV teletext page number (default: 100).
1965 .IPs tlang=<\-1\-127>
1966 Specify default teletext language code (default: 0), which will be used
1967 as primary language until a type 28 packet is received.
1968 Useful when the teletext system uses a non-latin character set, but language
1969 codes are not transmitted via teletext type 28 packets for some reason.
1970 To see a list of supported language codes set this option to \-1.
1971 .IPs "hidden_video_renderer (dshow only)"
1972 Terminate stream with video renderer instead of Null renderer (default: off).
1973 Will help if video freezes but audio does not.
1975 May not work with \-vo directx and \-vf crop combination.
1976 .IPs "hidden_vp_renderer (dshow only)"
1977 Terminate VideoPort pin stream with video renderer
1978 instead of removing it from the graph (default: off).
1979 Useful if your card has a VideoPort pin and video is choppy.
1981 May not work with \-vo directx and \-vf crop combination.
1982 .IPs "system_clock (dshow only)"
1983 Use the system clock as sync source instead of the default graph clock
1984 (usually the clock from one of the live sources in graph).
1985 .IPs "normalize_audio_chunks (dshow only)"
1986 Create audio chunks with a time length equal to
1987 video frame time length (default: off).
1988 Some audio cards create audio chunks about 0.5s in size, resulting in
1989 choppy video when using immediatemode=0.
1993 .B \-tvscan <option1:option2:...> (TV and MPlayer only)
1994 Tune the TV channel scanner.
1995 MPlayer will also print value for "-tv channels=" option,
1996 including existing and just found channels.
1998 Available suboptions are:
2001 Begin channel scanning immediately after startup (default: disabled).
2002 .IPs period=<0.1\-2.0>
2003 Specify delay in seconds before switching to next channel (default: 0.5).
2004 Lower values will cause faster scanning, but can detect
2005 inactive TV channels as active.
2006 .IPs threshold=<1\-100>
2007 Threshold value for the signal strength (in percent), as reported
2008 by the device (default: 50).
2009 A signal strength higher than this value will indicate that the
2010 currently scanning channel is active.
2014 .B \-user <username> (also see \-passwd) (network only)
2015 Specify username for HTTP authentication.
2018 .B \-user\-agent <string>
2019 Use <string> as user agent for HTTP streaming.
2023 Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
2024 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
2025 (if present) with the chosen video stream.
2028 .B \-vivo <suboption> (DEBUG CODE)
2029 Force audio parameters for the VIVO demuxer (for debugging purposes).
2030 FIXME: Document this.
2034 .SH "OSD/SUBTITLE OPTIONS"
2036 Also see \-vf expand.
2039 .B \-ass (FreeType only)
2040 Turn on SSA/ASS subtitle rendering.
2041 With this option, libass will be used for SSA/ASS
2042 external subtitles and Matroska tracks.
2043 You may also want to use \-embeddedfonts.
2046 Unlike normal OSD, libass uses fontconfig by default. To disable it, use
2050 .B \-ass\-border\-color <value>
2051 Sets the border (outline) color for text subtitles.
2052 The color format is RRGGBBAA.
2055 .B \-ass\-bottom\-margin <value>
2056 Adds a black band at the bottom of the frame.
2057 The SSA/ASS renderer can place subtitles there (with \-ass\-use\-margins).
2060 .B \-ass\-color <value>
2061 Sets the color for text subtitles.
2062 The color format is RRGGBBAA.
2065 .B \-ass\-font\-scale <value>
2066 Set the scale coefficient to be used for fonts in the SSA/ASS renderer.
2069 .B \-ass\-force\-style <[Style.]Param=Value[,...]>
2070 Override some style or script info parameters.
2075 \-ass\-force\-style FontName=Arial,Default.Bold=1
2077 \-ass\-force\-style PlayResY=768
2082 .B \-ass\-hinting <type>
2090 FreeType autohinter, light mode
2092 FreeType autohinter, normal mode
2096 The same, but hinting will only be performed if the OSD is rendered at
2097 screen resolution and will therefore not be scaled.
2100 The default value is 5 (use light hinter for unscaled OSD and no hinting otherwise).
2105 .B \-ass\-line\-spacing <value>
2106 Set line spacing value for SSA/ASS renderer.
2109 .B \-ass\-styles <filename>
2110 Load all SSA/ASS styles found in the specified file and use them for
2111 rendering text subtitles.
2112 The syntax of the file is exactly like the
2113 [V4 Styles] / [V4+ Styles] section of SSA/ASS.
2116 .B \-ass\-top\-margin <value>
2117 Adds a black band at the top of the frame.
2118 The SSA/ASS renderer can place toptitles there (with \-ass\-use\-margins).
2121 .B \-ass\-use\-margins
2122 Enables placing toptitles and subtitles in black borders when they
2126 .B \-dumpjacosub (MPlayer only)
2127 Convert the given subtitle (specified with the \-sub option) to the time-based
2128 JACOsub subtitle format.
2129 Creates a dumpsub.js file in the current directory.
2132 .B \-dumpmicrodvdsub (MPlayer only)
2133 Convert the given subtitle (specified with the \-sub option) to the
2134 MicroDVD subtitle format.
2135 Creates a dumpsub.sub file in the current directory.
2138 .B \-dumpmpsub (MPlayer only)
2139 Convert the given subtitle (specified with the \-sub option) to MPlayer's
2140 subtitle format, MPsub.
2141 Creates a dump.mpsub file in the current directory.
2144 .B \-dumpsami (MPlayer only)
2145 Convert the given subtitle (specified with the \-sub option) to the time-based
2146 SAMI subtitle format.
2147 Creates a dumpsub.smi file in the current directory.
2150 .B \-dumpsrtsub (MPlayer only)
2151 Convert the given subtitle (specified with the \-sub option) to the time-based
2152 SubViewer (SRT) subtitle format.
2153 Creates a dumpsub.srt file in the current directory.
2156 Some broken hardware players choke on SRT subtitle files with Unix
2158 If you are unlucky enough to have such a box, pass your subtitle
2159 files through unix2dos or a similar program to replace Unix line
2160 endings with DOS/Windows line endings.
2163 .B \-dumpsub (MPlayer only) (BETA CODE)
2164 Dumps the subtitle substream from VOB streams.
2165 Also see the \-dump*sub and \-vobsubout* options.
2168 .B \-embeddedfonts (FreeType only)
2169 Enables extraction of Matroska embedded fonts (default: disabled).
2170 These fonts can be used for SSA/ASS subtitle
2171 rendering (\-ass option).
2172 Font files are created in the ~/.mplayer/\:fonts directory.
2175 With FontConfig 2.4.2 or newer, embedded fonts are opened directly from memory,
2176 and this option is enabled by default.
2179 .B \-ffactor <number>
2180 Resample the font alphamap.
2187 very narrow black outline (default)
2189 narrow black outline
2196 .B \-flip\-hebrew (FriBiDi only)
2197 Turns on flipping subtitles using FriBiDi.
2200 .B \-noflip\-hebrew\-commas
2201 Change FriBiDi's assumptions about the placements of commas in subtitles.
2202 Use this if commas in subtitles are shown at the start of a sentence
2203 instead of at the end.
2206 .B \-font <path to font.desc file, path to font (FreeType), font pattern (Fontconfig)>
2207 Search for the OSD/\:SUB fonts in an alternative directory (default for normal
2208 fonts: ~/\:.mplayer/\:font/\:font.desc, default for FreeType fonts:
2209 ~/.mplayer/\:subfont.ttf).
2212 With FreeType, this option determines the path to the text font file.
2213 With Fontconfig, this option determines the Fontconfig font pattern.
2218 \-font ~/\:.mplayer/\:arial-14/\:font.desc
2220 \-font ~/\:.mplayer/\:arialuni.ttf
2222 \-font 'Bitstream Vera Sans'
2224 \-font 'Bitstream Vera Sans:style=Bold'
2229 .B \-fontconfig (fontconfig only)
2230 Enables the usage of fontconfig managed fonts.
2233 By default fontconfig is used for libass-rendered subtitles and not used for
2234 OSD. With \-fontconfig it is used for both libass and OSD, with \-nofontconfig
2235 it is not used at all.
2239 Display only forced subtitles for the DVD subtitle stream selected by e.g.\&
2243 .B \-fribidi\-charset <charset name> (FriBiDi only)
2244 Specifies the character set that will be passed to FriBiDi when
2245 decoding non-UTF-8 subtitles (default: ISO8859-8).
2248 .B \-ifo <VOBsub IFO file>
2249 Indicate the file that will be used to load palette and frame size for VOBsub
2254 Turns off automatic subtitle file loading.
2257 .B \-osd\-duration <time>
2258 Set the duration of the OSD messages in ms (default: 1000).
2261 .B \-osdlevel <0\-3> (MPlayer only)
2262 Specifies which mode the OSD should start in.
2268 volume + seek (default)
2270 volume + seek + timer + percentage
2272 volume + seek + timer + percentage + total time
2278 Allows the next subtitle to be displayed while the current one is
2279 still visible (default is to enable the support only for specific
2283 .B \-sid <ID> (also see \-slang, \-vobsubid)
2284 Display the subtitle stream specified by <ID> (0\-31).
2285 MPlayer prints the available subtitle IDs when run in verbose (\-v) mode.
2286 If you cannot select one of the subtitles on a DVD, also try \-vobsubid.
2289 .B \-slang <language code[,language code,...]> (also see \-sid)
2290 Specify a priority list of subtitle languages to use.
2291 Different container formats employ different language codes.
2292 DVDs use ISO 639-1 two letter language codes, Matroska uses ISO 639-2
2293 three letter language codes while OGM uses a free-form identifier.
2294 MPlayer prints the available languages when run in verbose (\-v) mode.
2299 .IPs "mplayer dvd://1 \-slang hu,en"
2300 Chooses the Hungarian subtitle track on a DVD and falls back on English if
2301 Hungarian is not available.
2302 .IPs "mplayer \-slang jpn example.mkv"
2303 Plays a Matroska file with Japanese subtitles.
2309 Antialiasing/\:scaling mode for DVD/\:VOBsub.
2310 A value of 16 may be added to <mode> in order to force scaling even
2311 when original and scaled frame size already match.
2312 This can be employed to e.g.\& smooth subtitles with gaussian blur.
2313 Available modes are:
2317 none (fastest, very ugly)
2319 approximate (broken?)
2323 bilinear (default, fast and not too bad)
2325 uses swscaler gaussian blur (looks very good)
2330 .B \-spualign <\-1\-2>
2331 Specify how SPU (DVD/\:VOBsub) subtitles should be aligned.
2337 Align at top (original behavior, default).
2346 .B \-spugauss <0.0\-3.0>
2347 Variance parameter of gaussian used by \-spuaa 4.
2348 Higher means more blur (default: 1.0).
2351 .B \-sub <subtitlefile1,subtitlefile2,...>
2352 Use/\:display these subtitle files.
2353 Only one file can be displayed at the same time.
2356 .B \-sub\-bg\-alpha <0\-255>
2357 Specify the alpha channel value for subtitles and OSD backgrounds.
2358 Big values mean more transparency.
2359 0 means completely transparent.
2362 .B \-sub\-bg\-color <0\-255>
2363 Specify the color value for subtitles and OSD backgrounds.
2364 Currently subtitles are grayscale so this value is equivalent to the
2365 intensity of the color.
2366 255 means white and 0 black.
2369 .B \-sub\-demuxer <[+]name> (\-subfile only) (BETA CODE)
2370 Force subtitle demuxer type for \-subfile.
2371 Use a '+' before the name to force it, this will skip some checks!
2372 Give the demuxer name as printed by \-sub\-demuxer help.
2373 For backward compatibility it also accepts the demuxer ID as defined in
2377 .B \-sub\-fuzziness <mode>
2378 Adjust matching fuzziness when searching for subtitles:
2384 Load all subs containing movie name.
2386 Load all subs in the current directory.
2391 .B \-sub\-no\-text\-pp
2392 Disables any kind of text post processing done after loading the subtitles.
2393 Used for debug purposes.
2396 .B \-subalign <0\-2>
2397 Specify which edge of the subtitles should be aligned at the height
2402 Align subtitle top edge (original behavior).
2404 Align subtitle center.
2406 Align subtitle bottom edge (default).
2412 Display DVD Closed Caption (CC) subtitles.
2415 the VOB subtitles, these are special ASCII subtitles for the
2416 hearing impaired encoded in the VOB userdata stream on most region 1 DVDs.
2417 CC subtitles have not been spotted on DVDs from other regions so far.
2420 .B \-subcp <codepage> (iconv only)
2421 If your system supports iconv(3), you can use this option to
2422 specify the subtitle codepage.
2434 .B \-subcp enca:<language>:<fallback codepage> (ENCA only)
2435 You can specify your language using a two letter language code to
2436 make ENCA detect the codepage automatically.
2437 If unsure, enter anything and watch mplayer \-v output for available
2439 Fallback codepage specifies the codepage to use, when autodetection fails.
2444 .IPs "\-subcp enca:cs:latin2"
2445 Guess the encoding, assuming the subtitles are Czech, fall back on
2446 latin 2, if the detection fails.
2447 .IPs "\-subcp enca:pl:cp1250"
2448 Guess the encoding for Polish, fall back on cp1250.
2454 Delays subtitles by <sec> seconds.
2458 .B \-subfile <filename> (BETA CODE)
2460 Same as \-audiofile, but for subtitle streams (OggDS?).
2463 .B \-subfont <path to font (FreeType), font pattern (Fontconfig)> (FreeType only)
2464 Sets the subtitle font (see \-font).
2465 If no \-subfont is given, \-font is used.
2468 .B \-subfont\-autoscale <0\-3> (FreeType only)
2469 Sets the autoscale mode.
2472 0 means that text scale and OSD scale are font heights in points.
2481 proportional to movie height
2483 proportional to movie width
2485 proportional to movie diagonal (default)
2490 .B \-subfont\-blur <0\-8> (FreeType only)
2491 Sets the font blur radius (default: 2).
2494 .B \-subfont\-encoding <value> (FreeType only)
2495 Sets the font encoding.
2496 When set to 'unicode', all the glyphs from the font file will be rendered and
2497 unicode will be used (default: unicode).
2500 .B \-subfont\-osd\-scale <0\-100> (FreeType only)
2501 Sets the autoscale coefficient of the OSD elements (default: 6).
2504 .B \-subfont\-outline <0\-8> (FreeType only)
2505 Sets the font outline thickness (default: 2).
2508 .B \-subfont\-text\-scale <0\-100> (FreeType only)
2509 Sets the subtitle text autoscale coefficient as percentage of the
2510 screen size (default: 5).
2514 Specify the framerate of the subtitle file (default: movie fps).
2517 <rate> > movie fps speeds the subtitles up for frame-based subtitle files and
2518 slows them down for time-based ones.
2521 .B \-subpos <0\-100> (useful with \-vf expand)
2522 Specify the position of subtitles on the screen.
2523 The value is the vertical position of the subtitle in % of the screen height.
2526 .B \-subwidth <10\-100>
2527 Specify the maximum width of subtitles on the screen.
2529 The value is the width of the subtitle in % of the screen width.
2533 Disable the display of OSD messages on the console when no video output is
2537 .B \-term\-osd\-esc <escape sequence>
2538 Specify the escape sequence to use before writing an OSD message on the
2540 The escape sequence should move the pointer to the beginning of the line
2541 used for the OSD and clear it (default: ^[[A\\r^[[K).
2545 Tells MPlayer to handle the subtitle file as unicode.
2548 .B \-unrarexec <path to unrar executable> (not supported on MingW)
2549 Specify the path to the unrar executable so MPlayer can use it to access
2550 rar-compressed VOBsub files (default: not set, so the feature is off).
2551 The path must include the executable's filename, i.e.\& /usr/local/bin/unrar.
2555 Tells MPlayer to handle the subtitle file as UTF-8.
2558 .B \-vobsub <VOBsub file without extension>
2559 Specify a VOBsub file to use for subtitles.
2560 Has to be the full pathname without extension, i.e.\& without
2561 the '.idx', '.ifo' or '.sub'.
2564 .B \-vobsubid <0\-31>
2565 Specify the VOBsub subtitle ID.
2569 .SH "AUDIO OUTPUT OPTIONS (MPLAYER ONLY)"
2572 .B \-abs <value> (\-ao oss only) (OBSOLETE)
2573 Override audio driver/\:card buffer size detection.
2576 .B \-format <format> (also see the format audio filter)
2577 Select the sample format used for output from the audio filter
2578 layer to the sound card.
2579 The values that <format> can adopt are listed below in the
2580 description of the format audio filter.
2584 Use a mixer device different from the default /dev/\:mixer.
2585 For ALSA this is the mixer name.
2588 .B \-mixer\-channel <mixer line>[,mixer index] (\-ao oss and \-ao alsa only)
2589 This option will tell MPlayer to use a different channel for controlling
2590 volume than the default PCM.
2591 Options for OSS include
2593 For a complete list of options look for SOUND_DEVICE_NAMES in
2594 /usr/\:include/\:linux/\:soundcard.h.
2595 For ALSA you can use the names e.g.\& alsamixer displays, like
2596 .B Master, Line, PCM.
2599 ALSA mixer channel names followed by a number must be specified in the
2600 <name,number> format, i.e.\& a channel labeled 'PCM 1' in alsamixer must
2606 Force the use of the software mixer, instead of using the sound card
2610 .B \-softvol\-max <10.0\-10000.0>
2611 Set the maximum amplification level in percent (default: 110).
2612 A value of 200 will allow you to adjust the volume up to a maximum of
2613 double the current level.
2614 With values below 100 the initial volume (which is 100%) will be above
2615 the maximum, which e.g.\& the OSD cannot display correctly.
2618 .B \-volstep <0\-100>
2619 Set the step size of mixer volume changes in percent of the whole range
2623 .B \-volume <-1\-100> (also see \-af volume)
2624 Set the startup volume in the mixer, either hardware or software (if
2625 used with \-softvol).
2626 A value of -1 (the default) will not change the volume.
2630 .SH "AUDIO OUTPUT DRIVERS (MPLAYER ONLY)"
2631 Audio output drivers are interfaces to different audio output facilities.
2635 .B \-ao <driver1[:suboption1[=value]:...],driver2,...[,]>
2636 Specify a priority list of audio output drivers to be used.
2638 If the list has a trailing ',' MPlayer will fall back on drivers not
2639 contained in the list.
2640 Suboptions are optional and can mostly be omitted.
2643 See \-ao help for a list of compiled-in audio output drivers.
2648 .IPs "\-ao alsa,oss,"
2649 Try the ALSA driver, then the OSS driver, then others.
2650 .IPs "\-ao alsa:noblock:device=hw=0.3"
2651 Sets noblock-mode and the device-name as first card, fourth device.
2655 Available audio output drivers are:
2659 ALSA 0.9/1.x audio output driver
2664 .IPs device=<device>
2665 Sets the device name.
2666 Replace any ',' with '.' and any ':' with '=' in the ALSA device name.
2667 For hwac3 output via S/PDIF, use an "iec958" or "spdif" device, unless
2668 you really know how to set it correctly.
2674 ALSA 0.5 audio output driver
2678 OSS audio output driver
2682 Sets the audio output device (default: /dev/\:dsp).
2684 Sets the audio mixer device (default: /dev/\:mixer).
2685 .IPs <mixer-channel>
2686 Sets the audio mixer channel (default: pcm).
2692 highly platform independent SDL (Simple Directmedia Layer) library
2697 Explicitly choose the SDL audio driver to use (default: let SDL choose).
2703 audio output through the aRts daemon
2707 audio output through the ESD daemon
2711 Explicitly choose the ESD server to use (default: localhost).
2717 audio output through JACK (Jack Audio Connection Kit)
2721 Connects to the ports with the given name (default: physical ports).
2722 .IPs name=<client name>
2723 Client name that is passed to JACK (default: MPlayer [<PID>]).
2724 Useful if you want to have certain connections established automatically.
2726 Estimate the audio delay, supposed to make the video playback smoother
2728 .IPs (no)autostart (default: disabled)
2729 Automatically start jackd if necessary.
2730 Note that this seems unreliable and will spam stdout with server messages.
2736 audio output through NAS
2739 .B coreaudio (Mac OS X only)
2740 native Mac OS X audio output driver
2744 Experimental OpenAL audio output driver
2748 PulseAudio audio output driver
2751 .IPs "[<host>][:<output sink>]"
2752 Specify the host and optionally output sink to use.
2753 An empty <host> string uses a local connection, "localhost"
2754 uses network transfer (most likely not what you want).
2760 native SGI audio output driver
2763 .IPs "<output device name>"
2764 Explicitly choose the output device/\:interface to use
2765 (default: system-wide default).
2766 For example, 'Analog Out' or 'Digital Out'.
2772 native Sun audio output driver
2776 Explicitly choose the audio device to use (default: /dev/\:audio).
2781 .B win32 (Windows only)
2782 native Windows waveout audio output driver
2785 .B dsound (Windows only)
2786 DirectX DirectSound audio output driver
2789 .IPs device=<devicenum>
2790 Sets the device number to use.
2791 Playing a file with \-v will show a list of available devices.
2797 OS/2 DART audio output driver
2801 Open DART in shareable or exclusive mode.
2803 Set buffer size to <size> in samples (default: 2048).
2808 .B dxr2 (also see \-dxr2) (DXR2 only)
2809 Creative DXR2 specific output driver
2813 IVTV specific MPEG audio output driver.
2814 Works with \-ac hwmpa only.
2817 .B v4l2 (requires Linux 2.6.22+ kernel)
2818 Audio output driver for V4L2 cards with hardware MPEG decoder.
2821 .B mpegpes (DVB only)
2822 Audio output driver for DVB cards that writes the output to an MPEG-PES
2823 file if no DVB card is installed.
2827 DVB card to use if more than one card is present.
2828 If not specified MPlayer will search the first usable card.
2829 .IPs file=<filename>
2836 Produces no audio output but maintains video playback speed.
2837 Use \-nosound for benchmarking.
2841 raw PCM/wave file writer audio output
2845 Include or do not include the wave header (default: included).
2846 When not included, raw PCM will be generated.
2847 .IPs file=<filename>
2848 Write the sound to <filename> instead of the default
2850 If nowaveheader is specified, the default is audiodump.pcm.
2852 Try to dump faster than realtime.
2853 Make sure the output does not get truncated (usually with
2854 "Too many video packets in buffer" message).
2855 It is normal that you get a "Your system is too SLOW to play this!" message.
2861 plugin audio output driver
2865 .SH "VIDEO OUTPUT OPTIONS (MPLAYER ONLY)"
2868 .B \-adapter <value>
2869 Set the graphics card that will receive the image.
2870 You can get a list of available cards when you run this option with \-v.
2871 Currently only works with the directx video output driver.
2875 Override the autodetected color depth.
2876 Only supported by the fbdev, dga, svga, vesa video output drivers.
2880 Play movie with window border and decorations.
2881 Since this is on by default, use \-noborder to disable the standard window
2885 .B \-brightness <\-100\-100>
2886 Adjust the brightness of the video signal (default: 0).
2887 Not supported by all video output drivers.
2890 .B \-contrast <\-100\-100>
2891 Adjust the contrast of the video signal (default: 0).
2892 Not supported by all video output drivers.
2895 .B \-display <name> (X11 only)
2896 Specify the hostname and display number of the X server you want to display
2902 \-display xtest.localdomain:0
2908 Turns on direct rendering (not supported by all codecs and video outputs)
2911 May cause OSD/SUB corruption!
2914 .B \-dxr2 <option1:option2:...>
2915 This option is used to control the dxr2 video output driver.
2917 .IPs ar-mode=<value>
2918 aspect ratio mode (0 = normal, 1 = pan-and-scan, 2 = letterbox (default))
2920 Set iec958 output mode to encoded.
2922 Set iec958 output mode to decoded (default).
2923 .IPs macrovision=<value>
2924 macrovision mode (0 = off (default), 1 = agc, 2 = agc 2 colorstripe,
2925 3 = agc 4 colorstripe)
2931 path to the microcode
2939 enable 7.5 IRE output mode
2941 disable 7.5 IRE output mode (default)
2945 color TV output (default)
2947 interlaced TV output (default)
2949 disable interlaced TV output
2951 TV norm (ntsc (default), pal, pal60, palm, paln, palnc)
2953 set pixel mode to square
2955 set pixel mode to ccir601
2962 .IPs cr-left=<0\-500>
2963 Set the left cropping value (default: 50).
2964 .IPs cr-right=<0\-500>
2965 Set the right cropping value (default: 300).
2966 .IPs cr-top=<0\-500>
2967 Set the top cropping value (default: 0).
2968 .IPs cr-bottom=<0\-500>
2969 Set the bottom cropping value (default: 0).
2970 .IPs ck-[r|g|b]=<0\-255>
2971 Set the r(ed), g(reen) or b(lue) gain of the overlay color-key.
2972 .IPs ck-[r|g|b]min=<0\-255>
2973 minimum value for the respective color key
2974 .IPs ck-[r|g|b]max=<0\-255>
2975 maximum value for the respective color key
2977 Ignore cached overlay settings.
2979 Update cached overlay settings.
2981 Enable overlay onscreen display.
2983 Disable overlay onscreen display (default).
2984 .IPs ol[h|w|x|y]-cor=<\-20\-20>
2985 Adjust the overlay size (h,w) and position (x,y) in case it does not
2986 match the window perfectly (default: 0).
2988 Activate overlay (default).
2991 .IPs overlay-ratio=<1\-2500>
2992 Tune the overlay (default: 1000).
2996 .B \-fbmode <modename> (\-vo fbdev only)
2997 Change video mode to the one that is labeled as <modename> in
3001 VESA framebuffer does not support mode changing.
3004 .B \-fbmodeconfig <filename> (\-vo fbdev only)
3005 Override framebuffer mode configuration file (default: /etc/\:fb.modes).
3008 .B \-force\-window\-position
3009 Forcefully move MPlayer's video output window to default location whenever
3010 there is a change in video parameters, video stream or file.
3011 This used to be the default behavior.
3012 Currently only affects X11 VOs.
3015 .B \-fs (also see \-zoom)
3016 Fullscreen playback (centers movie, and paints black bands around it).
3017 Not supported by all video output drivers.
3020 .B \-fsmode\-dontuse <0\-31> (OBSOLETE, use the \-fs option)
3021 Try this option if you still experience fullscreen problems.
3024 .B \-fstype <type1,type2,...> (X11 only)
3025 Specify a priority list of fullscreen modes to be used.
3026 You can negate the modes by prefixing them with '\-'.
3027 If you experience problems like the fullscreen window being covered
3028 by other windows try using a different order.
3031 See \-fstype help for a full list of available modes.
3033 The available types are:
3038 Use the _NETWM_STATE_ABOVE hint if available.
3040 Use the _NETWM_STATE_BELOW hint if available.
3042 Use the _NETWM_STATE_FULLSCREEN hint if available.
3044 Use the _WIN_LAYER hint with the default layer.
3046 Use the _WIN_LAYER hint with the given layer number.
3050 Do not set fullscreen window layer.
3052 Use _NETWM_STATE_STAYS_ON_TOP hint if available.
3060 .IPs layer,stays_on_top,above,fullscreen
3061 Default order, will be used as a fallback if incorrect or
3062 unsupported modes are specified.
3064 Fixes fullscreen switching on OpenBox 1.x.
3069 .B \-geometry x[%][:y[%]] or [WxH][+x+y]
3070 Adjust where the output is on the screen initially.
3071 The x and y specifications are in pixels measured from the top-left of the
3072 screen to the top-left of the image being displayed, however if a percentage
3073 sign is given after the argument it turns the value into a percentage of the
3074 screen size in that direction.
3075 It also supports the standard X11 \-geometry option format.
3076 If an external window is specified using the \-wid option, then the x and
3077 y coordinates are relative to the top-left corner of the window rather
3079 The coordinates are relative to the screen given with \-xineramascreen for
3080 the video output drivers that fully support \-xineramascreen (direct3d, gl, gl2,
3081 vdpau, x11, xv, xvmc).
3084 This option is only supported by the x11, xmga, xv, xvmc, xvidix,
3085 gl, gl2, directx, fbdev and tdfxfb video output drivers.
3091 Places the window at x=50, y=40.
3093 Places the window in the middle of the screen.
3095 Places the window at the middle of the right edge of the screen.
3097 Places the window at the bottom right corner of the screen.
3102 .B \-hue <\-100\-100>
3103 Adjust the hue of the video signal (default: 0).
3104 You can get a colored negative of the image with this option.
3105 Not supported by all video output drivers.
3108 .B \-monitor\-dotclock <range[,range,...]> (\-vo fbdev and vesa only)
3109 Specify the dotclock or pixelclock range of the monitor.
3112 .B \-monitor\-hfreq <range[,range,...]> (\-vo fbdev and vesa only)
3113 Specify the horizontal frequency range of the monitor.
3116 .B \-monitor\-vfreq <range[,range,...]> (\-vo fbdev and vesa only)
3117 Specify the vertical frequency range of the monitor.
3120 .B \-monitoraspect <ratio> (also see \-aspect)
3121 Set the aspect ratio of your monitor or TV screen.
3122 A value of 0 disables a previous setting (e.g.\& in the config file).
3123 Overrides the \-monitorpixelaspect setting if enabled.
3128 \-monitoraspect 4:3 or 1.3333
3130 \-monitoraspect 16:9 or 1.7777
3135 .B \-monitorpixelaspect <ratio> (also see \-aspect)
3136 Set the aspect of a single pixel of your monitor or TV screen (default: 1).
3137 A value of 1 means square pixels
3138 (correct for (almost?) all LCDs).
3142 Disables double buffering, mostly for debugging purposes.
3143 Double buffering fixes flicker by storing two frames in memory, and
3144 displaying one while decoding another.
3145 It can affect OSD negatively, but often removes OSD flickering.
3149 Do not grab the mouse pointer after a video mode change (\-vm).
3150 Useful for multihead setups.
3154 Do not keep window aspect ratio when resizing windows.
3155 Only works with the x11, xv, xmga, xvidix, directx video output drivers.
3156 Furthermore under X11 your window manager has to honor window aspect hints.
3160 Makes the player window stay on top of other windows.
3161 Supported by video output drivers which use X11, except SDL,
3162 as well as directx, corevideo, quartz, ggi and gl2.
3165 .B \-panscan <0.0\-1.0>
3166 Enables pan-and-scan functionality (cropping the sides of e.g.\& a 16:9
3167 movie to make it fit a 4:3 display without black bands).
3168 The range controls how much of the image is cropped.
3169 Only works with the xv, xmga, mga, gl, gl2, quartz, corevideo and xvidix
3170 video output drivers.
3173 Values between \-1 and 0 are allowed as well, but highly experimental
3174 and may crash or worse.
3175 Use at your own risk!
3178 .B \-panscanrange <\-19.0\-99.0> (experimental)
3179 Change the range of the pan-and-scan functionality (default: 1).
3180 Positive values mean multiples of the default range.
3181 Negative numbers mean you can zoom in up to a factor of \-panscanrange+1.
3182 E.g.\& \-panscanrange \-3 allows a zoom factor of up to 4.
3183 This feature is experimental.
3184 Do not report bugs unless you are using \-vo gl.
3187 .B \-refreshrate <Hz>
3188 Set the monitor refreshrate in Hz.
3189 Currently only supported by \-vo directx combined with the \-vm option.
3193 Play movie in the root window (desktop background).
3194 Desktop background images may cover the movie window, though.
3195 Only works with the x11, xv, xmga, xvidix, quartz, corevideo and directx video output drivers.
3198 .B \-saturation <\-100\-100>
3199 Adjust the saturation of the video signal (default: 0).
3200 You can get grayscale output with this option.
3201 Not supported by all video output drivers.
3204 .B \-screenh <pixels>
3205 Specify the screen height for video output drivers which
3206 do not know the screen resolution like fbdev, x11 and TV-out.
3209 .B \-screenw <pixels>
3210 Specify the screen width for video output drivers which
3211 do not know the screen resolution like fbdev, x11 and TV-out.
3214 .B \-stop\-xscreensaver (X11 only)
3215 Turns off xscreensaver at startup and turns it on again on exit.
3216 If your screensaver supports neither the XSS nor XResetScreenSaver
3217 API please use \-heartbeat\-cmd instead.
3221 Try to change to a different video mode.
3222 Supported by the dga, x11, xv, sdl and directx video output drivers.
3223 If used with the directx video output driver the \-screenw,
3224 \-screenh, \-bpp and \-refreshrate options can be used to set
3225 the new display mode.
3229 Enables VBI for the vesa, dfbmga and svga video output drivers.
3232 .B \-wid <window ID> (X11, OpenGL and DirectX only)
3233 This tells MPlayer to attach to an existing window.
3234 Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
3237 .B \-xineramascreen <\-2\-...>
3238 In Xinerama configurations (i.e.\& a single desktop that spans across multiple
3239 displays) this option tells MPlayer which screen to display the movie on.
3240 A value of \-2 means fullscreen across the whole virtual display (in this case
3241 Xinerama information is completely ignored), \-1 means
3242 fullscreen on the display the window currently is on.
3243 The initial position set via the \-geometry option is relative to the
3245 Will usually only work with "\-fstype \-fullscreen" or "\-fstype none".
3246 This option is not suitable to only set the startup screen (because
3247 it will always display on the given screen in fullscreen mode),
3248 \-geometry is the best that is available for that purpose
3250 Supported by at least the direct3d, gl, gl2, x11 and xv video output drivers.
3253 .B \-zrbw (\-vo zr only)
3254 Display in black and white.
3255 For optimal performance, this can be combined with '\-lavdopts gray'.
3258 .B \-zrcrop <[width]x[height]+[x offset]+[y offset]> (\-vo zr only)
3259 Select a part of the input image to display, multiple occurrences
3260 of this option switch on cinerama mode.
3261 In cinerama mode the movie is distributed over more than one TV
3262 (or beamer) to create a larger image.
3263 Options appearing after the n-th \-zrcrop apply to the n-th MJPEG card, each
3264 card should at least have a \-zrdev in addition to the \-zrcrop.
3265 For examples, see the output of \-zrhelp and the Zr section of the
3269 .B \-zrdev <device> (\-vo zr only)
3270 Specify the device special file that belongs to your MJPEG card, by default
3271 the zr video output driver takes the first v4l device it can find.
3274 .B \-zrfd (\-vo zr only)
3275 Force decimation: Decimation, as specified by \-zrhdec and \-zrvdec, only
3276 happens if the hardware scaler can stretch the image to its original size.
3277 Use this option to force decimation.
3280 .B \-zrhdec <1|2|4> (\-vo zr only)
3281 Horizontal decimation: Ask the driver to send only every 2nd or 4th
3282 line/\:pixel of the input image to the MJPEG card and use the scaler
3283 of the MJPEG card to stretch the image to its original size.
3286 .B \-zrhelp (\-vo zr only)
3287 Display a list of all \-zr* options, their default values and a
3288 cinerama mode example.
3291 .B \-zrnorm <norm> (\-vo zr only)
3292 Specify the TV norm as PAL or NTSC (default: no change).
3295 .B \-zrquality <1\-20> (\-vo zr only)
3296 A number from 1 (best) to 20 (worst) representing the JPEG encoding quality.
3299 .B \-zrvdec <1|2|4> (\-vo zr only)
3300 Vertical decimation: Ask the driver to send only every 2nd or 4th
3301 line/\:pixel of the input image to the MJPEG card and use the scaler
3302 of the MJPEG card to stretch the image to its original size.
3305 .B \-zrxdoff <x display offset> (\-vo zr only)
3306 If the movie is smaller than the TV screen, this option specifies the x
3307 offset from the upper-left corner of the TV screen (default: centered).
3310 .B \-zrydoff <y display offset> (\-vo zr only)
3311 If the movie is smaller than the TV screen, this option specifies the y
3312 offset from the upper-left corner of the TV screen (default: centered).
3316 .SH "VIDEO OUTPUT DRIVERS (MPLAYER ONLY)"
3317 Video output drivers are interfaces to different video output facilities.
3321 .B \-vo <driver1[:suboption1[=value]:...],driver2,...[,]>
3322 Specify a priority list of video output drivers to be used.
3324 If the list has a trailing ',' MPlayer will fall back on drivers not
3325 contained in the list.
3326 Suboptions are optional and can mostly be omitted.
3329 See \-vo help for a list of compiled-in video output drivers.
3334 .IPs "\-vo xmga,xv,"
3335 Try the Matrox X11 driver, then the Xv driver, then others.
3336 .IPs "\-vo directx:noaccel"
3337 Uses the DirectX driver with acceleration features turned off.
3341 Available video output drivers are:
3345 Uses the XVideo extension of XFree86 4.x to enable hardware
3346 accelerated playback.
3347 If you cannot use a hardware specific driver, this is probably
3349 For information about what colorkey is used and how it is drawn run MPlayer
3350 with \-v option and look out for the lines tagged with [xv common] at the
3354 .IPs adaptor=<number>
3355 Select a specific XVideo adaptor (check xvinfo results).
3357 Select a specific XVideo port.
3358 .IPs ck=<cur|use|set>
3359 Select the source from which the colorkey is taken (default: cur).
3362 The default takes the colorkey currently set in Xv.
3364 Use but do not set the colorkey from MPlayer (use \-colorkey option to change
3367 Same as use but also sets the supplied colorkey.
3369 .IPs ck-method=<man|bg|auto>
3370 Sets the colorkey drawing method (default: man).
3373 Draw the colorkey manually (reduces flicker in some cases).
3375 Set the colorkey as window background.
3377 Let Xv draw the colorkey.
3384 Shared memory video output driver without hardware acceleration that
3385 works whenever X11 is present.
3389 Adds X11 support to all overlay based video output drivers.
3390 Currently only supported by tdfx_vid.
3394 Select the driver to use as source to overlay on top of X11.
3399 .B vdpau (with \-vc ffmpeg12vdpau, ffwmv3vdpau, ffvc1vdpau or ffh264vdpau)
3400 Video output that uses VDPAU to decode video via hardware.
3401 Also supports displaying of software-decoded video.
3404 .IPs sharpen=<\-1\-1>
3405 For positive values, apply a sharpening algorithm to the video,
3406 for negative values a blurring algorithm (default: 0).
3408 Apply a noise reduction algorithm to the video (default: 0, no noise reduction).
3410 Chooses the deinterlacer (default: 0).
3411 All modes > 0 respect \-field\-dominance.
3416 Show only first field, similar to \-vf field.
3418 Bob deinterlacing, similar to \-vf tfields=1.
3420 Motion adaptive temporal deinterlacing.
3421 May lead to A/V desync with slow video hardware and/or high resolution.
3422 This is the default if "D" is used to enable deinterlacing.
3424 Motion adaptive temporal deinterlacing with edge-guided spatial interpolation.
3425 Needs fast video hardware.
3428 Makes temporal deinterlacers operate both on luma and chroma (default).
3429 Use nochroma\-deint to solely use luma and speed up advanced deinterlacing.
3430 Useful with slow video memory.
3432 Try to apply inverse telecine, needs motion adaptive temporal deinterlacing.
3437 .B xvmc (X11 with \-vc ffmpeg12mc only)
3438 Video output driver that uses the XvMC (X Video Motion Compensation)
3439 extension of XFree86 4.x to speed up MPEG-1/2 and VCR2 decoding.
3442 .IPs adaptor=<number>
3443 Select a specific XVideo adaptor (check xvinfo results).
3445 Select a specific XVideo port.
3447 Disables image display.
3448 Necessary for proper benchmarking of drivers that change
3449 image buffers on monitor retrace only (nVidia).
3450 Default is not to disable image display (nobenchmark).
3452 Very simple deinterlacer.
3453 Might not look better than \-vf tfields=1,
3454 but it is the only deinterlacer for xvmc (default: nobobdeint).
3456 Queue frames for display to allow more parallel work of the video hardware.
3457 May add a small (not noticeable) constant A/V desync (default: noqueue).
3459 Use sleep function while waiting for rendering to finish
3460 (not recommended on Linux) (default: nosleep).
3462 Same as \-vo xv:ck (see \-vo xv).
3463 .IPs ck-method=man|bg|auto
3464 Same as \-vo xv:ck-method (see \-vo xv).
3470 Play video through the XFree86 Direct Graphics Access extension.
3471 Considered obsolete.
3474 .B sdl (SDL only, buggy/outdated)
3475 Highly platform independent SDL (Simple Directmedia Layer) library
3476 video output driver.
3477 Since SDL uses its own X11 layer, MPlayer X11 options do not have
3479 Note that it has several minor bugs (\-vm/\-novm is mostly ignored,
3480 \-fs behaves like \-novm should, window is in top-left corner when
3481 returning from fullscreen, panscan is not supported, ...)
3484 .IPs driver=<driver>
3485 Explicitly choose the SDL driver to use.
3487 Use XVideo through the sdl video output driver (default: forcexv).
3489 Use hardware accelerated scaler (default: hwaccel).
3495 VIDIX (VIDeo Interface for *niX) is an interface to the
3496 video acceleration features of different graphics cards.
3497 Very fast video output driver on cards that support it.
3501 Explicitly choose the VIDIX subdevice driver to use.
3502 Available subdevice drivers are cyberblade, ivtv, mach64,
3503 mga_crtc2, mga, nvidia, pm2, pm3, radeon, rage128, s3, sh_veu,
3504 sis_vid and unichrome.
3509 .B xvidix (X11 only)
3510 X11 frontend for VIDIX
3520 Generic and platform independent VIDIX frontend, can even run in a
3521 text console with nVidia cards.
3530 .B winvidix (Windows only)
3531 Windows frontend for VIDIX
3540 .B direct3d (Windows only) (BETA CODE!)
3541 Video output driver that uses the Direct3D interface (useful for Vista).
3544 .B directx (Windows only)
3545 Video output driver that uses the DirectX interface.
3549 Turns off hardware acceleration.
3550 Try this option if you have display problems.
3556 Video output driver that uses the libkva interface.
3562 Force WarpOverlay! mode.
3566 Enable/disable workaround for T23 laptop (default: \-not23).
3567 Try to enable this option if your video card supports upscaling only.
3572 .B quartz (Mac OS X only)
3573 Mac OS X Quartz video output driver.
3574 Under some circumstances, it might be more efficient to force a
3575 packed YUV output format, with e.g.\& \-vf format=yuy2.
3578 .IPs device_id=<number>
3579 Choose the display device to use in fullscreen.
3580 .IPs fs_res=<width>:<height>
3581 Specify the fullscreen resolution (useful on slow systems).
3586 .B corevideo (Mac OS X 10.4 or 10.3.9 with QuickTime 7)
3587 Mac OS X CoreVideo video output driver
3590 .IPs device_id=<number>
3591 Choose the display device to use for fullscreen or set it to \-1 to
3592 always use the same screen the video window is on (default: \-1 \- auto).
3594 Write output to a shared memory buffer instead of displaying it and
3595 try to open an existing NSConnection for communication with a GUI.
3596 .IPs buffer_name=<name>
3597 Name of the shared buffer created with shm_open as well as the name of
3598 the NSConnection MPlayer will try to open (default: "mplayerosx").
3599 Setting buffer_name implicitly enables shared_buffer.
3604 .B fbdev (Linux only)
3605 Uses the kernel framebuffer to play video.
3609 Explicitly choose the fbdev device name to use (e.g.\& /dev/\:fb0) or the
3610 name of the VIDIX subdevice if the device name starts with 'vidix'
3611 (e.g.\& 'vidixsis_vid' for the sis driver).
3616 .B fbdev2 (Linux only)
3617 Uses the kernel framebuffer to play video,
3618 alternative implementation.
3622 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3628 Very general video output driver that should work on any VESA VBE 2.0
3633 Turns DGA mode on or off (default: on).
3635 Activate the NeoMagic TV out and set it to PAL norm.
3637 Activate the NeoMagic TV out and set it to NTSC norm.
3639 Use the VIDIX driver.
3641 Activate the Linux Video Overlay on top of VESA mode.
3647 Play video using the SVGA library.
3651 Specify video mode to use.
3652 The mode can be given in a <width>x<height>x<colors> format,
3653 e.g.\& 640x480x16M or be a graphics mode number, e.g.\& 84.
3655 Draw OSD into black bands below the movie (slower).
3657 Use only native drawing functions.
3658 This avoids direct rendering, OSD and hardware acceleration.
3660 Force frame switch on vertical retrace.
3661 Usable only with \-double.
3662 It has the same effect as the \-vsync option.
3664 Try to select a video mode with square pixels.
3666 Use svga with VIDIX.
3672 OpenGL video output driver, simple version.
3673 Video size must be smaller than
3674 the maximum texture size of your OpenGL implementation.
3675 Intended to work even with the most basic OpenGL implementations,
3676 but also makes use of newer extensions, which allow support for more
3677 colorspaces and direct rendering.
3678 For optimal speed try something similar to
3680 \-vo gl:yuv=2:rectangle=2:force\-pbo:ati\-hack \-dr \-noslices
3682 The code performs very few checks, so if a feature does not work, this
3683 might be because it is not supported by your card/OpenGL implementation
3684 even if you do not get any error message.
3685 Use glxinfo or a similar tool to display the supported OpenGL extensions.
3689 ATI drivers may give a corrupted image when PBOs are used (when using \-dr
3691 This option fixes this, at the expense of using a bit more memory.
3693 Always uses PBOs to transfer textures even if this involves an extra copy.
3694 Currently this gives a little extra speed with NVidia drivers and a lot more
3695 speed with ATI drivers.
3696 May need \-noslices and the ati\-hack suboption to work correctly.
3698 Changes the way the OSD behaves when the size of the
3699 window changes (default: disabled).
3700 When enabled behaves more like the other video output drivers,
3701 which is better for fixed-size fonts.
3702 Disabled looks much better with FreeType fonts and uses the
3703 borders in fullscreen mode.
3704 Does not work correctly with ass subtitles (see \-ass), you can instead
3705 render them without OpenGL support via \-vf ass.
3706 .IPs osdcolor=<0xAARRGGBB>
3707 Color for OSD (default: 0x00ffffff, corresponds to non-transparent white).
3708 .IPs rectangle=<0,1,2>
3709 Select usage of rectangular textures which saves video RAM, but often is
3710 slower (default: 0).
3712 0: Use power-of-two textures (default).
3714 1: Use the GL_ARB_texture_rectangle extension.
3716 2: Use the GL_ARB_texture_non_power_of_two extension.
3717 In some cases only supported in software and thus very slow.
3719 .IPs swapinterval=<n>
3720 Minimum interval between two buffer swaps, counted in
3721 displayed frames (default: 1).
3722 1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
3723 Values below 0 will leave it at the system default.
3724 This limits the framerate to (horizontal refresh rate / n).
3725 Requires GLX_SGI_swap_control support to work.
3726 With some (most/all?) implementations this only works in fullscreen mode.
3728 Select the type of YUV to RGB conversion.
3730 0: Use software conversion (default).
3731 Compatible with all OpenGL versions.
3732 Provides brightness, contrast and saturation control.
3734 1: Use register combiners.
3735 This uses an nVidia-specific extension (GL_NV_register_combiners).
3736 At least three texture units are needed.
3737 Provides saturation and hue control.
3738 This method is fast but inexact.
3740 2: Use a fragment program.
3741 Needs the GL_ARB_fragment_program extension and at least three texture units.
3742 Provides brightness, contrast, saturation and hue control.
3744 3: Use a fragment program using the POW instruction.
3745 Needs the GL_ARB_fragment_program extension and at least three texture units.
3746 Provides brightness, contrast, saturation, hue and gamma control.
3747 Gamma can also be set independently for red, green and blue.
3748 Method 4 is usually faster.
3750 4: Use a fragment program with additional lookup.
3751 Needs the GL_ARB_fragment_program extension and at least four texture units.
3752 Provides brightness, contrast, saturation, hue and gamma control.
3753 Gamma can also be set independently for red, green and blue.
3755 5: Use ATI-specific method (for older cards).
3756 This uses an ATI-specific extension (GL_ATI_fragment_shader \- not
3757 GL_ARB_fragment_shader!).
3758 At least three texture units are needed.
3759 Provides saturation and hue control.
3760 This method is fast but inexact.
3762 6: Use a 3D texture to do conversion via lookup.
3763 Needs the GL_ARB_fragment_program extension and at least four texture units.
3764 Extremely slow (software emulation) on some (all?) ATI cards since it uses
3765 a texture with border pixels.
3766 Provides brightness, contrast, saturation, hue and gamma control.
3767 Gamma can also be set independently for red, green and blue.
3768 Speed depends more on GPU memory bandwidth than other methods.
3771 Use the GL_MESA_ycbcr_texture extension to convert YUV to RGB.
3772 In most cases this is probably slower than doing software conversion to RGB.
3774 Select the scaling function to use for luminance scaling.
3775 Only valid for yuv modes 2, 3, 4 and 6.
3777 0: Use simple linear filtering (default).
3779 1: Use bicubic B-spline filtering (better quality).
3780 Needs one additional texture unit.
3781 Older cards will not be able to handle this for chroma at least in fullscreen mode.
3783 2: Use cubic filtering in horizontal, linear filtering in vertical direction.
3784 Works on a few more cards than method 1.
3786 3: Same as 1 but does not use a lookup texture.
3787 Might be faster on some cards.
3789 4: Use experimental unsharp masking with 3x3 support and a default strength of 0.5 (see filter-strength).
3791 5: Use experimental unsharp masking with 5x5 support and a default strength of 0.5 (see filter-strength).
3794 Select the scaling function to use for chrominance scaling.
3795 For details see lscale.
3796 .IPs filter-strength=<value>
3797 Set the effect strength for the lscale/cscale filters that support it.
3798 .IPs customprog=<filename>
3799 Load a custom fragment program from <filename>.
3800 See TOOLS/edgedect.fp for an example.
3801 .IPs customtex=<filename>
3802 Load a custom "gamma ramp" texture from <filename>.
3803 This can be used in combination with yuv=4 or with the customprog option.
3805 If enabled (default) use GL_LINEAR interpolation, otherwise use GL_NEAREST
3806 for customtex texture.
3807 .IPs (no)customtrect
3808 If enabled, use texture_rectangle for customtex texture.
3809 Default is disabled.
3813 Normally there is no reason to use the following options, they mostly
3814 exist for testing purposes.
3819 Call glFinish() before swapping buffers.
3820 Slower but in some cases more correct output (default: disabled).
3822 Enables support for more (RGB and BGR) color formats (default: enabled).
3823 Needs OpenGL version >= 1.2.
3824 .IPs slice-height=<0\-...>
3825 Number of lines copied to texture in one piece (default: 0).
3829 If YUV colorspace is used (see yuv suboption), special rules apply:
3831 If the decoder uses slice rendering (see \-noslices), this setting
3832 has no effect, the size of the slices as provided by the decoder is used.
3834 If the decoder does not use slice rendering, the default is 16.
3837 Enable or disable support for OSD rendering via OpenGL (default: enabled).
3838 This option is for testing; to disable the OSD use \-osdlevel 0 instead.
3840 Enable or disable aspect scaling and pan-and-scan support (default: enabled).
3841 Disabling might increase speed.
3848 Variant of the OpenGL video output driver.
3849 Supports videos larger than the maximum texture size but lacks many of the
3850 advanced features and optimizations of the gl driver and is unlikely to be
3855 same as gl (default: enabled)
3857 Select the type of YUV to RGB conversion.
3858 If set to anything except 0 OSD will be disabled and brightness, contrast and
3859 gamma setting is only available via the global X server settings.
3860 Apart from this the values have the same meaning as for \-vo gl.
3865 Produces no video output.
3866 Useful for benchmarking.
3870 ASCII art video output driver that works on a text console.
3871 You can get a list and an explanation of available suboptions
3872 by executing 'mplayer \-vo aa:help'.
3875 The driver does not handle \-aspect correctly.
3878 You probably have to specify \-monitorpixelaspect.
3879 Try 'mplayer \-vo aa \-monitorpixelaspect 0.5'.
3883 Color ASCII art video output driver that works on a text console.
3887 Video playback using the Blinkenlights UDP protocol.
3888 This driver is highly hardware specific.
3892 Explicitly choose the Blinkenlights subdevice driver to use.
3893 It is something like arcade:host=localhost:2323 or
3894 hdl:file=name1,file=name2.
3895 You must specify a subdevice.
3901 GGI graphics system video output driver
3905 Explicitly choose the GGI driver to use.
3906 Replace any ',' that would appear in the driver string by a '.'.
3912 Play video using the DirectFB library.
3916 Use the DirectFB instead of the MPlayer keyboard code (default: enabled).
3917 .IPs buffermode=single|double|triple
3918 Double and triple buffering give best results if you want to avoid tearing issues.
3919 Triple buffering is more efficient than double buffering as it does
3920 not block MPlayer while waiting for the vertical retrace.
3921 Single buffering should be avoided (default: single).
3922 .IPs fieldparity=top|bottom
3923 Control the output order for interlaced frames (default: disabled).
3924 Valid values are top = top fields first, bottom = bottom fields first.
3925 This option does not have any effect on progressive film material
3926 like most MPEG movies are.
3927 You need to enable this option if you have tearing issues or unsmooth
3928 motions watching interlaced film material.
3930 Will force layer with ID N for playback (default: \-1 \- auto).
3932 Specify a parameter list for DirectFB.
3938 Matrox G400/\:G450/\:G550 specific video output driver that uses the
3939 DirectFB library to make use of special hardware features.
3940 Enables CRTC2 (second head), displaying video independently of the first head.
3944 same as directfb (default: disabled)
3945 .IPs buffermode=single|double|triple
3946 same as directfb (default: triple)
3947 .IPs fieldparity=top|bottom
3950 Enable the use of the Matrox BES (backend scaler) (default: disabled).
3951 Gives very good results concerning speed and output quality as interpolated
3952 picture processing is done in hardware.
3953 Works only on the primary head.
3955 Make use of the Matrox sub picture layer to display the OSD (default: enabled).
3957 Turn on TV-out on the second head (default: enabled).
3958 The output quality is amazing as it is a full interlaced picture
3959 with proper sync to every odd/\:even field.
3960 .IPs tvnorm=pal|ntsc|auto
3961 Will set the TV norm of the Matrox card without the need
3962 for modifying /etc/\:directfbrc (default: disabled).
3963 Valid norms are pal = PAL, ntsc = NTSC.
3964 Special norm is auto (auto-adjust using PAL/\:NTSC) because it decides
3965 which norm to use by looking at the framerate of the movie.
3971 Matrox specific video output driver that makes use of the YUV back
3972 end scaler on Gxxx cards through a kernel module.
3973 If you have a Matrox card, this is the fastest option.
3977 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3982 .B xmga (Linux, X11 only)
3983 The mga video output driver, running in an X11 window.
3987 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3992 .B s3fb (Linux only) (also see \-vf yuv2 and \-dr)
3993 S3 Virge specific video output driver.
3994 This driver supports the card's YUV conversion and scaling, double
3995 buffering and direct rendering features.
3996 Use \-vf yuy2 to get hardware-accelerated YUY2 rendering, which is
3997 much faster than YV12 on this card.
4001 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
4007 Nintendo Wii/GameCube specific video output driver.
4010 .B 3dfx (Linux only)
4011 3dfx-specific video output driver that directly uses
4012 the hardware on top of X11.
4013 Only 16 bpp are supported.
4016 .B tdfxfb (Linux only)
4017 This driver employs the tdfxfb framebuffer driver to play movies with
4018 YUV acceleration on 3dfx cards.
4022 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
4027 .B tdfx_vid (Linux only)
4028 3dfx-specific video output driver that works in combination with
4029 the tdfx_vid kernel module.
4033 Explicitly choose the device name to use (default: /dev/\:tdfx_vid).
4038 .B dxr2 (also see \-dxr2) (DXR2 only)
4039 Creative DXR2 specific video output driver.
4043 Output video subdriver to use as overlay (x11, xv).
4049 Sigma Designs em8300 MPEG decoder chip (Creative DXR3, Sigma Designs
4050 Hollywood Plus) specific video output driver.
4051 Also see the lavc video filter.
4055 Activates the overlay instead of TV-out.
4057 Turns on prebuffering.
4059 Will turn on the new sync-engine.
4061 Specifies the TV norm.
4063 0: Does not change current norm (default).
4065 1: Auto-adjust using PAL/\:NTSC.
4067 2: Auto-adjust using PAL/\:PAL-60.
4076 Specifies the device number to use if you have more than one em8300 card.
4082 Conexant CX23415 (iCompression iTVC15) or Conexant CX23416 (iCompression
4083 iTVC16) MPEG decoder chip (Hauppauge WinTV PVR-150/250/350/500)
4084 specific video output driver for TV-out.
4085 Also see the lavc video filter.
4089 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
4091 Explicitly choose the TV-out output to be used for the video signal.
4096 .B v4l2 (requires Linux 2.6.22+ kernel)
4097 Video output driver for V4L2 compliant cards with built-in hardware MPEG decoder.
4098 Also see the lavc video filter.
4102 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
4104 Explicitly choose the TV-out output to be used for the video signal.
4109 .B mpegpes (DVB only)
4110 Video output driver for DVB cards that writes the output to an MPEG-PES file
4111 if no DVB card is installed.
4115 Specifies the device number to use if you have more than one DVB output card
4116 (V3 API only, such as 1.x.y series drivers).
4117 If not specified MPlayer will search the first usable card.
4119 output filename (default: ./grab.mpg)
4124 .B zr (also see \-zr* and \-zrhelp)
4125 Video output driver for a number of MJPEG capture/\:playback cards.
4128 .B zr2 (also see the zrmjpeg video filter)
4129 Video output driver for a number of MJPEG capture/\:playback cards,
4134 Specifies the video device to use.
4135 .IPs norm=<PAL|NTSC|SECAM|auto>
4136 Specifies the video norm to use (default: auto).
4138 (De)Activate prebuffering, not yet supported.
4144 Calculate MD5 sums of each frame and write them to a file.
4145 Supports RGB24 and YV12 colorspaces.
4146 Useful for debugging.
4149 .IPs outfile=<value>
4150 Specify the output filename (default: ./md5sums).
4156 Transforms the video stream into a sequence of uncompressed YUV 4:2:0
4157 images and stores it in a file (default: ./stream.yuv).
4158 The format is the same as the one employed by mjpegtools, so this is
4159 useful if you want to process the video with the mjpegtools suite.
4160 It supports the YV12, RGB (24 bpp) and BGR (24 bpp) format.
4161 You can combine it with the \-fixed\-vo option to concatenate files
4162 with the same dimensions and fps value.
4166 Write the output as interlaced frames, top field first.
4168 Write the output as interlaced frames, bottom field first.
4169 .IPs file=<filename>
4170 Write the output to <filename> instead of the default stream.yuv.
4176 If you do not specify any option the output is progressive
4177 (i.e.\& not interlaced).
4182 Output each frame into a single animated GIF file in the current directory.
4183 It supports only RGB format with 24 bpp and the output is converted to 256
4188 Float value to specify framerate (default: 5.0).
4190 Specify the output filename (default: ./out.gif).
4196 You must specify the framerate before the filename or the framerate will
4197 be part of the filename.
4203 mplayer video.nut \-vo gif89a:fps=15:output=test.gif
4209 Output each frame into a JPEG file in the current directory.
4210 Each file takes the frame number padded with leading zeros as name.
4213 .IPs [no]progressive
4214 Specify standard or progressive JPEG (default: noprogressive).
4216 Specify use of baseline or not (default: baseline).
4217 .IPs optimize=<0\-100>
4218 optimization factor (default: 100)
4219 .IPs smooth=<0\-100>
4220 smooth factor (default: 0)
4221 .IPs quality=<0\-100>
4222 quality factor (default: 75)
4223 .IPs outdir=<dirname>
4224 Specify the directory to save the JPEG files to (default: ./).
4225 .IPs subdirs=<prefix>
4226 Create numbered subdirectories with the specified prefix to
4227 save the files in instead of the current directory.
4228 .IPs "maxfiles=<value> (subdirs only)"
4229 Maximum number of files to be saved per subdirectory.
4230 Must be equal to or larger than 1 (default: 1000).
4236 Output each frame into a PNM file in the current directory.
4237 Each file takes the frame number padded with leading zeros as name.
4238 It supports PPM, PGM and PGMYUV files in both raw and ASCII mode.
4239 Also see pnm(5), ppm(5) and pgm(5).
4243 Write PPM files (default).
4248 PGMYUV is like PGM, but it also contains the U and V plane, appended at the
4249 bottom of the picture.
4251 Write PNM files in raw mode (default).
4253 Write PNM files in ASCII mode.
4254 .IPs outdir=<dirname>
4255 Specify the directory to save the PNM files to (default: ./).
4256 .IPs subdirs=<prefix>
4257 Create numbered subdirectories with the specified prefix to
4258 save the files in instead of the current directory.
4259 .IPs "maxfiles=<value> (subdirs only)"
4260 Maximum number of files to be saved per subdirectory.
4261 Must be equal to or larger than 1 (default: 1000).
4267 Output each frame into a PNG file in the current directory.
4268 Each file takes the frame number padded with leading zeros as name.
4269 24bpp RGB and BGR formats are supported.
4273 Specifies the compression level.
4274 0 is no compression, 9 is maximum compression.
4275 .IPs alpha (default: noalpha)
4276 Create PNG files with an alpha channel.
4277 Note that MPlayer in general does not support alpha, so this will only
4278 be useful in some rare cases.
4284 Output each frame into a Targa file in the current directory.
4285 Each file takes the frame number padded with leading zeros as name.
4286 The purpose of this video output driver is to have a simple lossless
4287 image writer to use without any external library.
4288 It supports the BGR[A] color format, with 15, 24 and 32 bpp.
4289 You can force a particular format with the format video filter.
4295 mplayer video.nut \-vf format=bgr15 \-vo tga
4301 .SH "DECODING/FILTERING OPTIONS"
4304 .B \-ac <[\-|+]codec1,[\-|+]codec2,...[,]>
4305 Specify a priority list of audio codecs to be used, according to their codec
4306 name in codecs.conf.
4307 Use a '\-' before the codec name to omit it.
4308 Use a '+' before the codec name to force it, this will likely crash!
4309 If the list has a trailing ',' MPlayer will fall back on codecs not
4310 contained in the list.
4313 See \-ac help for a full list of available codecs.
4319 Force the l3codeca.acm MP3 codec.
4321 Try libmad first, then fall back on others.
4322 .IPs "\-ac hwac3,a52,"
4323 Try hardware AC-3 passthrough, software AC-3, then others.
4325 Try hardware DTS passthrough, then fall back on others.
4326 .IPs "\-ac \-ffmp3,"
4327 Skip FFmpeg's MP3 decoder.
4332 .B \-af\-adv <force=(0\-7):list=(filters)> (also see \-af)
4333 Specify advanced audio filter options:
4336 Forces the insertion of audio filters to one of the following:
4338 0: Use completely automatic filter insertion.
4340 1: Optimize for accuracy (default).
4342 2: Optimize for speed.
4344 Some features in the audio filters may silently fail,
4345 and the sound quality may drop.
4347 3: Use no automatic insertion of filters and no optimization.
4349 It may be possible to crash MPlayer using this setting.
4351 4: Use automatic insertion of filters according to 0 above,
4352 but use floating point processing when possible.
4354 5: Use automatic insertion of filters according to 1 above,
4355 but use floating point processing when possible.
4357 6: Use automatic insertion of filters according to 2 above,
4358 but use floating point processing when possible.
4360 7: Use no automatic insertion of filters according to 3 above,
4361 and use floating point processing when possible.
4368 .B \-afm <driver1,driver2,...>
4369 Specify a priority list of audio codec families to be used, according
4370 to their codec name in codecs.conf.
4371 Falls back on the default codecs if none of the given codec families work.
4374 See \-afm help for a full list of available codec families.
4380 Try FFmpeg's libavcodec codecs first.
4381 .IPs "\-afm acm,dshow"
4382 Try Win32 codecs first.
4387 .B \-aspect <ratio> (also see \-zoom)
4388 Override movie aspect ratio, in case aspect information is
4389 incorrect or missing in the file being played.
4394 \-aspect 4:3 or \-aspect 1.3333
4396 \-aspect 16:9 or \-aspect 1.7777
4402 Disable automatic movie aspect ratio compensation.
4405 .B "\-field\-dominance <\-1\-1>"
4406 Set first field for interlaced content.
4407 Useful for deinterlacers that double the framerate: \-vf tfields=1,
4408 \-vf yadif=1, \-vo vdpau:deint and \-vo xvmc:bobdeint.
4412 auto (default): If the decoder does not export the appropriate information,
4413 it falls back to 0 (top field first).
4423 Flip image upside-down.
4426 .B \-lavdopts <option1:option2:...> (DEBUG CODE)
4427 Specify libavcodec decoding parameters.
4428 Separate multiple options with a colon.
4433 \-lavdopts gray:skiploopfilter=all:skipframe=nonref
4438 Available options are:
4442 Only use bit-exact algorithms in all decoding steps (for codec testing).
4444 Manually work around encoder bugs.
4448 1: autodetect bugs (default)
4450 2 (msmpeg4v3): some old lavc generated msmpeg4v3 files (no autodetection)
4452 4 (mpeg4): Xvid interlacing bug (autodetected if fourcc==XVIX)
4454 8 (mpeg4): UMP4 (autodetected if fourcc==UMP4)
4456 16 (mpeg4): padding bug (autodetected)
4458 32 (mpeg4): illegal vlc bug (autodetected per fourcc)
4460 64 (mpeg4): Xvid and DivX qpel bug (autodetected per fourcc/\:version)
4462 128 (mpeg4): old standard qpel (autodetected per fourcc/\:version)
4464 256 (mpeg4): another qpel bug (autodetected per fourcc/\:version)
4466 512 (mpeg4): direct-qpel-blocksize bug (autodetected per fourcc/\:version)
4468 1024 (mpeg4): edge padding bug (autodetected per fourcc/\:version)
4471 Display debugging information.
4482 8: macroblock (MB) type
4484 16: per-block quantization parameter (QP)
4488 0x0040: motion vector visualization (use \-noslices)
4490 0x0080: macroblock (MB) skip
4496 0x0400: error resilience
4498 0x0800: memory management control operations (H.264)
4502 0x2000: Visualize quantization parameter (QP), lower QP are tinted greener.
4504 0x4000: Visualize block types.
4507 Set error concealment strategy.
4509 1: Use strong deblock filter for damaged MBs.
4511 2: iterative motion vector (MV) search (slow)
4516 Set error resilience strategy.
4521 1: careful (Should work with broken encoders.)
4523 2: normal (default) (Works with compliant encoders.)
4525 3: aggressive (More checks, but might cause problems even for valid bitstreams.)
4529 .IPs "fast (MPEG-2, MPEG-4, and H.264 only)"
4530 Enable optimizations which do not comply to the specification and might
4531 potentially cause problems, like simpler dequantization, simpler motion
4532 compensation, assuming use of the default quantization matrix, assuming
4533 YUV 4:2:0 and skipping a few checks to detect damaged bitstreams.
4535 grayscale only decoding (a bit faster than with color)
4536 .IPs "idct=<0\-99> (see \-lavcopts)"
4537 For best decoding quality use the same IDCT algorithm for decoding and encoding.
4538 This may come at a price in accuracy, though.
4539 .IPs lowres=<number>[,<w>]
4540 Decode at lower resolutions.
4541 Low resolution decoding is not supported by all codecs, and it will
4542 often result in ugly artifacts.
4543 This is not a bug, but a side effect of not decoding at full resolution.
4555 If <w> is specified lowres decoding will be used only if the width of the
4556 video is major than or equal to <w>.
4558 .B o=<key>=<value>[,<key>=<value>[,...]]
4559 Pass AVOptions to libavcodec decoder.
4560 Note, a patch to make the o= unneeded and pass all unknown options through
4561 the AVOption system is welcome.
4562 A full list of AVOptions can be found in the FFmpeg manual.
4563 Note that some options may conflict with MEncoder options.
4573 .IPs "sb=<number> (MPEG-2 only)"
4574 Skip the given number of macroblock rows at the bottom.
4575 .IPs "st=<number> (MPEG-2 only)"
4576 Skip the given number of macroblock rows at the top.
4577 .IPs "skiploopfilter=<skipvalue> (H.264 only)"
4578 Skips the loop filter (AKA deblocking) during H.264 decoding.
4579 Since the filtered frame is supposed to be used as reference
4580 for decoding dependent frames this has a worse effect on quality
4581 than not doing deblocking on e.g.\& MPEG-2 video.
4582 But at least for high bitrate HDTV this provides a big speedup with
4583 no visible quality loss.
4585 <skipvalue> can be either one of the following:
4590 default: Skip useless processing steps (e.g.\& 0 size packets in AVI).
4592 nonref: Skip frames that are not referenced (i.e.\& not used for
4593 decoding other frames, the error cannot "build up").
4595 bidir: Skip B-Frames.
4597 nonkey: Skip all frames except keyframes.
4599 all: Skip all frames.
4601 .IPs "skipidct=<skipvalue> (MPEG-1/2 only)"
4602 Skips the IDCT step.
4603 This degrades quality a lot of in almost all cases
4604 (see skiploopfilter for available skip values).
4605 .IPs skipframe=<skipvalue>
4606 Skips decoding of frames completely.
4607 Big speedup, but jerky motion and sometimes bad artifacts
4608 (see skiploopfilter for available skip values).
4609 .IPs "threads=<1\-8> (MPEG-1/2 and H.264 only)"
4610 number of threads to use for decoding (default: 1)
4612 Visualize motion vectors.
4617 1: Visualize forward predicted MVs of P-frames.
4619 2: Visualize forward predicted MVs of B-frames.
4621 4: Visualize backward predicted MVs of B-frames.
4624 Prints some statistics and stores them in ./vstats_*.log.
4629 Disable drawing video by 16-pixel height slices/\:bands, instead draws the
4630 whole frame in a single run.
4631 May be faster or slower, depending on video card and available cache.
4632 It has effect only with libmpeg2 and libavcodec codecs.
4636 Do not play/\:encode sound.
4637 Useful for benchmarking.
4641 Do not play/\:encode video.
4642 In many cases this will not work, use \-vc null \-vo null instead.
4645 .B \-pp <quality> (also see \-vf pp)
4646 Set the DLL postprocess level.
4647 This option is no longer usable with \-vf pp.
4648 It only works with Win32 DirectShow DLLs with internal postprocessing routines.
4649 The valid range of \-pp values varies by codec, it is mostly
4650 0\-6, where 0=disable, 6=slowest/\:best.
4653 .B \-pphelp (also see \-vf pp)
4654 Show a summary about the available postprocess filters and their usage.
4658 Specifies software scaler parameters.
4663 \-vf scale \-ssf lgb=3.0
4669 gaussian blur filter (luma)
4671 gaussian blur filter (chroma)
4672 .IPs ls=<\-100\-100>
4673 sharpen filter (luma)
4674 .IPs cs=<\-100\-100>
4675 sharpen filter (chroma)
4677 chroma horizontal shifting
4679 chroma vertical shifting
4685 Select type of MP2/\:MP3 stereo output.
4698 .B \-sws <software scaler type> (also see \-vf scale and \-zoom)
4699 Specify the software scaler algorithm to be used with the \-zoom option.
4700 This affects video output drivers which lack hardware acceleration, e.g.\& x11.
4702 Available types are:
4711 bicubic (good quality) (default)
4715 nearest neighbor (bad quality)
4719 luma bicubic / chroma bilinear
4727 natural bicubic spline
4733 Some \-sws options are tunable.
4734 The description of the scale video filter has further information.
4738 .B \-vc <[\-|+]codec1,[\-|+]codec2,...[,]>
4739 Specify a priority list of video codecs to be used, according to their codec
4740 name in codecs.conf.
4741 Use a '\-' before the codec name to omit it.
4742 Use a '+' before the codec name to force it, this will likely crash!
4743 If the list has a trailing ',' MPlayer will fall back on codecs not
4744 contained in the list.
4747 See \-vc help for a full list of available codecs.
4753 Force Win32/\:VfW DivX codec, no fallback.
4754 .IPs "\-vc \-divxds,\-divx,"
4755 Skip Win32 DivX codecs.
4756 .IPs "\-vc ffmpeg12,mpeg12,"
4757 Try libavcodec's MPEG-1/2 codec, then libmpeg2, then others.
4762 .B \-vfm <driver1,driver2,...>
4763 Specify a priority list of video codec families to be used, according
4764 to their names in codecs.conf.
4765 Falls back on the default codecs if none of the given codec families work.
4768 See \-vfm help for a full list of available codec families.
4773 .IPs "\-vfm ffmpeg,dshow,vfw"
4774 Try the libavcodec, then Directshow, then VfW codecs and fall back
4775 on others, if they do not work.
4777 Try XAnim codecs first.
4782 .B \-x <x> (also see \-zoom) (MPlayer only)
4783 Scale image to width <x> (if software/\:hardware scaling is available).
4784 Disables aspect calculations.
4787 .B \-xvidopts <option1:option2:...>
4788 Specify additional parameters when decoding with Xvid.
4791 Since libavcodec is faster than Xvid you might want to use the libavcodec
4792 postprocessing filter (\-vf pp) and decoder (\-vfm ffmpeg) instead.
4794 Xvid's internal postprocessing filters:
4797 .IPs "deblock-chroma (also see \-vf pp)"
4798 chroma deblock filter
4799 .IPs "deblock-luma (also see \-vf pp)"
4801 .IPs "dering-luma (also see \-vf pp)"
4802 luma deringing filter
4803 .IPs "dering-chroma (also see \-vf pp)"
4804 chroma deringing filter
4805 .IPs "filmeffect (also see \-vf noise)"
4806 Adds artificial film grain to the video.
4807 May increase perceived quality, while lowering true quality.
4816 Activate direct rendering method 2.
4818 Deactivate direct rendering method 2.
4823 .B \-xy <value> (also see \-zoom)
4827 Scale image by factor <value>.
4829 Set width to value and calculate height to keep correct aspect ratio.
4834 .B \-y <y> (also see \-zoom) (MPlayer only)
4835 Scale image to height <y> (if software/\:hardware scaling is available).
4836 Disables aspect calculations.
4840 Allow software scaling, where available.
4841 This will allow scaling with output drivers (like x11, fbdev) that
4842 do not support hardware scaling where MPlayer disables scaling by
4843 default for performance reasons.
4848 Audio filters allow you to modify the audio stream and its properties.
4852 .B \-af <filter1[=parameter1:parameter2:...],filter2,...>
4853 Setup a chain of audio filters.
4856 To get a full list of available audio filters, see \-af help.
4858 Audio filters are managed in lists.
4859 There are a few commands to manage the filter list.
4862 .B \-af\-add <filter1[,filter2,...]>
4863 Appends the filters given as arguments to the filter list.
4866 .B \-af\-pre <filter1[,filter2,...]>
4867 Prepends the filters given as arguments to the filter list.
4870 .B \-af\-del <index1[,index2,...]>
4871 Deletes the filters at the given indexes.
4872 Index numbers start at 0, negative numbers address the end of the
4873 list (\-1 is the last).
4877 Completely empties the filter list.
4879 Available filters are:
4882 .B resample[=srate[:sloppy[:type]]]
4883 Changes the sample rate of the audio stream.
4884 Can be used if you have a fixed frequency sound card or if you are
4885 stuck with an old sound card that is only capable of max 44.1kHz.
4886 This filter is automatically enabled if necessary.
4887 It only supports 16-bit integer and float in native-endian format as input.
4890 With MEncoder, you need to also use \-srate <srate>.
4894 output sample frequency in Hz.
4895 The valid range for this parameter is 8000 to 192000.
4896 If the input and output sample frequency are the same or if this
4897 parameter is omitted the filter is automatically unloaded.
4898 A high sample frequency normally improves the audio quality,
4899 especially when used in combination with other filters.
4901 Allow (1) or disallow (0) the output frequency to differ slightly
4902 from the frequency given by <srate> (default: 1).
4903 Can be used if the startup of the playback is extremely slow.
4905 Selects which resampling method to use.
4907 0: linear interpolation (fast, poor quality especially when upsampling)
4909 1: polyphase filterbank and integer processing
4911 2: polyphase filterbank and floating point processing (slow, best quality)
4921 .IPs "mplayer \-af resample=44100:0:0"
4922 would set the output frequency of the resample filter to 44100Hz using
4923 exact output frequency scaling and linear interpolation.
4928 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
4929 Changes the sample rate of the audio stream to an integer <srate> in Hz.
4930 It only supports the 16-bit native-endian format.
4933 With MEncoder, you need to also use \-srate <srate>.
4937 the output sample rate
4939 length of the filter with respect to the lower sampling rate (default: 16)
4941 if 1 then filters will be linearly interpolated between polyphase entries
4943 log2 of the number of polyphase entries
4944 (..., 10->1024, 11->2048, 12->4096, ...)
4947 cutoff frequency (0.0\-1.0), default set depending upon filter length
4952 .B lavcac3enc[=tospdif[:bitrate[:minchn]]]
4953 Encode multi-channel audio to AC-3 at runtime using libavcodec.
4954 Supports 16-bit native-endian input format, maximum 6 channels.
4955 The output is big-endian when outputting a raw AC-3 stream,
4956 native-endian when outputting to S/PDIF.
4957 The output sample rate of this filter is same with the input sample rate.
4958 When input sample rate is 48kHz, 44.1kHz, or 32kHz, this filter directly use it.
4959 Otherwise a resampling filter is auto-inserted before this filter to make
4960 the input and output sample rate be 48kHz.
4961 You need to specify '\-channels N' to make the decoder decode audio into
4962 N-channel, then the filter can encode the N-channel input to AC-3.
4967 Output raw AC-3 stream if zero or not set,
4968 output to S/PDIF for passthrough when <tospdif> is set non-zero.
4970 The bitrate to encode the AC-3 stream.
4971 Set it to either 384 or 384000 to get 384kbits.
4972 Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256,
4973 320, 384, 448, 512, 576, 640
4974 Default bitrate is based on the input channel number:
4975 1ch: 96, 2ch: 192, 3ch: 224, 4ch: 384, 5ch: 448, 6ch: 448
4977 If the input channel number is less than <minchn>, the filter will
4978 detach itself (default: 5).
4984 Produces a sine sweep.
4988 Sine function delta, use very low values to hear the sweep.
4993 .B sinesuppress[=freq:decay]
4994 Remove a sine at the specified frequency.
4995 Useful to get rid of the 50/60Hz noise on low quality audio equipment.
4996 It probably only works on mono input.
5000 The frequency of the sine which should be removed (in Hz) (default: 50)
5002 Controls the adaptivity (a larger value will make the filter adapt to
5003 amplitude and phase changes quicker, a smaller value will make the
5004 adaptation slower) (default: 0.0001).
5005 Reasonable values are around 0.001.
5010 .B bs2b[=option1:option2]
5011 Bauer stereophonic to binaural transformation using libbs2b.
5012 Improves the headphone listening experience by making the sound
5013 similar to that from loudspeakers, allowing each ear to hear both
5014 channels and taking into account the distance difference and the
5015 head shadowing effect.
5016 It is applicable only to 2 channel audio.
5019 .IPs fcut=<300\-1000>
5020 Set cut frequency in Hz.
5022 Set feed level for low frequencies in 0.1*dB.
5023 .IPs profile=<value>
5024 Several profiles are available for convenience:
5026 default: will be used if nothing else was specified (fcut=700,
5029 cmoy: Chu Moy circuit implementation (fcut=700, feed=60);
5031 jmeier: Jan Meier circuit implementation (fcut=650, feed=95).
5037 If fcut or feed options are specified together with a profile, they
5038 will be applied on top of the selected profile.
5044 Head-related transfer function: Converts multichannel audio to
5045 2 channel output for headphones, preserving the spatiality of the sound.
5050 .IPs "m matrix decoding of the rear channel"
5051 .IPs "s 2-channel matrix decoding"
5052 .IPs "0 no matrix decoding (default)"
5057 .B equalizer=[g1:g2:g3:...:g10]
5058 10 octave band graphic equalizer, implemented using 10 IIR band pass filters.
5059 This means that it works regardless of what type of audio is being played back.
5060 The center frequencies for the 10 bands are:
5064 .IPs "No. frequency"
5079 If the sample rate of the sound being played is lower than the center
5080 frequency for a frequency band, then that band will be disabled.
5081 A known bug with this filter is that the characteristics for the
5082 uppermost band are not completely symmetric if the sample
5083 rate is close to the center frequency of that band.
5084 This problem can be worked around by upsampling the sound
5085 using the resample filter before it reaches this filter.
5089 .IPs <g1>:<g2>:<g3>:...:<g10>
5090 floating point numbers representing the gain in dB
5091 for each frequency band (\-12\-12)
5098 .IPs "mplayer \-af equalizer=11:11:10:5:0:\-12:0:5:12:12 media.avi"
5099 Would amplify the sound in the upper and lower frequency region
5100 while canceling it almost completely around 1kHz.
5105 .B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...]
5106 Can be used for adding, removing, routing and copying audio channels.
5107 If only <nch> is given the default routing is used, it works as
5108 follows: If the number of output channels is bigger than the number of
5109 input channels empty channels are inserted (except mixing from mono to
5110 stereo, then the mono channel is repeated in both of the output
5112 If the number of output channels is smaller than the number
5113 of input channels the exceeding channels are truncated.
5117 number of output channels (1\-6)
5119 number of routes (1\-6)
5120 .IPs <from1:to1:from2:to2:from3:to3:...>
5121 Pairs of numbers between 0 and 5 that define where to route each channel.
5128 .IPs "mplayer \-af channels=4:4:0:1:1:0:2:2:3:3 media.avi"
5129 Would change the number of channels to 4 and set up 4 routes that
5130 swap channel 0 and channel 1 and leave channel 2 and 3 intact.
5131 Observe that if media containing two channels was played back, channels
5132 2 and 3 would contain silence but 0 and 1 would still be swapped.
5133 .IPs "mplayer \-af channels=6:4:0:0:0:1:0:2:0:3 media.avi"
5134 Would change the number of channels to 6 and set up 4 routes
5135 that copy channel 0 to channels 0 to 3.
5136 Channel 4 and 5 will contain silence.
5141 .B format[=format] (also see \-format)
5142 Convert between different sample formats.
5143 Automatically enabled when needed by the sound card or another filter.
5147 Sets the desired format.
5148 The general form is 'sbe', where 's' denotes the sign (either 's' for signed
5149 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32)
5150 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian
5151 and 'ne' the endianness of the computer MPlayer is running on).
5152 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'.
5153 Exceptions to this rule that are also valid format specifiers: u8, s8,
5154 floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm.
5160 Implements software volume control.
5161 Use this filter with caution since it can reduce the signal
5162 to noise ratio of the sound.
5163 In most cases it is best to set the level for the PCM sound to max,
5164 leave this filter out and control the output level to your
5165 speakers with the master volume control of the mixer.
5166 In case your sound card has a digital PCM mixer instead of an analog
5167 one, and you hear distortion, use the MASTER mixer instead.
5168 If there is an external amplifier connected to the computer (this
5169 is almost always the case), the noise level can be minimized by
5170 adjusting the master level and the volume knob on the amplifier
5171 until the hissing noise in the background is gone.
5173 This filter has a second feature: It measures the overall maximum
5174 sound level and prints out that level when MPlayer exits.
5175 This volume estimate can be used for setting the sound level in
5176 MEncoder such that the maximum dynamic range is utilized.
5179 This filter is not reentrant and can therefore only be enabled
5180 once for every audio stream.
5184 Sets the desired gain in dB for all channels in the stream
5185 from \-200dB to +60dB, where \-200dB mutes the sound
5186 completely and +60dB equals a gain of 1000 (default: 0).
5188 Turns soft clipping on (1) or off (0).
5189 Soft-clipping can make the sound more smooth if very
5190 high volume levels are used.
5191 Enable this option if the dynamic range of the
5192 loudspeakers is very low.
5195 This feature creates distortion and should be considered a last resort.
5202 .IPs "mplayer \-af volume=10.1:0 media.avi"
5203 Would amplify the sound by 10.1dB and hard-clip if the
5204 sound level is too high.
5209 .B pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...]
5210 Mixes channels arbitrarily.
5211 Basically a combination of the volume and the channels filter
5212 that can be used to down-mix many channels to only a few,
5213 e.g.\& stereo to mono or vary the "width" of the center
5214 speaker in a surround sound system.
5215 This filter is hard to use, and will require some tinkering
5216 before the desired result is obtained.
5217 The number of options for this filter depends on
5218 the number of output channels.
5219 An example how to downmix a six-channel file to two channels with
5220 this filter can be found in the examples section near the end.
5224 number of output channels (1\-6)
5226 How much of input channel i is mixed into output channel j (0\-1).
5227 So in principle you first have n numbers saying what to do with the
5228 first input channel, then n numbers that act on the second input channel
5230 If you do not specify any numbers for some input channels, 0 is assumed.
5237 .IPs "mplayer \-af pan=1:0.5:0.5 media.avi"
5238 Would down-mix from stereo to mono.
5239 .IPs "mplayer \-af pan=3:1:0:0.5:0:1:0.5 media.avi"
5240 Would give 3 channel output leaving channels 0 and 1 intact,
5241 and mix channels 0 and 1 into output channel 2 (which could
5242 be sent to a subwoofer for example).
5248 Adds a subwoofer channel to the audio stream.
5249 The audio data used for creating the subwoofer channel is
5250 an average of the sound in channel 0 and channel 1.
5251 The resulting sound is then low-pass filtered by a 4th order
5252 Butterworth filter with a default cutoff frequency of 60Hz
5253 and added to a separate channel in the audio stream.
5256 Disable this filter when you are playing DVDs with Dolby
5257 Digital 5.1 sound, otherwise this filter will disrupt
5258 the sound to the subwoofer.
5262 cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz)
5263 For the best result try setting the cutoff frequency as low as possible.
5264 This will improve the stereo or surround sound experience.
5266 Determines the channel number in which to insert the sub-channel audio.
5267 Channel number can be between 0 and 5 (default: 5).
5268 Observe that the number of channels will automatically
5269 be increased to <ch> if necessary.
5276 .IPs "mplayer \-af sub=100:4 \-channels 5 media.avi"
5277 Would add a sub-woofer channel with a cutoff frequency of
5278 100Hz to output channel 4.
5284 Creates a center channel from the front channels.
5285 May currently be low quality as it does not implement a
5286 high-pass filter for proper extraction yet, but averages and
5287 halves the channels instead.
5291 Determines the channel number in which to insert the center channel.
5292 Channel number can be between 0 and 5 (default: 5).
5293 Observe that the number of channels will automatically
5294 be increased to <ch> if necessary.
5300 Decoder for matrix encoded surround sound like Dolby Surround.
5301 Many files with 2 channel audio actually contain matrixed surround sound.
5302 Requires a sound card supporting at least 4 channels.
5306 delay time in ms for the rear speakers (0 to 1000) (default: 20)
5307 This delay should be set as follows: If d1 is the distance
5308 from the listening position to the front speakers and d2 is the distance
5309 from the listening position to the rear speakers, then the delay should
5310 be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2.
5317 .IPs "mplayer \-af surround=15 \-channels 4 media.avi"
5318 Would add surround sound decoding with 15ms delay for the sound to the
5324 .B delay[=ch1:ch2:...]
5325 Delays the sound to the loudspeakers such that the sound from the
5326 different channels arrives at the listening position simultaneously.
5327 It is only useful if you have more than 2 loudspeakers.
5331 The delay in ms that should be imposed on each channel
5332 (floating point number between 0 and 1000).
5337 To calculate the required delay for the different channels do as follows:
5339 Measure the distance to the loudspeakers in meters in relation
5340 to your listening position, giving you the distances s1 to s5
5342 There is no point in compensating for the subwoofer (you will not hear the
5345 Subtract the distances s1 to s5 from the maximum distance,
5346 i.e.\& s[i] = max(s) \- s[i]; i = 1...5.
5348 Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5.
5356 .IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi"
5357 Would delay front left and right by 10.5ms, the two rear channels
5358 and the sub by 0ms and the center channel by 7ms.
5363 .B export[=mmapped_file[:nsamples]]
5364 Exports the incoming signal to other processes using memory mapping (mmap()).
5365 Memory mapped areas contain a header:
5368 int nch /*number of channels*/
5369 int size /*buffer size*/
5370 unsigned long long counter /*Used to keep sync, updated every
5371 time new data is exported.*/
5374 The rest is payload (non-interleaved) 16 bit data.
5378 file to map data to (default: ~/.mplayer/\:mplayer-af_export)
5380 number of samples per channel (default: 512)
5387 .IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi"
5388 Would export 1024 samples per channel to '/tmp/mplayer-af_export'.
5393 .B extrastereo[=mul]
5394 (Linearly) increases the difference between left and right channels
5395 which adds some sort of "live" effect to playback.
5399 Sets the difference coefficient (default: 2.5).
5400 0.0 means mono sound (average of both channels), with 1.0 sound will be
5401 unchanged, with \-1.0 left and right channels will be swapped.
5406 .B volnorm[=method:target]
5407 Maximizes the volume without distorting the sound.
5411 Sets the used method.
5413 1: Use a single sample to smooth the variations via the standard
5414 weighted mean over past samples (default).
5416 2: Use several samples to smooth the variations via the standard
5417 weighted mean over past samples.
5420 Sets the target amplitude as a fraction of the maximum for the
5421 sample type (default: 0.25).
5426 .B ladspa=file:label[:controls...]
5427 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
5428 This filter is reentrant, so multiple LADSPA plugins can be used at once.
5432 Specifies the LADSPA plugin library file.
5433 If LADSPA_PATH is set, it searches for the specified file.
5434 If it is not set, you must supply a fully specified pathname.
5436 Specifies the filter within the library.
5437 Some libraries contain only one filter, but others contain many of them.
5438 Entering 'help' here, will list all available filters within the specified
5439 library, which eliminates the use of 'listplugins' from the LADSPA SDK.
5441 Controls are zero or more floating point values that determine the
5442 behavior of the loaded plugin (for example delay, threshold or gain).
5443 In verbose mode (add \-v to the MPlayer command line), all available controls
5444 and their valid ranges are printed.
5445 This eliminates the use of 'analyseplugin' from the LADSPA SDK.
5451 Compressor/expander filter usable for microphone input.
5452 Prevents artifacts on very loud sound and raises the volume on
5454 This filter is untested, maybe even unusable.
5458 Noise gate filter similar to the comp audio filter.
5459 This filter is untested, maybe even unusable.
5463 Simple voice removal filter exploiting the fact that voice is
5464 usually recorded with mono gear and later 'center' mixed onto
5465 the final audio stream.
5466 Beware that this filter will turn your signal into mono.
5467 Works well for 2 channel tracks; do not bother trying it
5468 on anything but 2 channel stereo.
5471 .B scaletempo[=option1:option2:...]
5472 Scales audio tempo without altering pitch, optionally synced to playback
5475 This works by playing \'stride\' ms of audio at normal speed then
5476 consuming \'stride*scale\' ms of input audio.
5477 It pieces the strides together by blending \'overlap\'% of stride with
5478 audio following the previous stride.
5479 It optionally performs a short statistical analysis on the next \'search\'
5480 ms of audio to determine the best overlap position.
5484 Nominal amount to scale tempo.
5485 Scales this amount in addition to speed.
5487 .IPs stride=<amount>
5488 Length in milliseconds to output each stride.
5489 Too high of value will cause noticable skips at high scale amounts and
5490 an echo at low scale amounts.
5491 Very low values will alter pitch.
5492 Increasing improves performance.
5494 .IPs overlap=<percent>
5495 Percentage of stride to overlap.
5496 Decreasing improves performance.
5498 .IPs search=<amount>
5499 Length in milliseconds to search for best overlap position.
5500 Decreasing improves performance greatly.
5501 On slow systems, you will probably want to set this very low.
5503 .IPs speed=<tempo|pitch|both|none>
5504 Set response to speed change.
5507 Scale tempo in sync with speed (default).
5509 Reverses effect of filter.
5510 Scales pitch without altering tempo.
5511 Add \'[ speed_mult 0.9438743126816935\' and \'] speed_mult 1.059463094352953\'
5512 to your input.conf to step by musical semi-tones.
5514 Loses sync with video.
5516 Scale both tempo and pitch.
5518 Ignore speed changes.
5526 .IPs "mplayer \-af scaletempo \-speed 1.2 media.ogg"
5527 Would playback media at 1.2x normal speed, with audio at normal pitch.
5528 Changing playback speed, would change audio tempo to match.
5529 .IPs "mplayer \-af scaletempo=scale=1.2:speed=none \-speed 1.2 media.ogg"
5530 Would playback media at 1.2x normal speed, with audio at normal pitch,
5531 but changing playback speed has no effect on audio tempo.
5532 .IPs "mplayer \-af scaletempo=stride=30:overlap=.50:search=10 media.ogg"
5533 Would tweak the quality and performace parameters.
5534 .IPs "mplayer \-af format=floatne,scaletempo media.ogg"
5535 Would make scaletempo use float code.
5536 Maybe faster on some platforms.
5537 .IPs "mplayer \-af scaletempo=scale=1.2:speed=pitch audio.ogg"
5538 Would playback audio file at 1.2x normal speed, with audio at normal pitch.
5539 Changing playback speed, would change pitch, leaving audio tempo at 1.2x.
5545 Collects and prints statistics about the audio stream, especially the volume.
5546 These statistics are especially intended to help adjusting the volume while
5548 The volumes are printed in dB and compatible with the volume audio filter.
5553 Video filters allow you to modify the video stream and its properties.
5557 .B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
5558 Setup a chain of video filters.
5560 Many parameters are optional and set to default values if omitted.
5561 To explicitly use a default value set a parameter to '\-1'.
5562 Parameters w:h means width x height in pixels, x:y means x;y position counted
5563 from the upper left corner of the bigger image.
5566 To get a full list of available video filters, see \-vf help.
5568 Video filters are managed in lists.
5569 There are a few commands to manage the filter list.
5572 .B \-vf\-add <filter1[,filter2,...]>
5573 Appends the filters given as arguments to the filter list.
5576 .B \-vf\-pre <filter1[,filter2,...]>
5577 Prepends the filters given as arguments to the filter list.
5580 .B \-vf\-del <index1[,index2,...]>
5581 Deletes the filters at the given indexes.
5582 Index numbers start at 0, negative numbers address the end of the
5583 list (\-1 is the last).
5587 Completely empties the filter list.
5589 With filters that support it, you can access parameters by their name.
5592 .B \-vf <filter>=help
5593 Prints the parameter names and parameter value ranges for a particular
5597 .B \-vf <filter=named_parameter1=value1[:named_parameter2=value2:...]>
5598 Sets a named parameter to the given value.
5599 Use on and off or yes and no to set flag parameters.
5601 Available filters are:
5605 Crops the given part of the image and discards the rest.
5606 Useful to remove black bands from widescreen movies.
5610 Cropped width and height, defaults to original width and height.
5612 Position of the cropped picture, defaults to center.
5617 .B cropdetect[=limit:round]
5618 Calculates necessary cropping parameters and prints the recommended parameters
5623 Threshold, which can be optionally specified from nothing (0) to
5624 everything (255) (default: 24).
5627 Value which the width/\:height should be divisible by (default: 16).
5628 The offset is automatically adjusted to center the video.
5629 Use 2 to get only even dimensions (needed for 4:2:2 video).
5630 16 is best when encoding to most video codecs.
5635 .B rectangle[=w:h:x:y]
5636 Draws a rectangle of the requested width and height at the specified
5637 coordinates over the image and prints current rectangle parameters
5639 This can be used to find optimal cropping parameters.
5640 If you bind the input.conf directive 'change_rectangle' to keystrokes,
5641 you can move and resize the rectangle on the fly.
5645 width and height (default: \-1, maximum possible width where boundaries
5648 top left corner position (default: \-1, uppermost leftmost)
5653 .B expand[=w:h:x:y:o:a:r]
5654 Expands (not scales) movie resolution to the given value and places the
5655 unscaled original at coordinates x, y.
5656 Can be used for placing subtitles/\:OSD in the resulting black bands.
5659 Expanded width,height (default: original width,height).
5660 Negative values for w and h are treated as offsets to the original size.
5665 .IP expand=0:\-50:0:0
5666 Adds a 50 pixel border to the bottom of the picture.
5670 position of original image on the expanded image (default: center)
5672 OSD/\:subtitle rendering
5674 0: disable (default)
5679 Expands to fit an aspect instead of a resolution (default: 0).
5684 .IP expand=800:::::4/3
5685 Expands to 800x600, unless the source is higher resolution, in which
5686 case it expands to fill a 4/3 aspect.
5690 Rounds up to make both width and height divisible by <r> (default: 1).
5694 .B flip (also see \-flip)
5695 Flips the image upside down.
5699 Mirrors the image on the Y axis.
5703 Rotates the image by 90 degrees and optionally flips it.
5704 For values between 4\-7 rotation is only done if the movie geometry is
5705 portrait and not landscape.
5708 Rotate by 90 degrees clockwise and flip (default).
5710 Rotate by 90 degrees clockwise.
5712 Rotate by 90 degrees counterclockwise.
5714 Rotate by 90 degrees counterclockwise and flip.
5718 .B scale[=w:h[:ilaced[:chr_drop[:par[:par2[:presize[:noup[:arnd]]]]]]]]
5719 Scales the image with the software scaler (slow) and performs a YUV<\->RGB
5720 colorspace conversion (also see \-sws).
5723 scaled width/\:height (default: original width/\:height)
5726 If \-zoom is used, and underlying filters (including libvo) are
5727 incapable of scaling, it defaults to d_width/\:d_height!
5729 0: scaled d_width/\:d_height
5731 \-1: original width/\:height
5733 \-2: Calculate w/h using the other dimension and the prescaled aspect ratio.
5735 \-3: Calculate w/h using the other dimension and the original aspect ratio.
5737 \-(n+8): Like \-n above, but rounding the dimension to the closest multiple of 16.
5740 Toggle interlaced scaling.
5749 0: Use all available input lines for chroma.
5751 1: Use only every 2. input line for chroma.
5753 2: Use only every 4. input line for chroma.
5755 3: Use only every 8. input line for chroma.
5757 .IPs "<par>[:<par2>] (also see \-sws)"
5758 Set some scaling parameters depending on the type of scaler selected
5761 \-sws 2 (bicubic): B (blurring) and C (ringing)
5765 0.00:0.75 VirtualDub's "precise bicubic"
5767 0.00:0.50 Catmull-Rom spline
5769 0.33:0.33 Mitchell-Netravali spline
5771 1.00:0.00 cubic B-spline
5773 \-sws 7 (gaussian): sharpness (0 (soft) \- 100 (sharp))
5775 \-sws 9 (lanczos): filter length (1\-10)
5778 Scale to preset sizes.
5780 qntsc: 352x240 (NTSC quarter screen)
5782 qpal: 352x288 (PAL quarter screen)
5784 ntsc: 720x480 (standard NTSC)
5786 pal: 720x576 (standard PAL)
5788 sntsc: 640x480 (square pixel NTSC)
5790 spal: 768x576 (square pixel PAL)
5793 Disallow upscaling past the original dimensions.
5795 0: Allow upscaling (default).
5797 1: Disallow upscaling if one dimension exceeds its original value.
5799 2: Disallow upscaling if both dimensions exceed their original values.
5802 Accurate rounding for the vertical scaler, which may be faster
5803 or slower than the default rounding.
5805 0: Disable accurate rounding (default).
5807 1: Enable accurate rounding.
5812 .B dsize[=aspect|w:h:aspect-method:r]
5813 Changes the intended display size/\:aspect at an arbitrary point in the
5815 Aspect can be given as a fraction (4/3) or floating point number
5817 Alternatively, you may specify the exact display width and height
5819 Note that this filter does
5821 do any scaling itself; it just affects
5822 what later scalers (software or hardware) will do when auto-scaling to
5826 New display width and height.
5827 Can also be these special values:
5829 0: original display width and height
5831 \-1: original video width and height (default)
5833 \-2: Calculate w/h using the other dimension and the original display
5836 \-3: Calculate w/h using the other dimension and the original video
5844 Specifies a display resolution of 800x600 for a 4/3 aspect video, or
5845 800x450 for a 16/9 aspect video.
5847 .IPs <aspect-method>
5848 Modifies width and height according to original aspect ratios.
5850 \-1: Ignore original aspect ratio (default).
5852 0: Keep display aspect ratio by using <w> and <h> as maximum
5855 1: Keep display aspect ratio by using <w> and <h> as minimum
5858 2: Keep video aspect ratio by using <w> and <h> as maximum
5861 3: Keep video aspect ratio by using <w> and <h> as minimum
5869 Specifies a display resolution of at most 800x600, or smaller, in order
5874 Rounds up to make both width and height divisible by <r> (default: 1).
5879 Forces software YV12/\:I420/\:422P to YUY2 conversion.
5880 Useful for video cards/\:drivers with slow YV12 but fast YUY2 support.
5884 Forces software YVU9 to YV12 colorspace conversion.
5885 Deprecated in favor of the software scaler.
5889 Clamps YUV color values to the CCIR 601 range without doing real conversion.
5893 RGB 24/32 <\-> BGR 24/32 colorspace conversion.
5897 Also perform R <\-> B swapping.
5903 RGB/BGR 8 \-> 15/16/24/32bpp colorspace conversion using palette.
5907 Restricts the colorspace for the next filter without doing any conversion.
5908 Use together with the scale filter for a real conversion.
5911 For a list of available formats see format=fmt=help.
5915 format name like rgb15, bgr24, yv12, etc (default: yuy2)
5920 .B noformat[=fourcc]
5921 Restricts the colorspace for the next filter without doing any conversion.
5922 Unlike the format filter, this will allow any colorspace
5924 the one you specify.
5927 For a list of available formats see noformat=fmt=help.
5931 format name like rgb15, bgr24, yv12, etc (default: yv12)
5936 .B pp[=filter1[:option1[:option2...]]/[\-]filter2...] (also see \-pphelp)
5937 Enables the specified chain of postprocessing subfilters.
5938 Subfilters must be separated by '/' and can be disabled by
5940 Each subfilter and some options have a short and a long name that can be
5941 used interchangeably, i.e.\& dr/dering are the same.
5942 All subfilters share common options to determine their scope:
5946 Automatically switch the subfilter off if the CPU is too slow.
5948 Do chrominance filtering, too (default).
5950 Do luminance filtering only (no chrominance).
5952 Do chrominance filtering only (no luminance).
5959 \-pphelp shows a list of available subfilters.
5961 Available subfilters are
5964 .IPs hb/hdeblock[:difference[:flatness]]
5965 horizontal deblocking filter
5967 <difference>: Difference factor where higher values mean
5968 more deblocking (default: 32).
5970 <flatness>: Flatness threshold where lower values mean
5971 more deblocking (default: 39).
5973 .IPs vb/vdeblock[:difference[:flatness]]
5974 vertical deblocking filter
5976 <difference>: Difference factor where higher values mean
5977 more deblocking (default: 32).
5979 <flatness>: Flatness threshold where lower values mean
5980 more deblocking (default: 39).
5982 .IPs ha/hadeblock[:difference[:flatness]]
5983 accurate horizontal deblocking filter
5985 <difference>: Difference factor where higher values mean
5986 more deblocking (default: 32).
5988 <flatness>: Flatness threshold where lower values mean
5989 more deblocking (default: 39).
5991 .IPs va/vadeblock[:difference[:flatness]]
5992 accurate vertical deblocking filter
5994 <difference>: Difference factor where higher values mean
5995 more deblocking (default: 32).
5997 <flatness>: Flatness threshold where lower values mean
5998 more deblocking (default: 39).
6001 The horizontal and vertical deblocking filters share the
6002 difference and flatness values so you cannot set
6003 different horizontal and vertical thresholds.
6006 experimental horizontal deblocking filter
6008 experimental vertical deblocking filter
6011 .IPs tn/tmpnoise[:threshold1[:threshold2[:threshold3]]]
6012 temporal noise reducer
6014 <threshold1>: larger -> stronger filtering
6016 <threshold2>: larger -> stronger filtering
6018 <threshold3>: larger -> stronger filtering
6020 .IPs al/autolevels[:f/fullyrange]
6021 automatic brightness / contrast correction
6023 f/fullyrange: Stretch luminance to (0\-255).
6025 .IPs lb/linblenddeint
6026 Linear blend deinterlacing filter that deinterlaces the given block
6027 by filtering all lines with a (1 2 1) filter.
6028 .IPs li/linipoldeint
6029 Linear interpolating deinterlacing filter that deinterlaces the given block
6030 by linearly interpolating every second line.
6031 .IPs ci/cubicipoldeint
6032 Cubic interpolating deinterlacing filter deinterlaces the given block
6033 by cubically interpolating every second line.
6035 Median deinterlacing filter that deinterlaces the given block
6036 by applying a median filter to every second line.
6038 FFmpeg deinterlacing filter that deinterlaces the given block
6039 by filtering every second line with a (\-1 4 2 4 \-1) filter.
6041 Vertically applied FIR lowpass deinterlacing filter that deinterlaces
6042 the given block by filtering all lines with a (\-1 2 6 2 \-1) filter.
6043 .IPs fq/forceQuant[:quantizer]
6044 Overrides the quantizer table from the input with the constant
6045 quantizer you specify.
6047 <quantizer>: quantizer to use
6050 default pp filter combination (hb:a,vb:a,dr:a)
6052 fast pp filter combination (h1:a,v1:a,dr:a)
6054 high quality pp filter combination (ha:a:128:7,va:a,dr:a)
6062 .IPs "\-vf pp=hb/vb/dr/al"
6063 horizontal and vertical deblocking, deringing and automatic
6064 brightness/\:contrast
6065 .IPs "\-vf pp=de/\-al"
6066 default filters without brightness/\:contrast correction
6067 .IPs "\-vf pp=default/tmpnoise:1:2:3"
6068 Enable default filters & temporal denoiser.
6069 .IPs "\-vf pp=hb:y/vb:a"
6070 Horizontal deblocking on luminance only, and switch vertical deblocking
6071 on or off automatically depending on available CPU time.
6076 .B spp[=quality[:qp[:mode]]]
6077 Simple postprocessing filter that compresses and decompresses the
6078 image at several (or \- in the case of quality level 6 \- all)
6079 shifts and averages the results.
6084 Force quantization parameter (default: 0, use QP from video).
6086 0: hard thresholding (default)
6088 1: soft thresholding (better deringing, but blurrier)
6090 4: like 0, but also use B-frames' QP (may cause flicker)
6092 5: like 1, but also use B-frames' QP (may cause flicker)
6096 .B uspp[=quality[:qp]]
6097 Ultra simple & slow postprocessing filter that compresses and
6098 decompresses the image at several (or \- in the case of quality
6099 level 8 \- all) shifts and averages the results.
6100 The way this differs from the behavior of spp is that uspp actually
6101 encodes & decodes each case with libavcodec Snow, whereas spp uses
6102 a simplified intra only 8x8 DCT similar to MJPEG.
6107 Force quantization parameter (default: 0, use QP from video).
6111 .B fspp[=quality[:qp[:strength[:bframes]]]]
6112 faster version of the simple postprocessing filter
6115 4\-5 (equivalent to spp; default: 4)
6117 Force quantization parameter (default: 0, use QP from video).
6119 Filter strength, lower values mean more details but also more artifacts,
6120 while higher values make the image smoother but also blurrier (default:
6123 0: do not use QP from B-frames (default)
6125 1: use QP from B-frames too (may cause flicker)
6130 Variant of the spp filter, similar to spp=6 with 7 point DCT where
6131 only the center sample is used after IDCT.
6134 Force quantization parameter (default: 0, use QP from video).
6136 0: hard thresholding
6138 1: soft thresholding (better deringing, but blurrier)
6140 2: medium thresholding (default, good results)
6145 quantization parameter (QP) change filter
6148 some equation like "2+2*sin(PI*qp)"
6153 generic equation change filter
6156 Some equation, e.g.\& 'p(W-X\\,Y)' to flip the image horizontally.
6157 You can use whitespace to make the equation more readable.
6158 There are a couple of constants that can be used in the equation:
6164 X / Y: the coordinates of the current sample
6166 W / H: width and height of the image
6168 SW / SH: width/height scale depending on the currently filtered plane, e.g.\&
6169 1,1 and 0.5,0.5 for YUV 4:2:0.
6171 p(x,y): returns the value of the pixel at location x/y of the current plane.
6177 Generate various test patterns.
6180 .B rgbtest[=width:height]
6181 Generate an RGB test pattern useful for detecting RGB vs BGR issues.
6182 You should see a red, green and blue stripe from top to bottom.
6185 Desired width of generated image (default: 0).
6186 0 means width of input image.
6189 Desired height of generated image (default: 0).
6190 0 means height of input image.
6194 .B lavc[=quality:fps]
6195 Fast software YV12 to MPEG-1 conversion with libavcodec for use with DVB/\:DXR3/\:IVTV/\:V4L2.
6200 32\-: fixed bitrate in kbits
6202 force output fps (float value) (default: 0, autodetect based on height)
6206 .B dvbscale[=aspect]
6207 Set up optimal scaling for DVB cards, scaling the x axis in hardware and
6208 calculating the y axis scaling in software to keep aspect.
6209 Only useful together with expand and scale.
6212 Control aspect ratio, calculate as DVB_HEIGHT*ASPECTRATIO (default:
6213 576*4/3=768), set it to 576*(16/9)=1024 for a 16:9 TV.
6221 .IPs "\-vf dvbscale,scale=\-1:0,expand=\-1:576:\-1:\-1:1,lavc"
6222 FIXME: Explain what this does.
6227 .B noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]]
6236 uniform noise (gaussian otherwise)
6238 temporal noise (noise pattern changes between frames)
6240 averaged temporal noise (smoother, but a lot slower)
6242 high quality (slightly better looking, slightly slower)
6244 mix random noise with a (semi)regular pattern
6249 .B denoise3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
6250 This filter aims to reduce image noise producing smooth images and making still
6251 images really still (This should enhance compressibility.).
6255 spatial luma strength (default: 4)
6256 .IPs <chroma_spatial>
6257 spatial chroma strength (default: 3)
6259 luma temporal strength (default: 6)
6261 chroma temporal strength (default: luma_tmp*chroma_spatial/luma_spatial)
6266 .B hqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
6267 High precision/\:quality version of the denoise3d filter.
6268 Parameters and usage are the same.
6271 .B ow[=depth[:luma_strength[:chroma_strength]]]
6272 Overcomplete Wavelet denoiser.
6276 Larger depth values will denoise lower frequency components more, but
6277 slow down filtering (default: 8).
6278 .IPs <luma_strength>
6279 luma strength (default: 1.0)
6280 .IPs <chroma_strength>
6281 chroma strength (default: 1.0)
6286 .B eq[=brightness:contrast] (OBSOLETE)
6287 Software equalizer with interactive controls just like the hardware
6288 equalizer, for cards/\:drivers that do not support brightness and
6289 contrast controls in hardware.
6290 Might also be useful with MEncoder, either for fixing poorly captured
6291 movies, or for slightly reducing contrast to mask artifacts and get by
6292 with lower bitrates.
6303 .B eq2[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]
6304 Alternative software equalizer that uses lookup tables (very slow),
6305 allowing gamma correction in addition to simple brightness
6306 and contrast adjustment.
6307 Note that it uses the same MMX optimized code as \-vf eq if all
6308 gamma values are 1.0.
6309 The parameters are given as floating point values.
6313 initial gamma value (default: 1.0)
6315 initial contrast, where negative values result in a
6316 negative image (default: 1.0)
6318 initial brightness (default: 0.0)
6320 initial saturation (default: 1.0)
6322 gamma value for the red component (default: 1.0)
6324 gamma value for the green component (default: 1.0)
6326 gamma value for the blue component (default: 1.0)
6328 The weight parameter can be used to reduce the effect of a high gamma value on
6329 bright image areas, e.g.\& keep them from getting overamplified and just plain
6331 A value of 0.0 turns the gamma correction all the way down while 1.0 leaves it
6332 at its full strength (default: 1.0).
6337 .B hue[=hue:saturation]
6338 Software equalizer with interactive controls just like the hardware
6339 equalizer, for cards/\:drivers that do not support hue and
6340 saturation controls in hardware.
6344 initial hue (default: 0.0)
6346 initial saturation, where negative values result
6347 in a negative chroma (default: 1.0)
6353 Convert planar YUV 4:2:0 to half-height packed 4:2:2, downsampling luma but
6354 keeping all chroma samples.
6355 Useful for output to low-resolution display devices when hardware downscaling
6356 is poor quality or is not available.
6357 Can also be used as a primitive luma-only deinterlacer with very low CPU
6362 By default, halfpack averages pairs of lines when downsampling.
6363 Any value different from 0 or 1 gives the default (averaging) behavior.
6365 0: Only use even lines when downsampling.
6367 1: Only use odd lines when downsampling.
6374 When interlaced video is stored in YUV 4:2:0 formats, chroma
6375 interlacing does not line up properly due to vertical downsampling of
6376 the chroma channels.
6377 This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format with
6378 the chroma lines in their proper locations, so that in any given
6379 scanline, the luma and chroma data both come from the same field.
6383 Select the sampling mode.
6385 0: nearest-neighbor sampling, fast but incorrect
6387 1: linear interpolation (default)
6394 Only useful with MEncoder.
6395 If harddup is used when encoding, it will force duplicate frames to be
6396 encoded in the output.
6397 This uses slightly more space, but is necessary for output to MPEG
6398 files or if you plan to demux and remux the video stream after
6400 Should be placed at or near the end of the filter chain unless you
6401 have a good reason to do otherwise.
6405 Only useful with MEncoder.
6406 Softskip moves the frame skipping (dropping) step of encoding from
6407 before the filter chain to some point during the filter chain.
6408 This allows filters which need to see all frames (inverse telecine,
6409 temporal denoising, etc.) to function properly.
6410 Should be placed after the filters which need to see all frames and
6411 before any subsequent filters that are CPU-intensive.
6414 .B decimate[=max:hi:lo:frac]
6415 Drops frames that do not differ greatly from the previous frame in
6416 order to reduce framerate.
6417 The main use of this filter is for very-low-bitrate encoding (e.g.\&
6418 streaming over dialup modem), but it could in theory be used for
6419 fixing movies that were inverse-telecined incorrectly.
6423 Sets the maximum number of consecutive frames which can be
6424 dropped (if positive), or the minimum interval between
6425 dropped frames (if negative).
6426 .IPs <hi>,<lo>,<frac>
6427 A frame is a candidate for dropping if no 8x8 region differs by more
6428 than a threshold of <hi>, and if not more than <frac> portion (1
6429 meaning the whole image) differs by more than a threshold of <lo>.
6430 Values of <hi> and <lo> are for 8x8 pixel blocks and represent actual
6431 pixel value differences, so a threshold of 64 corresponds to 1 unit of
6432 difference for each pixel, or the same spread out differently over the
6438 .B dint[=sense:level]
6439 The drop-deinterlace (dint) filter detects and drops the first from a set
6440 of interlaced video frames.
6444 relative difference between neighboring pixels (default: 0.1)
6446 What part of the image has to be detected as interlaced to
6447 drop the frame (default: 0.15).
6452 .B lavcdeint (OBSOLETE)
6453 FFmpeg deinterlacing filter, same as \-vf pp=fd
6456 .B kerndeint[=thresh[:map[:order[:sharp[:twoway]]]]]
6457 Donald Graft's adaptive kernel deinterlacer.
6458 Deinterlaces parts of a video if a configurable threshold is exceeded.
6462 threshold (default: 10)
6465 0: Ignore pixels exceeding the threshold (default).
6467 1: Paint pixels exceeding the threshold white.
6471 0: Leave fields alone (default).
6477 0: Disable additional sharpening (default).
6479 1: Enable additional sharpening.
6483 0: Disable twoway sharpening (default).
6485 1: Enable twoway sharpening.
6491 .B unsharp[=l|cWxH:amount[:l|cWxH:amount]]
6492 unsharp mask / gaussian blur
6495 Apply effect on luma component.
6497 Apply effect on chroma components.
6498 .IPs <width>x<height>
6499 width and height of the matrix, odd sized in both directions
6500 (min = 3x3, max = 13x11 or 11x13, usually something between 3x3 and 7x7)
6502 Relative amount of sharpness/\:blur to add to the image
6503 (a sane range should be \-1.5\-1.5).
6516 .B il[=d|i][s][:[d|i][s]]
6517 (De)interleaves lines.
6518 The goal of this filter is to add the ability to process interlaced images
6519 pre-field without deinterlacing them.
6520 You can filter your interlaced DVD and play it on a TV without breaking the
6522 While deinterlacing (with the postprocessing filter) removes interlacing
6523 permanently (by smoothing, averaging, etc) deinterleaving splits the frame into
6524 2 fields (so called half pictures), so you can process (filter) them
6525 independently and then re-interleave them.
6529 deinterleave (placing one above the other)
6533 swap fields (exchange even & odd lines)
6539 (De)interleaves lines.
6540 This filter is very similar to the il filter but much faster, the main
6541 disadvantage is that it does not always work.
6542 Especially if combined with other filters it may produce randomly messed
6543 up images, so be happy if it works but do not complain if it does not for
6544 your combination of filters.
6548 Deinterleave fields, placing them side by side.
6550 Interleave fields again (reversing the effect of fil=d).
6556 Extracts a single field from an interlaced image using stride arithmetic
6557 to avoid wasting CPU time.
6558 The optional argument n specifies whether to extract the even or the odd
6559 field (depending on whether n is even or odd).
6562 .B detc[=var1=value1:var2=value2:...]
6563 Attempts to reverse the 'telecine' process to recover a clean,
6564 non-interlaced stream at film framerate.
6565 This was the first and most primitive inverse telecine filter to be
6566 added to MPlayer/\:MEncoder.
6567 It works by latching onto the telecine 3:2 pattern and following it as
6569 This makes it suitable for perfectly-telecined material, even in the
6570 presence of a fair degree of noise, but it will fail in the presence
6571 of complex post-telecine edits.
6572 Development on this filter is no longer taking place, as ivtc, pullup,
6573 and filmdint are better for most applications.
6574 The following arguments (see syntax above) may be used to control
6578 Set the frame dropping mode.
6580 0: Do not drop frames to maintain fixed output framerate (default).
6582 1: Always drop a frame when there have been no drops or telecine
6583 merges in the past 5 frames.
6585 2: Always maintain exact 5:4 input to output frame ratio.
6588 Use mode 1 or 2 with MEncoder.
6593 0: Fixed pattern with initial frame number specified by <fr>.
6595 1: aggressive search for telecine pattern (default)
6598 Set initial frame number in sequence.
6599 0\-2 are the three clean progressive frames; 3 and 4 are the two
6601 The default, \-1, means 'not in telecine sequence'.
6602 The number specified here is the type for the imaginary previous
6603 frame before the movie starts.
6604 .IPs "<t0>, <t1>, <t2>, <t3>"
6605 Threshold values to be used in certain modes.
6610 Experimental 'stateless' inverse telecine filter.
6611 Rather than trying to lock on to a pattern like the detc filter does,
6612 ivtc makes its decisions independently for each frame.
6613 This will give much better results for material that has undergone
6614 heavy editing after telecine was applied, but as a result it is not as
6615 forgiving of noisy input, for example TV capture.
6616 The optional parameter (ivtc=1) corresponds to the dr=1 option for the
6617 detc filter, and should be used with MEncoder but not with MPlayer.
6618 As with detc, you must specify the correct output framerate (\-ofps
6619 24000/1001) when using MEncoder.
6620 Further development on ivtc has stopped, as the pullup and filmdint
6621 filters appear to be much more accurate.
6624 .B pullup[=jl:jr:jt:jb:sb:mp]
6625 Third-generation pulldown reversal (inverse telecine) filter,
6626 capable of handling mixed hard-telecine, 24000/1001 fps progressive, and 30000/1001
6627 fps progressive content.
6628 The pullup filter is designed to be much more robust than detc or
6629 ivtc, by taking advantage of future context in making its decisions.
6630 Like ivtc, pullup is stateless in the sense that it does not lock onto
6631 a pattern to follow, but it instead looks forward to the following
6632 fields in order to identify matches and rebuild progressive frames.
6633 It is still under development, but believed to be quite accurate.
6635 .IPs "jl, jr, jt, and jb"
6636 These options set the amount of "junk" to ignore at
6637 the left, right, top, and bottom of the image, respectively.
6638 Left/\:right are in units of 8 pixels, while top/\:bottom are in units of
6640 The default is 8 pixels on each side.
6642 .IPs "sb (strict breaks)"
6643 Setting this option to 1 will reduce the chances of
6644 pullup generating an occasional mismatched frame, but it may also
6645 cause an excessive number of frames to be dropped during high motion
6647 Conversely, setting it to \-1 will make pullup match fields more
6649 This may help processing of video where there is slight blurring
6650 between the fields, but may also cause there to be interlaced frames
6653 .IPs "mp (metric plane)"
6654 This option may be set to 1 or 2 to use a chroma
6655 plane instead of the luma plane for doing pullup's computations.
6656 This may improve accuracy on very clean source material, but more
6657 likely will decrease accuracy, especially if there is chroma noise
6658 (rainbow effect) or any grayscale video.
6659 The main purpose of setting mp to a chroma plane is to reduce CPU load
6660 and make pullup usable in realtime on slow machines.
6665 Always follow pullup with the softskip filter when encoding to ensure
6666 that pullup is able to see each frame.
6667 Failure to do so will lead to incorrect output and will usually crash,
6668 due to design limitations in the codec/\:filter layer.
6672 .B filmdint[=options]
6673 Inverse telecine filter, similar to the pullup filter above.
6674 It is designed to handle any pulldown pattern, including mixed soft and
6675 hard telecine and limited support for movies that are slowed down or sped
6676 up from their original framerate for TV.
6677 Only the luma plane is used to find the frame breaks.
6678 If a field has no match, it is deinterlaced with simple linear
6680 If the source is MPEG-2, this must be the first filter to allow
6681 access to the field-flags set by the MPEG-2 decoder.
6682 Depending on the source MPEG, you may be fine ignoring this advice, as
6683 long as you do not see lots of "Bottom-first field" warnings.
6684 With no options it does normal inverse telecine, and should be used
6685 together with mencoder \-fps 30000/1001 \-ofps 24000/1001.
6686 When this filter is used with MPlayer, it will result in an uneven
6687 framerate during playback, but it is still generally better than using
6688 pp=lb or no deinterlacing at all.
6689 Multiple options can be specified separated by /.
6691 .IPs crop=<w>:<h>:<x>:<y>
6692 Just like the crop filter, but faster, and works on mixed hard and soft
6693 telecined content as well as when y is not a multiple of 4.
6694 If x or y would require cropping fractional pixels from the chroma
6695 planes, the crop area is extended.
6696 This usually means that x and y must be even.
6697 .IPs io=<ifps>:<ofps>
6698 For each ifps input frames the filter will output ofps frames.
6699 The ratio of ifps/\:ofps should match the \-fps/\-ofps ratio.
6700 This could be used to filter movies that are broadcast on TV at a frame
6701 rate different from their original framerate.
6703 If n is nonzero, the chroma plane is copied unchanged.
6704 This is useful for YV12 sampled TV, which discards one of the chroma
6707 On x86, if n=1, use MMX2 optimized functions, if n=2, use 3DNow!
6708 optimized functions, otherwise, use plain C.
6709 If this option is not specified, MMX2 and 3DNow! are auto-detected, use
6710 this option to override auto-detection.
6712 The larger n will speed up the filter at the expense of accuracy.
6713 The default value is n=3.
6714 If n is odd, a frame immediately following a frame marked with the
6715 REPEAT_FIRST_FIELD MPEG flag is assumed to be progressive, thus filter
6716 will not spend any time on soft-telecined MPEG-2 content.
6717 This is the only effect of this flag if MMX2 or 3DNow! is available.
6718 Without MMX2 and 3DNow, if n=0 or 1, the same calculations will be used
6720 If n=2 or 3, the number of luma levels used to find the frame breaks is
6721 reduced from 256 to 128, which results in a faster filter without losing
6723 If n=4 or 5, a faster, but much less accurate metric will be used to
6724 find the frame breaks, which is more likely to misdetect high vertical
6725 detail as interlaced content.
6727 If n is nonzero, print the detailed metrics for each frame.
6728 Useful for debugging.
6730 Deinterlace threshold.
6731 Used during de-interlacing of unmatched frames.
6732 Larger value means less deinterlacing, use n=256 to completely turn off
6736 Threshold for comparing a top and bottom fields.
6739 Threshold to detect temporal change of a field.
6742 Sum of Absolute Difference threshold, default is 64.
6744 If n is nonzero, attempt to output meaningful PTS values, and try to discard
6745 only frames that are duplicates in telecine sequences. Experimental, should
6746 be used in mencoder with -noskip, in which case output must be used with
6747 tcdump filter and an external tool to apply the timestamps to frames.
6752 This filter works only correct with MEncoder and acts on the MPEG-2 flags
6753 used for soft 3:2 pulldown (soft telecine).
6754 If you want to use the ivtc or detc filter on movies that are partly soft
6755 telecined, inserting this filter before them should make them more reliable.
6759 Inverse telecine for deinterlaced video.
6760 If 3:2-pulldown telecined video has lost one of the fields or is deinterlaced
6761 using a method that keeps one field and interpolates the other, the result is
6762 a juddering video that has every fourth frame duplicated.
6763 This filter is intended to find and drop those duplicates and restore the
6764 original film framerate.
6765 When using this filter, you must specify \-ofps that is 4/5 of
6766 the fps of the input file and place the softskip later in the
6767 filter chain to make sure that divtc sees all the frames.
6768 Two different modes are available:
6769 One pass mode is the default and is straightforward to use,
6770 but has the disadvantage that any changes in the telecine
6771 phase (lost frames or bad edits) cause momentary judder
6772 until the filter can resync again.
6773 Two pass mode avoids this by analyzing the whole video
6774 beforehand so it will have forward knowledge about the
6775 phase changes and can resync at the exact spot.
6778 correspond to pass one and two of the encoding process.
6779 You must run an extra pass using divtc pass one before the
6780 actual encoding throwing the resulting video away.
6781 Use \-nosound \-ovc raw \-o /dev/null to avoid
6782 wasting CPU power for this pass.
6783 You may add something like crop=2:2:0:0 after divtc
6784 to speed things up even more.
6785 Then use divtc pass two for the actual encoding.
6786 If you use multiple encoder passes, use divtc
6787 pass two for all of them.
6792 .IPs file=<filename>
6793 Set the two pass log filename (default: "framediff.log").
6794 .IPs threshold=<value>
6795 Set the minimum strength the telecine pattern must have for the filter to
6796 believe in it (default: 0.5).
6797 This is used to avoid recognizing false pattern from the parts of the video
6798 that are very dark or very still.
6799 .IPs window=<numframes>
6800 Set the number of past frames to look at when searching for pattern
6802 Longer window improves the reliability of the pattern search, but shorter
6803 window improves the reaction time to the changes in the telecine phase.
6804 This only affects the one pass mode.
6805 The two pass mode currently uses fixed window that extends to both future
6807 .IPs phase=0|1|2|3|4
6808 Sets the initial telecine phase for one pass mode (default: 0).
6809 The two pass mode can see the future, so it is able to use the correct
6810 phase from the beginning, but one pass mode can only guess.
6811 It catches the correct phase when it finds it, but this option can be used
6812 to fix the possible juddering at the beginning.
6813 The first pass of the two pass mode also uses this, so if you save the output
6814 from the first pass, you get constant phase result.
6815 .IPs deghost=<value>
6816 Set the deghosting threshold (0\-255 for one pass mode, \-255\-255 for two pass
6818 If nonzero, deghosting mode is used.
6819 This is for video that has been deinterlaced by blending the fields
6820 together instead of dropping one of the fields.
6821 Deghosting amplifies any compression artifacts in the blended frames, so the
6822 parameter value is used as a threshold to exclude those pixels from
6823 deghosting that differ from the previous frame less than specified value.
6824 If two pass mode is used, then negative value can be used to make the
6825 filter analyze the whole video in the beginning of pass-2 to determine
6826 whether it needs deghosting or not and then select either zero or the
6827 absolute value of the parameter.
6828 Specify this option for pass-2, it makes no difference on pass-1.
6832 .B phase[=t|b|p|a|u|T|B|A|U][:v]
6833 Delay interlaced video by one field time so that the field order
6835 The intended use is to fix PAL movies that have been captured with the
6836 opposite field order to the film-to-video transfer.
6840 Capture field order top-first, transfer bottom-first.
6841 Filter will delay the bottom field.
6843 Capture bottom-first, transfer top-first.
6844 Filter will delay the top field.
6846 Capture and transfer with the same field order.
6847 This mode only exists for the documentation of the other options to refer to,
6848 but if you actually select it, the filter will faithfully do nothing ;-)
6850 Capture field order determined automatically by field flags, transfer opposite.
6851 Filter selects among t and b modes on a frame by frame basis using field flags.
6852 If no field information is available, then this works just like u.
6854 Capture unknown or varying, transfer opposite.
6855 Filter selects among t and b on a frame by frame basis by analyzing the
6856 images and selecting the alternative that produces best match between the
6859 Capture top-first, transfer unknown or varying.
6860 Filter selects among t and p using image analysis.
6862 Capture bottom-first, transfer unknown or varying.
6863 Filter selects among b and p using image analysis.
6865 Capture determined by field flags, transfer unknown or varying.
6866 Filter selects among t, b and p using field flags and image analysis.
6867 If no field information is available, then this works just like U.
6868 This is the default mode.
6870 Both capture and transfer unknown or varying.
6871 Filter selects among t, b and p using image analysis only.
6874 Prints the selected mode for each frame and the average squared difference
6875 between fields for t, b, and p alternatives.
6880 Apply 3:2 'telecine' process to increase framerate by 20%.
6881 This most likely will not work correctly with MPlayer, but it can
6882 be used with 'mencoder \-fps 30000/1001 \-ofps 30000/1001 \-vf telecine'.
6883 Both fps options are essential!
6884 (A/V sync will break if they are wrong.)
6885 The optional start parameter tells the filter where in the telecine
6886 pattern to start (0\-3).
6889 .B tinterlace[=mode]
6890 Temporal field interlacing \- merge pairs of frames into an interlaced
6891 frame, halving the framerate.
6892 Even frames are moved into the upper field, odd frames to the lower field.
6893 This can be used to fully reverse the effect of the tfields filter (in mode 0).
6894 Available modes are:
6898 Move odd frames into the upper field, even into the lower field, generating
6899 a full-height frame at half framerate.
6901 Only output odd frames, even frames are dropped; height unchanged.
6903 Only output even frames, odd frames are dropped; height unchanged.
6905 Expand each frame to full height, but pad alternate lines with black;
6906 framerate unchanged.
6908 Interleave even lines from even frames with odd lines from odd frames.
6909 Height unchanged at half framerate.
6914 .B tfields[=mode[:field_dominance]]
6915 Temporal field separation \- split fields into frames, doubling the
6917 Like the telecine filter, tfields will only work properly with
6918 MEncoder, and only if both \-fps and \-ofps are set to the
6919 desired (double) framerate!
6923 0: Leave fields unchanged (will jump/\:flicker).
6925 1: Interpolate missing lines. (The algorithm used might not be so good.)
6927 2: Translate fields by 1/4 pixel with linear interpolation (no jump).
6929 4: Translate fields by 1/4 pixel with 4tap filter (higher quality) (default).
6930 .IPs <field_dominance>\ (DEPRECATED)
6932 Only works if the decoder exports the appropriate information and
6933 no other filters which discard that information come before tfields
6934 in the filter chain, otherwise it falls back to 0 (top field first).
6938 1: bottom field first
6941 This option will possibly be removed in a future version.
6942 Use \-field\-dominance instead.
6947 .B yadif=[mode[:field_dominance]]
6948 Yet another deinterlacing filter
6952 0: Output 1 frame for each frame.
6954 1: Output 1 frame for each field.
6956 2: Like 0 but skips spatial interlacing check.
6958 3: Like 1 but skips spatial interlacing check.
6959 .IPs <field_dominance>\ (DEPRECATED)
6960 Operates like tfields.
6963 This option will possibly be removed in a future version.
6964 Use \-field\-dominance instead.
6969 .B mcdeint=[mode[:parity[:qp]]]
6970 Motion compensating deinterlacer.
6971 It needs one field per frame as input and must thus be used together
6972 with tfields=1 or yadif=1/3 or equivalent.
6980 2: slow, iterative motion estimation
6982 3: extra slow, like 2 plus multiple reference frames
6984 0 or 1 selects which field to use (note: no autodetection yet!).
6986 Higher values should result in a smoother motion vector
6987 field but less optimal individual vectors.
6992 .B boxblur=radius:power[:radius:power]
6997 blur filter strength
6999 number of filter applications
7004 .B sab=radius:pf:colorDiff[:radius:pf:colorDiff]
7009 blur filter strength (~0.1\-4.0) (slower if larger)
7011 prefilter strength (~0.1\-2.0)
7013 maximum difference between pixels to still be considered (~0.1\-100.0)
7018 .B smartblur=radius:strength:threshold[:radius:strength:threshold]
7023 blur filter strength (~0.1\-5.0) (slower if larger)
7025 blur (0.0\-1.0) or sharpen (\-1.0\-0.0)
7027 filter all (0), filter flat areas (0\-30) or filter edges (\-30\-0)
7032 .B perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
7033 Correct the perspective of movies not filmed perpendicular to the screen.
7037 coordinates of the top left, top right, bottom left, bottom right corners
7039 linear (0) or cubic resampling (1)
7045 Scale and smooth the image with the 2x scale and interpolate algorithm.
7049 1bpp bitmap to YUV/\:BGR 8/\:15/\:16/\:32 conversion
7052 .B down3dright[=lines]
7053 Reposition and resize stereoscopic images.
7054 Extracts both stereo fields and places them side by side, resizing
7055 them to maintain the original movie aspect.
7059 number of lines to select from the middle of the image (default: 12)
7064 .B bmovl=hidden:opaque:fifo
7065 The bitmap overlay filter reads bitmaps from a FIFO and displays them
7066 on top of the movie, allowing some transformations on the image.
7067 Also see TOOLS/bmovl-test.c for a small bmovl test program.
7071 Set the default value of the 'hidden' flag (0=visible, 1=hidden).
7073 Set the default value of the 'opaque' flag (0=transparent, 1=opaque).
7075 path/\:filename for the FIFO (named pipe connecting 'mplayer \-vf bmovl' to the
7076 controlling application)
7085 .IPs "RGBA32 width height xpos ypos alpha clear"
7086 followed by width*height*4 Bytes of raw RGBA32 data.
7087 .IPs "ABGR32 width height xpos ypos alpha clear"
7088 followed by width*height*4 Bytes of raw ABGR32 data.
7089 .IPs "RGB24 width height xpos ypos alpha clear"
7090 followed by width*height*3 Bytes of raw RGB24 data.
7091 .IPs "BGR24 width height xpos ypos alpha clear"
7092 followed by width*height*3 Bytes of raw BGR24 data.
7093 .IPs "ALPHA width height xpos ypos alpha"
7094 Change alpha transparency of the specified area.
7095 .IPs "CLEAR width height xpos ypos"
7098 Disable all alpha transparency.
7099 Send "ALPHA 0 0 0 0 0" to enable it again.
7112 .IPs "<width>, <height>"
7114 .IPs "<xpos>, <ypos>"
7115 Start blitting at position x/y.
7117 Set alpha difference.
7118 If you set this to \-255 you can then send a sequence of ALPHA-commands to set
7119 the area to \-225, \-200, \-175 etc for a nice fade-in-effect! ;)
7123 255: Make everything opaque.
7125 \-255: Make everything transparent.
7128 Clear the framebuffer before blitting.
7130 0: The image will just be blitted on top of the old one, so you do not need to
7131 send 1.8MB of RGBA32 data every time a small part of the screen is updated.
7139 .B framestep=I|[i]step
7140 Renders only every nth frame or every intra frame (keyframe).
7142 If you call the filter with I (uppercase) as the parameter, then
7144 keyframes are rendered.
7145 For DVDs it generally means one in every 15/12 frames (IBBPBBPBBPBBPBB),
7146 for AVI it means every scene change or every keyint value (see \-lavcopts
7147 keyint= value if you use MEncoder to encode the video).
7149 When a keyframe is found, an 'I!' string followed by a newline character is
7150 printed, leaving the current line of MPlayer/\:MEncoder output on the screen,
7151 because it contains the time (in seconds) and frame number of the keyframe
7152 (You can use this information to split the AVI.).
7154 If you call the filter with a numeric parameter 'step' then only one in
7155 every 'step' frames is rendered.
7157 If you put an 'i' (lowercase) before the number then an 'I!' is printed
7158 (like the I parameter).
7160 If you give only the i then nothing is done to the frames, only I! is
7164 .B tile=xtiles:ytiles:output:start:delta
7165 Tile a series of images into a single, bigger image.
7166 If you omit a parameter or use a value less than 0, then the default
7168 You can also stop when you are satisfied (... \-vf tile=10:5 ...).
7169 It is probably a good idea to put the scale filter before the tile :-)
7176 number of tiles on the x axis (default: 5)
7178 number of tiles on the y axis (default: 5)
7180 Render the tile when 'output' number of frames are reached, where 'output'
7181 should be a number less than xtile * ytile.
7182 Missing tiles are left blank.
7183 You could, for example, write an 8 * 7 tile every 50 frames to have one
7184 image every 2 seconds @ 25 fps.
7186 outer border thickness in pixels (default: 2)
7188 inner border thickness in pixels (default: 4)
7193 .B delogo[=x:y:w:h:t]
7194 Suppresses a TV station logo by a simple interpolation of the
7196 Just set a rectangle covering the logo and watch it disappear (and
7197 sometimes something even uglier appear \- your mileage may vary).
7201 top left corner of the logo
7203 width and height of the cleared rectangle
7205 Thickness of the fuzzy edge of the rectangle (added to w and h).
7206 When set to \-1, a green rectangle is drawn on the screen to
7207 simplify finding the right x,y,w,h parameters.
7212 .B remove\-logo=/path/to/logo_bitmap_file_name.pgm
7213 Suppresses a TV station logo, using a PGM or PPM image
7214 file to determine which pixels comprise the logo.
7215 The width and height of the image file must match
7216 those of the video stream being processed.
7217 Uses the filter image and a circular blur
7218 algorithm to remove the logo.
7220 .IPs /path/to/logo_bitmap_file_name.pgm
7221 [path] + filename of the filter image.
7225 .B zrmjpeg[=options]
7226 Software YV12 to MJPEG encoder for use with the zr2 video
7229 .IPs maxheight=<h>|maxwidth=<w>
7230 These options set the maximum width and height the zr card
7231 can handle (the MPlayer filter layer currently cannot query those).
7232 .IPs {dc10+,dc10,buz,lml33}-{PAL|NTSC}
7233 Use these options to set maxwidth and maxheight automatically to the
7234 values known for card/\:mode combo.
7235 For example, valid options are: dc10-PAL and buz-NTSC (default: dc10+PAL)
7237 Select color or black and white encoding.
7238 Black and white encoding is faster.
7239 Color is the default.
7241 Horizontal decimation 1, 2 or 4.
7243 Vertical decimation 1, 2 or 4.
7245 Set JPEG compression quality [BEST] 1 \- 20 [VERY BAD].
7247 By default, decimation is only performed if the Zoran hardware
7248 can upscale the resulting MJPEG images to the original size.
7249 The option fd instructs the filter to always perform the requested
7255 Allows acquiring screenshots of the movie using slave mode
7256 commands that can be bound to keypresses.
7257 See the slave mode documentation and the INTERACTIVE CONTROL
7258 section for details.
7259 Files named 'shotNNNN.png' will be saved in the working directory,
7260 using the first available number \- no files will be overwritten.
7261 The filter has no overhead when not used and accepts an arbitrary
7262 colorspace, so it is safe to add it to the configuration file.
7267 Moves SSA/ASS subtitle rendering to an arbitrary point in the filter chain.
7268 Only useful with the \-ass option.
7273 .IPs "\-vf ass,screenshot"
7274 Moves SSA/ASS rendering before the screenshot filter.
7275 Screenshots taken this way will contain subtitles.
7280 .B blackframe[=amount:threshold]
7281 Detect frames that are (almost) completely black.
7282 Can be useful to detect chapter transitions or commercials.
7283 Output lines consist of the frame number of the detected frame, the
7284 percentage of blackness, the frame type and the frame number of the last
7285 encountered keyframe.
7288 Percentage of the pixels that have to be below the threshold (default: 98).
7290 Threshold below which a pixel value is considered black (default: 32).
7294 .B gradfun[=strength[:radius]]
7295 Fix the banding artifacts that are sometimes introduced into nearly flat
7296 regions by truncation to 8bit colordepth.
7297 Interpolates the gradients that should go where the bands are, and
7300 This filter is designed for playback only.
7301 Do not use it prior to lossy compression, because compression tends
7302 to lose the dither and bring back the bands.
7305 Maximum amount by which the filter will change any one pixel.
7306 Also the threshold for detecting nearly flat regions (default: 1.2).
7308 Neighborhood to fit the gradient to.
7309 Larger radius makes for smoother gradients, but also prevents the filter
7310 from modifying pixels near detailed regions (default: 16).
7314 .B tcdump[=filename]
7315 Dump frame timecodes to a file, in the v2 external timecode file used by
7316 mkvmerge. With proper post-processing, this could be used to produce VFR
7317 files with mplayer/mencoder. Note that mencoder does not pass timestamps
7318 to the filter chain, and will not work with this filter. If none is given,
7319 the default filename is "timecodesv2.txt".
7324 Fixes the presentation timestamps (PTS) of the frames.
7325 By default, the PTS passed to the next filter is dropped, but the following
7326 options can change that:
7329 Print the incoming PTS.
7331 Specify a frame per second value.
7333 Specify an initial value for the PTS.
7337 incoming PTS as the initial PTS.
7338 All previous pts are kept, so setting a huge value or \-1 keeps the PTS
7343 incoming PTS after the end of autostart to determine the framerate.
7351 .IPs "\-vf fixpts=fps=24000/1001,ass,fixpts"
7352 Generates a new sequence of PTS, uses it for ASS subtitles, then drops it.
7353 Generating a new sequence is useful when the timestamps are reset during the
7354 program; this is frequent on DVDs.
7355 Dropping it may be necessary to avoid confusing encoders.
7361 Using this filter together with any sort of seeking (including -ss and EDLs)
7362 may make demons fly out of your nose.
7365 .SH "GENERAL ENCODING OPTIONS (MENCODER ONLY)"
7368 .B \-audio\-delay <any floating-point number>
7369 Delays either audio or video by setting a delay field in the header
7371 This does not delay either stream while encoding, but the player will
7372 see the delay field and compensate accordingly.
7373 Positive values delay the audio, and negative values delay the video.
7374 Note that this is the exact opposite of the \-delay option.
7375 For example, if a video plays correctly with \-delay 0.2, you can
7376 fix the video with MEncoder by using \-audio\-delay \-0.2.
7378 Currently, this option only works with the default muxer (\-of avi).
7379 If you are using a different muxer, then you must use \-delay instead.
7382 .B \-audio\-density <1\-50>
7383 Number of audio chunks per second (default is 2 for 0.5s long audio chunks).
7386 CBR only, VBR ignores this as it puts each packet in a new chunk.
7389 .B \-audio\-preload <0.0\-2.0>
7390 Sets up the audio buffering time interval (default: 0.5s).
7393 .B \-fafmttag <format>
7394 Can be used to override the audio format tag of the output file.
7399 .IPs "\-fafmttag 0x55"
7400 Will have the output file contain 0x55 (mp3) as audio format tag.
7405 .B \-ffourcc <fourcc>
7406 Can be used to override the video fourcc of the output file.
7411 .IPs "\-ffourcc div3"
7412 Will have the output file contain 'div3' as video fourcc.
7417 .B \-force\-avi\-aspect <0.2\-3.0>
7418 Override the aspect stored in the AVI OpenDML vprp header.
7419 This can be used to change the aspect ratio with '\-ovc copy'.
7422 .B \-frameno\-file <filename> (DEPRECATED)
7423 Specify the name of the audio file with framenumber mappings created in
7424 the first (audio only) pass of a special three pass encoding mode.
7427 Using this mode will most likely give you A-V desync.
7429 It is kept for backwards compatibility only and will possibly
7430 be removed in a future version.
7434 Use a more precise, but much slower method for skipping areas.
7435 Areas marked for skipping are not seeked over, instead all
7436 frames are decoded, but only the necessary frames are encoded.
7437 This allows starting at non-keyframe boundaries.
7440 Not guaranteed to work right with '\-ovc copy'.
7443 .B \-info <option1:option2:...> (AVI only)
7444 Specify the info header of the resulting AVI file.
7446 Available options are:
7449 Show this description.
7453 artist or author of the work
7455 original work category
7456 .IPs subject=<value>
7457 contents of the work
7458 .IPs copyright=<value>
7459 copyright information
7460 .IPs srcform=<value>
7461 original format of the digitized material
7462 .IPs comment=<value>
7463 general comments about the work
7468 Do not automatically insert the expand filter into the MEncoder filter chain.
7469 Useful to control at which point of the filter chain subtitles are rendered
7470 when hardcoding subtitles onto a movie.
7474 Do not attempt to encode duplicate frames in duplicate; always output
7475 zero-byte frames to indicate duplicates.
7476 Zero-byte frames will be written anyway unless a filter or encoder
7477 capable of doing duplicate encoding is loaded.
7478 Currently the only such filter is harddup.
7481 .B \-noodml (\-of avi only)
7482 Do not write OpenDML index for AVI files >1GB.
7486 Send the original presentation timestamp (PTS) down the filter and encoder
7488 This may cause incorrect output ("badly interleaved") if the original PTS
7489 are wrong or the framerate is changed, but can be necessary for certain
7490 filters (such as ASS).
7498 Outputs to the given filename.
7500 If you want a default output filename, you can put this option in the
7501 MEncoder config file.
7504 .B \-oac <codec name>
7505 Encode with the given audio codec (no default set).
7508 Use \-oac help to get a list of available audio codecs.
7514 no encoding, just streamcopy
7516 Encode to uncompressed PCM.
7517 .IPs "\-oac mp3lame"
7518 Encode to MP3 (using LAME).
7520 Encode with a libavcodec codec.
7525 .B \-of <format> (BETA CODE!)
7526 Encode to the specified container format (default: AVI).
7529 Use \-of help to get a list of available container formats.
7537 Encode to MPEG (also see \-mpegopts).
7539 Encode with libavformat muxers (also see \-lavfopts).
7540 .IPs "\-of rawvideo"
7541 raw video stream (no muxing \- one video stream only)
7542 .IPs "\-of rawaudio"
7543 raw audio stream (no muxing \- one audio stream only)
7549 Specify a frames per second (fps) value for the output file,
7550 which can be different from that of the source material.
7551 Must be set for variable fps (ASF, some MOV) and progressive
7552 (30000/1001 fps telecined MPEG) files.
7555 .B \-ovc <codec name>
7556 Encode with the given video codec (no default set).
7559 Use \-ovc help to get a list of available video codecs.
7565 no encoding, just streamcopy
7567 Encode to an arbitrary uncompressed format (use '\-vf format' to select).
7569 Encode with a libavcodec codec.
7574 .B \-passlogfile <filename>
7575 Dump first pass information to <filename> instead of the default divx2pass.log
7576 in two pass encoding mode.
7579 .B \-skiplimit <value>
7580 Specify the maximum number of frames that may be skipped after
7581 encoding one frame (\-noskiplimit for unlimited).
7584 .B \-vobsubout <basename>
7585 Specify the basename for the output .idx and .sub files.
7586 This turns off subtitle rendering in the encoded movie and diverts it to
7587 VOBsub subtitle files.
7590 .B \-vobsuboutid <langid>
7591 Specify the language two letter code for the subtitles.
7592 This overrides what is read from the DVD or the .ifo file.
7595 .B \-vobsuboutindex <index>
7596 Specify the index of the subtitles in the output files (default: 0).
7600 .SH "CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY)"
7601 You can specify codec specific encoding parameters using the following
7605 .B \-<codec>opts <option1[=value1]:option2[=value2]:...>
7608 Where <codec> may be: lavc, xvidenc, mp3lame, toolame, twolame,
7609 nuv, xvfw, faac, x264enc, mpeg, lavf.
7612 .SS mp3lame (\-lameopts)
7620 variable bitrate method
7643 Also forces CBR mode encoding on subsequent ABR presets modes.
7647 bitrate in kbps (CBR and ABR only)
7651 quality (0 \- highest, 9 \- lowest) (VBR only)
7655 algorithmic quality (0 \- best/slowest, 9 \- worst/fastest)
7696 Switch on faster encoding on subsequent VBR presets modes.
7697 This results in slightly lower quality and higher bitrates.
7700 .B highpassfreq=<freq>
7701 Set a highpass filtering frequency in Hz.
7702 Frequencies below the specified one will be cut off.
7703 A value of \-1 will disable filtering, a value of 0
7704 will let LAME choose values automatically.
7707 .B lowpassfreq=<freq>
7708 Set a lowpass filtering frequency in Hz.
7709 Frequencies above the specified one will be cut off.
7710 A value of \-1 will disable filtering, a value of 0
7711 will let LAME choose values automatically.
7718 Print additional options and information about presets settings.
7720 VBR encoding, good quality, 150\-180 kbps bitrate range
7722 VBR encoding, high quality, 170\-210 kbps bitrate range
7724 VBR encoding, very high quality, 200\-240 kbps bitrate range
7726 CBR encoding, highest preset quality, 320 kbps bitrate
7728 ABR encoding at average given kbps bitrate
7736 .IPs fast:preset=standard
7737 suitable for most people and most music types and already quite high quality
7739 Encode with ABR presets at a 192 kbps forced constant bitrate.
7741 Encode with ABR presets at a 172 kbps average bitrate.
7743 for people with extremely good hearing and similar equipment
7748 .SS toolame and twolame (\-toolameopts and \-twolameopts respectively)
7752 In CBR mode this parameter indicates the bitrate in kbps,
7753 when in VBR mode it is the minimum bitrate allowed per frame.
7754 VBR mode will not work with a value below 112.
7757 .B vbr=<\-50\-50> (VBR only)
7758 variability range; if negative the encoder shifts the average bitrate
7759 towards the lower limit, if positive towards the higher.
7760 When set to 0 CBR is used (default).
7763 .B maxvbr=<32\-384> (VBR only)
7764 maximum bitrate allowed per frame, in kbps
7767 .B mode=<stereo | jstereo | mono | dual>
7768 (default: mono for 1-channel audio, stereo otherwise)
7772 psychoacoustic model (default: 2)
7776 Include error protection.
7785 .SS faac (\-faacopts)
7789 average bitrate in kbps (mutually exclusive with quality)
7792 .B quality=<1\-1000>
7793 quality mode, the higher the better (mutually exclusive with br)
7797 object type complexity
7807 LTP (extremely slow)
7813 MPEG version (default: 4)
7817 Enables temporal noise shaping.
7820 .B cutoff=<0\-sampling_rate/2>
7821 cutoff frequency (default: sampling_rate/2)
7825 Stores the bitstream as raw payload with extradata in the container header
7826 (default: 0, corresponds to ADTS).
7827 Do not set this flag if not explicitly required or you will not be able to
7828 remux the audio stream later on.
7833 .SS lavc (\-lavcopts)
7835 Many libavcodec (lavc for short) options are tersely documented.
7836 Read the source for full details.
7841 .IPs vcodec=msmpeg4:vbitrate=1800:vhq:keyint=250
7846 .B o=<key>=<value>[,<key>=<value>[,...]]
7847 Pass AVOptions to libavcodec encoder.
7848 Note, a patch to make the o= unneeded and pass all unknown options through
7849 the AVOption system is welcome.
7850 A full list of AVOptions can be found in the FFmpeg manual.
7851 Note that some AVOptions may conflict with MEncoder options.
7864 audio codec (default: mp2)
7868 Dolby Digital (AC-3)
7870 Adaptive PCM formats \- see the HTML documentation for details.
7872 Free Lossless Audio Codec (FLAC)
7876 3GPP Adaptive Multi-Rate (AMR) narrow-band
7878 3GPP Adaptive Multi-Rate (AMR) wide-band
7880 Advanced Audio Coding (AAC) \- using FAAC
7882 MPEG-1 audio layer 3 (MP3) \- using LAME
7884 MPEG-1 audio layer 2 (MP2)
7886 PCM formats \- see the HTML documentation for details.
7888 Id Software RoQ DPCM
7890 experimental simple lossy codec
7892 experimental simple lossless codec
7896 Windows Media Audio v1
7898 Windows Media Audio v2
7904 audio bitrate in kbps (default: 224)
7908 Use the specified Windows audio format tag (e.g.\& atag=0x55).
7912 Use only bit exact algorithms (except (I)DCT).
7913 Additionally bit_exact disables several optimizations and thus
7914 should only be used for regression tests, which need binary
7915 identical files even if the encoder version changes.
7916 This also suppresses the user_data header in MPEG-4 streams.
7917 Do not use this option unless you know exactly what you are doing.
7921 Maximum number of threads to use (default: 1).
7922 May have a slight negative effect on motion estimation.
7927 Employ the specified codec (default: mpeg4).
7937 FFmpeg's lossless video codec
7939 nonstandard 20% smaller HuffYUV using YV12
7941 Sorenson H.263 used in Flash Video
7953 x264 H.264/AVC MPEG-4 Part 10
7955 Xvid MPEG-4 Part 2 (ASP)
7971 ID Software RoQ Video
7973 an old RealVideo codec
7974 .IPs "snow (also see: vstrict)"
7975 FFmpeg's experimental wavelet-based codec
7977 Apple Sorenson Video 1
7979 Windows Media Video, version 1 (AKA WMV7)
7981 Windows Media Video, version 2 (AKA WMV8)
7990 Not recommended (much larger file, little quality difference and weird side
7991 effects: msmpeg4, h263 will be very low quality, ratecontrol will be confused
7992 resulting in lower quality and some decoders will not be able to decode it).
7994 Recommended for normal mpeg4/\:mpeg1video encoding (default).
7996 Recommended for h263(p)/\:msmpeg4.
7997 The reason for preferring 3 over 2 is that 2 could lead to overflows.
7998 (This will be fixed for h263(p) by changing the quantizer per MB in
7999 the future, msmpeg4 cannot be fixed as it does not support that.)
8003 .B lmin=<0.01\-255.0>
8004 Minimum frame-level Lagrange multiplier for ratecontrol (default: 2.0).
8005 Lavc will rarely use quantizers below the value of lmin.
8006 Lowering lmin will make lavc more likely to choose lower quantizers for
8007 some frames, but not lower than the value of vqmin.
8008 Likewise, raising lmin will make lavc less likely to choose low
8009 quantizers, even if vqmin would have allowed them.
8010 You probably want to set lmin approximately equal to vqmin.
8011 When adaptive quantization is in use, changing lmin/lmax may have less
8012 of an effect; see mblmin/mblmax.
8016 .B lmax=<0.01\-255.0>
8017 maximum Lagrange multiplier for ratecontrol (default: 31.0)
8021 .B mblmin=<0.01\-255.0>
8022 Minimum macroblock-level Lagrange multiplier for ratecontrol
8024 This parameter affects adaptive quantization options like qprd,
8029 .B mblmax=<0.01\-255.0>
8030 Maximum macroblock-level Lagrange multiplier for ratecontrol
8036 Constant quantizer /\: constant quality encoding (selects fixed quantizer mode).
8037 A lower value means better quality but larger files (default: \-1).
8038 In case of snow codec, value 0 means lossless encoding.
8039 Since the other codecs do not support this, vqscale=0 will have an undefined
8041 1 is not recommended (see vqmin for details).
8045 Maximum quantizer, 10\-31 should be a sane range (default: 31).
8057 maximum quantizer difference between consecutive I- or P-frames
8061 .B vmax_b_frames=<0\-4>
8062 maximum number of B-frames between non-B-frames:
8066 no B-frames (default)
8068 sane range for MPEG-4
8074 motion estimation method.
8075 Available methods are:
8079 none (very low quality)
8081 full (slow, currently unmaintained and disabled)
8083 log (low quality, currently unmaintained and disabled)
8085 phods (low quality, currently unmaintained and disabled)
8087 EPZS: size=1 diamond, size can be adjusted with the *dia options
8090 X1 (experimental, currently aliased to EPZS)
8092 iter (iterative overlapped block, only used in snow)
8099 0\-3 currently ignores the amount of bits spent,
8100 so quality may be low.
8104 .B me_range=<0\-9999>
8105 motion estimation search range (default: 0 (unlimited))
8108 .B mbd=<0\-2> (also see *cmp, qpel)
8109 Macroblock decision algorithm (high quality mode), encode each macro
8110 block in all modes and choose the best.
8111 This is slow but results in better quality and file size.
8112 When mbd is set to 1 or 2, the value of mbcmp is ignored when comparing
8113 macroblocks (the mbcmp value is still used in other places though, in particular
8114 the motion search algorithms).
8115 If any comparison setting (precmp, subcmp, cmp, or mbcmp) is nonzero,
8116 however, a slower but better half-pel motion search will be used,
8117 regardless of what mbd is set to.
8118 If qpel is set, quarter-pel motion search will be used regardless.
8122 Use comparison function given by mbcmp (default).
8124 Select the MB mode which needs the fewest bits (=vhq).
8126 Select the MB mode which has the best rate distortion.
8132 Same as mbd=1, kept for compatibility reasons.
8136 Allow 4 motion vectors per macroblock (slightly better quality).
8137 Works better if used with mbd>0.
8141 overlapped block motion compensation (H.263+)
8145 loop filter (H.263+)
8146 note, this is broken
8149 .B inter_threshold <\-1000\-1000>
8150 Does absolutely nothing at the moment.
8154 maximum interval between keyframes in frames (default: 250 or one
8155 keyframe every ten seconds in a 25fps movie.
8156 This is the recommended default for MPEG-4).
8157 Most codecs require regular keyframes in order to limit the accumulation of mismatch error.
8158 Keyframes are also needed for seeking, as seeking is only possible to a keyframe \- but
8159 keyframes need more space than other frames, so larger numbers here mean
8160 slightly smaller files but less precise seeking.
8161 0 is equivalent to 1, which makes every frame a keyframe.
8162 Values >300 are not recommended as the quality might be bad depending upon
8163 decoder, encoder and luck.
8164 It is common for MPEG-1/2 to use values <=30.
8167 .B sc_threshold=<\-1000000000\-1000000000>
8168 Threshold for scene change detection.
8169 A keyframe is inserted by libavcodec when it detects a scene change.
8170 You can specify the sensitivity of the detection with this option.
8171 \-1000000000 means there is a scene change detected at every frame,
8172 1000000000 means no scene changes are detected (default: 0).
8175 .B sc_factor=<any positive integer>
8176 Causes frames with higher quantizers to be more likely to trigger a
8177 scene change detection and make libavcodec use an I-frame (default: 1).
8178 1\-16 is a sane range.
8179 Values between 2 and 6 may yield increasing PSNR (up to approximately
8180 0.04 dB) and better placement of I-frames in high-motion scenes.
8181 Higher values than 6 may give very slightly better PSNR (approximately
8182 0.01 dB more than sc_factor=6), but noticably worse visual quality.
8185 .B vb_strategy=<0\-2> (pass one only)
8186 strategy to choose between I/P/B-frames:
8190 Always use the maximum number of B-frames (default).
8192 Avoid B-frames in high motion scenes.
8193 See the b_sensitivity option to tune this strategy.
8195 Places B-frames more or less optimally to yield maximum quality (slower).
8196 You may want to reduce the speed impact of this option by tuning the
8202 .B b_sensitivity=<any integer greater than 0>
8203 Adjusts how sensitively vb_strategy=1 detects motion and avoids using
8204 B-frames (default: 40).
8205 Lower sensitivities will result in more B-frames.
8206 Using more B-frames usually improves PSNR, but too many B-frames can
8207 hurt quality in high-motion scenes.
8208 Unless there is an extremely high amount of motion, b_sensitivity can
8209 safely be lowered below the default; 10 is a reasonable value in most
8213 .B brd_scale=<0\-10>
8214 Downscales frames for dynamic B-frame decision (default: 0).
8215 Each time brd_scale is increased by one, the frame dimensions are
8216 divided by two, which improves speed by a factor of four.
8217 Both dimensions of the fully downscaled frame must be even numbers, so
8218 brd_scale=1 requires the original dimensions to be multiples of four,
8219 brd_scale=2 requires multiples of eight, etc.
8220 In other words, the dimensions of the original frame must both be
8221 divisible by 2^(brd_scale+1) with no remainder.
8224 .B bidir_refine=<0\-4>
8225 Refine the two motion vectors used in bidirectional macroblocks,
8226 rather than re-using vectors from the forward and backward searches.
8227 This option has no effect without B-frames.
8233 Use a wider search (larger values are slower).
8239 Activates internal two (or more) pass mode, only specify if you wish to
8240 use two (or more) pass encoding.
8244 first pass (also see turbo)
8248 Nth pass (second and subsequent passes of N-pass encoding)
8251 Here is how it works, and how to use it:
8253 The first pass (vpass=1) writes the statistics file.
8254 You might want to deactivate some CPU-hungry options, like "turbo"
8257 In two pass mode, the second pass (vpass=2) reads the statistics file and
8258 bases ratecontrol decisions on it.
8260 In N-pass mode, the second pass (vpass=3, that is not a typo)
8261 does both: It first reads the statistics, then overwrites them.
8262 You might want to backup divx2pass.log before doing this if there is
8263 any possibility that you will have to cancel MEncoder.
8264 You can use all encoding options, except very CPU-hungry options like "qns".
8266 You can run this same pass over and over to refine the encode.
8267 Each subsequent pass will use the statistics from the previous pass to improve.
8268 The final pass can include any CPU-hungry encoding options.
8270 If you want a 2 pass encode, use first vpass=1, and then vpass=2.
8272 If you want a 3 or more pass encode, use vpass=1 for the first pass
8273 and then vpass=3 and then vpass=3 again and again until you are
8274 satisfied with the encode.
8286 Encodes with an optimal Huffman table based upon statistics
8287 from the first pass.
8292 .B turbo (two pass only)
8293 Dramatically speeds up pass one using faster algorithms and disabling
8294 CPU-intensive options.
8295 This will probably reduce global PSNR a little bit (around 0.01dB) and
8296 change individual frame type and PSNR a little bit more (up to 0.03dB).
8300 Store movie aspect internally, just like with MPEG files.
8301 Much nicer than rescaling, because quality is not decreased.
8302 Only MPlayer will play these files correctly, other players will display
8303 them with wrong aspect.
8304 The aspect parameter can be given as a ratio or a floating point number.
8311 .IPs "aspect=16/9 or aspect=1.78"
8317 Same as the aspect option, but automatically computes aspect, taking
8318 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
8320 Does not incur a performance penalty, so you can safely leave it
8325 Specify bitrate (default: 800).
8333 .IPs 16001\-24000000
8340 approximated file size tolerance in kbit.
8341 1000\-100000 is a sane range.
8342 (warning: 1kbit = 1000 bits)
8346 vratetol should not be too large during the second pass or there might
8347 be problems if vrc_(min|max)rate is used.
8350 .B vrc_maxrate=<value>
8351 maximum bitrate in kbit/\:sec
8352 (default: 0, unlimited)
8355 .B vrc_minrate=<value>
8356 minimum bitrate in kbit/\:sec
8357 (default: 0, unlimited)
8360 .B vrc_buf_size=<value>
8362 For MPEG-1/2 this also sets the vbv buffer size, use 327 for VCD,
8363 917 for SVCD and 1835 for DVD.
8366 .B vrc_buf_aggressivity
8372 Note that some of the ratecontrol-affecting options will have no effect
8373 if vrc_strategy is not set to 0.
8377 Use internal lavc ratecontrol (default).
8379 Use Xvid ratecontrol (experimental; requires MEncoder to be compiled
8380 with support for Xvid 1.1 or higher).
8385 .B vb_qfactor=<\-31.0\-31.0>
8386 quantizer factor between B- and non-B-frames (default: 1.25)
8389 .B vi_qfactor=<\-31.0\-31.0>
8390 quantizer factor between I- and non-I-frames (default: 0.8)
8393 .B vb_qoffset=<\-31.0\-31.0>
8394 quantizer offset between B- and non-B-frames (default: 1.25)
8397 .B vi_qoffset=<\-31.0\-31.0>
8400 if v{b|i}_qfactor > 0
8402 I/B-frame quantizer = P-frame quantizer * v{b|i}_qfactor + v{b|i}_qoffset
8406 do normal ratecontrol (do not lock to next P-frame quantizer) and
8407 set q= \-q * v{b|i}_qfactor + v{b|i}_qoffset
8410 To do constant quantizer encoding with different quantizers for
8411 I/P- and B-frames you can use:
8412 lmin= <ip_quant>:lmax= <ip_quant>:vb_qfactor= <b_quant/\:ip_quant>.
8415 .B vqblur=<0.0\-1.0> (pass one)
8416 Quantizer blur (default: 0.5), larger values will average the
8417 quantizer more over time (slower change).
8421 Quantizer blur disabled.
8423 Average the quantizer over all previous frames.
8428 .B vqblur=<0.0\-99.0> (pass two)
8429 Quantizer gaussian blur (default: 0.5), larger values will average
8430 the quantizer more over time (slower change).
8433 .B vqcomp=<0.0\-1.0>
8434 Quantizer compression, vrc_eq depends upon this (default: 0.5).
8436 Perceptual quality will be optimal somewhere in between the range's extremes.
8439 .B vrc_eq=<equation>
8440 main ratecontrol equation
8443 .IPs 1+(tex/\:avgTex-1)*qComp
8444 approximately the equation of the old ratecontrol code
8446 with qcomp 0.5 or something like that (default)
8463 intra, non-intra texture complexity
8465 average texture complexity
8467 average intra texture complexity in I-frames
8469 average intra texture complexity in P-frames
8471 average non-intra texture complexity in P-frames
8473 average non-intra texture complexity in B-frames
8475 bits used for motion vectors
8477 maximum length of motion vector in log2 scale
8479 number of intra macroblocks / number of macroblocks
8485 qcomp from the command line
8486 .IPs "isI, isP, isB"
8487 Is 1 if picture type is I/P/B else 0.
8489 See your favorite math book.
8496 .IPs max(a,b),min(a,b)
8499 is 1 if a>b, 0 otherwise
8501 is 1 if a<b, 0 otherwise
8503 is 1 if a==b, 0 otherwise
8504 .IPs "sin, cos, tan, sinh, cosh, tanh, exp, log, abs"
8508 .B vrc_override=<options>
8509 User specified quality for specific parts (ending, credits, ...).
8510 The options are <start-frame>, <end-frame>, <quality>[/<start-frame>,
8511 <end-frame>, <quality>[/...]]:
8514 .IPs "quality (2\-31)"
8516 .IPs "quality (\-500\-0)"
8517 quality correction in %
8522 .B vrc_init_cplx=<0\-1000>
8523 initial complexity (pass 1)
8526 .B vrc_init_occupancy=<0.0\-1.0>
8527 initial buffer occupancy, as a fraction of vrc_buf_size (default: 0.9)
8531 Specify how to keep the quantizer between qmin and qmax.
8537 Use a nice differentiable function (default).
8542 .B vlelim=<\-1000\-1000>
8543 Sets single coefficient elimination threshold for luminance.
8544 Negative values will also consider the DC coefficient (should be at least \-4
8545 or lower for encoding at quant=1):
8556 .B vcelim=<\-1000\-1000>
8557 Sets single coefficient elimination threshold for chrominance.
8558 Negative values will also consider the DC coefficient (should be at least \-4
8559 or lower for encoding at quant=1):
8570 .B vstrict=<\-2|\-1|0|1>
8571 strict standard compliance
8577 Only recommended if you want to feed the output into the
8578 MPEG-4 reference decoder.
8580 Allow libavcodec specific extensions (default).
8582 Enables experimental codecs and features which may not be playable
8583 with future MPlayer versions (snow).
8590 Adds 2 Bytes per video packet, improves error-resistance when transferring over
8591 unreliable channels (e.g.\& streaming over the internet).
8592 Each video packet will be encoded in 3 separate partitions:
8597 .IPs "2. DC coefficients"
8599 .IPs "3. AC coefficients"
8604 MV & DC are most important, losing them looks far worse than losing
8605 the AC and the 1. & 2. partition.
8606 (MV & DC) are far smaller than the 3. partition (AC) meaning that errors
8607 will hit the AC partition much more often than the MV & DC partitions.
8608 Thus, the picture will look better with partitioning than without,
8609 as without partitioning an error will trash AC/\:DC/\:MV equally.
8613 .B vpsize=<0\-10000> (also see vdpart)
8614 Video packet size, improves error-resistance.
8626 slice structured mode for H.263+
8630 grayscale only encoding (faster)
8638 Automatically select a good one (default).
8659 To the best of our knowledge all these IDCTs do pass the IEEE1180 tests.
8663 Automatically select a good one (default).
8665 JPEG reference integer
8671 libmpeg2mmx (inaccurate, do not use for encoding with keyint >100)
8702 .B lumi_mask=<0.0\-1.0>
8703 Luminance masking is a 'psychosensory' setting that is supposed to
8704 make use of the fact that the human eye tends to notice fewer details
8705 in very bright parts of the picture.
8706 Luminance masking compresses bright areas stronger than medium ones,
8707 so it will save bits that can be spent again on other frames, raising
8708 overall subjective quality, while possibly reducing PSNR.
8711 Be careful, overly large values can cause disastrous things.
8714 Large values might look good on some monitors but may look horrible
8726 .B dark_mask=<0.0\-1.0>
8727 Darkness masking is a 'psychosensory' setting that is supposed to
8728 make use of the fact that the human eye tends to notice fewer details
8729 in very dark parts of the picture.
8730 Darkness masking compresses dark areas stronger than medium ones,
8731 so it will save bits that can be spent again on other frames, raising
8732 overall subjective quality, while possibly reducing PSNR.
8735 Be careful, overly large values can cause disastrous things.
8738 Large values might look good on some monitors but may look horrible
8739 on other monitors / TV / TFT.
8750 .B tcplx_mask=<0.0\-1.0>
8751 Temporal complexity masking (default: 0.0 (disabled)).
8752 Imagine a scene with a bird flying across the whole scene; tcplx_mask
8753 will raise the quantizers of the bird's macroblocks (thus decreasing their
8754 quality), as the human eye usually does not have time to see all the bird's
8756 Be warned that if the masked object stops (e.g.\& the bird lands) it is
8757 likely to look horrible for a short period of time, until the encoder
8758 figures out that the object is not moving and needs refined blocks.
8759 The saved bits will be spent on other parts of the video, which may increase
8760 subjective quality, provided that tcplx_mask is carefully chosen.
8763 .B scplx_mask=<0.0\-1.0>
8764 Spatial complexity masking.
8765 Larger values help against blockiness, if no deblocking filter is used for
8766 decoding, which is maybe not a good idea.
8768 Imagine a scene with grass (which usually has great spatial complexity),
8769 a blue sky and a house; scplx_mask will raise the quantizers of the grass'
8770 macroblocks, thus decreasing its quality, in order to spend more bits on
8771 the sky and the house.
8774 Crop any black borders completely as they will reduce the quality
8775 of the macroblocks (also applies without scplx_mask).
8787 This setting does not have the same effect as using a custom matrix that
8788 would compress high frequencies harder, as scplx_mask will reduce the
8789 quality of P blocks even if only DC is changing.
8790 The result of scplx_mask will probably not look as good.
8794 .B p_mask=<0.0\-1.0> (also see vi_qfactor)
8795 Reduces the quality of inter blocks.
8796 This is equivalent to increasing the quality of intra blocks, because the
8797 same average bitrate will be distributed by the rate controller to the
8798 whole video sequence (default: 0.0 (disabled)).
8799 p_mask=1.0 doubles the bits allocated to each intra block.
8802 .B border_mask=<0.0\-1.0>
8803 border-processing for MPEG-style encoders.
8804 Border processing increases the quantizer for macroblocks which are less
8805 than 1/5th of the frame width/height away from the frame border,
8806 since they are often visually less important.
8810 Normalize adaptive quantization (experimental).
8811 When using adaptive quantization (*_mask), the average per-MB quantizer may no
8812 longer match the requested frame-level quantizer.
8813 Naq will attempt to adjust the per-MB quantizers to maintain the proper
8822 Use interlaced motion estimation (mutually exclusive with qpel).
8826 Use alternative scantable.
8829 .B "top=<\-1\-1>\ \ \ "
8850 for HuffYUV, lossless JPEG, dv and ffv1
8852 for lossless JPEG, dv and ffv1
8854 for lossless JPEG, ffv1 and svq1
8856 for lossless JPEG and ffv1
8868 plane/\:gradient prediction
8886 plane/\:gradient prediction
8898 vlc coding (Golomb-Rice)
8900 arithmetic coding (CABAC)
8922 predetermined Huffman tables (builtin or two pass)
8924 adaptive Huffman tables
8930 Use quarter pel motion compensation (mutually exclusive with ilme).
8933 This seems only useful for high bitrate encodings.
8937 Sets the comparison function for the macroblock decision, has only
8939 This is also used for some motion search functions, in which case
8940 it has an effect regardless of mbd setting.
8944 sum of absolute differences, fast (default)
8946 sum of squared errors
8948 sum of absolute Hadamard transformed differences
8950 sum of absolute DCT transformed differences
8952 sum of squared quantization errors (avoid, low quality)
8954 number of bits needed for the block
8956 rate distortion optimal, slow
8960 sum of absolute vertical differences
8962 sum of squared vertical differences
8964 noise preserving sum of squared differences
8966 5/3 wavelet, only used in snow
8968 9/7 wavelet, only used in snow
8970 Also use chroma, currently does not work (correctly) with B-frames.
8975 .B ildctcmp=<0\-2000>
8976 Sets the comparison function for interlaced DCT decision
8977 (see mbcmp for available comparison functions).
8981 Sets the comparison function for motion estimation pre pass
8982 (see mbcmp for available comparison functions) (default: 0).
8986 Sets the comparison function for full pel motion estimation
8987 (see mbcmp for available comparison functions) (default: 0).
8991 Sets the comparison function for sub pel motion estimation
8992 (see mbcmp for available comparison functions) (default: 0).
8995 .B skipcmp=<0\-2000>
8996 FIXME: Document this.
8999 .B nssew=<0\-1000000>
9000 This setting controls NSSE weight, where larger weights will result in
9002 0 NSSE is identical to SSE
9003 You may find this useful if you prefer to keep some noise in your encoded
9004 video rather than filtering it away before encoding (default: 8).
9008 diamond type and size for motion estimation pre-pass
9012 Diamond type & size for motion estimation.
9013 Motion search is an iterative process.
9014 Using a small diamond does not limit the search to finding only small
9016 It is just somewhat more likely to stop before finding the very best motion
9017 vector, especially when noise is involved.
9018 Bigger diamonds allow a wider search for the best motion vector, thus are
9019 slower but result in better quality.
9021 Big normal diamonds are better quality than shape-adaptive diamonds.
9023 Shape-adaptive diamonds are a good tradeoff between speed and quality.
9026 The sizes of the normal diamonds and shape adaptive ones do not have
9030 shape adaptive (fast) diamond with size 3
9032 shape adaptive (fast) diamond with size 2
9034 uneven multi-hexagon search (slow)
9036 normal size=1 diamond (default) =EPZS type diamond
9044 normal size=2 diamond
9057 Trellis searched quantization.
9058 This will find the optimal encoding for each 8x8 block.
9059 Trellis searched quantization is quite simply an optimal quantization in
9060 the PSNR versus bitrate sense (Assuming that there would be no rounding
9061 errors introduced by the IDCT, which is obviously not the case.).
9062 It simply finds a block for the minimum of error and lambda*bits.
9066 quantization parameter (QP) dependent constant
9068 amount of bits needed to encode the block
9070 sum of squared errors of the quantization
9076 Rate distorted optimal coded block pattern.
9077 Will select the coded block pattern which minimizes distortion + lambda*rate.
9078 This can only be used together with trellis quantization.
9082 Try to encode each MB with MV=<0,0> and choose the better one.
9083 This has no effect if mbd=0.
9086 .B mv0_threshold=<any non-negative integer>
9087 When surrounding motion vectors are <0,0> and the motion estimation
9088 score of the current block is less than mv0_threshold, <0,0> is used for
9089 the motion vector and further motion estimation is skipped (default:
9091 Lowering mv0_threshold to 0 can give a slight (0.01dB) PSNR increase and
9092 possibly make the encoded video look slightly better; raising
9093 mv0_threshold past 320 results in diminished PSNR and visual quality.
9094 Higher values speed up encoding very slightly (usually less than 1%,
9095 depending on the other options used).
9098 This option does not require mv0 to be enabled.
9101 .B qprd (mbd=2 only)
9102 rate distorted optimal quantization parameter (QP) for the given
9103 lambda of each macroblock
9106 .B last_pred=<0\-99>
9107 amount of motion predictors from the previous frame
9113 Will use 2a+1 x 2a+1 macroblock square of motion vector predictors from the
9120 motion estimation pre-pass
9126 only after I-frames (default)
9134 subpel refinement quality (for qpel) (default: 8 (high quality))
9137 This has a significant effect on speed.
9141 number of reference frames to consider for motion compensation
9142 (Snow only) (default: 1)
9146 print the PSNR (peak signal to noise ratio) for the whole video after encoding
9147 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
9148 Returned values are in dB (decibel), the higher the better.
9152 Use MPEG quantizers instead of H.263.
9156 Enable AC prediction for MPEG-4 or advanced intra prediction for H.263+.
9157 This will improve quality very slightly (around 0.02 dB PSNR) and slow
9158 down encoding very slightly (about 1%).
9161 vqmin should be 8 or larger for H.263+ AIC.
9165 alternative inter vlc for H.263+
9169 unlimited MVs (H.263+ only)
9170 Allows encoding of arbitrarily long MVs.
9173 .B ibias=<\-256\-256>
9174 intra quantizer bias (256 equals 1.0, MPEG style quantizer default: 96,
9175 H.263 style quantizer default: 0)
9178 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
9179 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
9182 .B pbias=<\-256\-256>
9183 inter quantizer bias (256 equals 1.0, MPEG style quantizer default: 0,
9184 H.263 style quantizer default: \-64)
9187 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
9188 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
9191 A more positive bias (\-32 \- \-16 instead of \-64) seems to improve the PSNR.
9195 Noise reduction, 0 means disabled.
9196 0\-600 is a useful range for typical content, but you may want to turn it
9197 up a bit more for very noisy content (default: 0).
9198 Given its small impact on speed, you might want to prefer to use this over
9199 filtering noise away with video filters like denoise3d or hqdn3d.
9203 Quantizer noise shaping.
9204 Rather than choosing quantization to most closely match the source video
9205 in the PSNR sense, it chooses quantization such that noise (usually ringing)
9206 will be masked by similar-frequency content in the image.
9207 Larger values are slower but may not result in better quality.
9208 This can and should be used together with trellis quantization, in which case
9209 the trellis quantization (optimal for constant weight) will be used as
9210 startpoint for the iterative search.
9216 Only lower the absolute value of coefficients.
9218 Only change coefficients before the last non-zero coefficient + 1.
9225 .B inter_matrix=<comma separated matrix>
9226 Use custom inter matrix.
9227 It needs a comma separated string of 64 integers.
9230 .B intra_matrix=<comma separated matrix>
9231 Use custom intra matrix.
9232 It needs a comma separated string of 64 integers.
9236 experimental quantizer modulation
9240 experimental quantizer modulation
9244 intra DC precision in bits (default: 8).
9245 If you specify vcodec=mpeg2video this value can be 8, 9, 10 or 11.
9248 .B cgop (also see sc_threshold)
9250 Currently it only works if scene change detection is disabled
9251 (sc_threshold=1000000000).
9255 Enable Global Motion Compensation.
9259 Sets the low delay flag for MPEG-1/2 (disables B-frames).
9263 Control writing global video headers.
9267 Codec decides where to write global headers (default).
9269 Write global headers only in extradata (needed for .mp4/MOV/NUT).
9271 Write global headers only in front of keyframes.
9279 Same as vglobal for audio headers.
9283 Set CodecContext Level.
9284 Use 31 or 41 to play video on a Playstation 3.
9287 .B skip_exp=<0\-1000000>
9288 FIXME: Document this.
9291 .B skip_factor=<0\-1000000>
9292 FIXME: Document this.
9295 .B skip_threshold=<0\-1000000>
9296 FIXME: Document this.
9301 Nuppel video is based on RTJPEG and LZO.
9302 By default frames are first encoded with RTJPEG and then compressed with LZO,
9303 but it is possible to disable either or both of the two passes.
9304 As a result, you can in fact output raw i420, LZO compressed i420, RTJPEG,
9305 or the default LZO compressed RTJPEG.
9308 The nuvrec documentation contains some advice and examples about the
9309 settings to use for the most common TV encodings.
9313 chrominance threshold (default: 1)
9317 luminance threshold (default: 1)
9321 Enable LZO compression (default).
9325 Disable LZO compression.
9329 quality level (default: 255)
9333 Disable RTJPEG encoding.
9337 Enable RTJPEG encoding (default).
9340 .SS xvidenc (\-xvidencopts)
9342 There are three modes available: constant bitrate (CBR), fixed quantizer and
9347 Specify the pass in two pass mode.
9350 .B turbo (two pass only)
9351 Dramatically speeds up pass one using faster algorithms and disabling
9352 CPU-intensive options.
9353 This will probably reduce global PSNR a little bit and change individual
9354 frame type and PSNR a little bit more.
9357 .B bitrate=<value> (CBR or two pass mode)
9358 Sets the bitrate to be used in kbits/\:second if <16000 or in bits/\:second
9360 If <value> is negative, Xvid will use its absolute value as the target size
9361 (in kBytes) of the video and compute the associated bitrate automagically
9362 (default: 687 kbits/s).
9365 .B fixed_quant=<1\-31>
9366 Switch to fixed quantizer mode and specify the quantizer to be used.
9369 .B zones=<zone0>[/<zone1>[/...]] (CBR or two pass mode)
9370 User specified quality for specific parts (ending, credits, ...).
9371 Each zone is <start-frame>,<mode>,<value> where <mode> may be
9375 Constant quantizer override, where value=<2.0\-31.0>
9376 represents the quantizer value.
9378 Ratecontrol weight override, where value=<0.01\-2.00>
9379 represents the quality correction in %.
9388 .IPs zones=90000,q,20
9389 Encodes all frames starting with frame 90000 at constant quantizer 20.
9390 .IPs zones=0,w,0.1/10001,w,1.0/90000,q,20
9391 Encode frames 0\-10000 at 10% bitrate, encode frames 90000
9392 up to the end at constant quantizer 20.
9393 Note that the second zone is needed to delimit the first zone, as
9394 without it everything up until frame 89999 would be encoded at 10%
9400 .B me_quality=<0\-6>
9401 This option controls the motion estimation subsystem.
9402 The higher the value, the more precise the estimation should be (default: 6).
9403 The more precise the motion estimation is, the more bits can be saved.
9404 Precision is gained at the expense of CPU time so decrease this setting if
9405 you need realtime encoding.
9409 MPEG-4 uses a half pixel precision for its motion search by default.
9410 The standard proposes a mode where encoders are allowed to use quarter
9412 This option usually results in a sharper image.
9413 Unfortunately it has a great impact on bitrate and sometimes the
9414 higher bitrate use will prevent it from giving a better image
9415 quality at a fixed bitrate.
9416 It is better to test with and without this option and see whether it
9417 is worth activating.
9421 Enable Global Motion Compensation, which makes Xvid generate special
9422 frames (GMC-frames) which are well suited for Pan/\:Zoom/\:Rotating images.
9423 Whether or not the use of this option will save bits is highly
9424 dependent on the source material.
9428 Trellis Quantization is a kind of adaptive quantization method that
9429 saves bits by modifying quantized coefficients to make them more
9430 compressible by the entropy encoder.
9431 Its impact on quality is good, and if VHQ uses too much CPU for you,
9432 this setting can be a good alternative to save a few bits (and gain
9433 quality at fixed bitrate) at a lesser cost than with VHQ (default: on).
9437 Activate this if your encoded sequence is an anime/\:cartoon.
9438 It modifies some Xvid internal thresholds so Xvid takes better decisions on
9439 frame types and motion vectors for flat looking cartoons.
9443 The usual motion estimation algorithm uses only the luminance information to
9444 find the best motion vector.
9445 However for some video material, using the chroma planes can help find
9447 This setting toggles the use of chroma planes for motion estimation
9452 Enable a chroma optimizer prefilter.
9453 It will do some extra magic on color information to minimize the
9454 stepped-stairs effect on edges.
9455 It will improve quality at the cost of encoding speed.
9456 It reduces PSNR by nature, as the mathematical deviation to the original
9457 picture will get bigger, but the subjective image quality will raise.
9458 Since it works with color information, you might want to turn it off when
9459 encoding in grayscale.
9463 Activates high-quality prediction of AC coefficients for intra frames from
9464 neighbor blocks (default: on).
9468 The motion search algorithm is based on a search in the usual color domain
9469 and tries to find a motion vector that minimizes the difference between the
9470 reference frame and the encoded frame.
9471 With this setting activated, Xvid will also use the frequency domain (DCT)
9472 to search for a motion vector that minimizes not only the spatial
9473 difference but also the encoding length of the block.
9480 mode decision (inter/\:intra MB) (default)
9492 Adaptive quantization allows the macroblock quantizers to vary inside
9494 This is a 'psychosensory' setting that is supposed to make use of the
9495 fact that the human eye tends to notice fewer details in very bright
9496 and very dark parts of the picture.
9497 It compresses those areas more strongly than medium ones, which will
9498 save bits that can be spent again on other frames, raising overall
9499 subjective quality and possibly reducing PSNR.
9503 Make Xvid discard chroma planes so the encoded video is grayscale only.
9504 Note that this does not speed up encoding, it just prevents chroma data
9505 from being written in the last stage of encoding.
9509 Encode the fields of interlaced video material.
9510 Turn this option on for interlaced content.
9513 Should you rescale the video, you would need an interlace-aware resizer,
9514 which you can activate with \-vf scale=<width>:<height>:1.
9517 .B min_iquant=<0\-31>
9518 minimum I-frame quantizer (default: 2)
9521 .B max_iquant=<0\-31>
9522 maximum I-frame quantizer (default: 31)
9525 .B min_pquant=<0\-31>
9526 minimum P-frame quantizer (default: 2)
9529 .B max_pquant=<0\-31>
9530 maximum P-frame quantizer (default: 31)
9533 .B min_bquant=<0\-31>
9534 minimum B-frame quantizer (default: 2)
9537 .B max_bquant=<0\-31>
9538 maximum B-frame quantizer (default: 31)
9541 .B min_key_interval=<value> (two pass only)
9542 minimum interval between keyframes (default: 0)
9545 .B max_key_interval=<value>
9546 maximum interval between keyframes (default: 10*fps)
9549 .B quant_type=<h263|mpeg>
9550 Sets the type of quantizer to use.
9551 For high bitrates, you will find that MPEG quantization preserves more detail.
9552 For low bitrates, the smoothing of H.263 will give you less block noise.
9553 When using custom matrices, MPEG quantization
9558 .B quant_intra_matrix=<filename>
9559 Load a custom intra matrix file.
9560 You can build such a file with xvid4conf's matrix editor.
9563 .B quant_inter_matrix=<filename>
9564 Load a custom inter matrix file.
9565 You can build such a file with xvid4conf's matrix editor.
9568 .B keyframe_boost=<0\-1000> (two pass mode only)
9569 Shift some bits from the pool for other frame types to intra frames,
9570 thus improving keyframe quality.
9571 This amount is an extra percentage, so a value of 10 will give
9572 your keyframes 10% more bits than normal
9576 .B kfthreshold=<value> (two pass mode only)
9577 Works together with kfreduction.
9578 Determines the minimum distance below which you consider that
9579 two frames are considered consecutive and treated differently
9580 according to kfreduction
9584 .B kfreduction=<0\-100> (two pass mode only)
9585 The above two settings can be used to adjust the size of keyframes that
9586 you consider too close to the first (in a row).
9587 kfthreshold sets the range in which keyframes are reduced, and
9588 kfreduction determines the bitrate reduction they get.
9589 The last I-frame will get treated normally
9593 .B max_bframes=<0\-4>
9594 Maximum number of B-frames to put between I/P-frames (default: 2).
9597 .B bquant_ratio=<0\-1000>
9598 quantizer ratio between B- and non-B-frames, 150=1.50 (default: 150)
9601 .B bquant_offset=<\-1000\-1000>
9602 quantizer offset between B- and non-B-frames, 100=1.00 (default: 100)
9605 .B bf_threshold=<\-255\-255>
9606 This setting allows you to specify what priority to place on the use of
9608 The higher the value, the higher the probability of B-frames being used
9610 Do not forget that B-frames usually have a higher quantizer, and therefore
9611 aggressive production of B-frames may cause worse visual quality.
9615 This option tells Xvid to close every GOP (Group Of Pictures bounded
9616 by two I-frames), which makes GOPs independent from each other.
9617 This just implies that the last frame of the GOP is either a P-frame or a
9618 N-frame but not a B-frame.
9619 It is usually a good idea to turn this option on (default: on).
9623 This option is meant to solve frame-order issues when encoding to
9624 container formats like AVI that cannot cope with out-of-order frames.
9625 In practice, most decoders (both software and hardware) are able to deal
9626 with frame-order themselves, and may get confused when this option is
9627 turned on, so you can safely leave if off, unless you really know what
9631 This will generate an illegal bitstream, and will not be
9632 decodable by ISO-MPEG-4 decoders except DivX/\:libavcodec/\:Xvid.
9635 This will also store a fake DivX version in the file so the bug
9636 autodetection of some decoders might be confused.
9639 .B frame_drop_ratio=<0\-100> (max_bframes=0 only)
9640 This setting allows the creation of variable framerate video streams.
9641 The value of the setting specifies a threshold under which, if the
9642 difference of the following frame to the previous frame is below or equal
9643 to this threshold, a frame gets not coded (a so called n-vop is placed
9645 On playback, when reaching an n-vop the previous frame will be displayed.
9648 Playing with this setting may result in a jerky video, so use it at your
9652 .B rc_reaction_delay_factor=<value>
9653 This parameter controls the number of frames the CBR rate controller
9654 will wait before reacting to bitrate changes and compensating for them
9655 to obtain a constant bitrate over an averaging range of frames.
9658 .B rc_averaging_period=<value>
9659 Real CBR is hard to achieve.
9660 Depending on the video material, bitrate can be variable, and hard to predict.
9661 Therefore Xvid uses an averaging period for which it guarantees a given
9662 amount of bits (minus a small variation).
9663 This settings expresses the "number of frames" for which Xvid averages
9664 bitrate and tries to achieve CBR.
9667 .B rc_buffer=<value>
9668 size of the rate control buffer
9671 .B curve_compression_high=<0\-100>
9672 This setting allows Xvid to take a certain percentage of bits away from
9673 high bitrate scenes and give them back to the bit reservoir.
9674 You could also use this if you have a clip with so many bits allocated
9675 to high-bitrate scenes that the low(er)-bitrate scenes start to look bad
9679 .B curve_compression_low=<0\-100>
9680 This setting allows Xvid to give a certain percentage of extra bits to the
9681 low bitrate scenes, taking a few bits from the entire clip.
9682 This might come in handy if you have a few low-bitrate scenes that are
9683 still blocky (default: 0).
9686 .B overflow_control_strength=<0\-100>
9687 During pass one of two pass encoding, a scaled bitrate curve is computed.
9688 The difference between that expected curve and the result obtained during
9689 encoding is called overflow.
9690 Obviously, the two pass rate controller tries to compensate for that overflow,
9691 distributing it over the next frames.
9692 This setting controls how much of the overflow is distributed every time
9693 there is a new frame.
9694 Low values allow lazy overflow control, big rate bursts are compensated for
9695 more slowly (could lead to lack of precision for small clips).
9696 Higher values will make changes in bit redistribution more abrupt, possibly
9697 too abrupt if you set it too high, creating artifacts (default: 5).
9700 This setting impacts quality a lot, play with it carefully!
9703 .B max_overflow_improvement=<0\-100>
9704 During the frame bit allocation, overflow control may increase the frame
9706 This parameter specifies the maximum percentage by which the overflow
9707 control is allowed to increase the frame size, compared to the ideal curve
9712 .B max_overflow_degradation=<0\-100>
9713 During the frame bit allocation, overflow control may decrease the frame
9715 This parameter specifies the maximum percentage by which the overflow
9716 control is allowed to decrease the frame size, compared to the ideal curve
9721 .B container_frame_overhead=<0...>
9722 Specifies a frame average overhead per frame, in bytes.
9723 Most of the time users express their target bitrate for video w/o taking
9724 care of the video container overhead.
9725 This small but (mostly) constant overhead can cause the target file size
9727 Xvid allows users to set the amount of overhead per frame the
9728 container generates (give only an average per frame).
9729 0 has a special meaning, it lets Xvid use its own default values
9730 (default: 24 \- AVI average overhead).
9733 .B profile=<profile_name>
9734 Restricts options and VBV (peak bitrate over a short period) according to
9735 the Simple, Advanced Simple and DivX profiles.
9736 The resulting videos should be playable on standalone players adhering to these
9737 profile specifications.
9741 no restrictions (default)
9743 simple profile at level 0
9745 simple profile at level 1
9747 simple profile at level 2
9749 simple profile at level 3
9751 advanced simple profile at level 0
9753 advanced simple profile at level 1
9755 advanced simple profile at level 2
9757 advanced simple profile at level 3
9759 advanced simple profile at level 4
9761 advanced simple profile at level 5
9763 DXN handheld profile
9765 DXN portable NTSC profile
9767 DXN portable PAL profile
9769 DXN home theater NTSC profile
9771 DXN home theater PAL profile
9778 These profiles should be used in conjunction with an appropriate \-ffourcc.
9779 Generally DX50 is applicable, as some players do not recognize Xvid but
9780 most recognize DivX.
9785 Specifies the Pixel Aspect Ratio mode (not to be confused with DAR,
9786 the Display Aspect Ratio).
9787 PAR is the ratio of the width and height of a single pixel.
9788 So both are related like this: DAR = PAR * (width/height).
9790 MPEG-4 defines 5 pixel aspect ratios and one extended
9791 one, giving the opportunity to specify a specific pixel aspect
9793 5 standard modes can be specified:
9797 It is the usual PAR for PC content.
9798 Pixels are a square unit.
9800 PAL standard 4:3 PAR.
9801 Pixels are rectangles.
9807 same as above (Do not forget to give the exact ratio.)
9809 Allows you to specify your own pixel aspect ratio with par_width and
9815 In general, setting aspect and autoaspect options is enough.
9819 .B par_width=<1\-255> (par=ext only)
9820 Specifies the width of the custom pixel aspect ratio.
9823 .B par_height=<1\-255> (par=ext only)
9824 Specifies the height of the custom pixel aspect ratio.
9827 .B aspect=<x/y | f (float value)>
9828 Store movie aspect internally, just like MPEG files.
9829 Much nicer solution than rescaling, because quality is not decreased.
9830 MPlayer and a few others players will play these files correctly, others
9831 will display them with the wrong aspect.
9832 The aspect parameter can be given as a ratio or a floating point number.
9836 Same as the aspect option, but automatically computes aspect, taking
9837 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
9842 Print the PSNR (peak signal to noise ratio) for the whole video after encoding
9843 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
9844 the current directory.
9845 Returned values are in dB (decibel), the higher the better.
9849 Save per-frame statistics in ./xvid.dbg. (This is not the two pass control
9855 The following option is only available in Xvid 1.1.x.
9859 This setting allows vector candidates for B-frames to be used for
9860 the encoding chosen using a rate distortion optimized operator,
9861 which is what is done for P-frames by the vhq option.
9862 This produces nicer-looking B-frames while incurring almost no
9863 performance penalty (default: 1).
9867 The following option is only available in the 1.2.x version of Xvid.
9871 Create n threads to run the motion estimation (default: 0).
9872 The maximum number of threads that can be used is the picture height
9876 .SS x264enc (\-x264encopts)
9880 Sets the average bitrate to be used in kbits/\:second (default: off).
9881 Since local bitrate may vary, this average may be inaccurate for
9882 very short videos (see ratetol).
9883 Constant bitrate can be achieved by combining this with vbv_maxrate,
9884 at significant reduction in quality.
9888 This selects the quantizer to use for P-frames.
9889 I- and B-frames are offset from this value by ip_factor and pb_factor, respectively.
9890 20\-40 is a useful range.
9891 Lower values result in better fidelity, but higher bitrates.
9893 Note that quantization in H.264 works differently from MPEG-1/2/4:
9894 H.264's quantization parameter (QP) is on a logarithmic scale.
9895 The mapping is approximately H264QP = 12 + 6*log2(MPEGQP).
9896 For example, MPEG at QP=2 is equivalent to H.264 at QP=18.
9900 Enables constant quality mode, and selects the quality.
9901 The scale is similar to QP.
9902 Like the bitrate-based modes, this allows each frame to use a
9903 different QP based on the frame's complexity.
9907 Enable 2 or 3-pass mode.
9908 It is recommended to always encode in 2 or 3-pass mode as it leads to a
9909 better bit distribution and improves overall quality.
9915 second pass (of two pass encoding)
9917 Nth pass (second and third passes of three pass encoding)
9920 Here is how it works, and how to use it:
9922 The first pass (pass=1) collects statistics on the video and writes them
9924 You might want to deactivate some CPU-hungry options, apart from the ones
9925 that are on by default.
9927 In two pass mode, the second pass (pass=2) reads the statistics file and
9928 bases ratecontrol decisions on it.
9930 In three pass mode, the second pass (pass=3, that is not a typo)
9931 does both: It first reads the statistics, then overwrites them.
9932 You can use all encoding options, except very CPU-hungry options.
9934 The third pass (pass=3) is the same as the second pass, except that it has
9935 the second pass' statistics to work from.
9936 You can use all encoding options, including CPU-hungry ones.
9938 The first pass may use either average bitrate or constant quantizer.
9939 ABR is recommended, since it does not require guessing a quantizer.
9940 Subsequent passes are ABR, and must specify bitrate.
9945 Fast first pass mode.
9946 During the first pass of a two or more pass encode it is possible to gain
9947 speed by disabling some options with negligible or even no impact on the
9948 final pass output quality.
9954 Reduce subq, frameref and disable some inter-macroblock partition analysis
9957 Reduce subq and frameref to 1, use a diamond ME search and disable all
9958 partition analysis modes.
9961 Level 1 can increase first pass speed up to 2x with no change in the global
9962 PSNR of the final pass compared to a full quality first pass.
9964 Level 2 can increase first pass speed up to 4x with about +/\- 0.05dB change
9965 in the global PSNR of the final pass compared to a full quality first pass.
9970 Sets maximum interval between IDR-frames (default: 250).
9971 Larger values save bits, thus improve quality, at the cost of seeking
9973 Unlike MPEG-1/2/4, H.264 does not suffer from DCT drift with large
9977 .B keyint_min=<1\-keyint/2>
9978 Sets minimum interval between IDR-frames (default: 25).
9979 If scenecuts appear within this interval, they are still encoded as
9980 I-frames, but do not start a new GOP.
9981 In H.264, I-frames do not necessarily bound a closed GOP because it is
9982 allowable for a P-frame to be predicted from more frames than just the one
9983 frame before it (also see frameref).
9984 Therefore, I-frames are not necessarily seekable.
9985 IDR-frames restrict subsequent P-frames from referring to any frame
9986 prior to the IDR-frame.
9989 .B scenecut=<\-1\-100>
9990 Controls how aggressively to insert extra I-frames (default: 40).
9991 With small values of scenecut, the codec often has to force an I-frame
9992 when it would exceed keyint.
9993 Good values of scenecut may find a better location for the I-frame.
9994 Large values use more I-frames than necessary, thus wasting bits.
9995 \-1 disables scene-cut detection, so I-frames are inserted only once
9996 every other keyint frames, even if a scene-cut occurs earlier.
9997 This is not recommended and wastes bitrate as scenecuts encoded as P-frames
9998 are just as big as I-frames, but do not reset the "keyint counter".
10001 .B frameref=<1\-16>
10002 Number of previous frames used as predictors in B- and P-frames (default: 1).
10003 This is effective in anime, but in live-action material the improvements
10004 usually drop off very rapidly above 6 or so reference frames.
10005 This has no effect on decoding speed, but does increase the memory needed for
10007 Some decoders can only handle a maximum of 15 reference frames.
10011 maximum number of consecutive B-frames between I- and P-frames (default: 0)
10015 Automatically decides when to use B-frames and how many, up to the maximum
10016 specified above (default: on).
10017 If this option is disabled, then the maximum number of B-frames is used.
10020 .B b_bias=<\-100\-100>
10021 Controls the decision performed by b_adapt.
10022 A higher b_bias produces more B-frames (default: 0).
10026 Allows B-frames to be used as references for predicting other frames.
10027 For example, consider 3 consecutive B-frames: I0 B1 B2 B3 P4.
10028 Without this option, B-frames follow the same pattern as MPEG-[124].
10029 So they are coded in the order I0 P4 B1 B2 B3, and all the B-frames
10030 are predicted from I0 and P4.
10031 With this option, they are coded as I0 P4 B2 B1 B3.
10032 B2 is the same as above, but B1 is predicted from I0 and B2, and
10033 B3 is predicted from B2 and P4.
10034 This usually results in slightly improved compression, at almost no
10036 However, this is an experimental option: it is not fully tuned and
10037 may not always help.
10038 Requires bframes >= 2.
10039 Disadvantage: increases decoding delay to 2 frames.
10043 Use deblocking filter (default: on).
10044 As it takes very little time compared to its quality gain, it is not
10045 recommended to disable it.
10048 .B deblock=<\-6\-6>,<\-6\-6>
10049 The first parameter is AlphaC0 (default: 0).
10050 This adjusts thresholds for the H.264 in-loop deblocking filter.
10051 First, this parameter adjusts the maximum amount of change that the filter is
10052 allowed to cause on any one pixel.
10053 Secondly, this parameter affects the threshold for difference across the
10054 edge being filtered.
10055 A positive value reduces blocking artifacts more, but will also smear details.
10057 The second parameter is Beta (default: 0).
10058 This affects the detail threshold.
10059 Very detailed blocks are not filtered, since the smoothing caused by the
10060 filter would be more noticeable than the original blocking.
10062 The default behavior of the filter almost always achieves optimal quality,
10063 so it is best to either leave it alone, or make only small adjustments.
10064 However, if your source material already has some blocking or noise which
10065 you would like to remove, it may be a good idea to turn it up a little bit.
10069 Use CABAC (Context-Adaptive Binary Arithmetic Coding) (default: on).
10070 Slightly slows down encoding and decoding, but should save 10\-15% bitrate.
10071 Unless you are looking for decoding speed, you should not disable it.
10074 .B qp_min=<1\-51> (ABR or two pass)
10075 Minimum quantizer, 10\-30 seems to be a useful range (default: 10).
10078 .B qp_max=<1\-51> (ABR or two pass)
10079 maximum quantizer (default: 51)
10082 .B qp_step=<1\-50> (ABR or two pass)
10083 maximum value by which the quantizer may be incremented/decremented between
10084 frames (default: 4)
10087 .B ratetol=<0.1\-100.0> (ABR or two pass)
10088 allowed variance in average bitrate (no particular units) (default: 1.0)
10091 .B vbv_maxrate=<value> (ABR or two pass)
10092 maximum local bitrate, in kbits/\:second (default: disabled)
10095 .B vbv_bufsize=<value> (ABR or two pass)
10096 averaging period for vbv_maxrate, in kbits
10097 (default: none, must be specified if vbv_maxrate is enabled)
10100 .B vbv_init=<0.0\-1.0> (ABR or two pass)
10101 initial buffer occupancy, as a fraction of vbv_bufsize (default: 0.9)
10104 .B ip_factor=<value>
10105 quantizer factor between I- and P-frames (default: 1.4)
10108 .B pb_factor=<value>
10109 quantizer factor between P- and B-frames (default: 1.3)
10112 .B qcomp=<0\-1> (ABR or two pass)
10113 quantizer compression (default: 0.6).
10114 A lower value makes the bitrate more constant,
10115 while a higher value makes the quantization parameter more constant.
10118 .B cplx_blur=<0\-999> (two pass only)
10119 Temporal blur of the estimated frame complexity, before curve compression
10121 Lower values allow the quantizer value to jump around more,
10122 higher values force it to vary more smoothly.
10123 cplx_blur ensures that each I-frame has quality comparable to the following
10124 P-frames, and ensures that alternating high and low complexity frames
10125 (e.g.\& low fps animation) do not waste bits on fluctuating quantizer.
10128 .B qblur=<0\-99> (two pass only)
10129 Temporal blur of the quantization parameter, after curve compression
10131 Lower values allow the quantizer value to jump around more,
10132 higher values force it to vary more smoothly.
10135 .B zones=<zone0>[/<zone1>[/...]]
10136 User specified quality for specific parts (ending, credits, ...).
10137 Each zone is <start-frame>,<end-frame>,<option> where option may be
10142 .IPs "b=<0.01\-100.0>"
10148 The quantizer option is not strictly enforced.
10149 It affects only the planning stage of ratecontrol, and is still subject
10150 to overflow compensation and qp_min/qp_max.
10154 .B direct_pred=<name>
10155 Determines the type of motion prediction used for direct macroblocks
10160 Direct macroblocks are not used.
10162 Motion vectors are extrapolated from neighboring blocks.
10165 Motion vectors are extrapolated from the following P-frame.
10167 The codec selects between spatial and temporal for each frame.
10171 Spatial and temporal are approximately the same speed and PSNR,
10172 the choice between them depends on the video content.
10173 Auto is slightly better, but slower.
10174 Auto is most effective when combined with multipass.
10175 direct_pred=none is both slower and lower quality.
10180 Use weighted prediction in B-frames.
10181 Without this option, bidirectionally predicted macroblocks give
10182 equal weight to each reference frame.
10183 With this option, the weights are determined by the temporal position
10184 of the B-frame relative to the references.
10185 Requires bframes > 1.
10188 .B partitions=<list>
10189 Enable some optional macroblock types (default: p8x8,b8x8,i8x8,i4x4).
10193 Enable types p16x8, p8x16, p8x8.
10195 Enable types p8x4, p4x8, p4x4.
10196 p4x4 is recommended only with subq >= 5, and only at low resolutions.
10198 Enable types b16x8, b8x16, b8x8.
10201 i8x8 has no effect unless 8x8dct is enabled.
10205 Enable all of the above types.
10207 Disable all of the above types.
10211 Regardless of this option, macroblock types p16x16, b16x16, and i16x16
10212 are always enabled.
10214 The idea is to find the type and size that best describe a certain area
10216 For example, a global pan is better represented by 16x16 blocks, while
10217 small moving objects are better represented by smaller blocks.
10222 Adaptive spatial transform size: allows macroblocks to choose between
10224 Also allows the i8x8 macroblock type.
10225 Without this option, only 4x4 DCT is used.
10229 Select fullpixel motion estimation algorithm.
10233 diamond search, radius 1 (fast)
10235 hexagon search, radius 2 (default)
10237 uneven multi-hexagon search (slow)
10239 exhaustive search (very slow, and no better than umh)
10244 .B me_range=<4\-64>
10245 radius of exhaustive or multi-hexagon motion search (default: 16)
10249 Adjust subpel refinement quality.
10250 This parameter controls quality versus speed tradeoffs involved in the motion
10251 estimation decision process.
10252 subq=5 can compress up to 10% better than subq=1.
10256 Runs fullpixel precision motion estimation on all candidate
10258 Then selects the best type with SAD metric (faster than subq=1, not recommended
10259 unless you're looking for ultra-fast encoding).
10261 Does as 0, then refines the motion of that type to fast quarterpixel precision
10264 Runs halfpixel precision motion estimation on all candidate macroblock types.
10265 Then selects the best type with SATD metric.
10266 Then refines the motion of that type to fast quarterpixel precision.
10268 As 2, but uses a slower quarterpixel refinement.
10270 Runs fast quarterpixel precision motion estimation on all candidate
10272 Then selects the best type with SATD metric.
10273 Then finishes the quarterpixel refinement for that type.
10275 Runs best quality quarterpixel precision motion estimation on all
10276 candidate macroblock types, before selecting the best type.
10277 Also refines the two motion vectors used in bidirectional macroblocks with
10278 SATD metric, rather than reusing vectors from the forward and backward
10281 Enables rate-distortion optimization of macroblock types in
10282 I- and P-frames (default).
10284 Enables rate-distortion optimization of macroblock types in all frames.
10286 Enables rate-distortion optimization of motion vectors and intra prediction modes in I- and P-frames.
10288 Enables rate-distortion optimization of motion vectors and intra prediction modes in all frames (best).
10292 In the above, "all candidates" does not exactly mean all enabled types:
10293 4x4, 4x8, 8x4 are tried only if 8x8 is better than 16x16.
10298 Takes into account chroma information during subpixel motion search
10299 (default: enabled).
10304 Allows each 8x8 or 16x8 motion partition to independently select a
10306 Without this option, a whole macroblock must use the same reference.
10307 Requires frameref>1.
10310 .B trellis=<0\-2> (cabac only)
10311 rate-distortion optimal quantization
10317 enabled only for the final encode
10319 enabled during all mode decisions (slow, requires subq>=6)
10324 .B psy-rd=rd[,trell]
10325 Sets the strength of the psychovisual optimization.
10328 .IPs rd=<0.0\-10.0>
10329 psy optimization strength (requires subq>=6) (default: 1.0)
10330 .IPs trell=<0.0\-10.0>
10331 trellis (requires trellis, experimental) (default: 0.0)
10337 .B deadzone_inter=<0\-32>
10338 Set the size of the inter luma quantization deadzone for non-trellis
10339 quantization (default: 21).
10340 Lower values help to preserve fine details and film grain (typically useful
10341 for high bitrate/quality encode), while higher values help filter out
10342 these details to save bits that can be spent again on other macroblocks
10343 and frames (typically useful for bitrate-starved encodes).
10344 It is recommended that you start by tweaking deadzone_intra before changing
10348 .B deadzone_intra=<0\-32>
10349 Set the size of the intra luma quantization deadzone for non-trellis
10350 quantization (default: 11).
10351 This option has the same effect as deadzone_inter except that it affects
10353 It is recommended that you start by tweaking this parameter before changing
10358 Performs early skip detection in P-frames (default: enabled).
10359 This usually improves speed at no cost, but it can sometimes produce
10360 artifacts in areas with no details, like sky.
10363 .B (no)dct_decimate
10364 Eliminate dct blocks in P-frames containing only a small single coefficient
10365 (default: enabled).
10366 This will remove some details, so it will save bits that can be spent
10367 again on other frames, hopefully raising overall subjective quality.
10368 If you are compressing non-anime content with a high target bitrate, you
10369 may want to disable this to preserve as much detail as possible.
10373 Noise reduction, 0 means disabled.
10374 100\-1000 is a useful range for typical content, but you may want to turn it
10375 up a bit more for very noisy content (default: 0).
10376 Given its small impact on speed, you might want to prefer to use this over
10377 filtering noise away with video filters like denoise3d or hqdn3d.
10380 .B chroma_qp_offset=<\-12\-12>
10381 Use a different quantizer for chroma as compared to luma.
10382 Useful values are in the range <\-2\-2> (default: 0).
10386 Defines how adaptive quantization (AQ) distributes bits:
10392 Avoid moving bits between frames.
10394 Move bits between frames (by default).
10399 .B aq_strength=<positive float value>
10400 Controls how much adaptive quantization (AQ) reduces blocking and blurring
10401 in flat and textured areas (default: 1.0).
10402 A value of 0.5 will lead to weak AQ and less details, when a value of 1.5
10403 will lead to strong AQ and more details.
10406 .B cqm=<flat|jvt|<filename>>
10407 Either uses a predefined custom quantization matrix or loads a JM format
10412 Use the predefined flat 16 matrix (default).
10414 Use the predefined JVT matrix.
10416 Use the provided JM format matrix file.
10421 Windows CMD.EXE users may experience problems with parsing the command line
10422 if they attempt to use all the CQM lists.
10423 This is due to a command line length limitation.
10424 In this case it is recommended the lists be put into a JM format CQM
10425 file and loaded as specified above.
10429 .B cqm4iy=<list> (also see cqm)
10430 Custom 4x4 intra luminance matrix, given as a list of 16 comma separated
10431 values in the 1\-255 range.
10434 .B cqm4ic=<list> (also see cqm)
10435 Custom 4x4 intra chrominance matrix, given as a list of 16 comma
10436 separated values in the 1\-255 range.
10439 .B cqm4py=<list> (also see cqm)
10440 Custom 4x4 inter luminance matrix, given as a list of 16 comma separated
10441 values in the 1\-255 range.
10444 .B cqm4pc=<list> (also see cqm)
10445 Custom 4x4 inter chrominance matrix, given as a list of 16 comma
10446 separated values in the 1\-255 range.
10449 .B cqm8iy=<list> (also see cqm)
10450 Custom 8x8 intra luminance matrix, given as a list of 64 comma separated
10451 values in the 1\-255 range.
10454 .B cqm8py=<list> (also see cqm)
10455 Custom 8x8 inter luminance matrix, given as a list of 64 comma separated
10456 values in the 1\-255 range.
10459 .B level_idc=<10\-51>
10460 Set the bitstream's level as defined by annex A of the H.264 standard
10461 (default: 51 \- level 5.1).
10462 This is used for telling the decoder what capabilities it needs to support.
10463 Use this parameter only if you know what it means,
10464 and you have a need to set it.
10468 Spawn threads to encode in parallel on multiple CPUs (default: 1).
10469 This has a slight penalty to compression quality.
10470 0 or 'auto' tells x264 to detect how many CPUs you have and pick an
10471 appropriate number of threads.
10474 .B (no)global_header
10475 Causes SPS and PPS to appear only once, at the beginning of the bitstream
10476 (default: disabled).
10477 Some players, such as the Sony PSP, require the use of this option.
10478 The default behavior causes SPS and PPS to repeat prior to each IDR frame.
10482 Treat the video content as interlaced.
10486 Adjust the amount of logging info printed to the screen.
10496 PSNR and other analysis statistics when the encode finishes (default)
10498 PSNR, QP, frametype, size, and other statistics for every frame
10504 Print signal-to-noise ratio statistics.
10507 The 'Y', 'U', 'V', and 'Avg' PSNR fields in the summary are not
10508 mathematically sound (they are simply the average of per-frame PSNRs).
10509 They are kept only for comparison to the JM reference codec.
10510 For all other purposes, please use either the 'Global' PSNR, or the per-frame
10511 PSNRs printed by log=3.
10515 Print the Structural Similarity Metric results.
10516 This is an alternative to PSNR, and may be better correlated with the
10517 perceived quality of the compressed video.
10521 Enable x264 visualizations during encoding.
10522 If the x264 on your system supports it, a new window will be opened during
10523 the encoding process, in which x264 will attempt to present an overview of
10524 how each frame gets encoded.
10525 Each block type on the visualized movie will be colored as follows:
10539 This feature can be considered experimental and subject to change.
10540 In particular, it depends on x264 being compiled with visualizations enabled.
10541 Note that as of writing this, x264 pauses after encoding and visualizing
10542 each frame, waiting for the user to press a key, at which point the next
10543 frame will be encoded.
10547 .SS xvfw (\-xvfwopts)
10549 Encoding with Video for Windows codecs is mostly obsolete unless you wish
10550 to encode to some obscure fringe codec.
10554 The name of the binary codec file with which to encode.
10558 The name of the codec settings file (like firstpass.mcf) created by vfw2menc.
10561 .SS MPEG muxer (\-mpegopts)
10563 The MPEG muxer can generate 5 types of streams, each of which has reasonable
10564 default parameters that the user can override.
10565 Generally, when generating MPEG files, it is advisable to disable
10566 MEncoder's frame-skip code (see \-noskip, \-mc as well as the
10567 harddup and softskip video filters).
10572 .IPs format=mpeg2:tsaf:vbitrate=8000
10577 .B format=<mpeg1 | mpeg2 | xvcd | xsvcd | dvd | pes1 | pes2>
10578 stream format (default: mpeg2).
10579 pes1 and pes2 are very broken formats (no pack header and no padding),
10580 but VDR uses them; do not choose them unless you know exactly what you
10584 .B size=<up to 65535>
10585 Pack size in bytes, do not change unless you know exactly what
10586 you are doing (default: 2048).
10590 Nominal muxrate in kbit/s used in the pack headers (default: 1800 kb/s).
10591 Will be updated as necessary in the case of 'format=mpeg1' or 'mpeg2'.
10595 Sets timestamps on all frames, if possible; recommended when format=dvd.
10596 If dvdauthor complains with a message like "..audio sector out of range...",
10597 you probably did not enable this option.
10601 Uses a better algorithm to interleave audio and video packets, based on the
10602 principle that the muxer will always try to fill the stream with the largest
10603 percentage of free space.
10606 .B vdelay=<1\-32760>
10607 Initial video delay time, in milliseconds (default: 0),
10608 use it if you want to delay video with respect to audio.
10609 It doesn't work with :drop.
10612 .B adelay=<1\-32760>
10613 Initial audio delay time, in milliseconds (default: 0),
10614 use it if you want to delay audio with respect to video.
10618 When used with vdelay the muxer drops the part of audio that was
10622 .B vwidth, vheight=<1\-4095>
10623 Set the video width and height when video is MPEG-1/2.
10626 .B vpswidth, vpsheight=<1\-4095>
10627 Set pan and scan video width and height when video is MPEG-2.
10630 .B vaspect=<1 | 4/3 | 16/9 | 221/100>
10631 Sets the display aspect ratio for MPEG-2 video.
10632 Do not use it on MPEG-1 or the resulting aspect ratio will be completely wrong.
10636 Sets the video bitrate in kbit/s for MPEG-1/2 video.
10639 .B vframerate=<24000/1001 | 24 | 25 | 30000/1001 | 30 | 50 | 60000/1001 | 60 >
10640 Sets the framerate for MPEG-1/2 video.
10641 This option will be ignored if used with the telecine option.
10645 Enables 3:2 pulldown soft telecine mode: The muxer will make the
10646 video stream look like it was encoded at 30000/1001 fps.
10647 It only works with MPEG-2 video when the output framerate is
10648 24000/1001 fps, convert it with \-ofps if necessary.
10649 Any other framerate is incompatible with this option.
10653 Enables FILM to PAL and NTSC to PAL soft telecine mode: The muxer
10654 will make the video stream look like it was encoded at 25 fps.
10655 It only works with MPEG-2 video when the output framerate is
10656 24000/1001 fps, convert it with \-ofps if necessary.
10657 Any other framerate is incompatible with this option.
10660 .B tele_src and tele_dest
10661 Enables arbitrary telecining using Donand Graft's DGPulldown code.
10662 You need to specify the original and the desired framerate; the
10663 muxer will make the video stream look like it was encoded at
10664 the desired framerate.
10665 It only works with MPEG-2 video when the input framerate is smaller
10666 than the output framerate and the framerate increase is <= 1.5.
10673 .IPs tele_src=25,tele_dest=30000/1001
10674 PAL to NTSC telecining
10679 .B vbuf_size=<40\-1194>
10680 Sets the size of the video decoder's buffer, expressed in kilobytes.
10681 Specify it only if the bitrate of the video stream is too high for
10682 the chosen format and if you know perfectly well what you are doing.
10683 A too high value may lead to an unplayable movie, depending on the player's
10685 When muxing HDTV video a value of 400 should suffice.
10688 .B abuf_size=<4\-64>
10689 Sets the size of the audio decoder's buffer, expressed in kilobytes.
10690 The same principle as for vbuf_size applies.
10693 .SS FFmpeg libavformat demuxers (\-lavfdopts)
10696 .B analyzeduration=<value>
10697 Maximum length in seconds to analyze the stream properties.
10701 Force a specific libavformat demuxer.
10704 .B o=<key>=<value>[,<key>=<value>[,...]]
10705 Pass AVOptions to libavformat demuxer.
10706 Note, a patch to make the o= unneeded and pass all unknown options through
10707 the AVOption system is welcome.
10708 A full list of AVOptions can be found in the FFmpeg manual.
10709 Note that some options may conflict with MPlayer/MEncoder options.
10721 .B probesize=<value>
10722 Maximum amount of data to probe during the detection phase.
10723 In the case of MPEG-TS this value identifies the maximum number
10724 of TS packets to scan.
10727 .B cryptokey=<hexstring>
10728 Encryption key the demuxer should use.
10729 This is the raw binary data of the key converted to a hexadecimal string.
10732 .SS FFmpeg libavformat muxers (\-lavfopts) (also see \-of lavf)
10736 Currently only meaningful for MPEG[12]: Maximum allowed distance,
10737 in seconds, between the reference timer of the output stream (SCR)
10738 and the decoding timestamp (DTS) for any stream present
10739 (demux to decode delay).
10740 Default is 0.7 (as mandated by the standards defined by MPEG).
10741 Higher values require larger buffers and must not be used.
10744 .B format=<container_format>
10745 Override which container format to mux into
10746 (default: autodetect from output file extension).
10750 MPEG-1 systems and MPEG-2 PS
10752 Advanced Streaming Format
10754 Audio Video Interleave file
10760 Macromedia Flash video files
10762 RealAudio and RealVideo
10766 NUT open container format (experimental)
10772 MPEG-4 format with extra header flags required by Apple iPod firmware
10774 Sony Digital Video container
10775 .IPs "matroska\ \ \ "
10781 Nominal bitrate of the multiplex, in bits per second;
10782 currently it is meaningful only for MPEG[12].
10783 Sometimes raising it is necessary in order to avoid "buffer underflows".
10786 .B o=<key>=<value>[,<key>=<value>[,...]]
10787 Pass AVOptions to libavformat muxer.
10788 Note, a patch to make the o= unneeded and pass all unknown options through
10789 the AVOption system is welcome.
10790 A full list of AVOptions can be found in the FFmpeg manual.
10791 Note that some options may conflict with MEncoder options.
10798 .IPs o=packetsize=100
10803 .B packetsize=<size>
10804 Size, expressed in bytes, of the unitary packet for the chosen format.
10805 When muxing to MPEG[12] implementations the default values are:
10806 2324 for [S]VCD, 2048 for all others formats.
10809 .B preload=<distance>
10810 Currently only meaningful for MPEG[12]: Initial distance,
10811 in seconds, between the reference timer of the output stream (SCR)
10812 and the decoding timestamp (DTS) for any stream present
10813 (demux to decode delay).
10817 .\" --------------------------------------------------------------------------
10818 .\" environment variables
10819 .\" --------------------------------------------------------------------------
10821 .SH ENVIRONMENT VARIABLES
10823 There are a number of environment variables that can be used to
10824 control the behavior of MPlayer and MEncoder.
10827 .B MPLAYER_CHARSET (also see \-msgcharset)
10828 Convert console messages to the specified charset (default: autodetect).
10829 A value of "noconv" means no conversion.
10833 Directory where MPlayer looks for user settings.
10836 .B MPLAYER_VERBOSE (also see \-v and \-msglevel)
10837 Set the initial verbosity level across all message modules (default: 0).
10838 The resulting verbosity corresponds to that of \-msglevel 5 plus the
10839 value of MPLAYER_VERBOSE.
10845 If LADSPA_PATH is set, it searches for the specified file.
10846 If it is not set, you must supply a fully specified pathname.
10847 FIXME: This is also mentioned in the ladspa section.
10853 Specify a directory in which to store title key values.
10854 This will speed up descrambling of DVDs which are in the cache.
10855 The DVDCSS_CACHE directory is created if it does not exist,
10856 and a subdirectory is created named after the DVD's title
10857 or manufacturing date.
10858 If DVDCSS_CACHE is not set or is empty, libdvdcss will use
10859 the default value which is "${HOME}/.dvdcss/" under Unix and
10860 "C:\\Documents and Settings\\$USER\\Application Data\\dvdcss\\" under Win32.
10861 The special value "off" disables caching.
10865 Sets the authentication and decryption method that
10866 libdvdcss will use to read scrambled discs.
10867 Can be one of title, key or disc.
10871 is the default method.
10872 libdvdcss will use a set of calculated player keys to try and get the disc key.
10873 This can fail if the drive does not recognize any of the player keys.
10875 is a fallback method when key has failed.
10876 Instead of using player keys, libdvdcss will crack the disc key using
10877 a brute force algorithm.
10878 This process is CPU intensive and requires 64 MB of memory to store
10881 is the fallback when all other methods have failed.
10882 It does not rely on a key exchange with the DVD drive, but rather uses
10883 a crypto attack to guess the title key.
10884 On rare cases this may fail because there is not enough encrypted data
10885 on the disc to perform a statistical attack, but in the other hand it
10886 is the only way to decrypt a DVD stored on a hard disc, or a DVD with
10887 the wrong region on an RPC2 drive.
10892 .B DVDCSS_RAW_DEVICE
10893 Specify the raw device to use.
10894 Exact usage will depend on your operating system, the Linux
10895 utility to set up raw devices is raw(8) for instance.
10896 Please note that on most operating systems, using a raw device
10897 requires highly aligned buffers: Linux requires a 2048 bytes
10898 alignment (which is the size of a DVD sector).
10902 Sets the libdvdcss verbosity level.
10906 Outputs no messages at all.
10908 Outputs error messages to stderr.
10910 Outputs error messages and debug messages to stderr.
10916 Skip retrieving all keys on startup.
10917 Currently disabled.
10921 FIXME: Document this.
10926 .B AO_SUN_DISABLE_SAMPLE_TIMING
10927 FIXME: Document this.
10931 FIXME: Document this.
10935 Specifies the Network Audio System server to which the
10936 nas audio output driver should connect and the transport
10937 that should be used.
10938 If unset DISPLAY is used instead.
10939 The transport can be one of tcp and unix.
10940 Syntax is tcp/<somehost>:<someport>, <somehost>:<instancenumber>
10941 or [unix]:<instancenumber>.
10942 The NAS base port is 8000 and <instancenumber> is added to that.
10949 .IPs AUDIOSERVER=somehost:0
10950 Connect to NAS server on somehost using default port and transport.
10951 .IPs AUDIOSERVER=tcp/somehost:8000
10952 Connect to NAS server on somehost listening on TCP port 8000.
10953 .IPs AUDIOSERVER=(unix)?:0
10954 Connect to NAS server instance 0 on localhost using unix domain sockets.
10960 FIXME: Document this.
10966 FIXME: Document this.
10970 Set this to 'disable' in order to stop the VIDIX driver from controlling
10971 alphablending settings.
10972 You can then manipulate it yourself with 'ivtvfbctl'.
10978 FIXME: Document this.
10984 FIXME: Document this.
10988 FIXME: Document this.
10992 FIXME: Document this.
10998 FIXME: Document this.
11002 FIXME: Document this.
11006 FIXME: Document this.
11010 FIXME: Document this.
11014 FIXME: Document this.
11020 FIXME: Document this.
11026 FIXME: Document this.
11030 FIXME: Document this.
11034 FIXME: Document this.
11040 FIXME: Document this.
11044 FIXME: Document this.
11048 FIXME: Document this.
11052 FIXME: Document this.
11056 FIXME: Document this.
11060 FIXME: Document this.
11064 .\" --------------------------------------------------------------------------
11066 .\" --------------------------------------------------------------------------
11071 /usr/\:local/\:etc/\:mplayer/\:mplayer.conf
11072 MPlayer system-wide settings
11075 /usr/\:local/\:etc/\:mplayer/\:mencoder.conf
11076 MEncoder system-wide settings
11079 ~/.mplayer/\:config
11080 MPlayer user settings
11083 ~/.mplayer/\:mencoder.conf
11084 MEncoder user settings
11087 ~/.mplayer/\:input.conf
11088 input bindings (see '\-input keylist' for the full list)
11092 font directory (There must be a font.desc file and files with .RAW extension.)
11095 ~/.mplayer/\:DVDkeys/
11099 Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
11102 /path/\:to/\:movie.sub
11104 ~/.mplayer/\:sub/\:movie.sub
11109 .\" --------------------------------------------------------------------------
11111 .\" --------------------------------------------------------------------------
11113 .SH EXAMPLES OF MPLAYER USAGE
11116 .B Quickstart DVD playing:
11122 .B Play in Japanese with English subtitles:
11124 mplayer dvd://1 \-alang ja \-slang en
11128 .B Play only chapters 5, 6, 7:
11130 mplayer dvd://1 \-chapter 5\-7
11134 .B Play only titles 5, 6, 7:
11140 .B Play a multiangle DVD:
11142 mplayer dvd://1 \-dvdangle 2
11146 .B Play from a different DVD device:
11148 mplayer dvd://1 \-dvd\-device /dev/\:dvd2
11152 .B Play DVD video from a directory with VOB files:
11154 mplayer dvd://1 \-dvd\-device /path/\:to/\:directory/
11158 .B Copy a DVD title to hard disk, saving to file "title1.vob":
11160 mplayer dvd://1 \-dumpstream \-dumpfile title1.vob
11164 .B Play a DVD with dvdnav from path /dev/sr1:
11166 mplayer dvdnav:////dev/sr1
11170 .B Stream from HTTP:
11172 mplayer http://mplayer.hq/example.avi
11176 .B Stream using RTSP:
11178 mplayer rtsp://server.example.com/streamName
11182 .B Convert subtitles to MPsub format:
11184 mplayer dummy.avi \-sub source.sub \-dumpmpsub
11188 .B Convert subtitles to MPsub format without watching the movie:
11190 mplayer /dev/\:zero \-rawvideo pal:fps=xx \-demuxer rawvideo \-vc null \-vo null \-noframedrop \-benchmark \-sub source.sub \-dumpmpsub
11194 .B input from standard V4L:
11196 mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420 \-vo xv
11200 .B Playback on Zoran cards (old style, deprecated):
11202 mplayer \-vo zr \-vf scale=352:288 file.avi
11206 .B Playback on Zoran cards (new style):
11208 mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
11212 .B Play DTS-CD with passthrough:
11214 mplayer \-ac hwdts \-rawaudio format=0x2001 \-cdrom\-device /dev/cdrom cdda://
11217 You can also use \-afm hwac3 instead of \-ac hwdts.
11218 Adjust '/dev/cdrom' to match the CD-ROM device on your system.
11219 If your external receiver supports decoding raw DTS streams,
11220 you can directly play it via cdda:// without setting format, hwac3 or hwdts.
11223 .B Play a 6-channel AAC file with only two speakers:
11225 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
11228 You might want to play a bit with the pan values (e.g multiply with a value) to
11229 increase volume or avoid clipping.
11232 .B checkerboard invert with geq filter:
11234 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'
11238 .SH EXAMPLES OF MENCODER USAGE
11241 .B Encode DVD title #2, only selected chapters:
11243 mencoder dvd://2 \-chapter 10\-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11247 .B Encode DVD title #2, resizing to 640x480:
11249 mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11253 .B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
11255 mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
11259 .B The same, but with bitrate set to 1800kbit and optimized macroblocks:
11261 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
11265 .B The same, but with MJPEG compression:
11267 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800
11271 .B Encode all *.jpg files in the current directory:
11273 mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
11277 .B Encode from a tuner (specify a format with \-vf format):
11279 mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
11283 .B Encode from a pipe:
11285 rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
11289 .\" --------------------------------------------------------------------------
11290 .\" Bugs, authors, standard disclaimer
11291 .\" --------------------------------------------------------------------------
11295 If you find one, report it to us, but please make sure you have read all
11296 of the documentation first.
11297 Also look out for smileys. :)
11298 Many bugs are the result of incorrect setup or parameter usage.
11299 The bug reporting section of the documentation
11300 (http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:bugreports.html)
11301 explains how to create useful bug reports.
11306 MPlayer was initially written by Arpad Gereoffy.
11307 See the AUTHORS file for a list of some of the many other contributors.
11309 MPlayer is (C) 2000\-2009 The MPlayer Team
11311 This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
11312 It is maintained by Diego Biurrun.
11313 Please send mails about it to the MPlayer-DOCS mailing list.
11314 Translation specific mails belong on the MPlayer-translations mailing list.