when {v|a}_o_mpegpes:card isn't specified by the user mplayer uses the first availabl...
[mplayer/greg.git] / DOCS / man / en / mplayer.1
blob37a288858644fc99890deef45734b922cdc922b0
1 .\" $Revision$
2 .\" MPlayer (C) 2000-2008 MPlayer Team
3 .\" This man page was/is done by Gabucino, Diego Biurrun, Jonas Jermann
5 .\" --------------------------------------------------------------------------
6 .\" Macro definitions
7 .\" --------------------------------------------------------------------------
9 .\" define indentation for suboptions
10 .nr SS 5
11 .\" add new suboption
12 .de IPs
13 .IP "\\$1" \n(SS
15 .\" begin of first level suboptions, end with .RE
16 .de RSs
17 .RS 10
19 .\" begin of 2nd level suboptions
20 .de RSss
21 .PD 0
22 .RS \n(SS+3
24 .\" end of 2nd level suboptions
25 .de REss
26 .RE
27 .PD 1
30 .\" --------------------------------------------------------------------------
31 .\" Title
32 .\" --------------------------------------------------------------------------
34 .TH MPlayer 1 "2008-01-01" "The MPlayer Project" "The Movie Player"
36 .SH NAME
37 mplayer  \- movie player
38 .br
39 mencoder \- movie encoder
41 .\" --------------------------------------------------------------------------
42 .\" Synopsis
43 .\" --------------------------------------------------------------------------
45 .SH SYNOPSIS
46 .na
47 .nh
48 .B mplayer
49 [options] [file|URL|playlist|\-]
51 .br
52 .B mplayer
53 [options] file1
54 [specific options] [file2] [specific options]
56 .br
57 .B mplayer
58 [options]
59 {group of files and options}
60 [group-specific options]
62 .br
63 .B mplayer
64 [dvd|dvdnav]://[title|[start_title]\-end_title]
65 [options]
67 .br
68 .B mplayer
69 vcd://track[/device]
71 .br
72 .B mplayer
73 tv://[channel][/input_id]
74 [options]
76 .br
77 .B mplayer
78 radio://[channel|frequency][/capture]
79 [options]
81 .br
82 .B mplayer
83 pvr://
84 [options]
86 .br
87 .B mplayer
88 dvb://[card_number@]channel
89 [options]
91 .br
92 .B mplayer
93 mf://[filemask|@listfile]
94 [\-mf options] [options]
96 .br
97 .B mplayer
98 [cdda|cddb]://track[\-endtrack][:speed][/device]
99 [options]
102 .B mplayer
103 cue://file[:track]
104 [options]
107 .B mplayer
108 [file|mms[t]|http|http_proxy|rt[s]p|ftp|udp|unsv|smb]://
109 [user:pass@]URL[:port] [options]
112 .B mplayer
113 sdp://file
114 [options]
117 .B mplayer
118 mpst://host[:port]/URL
119 [options]
122 .B mplayer
123 tivo://host/[list|llist|fsid]
124 [options]
127 .B gmplayer
128 [options]
129 [\-skin\ skin]
132 .B mencoder
133 [options] file
134 [file|URL|\-] [\-o file | file://file | smb://[user:pass@]host/filepath]
137 .B mencoder
138 [options] file1
139 [specific options] [file2] [specific options]
143 .\" --------------------------------------------------------------------------
144 .\" Description
145 .\" --------------------------------------------------------------------------
147 .SH DESCRIPTION
148 .B mplayer
149 is a movie player for Linux (runs on many other platforms and CPU
150 architectures, see the documentation).
151 It plays most MPEG/\:VOB, AVI, ASF/\:WMA/\:WMV, RM, QT/\:MOV/\:MP4, Ogg/\:OGM,
152 MKV, VIVO, FLI, NuppelVideo, yuv4mpeg, FILM and RoQ files, supported by many
153 native and binary codecs.
154 You can watch Video CD, SVCD, DVD, 3ivx, DivX 3/4/5 and even WMV movies,
155 too.
157 MPlayer supports a wide range of video and audio output drivers.
158 It works with X11, Xv, DGA, OpenGL, SVGAlib, fbdev, AAlib, libcaca, DirectFB,
159 Quartz, Mac OS X CoreVideo, but you can also use GGI, SDL (and all their drivers),
160 VESA (on every VESA-compatible card, even without X11), some low-level
161 card-specific drivers (for Matrox, 3dfx and ATI) and some hardware MPEG decoder
162 boards, such as the Siemens DVB, Hauppauge PVR (IVTV), DXR2 and DXR3/\:Hollywood+.
163 Most of them support software or hardware scaling, so you can enjoy movies in
164 fullscreen mode.
166 MPlayer has an onscreen display (OSD) for status information, nice big
167 antialiased shaded subtitles and visual feedback for keyboard controls.
168 European/\:ISO8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean
169 fonts are supported along with 12 subtitle formats (MicroDVD, SubRip, OGM,
170 SubViewer, Sami, VPlayer, RT, SSA, AQTitle, JACOsub, PJS and our own: MPsub) and
171 DVD subtitles (SPU streams, VOBsub and Closed Captions).
173 .B mencoder
174 (MPlayer's Movie Encoder) is a simple movie encoder, designed to encode
175 MPlayer-playable movies (see above) to other MPlayer-playable formats (see
176 below).
177 It encodes to MPEG-4 (DivX/Xvid), one of the libavcodec codecs and
178 PCM/\:MP3/\:VBRMP3 audio in 1, 2 or 3 passes.
179 Furthermore it has stream copying abilities, a powerful filter system (crop,
180 expand, flip, postprocess, rotate, scale, noise, RGB/\:YUV conversion) and
181 more.
183 .B gmplayer
184 is MPlayer with a graphical user interface.
185 It has the same options as MPlayer.
187 Usage examples to get you started quickly can be found at the end
188 of this man page.
190 .B Also see the HTML documentation!
193 .\" --------------------------------------------------------------------------
194 .\" interactive control
195 .\" --------------------------------------------------------------------------
197 .SH "INTERACTIVE CONTROL"
198 MPlayer has a fully configurable, command-driven control layer
199 which allows you to control MPlayer using keyboard, mouse, joystick
200 or remote control (with LIRC).
201 See the \-input option for ways to customize it.
204 .B keyboard control
205 .PD 0
207 .IPs "<\- and \->"
208 Seek backward/\:forward 10 seconds.
209 .IPs "up and down"
210 Seek forward/\:backward 1 minute.
211 .IPs "pgup and pgdown"
212 Seek forward/\:backward 10 minutes.
213 .IPs "[ and ]"
214 Decrease/increase current playback speed by 10%.
215 .IPs "{ and }"
216 Halve/double current playback speed.
217 .IPs "backspace"
218 Reset playback speed to normal.
219 .IPs "< and >"
220 Go backward/\:forward in the playlist.
221 .IPs "ENTER"
222 Go forward in the playlist, even over the end.
223 .IPs "HOME and END"
224 next/\:previous playtree entry in the parent list
225 .IPs "INS and DEL (ASX playlist only)"
226 next/\:previous alternative source.
227 .IPs "p / SPACE"
228 Pause (pressing again unpauses).
229 .IPs ".\ \ \ \ "
230 Step forward.
231 Pressing once will pause movie, every consecutive press will play one frame
232 and then go into pause mode again (any other key unpauses).
233 .IPs "q / ESC"
234 Stop playing and quit.
235 .IPs "+ and \-"
236 Adjust audio delay by +/\- 0.1 seconds.
237 .IPs "/ and *"
238 Decrease/\:increase volume.
239 .IPs "9 and 0"
240 Decrease/\:increase volume.
241 .IPs "( and )"
242 Adjust audio balance in favor of left/\:right channel.
243 .IPs "m\ \ \ \ "
244 Mute sound.
245 .IPs "_ (MPEG-TS, AVI and libavformat only)"
246 Cycle through the available video tracks.
247 .IPs "# (DVD, MPEG, Matroska, AVI and libavformat only)"
248 Cycle through the available audio tracks.
249 .IPs "TAB (MPEG-TS and libavformat only)"
250 Cycle through the available programs.
251 .IPs "f\ \ \ \ "
252 Toggle fullscreen (also see \-fs).
253 .IPs "T\ \ \ \ "
254 Toggle stay-on-top (also see \-ontop).
255 .IPs "w and e"
256 Decrease/\:increase pan-and-scan range.
257 .IPs "o\ \ \ \ "
258 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
259 .IPs "d\ \ \ \ "
260 Toggle frame dropping states: none / skip display / skip decoding
261 (see \-framedrop and \-hardframedrop).
262 .IPs "v\ \ \ \ "
263 Toggle subtitle visibility.
264 .IPs "j\ \ \ \ "
265 Cycle through the available subtitles.
266 .IPs "y and g"
267 Step forward/backward in the subtitle list.
268 .IPs "F\ \ \ \ "
269 Toggle displaying "forced subtitles".
270 .IPs "a\ \ \ \ "
271 Toggle subtitle alignment: top / middle / bottom.
272 .IPs "x and z"
273 Adjust subtitle delay by +/\- 0.1 seconds.
274 .IPs "r and t"
275 Move subtitles up/down.
276 .IPs "i (\-edlout mode only)"
277 Set start or end of an EDL skip and write it out to the given file.
278 .IPs "s (\-vf screenshot only)"
279 Take a screenshot.
280 .IPs "S (\-vf screenshot only)"
281 Start/stop taking screenshots.
282 .IPs "I\ \ \ \ "
283 Show filename on the OSD.
284 .IPs "! and @"
285 Seek to the beginning of the previous/next chapter.
286 .IPs "D (\-vo xvmc, \-vf yadif, \-vf kerndeint only)"
287 Activate/deactivate deinterlacer.
289 .PD 1
292 (The following keys are valid only when using a hardware accelerated video
293 output (xv, (x)vidix, (x)mga, etc), the software equalizer
294 (\-vf eq or \-vf eq2) or hue filter (\-vf hue).)
297 .PD 0
299 .IPs "1 and 2"
300 Adjust contrast.
301 .IPs "3 and 4"
302 Adjust brightness.
303 .IPs "5 and 6"
304 Adjust hue.
305 .IPs "7 and 8"
306 Adjust saturation.
308 .PD 1
311 (The following keys are valid only when using the quartz or macosx
312 video output driver.)
315 .PD 0
317 .IPs "command + 0"
318 Resize movie window to half its original size.
319 .IPs "command + 1"
320 Resize movie window to its original size.
321 .IPs "command + 2"
322 Resize movie window to double its original size.
323 .IPs "command + f"
324 Toggle fullscreen (also see \-fs).
325 .IPs "command + [ and command + ]"
326 Set movie window alpha.
328 .PD 1
331 (The following keys are valid only when using the sdl
332 video output driver.)
335 .PD 0
337 .IPs "c\ \ \ \ "
338 Cycle through available fullscreen modes.
339 .IPs "n\ \ \ \ "
340 Restore original mode.
342 .PD 1
345 (The following keys are valid if you have a keyboard
346 with multimedia keys.)
349 .PD 0
351 .IPs PAUSE
352 Pause.
353 .IPs "STOP\ "
354 Stop playing and quit.
355 .IPs "PREVIOUS and NEXT"
356 Seek backward/\:forward 1 minute.
358 .PD 1
361 (The following keys are only valid if GUI support is compiled in
362 and will take precedence over the keys defined above.)
365 .PD 0
367 .IPs ENTER
368 Start playing.
369 .IPs "ESC\ \ "
370 Stop playing.
371 .IPs "l\ \ \ \ "
372 Load file.
373 .IPs "t\ \ \ \ "
374 Load subtitle.
375 .IPs "c\ \ \ \ "
376 Open skin browser.
377 .IPs "p\ \ \ \ "
378 Open playlist.
379 .IPs "r\ \ \ \ "
380 Open preferences.
382 .PD 1
385 (The following keys are only valid if you compiled with TV or DVB input
386 support and will take precedence over the keys defined above.)
389 .PD 0
391 .IPs "h and k"
392 Select previous/\:next channel.
393 .IPs "n\ \ \ \ "
394 Change norm.
395 .IPs "u\ \ \ \ "
396 Change channel list.
398 .PD 1
401 (The following keys are only valid if you compiled with dvdnav
402 support: They are used to navigate the menus.)
405 .PD 0
407 .IPs "keypad 8"
408 Select button up.
409 .IPs "keypad 2"
410 Select button down.
411 .IPs "keypad 4"
412 Select button left.
413 .IPs "keypad 6"
414 Select button right.
415 .IPs "keypad 5"
416 Return to main menu.
417 .IPs "keypad 7"
418 Return to nearest menu (the order of preference is: chapter->title->root).
419 .IPs "keypad ENTER"
420 Confirm choice.
422 .PD 1
426 (The following keys are only valid if teletext support is enabled during
427 compilation: They are used for controlling TV teletext.)
430 .PD 0
432 .IPs "X\ \ \ \ "
433 Switch teletext on/\:off.
434 .IPs "Q and W"
435 Go to next/\:prev teletext page.
437 .PD 1
442 .B mouse control
443 .PD 0
445 .IPs "button 3 and button 4"
446 Seek backward/\:forward 1 minute.
447 .IPs "button 5 and button 6"
448 Decrease/\:increase volume.
450 .PD 1
453 .B joystick control
454 .PD 0
456 .IPs "left and right"
457 Seek backward/\:forward 10 seconds.
458 .IPs "up and down"
459 Seek forward/\:backward 1 minute.
460 .IPs "button 1"
461 Pause.
462 .IPs "button 2"
463 Toggle OSD states: none / seek / seek + timer / seek + timer + total time.
464 .IPs "button 3 and button 4"
465 Decrease/\:increase volume.
467 .PD 1
470 .\" --------------------------------------------------------------------------
471 .\" Usage
472 .\" --------------------------------------------------------------------------
474 .SH "USAGE"
475 Every 'flag' option has a 'noflag' counterpart, e.g.\& the opposite of the
476 \-fs option is \-nofs.
478 If an option is marked as (XXX only), it will only work in combination with
479 the XXX option or if XXX is compiled in.
481 .I NOTE:
482 The suboption parser (used for example for \-ao pcm suboptions) supports
483 a special kind of string-escaping intended for use with external GUIs.
485 It has the following format:
487 %n%string_of_length_n
489 .I EXAMPLES:
491 mplayer \-ao pcm:file=%10%C:test.wav test.avi
493 Or in a script:
495 mplayer \-ao pcm:file=%`expr length "$NAME"`%"$NAME" test.avi
498 .\" --------------------------------------------------------------------------
499 .\" Configuration files
500 .\" --------------------------------------------------------------------------
502 .SH "CONFIGURATION FILES"
503 You can put all of the options in configuration files which will be read
504 every time MPlayer/MEncoder is run.
505 The system-wide configuration file 'mplayer.conf' is in your configuration
506 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the user
507 specific one is '~/\:.mplayer/\:config'.
508 The configuration file for MEncoder is 'mencoder.conf' in your configuration
509 directory (e.g.\& /etc/\:mplayer or /usr/\:local/\:etc/\:mplayer), the
510 user specific one is '~/\:.mplayer/\:mencoder.conf.
511 User specific options override system-wide options and options given on the
512 command line override either.
513 The syntax of the configuration files is 'option=<value>', everything after
514 a '#' is considered a comment.
515 Options that work without values can be enabled by setting them to 'yes'
516 or '1' or 'true' and disabled by setting them to 'no' or '0' or 'false'.
517 Even suboptions can be specified in this way.
519 You can also write file-specific configuration files.
520 If you wish to have a configuration file for a file called 'movie.avi', create a file
521 named 'movie.avi.conf' with the file-specific options in it and put it in
522 ~/.mplayer/.
523 You can also put the configuration file in the same directory as the file to
524 be played, as long as you give the \-use\-filedir\-conf option (either on the
525 command line or in your global config file).
527 .I EXAMPLE MPLAYER CONFIGURATION FILE:
528 .sp 1
530 # Use Matrox driver by default.
531 vo=xmga
532 # I love practicing handstands while watching videos.
533 flip=yes
534 # Decode/encode multiple files from PNG,
535 # start with mf://filemask
536 mf=type=png:fps=25
537 # Eerie negative images are cool.
538 vf=eq2=1.0:\-0.8
541 .I "EXAMPLE MENCODER CONFIGURATION FILE:"
542 .sp 1
544 # Make MEncoder output to a default filename.
545 o=encoded.avi
546 # The next 4 lines allow mencoder tv:// to start capturing immediately.
547 oac=pcm=yes
548 ovc=lavc=yes
549 lavcopts=vcodec=mjpeg
550 tv=driver=v4l2:input=1:width=768:height=576:device=/dev/video0:audiorate=48000
551 # more complex default encoding option set
552 lavcopts=vcodec=mpeg4:autoaspect=1
553 lameopts=aq=2:vbr=4
554 ovc=lavc=1
555 oac=lavc=1
556 passlogfile=pass1stats.log
557 noautoexpand=1
558 subfont-autoscale=3
559 subfont-osd-scale=6
560 subfont-text-scale=4
561 subalign=2
562 subpos=96
563 spuaa=20
566 .\" --------------------------------------------------------------------------
567 .\" Profiles
568 .\" --------------------------------------------------------------------------
570 .SH "PROFILES"
571 To ease working with different configurations profiles can be defined in the
572 configuration files.
573 A profile starts with its name between square brackets, e.g.\& '[my-profile]'.
574 All following options will be part of the profile.
575 A description (shown by \-profile help) can be defined with the profile-desc
576 option.
577 To end the profile, start another one or use the profile name 'default'
578 to continue with normal options.
581 .I "EXAMPLE MENCODER PROFILE:"
582 .sp 1
585 [mpeg4]
586 profile-desc="MPEG4 encoding"
587 ovc=lacv=yes
588 lavcopts=vcodec=mpeg4:vbitrate=1200
590 [mpeg4\-hq]
591 profile-desc="HQ MPEG4 encoding"
592 profile=mpeg4
593 lavcopts=mbd=2:trell=yes:v4mv=yes
596 .\" --------------------------------------------------------------------------
597 .\" Options
598 .\" --------------------------------------------------------------------------
600 .SH "GENERAL OPTIONS"
603 .B \-codecs\-file <filename> (also see \-afm, \-ac, \-vfm, \-vc)
604 Override the standard search path and use the specified file
605 instead of the builtin codecs.conf.
608 .B \-include <configuration file>
609 Specify configuration file to be parsed after the default ones.
612 .B \-list\-options
613 Prints all available options.
616 .B \-msgcharset <charset>
617 Convert console messages to the specified character set (default: autodetect).
618 Text will be in the encoding specified with the \-\-charset configure option.
619 Set this to "noconv" to disable conversion (for e.g.\& iconv problems).
621 .I NOTE:
622 The option takes effect after command line parsing has finished.
623 The MPLAYER_CHARSET environment variable can help you get rid of
624 the first lines of garbled output.
627 .B \-msglevel <all=<level>:<module>=<level>:...>
628 Control verbosity directly for each module.
629 The 'all' module changes the verbosity of all the modules not
630 explicitly specified on the command line.
631 See '\-msglevel help' for a list of all modules.
633 .I NOTE:
634 Some messages are printed before the command line is parsed and are
635 therefore not affected by \-msglevel.
636 To control these messages you have to use the MPLAYER_VERBOSE environment
637 variable, see its description below for details.
639 Available levels:
640 .PD 0
641 .RSs
642 .IPs "\-1"
643 complete silence
644 .IPs " 0"
645 fatal messages only
646 .IPs " 1"
647 error messages
648 .IPs " 2"
649 warning messages
650 .IPs " 3"
651 short hints
652 .IPs " 4"
653 informational messages
654 .IPs " 5"
655 status messages (default)
656 .IPs " 6"
657 verbose messages
658 .IPs " 7"
659 debug level 2
660 .IPs " 8"
661 debug level 3
662 .IPs " 9"
663 debug level 4
665 .PD 1
668 .B "\-quiet\ "
669 Make console output less verbose; in particular, prevents the status line
670 (i.e.\& A:   0.7 V:   0.6 A-V:  0.068 ...) from being displayed.
671 Particularly useful on slow terminals or broken ones which do not properly
672 handle carriage return (i.e.\& \\r).
675 .B \-priority <prio> (Windows only)
676 Set process priority for MPlayer according to the predefined
677 priorities available under Windows.
678 Possible values of <prio>:
679 .RSs
680 idle|belownormal|normal|abovenormal|high|realtime
682 .sp 1
684 .I WARNING:
685 Using realtime priority can cause system lockup.
689 .B \-profile <profile1,profile2,...>
690 Use the given profile(s), \-profile help displays a list of the defined profiles.
693 .B \-really\-quiet (also see \-quiet)
694 Display even less output and status messages than with \-quiet.
695 Also suppresses the GUI error message boxes.
698 .B \-show\-profile <profile>
699 Show the description and content of a profile.
702 .B \-use\-filedir\-conf
703 Look for a file-specific configuration file in the same directory as
704 the file that is being played.
706 .I WARNING:
707 May be dangerous if playing from untrusted media.
710 .B "\-v\ \ \ \ \ "
711 Increment verbosity level, one level for each \-v
712 found on the command line.
716 .SH "PLAYER OPTIONS (MPLAYER ONLY)"
719 .B \-autoq <quality> (use with \-vf [s]pp)
720 Dynamically changes the level of postprocessing depending on the available spare
721 CPU time.
722 The number you specify will be the maximum level used.
723 Usually you can use some big number.
724 You have to use \-vf [s]pp without parameters in order for this to work.
727 .B \-autosync <factor>
728 Gradually adjusts the A/V sync based on audio delay measurements.
729 Specifying \-autosync 0, the default, will cause frame timing to be based
730 entirely on audio delay measurements.
731 Specifying \-autosync 1 will do the same, but will subtly change the A/V
732 correction algorithm.
733 An uneven video framerate in a movie which plays fine with \-nosound can
734 often be helped by setting this to an integer value greater than 1.
735 The higher the value, the closer the timing will be to \-nosound.
736 Try \-autosync 30 to smooth out problems with sound drivers which do
737 not implement a perfect audio delay measurement.
738 With this value, if large A/V sync offsets occur, they will only take about
739 1 or 2 seconds to settle out.
740 This delay in reaction time to sudden A/V offsets should be the only
741 side-effect of turning this option on, for all sound drivers.
744 .B \-benchmark
745 Prints some statistics on CPU usage and dropped frames at the end of playback.
746 Use in combination with \-nosound and \-vo null for benchmarking only the
747 video codec.
749 .I NOTE:
750 With this option MPlayer will also ignore frame duration when playing
751 only video (you can think of that as infinite fps).
754 .B \-colorkey <number>
755 Changes the colorkey to an RGB value of your choice.
756 0x000000 is black and 0xffffff is white.
757 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
758 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
759 drivers.
762 .B \-nocolorkey
763 Disables colorkeying.
764 Only supported by the cvidix, fbdev, svga, vesa, winvidix, xmga, xvidix,
765 xover, xv (see \-vo xv:ck), xvmc (see \-vo xv:ck) and directx video output
766 drivers.
769 .B \-correct\-pts (experimental)
770 Switches MPlayer to an experimental mode where timestamps for video frames
771 are calculated differently and video filters which add new frames or
772 modify timestamps of existing ones are supported.
773 The more accurate timestamps can be visible for example when playing
774 subtitles timed to scene changes with the \-ass option.
775 Without \-correct\-pts the subtitle timing will typically be off by some frames.
776 This option does not work correctly with some demuxers and codecs.
779 .B \-crash\-debug (DEBUG CODE)
780 Automatically attaches gdb upon crash or SIGTRAP.
781 Support must be compiled in by configuring with \-\-enable\-crash\-debug.
784 .B \-doubleclick\-time
785 Time in milliseconds to recognize two consecutive button presses as
786 a double-click (default: 300).
787 Set to 0 to let your windowing system decide what a double-click is
788 (\-vo directx only).
790 .I NOTE:
791 You will get slightly different behaviour depending on whether you bind
792 MOUSE_BTN0_DBL or MOUSE_BTN0\-MOUSE_BTN0_DBL.
795 .B \-edlout <filename>
796 Creates a new file and writes edit decision list (EDL) records to it.
797 During playback, the user hits 'i' to mark the start or end of a skip block.
798 This provides a starting point from which the user can fine-tune EDL entries
799 later.
800 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details.
803 .B \-enqueue (GUI only)
804 Enqueue files given on the command line in the playlist instead of playing them
805 immediately.
808 .B \-fixed\-vo
809 Enforces a fixed video system for multiple files (one (un)initialization for
810 all files).
811 Therefore only one window will be opened for all files.
812 Currently the following drivers are fixed-vo compliant: gl, gl2, mga, svga, x11,
813 xmga, xv, xvidix and dfbmga.
816 .B \-framedrop (also see \-hardframedrop)
817 Skip displaying some frames to maintain A/V sync on slow systems.
818 Video filters are not applied to such frames.
819 For B-frames even decoding is skipped completely.
822 .B \-(no)gui
823 Enable or disable the GUI interface (default depends on binary name).
824 Only works as the first argument on the command line.
825 Does not work as a config-file option.
828 .B \-h, \-help, \-\-help
829 Show short summary of options.
832 .B \-hardframedrop
833 More intense frame dropping (breaks decoding).
834 Leads to image distortion!
837 .B \-identify
838 Shorthand for \-msglevel identify=4.
839 Show file parameters in an easily parseable format.
840 Also prints more detailed information about subtitle and audio
841 track languages and IDs.
842 In some cases you can get more information by using \-msglevel identify=6.
843 For example, for a DVD it will list the chapters and time length of each title,
844 as well as a disk ID.
845 The wrapper script TOOLS/\:midentify suppresses the other MPlayer output and
846 (hopefully) shellescapes the filenames.
849 .B \-idle (also see \-slave)
850 Makes MPlayer wait idly instead of quitting when there is no file to play.
851 Mostly useful in slave mode where MPlayer can be controlled
852 through input commands.
855 .B \-input <commands>
856 This option can be used to configure certain parts of the input system.
857 Paths are relative to ~/.mplayer/.
859 .I NOTE:
860 Autorepeat is currently only supported by joysticks.
861 .sp 1
862 Available commands are:
863 .sp 1
864 .PD 0
865 .RSs
866 .IPs conf=<filename>
867 Specify input configuration file other than the default
868 ~/\:.mplayer/\:input.conf.
869 ~/\:.mplayer/\:<filename> is assumed if no full path is given.
870 .IPs ar-delay
871 Delay in milliseconds before we start to autorepeat a key (0 to disable).
872 .IPs ar-rate
873 Number of key presses to generate per second on autorepeat.
874 .IPs keylist
875 Prints all keys that can be bound to commands.
876 .IPs cmdlist
877 Prints all commands that can be bound to keys.
878 .IPs js-dev
879 Specifies the joystick device to use (default: /dev/\:input/\:js0).
880 .IPs file=<filename>
881 Read commands from the given file.
882 Mostly useful with a FIFO.
884 .I NOTE:
885 When the given file is a FIFO MPlayer opens both ends so you can do
886 several 'echo "seek 10" > mp_pipe' and the pipe will stay valid.
888 .PD 1
891 .B \-key\-fifo\-size <2\-65000>
892 Specify the size of the FIFO that buffers key events (default: 7).
893 A FIFO of size n can buffer (n\-1) events.
894 If it is too small some events may be lost
895 (leading to "stuck mouse buttons" and similar effects).
896 If it is too big, MPlayer may seem to hang while it
897 processes the buffered events.
898 To get the same behavior as before this option was introduced,
899 set it to 2 for Linux or 1024 for Windows.
902 .B \-lircconf <filename> (LIRC only)
903 Specifies a configuration file for LIRC (default: ~/.lircrc).
906 .B \-list\-properties
907 Print a list of the available properties.
910 .B \-loop <number>
911 Loops movie playback <number> times.
912 0 means forever.
915 .B \-menu (OSD menu only)
916 Turn on OSD menu support.
919 .B \-menu\-cfg <filename> (OSD menu only)
920 Use an alternative menu.conf.
923 .B \-menu\-chroot <path> (OSD menu only)
924 Chroot the file selection menu to a specific location.
925 .sp 1
926 .I EXAMPLE:
927 .PD 0
928 .RSs
929 .IPs "\-menu\-chroot /home"
930 Will restrict the file selection menu to /\:home and downward (i.e.\& no
931 access to / will be possible, but /home/user_name will).
933 .PD 1
936 .B \-menu\-keepdir (OSD menu only)
937 File browser starts from the last known location instead of current directory.
940 .B \-menu\-root <value> (OSD menu only)
941 Specify the main menu.
944 .B \-menu\-startup (OSD menu only)
945 Display the main menu at MPlayer startup.
948 .B \-mouse\-movements
949 Permit MPlayer to receive pointer events reported by the video
950 output driver (currently only derivatives of X11 are supported).
951 Necessary to select the buttons in DVD menus.
954 .B \-noconsolecontrols
955 Prevent MPlayer from reading key events from standard input.
956 Useful when reading data from standard input.
957 This is automatically enabled when \- is found on the command line.
958 There are situations where you have to set it manually, e.g.\&
959 if you open /dev/\:stdin (or the equivalent on your system), use stdin
960 in a playlist or intend to read from stdin later on via the loadfile or
961 loadlist slave commands.
964 .B \-nojoystick
965 Turns off joystick support.
968 .B \-nolirc
969 Turns off LIRC support.
972 .B \-nomouseinput
973 Disable mouse button press/\:release input (mozplayerxp's context menu relies
974 on this option).
977 .B \-rtc (RTC only)
978 Turns on usage of the Linux RTC (realtime clock \- /dev/\:rtc) as timing
979 mechanism.
980 This wakes up the process every 1/1024 seconds to check the current time.
981 Useless with modern Linux kernels configured for desktop use as they already
982 wake up the process with similar accuracy when using normal timed sleep.
985 .B \-playing\-msg <string>
986 Print out a string before starting playback.
987 The following expansions are supported:
988 .RSs
989 .IPs ${NAME}
990 Expand to the value of the property NAME.
991 .IPs ?(NAME:TEXT)
992 Expand TEXT only if the property NAME is available.
993 .IPs ?(!NAME:TEXT)
994 Expand TEXT only if the property NAME is not available.
998 .B \-playlist <filename>
999 Play files according to a playlist file (ASX, Winamp, SMIL, or
1000 one-file-per-line format).
1002 .I NOTE:
1003 This option is considered an entry so options found after it will apply
1004 only to the elements of this playlist.
1006 FIXME: This needs to be clarified and documented thoroughly.
1009 .B \-rtc\-device <device>
1010 Use the specified device for RTC timing.
1013 .B \-shuffle
1014 Play files in random order.
1017 .B \-skin <name> (GUI only)
1018 Loads a skin from the directory given as parameter below the default skin
1019 directories, /usr/\:local/\:share/\:mplayer/\:skins/\: and ~/.mplayer/\:skins/.
1020 .sp 1
1021 .I EXAMPLE:
1022 .PD 0
1023 .RSs
1024 .IPs "\-skin fittyfene"
1025 Tries /usr/\:local/\:share/\:mplayer/\:skins/\:fittyfene
1026 and afterwards ~/.mplayer/\:skins/\:fittyfene.
1028 .PD 1
1031 .B \-slave (also see \-input)
1032 Switches on slave mode, in which MPlayer works as a backend for other programs.
1033 Instead of intercepting keyboard events, MPlayer will read commands separated
1034 by a newline (\\n) from stdin.
1036 .I NOTE:
1037 See \-input cmdlist for a list of slave commands and DOCS/tech/slave.txt
1038 for their description.
1041 .B \-softsleep
1042 Time frames by repeatedly checking the current time instead of asking the
1043 kernel to wake up MPlayer at the correct time.
1044 Useful if your kernel timing is imprecise and you cannot use the RTC either.
1045 Comes at the price of higher CPU consumption.
1048 .B \-sstep <sec>
1049 Skip <sec> seconds after every frame.
1050 The normal framerate of the movie is kept, so playback is accelerated.
1051 Since MPlayer can only seek to the next keyframe this may be inexact.
1055 .SH "DEMUXER/STREAM OPTIONS"
1058 .B \-a52drc <level>
1059 Select the Dynamic Range Compression level for AC-3 audio streams.
1060 <level> is a float value ranging from 0 to 1, where 0 means no compression
1061 and 1 (which is the default) means full compression (make loud passages more
1062 silent and vice versa).
1063 This option only shows an effect if the AC-3 stream contains the required range
1064 compression information.
1067 .B \-aid <ID> (also see \-alang)
1068 Select audio channel (MPEG: 0\-31, AVI/\:OGM: 1\-99, ASF/\:RM: 0\-127,
1069 VOB(AC-3): 128\-159, VOB(LPCM): 160\-191, MPEG-TS 17\-8190).
1070 MPlayer prints the available audio IDs when run in verbose (\-v) mode.
1071 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1072 (if present) with the chosen audio stream.
1075 .B \-alang <language code[,language code,...]> (also see \-aid)
1076 Specify a priority list of audio languages to use.
1077 Different container formats employ different language codes.
1078 DVDs use ISO 639-1 two letter language codes, Matroska, MPEG-TS and NUT
1079 use ISO 639-2 three letter language codes while OGM uses a free-form identifier.
1080 MPlayer prints the available languages when run in verbose (\-v) mode.
1081 .sp 1
1082 .I EXAMPLE:
1083 .PD 0
1084 .RSs
1085 .IPs "mplayer dvd://1 \-alang hu,en"
1086 Chooses the Hungarian language track on a DVD and falls back on English if
1087 Hungarian is not available.
1088 .IPs "mplayer \-alang jpn example.mkv"
1089 Plays a Matroska file in Japanese.
1091 .PD 1
1094 .B \-audio\-demuxer <[+]name> (\-audiofile only)
1095 Force audio demuxer type for \-audiofile.
1096 Use a '+' before the name to force it, this will skip some checks!
1097 Give the demuxer name as printed by \-audio\-demuxer help.
1098 For backward compatibility it also accepts the demuxer ID as defined in
1099 libmpdemux/\:demuxer.h.
1100 \-audio\-demuxer audio or \-audio\-demuxer 17 forces MP3.
1103 .B \-audiofile <filename>
1104 Play audio from an external file (WAV, MP3 or Ogg Vorbis) while viewing a
1105 movie.
1108 .B \-audiofile\-cache <kBytes>
1109 Enables caching for the stream used by \-audiofile, using the specified
1110 amount of memory.
1113 .B \-reuse\-socket (udp:// only)
1114 Allows a socket to be reused by other processes as soon as it is closed.
1117 .B \-bandwidth <value> (network only)
1118 Specify the maximum bandwidth for network streaming (for servers that are
1119 able to send content in different bitrates).
1120 Useful if you want to watch live streamed media behind a slow connection.
1121 With Real RTSP streaming, it is also used to set the maximum delivery
1122 bandwidth allowing faster cache filling and stream dumping.
1125 .B \-cache <kBytes>
1126 This option specifies how much memory (in kBytes) to use when precaching a
1127 file or URL.
1128 Especially useful on slow media.
1131 .B \-nocache
1132 Turns off caching.
1135 .B \-cache\-min <percentage>
1136 Playback will start when the cache has been filled up to <percentage>
1137 of the total.
1140 .B \-cache\-seek\-min <percentage>
1141 If a seek is to be made to a position within <percentage> of the cache size
1142 from the current position, MPlayer will wait for the cache to be filled to
1143 this position rather than performing a stream seek (default: 50).
1146 .B \-cdda <option1:option2> (CDDA only)
1147 This option can be used to tune the CD Audio reading feature of MPlayer.
1148 .sp 1
1149 Available options are:
1150 .RSs
1151 .IPs speed=<value>
1152 Set CD spin speed.
1153 .IPs paranoia=<0\-2>
1154 Set paranoia level.
1155 Values other than 0 seem to break playback of anything but the first track.
1156 .RSss
1157 0: disable checking (default)
1159 1: overlap checking only
1161 2: full data correction and verification
1162 .REss
1163 .IPs generic-dev=<value>
1164 Use specified generic SCSI device.
1165 .IPs sector-size=<value>
1166 Set atomic read size.
1167 .IPs overlap=<value>
1168 Force minimum overlap search during verification to <value> sectors.
1169 .IPs toc-bias
1170 Assume that the beginning offset of track 1 as reported in the TOC will be
1171 addressed as LBA 0.
1172 Some Toshiba drives need this for getting track boundaries correct.
1173 .IPs toc-offset=<value>
1174 Add <value> sectors to the values reported when addressing tracks.
1175 May be negative.
1176 .IPs (no)skip
1177 (Never) accept imperfect data reconstruction.
1181 .B \-cdrom\-device <path to device>
1182 Specify the CD-ROM device (default: /dev/\:cdrom).
1185 .B \-channels <number> (also see \-af channels)
1186 Request the number of playback channels (default: 2).
1187 MPlayer asks the decoder to decode the audio into as many channels as
1188 specified.
1189 Then it is up to the decoder to fulfill the requirement.
1190 This is usually only important when playing videos with AC-3 audio (like DVDs).
1191 In that case liba52 does the decoding by default and correctly downmixes the
1192 audio into the requested number of channels.
1193 To directly control the number of output channels independently of how many
1194 channels are decoded, use the channels filter.
1196 .I NOTE:
1197 This option is honored by codecs (AC-3 only), filters (surround) and audio
1198 output drivers (OSS at least).
1199 .sp 1
1200 Available options are:
1201 .sp 1
1202 .PD 0
1203 .RSs
1204 .IPs 2
1205 stereo
1206 .IPs 4
1207 surround
1208 .IPs 6
1209 full 5.1
1211 .PD 1
1214 .B \-chapter <chapter ID>[\-<endchapter ID>] (dvd:// and dvdnav:// only)
1215 Specify which chapter to start playing at.
1216 Optionally specify which chapter to end playing at (default: 1).
1219 .B \-cookies (network only)
1220 Send cookies when making HTTP requests.
1223 .B \-cookies\-file <filename> (network only)
1224 Read HTTP cookies from <filename> (default: ~/.mozilla/ and ~/.netscape/)
1225 and skip reading from default locations.
1226 The file is assumed to be in Netscape format.
1229 .B \-delay <sec>
1230 audio delay in seconds (positive or negative float value)
1232 Negative values delay the audio, and positive values delay the video.
1233 Note that this is the exact opposite of the \-audio\-delay MEncoder option.
1235 .I NOTE:
1236 When used with MEncoder, this is not guaranteed to work correctly
1237 with \-ovc copy; use \-audio\-delay instead.
1240 .B \-ignore\-start
1241 Ignore the specified starting time for streams in AVI files.
1242 In MPlayer, this nullifies stream delays in files encoded with
1243 the \-audio\-delay option.
1244 During encoding, this option prevents MEncoder from transferring
1245 original stream start times to the new file; the \-audio\-delay option is
1246 not affected.
1247 Note that MEncoder sometimes adjusts stream starting times
1248 automatically to compensate for anticipated decoding delays, so do not
1249 use this option for encoding without testing it first.
1252 .B \-demuxer <[+]name>
1253 Force demuxer type.
1254 Use a '+' before the name to force it, this will skip some checks!
1255 Give the demuxer name as printed by \-demuxer help.
1256 For backward compatibility it also accepts the demuxer ID as defined in
1257 libmpdemux/\:demuxer.h.
1260 .B \-dumpaudio (MPlayer only)
1261 Dumps raw compressed audio stream to ./stream.dump (useful with MPEG/\:AC-3,
1262 in most other cases the resulting file will not be playable).
1263 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1264 on the command line only the last one will work.
1267 .B \-dumpfile <filename> (MPlayer only)
1268 Specify which file MPlayer should dump to.
1269 Should be used together with \-dumpaudio / \-dumpvideo / \-dumpstream.
1272 .B \-dumpstream (MPlayer only)
1273 Dumps the raw stream to ./stream.dump.
1274 Useful when ripping from DVD or network.
1275 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1276 on the command line only the last one will work.
1279 .B \-dumpvideo (MPlayer only)
1280 Dump raw compressed video stream to ./stream.dump (not very usable).
1281 If you give more than one of \-dumpaudio, \-dumpvideo, \-dumpstream
1282 on the command line only the last one will work.
1285 .B \-dvbin <options> (DVB only)
1286 Pass the following parameters to the DVB input module, in order to override
1287 the default ones:
1288 .sp 1
1289 .PD 0
1290 .RSs
1291 .IPs card=<1\-4>
1292 Specifies using card number 1\-4 (default: 1).
1293 .IPs file=<filename>
1294 Instructs MPlayer to read the channels list from <filename>.
1295 Default is ~/.mplayer/\:channels.conf.{sat,ter,cbl,atsc} (based on your card type)
1296 or ~/.mplayer/\:channels.conf as a last resort.
1297 .IPs timeout=<1\-30>
1298 Maximum number of seconds to wait when trying to tune a
1299 frequency before giving up (default: 30).
1301 .PD 1
1304 .B \-dvd\-device <path to device> (DVD only)
1305 Specify the DVD device (default: /dev/\:dvd).
1306 You can also specify a directory that contains files previously copied directly
1307 from a DVD (with e.g.\& vobcopy).
1308 Note that using \-dumpstream is usually a better way to
1309 copy DVD titles in the first place (see the examples).
1312 .B \-dvd\-speed <factor or speed in KB/s> (DVD only)
1313 Try to limit DVD speed (default: 0, no change).
1314 DVD base speed is about 1350KB/s, so a 8x drive can read at speeds up to
1315 10800KB/s.
1316 Slower speeds make the drive more quiet, for watching DVDs 2700KB/s should be
1317 quiet and fast enough.
1318 MPlayer resets the speed to the drive default value on close.
1319 Values less than 100 mean multiples of 1350KB/s, i.e.\& \-dvd\-speed 8 selects
1320 10800KB/s.
1322 .I NOTE:
1323 You need write access to the DVD device to change the speed.
1326 .B \-dvdangle <angle ID> (DVD only)
1327 Some DVD discs contain scenes that can be viewed from multiple angles.
1328 Here you can tell MPlayer which angles to use (default: 1).
1331 .B \-edl <filename>
1332 Enables edit decision list (EDL) actions during playback.
1333 Video will be skipped over and audio will be muted and unmuted according to
1334 the entries in the given file.
1335 See http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:edl.html for details
1336 on how to use this.
1339 .B \-endpos <[[hh:]mm:]ss[.ms]|size[b|kb|mb]> (also see \-ss and \-sb)
1340 Stop at given time or byte position.
1342 .I NOTE:
1343 Byte position is enabled only for MEncoder and will not be accurate, as it can
1344 only stop at a frame boundary.
1345 When used in conjunction with \-ss option, \-endpos time will shift forward by
1346 seconds specified with \-ss.
1347 .sp 1
1348 .I EXAMPLE:
1349 .PD 0
1350 .RSs
1351 .IPs "\-endpos 56"
1352 Stop at 56 seconds.
1353 .IPs "\-endpos 01:10:00"
1354 Stop at 1 hour 10 minutes.
1355 .IPs "\-ss 10 \-endpos 56"
1356 Stop at 1 minute 6 seconds.
1357 .IPs "\-endpos 100mb"
1358 Encode only 100 MB.
1360 .PD 1
1363 .B \-forceidx
1364 Force index rebuilding.
1365 Useful for files with broken index (A/V desync, etc).
1366 This will enable seeking in files where seeking was not possible.
1367 You can fix the index permanently with MEncoder (see the documentation).
1369 .I NOTE:
1370 This option only works if the underlying media supports seeking
1371 (i.e.\& not with stdin, pipe, etc).
1374 .B \-fps <float value>
1375 Override video framerate.
1376 Useful if the original value is wrong or missing.
1379 .B \-frames <number>
1380 Play/\:convert only first <number> frames, then quit.
1383 .B \-hr\-mp3\-seek (MP3 only)
1384 Hi-res MP3 seeking.
1385 Enabled when playing from an external MP3 file, as we need to seek
1386 to the very exact position to keep A/V sync.
1387 Can be slow especially when seeking backwards since it has to rewind
1388 to the beginning to find an exact frame position.
1391 .B \-idx (also see \-forceidx)
1392 Rebuilds index of files if no index was found, allowing seeking.
1393 Useful with broken/\:incomplete downloads, or badly created files.
1395 .I NOTE:
1396 This option only works if the underlying media supports seeking
1397 (i.e.\& not with stdin, pipe, etc).
1400 .B \-noidx
1401 Skip rebuilding index file.
1402 MEncoder skips writing the index with this option.
1405 .B \-ipv4\-only\-proxy (network only)
1406 Skip the proxy for IPv6 addresses.
1407 It will still be used for IPv4 connections.
1410 .B \-loadidx <index file>
1411 The file from which to read the video index data saved by \-saveidx.
1412 This index will be used for seeking, overriding any index data
1413 contained in the AVI itself.
1414 MPlayer will not prevent you from loading an index file generated
1415 from a different AVI, but this is sure to cause unfavorable results.
1417 .I NOTE:
1418 This option is obsolete now that MPlayer has OpenDML support.
1421 .B \-mc <seconds/frame>
1422 maximum A-V sync correction per frame (in seconds)
1425 .B \-mf <option1:option2:...>
1426 Used when decoding from multiple PNG or JPEG files.
1427 .sp 1
1428 Available options are:
1429 .sp 1
1430 .PD 0
1431 .RSs
1432 .IPs w=<value>
1433 input file width (default: autodetect)
1434 .IPs h=<value>
1435 input file height (default: autodetect)
1436 .IPs fps=<value>
1437 output fps (default: 25)
1438 .IPs type=<value>
1439 input file type (available: jpeg, png, tga, sgi)
1441 .PD 1
1444 .B \-ni (AVI only)
1445 Force usage of non-interleaved AVI parser (fixes playback
1446 of some bad AVI files).
1449 .B \-nobps (AVI only)
1450 Do not use average byte/\:second value for A-V sync.
1451 Helps with some AVI files with broken header.
1454 .B \-noextbased
1455 Disables extension-based demuxer selection.
1456 By default, when the file type (demuxer) cannot be detected reliably
1457 (the file has no header or it is not reliable enough), the filename
1458 extension is used to select the demuxer.
1459 Always falls back on content-based demuxer selection.
1462 .B \-passwd <password> (also see \-user) (network only)
1463 Specify password for HTTP authentication.
1466 .B \-prefer\-ipv4 (network only)
1467 Use IPv4 on network connections.
1468 Falls back on IPv6 automatically.
1471 .B \-prefer\-ipv6 (IPv6 network only)
1472 Use IPv6 on network connections.
1473 Falls back on IPv4 automatically.
1476 .B \-psprobe <byte position>
1477 When playing an MPEG-PS stream, this option lets you specify how many
1478 bytes in the stream you want MPlayer to scan in order to identify the
1479 video codec used.
1480 This option is needed to play EVO files containing H.264 streams.
1483 .B \-pvr <option1:option2:...> (PVR only)
1484 This option tunes various encoding properties of the PVR capture module.
1485 It has to be used with any hardware MPEG encoder based card supported by the
1486 V4L2 driver.
1487 The Hauppauge WinTV PVR\-150/250/350/500 and all IVTV based
1488 cards are known as PVR capture cards.
1489 Be aware that only Linux 2.6.18 kernel
1490 and above is able to handle MPEG stream through V4L2 layer.
1491 For hardware capture of an MPEG stream and watching it with
1492 MPlayer/MEncoder, use 'pvr://' as a movie URL.
1493 .sp 1
1494 Available options are:
1495 .RSs
1496 .IPs aspect=<0\-3>
1497 Specify input aspect ratio:
1498 .RSss
1499 0: 1:1
1501 1: 4:3 (default)
1503 2: 16:9
1505 3: 2.21:1
1506 .REss
1507 .IPs arate=<32000\-48000>
1508 Specify encoding audio rate (default: 48000 Hz, available: 32000, 44100
1509 and 48000 Hz).
1510 .IPs alayer=<1\-3>
1511 Specify MPEG audio layer encoding (default: 2).
1512 .IPs abitrate=<32\-448>
1513 Specify audio encoding bitrate in kbps (default: 384).
1514 .IPs amode=<value>
1515 Specify audio encoding mode.
1516 Available preset values are 'stereo', 'joint_stereo', 'dual' and 'mono' (default: stereo).
1517 .IPs vbitrate=<value>
1518 Specify average video bitrate encoding in Mbps (default: 6).
1519 .IPs vmode=<value>
1520 Specify video encoding mode:
1521 .RSss
1522 vbr: Variable BitRate (default)
1524 cbr: Constant BitRate
1525 .REss
1526 .IPs vpeak=<value>
1527 Specify peak video bitrate encoding in Mbps
1528 (only useful for VBR encoding, default: 9.6).
1529 .IPs fmt=<value>
1530 Choose an MPEG format for encoding:
1531 .RSss
1532 ps:    MPEG-2 Program Stream (default)
1534 ts:    MPEG-2 Transport Stream
1536 mpeg1: MPEG-1 System Stream
1538 vcd:   Video CD compatible stream
1540 svcd:  Super Video CD compatible stream
1542 dvd:   DVD compatible stream
1543 .REss
1545 .PD 1
1548 .B \-radio <option1:option2:...> (radio only)
1549 These options set various parameters of the radio capture module.
1550 For listening to radio with MPlayer use 'radio://<frequency>'
1551 (if channels option is not given) or 'radio://<channel_number>'
1552 (if channels option is given) as a movie URL.
1553 You can see allowed frequency range by running MPlayer with '\-v'.
1554 To start the grabbing subsystem, use 'radio://<frequency or channel>/capture'.
1555 If the capture keyword is not given you can listen to radio
1556 using the line-in cable only.
1557 Using capture to listen is not recommended due to synchronization
1558 problems, which makes this process uncomfortable.
1559 .sp 1
1560 Available options are:
1561 .RSs
1562 .IPs device=<value>
1563 Radio device to use (default: /dev/radio0 for Linux and /dev/tuner0 for *BSD).
1564 .IPs driver=<value>
1565 Radio driver to use (default: v4l2 if available, otherwise v4l).
1566 Currently, v4l and v4l2 drivers are supported.
1567 .IPs volume=<0..100>
1568 sound volume for radio device (default 100)
1569 .IPs "freq_min=<value> (*BSD BT848 only)"
1570 minimum allowed frequency (default: 87.50)
1571 .IPs "freq_max=<value> (*BSD BT848 only)"
1572 maximum allowed frequency (default: 108.00)
1573 .IPs channels=<frequency>\-<name>,<frequency>\-<name>,...
1574 Set channel list.
1575 Use _ for spaces in names (or play with quoting ;-).
1576 The channel names will then be written using OSD and the slave commands
1577 radio_step_channel and radio_set_channel will be usable for
1578 a remote control (see LIRC).
1579 If given, number in movie URL will be treated as channel position in
1580 channel list.
1582 .I EXAMPLE:
1583 radio://1, radio://104.4, radio_set_channel 1
1584 .IPs "adevice=<value> (radio capture only)"
1585 Name of device to capture sound from.
1586 Without such a name capture will be disabled,
1587 even if the capture keyword appears in the URL.
1588 For ALSA devices use it in the form hw=<card>.<device>.
1589 If the device name contains a '=', the module will use
1590 ALSA to capture, otherwise OSS.
1591 .IPs "arate=<value> (radio capture only)"
1592 Rate in samples per second (default: 44100).
1594 .I NOTE:
1595 When using audio capture set also \-rawaudio rate=<value> option
1596 with the same value as arate.
1597 If you have problems with sound speed (runs too quickly), try to play
1598 with different rate values (e.g.\& 48000,44100,32000,...).
1599 .IPs "achannels=<value> (radio capture only)"
1600 Number of audio channels to capture.
1604 .B \-rawaudio <option1:option2:...>
1605 This option lets you play raw audio files.
1606 You have to use \-demuxer rawaudio as well.
1607 It may also be used to play audio CDs which are not 44kHz 16-bit stereo.
1608 For playing raw AC-3 streams use \-rawaudio format=0x2000 \-demuxer rawaudio.
1609 .sp 1
1610 Available options are:
1611 .sp 1
1612 .PD 0
1613 .RSs
1614 .IPs channels=<value>
1615 number of channels
1616 .IPs rate=<value>
1617 rate in samples per second
1618 .IPs samplesize=<value>
1619 sample size in bytes
1620 .IPs bitrate=<value>
1621 bitrate for rawaudio files
1622 .IPs format=<value>
1623 fourcc in hex
1625 .PD 1
1628 .B \-rawvideo <option1:option2:...>
1629 This option lets you play raw video files.
1630 You have to use \-demuxer rawvideo as well.
1631 .sp 1
1632 Available options are:
1633 .sp 1
1634 .PD 0
1635 .RSs
1636 .IPs fps=<value>
1637 rate in frames per second (default: 25.0)
1638 .IPs sqcif|qcif|cif|4cif|pal|ntsc
1639 set standard image size
1640 .IPs w=<value>
1641 image width in pixels
1642 .IPs h=<value>
1643 image height in pixels
1644 .IPs i420|yv12|yuy2|y8
1645 set colorspace
1646 .IPs format=<value>
1647 colorspace (fourcc) in hex or string constant.
1648 Use \-rawvideo format=help for a list of possible strings.
1649 .IPs size=<value>
1650 frame size in Bytes
1651 .REss
1652 .sp 1
1654 .I EXAMPLE:
1656 .PD 0
1657 .RSs
1658 .IPs "mplayer foreman.qcif -demuxer rawvideo -rawvideo qcif"
1659 Play the famous "foreman" sample video.
1660 .IPs "mplayer sample-720x576.yuv -demuxer rawvideo -rawvideo w=720:h=576"
1661 Play a raw YUV sample.
1663 .PD 1
1666 .B \-rtsp\-port
1667 Used with 'rtsp://' URLs to force the client's port number.
1668 This option may be useful if you are behind a router and want to forward
1669 the RTSP stream from the server to a specific client.
1672 .B \-rtsp\-destination
1673 Used with 'rtsp://' URLs to force the destination IP address to be bound.
1674 This option may be useful with some RTSP server which do not
1675 send RTP packets to the right interface.
1676 If the connection to the RTSP server fails, use \-v to see
1677 which IP address MPlayer tries to bind to and try to force
1678 it to one assigned to your computer instead.
1681 .B \-rtsp\-stream\-over\-tcp (LIVE555 and NEMESI only)
1682 Used with 'rtsp://' URLs to specify that the resulting incoming RTP and RTCP
1683 packets be streamed over TCP (using the same TCP connection as RTSP).
1684 This option may be useful if you have a broken internet connection that does
1685 not pass incoming UDP packets (see http://www.live555.com/\:mplayer/).
1688 .B \-saveidx <filename>
1689 Force index rebuilding and dump the index to <filename>.
1690 Currently this only works with AVI files.
1692 .I NOTE:
1693 This option is obsolete now that MPlayer has OpenDML support.
1696 .B \-sb <byte position> (also see \-ss)
1697 Seek to byte position.
1698 Useful for playback from CD-ROM images or VOB files with junk at the beginning.
1701 .B \-speed <0.01\-100>
1702 Slow down or speed up playback by the factor given as parameter.
1703 Not guaranteed to work correctly with \-oac copy.
1706 .B \-srate <Hz>
1707 Selects the output sample rate to be used
1708 (of course sound cards have limits on this).
1709 If the sample frequency selected is different from that
1710 of the current media, the resample or lavcresample audio filter will be inserted
1711 into the audio filter layer to compensate for the difference.
1712 The type of resampling can be controlled by the \-af\-adv option.
1713 The default is fast resampling that may cause distortion.
1716 .B \-ss <time> (also see \-sb)
1717 Seek to given time position.
1718 .sp 1
1719 .I EXAMPLE:
1720 .PD 0
1721 .RSs
1722 .IPs "\-ss 56"
1723 Seeks to 56 seconds.
1724 .IPs "\-ss 01:10:00"
1725 Seeks to 1 hour 10 min.
1727 .PD 1
1730 .B \-tskeepbroken
1731 Tells MPlayer not to discard TS packets reported as broken in the stream.
1732 Sometimes needed to play corrupted MPEG-TS files.
1735 .B \-tsprobe <byte position>
1736 When playing an MPEG-TS stream, this option lets you specify how many
1737 bytes in the stream you want MPlayer to search for the desired
1738 audio and video IDs.
1741 .B \-tsprog <1\-65534>
1742 When playing an MPEG-TS stream, you can specify with this option which
1743 program (if present) you want to play.
1744 Can be used with \-vid and \-aid.
1747 .B \-tv <option1:option2:...> (TV/\:PVR only)
1748 This option tunes various properties of the TV capture module.
1749 For watching TV with MPlayer, use 'tv://' or 'tv://<channel_number>'
1750 or even 'tv://<channel_name> (see option channels for channel_name below)
1751 as a movie URL.
1752 You can also use 'tv:///<input_id>' to start watching a
1753 movie from a composite or S-Video input (see option input for details).
1754 .sp 1
1755 Available options are:
1756 .RSs
1757 .IPs noaudio
1758 no sound
1759 .IPs "automute=<0\-255> (v4l and v4l2 only)"
1760 If signal strength reported by device is less than this value,
1761 audio and video will be muted.
1762 In most cases automute=100 will be enough.
1763 Default is 0 (automute disabled).
1764 .IPs driver=<value>
1765 See \-tv driver=help for a list of compiled-in TV input drivers.
1766 available: dummy, v4l, v4l2, bsdbt848 (default: autodetect)
1767 .IPs device=<value>
1768 Specify TV device (default: /dev/\:video0).
1769 .I NOTE:
1770 For the bsdbt848 driver you can provide both bktr and tuner device
1771 names separating them with a comma, tuner after
1772 bktr (e.g.\& -tv device=/dev/bktr1,/dev/tuner1).
1773 .IPs input=<value>
1774 Specify input (default: 0 (TV), see console output for available inputs).
1775 .IPs freq=<value>
1776 Specify the frequency to set the tuner to (e.g.\& 511.250).
1777 Not compatible with the channels parameter.
1778 .IPs outfmt=<value>
1779 Specify the output format of the tuner with a preset value supported by the
1780 V4L driver (yv12, rgb32, rgb24, rgb16, rgb15, uyvy, yuy2, i420) or an
1781 arbitrary format given as hex value.
1782 Try outfmt=help for a list of all available formats.
1783 .IPs width=<value>
1784 output window width
1785 .IPs height=<value>
1786 output window height
1787 .IPs fps=<value>
1788 framerate at which to capture video (frames per second)
1789 .IPs buffersize=<value>
1790 maximum size of the capture buffer in megabytes (default: dynamical)
1791 .IPs norm=<value>
1792 For bsdbt848 and v4l, PAL, SECAM, NTSC are available.
1793 For v4l2, see the console output for a list of all available norms,
1794 also see the normid option below.
1795 .IPs "normid=<value> (v4l2 only)"
1796 Sets the TV norm to the given numeric ID.
1797 The TV norm depends on the capture card.
1798 See the console output for a list of available TV norms.
1799 .IPs channel=<value>
1800 Set tuner to <value> channel.
1801 .IPs chanlist=<value>
1802 available: europe-east, europe-west, us-bcast, us-cable, etc
1803 .IPs channels=<channel>\-<name>,<channel>\-<name>,...
1804 Set names for channels.
1805 .I NOTE:
1806 If <channel> is an integer greater than 1000, it will be treated as frequency (in kHz)
1807 rather than channel name from frequency table.
1809 Use _ for spaces in names (or play with quoting ;-).
1810 The channel names will then be written using OSD, and the slave commands
1811 tv_step_channel, tv_set_channel and tv_last_channel will be usable for
1812 a remote control (see LIRC).
1813 Not compatible with the frequency parameter.
1815 .I NOTE:
1816 The channel number will then be the position in the 'channels' list,
1817 beginning with 1.
1819 .I EXAMPLE:
1820 tv://1, tv://TV1, tv_set_channel 1, tv_set_channel TV1
1821 .IPs [brightness|contrast|hue|saturation]=<\-100\-100>
1822 Set the image equalizer on the card.
1823 .IPs audiorate=<value>
1824 Set audio capture bitrate.
1825 .IPs forceaudio
1826 Capture audio even if there are no audio sources reported by v4l.
1827 .IPs "alsa\ "
1828 Capture from ALSA.
1829 .IPs amode=<0\-3>
1830 Choose an audio mode:
1831 .RSss
1832 0: mono
1834 1: stereo
1836 2: language 1
1838 3: language 2
1839 .REss
1840 .IPs forcechan=<1\-2>
1841 By default, the count of recorded audio channels is determined automatically
1842 by querying the audio mode from the TV card.
1843 This option allows forcing stereo/\:mono recording regardless of the amode
1844 option and the values returned by v4l.
1845 This can be used for troubleshooting when the TV card is unable to report the
1846 current audio mode.
1847 .IPs adevice=<value>
1848 Set an audio device.
1849 <value> should be /dev/\:xxx for OSS and a hardware ID for ALSA.
1850 You must replace any ':' by a '.' in the hardware ID for ALSA.
1851 .IPs audioid=<value>
1852 Choose an audio output of the capture card, if it has more than one.
1853 .IPs "[volume|bass|treble|balance]=<0\-65535> (v4l1)"
1854 .IPs "[volume|bass|treble|balance]=<0\-100> (v4l2)"
1855 These options set parameters of the mixer on the video capture card.
1856 They will have no effect, if your card does not have one.
1857 For v4l2 50 maps to the default value of the
1858 control, as reported by the driver.
1859 .IPs "gain=<0\-100> (v4l2)"
1860 Set gain control for video devices (usually webcams) to the desired
1861 value and switch off automatic control.
1862 A value of 0 enables automatic control.
1863 If this option is omitted, gain control will not be modified.
1864 .IPs immediatemode=<bool>
1865 A value of 0 means capture and buffer audio and video together
1866 (default for MEncoder).
1867 A value of 1 (default for MPlayer) means to do video capture only and let the
1868 audio go through a loopback cable from the TV card to the sound card.
1869 .IPs mjpeg
1870 Use hardware MJPEG compression (if the card supports it).
1871 When using this option, you do not need to specify the width and height
1872 of the output window, because MPlayer will determine it automatically
1873 from the decimation value (see below).
1874 .IPs decimation=<1|2|4>
1875 choose the size of the picture that will be compressed by hardware
1876 MJPEG compression:
1877 .RSss
1878 1: full size
1879     704x576    PAL
1880     704x480    NTSC
1882 2: medium size
1883     352x288    PAL
1884     352x240    NTSC
1886 4: small size
1887     176x144    PAL
1888     176x120    NTSC
1889 .REss
1890 .IPs quality=<0\-100>
1891 Choose the quality of the JPEG compression
1892 (< 60 recommended for full size).
1893 .IPs tdevice=<value>
1894 Specify TV teletext device (example: /dev/\:vbi0) (default: none).
1895 .IPs tformat=<format>
1896 Specify TV teletext display format (default: 0):
1897 .RSss
1898 0: opaque
1900 1: transparent
1902 2: opaque with inverted colors
1904 3: transparent with inverted colors
1905 .REss
1906 .IPs tpage=<100\-899>
1907 Specify initial TV teletext page number (default: 100).
1908 .IPs tlang=<\-1\-127>
1909 Specify default teletext language code (default: 0), which will be used
1910 as primary language until a type 28 packet is received.
1911 Useful when the teletext system uses a non-latin character set, but language
1912 codes are not transmitted via teletext type 28 packets for some reason.
1913 To see a list of supported language codes set this option to \-1.
1914 .IPs "hidden_video_renderer (dshow only)"
1915 Terminate stream with video renderer instead of Null renderer (default: off).
1916 Will help if video freezes but audio does not.
1917 .I NOTE:
1918 May not work with \-vo directx and \-vf crop combination.
1919 .IPs "hidden_vp_renderer (dshow only)"
1920 Terminate VideoPort pin stream with video renderer 
1921 instead of removing it from the graph (default: off).
1922 Useful if your card has a VideoPort pin and video is choppy.
1923 .I NOTE:
1924 May not work with \-vo directx and \-vf crop combination.
1925 .IPs "system_clock (dshow only)"
1926 Use the system clock as sync source instead of the default graph clock
1927 (usually the clock from one of the live sources in graph).
1928 .IPs "normalize_audio_chunks (dshow only)"
1929 Create audio chunks with a time length equal to
1930 video frame time length (default: off).
1931 Some audio cards create audio chunks about 0.5s in size, resulting in
1932 choppy video when using immediatemode=0.
1936 .B \-tvscan <option1:option2:...> (TV and MPlayer only)
1937 Tune the TV channel scanner.
1938 MPlayer will also print value for "-tv channels=" option,
1939 including existing and just found channels.
1940 .sp 1
1941 Available suboptions are:
1942 .RSs
1943 .IPs autostart
1944 Begin channel scanning immediately after startup (default: disabled).
1945 .IPs period=<0.1\-2.0>
1946 Specify delay in seconds before switching to next channel (default: 0.5).
1947 Lower values will cause faster scanning, but can detect
1948 inactive TV channels as active.
1949 .IPs threshold=<1\-100>
1950 Threshold value for the signal strength (in percent), as reported
1951 by the device (default: 50).
1952 A signal strength higher than this value will indicate that the
1953 currently scanning channel is active.
1957 .B \-user <username> (also see \-passwd) (network only)
1958 Specify username for HTTP authentication.
1961 .B \-user\-agent <string>
1962 Use <string> as user agent for HTTP streaming.
1965 .B \-vid <ID>
1966 Select video channel (MPG: 0\-15, ASF: 0\-255, MPEG-TS: 17\-8190).
1967 When playing an MPEG-TS stream, MPlayer/\:MEncoder will use the first program
1968 (if present) with the chosen video stream.
1971 .B \-vivo <suboption> (DEBUG CODE)
1972 Force audio parameters for the VIVO demuxer (for debugging purposes).
1973 FIXME: Document this.
1977 .SH "OSD/SUBTITLE OPTIONS"
1978 .I NOTE:
1979 Also see \-vf expand.
1982 .B \-ass (FreeType only)
1983 Turn on SSA/ASS subtitle rendering.
1984 With this option, libass will be used for SSA/ASS
1985 external subtitles and Matroska tracks.
1986 You may also want to use \-embeddedfonts.
1988 .I NOTE:
1989 When fontconfig is compiled-in, \-ass turns on \-fontconfig
1990 unless explicitly turned off with \-nofontconfig.
1993 .B \-ass\-border\-color <value>
1994 Sets the border (outline) color for text subtitles.
1995 The color format is RRGGBBAA.
1998 .B \-ass\-bottom\-margin <value>
1999 Adds a black band at the bottom of the frame.
2000 The SSA/ASS renderer can place subtitles there (with \-ass\-use\-margins).
2003 .B \-ass\-color <value>
2004 Sets the color for text subtitles.
2005 The color format is RRGGBBAA.
2008 .B \-ass\-font\-scale <value>
2009 Set the scale coefficient to be used for fonts in the SSA/ASS renderer.
2012 .B \-ass\-force\-style <[Style.]Param=Value[,...]>
2013 Override some style parameters.
2015 .I EXAMPLE:
2016 .PD 0
2017 .RSs
2018 \-ass\-force\-style FontName=Arial,Default.Bold=1
2020 .PD 1
2023 .B \-ass\-hinting <type>
2024 Set hinting type.
2025 <type> can be:
2026 .PD 0
2027 .RSs
2028 .IPs 0
2029 no hinting
2030 .IPs 1
2031 FreeType autohinter, light mode
2032 .IPs 2
2033 FreeType autohinter, normal mode
2034 .IPs 3
2035 font native hinter
2036 .IPs "0-3 + 4"
2037 The same, but hinting will only be performed if the OSD is rendered at
2038 screen resolution and will therefore not be scaled.
2040 .RSs
2041 The default value is 7 (use native hinter for unscaled OSD and no hinting otherwise).
2043 .PD 1
2046 .B \-ass\-line\-spacing <value>
2047 Set line spacing value for SSA/ASS renderer.
2050 .B \-ass\-styles <filename>
2051 Load all SSA/ASS styles found in the specified file and use them for
2052 rendering text subtitles.
2053 The syntax of the file is exactly like the
2054 [V4 Styles] / [V4+ Styles] section of SSA/ASS.
2057 .B \-ass\-top\-margin <value>
2058 Adds a black band at the top of the frame.
2059 The SSA/ASS renderer can place toptitles there (with \-ass\-use\-margins).
2062 .B \-ass\-use\-margins
2063 Enables placing toptitles and subtitles in black borders when they
2064 are available.
2067 .B \-dumpjacosub (MPlayer only)
2068 Convert the given subtitle (specified with the \-sub option) to the time-based
2069 JACOsub subtitle format.
2070 Creates a dumpsub.js file in the current directory.
2073 .B \-dumpmicrodvdsub (MPlayer only)
2074 Convert the given subtitle (specified with the \-sub option) to the
2075 MicroDVD subtitle format.
2076 Creates a dumpsub.sub file in the current directory.
2079 .B \-dumpmpsub (MPlayer only)
2080 Convert the given subtitle (specified with the \-sub option) to MPlayer's
2081 subtitle format, MPsub.
2082 Creates a dump.mpsub file in the current directory.
2085 .B \-dumpsami (MPlayer only)
2086 Convert the given subtitle (specified with the \-sub option) to the time-based
2087 SAMI subtitle format.
2088 Creates a dumpsub.smi file in the current directory.
2091 .B \-dumpsrtsub (MPlayer only)
2092 Convert the given subtitle (specified with the \-sub option) to the time-based
2093 SubViewer (SRT) subtitle format.
2094 Creates a dumpsub.srt file in the current directory.
2096 .I NOTE:
2097 Some broken hardware players choke on SRT subtitle files with Unix
2098 line endings.
2099 If you are unlucky enough to have such a box, pass your subtitle
2100 files through unix2dos or a similar program to replace Unix line
2101 endings with DOS/Windows line endings.
2104 .B \-dumpsub (MPlayer only) (BETA CODE)
2105 Dumps the subtitle substream from VOB streams.
2106 Also see the \-dump*sub and \-vobsubout* options.
2109 .B \-embeddedfonts (FreeType only)
2110 Enables extraction of Matroska embedded fonts (default: disabled).
2111 These fonts can be used for SSA/ASS subtitle
2112 rendering (\-ass option).
2113 Font files are created in the ~/.mplayer/\:fonts directory.
2115 .I NOTE:
2116 With FontConfig 2.4.2 or newer, embedded fonts are opened directly from memory,
2117 and this option is enabled by default.
2120 .B \-ffactor <number>
2121 Resample the font alphamap.
2122 Can be:
2123 .PD 0
2124 .RSs
2125 .IPs 0
2126 plain white fonts
2127 .IPs 0.75
2128 very narrow black outline (default)
2129 .IPs 1
2130 narrow black outline
2131 .IPs 10
2132 bold black outline
2134 .PD 1
2137 .B \-flip\-hebrew (FriBiDi only)
2138 Turns on flipping subtitles using FriBiDi.
2141 .B \-noflip\-hebrew\-commas
2142 Change FriBiDi's assumptions about the placements of commas in subtitles.
2143 Use this if commas in subtitles are shown at the start of a sentence
2144 instead of at the end.
2147 .B \-font <path to font.desc file>
2148 Search for the OSD/\:SUB fonts in an alternative directory (default for normal
2149 fonts: ~/\:.mplayer/\:font/\:font.desc, default for FreeType fonts:
2150 ~/.mplayer/\:subfont.ttf).
2152 .I NOTE:
2153 With FreeType, this option determines the path to the text font file.
2154 With fontconfig, this option determines the fontconfig font name.
2155 .sp 1
2156 .I EXAMPLE:
2157 .PD 0
2158 .RSs
2159 \-font ~/\:.mplayer/\:arial-14/\:font.desc
2161 \-font ~/\:.mplayer/\:arialuni.ttf
2163 \-font 'Bitstream Vera Sans'
2165 .PD 1
2168 .B \-fontconfig (fontconfig only)
2169 Enables the usage of fontconfig managed fonts.
2171 .I NOTE:
2172 \-ass automatically turns this on unless explicitly overridden
2173 with \-nofontconfig.
2176 .B \-forcedsubsonly
2177 Display only forced subtitles for the DVD subtitle stream selected by e.g.\&
2178 \-slang.
2181 .B \-fribidi\-charset <charset name> (FriBiDi only)
2182 Specifies the character set that will be passed to FriBiDi when
2183 decoding non-UTF-8 subtitles (default: ISO8859-8).
2186 .B \-ifo <VOBsub IFO file>
2187 Indicate the file that will be used to load palette and frame size for VOBsub
2188 subtitles.
2191 .B \-noautosub
2192 Turns off automatic subtitle file loading.
2195 .B \-osd\-duration <time>
2196 Set the duration of the OSD messages in ms (default: 1000).
2199 .B \-osdlevel <0\-3> (MPlayer only)
2200 Specifies which mode the OSD should start in.
2201 .PD 0
2202 .RSs
2203 .IPs 0
2204 subtitles only
2205 .IPs 1
2206 volume + seek (default)
2207 .IPs 2
2208 volume + seek + timer + percentage
2209 .IPs 3
2210 volume + seek + timer + percentage + total time
2212 .PD 1
2215 .B \-overlapsub
2216 Allows the next subtitle to be displayed while the current one is
2217 still visible (default is to enable the support only for specific
2218 formats).
2221 .B \-sid <ID> (also see \-slang, \-vobsubid)
2222 Display the subtitle stream specified by <ID> (0\-31).
2223 MPlayer prints the available subtitle IDs when run in verbose (\-v) mode.
2224 If you cannot select one of the subtitles on a DVD, also try \-vobsubid.
2227 .B \-slang <language code[,language code,...]> (also see \-sid)
2228 Specify a priority list of subtitle languages to use.
2229 Different container formats employ different language codes.
2230 DVDs use ISO 639-1 two letter language codes, Matroska uses ISO 639-2
2231 three letter language codes while OGM uses a free-form identifier.
2232 MPlayer prints the available languages when run in verbose (\-v) mode.
2233 .sp 1
2234 .I EXAMPLE:
2235 .PD 0
2236 .RSs
2237 .IPs "mplayer dvd://1 \-slang hu,en"
2238 Chooses the Hungarian subtitle track on a DVD and falls back on English if
2239 Hungarian is not available.
2240 .IPs "mplayer \-slang jpn example.mkv"
2241 Plays a Matroska file with Japanese subtitles.
2243 .PD 1
2246 .B \-spuaa <mode>
2247 Antialiasing/\:scaling mode for DVD/\:VOBsub.
2248 A value of 16 may be added to <mode> in order to force scaling even
2249 when original and scaled frame size already match.
2250 This can be employed to e.g.\& smooth subtitles with gaussian blur.
2251 Available modes are:
2252 .PD 0
2253 .RSs
2254 .IPs 0
2255 none (fastest, very ugly)
2256 .IPs 1
2257 approximate (broken?)
2258 .IPs 2
2259 full (slow)
2260 .IPs 3
2261 bilinear (default, fast and not too bad)
2262 .IPs 4
2263 uses swscaler gaussian blur (looks very good)
2265 .PD 1
2268 .B \-spualign <\-1\-2>
2269 Specify how SPU (DVD/\:VOBsub) subtitles should be aligned.
2270 .PD 0
2271 .RSs
2272 .IPs "\-1"
2273 original position
2274 .IPs " 0"
2275 Align at top (original behavior, default).
2276 .IPs " 1"
2277 Align at center.
2278 .IPs " 2"
2279 Align at bottom.
2281 .PD 1
2284 .B \-spugauss <0.0\-3.0>
2285 Variance parameter of gaussian used by \-spuaa 4.
2286 Higher means more blur (default: 1.0).
2289 .B \-sub <subtitlefile1,subtitlefile2,...>
2290 Use/\:display these subtitle files.
2291 Only one file can be displayed at the same time.
2294 .B \-sub\-bg\-alpha <0\-255>
2295 Specify the alpha channel value for subtitles and OSD backgrounds.
2296 Big values mean more transparency.
2297 0 means completely transparent.
2300 .B \-sub\-bg\-color <0\-255>
2301 Specify the color value for subtitles and OSD backgrounds.
2302 Currently subtitles are grayscale so this value is equivalent to the
2303 intensity of the color.
2304 255 means white and 0 black.
2307 .B \-sub\-demuxer <[+]name> (\-subfile only) (BETA CODE)
2308 Force subtitle demuxer type for \-subfile.
2309 Use a '+' before the name to force it, this will skip some checks!
2310 Give the demuxer name as printed by \-sub\-demuxer help.
2311 For backward compatibility it also accepts the demuxer ID as defined in
2312 subreader.h.
2315 .B \-sub\-fuzziness <mode>
2316 Adjust matching fuzziness when searching for subtitles:
2317 .PD 0
2318 .RSs
2319 .IPs 0
2320 exact match
2321 .IPs 1
2322 Load all subs containing movie name.
2323 .IPs 2
2324 Load all subs in the current directory.
2326 .PD 1
2329 .B \-sub\-no\-text\-pp
2330 Disables any kind of text post processing done after loading the subtitles.
2331 Used for debug purposes.
2334 .B \-subalign <0\-2>
2335 Specify which edge of the subtitles should be aligned at the height
2336 given by \-subpos.
2337 .PD 0
2338 .RSs
2339 .IPs 0
2340 Align subtitle top edge (original behavior).
2341 .IPs 1
2342 Align subtitle center.
2343 .IPs 2
2344 Align subtitle bottom edge (default).
2346 .PD 1
2349 .B "\-subcc \ "
2350 Display DVD Closed Caption (CC) subtitles.
2351 These are
2352 .B not
2353 the VOB subtitles, these are special ASCII subtitles for the
2354 hearing impaired encoded in the VOB userdata stream on most region 1 DVDs.
2355 CC subtitles have not been spotted on DVDs from other regions so far.
2358 .B \-subcp <codepage> (iconv only)
2359 If your system supports iconv(3), you can use this option to
2360 specify the subtitle codepage.
2361 .sp 1
2362 .I EXAMPLE:
2363 .PD 0
2364 .RSs
2365 \-subcp latin2
2367 \-subcp cp1250
2369 .PD 1
2372 .B \-subcp enca:<language>:<fallback codepage> (ENCA only)
2373 You can specify your language using a two letter language code to
2374 make ENCA detect the codepage automatically.
2375 If unsure, enter anything and watch mplayer \-v output for available
2376 languages.
2377 Fallback codepage specifies the codepage to use, when autodetection fails.
2378 .sp 1
2379 .I EXAMPLE:
2380 .PD 0
2381 .RSs
2382 .IPs "\-subcp enca:cs:latin2"
2383 Guess the encoding, assuming the subtitles are Czech, fall back on
2384 latin 2, if the detection fails.
2385 .IPs "\-subcp enca:pl:cp1250"
2386 Guess the encoding for Polish, fall back on cp1250.
2388 .PD 1
2391 .B \-subdelay <sec>
2392 Delays subtitles by <sec> seconds.
2393 Can be negative.
2396 .B \-subfile <filename> (BETA CODE)
2397 Currently useless.
2398 Same as \-audiofile, but for subtitle streams (OggDS?).
2401 .B \-subfont <filename> (FreeType only)
2402 Sets the subtitle font.
2403 If no \-subfont is given, \-font is used.
2406 .B \-subfont\-autoscale <0\-3> (FreeType only)
2407 Sets the autoscale mode.
2409 .I NOTE:
2410 0 means that text scale and OSD scale are font heights in points.
2411 .sp 1
2412 The mode can be:
2413 .sp 1
2414 .PD 0
2415 .RSs
2416 .IPs 0
2417 no autoscale
2418 .IPs 1
2419 proportional to movie height
2420 .IPs 2
2421 proportional to movie width
2422 .IPs 3
2423 proportional to movie diagonal (default)
2425 .PD 1
2428 .B \-subfont\-blur <0\-8> (FreeType only)
2429 Sets the font blur radius (default: 2).
2432 .B \-subfont\-encoding <value> (FreeType only)
2433 Sets the font encoding.
2434 When set to 'unicode', all the glyphs from the font file will be rendered and
2435 unicode will be used (default: unicode).
2438 .B \-subfont\-osd\-scale <0\-100> (FreeType only)
2439 Sets the autoscale coefficient of the OSD elements (default: 6).
2442 .B \-subfont\-outline <0\-8> (FreeType only)
2443 Sets the font outline thickness (default: 2).
2446 .B \-subfont\-text\-scale <0\-100> (FreeType only)
2447 Sets the subtitle text autoscale coefficient as percentage of the
2448 screen size (default: 5).
2451 .B \-subfps <rate>
2452 Specify the framerate of the subtitle file (default: movie fps).
2454 .I NOTE:
2455 <rate> > movie fps speeds the subtitles up for frame-based subtitle files and
2456 slows them down for time-based ones.
2459 .B \-subpos <0\-100> (useful with \-vf expand)
2460 Specify the position of subtitles on the screen.
2461 The value is the vertical position of the subtitle in % of the screen height.
2464 .B \-subwidth <10\-100>
2465 Specify the maximum width of subtitles on the screen.
2466 Useful for TV-out.
2467 The value is the width of the subtitle in % of the screen width.
2470 .B \-noterm\-osd
2471 Disable the display of OSD messages on the console when no video output is
2472 available.
2475 .B \-term\-osd\-esc <escape sequence>
2476 Specify the escape sequence to use before writing an OSD message on the
2477 console.
2478 The escape sequence should move the pointer to the beginning of the line
2479 used for the OSD and clear it (default: ^[[A\\r^[[K).
2482 .B \-unicode
2483 Tells MPlayer to handle the subtitle file as unicode.
2486 .B \-unrarexec <path to unrar executable> (does not support MingW currently.)
2487 Specify the path to the unrar executable so MPlayer can use it to access
2488 rar-compressed vobsub files (default: not set, so the feature is off).
2489 The path must include the executable's filename, i.e.\& /usr/local/bin/unrar.
2492 .B "\-utf8 \ \ "
2493 Tells MPlayer to handle the subtitle file as UTF-8.
2496 .B \-vobsub <VOBsub file without extension>
2497 Specify a VOBsub file to use for subtitles.
2498 Has to be the full pathname without extension, i.e.\& without
2499 the '.idx', '.ifo' or '.sub'.
2502 .B \-vobsubid <0\-31>
2503 Specify the VOBsub subtitle ID.
2507 .SH "AUDIO OUTPUT OPTIONS (MPLAYER ONLY)"
2510 .B \-abs <value> (\-ao oss only) (OBSOLETE)
2511 Override audio driver/\:card buffer size detection.
2514 .B \-format <format> (also see the format audio filter)
2515 Select the sample format used for output from the audio filter
2516 layer to the sound card.
2517 The values that <format> can adopt are listed below in the
2518 description of the format audio filter.
2521 .B \-mixer <device>
2522 Use a mixer device different from the default /dev/\:mixer.
2523 For ALSA this is the mixer name.
2526 .B \-mixer\-channel <mixer line>[,mixer index] (\-ao oss and \-ao alsa only)
2527 This option will tell MPlayer to use a different channel for controlling
2528 volume than the default PCM.
2529 Options for OSS include
2530 .B vol, pcm, line.
2531 For a complete list of options look for SOUND_DEVICE_NAMES in
2532 /usr/\:include/\:linux/\:soundcard.h.
2533 For ALSA you can use the names e.g.\& alsamixer displays, like
2534 .B Master, Line, PCM.
2536 .I NOTE:
2537 ALSA mixer channel names followed by a number must be specified in the
2538 <name,number> format, i.e.\& a channel labeled 'PCM 1' in alsamixer must
2539 be converted to
2540 .BR PCM,1 .
2543 .B \-softvol
2544 Force the use of the software mixer, instead of using the sound card
2545 mixer.
2548 .B \-softvol\-max <10.0\-10000.0>
2549 Set the maximum amplification level in percent (default: 110).
2550 A value of 200 will allow you to adjust the volume up to a maximum of
2551 double the current level.
2552 With values below 100 the initial volume (which is 100%) will be above
2553 the maximum, which e.g.\& the OSD cannot display correctly.
2556 .B \-volstep <0\-100>
2557 Set the step size of mixer volume changes in percent of the whole range
2558 (default: 3).
2562 .SH "AUDIO OUTPUT DRIVERS (MPLAYER ONLY)"
2563 Audio output drivers are interfaces to different audio output facilities.
2564 The syntax is:
2567 .B \-ao <driver1[:suboption1[=value]:...],driver2,...[,]>
2568 Specify a priority list of audio output drivers to be used.
2570 If the list has a trailing ',' MPlayer will fall back on drivers not
2571 contained in the list.
2572 Suboptions are optional and can mostly be omitted.
2574 .I NOTE:
2575 See \-ao help for a list of compiled-in audio output drivers.
2576 .sp 1
2577 .I EXAMPLE:
2578 .PD 0
2579 .RSs
2580 .IPs "\-ao alsa,oss,"
2581 Try the ALSA driver, then the OSS driver, then others.
2582 .IPs "\-ao alsa:noblock:device=hw=0.3"
2583 Sets noblock-mode and the device-name as first card, fourth device.
2585 .PD 1
2586 .sp 1
2587 Available audio output drivers are:
2590 .B "alsa\ \ \ "
2591 ALSA 0.9/1.x audio output driver
2592 .PD 0
2593 .RSs
2594 .IPs noblock
2595 Sets noblock-mode.
2596 .IPs device=<device>
2597 Sets the device name.
2598 Replace any ',' with '.' and any ':' with '=' in the ALSA device name.
2599 For hwac3 output via S/PDIF, use an "iec958" or "spdif" device, unless
2600 you really know how to set it correctly.
2602 .PD 1
2605 .B "alsa5\ \ "
2606 ALSA 0.5 audio output driver
2609 .B "oss\ \ \ \ "
2610 OSS audio output driver
2611 .PD 0
2612 .RSs
2613 .IPs <dsp-device>
2614 Sets the audio output device (default: /dev/\:dsp).
2615 .IPs <mixer-device>
2616 Sets the audio mixer device (default: /dev/\:mixer).
2617 .IPs <mixer-channel>
2618 Sets the audio mixer channel (default: pcm).
2620 .PD 1
2623 .B sdl (SDL only)
2624 highly platform independent SDL (Simple Directmedia Layer) library
2625 audio output driver
2626 .PD 0
2627 .RSs
2628 .IPs <driver>
2629 Explicitly choose the SDL audio driver to use (default: let SDL choose).
2631 .PD 1
2634 .B "arts\ \ \ "
2635 audio output through the aRts daemon
2638 .B "esd\ \ \ \ "
2639 audio output through the ESD daemon
2640 .PD 0
2641 .RSs
2642 .IPs <server>
2643 Explicitly choose the ESD server to use (default: localhost).
2645 .PD 1
2648 .B "jack\ \ \ \ "
2649 audio output through JACK (Jack Audio Connection Kit)
2650 .PD 0
2651 .RSs
2652 .IPs port=<name>
2653 Connects to the ports with the given name (default: physical ports).
2654 .IPs name=<client name>
2655 Client name that is passed to JACK (default: MPlayer [<PID>]).
2656 Useful if you want to have certain connections established automatically.
2657 .IPs (no)estimate
2658 Estimate the audio delay, supposed to make the video playback smoother
2659 (default: enabled).
2661 .PD 1
2664 .B "nas\ \ \ \ "
2665 audio output through NAS
2668 .B macosx (Mac OS X only)
2669 native Mac OS X audio output driver
2672 .B "openal\ "
2673 Experimental OpenAL audio output driver
2676 .B "pulse\ \ "
2677 PulseAudio audio output driver
2678 .PD 0
2679 .RSs
2680 .IPs "[<host>][:<output sink>]"
2681 Specify the host and optionally output sink to use.
2682 An empty <host> string uses a local connection, "localhost"
2683 uses network transfer (most likely not what you want).
2685 .PD 1
2688 .B sgi (SGI only)
2689 native SGI audio output driver
2690 .PD 0
2691 .RSs
2692 .IPs "<output device name>"
2693 Explicitly choose the output device/\:interface to use
2694 (default: system-wide default).
2695 For example, 'Analog Out' or 'Digital Out'.
2697 .PD 1
2700 .B sun (Sun only)
2701 native Sun audio output driver
2702 .PD 0
2703 .RSs
2704 .IPs <device>
2705 Explicitly choose the audio device to use (default: /dev/\:audio).
2707 .PD 1
2710 .B win32 (Windows only)
2711 native Windows waveout audio output driver
2714 .B dsound (Windows only)
2715 DirectX DirectSound audio output driver
2716 .PD 0
2717 .RSs
2718 .IPs device=<devicenum>
2719 Sets the device number to use.
2720 Playing a file with \-v will show a list of available devices.
2722 .PD 1
2725 .B dxr2 (also see \-dxr2) (DXR2 only)
2726 Creative DXR2 specific output driver
2729 .B ivtv (IVTV only)
2730 IVTV specific MPEG audio output driver.
2731 Works with \-ac hwmpa only.
2734 .B v4l2 (requires Linux 2.6.22+ kernel)
2735 Audio output driver for V4L2 cards with hardware MPEG decoder.
2738 .B mpegpes (DVB only)
2739 Audio output driver for DVB cards that writes the output to an MPEG-PES
2740 file if no DVB card is installed.
2741 .PD 0
2742 .RSs
2743 .IPs card=<1\-4>
2744 DVB card to use if more than one card is present.
2745 If not specified mplayer will search the first usable card.
2746 .IPs file=<filename>
2747 output filename
2749 .PD 1
2752 .B "null\ \ \ "
2753 Produces no audio output but maintains video playback speed.
2754 Use \-nosound for benchmarking.
2757 .B "pcm\ \ \ \ "
2758 raw PCM/wave file writer audio output
2759 .PD 0
2760 .RSs
2761 .IPs (no)waveheader
2762 Include or do not include the wave header (default: included).
2763 When not included, raw PCM will be generated.
2764 .IPs file=<filename>
2765 Write the sound to <filename> instead of the default
2766 audiodump.wav.
2767 If nowaveheader is specified, the default is audiodump.pcm.
2768 .IPs "fast\ "
2769 Try to dump faster than realtime.
2770 Make sure the output does not get truncated (usually with
2771 "Too many video packets in buffer" message).
2772 It is normal that you get a "Your system is too SLOW to play this!" message.
2774 .PD 1
2777 .B "plugin\ \ "
2778 plugin audio output driver
2782 .SH "VIDEO OUTPUT OPTIONS (MPLAYER ONLY)"
2785 .B \-adapter <value>
2786 Set the graphics card that will receive the image.
2787 You can get a list of available cards when you run this option with \-v.
2788 Currently only works with the directx video output driver.
2791 .B \-bpp <depth>
2792 Override the autodetected color depth.
2793 Only supported by the fbdev, dga, svga, vesa video output drivers.
2796 .B \-border
2797 Play movie with window border and decorations.
2798 Since this is on by default, use \-noborder to disable the standard window
2799 decorations.
2800 Supported by the directx video output driver.
2803 .B \-brightness <\-100\-100>
2804 Adjust the brightness of the video signal (default: 0).
2805 Not supported by all video output drivers.
2808 .B \-contrast <\-100\-100>
2809 Adjust the contrast of the video signal (default: 0).
2810 Not supported by all video output drivers.
2813 .B \-display <name> (X11 only)
2814 Specify the hostname and display number of the X server you want to display
2816 .sp 1
2817 .I EXAMPLE:
2818 .PD 0
2819 .RSs
2820 \-display xtest.localdomain:0
2822 .PD 1
2825 .B "\-dr \ \ \ "
2826 Turns on direct rendering (not supported by all codecs and video outputs)
2828 .I WARNING:
2829 May cause OSD/SUB corruption!
2832 .B \-dxr2 <option1:option2:...>
2833 This option is used to control the dxr2 video output driver.
2834 .RSs
2835 .IPs ar-mode=<value>
2836 aspect ratio mode (0 = normal, 1 = pan-and-scan, 2 = letterbox (default))
2837 .IPs iec958-encoded
2838 Set iec958 output mode to encoded.
2839 .IPs iec958-decoded
2840 Set iec958 output mode to decoded (default).
2841 .IPs macrovision=<value>
2842 macrovision mode (0 = off (default), 1 = agc, 2 = agc 2 colorstripe,
2843 3 = agc 4 colorstripe)
2844 .IPs "mute\ "
2845 mute sound output
2846 .IPs unmute
2847 unmute sound output
2848 .IPs ucode=<value>
2849 path to the microcode
2852 .sp 1
2853 .I TV output
2855 .RSs
2856 .IPs 75ire
2857 enable 7.5 IRE output mode
2858 .IPs no75ire
2859 disable 7.5 IRE output mode (default)
2860 .IPs "bw\ \ \ "
2861 b/w TV output
2862 .IPs color
2863 color TV output (default)
2864 .IPs interlaced
2865 interlaced TV output (default)
2866 .IPs nointerlaced
2867 disable interlaced TV output
2868 .IPs norm=<value>
2869 TV norm (ntsc (default), pal, pal60, palm, paln, palnc)
2870 .IPs square-pixel
2871 set pixel mode to square
2872 .IPs ccir601-pixel
2873 set pixel mode to ccir601
2876 .sp 1
2877 .I overlay
2879 .RSs
2880 .IPs cr-left=<0\-500>
2881 Set the left cropping value (default: 50).
2882 .IPs cr-right=<0\-500>
2883 Set the right cropping value (default: 300).
2884 .IPs cr-top=<0\-500>
2885 Set the top cropping value (default: 0).
2886 .IPs cr-bottom=<0\-500>
2887 Set the bottom cropping value (default: 0).
2888 .IPs ck-[r|g|b]=<0\-255>
2889 Set the r(ed), g(reen) or b(lue) gain of the overlay color-key.
2890 .IPs ck-[r|g|b]min=<0\-255>
2891 minimum value for the respective color key
2892 .IPs ck-[r|g|b]max=<0\-255>
2893 maximum value for the respective color key
2894 .IPs ignore-cache
2895 Ignore cached overlay settings.
2896 .IPs update-cache
2897 Update cached overlay settings.
2898 .IPs ol-osd
2899 Enable overlay onscreen display.
2900 .IPs nool-osd
2901 Disable overlay onscreen display (default).
2902 .IPs ol[h|w|x|y]-cor=<\-20\-20>
2903 Adjust the overlay size (h,w) and position (x,y) in case it does not
2904 match the window perfectly (default: 0).
2905 .IPs overlay
2906 Activate overlay (default).
2907 .IPs nooverlay
2908 Activate TVout.
2909 .IPs overlay-ratio=<1\-2500>
2910 Tune the overlay (default: 1000).
2914 .B \-fbmode <modename> (\-vo fbdev only)
2915 Change video mode to the one that is labeled as <modename> in
2916 /etc/\:fb.modes.
2918 .I NOTE:
2919 VESA framebuffer does not support mode changing.
2922 .B \-fbmodeconfig <filename> (\-vo fbdev only)
2923 Override framebuffer mode configuration file (default: /etc/\:fb.modes).
2926 .B \-fs (also see \-zoom)
2927 Fullscreen playback (centers movie, and paints black bands around it).
2928 Not supported by all video output drivers.
2931 .B \-fsmode\-dontuse <0\-31> (OBSOLETE, use the \-fs option)
2932 Try this option if you still experience fullscreen problems.
2935 .B \-fstype <type1,type2,...> (X11 only)
2936 Specify a priority list of fullscreen modes to be used.
2937 You can negate the modes by prefixing them with '\-'.
2938 If you experience problems like the fullscreen window being covered
2939 by other windows try using a different order.
2941 .I NOTE:
2942 See \-fstype help for a full list of available modes.
2943 .sp 1
2944 The available types are:
2945 .sp 1
2946 .PD 0
2947 .RSs
2948 .IPs above
2949 Use the _NETWM_STATE_ABOVE hint if available.
2950 .IPs below
2951 Use the _NETWM_STATE_BELOW hint if available.
2952 .IPs fullscreen
2953 Use the _NETWM_STATE_FULLSCREEN hint if available.
2954 .IPs layer
2955 Use the _WIN_LAYER hint with the default layer.
2956 .IPs layer=<0...15>
2957 Use the _WIN_LAYER hint with the given layer number.
2958 .IPs netwm
2959 Force NETWM style.
2960 .IPs "none\ "
2961 Do not set fullscreen window layer.
2962 .IPs stays_on_top
2963 Use _NETWM_STATE_STAYS_ON_TOP hint if available.
2964 .REss
2965 .sp 1
2967 .I EXAMPLE:
2969 .PD 0
2970 .RSs
2971 .IPs layer,stays_on_top,above,fullscreen
2972 Default order, will be used as a fallback if incorrect or
2973 unsupported modes are specified.
2974 .IPs \-fullscreen
2975 Fixes fullscreen switching on OpenBox 1.x.
2977 .PD 1
2980 .B \-geometry x[%][:y[%]] or [WxH][+x+y]
2981 Adjust where the output is on the screen initially.
2982 The x and y specifications are in pixels measured from the top-left of the
2983 screen to the top-left of the image being displayed, however if a percentage
2984 sign is given after the argument it turns the value into a percentage of the
2985 screen size in that direction.
2986 It also supports the standard X11 \-geometry option format.
2987 If an external window is specified using the \-wid option, then the x and
2988 y coordinates are relative to the top-left corner of the window rather
2989 than the screen.
2991 .I NOTE:
2992 This option is only supported by the x11, xmga, xv, xvmc, xvidix,
2993 gl, gl2, directx and tdfxfb video output drivers.
2994 .sp 1
2995 .I EXAMPLE:
2996 .PD 0
2997 .RSs
2998 .IPs 50:40
2999 Places the window at x=50, y=40.
3000 .IPs 50%:50%
3001 Places the window in the middle of the screen.
3002 .IPs "100%\ "
3003 Places the window at the middle of the right edge of the screen.
3004 .IPs 100%:100%
3005 Places the window at the bottom right corner of the screen.
3007 .PD 1
3010 .B \-guiwid <window ID> (also see \-wid) (GUI only)
3011 This tells the GUI to also use an X11 window and stick itself to the bottom
3012 of the video, which is useful to embed a mini-GUI in a browser (with the
3013 MPlayer plugin for instance).
3016 .B \-hue <\-100\-100>
3017 Adjust the hue of the video signal (default: 0).
3018 You can get a colored negative of the image with this option.
3019 Not supported by all video output drivers.
3022 .B \-monitor\-dotclock <range[,range,...]> (\-vo fbdev and vesa only)
3023 Specify the dotclock or pixelclock range of the monitor.
3026 .B \-monitor\-hfreq <range[,range,...]> (\-vo fbdev and vesa only)
3027 Specify the horizontal frequency range of the monitor.
3030 .B \-monitor\-vfreq <range[,range,...]> (\-vo fbdev and vesa only)
3031 Specify the vertical frequency range of the monitor.
3034 .B \-monitoraspect <ratio> (also see \-aspect)
3035 Set the aspect ratio of your monitor or TV screen.
3036 A value of 0 disables a previous setting (e.g.\& in the config file).
3037 Overrides the \-monitorpixelaspect setting if enabled.
3038 .sp 1
3039 .I EXAMPLE:
3040 .PD 0
3041 .RSs
3042 \-monitoraspect 4:3  or 1.3333
3044 \-monitoraspect 16:9 or 1.7777
3046 .PD 1
3049 .B \-monitorpixelaspect <ratio> (also see \-aspect)
3050 Set the aspect of a single pixel of your monitor or TV screen (default: 1).
3051 A value of 1 means square pixels
3052 (correct for (almost?) all LCDs).
3055 .B \-nodouble
3056 Disables double buffering, mostly for debugging purposes.
3057 Double buffering fixes flicker by storing two frames in memory, and
3058 displaying one while decoding another.
3059 It can affect OSD negatively, but often removes OSD flickering.
3062 .B \-nograbpointer
3063 Do not grab the mouse pointer after a video mode change (\-vm).
3064 Useful for multihead setups.
3067 .B \-nokeepaspect
3068 Do not keep window aspect ratio when resizing windows.
3069 Only works with the x11, xv, xmga, xvidix, directx video output drivers.
3070 Furthermore under X11 your window manager has to honor window aspect hints.
3073 .B "\-ontop\ "
3074 Makes the player window stay on top of other windows.
3075 Supported by video output drivers which use X11, except SDL,
3076 as well as directx, macosx, quartz, ggi and gl2.
3079 .B \-panscan <0.0\-1.0>
3080 Enables pan-and-scan functionality (cropping the sides of e.g.\& a 16:9
3081 movie to make it fit a 4:3 display without black bands).
3082 The range controls how much of the image is cropped.
3083 Only works with the xv, xmga, mga, gl, gl2, quartz, macosx and xvidix
3084 video output drivers.
3086 .I NOTE:
3087 Values between \-1 and 0 are allowed as well, but highly experimental
3088 and may crash or worse.
3089 Use at your own risk!
3092 .B \-panscanrange <\-19.0\-99.0> (experimental)
3093 Change the range of the pan-and-scan functionality (default: 1).
3094 Positive values mean multiples of the default range.
3095 Negative numbers mean you can zoom in up to a factor of \-panscanrange+1.
3096 E.g. \-panscanrange \-3 allows a zoom factor of up to 4.
3097 This feature is experimental.
3098 Do not report bugs unless you are using \-vo gl.
3101 .B \-refreshrate <Hz>
3102 Set the monitor refreshrate in Hz.
3103 Currently only supported by \-vo directx combined with the \-vm option.
3106 .B \-rootwin
3107 Play movie in the root window (desktop background).
3108 Desktop background images may cover the movie window, though.
3109 Only works with the x11, xv, xmga, xvidix, quartz, macosx and directx video output drivers.
3112 .B \-saturation <\-100\-100>
3113 Adjust the saturation of the video signal (default: 0).
3114 You can get grayscale output with this option.
3115 Not supported by all video output drivers.
3118 .B \-screenh <pixels>
3119 Specify the vertical screen resolution for video output drivers which
3120 do not know the screen resolution like fbdev, x11 and TVout.
3123 .B \-screenw <pixels>
3124 Specify the horizontal screen resolution for video output drivers which
3125 do not know the screen resolution like fbdev, x11 and TVout.
3128 .B \-stop\-xscreensaver (X11 only)
3129 Turns off xscreensaver at startup and turns it on again on exit.
3132 .B "\-vm \ \ \ "
3133 Try to change to a different video mode.
3134 Supported by the dga, x11, xv, sdl and directx video output drivers.
3135 If used with the directx video output driver the \-screenw,
3136 \-screenh, \-bpp and \-refreshrate options can be used to set
3137 the new display mode.
3140 .B "\-vsync \ \ "
3141 Enables VBI for the vesa, dfbmga and svga video output drivers.
3144 .B \-wid <window ID> (also see \-guiwid) (X11, OpenGL and DirectX only)
3145 This tells MPlayer to attach to an existing window.
3146 Useful to embed MPlayer in a browser (e.g.\& the plugger extension).
3149 .B \-xineramascreen <\-2\-...> (X11 only)
3150 In Xinerama configurations (i.e.\& a single desktop that spans across multiple
3151 displays) this option tells MPlayer which screen to display the movie on.
3152 A value of \-2 means fullscreen across the whole virtual display (in this case
3153 Xinerama information is completely ignored), \-1 means
3154 fullscreen on the display the window currently is on.
3155 The initial position set via the \-geometry option is relative to the
3156 specified screen.
3157 Will usually only work with "\-fstype \-fullscreen" or "\-fstype none".
3160 .B \-zrbw (\-vo zr only)
3161 Display in black and white.
3162 For optimal performance, this can be combined with '\-lavdopts gray'.
3165 .B \-zrcrop <[width]x[height]+[x offset]+[y offset]> (\-vo zr only)
3166 Select a part of the input image to display, multiple occurrences
3167 of this option switch on cinerama mode.
3168 In cinerama mode the movie is distributed over more than one TV
3169 (or beamer) to create a larger image.
3170 Options appearing after the n-th \-zrcrop apply to the n-th MJPEG card, each
3171 card should at least have a \-zrdev in addition to the \-zrcrop.
3172 For examples, see the output of \-zrhelp and the Zr section of the
3173 documentation.
3176 .B \-zrdev <device> (\-vo zr only)
3177 Specify the device special file that belongs to your MJPEG card, by default
3178 the zr video output driver takes the first v4l device it can find.
3181 .B \-zrfd (\-vo zr only)
3182 Force decimation: Decimation, as specified by \-zrhdec and \-zrvdec, only
3183 happens if the hardware scaler can stretch the image to its original size.
3184 Use this option to force decimation.
3187 .B \-zrhdec <1|2|4> (\-vo zr only)
3188 Horizontal decimation: Ask the driver to send only every 2nd or 4th
3189 line/\:pixel of the input image to the MJPEG card and use the scaler
3190 of the MJPEG card to stretch the image to its original size.
3193 .B \-zrhelp (\-vo zr only)
3194 Display a list of all \-zr* options, their default values and a
3195 cinerama mode example.
3198 .B \-zrnorm <norm> (\-vo zr only)
3199 Specify the TV norm as PAL or NTSC (default: no change).
3202 .B \-zrquality <1\-20> (\-vo zr only)
3203 A number from 1 (best) to 20 (worst) representing the JPEG encoding quality.
3206 .B \-zrvdec <1|2|4> (\-vo zr only)
3207 Vertical decimation: Ask the driver to send only every 2nd or 4th
3208 line/\:pixel of the input image to the MJPEG card and use the scaler
3209 of the MJPEG card to stretch the image to its original size.
3212 .B \-zrxdoff <x display offset> (\-vo zr only)
3213 If the movie is smaller than the TV screen, this option specifies the x
3214 offset from the upper-left corner of the TV screen (default: centered).
3217 .B \-zrydoff <y display offset> (\-vo zr only)
3218 If the movie is smaller than the TV screen, this option specifies the y
3219 offset from the upper-left corner of the TV screen (default: centered).
3223 .SH "VIDEO OUTPUT DRIVERS (MPLAYER ONLY)"
3224 Video output drivers are interfaces to different video output facilities.
3225 The syntax is:
3228 .B \-vo <driver1[:suboption1[=value]:...],driver2,...[,]>
3229 Specify a priority list of video output drivers to be used.
3231 If the list has a trailing ',' MPlayer will fall back on drivers not
3232 contained in the list.
3233 Suboptions are optional and can mostly be omitted.
3235 .I NOTE:
3236 See \-vo help for a list of compiled-in video output drivers.
3237 .sp 1
3238 .I EXAMPLE:
3239 .PD 0
3240 .RSs
3241 .IPs "\-vo xmga,xv,"
3242 Try the Matrox X11 driver, then the Xv driver, then others.
3243 .IPs "\-vo directx:noaccel"
3244 Uses the DirectX driver with acceleration features turned off.
3246 .PD 1
3247 .sp 1
3248 Available video output drivers are:
3251 .B xv (X11 only)
3252 Uses the XVideo extension of XFree86 4.x to enable hardware
3253 accelerated playback.
3254 If you cannot use a hardware specific driver, this is probably
3255 the best option.
3256 For information about what colorkey is used and how it is drawn run MPlayer
3257 with \-v option and look out for the lines tagged with [xv common] at the
3258 beginning.
3259 .PD 0
3260 .RSs
3261 .IPs port=<number>
3262 Select a specific XVideo port.
3263 .IPs ck=<cur|use|set>
3264 Select the source from which the colorkey is taken (default: cur).
3265 .RSss
3266 .IPs cur
3267 The default takes the colorkey currently set in Xv.
3268 .IPs use
3269 Use but do not set the colorkey from MPlayer (use \-colorkey option to change
3270 it).
3271 .IPs set
3272 Same as use but also sets the supplied colorkey.
3274 .IPs ck-method=<man|bg|auto>
3275 Sets the colorkey drawing method (default: man).
3276 .RSss
3277 .IPs man
3278 Draw the colorkey manually (reduces flicker in some cases).
3279 .IPs bg
3280 Set the colorkey as window background.
3281 .IPs auto
3282 Let Xv draw the colorkey.
3285 .PD 1
3288 .B x11 (X11 only)
3289 Shared memory video output driver without hardware acceleration that
3290 works whenever X11 is present.
3293 .B xover (X11 only)
3294 Adds X11 support to all overlay based video output drivers.
3295 Currently only supported by tdfx_vid.
3296 .PD 0
3297 .RSs
3298 .IPs <vo_driver>
3299 Select the driver to use as source to overlay on top of X11.
3301 .PD 1
3304 .B xvmc (X11 with \-vc ffmpeg12mc only)
3305 Video output driver that uses the XvMC (X Video Motion Compensation)
3306 extension of XFree86 4.x to speed up MPEG-1/2 and VCR2 decoding.
3307 .PD 0
3308 .RSs
3309 .IPs port=<number>
3310 Select a specific XVideo port.
3311 .IPs (no)benchmark
3312 Disables image display.
3313 Necessary for proper benchmarking of drivers that change
3314 image buffers on monitor retrace only (nVidia).
3315 Default is not to disable image display (nobenchmark).
3316 .IPs (no)bobdeint
3317 Very simple deinterlacer.
3318 Might not look better than \-vf tfields=1,
3319 but it is the only deinterlacer for xvmc (default: nobobdeint).
3320 .IPs (no)queue
3321 Queue frames for display to allow more parallel work of the video hardware.
3322 May add a small (not noticeable) constant A/V desync (default: noqueue).
3323 .IPs (no)sleep
3324 Use sleep function while waiting for rendering to finish
3325 (not recommended on Linux) (default: nosleep).
3326 .IPs ck=cur|use|set
3327 Same as \-vo xv:ck (see \-vo xv).
3328 .IPs ck-method=man|bg|auto
3329 Same as \-vo xv:ck-method (see \-vo xv).
3331 .PD 1
3334 .B dga (X11 only)
3335 Play video through the XFree86 Direct Graphics Access extension.
3336 Considered obsolete.
3339 .B sdl (SDL only)
3340 Highly platform independent SDL (Simple Directmedia Layer) library
3341 video output driver.
3342 Since SDL uses its own X11 layer, MPlayer X11 options do not have
3343 any effect on SDL.
3344 .PD 0
3345 .RSs
3346 .IPs driver=<driver>
3347 Explicitly choose the SDL driver to use.
3348 .IPs (no)forcexv
3349 Use XVideo through the sdl video output driver (default: forcexv).
3350 .IPs (no)hwaccel
3351 Use hardware accelerated scaler (default: hwaccel).
3353 .PD 1
3356 .B "vidix\ \ "
3357 VIDIX (VIDeo Interface for *niX) is an interface to the
3358 video acceleration features of different graphics cards.
3359 Very fast video output driver on cards that support it.
3360 .PD 0
3361 .RSs
3362 .IPs <subdevice>
3363 Explicitly choose the VIDIX subdevice driver to use.
3364 Available subdevice drivers are cyberblade, mach64,
3365 mga_crtc2, mga, nvidia, pm2, pm3, radeon, rage128, sis_vid and unichrome.
3367 .PD 1
3370 .B xvidix (X11 only)
3371 X11 frontend for VIDIX
3372 .PD 0
3373 .RSs
3374 .IPs <subdevice>
3375 same as vidix
3377 .PD 1
3380 .B "cvidix\ "
3381 Generic and platform independent VIDIX frontend, can even run in a
3382 text console with nVidia cards.
3383 .PD 0
3384 .RSs
3385 .IPs <subdevice>
3386 same as vidix
3388 .PD 1
3391 .B winvidix (Windows only)
3392 Windows frontend for VIDIX
3393 .PD 0
3394 .RSs
3395 .IPs <subdevice>
3396 same as vidix
3398 .PD 1
3401 .B directx (Windows only)
3402 Video output driver that uses the DirectX interface.
3403 .PD 0
3404 .RSs
3405 .IPs noaccel
3406 Turns off hardware acceleration.
3407 Try this option if you have display problems.
3409 .PD 1
3412 .B quartz (Mac OS X only)
3413 Mac OS X Quartz video output driver.
3414 Under some circumstances, it might be more efficient to force a
3415 packed YUV output format, with e.g.\& \-vf format=yuy2.
3416 .PD 0
3417 .RSs
3418 .IPs device_id=<number>
3419 Choose the display device to use in fullscreen.
3420 .IPs fs_res=<width>:<height>
3421 Specify the fullscreen resolution (useful on slow systems).
3423 .PD 1
3426 .B macosx (Mac OS X 10.4 or 10.3.9 with QuickTime 7)
3427 Mac OS X CoreVideo video output driver
3428 .PD 0
3429 .RSs
3430 .IPs device_id=<number>
3431 Choose the display device to use in fullscreen.
3433 .PD 1
3436 .B fbdev (Linux only)
3437 Uses the kernel framebuffer to play video.
3438 .PD 0
3439 .RSs
3440 .IPs <device>
3441 Explicitly choose the fbdev device name to use (e.g.\& /dev/\:fb0) or the
3442 name of the VIDIX subdevice if the device name starts with 'vidix'
3443 (e.g.\& 'vidixsis_vid' for the sis driver).
3445 .PD 1
3448 .B fbdev2 (Linux only)
3449 Uses the kernel framebuffer to play video,
3450 alternative implementation.
3451 .PD 0
3452 .RSs
3453 .IPs <device>
3454 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3456 .PD 1
3459 .B "vesa\ \ \ "
3460 Very general video output driver that should work on any VESA VBE 2.0
3461 compatible card.
3462 .PD 0
3463 .RSs
3464 .IPs (no)dga
3465 Turns DGA mode on or off (default: on).
3466 .IPs neotv_pal
3467 Activate the NeoMagic TV out and set it to PAL norm.
3468 .IPs neotv_ntsc
3469 Activate the NeoMagic TV out and set it to NTSC norm.
3470 .IPs vidix
3471 Use the VIDIX driver.
3472 .IPs "lvo:\ \ \ "
3473 Activate the Linux Video Overlay on top of VESA mode.
3475 .PD 1
3478 .B "svga\ \ \ "
3479 Play video using the SVGA library.
3480 .PD 0
3481 .RSs
3482 .IPs "<video mode>"
3483 Specify video mode to use.
3484 The mode can be given in a <width>x<height>x<colors> format,
3485 e.g.\& 640x480x16M or be a graphics mode number, e.g.\& 84.
3486 .IPs bbosd
3487 Draw OSD into black bands below the movie (slower).
3488 .IPs native
3489 Use only native drawing functions.
3490 This avoids direct rendering, OSD and hardware acceleration.
3491 .IPs retrace
3492 Force frame switch on vertical retrace.
3493 Usable only with \-double.
3494 It has the same effect as the \-vsync option.
3495 .IPs "sq\ \ \ "
3496 Try to select a video mode with square pixels.
3497 .IPs vidix
3498 Use svga with VIDIX.
3500 .PD 1
3503 .B "gl\ \ \ \ \ "
3504 OpenGL video output driver, simple version.
3505 Video size must be smaller than
3506 the maximum texture size of your OpenGL implementation.
3507 Intended to work even with the most basic OpenGL implementations,
3508 but also makes use of newer extensions, which allow support for more
3509 colorspaces and direct rendering.
3510 Please use \-dr if it works with your OpenGL implementation,
3511 since for higher resolutions this provides a
3512 .B big
3513 speedup.
3514 The code performs very few checks, so if a feature does not work, this
3515 might be because it is not supported by your card/OpenGL implementation
3516 even if you do not get any error message.
3517 Use glxinfo or a similar tool to display the supported OpenGL extensions.
3518 .PD 0
3519 .RSs
3520 .IPs (no)scaled-osd
3521 Changes the way the OSD behaves when the size of the
3522 window changes (default: disabled).
3523 When enabled behaves more like the other video output drivers,
3524 which is better for fixed-size fonts.
3525 Disabled looks much better with FreeType fonts and uses the
3526 borders in fullscreen mode.
3527 Does not work correctly with ass subtitles (see \-ass), you can instead
3528 render them without OpenGL support via \-vf ass.
3529 .IPs osdcolor=<0xRRGGBB>
3530 Color for OSD (default: 0xffffff, corresponds to white).
3531 .IPs rectangle=<0,1,2>
3532 Select usage of rectangular textures which saves video RAM, but often is
3533 slower (default: 0).
3534 .RSss
3535 0: Use power-of-two textures (default).
3537 1: Use the GL_ARB_texture_rectangle extension.
3539 2: Use the GL_ARB_texture_non_power_of_two extension.
3540 In some cases only supported in software and thus very slow.
3542 .IPs swapinterval=<n>
3543 Minimum interval between two buffer swaps, counted in
3544 displayed frames (default: 1).
3545 1 is equivalent to enabling VSYNC, 0 to disabling VSYNC.
3546 Values below 0 will leave it at the system default.
3547 This limits the framerate to (horizontal refresh rate / n).
3548 Requires GLX_SGI_swap_control support to work.
3549 With some (most/all?) implementations this only works in fullscreen mode.
3550 .IPs yuv=<n>
3551 Select the type of YUV to RGB conversion.
3552 .RSss
3553 0: Use software conversion (default).
3554 Compatible with all OpenGL versions.
3555 Provides brightness, contrast and saturation control.
3557 1: Use register combiners.
3558 This uses an nVidia-specific extension (GL_NV_register_combiners).
3559 At least three texture units are needed.
3560 Provides saturation and hue control.
3561 This method is fast but inexact.
3563 2: Use a fragment program.
3564 Needs the GL_ARB_fragment_program extension and at least three texture units.
3565 Provides brightness, contrast, saturation and hue control.
3567 3: Use a fragment program using the POW instruction.
3568 Needs the GL_ARB_fragment_program extension and at least three texture units.
3569 Provides brightness, contrast, saturation, hue and gamma control.
3570 Gamma can also be set independently for red, green and blue.
3571 Method 4 is usually faster.
3573 4: Use a fragment program with additional lookup.
3574 Needs the GL_ARB_fragment_program extension and at least four texture units.
3575 Provides brightness, contrast, saturation, hue and gamma control.
3576 Gamma can also be set independently for red, green and blue.
3578 5: Use ATI-specific method (for older cards).
3579 This uses an ATI-specific extension (GL_ATI_fragment_shader \- not
3580 GL_ARB_fragment_shader!).
3581 At least three texture units are needed.
3582 Provides saturation and hue control.
3583 This method is fast but inexact.
3585 6: Use a 3D texture to do conversion via lookup.
3586 Needs the GL_ARB_fragment_program extension and at least four texture units.
3587 Extremely slow (software emulation) on some (all?) ATI cards since it uses
3588 a texture with border pixels.
3589 Provides brightness, contrast, saturation, hue and gamma control.
3590 Gamma can also be set independently for red, green and blue.
3591 Speed depends more on GPU memory bandwidth than other methods.
3593 .IPs lscale=<n>
3594 Select the scaling function to use for luminance scaling.
3595 Only valid for yuv modes 2, 3, 4 and 6.
3596 .RSss
3597 0: Use simple linear filtering (default).
3599 1: Use bicubic B-spline filtering (better quality).
3600 Needs one additional texture unit.
3601 Older cards will not be able to handle this for chroma at least in fullscreen mode.
3603 2: Use cubic filtering in horizontal, linear filtering in vertical direction.
3604 Works on a few more cards than method 1.
3606 .IPs cscale=<n>
3607 Select the scaling function to use for chrominance scaling.
3608 For details see lscale.
3609 .IPs customprog=<filename>
3610 Load a custom fragment program from <filename>.
3611 See TOOLS/edgedect.fp for an example.
3612 .IPs customtex=<filename>
3613 Load a custom "gamma ramp" texture from <filename>.
3614 This can be used in combination with yuv=4 or with the customprog option.
3615 .IPs (no)customtlin
3616 If enabled (default) use GL_LINEAR interpolation, otherwise use GL_NEAREST
3617 for customtex texture.
3618 .IPs (no)customtrect
3619 If enabled, use texture_rectangle for customtex texture.
3620 Default is disabled.
3622 .sp 1
3624 Normally there is no reason to use the following options, they mostly
3625 exist for testing purposes.
3627 .sp 1
3628 .RSs
3629 .IPs (no)glfinish
3630 Call glFinish() before swapping buffers.
3631 Slower but in some cases more correct output (default: disabled).
3632 .IPs (no)manyfmts
3633 Enables support for more (RGB and BGR) color formats (default: enabled).
3634 Needs OpenGL version >= 1.2.
3635 .IPs slice-height=<0\-...>
3636 Number of lines copied to texture in one piece (default: 0).
3637 0 for whole image.
3639 .I NOTE:
3640 If YUV colorspace is used (see yuv suboption), special rules apply:
3641 .RSss
3642 If the decoder uses slice rendering (see \-noslices), this setting
3643 has no effect, the size of the slices as provided by the decoder is used.
3645 If the decoder does not use slice rendering, the default is 16.
3647 .IPs (no)osd
3648 Enable or disable support for OSD rendering via OpenGL (default: enabled).
3649 This option is for testing; to disable the OSD use \-osdlevel 0 instead.
3650 .IPs (no)aspect
3651 Enable or disable aspect scaling and pan-and-scan support (default: enabled).
3652 Disabling might increase speed.
3653 .REss
3655 .PD 1
3658 .B "gl2\ \ \ \ "
3659 OpenGL video output driver, second generation.
3660 Supports OSD and videos larger than the maximum texture size.
3661 .PD 0
3662 .RSs
3663 .IPs (no)glfinish
3664 same as gl (default: enabled)
3665 .IPs yuv=<n>
3666 Select the type of YUV to RGB conversion.
3667 If set to anything except 0 OSD will be disabled and brightness, contrast and
3668 gamma setting is only available via the global X server settings.
3669 Apart from this the values have the same meaning as for \-vo gl.
3670 .REss
3673 .B "null\ \ \ "
3674 Produces no video output.
3675 Useful for benchmarking.
3678 .B "aa\ \ \ \ \ "
3679 ASCII art video output driver that works on a text console.
3680 You can get a list and an explanation of available suboptions
3681 by executing 'mplayer \-vo aa:help'.
3683 .I NOTE:
3684 The driver does not handle \-aspect correctly.
3686 .I HINT:
3687 You probably have to specify \-monitorpixelaspect.
3688 Try 'mplayer \-vo aa \-monitorpixelaspect 0.5'.
3691 .B "caca\ \ \ "
3692 Color ASCII art video output driver that works on a text console.
3695 .B "bl\ \ \ \ \ "
3696 Video playback using the Blinkenlights UDP protocol.
3697 This driver is highly hardware specific.
3698 .PD 0
3699 .RSs
3700 .IPs <subdevice>
3701 Explicitly choose the Blinkenlights subdevice driver to use.
3702 It is something like arcade:host=localhost:2323 or
3703 hdl:file=name1,file=name2.
3704 You must specify a subdevice.
3706 .PD 1
3709 .B "ggi\ \ \ \ "
3710 GGI graphics system video output driver
3711 .PD 0
3712 .RSs
3713 .IPs <driver>
3714 Explicitly choose the GGI driver to use.
3715 Replace any ',' that would appear in the driver string by a '.'.
3717 .PD 1
3720 .B directfb
3721 Play video using the DirectFB library.
3722 .PD 0
3723 .RSs
3724 .IPs (no)input
3725 Use the DirectFB instead of the MPlayer keyboard code (default: enabled).
3726 .IPs buffermode=single|double|triple
3727 Double and triple buffering give best results if you want to avoid tearing issues.
3728 Triple buffering is more efficient than double buffering as it does
3729 not block MPlayer while waiting for the vertical retrace.
3730 Single buffering should be avoided (default: single).
3731 .IPs fieldparity=top|bottom
3732 Control the output order for interlaced frames (default: disabled).
3733 Valid values are top = top fields first, bottom = bottom fields first.
3734 This option does not have any effect on progressive film material
3735 like most MPEG movies are.
3736 You need to enable this option if you have tearing issues or unsmooth
3737 motions watching interlaced film material.
3738 .IPs layer=N
3739 Will force layer with ID N for playback (default: \-1 \- auto).
3740 .IPs dfbopts=<list>
3741 Specify a parameter list for DirectFB.
3743 .PD 1
3746 .B "dfbmga\ "
3747 Matrox G400/\:G450/\:G550 specific video output driver that uses the
3748 DirectFB library to make use of special hardware features.
3749 Enables CRTC2 (second head), displaying video independently of the first head.
3750 .PD 0
3751 .RSs
3752 .IPs (no)input
3753 same as directfb (default: disabled)
3754 .IPs buffermode=single|double|triple
3755 same as directfb (default: triple)
3756 .IPs fieldparity=top|bottom
3757 same as directfb
3758 .IPs (no)bes
3759 Enable the use of the Matrox BES (backend scaler) (default: disabled).
3760 Gives very good results concerning speed and output quality as interpolated
3761 picture processing is done in hardware.
3762 Works only on the primary head.
3763 .IPs (no)spic
3764 Make use of the Matrox sub picture layer to display the OSD (default: enabled).
3765 .IPs (no)crtc2
3766 Turn on TV-out on the second head (default: enabled).
3767 The output quality is amazing as it is a full interlaced picture
3768 with proper sync to every odd/\:even field.
3769 .IPs tvnorm=pal|ntsc|auto
3770 Will set the TV norm of the Matrox card without the need
3771 for modifying /etc/\:directfbrc (default: disabled).
3772 Valid norms are pal = PAL, ntsc = NTSC.
3773 Special norm is auto (auto-adjust using PAL/\:NTSC) because it decides
3774 which norm to use by looking at the framerate of the movie.
3776 .PD 1
3779 .B mga (Linux only)
3780 Matrox specific video output driver that makes use of the YUV back
3781 end scaler on Gxxx cards through a kernel module.
3782 If you have a Matrox card, this is the fastest option.
3783 .PD 0
3784 .RSs
3785 .IPs <device>
3786 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3788 .PD 1
3791 .B xmga (Linux, X11 only)
3792 The mga video output driver, running in an X11 window.
3793 .PD 0
3794 .RSs
3795 .IPs <device>
3796 Explicitly choose the Matrox device name to use (default: /dev/\:mga_vid).
3798 .PD 1
3801 .B s3fb (Linux only) (see also \-vf yuv2 and \-dr)
3802 S3 Virge specific video output driver.
3803 This driver supports the card's YUV conversion and scaling, double
3804 buffering and direct rendering features.
3805 Use \-vf yuy2 to get hardware-accelerated YUY2 rendering, which is
3806 much faster than YV12 on this card.
3807 .PD 0
3808 .RSs
3809 .IPs <device>
3810 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3812 .PD 1
3815 .B 3dfx (Linux only)
3816 3dfx-specific video output driver that directly uses
3817 the hardware on top of X11.
3818 Only 16 bpp are supported.
3821 .B tdfxfb (Linux only)
3822 This driver employs the tdfxfb framebuffer driver to play movies with
3823 YUV acceleration on 3dfx cards.
3824 .PD 0
3825 .RSs
3826 .IPs <device>
3827 Explicitly choose the fbdev device name to use (default: /dev/\:fb0).
3829 .PD 1
3832 .B tdfx_vid (Linux only)
3833 3dfx-specific video output driver that works in combination with
3834 the tdfx_vid kernel module.
3835 .PD 0
3836 .RSs
3837 .IPs <device>
3838 Explicitly choose the device name to use (default: /dev/\:tdfx_vid).
3840 .PD 1
3843 .B dxr2 (also see \-dxr2) (DXR2 only)
3844 Creative DXR2 specific video output driver.
3845 .PD 0
3846 .RSs
3847 .IPs <vo_driver>
3848 Output video subdriver to use as overlay (x11, xv).
3850 .PD 1
3853 .B dxr3 (DXR3 only)
3854 Sigma Designs em8300 MPEG decoder chip (Creative DXR3, Sigma Designs
3855 Hollywood Plus) specific video output driver.
3856 Also see the lavc video filter.
3857 .PD 0
3858 .RSs
3859 .IPs overlay
3860 Activates the overlay instead of TVOut.
3861 .IPs prebuf
3862 Turns on prebuffering.
3863 .IPs "sync\ "
3864 Will turn on the new sync-engine.
3865 .IPs norm=<norm>
3866 Specifies the TV norm.
3867 .RSss
3868 0: Does not change current norm (default).
3870 1: Auto-adjust using PAL/\:NTSC.
3872 2: Auto-adjust using PAL/\:PAL-60.
3874 3: PAL
3876 4: PAL-60
3878 5: NTSC
3879 .REss
3880 .IPs <0\-3>
3881 Specifies the device number to use if you have more than one em8300 card.
3883 .PD 1
3886 .B ivtv (IVTV only)
3887 Conexant CX23415 (iCompression iTVC15) or Conexant CX23416 (iCompression
3888 iTVC16) MPEG decoder chip (Hauppauge WinTV PVR-150/250/350/500)
3889 specific video output driver for TV-Out.
3890 Also see the lavc video filter.
3891 .PD 0
3892 .RSs
3893 .IPs device
3894 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
3895 .IPs output
3896 Explicitly choose the TV-Out output to be used for the video signal.
3898 .PD 1
3901 .B v4l2 (requires Linux 2.6.22+ kernel)
3902 Video output driver for V4L2 compliant cards with built-in hardware MPEG decoder.
3903 Also see the lavc video filter.
3904 .PD 0
3905 .RSs
3906 .IPs device
3907 Explicitly choose the MPEG decoder device name to use (default: /dev/video16).
3908 .IPs output
3909 Explicitly choose the TV-Out output to be used for the video signal.
3911 .PD 1
3914 .B mpegpes (DVB only)
3915 Video output driver for DVB cards that writes the output to an MPEG-PES file
3916 if no DVB card is installed.
3917 .PD 0
3918 .RSs
3919 .IPs card=<1\-4>
3920 Specifies the device number to use if you have more than one DVB output card
3921 (V3 API only, such as 1.x.y series drivers).
3922 If not specified mplayer will search the first usable card.
3923 .IPs <filename>
3924 output filename (default: ./grab.mpg)
3926 .PD 1
3929 .B zr (also see \-zr* and \-zrhelp)
3930 Video output driver for a number of MJPEG capture/\:playback cards.
3933 .B zr2 (also see the zrmjpeg video filter)
3934 Video output driver for a number of MJPEG capture/\:playback cards,
3935 second generation.
3936 .PD 0
3937 .RSs
3938 .IPs dev=<device>
3939 Specifies the video device to use.
3940 .IPs norm=<PAL|NTSC|SECAM|auto>
3941 Specifies the video norm to use (default: auto).
3942 .IPs (no)prebuf
3943 (De)Activate prebuffering, not yet supported.
3945 .PD 1
3948 .B "md5sum\ "
3949 Calculate MD5 sums of each frame and write them to a file.
3950 Supports RGB24 and YV12 colorspaces.
3951 Useful for debugging.
3952 .PD 0
3953 .RSs
3954 .IPs outfile=<value>
3955 Specify the output filename (default: ./md5sums).
3957 .PD 1
3960 .B yuv4mpeg
3961 Transforms the video stream into a sequence of uncompressed YUV 4:2:0
3962 images and stores it in a file (default: ./stream.yuv).
3963 The format is the same as the one employed by mjpegtools, so this is
3964 useful if you want to process the video with the mjpegtools suite.
3965 It supports the YV12, RGB (24 bpp) and BGR (24 bpp) format.
3966 You can combine it with the \-fixed\-vo option to concatenate files
3967 with the same dimensions and fps value.
3968 .PD 0
3969 .RSs
3970 .IPs interlaced
3971 Write the output as interlaced frames, top field first.
3972 .IPs interlaced_bf
3973 Write the output as interlaced frames, bottom field first.
3974 .IPs file=<filename>
3975 Write the output to <filename> instead of the default stream.yuv.
3976 .REss
3977 .PD 1
3979 .sp 1
3980 .I NOTE:
3981 If you do not specify any option the output is progressive
3982 (i.e.\& not interlaced).
3986 .B "gif89a\ "
3987 Output each frame into a single animated GIF file in the current directory.
3988 It supports only RGB format with 24 bpp and the output is converted to 256
3989 colors.
3990 .PD 0
3991 .RSs
3992 .IPs <fps>
3993 Float value to specify framerate (default: 5.0).
3994 .IPs <output>
3995 Specify the output filename (default: ./out.gif).
3996 .REss
3997 .PD 1
3999 .sp 1
4000 .I NOTE:
4001 You must specify the framerate before the filename or the framerate will
4002 be part of the filename.
4003 .sp 1
4004 .I EXAMPLE:
4006 .PD 0
4007 .RSs
4008 mplayer video.nut \-vo gif89a:fps=15:output=test.gif
4010 .PD 1
4013 .B "jpeg\ \ \ "
4014 Output each frame into a JPEG file in the current directory.
4015 Each file takes the frame number padded with leading zeros as name.
4016 .PD 0
4017 .RSs
4018 .IPs [no]progressive
4019 Specify standard or progressive JPEG (default: noprogressive).
4020 .IPs [no]baseline
4021 Specify use of baseline or not (default: baseline).
4022 .IPs optimize=<0\-100>
4023 optimization factor (default: 100)
4024 .IPs smooth=<0\-100>
4025 smooth factor (default: 0)
4026 .IPs quality=<0\-100>
4027 quality factor (default: 75)
4028 .IPs outdir=<dirname>
4029 Specify the directory to save the JPEG files to (default: ./).
4030 .IPs subdirs=<prefix>
4031 Create numbered subdirectories with the specified prefix to
4032 save the files in instead of the current directory.
4033 .IPs "maxfiles=<value> (subdirs only)"
4034 Maximum number of files to be saved per subdirectory.
4035 Must be equal to or larger than 1 (default: 1000).
4037 .PD 1
4040 .B "pnm\ \ \ \ "
4041 Output each frame into a PNM file in the current directory.
4042 Each file takes the frame number padded with leading zeros as name.
4043 It supports PPM, PGM and PGMYUV files in both raw and ASCII mode.
4044 Also see pnm(5), ppm(5) and pgm(5).
4045 .PD 0
4046 .RSs
4047 .IPs "ppm\ \ "
4048 Write PPM files (default).
4049 .IPs "pgm\ \ "
4050 Write PGM files.
4051 .IPs pgmyuv
4052 Write PGMYUV files.
4053 PGMYUV is like PGM, but it also contains the U and V plane, appended at the
4054 bottom of the picture.
4055 .IPs "raw\ \ "
4056 Write PNM files in raw mode (default).
4057 .IPs ascii
4058 Write PNM files in ASCII mode.
4059 .IPs outdir=<dirname>
4060 Specify the directory to save the PNM files to (default: ./).
4061 .IPs subdirs=<prefix>
4062 Create numbered subdirectories with the specified prefix to
4063 save the files in instead of the current directory.
4064 .IPs "maxfiles=<value> (subdirs only)"
4065 Maximum number of files to be saved per subdirectory.
4066 Must be equal to or larger than 1 (default: 1000).
4068 .PD 1
4071 .B "png\ \ \ \ "
4072 Output each frame into a PNG file in the current directory.
4073 Each file takes the frame number padded with leading zeros as name.
4074 24bpp RGB and BGR formats are supported.
4075 .PD 0
4076 .RSs
4077 .IPs z=<0\-9>
4078 Specifies the compression level.
4079 0 is no compression, 9 is maximum compression.
4081 .PD 1
4084 .B "tga\ \ \ \ "
4085 Output each frame into a Targa file in the current directory.
4086 Each file takes the frame number padded with leading zeros as name.
4087 The purpose of this video output driver is to have a simple lossless
4088 image writer to use without any external library.
4089 It supports the BGR[A] color format, with 15, 24 and 32 bpp.
4090 You can force a particular format with the format video filter.
4091 .sp 1
4092 .I EXAMPLE:
4094 .PD 0
4095 .RSs
4096 mplayer video.nut \-vf format=bgr15 \-vo tga
4098 .PD 1
4102 .SH "DECODING/FILTERING OPTIONS"
4105 .B \-ac <[\-|+]codec1,[\-|+]codec2,...[,]>
4106 Specify a priority list of audio codecs to be used, according to their codec
4107 name in codecs.conf.
4108 Use a '\-' before the codec name to omit it.
4109 Use a '+' before the codec name to force it, this will likely crash!
4110 If the list has a trailing ',' MPlayer will fall back on codecs not
4111 contained in the list.
4113 .I NOTE:
4114 See \-ac help for a full list of available codecs.
4115 .sp 1
4116 .I EXAMPLE:
4117 .PD 0
4118 .RSs
4119 .IPs "\-ac mp3acm"
4120 Force the l3codeca.acm MP3 codec.
4121 .IPs "\-ac mad,"
4122 Try libmad first, then fall back on others.
4123 .IPs "\-ac hwac3,a52,"
4124 Try hardware AC-3 passthrough, software AC-3, then others.
4125 .IPs "\-ac hwdts,"
4126 Try hardware DTS passthrough, then fall back on others.
4127 .IPs "\-ac \-ffmp3,"
4128 Skip FFmpeg's MP3 decoder.
4130 .PD 1
4133 .B \-af\-adv <force=(0\-7):list=(filters)> (also see \-af)
4134 Specify advanced audio filter options:
4135 .RSs
4136 .IPs force=<0\-7>
4137 Forces the insertion of audio filters to one of the following:
4138 .RSss
4139 0: Use completely automatic filter insertion.
4141 1: Optimize for accuracy (default).
4143 2: Optimize for speed.
4144 .I Warning:
4145 Some features in the audio filters may silently fail,
4146 and the sound quality may drop.
4148 3: Use no automatic insertion of filters and no optimization.
4149 .I Warning:
4150 It may be possible to crash MPlayer using this setting.
4152 4: Use automatic insertion of filters according to 0 above,
4153 but use floating point processing when possible.
4155 5: Use automatic insertion of filters according to 1 above,
4156 but use floating point processing when possible.
4158 6: Use automatic insertion of filters according to 2 above,
4159 but use floating point processing when possible.
4161 7: Use no automatic insertion of filters according to 3 above,
4162 and use floating point processing when possible.
4163 .REss
4164 .IPs list=<filters>
4165 Same as \-af.
4169 .B \-afm <driver1,driver2,...>
4170 Specify a priority list of audio codec families to be used, according
4171 to their codec name in codecs.conf.
4172 Falls back on the default codecs if none of the given codec families work.
4174 .I NOTE:
4175 See \-afm help for a full list of available codec families.
4176 .sp 1
4177 .I EXAMPLE:
4178 .PD 0
4179 .RSs
4180 .IPs "\-afm ffmpeg"
4181 Try FFmpeg's libavcodec codecs first.
4182 .IPs "\-afm acm,dshow"
4183 Try Win32 codecs first.
4185 .PD 1
4188 .B \-aspect <ratio> (also see \-zoom)
4189 Override movie aspect ratio, in case aspect information is
4190 incorrect or missing in the file being played.
4191 .sp 1
4192 .I EXAMPLE:
4193 .PD 0
4194 .RSs
4195 \-aspect 4:3  or \-aspect 1.3333
4197 \-aspect 16:9 or \-aspect 1.7777
4199 .PD 1
4202 .B \-noaspect
4203 Disable automatic movie aspect ratio compensation.
4206 .B "\-field\-dominance <\-1\-1>"
4207 Set first field for interlaced content.
4208 Useful for deinterlacers that double the framerate: \-vf tfields=1,
4209 \-vf yadif=1 and \-vo xvmc:bobdeint.
4210 .PD 0
4211 .RSs
4212 .IPs \-1
4213 auto (default): If the decoder does not export the appropriate information,
4214 it falls back to 0 (top field first).
4215 .IPs 0
4216 top field first
4217 .IPs 1
4218 bottom field first
4220 .PD 1
4223 .B "\-flip \ "
4224 Flip image upside-down.
4227 .B \-lavdopts <option1:option2:...> (DEBUG CODE)
4228 Specify libavcodec decoding parameters.
4229 Separate multiple options with a colon.
4230 .sp 1
4231 .I EXAMPLE:
4232 .PD 0
4233 .RSs
4234 \-lavdopts gray:skiploopfilter=all:skipframe=nonref
4236 .PD 1
4237 .sp 1
4239 Available options are:
4241 .RSs
4242 .IPs bitexact
4243 Only use bit-exact algorithms in all decoding steps (for codec testing).
4244 .IPs bug=<value>
4245 Manually work around encoder bugs.
4246 .RSss
4247 0: nothing
4249 1: autodetect bugs (default)
4251 2 (msmpeg4v3): some old lavc generated msmpeg4v3 files (no autodetection)
4253 4 (mpeg4): Xvid interlacing bug (autodetected if fourcc==XVIX)
4255 8 (mpeg4): UMP4 (autodetected if fourcc==UMP4)
4257 16 (mpeg4): padding bug (autodetected)
4259 32 (mpeg4): illegal vlc bug (autodetected per fourcc)
4261 64 (mpeg4): Xvid and DivX qpel bug (autodetected per fourcc/\:version)
4263 128 (mpeg4): old standard qpel (autodetected per fourcc/\:version)
4265 256 (mpeg4): another qpel bug (autodetected per fourcc/\:version)
4267 512 (mpeg4): direct-qpel-blocksize bug (autodetected per fourcc/\:version)
4269 1024 (mpeg4): edge padding bug (autodetected per fourcc/\:version)
4270 .REss
4271 .IPs debug=<value>
4272 Display debugging information.
4273 .RSss
4275 0: disabled
4277 1: picture info
4279 2: rate control
4281 4: bitstream
4283 8: macroblock (MB) type
4285 16: per-block quantization parameter (QP)
4287 32: motion vector
4289 0x0040: motion vector visualization (use \-noslices)
4291 0x0080: macroblock (MB) skip
4293 0x0100: startcode
4295 0x0200: PTS
4297 0x0400: error resilience
4299 0x0800: memory management control operations (H.264)
4301 0x1000: bugs
4303 0x2000: Visualize quantization parameter (QP), lower QP are tinted greener.
4305 0x4000: Visualize block types.
4306 .REss
4307 .IPs ec=<value>
4308 Set error concealment strategy.
4309 .RSss
4310 1: Use strong deblock filter for damaged MBs.
4312 2: iterative motion vector (MV) search (slow)
4314 3: all (default)
4315 .REss
4316 .IPs er=<value>
4317 Set error resilience strategy.
4318 .RSss
4320 0: disabled
4322 1: careful (Should work with broken encoders.)
4324 2: normal (default) (Works with compliant encoders.)
4326 3: aggressive (More checks, but might cause problems even for valid bitstreams.)
4328 4: very aggressive
4329 .REss
4330 .IPs "fast (MPEG-2, MPEG-4, and H.264 only)"
4331 Enable optimizations which do not comply to the specification and might
4332 potentially cause problems, like simpler dequantization, simpler motion
4333 compensation, assuming use of the default quantization matrix, assuming
4334 YUV 4:2:0 and skipping a few checks to detect damaged bitstreams.
4335 .IPs "gray\ "
4336 grayscale only decoding (a bit faster than with color)
4337 .IPs "idct=<0\-99> (see \-lavcopts)"
4338 For best decoding quality use the same IDCT algorithm for decoding and encoding.
4339 This may come at a price in accuracy, though.
4340 .IPs lowres=<number>[,<w>]
4341 Decode at lower resolutions.
4342 Low resolution decoding is not supported by all codecs, and it will
4343 often result in ugly artifacts.
4344 This is not a bug, but a side effect of not decoding at full resolution.
4345 .RSss
4347 0: disabled
4349 1: 1/2 resolution
4351 2: 1/4 resolution
4353 3: 1/8 resolution
4354 .REss
4356 If <w> is specified lowres decoding will be used only if the width of the
4357 video is major than or equal to <w>.
4359 .IPs "sb=<number> (MPEG-2 only)"
4360 Skip the given number of macroblock rows at the bottom.
4361 .IPs "st=<number> (MPEG-2 only)"
4362 Skip the given number of macroblock rows at the top.
4363 .IPs "skiploopfilter=<skipvalue> (H.264 only)"
4364 Skips the loop filter (AKA deblocking) during H.264 decoding.
4365 Since the filtered frame is supposed to be used as reference
4366 for decoding dependent frames this has a worse effect on quality
4367 than not doing deblocking on e.g.\& MPEG-2 video.
4368 But at least for high bitrate HDTV this provides a big speedup with
4369 no visible quality loss.
4370 .sp 1
4371 <skipvalue> can be either one of the following:
4372 .RSss
4374 none: Never skip.
4376 default: Skip useless processing steps (e.g.\& 0 size packets in AVI).
4378 nonref: Skip frames that are not referenced (i.e.\& not used for
4379 decoding other frames, the error cannot "build up").
4381 bidir: Skip B-Frames.
4383 nonkey: Skip all frames except keyframes.
4385 all: Skip all frames.
4386 .REss
4387 .IPs "skipidct=<skipvalue> (MPEG-1/2 only)"
4388 Skips the IDCT step.
4389 This degrades quality a lot of in almost all cases
4390 (see skiploopfilter for available skip values).
4391 .IPs skipframe=<skipvalue>
4392 Skips decoding of frames completely.
4393 Big speedup, but jerky motion and sometimes bad artifacts
4394 (see skiploopfilter for available skip values).
4395 .IPs "threads=<1\-8> (MPEG-1/2 and H.264 only)"
4396 number of threads to use for decoding (default: 1)
4397 .IPs vismv=<value>
4398 Visualize motion vectors.
4399 .RSss
4401 0: disabled
4403 1: Visualize forward predicted MVs of P-frames.
4405 2: Visualize forward predicted MVs of B-frames.
4407 4: Visualize backward predicted MVs of B-frames.
4408 .REss
4409 .IPs vstats
4410 Prints some statistics and stores them in ./vstats_*.log.
4414 .B \-noslices
4415 Disable drawing video by 16-pixel height slices/\:bands, instead draws the
4416 whole frame in a single run.
4417 May be faster or slower, depending on video card and available cache.
4418 It has effect only with libmpeg2 and libavcodec codecs.
4421 .B \-nosound
4422 Do not play/\:encode sound.
4423 Useful for benchmarking.
4426 .B \-novideo
4427 Do not play/\:encode video.
4428 In many cases this will not work, use \-vc null \-vo null instead.
4431 .B \-pp <quality> (also see \-vf pp)
4432 Set the DLL postprocess level.
4433 This option is no longer usable with \-vf pp.
4434 It only works with Win32 DirectShow DLLs with internal postprocessing routines.
4435 The valid range of \-pp values varies by codec, it is mostly
4436 0\-6, where 0=disable, 6=slowest/\:best.
4439 .B \-pphelp (also see \-vf pp)
4440 Show a summary about the available postprocess filters and their usage.
4443 .B \-ssf <mode>
4444 Specifies software scaler parameters.
4445 .sp 1
4446 .I EXAMPLE:
4447 .PD 0
4448 .RSs
4449 \-vf scale \-ssf lgb=3.0
4451 .PD 1
4452 .PD 0
4453 .RSs
4454 .IPs lgb=<0\-100>
4455 gaussian blur filter (luma)
4456 .IPs cgb=<0\-100>
4457 gaussian blur filter (chroma)
4458 .IPs ls=<\-100\-100>
4459 sharpen filter (luma)
4460 .IPs cs=<\-100\-100>
4461 sharpen filter (chroma)
4462 .IPs chs=<h>
4463 chroma horizontal shifting
4464 .IPs cvs=<v>
4465 chroma vertical shifting
4467 .PD 1
4470 .B \-stereo <mode>
4471 Select type of MP2/\:MP3 stereo output.
4472 .PD 0
4473 .RSs
4474 .IPs 0
4475 stereo
4476 .IPs 1
4477 left channel
4478 .IPs 2
4479 right channel
4481 .PD 1
4484 .B \-sws <software scaler type> (also see \-vf scale and \-zoom)
4485 Specify the software scaler algorithm to be used with the \-zoom option.
4486 This affects video output drivers which lack hardware acceleration, e.g.\& x11.
4487 .sp 1
4488 Available types are:
4489 .sp 1
4490 .PD 0
4491 .RSs
4492 .IPs 0
4493 fast bilinear
4494 .IPs 1
4495 bilinear
4496 .IPs 2
4497 bicubic (good quality) (default)
4498 .IPs 3
4499 experimental
4500 .IPs 4
4501 nearest neighbor (bad quality)
4502 .IPs 5
4503 area
4504 .IPs 6
4505 luma bicubic / chroma bilinear
4506 .IPs 7
4507 gauss
4508 .IPs 8
4509 sincR
4510 .IPs 9
4511 lanczos
4512 .IPs 10
4513 natural bicubic spline
4515 .PD 1
4516 .sp 1
4518 .I NOTE:
4519 Some \-sws options are tunable.
4520 The description of the scale video filter has further information.
4524 .B \-vc <[\-|+]codec1,[\-|+]codec2,...[,]>
4525 Specify a priority list of video codecs to be used, according to their codec
4526 name in codecs.conf.
4527 Use a '\-' before the codec name to omit it.
4528 Use a '+' before the codec name to force it, this will likely crash!
4529 If the list has a trailing ',' MPlayer will fall back on codecs not
4530 contained in the list.
4532 .I NOTE:
4533 See \-vc help for a full list of available codecs.
4534 .sp 1
4535 .I EXAMPLE:
4536 .PD 0
4537 .RSs
4538 .IPs "\-vc divx"
4539 Force Win32/\:VfW DivX codec, no fallback.
4540 .IPs "\-vc \-divxds,\-divx,"
4541 Skip Win32 DivX codecs.
4542 .IPs "\-vc ffmpeg12,mpeg12,"
4543 Try libavcodec's MPEG-1/2 codec, then libmpeg2, then others.
4545 .PD 1
4548 .B \-vfm <driver1,driver2,...>
4549 Specify a priority list of video codec families to be used, according
4550 to their names in codecs.conf.
4551 Falls back on the default codecs if none of the given codec families work.
4553 .I NOTE:
4554 See \-vfm help for a full list of available codec families.
4555 .sp 1
4556 .I EXAMPLE:
4557 .PD 0
4558 .RSs
4559 .IPs "\-vfm ffmpeg,dshow,vfw"
4560 Try the libavcodec, then Directshow, then VfW codecs and fall back
4561 on others, if they do not work.
4562 .IPs "\-vfm xanim"
4563 Try XAnim codecs first.
4565 .PD 1
4568 .B \-x <x> (also see \-zoom) (MPlayer only)
4569 Scale image to width <x> (if software/\:hardware scaling is available).
4570 Disables aspect calculations.
4573 .B \-xvidopts <option1:option2:...>
4574 Specify additional parameters when decoding with Xvid.
4576 .I NOTE:
4577 Since libavcodec is faster than Xvid you might want to use the libavcodec
4578 postprocessing filter (\-vf pp) and decoder (\-vfm ffmpeg) instead.
4579 .sp 1
4580 Xvid's internal postprocessing filters:
4581 .PD 0
4582 .RSs
4583 .IPs "deblock-chroma (also see \-vf pp)"
4584 chroma deblock filter
4585 .IPs "deblock-luma (also see \-vf pp)"
4586 luma deblock filter
4587 .IPs "dering-luma (also see \-vf pp)"
4588 luma deringing filter
4589 .IPs "dering-chroma (also see \-vf pp)"
4590 chroma deringing filter
4591 .IPs "filmeffect (also see \-vf noise)"
4592 Adds artificial film grain to the video.
4593 May increase perceived quality, while lowering true quality.
4595 .sp 1
4597 rendering methods:
4599 .PD 0
4600 .RSs
4601 .IPs "dr2\ \ "
4602 Activate direct rendering method 2.
4603 .IPs nodr2
4604 Deactivate direct rendering method 2.
4606 .PD 1
4609 .B \-xy <value> (also see \-zoom)
4610 .PD 0
4611 .RSs
4612 .IPs value<=8
4613 Scale image by factor <value>.
4614 .IPs value>8
4615 Set width to value and calculate height to keep correct aspect ratio.
4617 .PD 1
4620 .B \-y <y> (also see \-zoom) (MPlayer only)
4621 Scale image to height <y> (if software/\:hardware scaling is available).
4622 Disables aspect calculations.
4625 .B "\-zoom\ \ "
4626 Allow software scaling, where available.
4627 This will allow scaling with output drivers (like x11, fbdev) that
4628 do not support hardware scaling where MPlayer disables scaling by
4629 default for performance reasons.
4633 .SH "AUDIO FILTERS"
4634 Audio filters allow you to modify the audio stream and its properties.
4635 The syntax is:
4638 .B \-af <filter1[=parameter1:parameter2:...],filter2,...>
4639 Setup a chain of audio filters.
4641 .I NOTE:
4642 To get a full list of available audio filters, see \-af help.
4644 Available filters are:
4647 .B resample[=srate[:sloppy[:type]]]
4648 Changes the sample rate of the audio stream.
4649 Can be used if you have a fixed frequency sound card or if you are
4650 stuck with an old sound card that is only capable of max 44.1kHz.
4651 This filter is automatically enabled if necessary.
4652 It only supports 16-bit integer and float in native-endian format as input.
4654 .I NOTE:
4655 With MEncoder, you need to also use \-srate <srate>.
4656 .PD 0
4657 .RSs
4658 .IPs <srate>
4659 output sample frequency in Hz.
4660 The valid range for this parameter is 8000 to 192000.
4661 If the input and output sample frequency are the same or if this
4662 parameter is omitted the filter is automatically unloaded.
4663 A high sample frequency normally improves the audio quality,
4664 especially when used in combination with other filters.
4665 .IPs <sloppy>
4666 Allow (1) or disallow (0) the output frequency to differ slightly
4667 from the frequency given by <srate> (default: 1).
4668 Can be used if the startup of the playback is extremely slow.
4669 .IPs <type>
4670 Selects which resampling method to use.
4671 .RSss
4672 0: linear interpolation (fast, poor quality especially when upsampling)
4674 1: polyphase filterbank and integer processing
4676 2: polyphase filterbank and floating point processing (slow, best quality)
4677 .REss
4678 .PD 1
4680 .sp 1
4682 .I EXAMPLE:
4684 .PD 0
4685 .RSs
4686 .IPs "mplayer \-af resample=44100:0:0"
4687 would set the output frequency of the resample filter to 44100Hz using
4688 exact output frequency scaling and linear interpolation.
4690 .PD 1
4693 .B lavcresample[=srate[:length[:linear[:count[:cutoff]]]]]
4694 Changes the sample rate of the audio stream to an integer <srate> in Hz.
4695 It only supports the 16-bit native-endian format.
4697 .I NOTE:
4698 With MEncoder, you need to also use \-srate <srate>.
4699 .PD 0
4700 .RSs
4701 .IPs <srate>
4702 the output sample rate
4703 .IPs <length>
4704 length of the filter with respect to the lower sampling rate (default: 16)
4705 .IPs <linear>
4706 if 1 then filters will be linearly interpolated between polyphase entries
4707 .IPs <count>
4708 log2 of the number of polyphase entries
4709 (..., 10->1024, 11->2048, 12->4096, ...)
4710 (default: 10->1024)
4711 .IPs <cutoff>
4712 cutoff frequency (0.0\-1.0), default set depending upon filter length
4714 .PD 1
4717 .B lavcac3enc[=tospdif[:bitrate[:minchn]]]
4718 Encode multi-channel audio to AC-3 at runtime using libavcodec.
4719 Supports 16-bit native-endian input format, maximum 6 channels.
4720 The output is big-endian when outputting a raw AC-3 stream,
4721 native-endian when outputting to S/PDIF.
4722 The output sample rate of this filter is same with the input sample rate.
4723 When input sample rate is 48kHz, 44.1kHz, or 32kHz, this filter directly use it.
4724 Otherwise a resampler filter is auto-inserted before this filter to make
4725 the input and output sample rate be 48kHz.
4726 You need to specify '\-channels N' to make the decoder decode audio into
4727 N-channel, then the filter can encode the N-channel input to AC-3.
4729 .PD 0
4730 .RSs
4731 .IPs <tospdif>
4732 Output raw AC-3 stream if zero or not set,
4733 output to S/PDIF for passthrough when <tospdif> is set non-zero.
4734 .IPs <bitrate>
4735 The bitrate to encode the AC-3 stream.
4736 Set it to either 384 or 384000 to get 384kbits.
4737 Valid values: 32, 40, 48, 56, 64, 80, 96, 112, 128, 160, 192, 224, 256,
4738               320, 384, 448, 512, 576, 640
4739 Default bitrate is based on the input channel number:
4740 1ch: 96,  2ch: 192,  3ch: 224,  4ch: 384,  5ch: 448,  6ch: 448
4741 .IPs <minchn>
4742 If the input channel number is less than <minchn>, the filter will
4743 detach itself (default: 5).
4745 .PD 1
4748 .B sweep[=speed]
4749 Produces a sine sweep.
4750 .PD 0
4751 .RSs
4752 .IPs <0.0\-1.0>
4753 Sine function delta, use very low values to hear the sweep.
4755 .PD 1
4758 .B sinesuppress[=freq:decay]
4759 Remove a sine at the specified frequency.
4760 Useful to get rid of the 50/60Hz noise on low quality audio equipment.
4761 It probably only works on mono input.
4762 .PD 0
4763 .RSs
4764 .IPs <freq>
4765 The frequency of the sine which should be removed (in Hz) (default: 50)
4766 .IPs <decay>
4767 Controls the adaptivity (a larger value will make the filter adapt to
4768 amplitude and phase changes quicker, a smaller value will make the
4769 adaptation slower) (default: 0.0001).
4770 Reasonable values are around 0.001.
4772 .PD 1
4775 .B hrtf[=flag]
4776 Head-related transfer function: Converts multichannel audio to
4777 2 channel output for headphones, preserving the spatiality of the sound.
4778 .sp 1
4779 .PD 0
4781 .IPs "Flag  Meaning"
4782 .IPs "m     matrix decoding of the rear channel"
4783 .IPs "s     2-channel matrix decoding"
4784 .IPs "0     no matrix decoding (default)"
4786 .PD 1
4789 .B equalizer=[g1:g2:g3:...:g10]
4790 10 octave band graphic equalizer, implemented using 10 IIR band pass filters.
4791 This means that it works regardless of what type of audio is being played back.
4792 The center frequencies for the 10 bands are:
4793 .sp 1
4794 .PD 0
4796 .IPs "No. frequency"
4797 .IPs "0    31.25 Hz"
4798 .IPs "1    62.50 Hz"
4799 .IPs "2   125.00 Hz"
4800 .IPs "3   250.00 Hz"
4801 .IPs "4   500.00 Hz"
4802 .IPs "5    1.00 kHz"
4803 .IPs "6    2.00 kHz"
4804 .IPs "7    4.00 kHz"
4805 .IPs "8    8.00 kHz"
4806 .IPs "9   16.00 kHz"
4808 .PD 1
4809 .sp 1
4811 If the sample rate of the sound being played is lower than the center
4812 frequency for a frequency band, then that band will be disabled.
4813 A known bug with this filter is that the characteristics for the
4814 uppermost band are not completely symmetric if the sample
4815 rate is close to the center frequency of that band.
4816 This problem can be worked around by upsampling the sound
4817 using the resample filter before it reaches this filter.
4819 .PD 0
4820 .RSs
4821 .IPs <g1>:<g2>:<g3>:...:<g10>
4822 floating point numbers representing the gain in dB
4823 for each frequency band (\-12\-12)
4825 .sp 1
4827 .I EXAMPLE:
4829 .RSs
4830 .IPs "mplayer \-af equalizer=11:11:10:5:0:\-12:0:5:12:12 media.avi"
4831 Would amplify the sound in the upper and lower frequency region
4832 while canceling it almost completely around 1kHz.
4834 .PD 1
4837 .B channels=nch[:nr:from1:to1:from2:to2:from3:to3:...]
4838 Can be used for adding, removing, routing and copying audio channels.
4839 If only <nch> is given the default routing is used, it works as
4840 follows: If the number of output channels is bigger than the number of
4841 input channels empty channels are inserted (except mixing from mono to
4842 stereo, then the mono channel is repeated in both of the output
4843 channels).
4844 If the number of output channels is smaller than the number
4845 of input channels the exceeding channels are truncated.
4846 .PD 0
4847 .RSs
4848 .IPs <nch>
4849 number of output channels (1\-6)
4850 .IPs "<nr>\ "
4851 number of routes (1\-6)
4852 .IPs <from1:to1:from2:to2:from3:to3:...>
4853 Pairs of numbers between 0 and 5 that define where to route each channel.
4855 .sp 1
4857 .I EXAMPLE:
4859 .RSs
4860 .IPs "mplayer \-af channels=4:4:0:1:1:0:2:2:3:3 media.avi"
4861 Would change the number of channels to 4 and set up 4 routes that
4862 swap channel 0 and channel 1 and leave channel 2 and 3 intact.
4863 Observe that if media containing two channels was played back, channels
4864 2 and 3 would contain silence but 0 and 1 would still be swapped.
4865 .IPs "mplayer \-af channels=6:4:0:0:0:1:0:2:0:3 media.avi"
4866 Would change the number of channels to 6 and set up 4 routes
4867 that copy channel 0 to channels 0 to 3.
4868 Channel 4 and 5 will contain silence.
4870 .PD 1
4873 .B format[=format] (also see \-format)
4874 Convert between different sample formats.
4875 Automatically enabled when needed by the sound card or another filter.
4876 .PD 0
4877 .RSs
4878 .IPs <format>
4879 Sets the desired format.
4880 The general form is 'sbe', where 's' denotes the sign (either 's' for signed
4881 or 'u' for unsigned), 'b' denotes the number of bits per sample (16, 24 or 32)
4882 and 'e' denotes the endianness ('le' means little-endian, 'be' big-endian
4883 and 'ne' the endianness of the computer MPlayer is running on).
4884 Valid values (amongst others) are: 's16le', 'u32be' and 'u24ne'.
4885 Exceptions to this rule that are also valid format specifiers: u8, s8,
4886 floatle, floatbe, floatne, mulaw, alaw, mpeg2, ac3 and imaadpcm.
4888 .PD 1
4891 .B volume[=v[:sc]]
4892 Implements software volume control.
4893 Use this filter with caution since it can reduce the signal
4894 to noise ratio of the sound.
4895 In most cases it is best to set the level for the PCM sound to max,
4896 leave this filter out and control the output level to your
4897 speakers with the master volume control of the mixer.
4898 In case your sound card has a digital PCM mixer instead of an analog
4899 one, and you hear distortion, use the MASTER mixer instead.
4900 If there is an external amplifier connected to the computer (this
4901 is almost always the case), the noise level can be minimized by
4902 adjusting the master level and the volume knob on the amplifier
4903 until the hissing noise in the background is gone.
4905 This filter has a second feature: It measures the overall maximum
4906 sound level and prints out that level when MPlayer exits.
4907 This volume estimate can be used for setting the sound level in
4908 MEncoder such that the maximum dynamic range is utilized.
4910 .I NOTE:
4911 This filter is not reentrant and can therefore only be enabled
4912 once for every audio stream.
4913 .PD 0
4914 .RSs
4915 .IPs "<v>\ \ "
4916 Sets the desired gain in dB for all channels in the stream
4917 from \-200dB to +60dB, where \-200dB mutes the sound
4918 completely and +60dB equals a gain of 1000 (default: 0).
4919 .IPs "<sc>\ "
4920 Turns soft clipping on (1) or off (0).
4921 Soft-clipping can make the sound more smooth if very
4922 high volume levels are used.
4923 Enable this option if the dynamic range of the
4924 loudspeakers is very low.
4926 .I WARNING:
4927 This feature creates distortion and should be considered a last resort.
4929 .sp 1
4931 .I EXAMPLE:
4933 .RSs
4934 .IPs "mplayer \-af volume=10.1:0 media.avi"
4935 Would amplify the sound by 10.1dB and hard-clip if the
4936 sound level is too high.
4938 .PD 1
4941 .B pan=n[:L00:L01:L02:...L10:L11:L12:...Ln0:Ln1:Ln2:...]
4942 Mixes channels arbitrarily.
4943 Basically a combination of the volume and the channels filter
4944 that can be used to down-mix many channels to only a few,
4945 e.g.\& stereo to mono or vary the "width" of the center
4946 speaker in a surround sound system.
4947 This filter is hard to use, and will require some tinkering
4948 before the desired result is obtained.
4949 The number of options for this filter depends on
4950 the number of output channels.
4951 An example how to downmix a six-channel file to two channels with
4952 this filter can be found in the examples section near the end.
4953 .PD 0
4954 .RSs
4955 .IPs "<n>\ \ "
4956 number of output channels (1\-6)
4957 .IPs <Lij>
4958 How much of input channel i is mixed into output channel j (0\-1).
4959 So in principle you first have n numbers saying what to do with the
4960 first input channel, then n numbers that act on the second input channel
4961 etc.
4962 If you do not specify any numbers for some input channels, 0 is assumed.
4964 .sp 1
4966 .I EXAMPLE:
4968 .RSs
4969 .IPs "mplayer \-af pan=1:0.5:0.5 media.avi"
4970 Would down-mix from stereo to mono.
4971 .IPs "mplayer \-af pan=3:1:0:0.5:0:1:0.5 media.avi"
4972 Would give 3 channel output leaving channels 0 and 1 intact,
4973 and mix channels 0 and 1 into output channel 2 (which could
4974 be sent to a subwoofer for example).
4976 .PD 1
4979 .B sub[=fc:ch]
4980 Adds a subwoofer channel to the audio stream.
4981 The audio data used for creating the subwoofer channel is
4982 an average of the sound in channel 0 and channel 1.
4983 The resulting sound is then low-pass filtered by a 4th order
4984 Butterworth filter with a default cutoff frequency of 60Hz
4985 and added to a separate channel in the audio stream.
4987 .I Warning:
4988 Disable this filter when you are playing DVDs with Dolby
4989 Digital 5.1 sound, otherwise this filter will disrupt
4990 the sound to the subwoofer.
4991 .PD 0
4992 .RSs
4993 .IPs "<fc>\ "
4994 cutoff frequency in Hz for the low-pass filter (20Hz to 300Hz) (default: 60Hz)
4995 For the best result try setting the cutoff frequency as low as possible.
4996 This will improve the stereo or surround sound experience.
4997 .IPs "<ch>\ "
4998 Determines the channel number in which to insert the sub-channel audio.
4999 Channel number can be between 0 and 5 (default: 5).
5000 Observe that the number of channels will automatically
5001 be increased to <ch> if necessary.
5003 .sp 1
5005 .I EXAMPLE:
5007 .RSs
5008 .IPs "mplayer \-af sub=100:4 \-channels 5 media.avi"
5009 Would add a sub-woofer channel with a cutoff frequency of
5010 100Hz to output channel 4.
5012 .PD 1
5015 .B "center\ "
5016 Creates a center channel from the front channels.
5017 May currently be low quality as it does not implement a
5018 high-pass filter for proper extraction yet, but averages and
5019 halves the channels instead.
5020 .PD 0
5021 .RSs
5022 .IPs "<ch>\ "
5023 Determines the channel number in which to insert the center channel.
5024 Channel number can be between 0 and 5 (default: 5).
5025 Observe that the number of channels will automatically
5026 be increased to <ch> if necessary.
5028 .PD 1
5031 .B surround[=delay]
5032 Decoder for matrix encoded surround sound like Dolby Surround.
5033 Many files with 2 channel audio actually contain matrixed surround sound.
5034 Requires a sound card supporting at least 4 channels.
5035 .PD 0
5036 .RSs
5037 .IPs <delay>
5038 delay time in ms for the rear speakers (0 to 1000) (default: 20)
5039 This delay should be set as follows: If d1 is the distance
5040 from the listening position to the front speakers and d2 is the distance
5041 from the listening position to the rear speakers, then the delay should
5042 be set to 15ms if d1 <= d2 and to 15 + 5*(d1-d2) if d1 > d2.
5044 .sp 1
5046 .I EXAMPLE:
5048 .RSs
5049 .IPs "mplayer \-af surround=15 \-channels 4 media.avi"
5050 Would add surround sound decoding with 15ms delay for the sound to the
5051 rear speakers.
5053 .PD 1
5056 .B delay[=ch1:ch2:...]
5057 Delays the sound to the loudspeakers such that the sound from the
5058 different channels arrives at the listening position simultaneously.
5059 It is only useful if you have more than 2 loudspeakers.
5060 .PD 0
5061 .RSs
5062 .IPs ch1,ch2,...
5063 The delay in ms that should be imposed on each channel
5064 (floating point number between 0 and 1000).
5066 .PD 1
5067 .sp 1
5069 To calculate the required delay for the different channels do as follows:
5070 .IP 1. 3
5071 Measure the distance to the loudspeakers in meters in relation
5072 to your listening position, giving you the distances s1 to s5
5073 (for a 5.1 system).
5074 There is no point in compensating for the subwoofer (you will not hear the
5075 difference anyway).
5076 .IP 2. 3
5077 Subtract the distances s1 to s5 from the maximum distance,
5078 i.e.\& s[i] = max(s) \- s[i]; i = 1...5.
5079 .IP 3.
5080 Calculate the required delays in ms as d[i] = 1000*s[i]/342; i = 1...5.
5082 .PD 0
5083 .sp 1
5085 .I EXAMPLE:
5087 .RSs
5088 .IPs "mplayer \-af delay=10.5:10.5:0:0:7:0 media.avi"
5089 Would delay front left and right by 10.5ms, the two rear channels
5090 and the sub by 0ms and the center channel by 7ms.
5092 .PD 1
5095 .B export[=mmapped_file[:nsamples]]
5096 Exports the incoming signal to other processes using memory mapping (mmap()).
5097 Memory mapped areas contain a header:
5098 .sp 1
5100 int nch                      /*number of channels*/
5101 int size                     /*buffer size*/
5102 unsigned long long counter   /*Used to keep sync, updated every
5103                                time new data is exported.*/
5105 .sp 1
5106 The rest is payload (non-interleaved) 16 bit data.
5107 .PD 0
5108 .RSs
5109 .IPs <mmapped_file>
5110 file to map data to (default: ~/.mplayer/\:mplayer-af_export)
5111 .IPs <nsamples>
5112 number of samples per channel (default: 512)
5114 .sp 1
5116 .I EXAMPLE:
5118 .RSs
5119 .IPs "mplayer \-af export=/tmp/mplayer-af_export:1024 media.avi"
5120 Would export 1024 samples per channel to '/tmp/mplayer-af_export'.
5122 .PD 1
5125 .B extrastereo[=mul]
5126 (Linearly) increases the difference between left and right channels
5127 which adds some sort of "live" effect to playback.
5128 .PD 0
5129 .RSs
5130 .IPs <mul>
5131 Sets the difference coefficient (default: 2.5).
5132 0.0 means mono sound (average of both channels), with 1.0 sound will be
5133 unchanged, with \-1.0 left and right channels will be swapped.
5135 .PD 1
5138 .B volnorm[=method:target]
5139 Maximizes the volume without distorting the sound.
5140 .PD 0
5141 .RSs
5142 .IPs <method>
5143 Sets the used method.
5144 .RSss
5145 1: Use a single sample to smooth the variations via the standard
5146 weighted mean over past samples (default).
5148 2: Use several samples to smooth the variations via the standard
5149 weighted mean over past samples.
5150 .REss
5151 .IPs <target>
5152 Sets the target amplitude as a fraction of the maximum for the
5153 sample type (default: 0.25).
5155 .PD 1
5158 .B ladspa=file:label[:controls...]
5159 Load a LADSPA (Linux Audio Developer's Simple Plugin API) plugin.
5160 This filter is reentrant, so multiple LADSPA plugins can be used at once.
5161 .PD 0
5162 .RSs
5163 .IPs <file>
5164 Specifies the LADSPA plugin library file.
5165 If LADSPA_PATH is set, it searches for the specified file.
5166 If it is not set, you must supply a fully specified pathname.
5167 .IPs <label>
5168 Specifies the filter within the library.
5169 Some libraries contain only one filter, but others contain many of them.
5170 Entering 'help' here, will list all available filters within the specified
5171 library, which eliminates the use of 'listplugins' from the LADSPA SDK.
5172 .IPs <controls>
5173 Controls are zero or more floating point values that determine the
5174 behavior of the loaded plugin (for example delay, threshold or gain).
5175 In verbose mode (add \-v to the MPlayer command line), all available controls
5176 and their valid ranges are printed.
5177 This eliminates the use of 'analyseplugin' from the LADSPA SDK.
5179 .PD 1
5182 .B "comp\ \ \ "
5183 Compressor/expander filter usable for microphone input.
5184 Prevents artifacts on very loud sound and raises the volume on
5185 very low sound.
5186 This filter is untested, maybe even unusable.
5189 .B "gate\ \ \ "
5190 Noise gate filter similar to the comp audio filter.
5191 This filter is untested, maybe even unusable.
5194 .B karaoke
5195 Simple voice removal filter exploiting the fact that voice is
5196 usually recorded with mono gear and later 'center' mixed onto
5197 the final audio stream.
5198 Beware that this filter will turn your signal into mono.
5199 Works well for 2 channel tracks; do not bother trying it
5200 on anything but 2 channel stereo.
5203 .B scaletempo[=option1:option2:...]
5204 Scales audio tempo without altering pitch, optionally synced to playback
5205 speed (default).
5207 This works by playing \'stride\' ms of audio at normal speed then
5208 consuming \'stride*scale\' ms of input audio.
5209 It pieces the strides together by blending 'overlap'% of stride with
5210 audio following the previous stride.
5211 It optionally performs a short statistical analysis on the next \'search\'
5212 ms of audio to determine the best overlap position.
5213 .PD 0
5214 .RSs
5215 .IPs scale=<amount>
5216 Nominal amount to scale tempo.
5217 Scales this amount in addition to speed.
5218 (default: 1.0)
5219 .IPs stride=<amount>
5220 Length in milliseconds to output each stride.
5221 Too high of value will cause noticable skips at high scale amounts and
5222 an echo at low scale amounts.
5223 Very low values will alter pitch.
5224 Increasing improves performance.
5225 (default: 60)
5226 .IPs overlap=<percent>
5227 Percentage of stride to overlap.
5228 Decreasing improves performance.
5229 (default: .20)
5230 .IPs search=<amount>
5231 Length in milliseconds to search for best overlap position.
5232 Decreasing improves performance greatly.
5233 On slow systems, you will probably want to set this very low.
5234 (default: 14)
5235 .IPs speed=<tempo|pitch|both|none>
5236 Set response to speed change.
5237 .RSss
5238 .IPs tempo
5239 Scale tempo in sync with speed (default)
5240 .IPs pitch
5241 Reverses effect of filter.
5242 Scales pitch without altering tempo.
5243 Add \'[ speed_mult 0.9438743126816935\' and \'] speed_mult 1.059463094352953\'
5244 to your input.conf to step by musical semi-tones.
5245 .I WARNING:
5246 Looses synch with video.
5247 .IPs both
5248 Scale both tempo and pitch
5249 .IPs none
5250 Ignore speed changes
5253 .sp 1
5255 .I EXAMPLE:
5257 .RSs
5258 .IPs "mplayer \-af scaletempo \-speed 1.2 media.ogg"
5259 Would playback media at 1.2x normal speed, with audio at normal pitch.
5260 Changing playback speed, would change audio tempo to match.
5261 .IPs "mplayer \-af scaletempo=scale=1.2:speed=none \-speed 1.2 media.ogg"
5262 Would playback media at 1.2x normal speed, with audio at normal pitch,
5263 but changing playback speed has no effect on audio tempo.
5264 .IPs "mplayer \-af scaletempo=stride=30:overlap=.50:search=10 media.ogg"
5265 Would tweak the quality and performace parameters.
5266 .IPs "mplayer \-af format=floatne,scaletempo media.ogg"
5267 Would make scaletempo use float code.
5268 Maybe faster on some platforms.
5269 .IPs "mplayer \-af scaletempo=scale=1.2:speed=pitch audio.ogg"
5270 Would playback audio file at 1.2x normal speed, with audio at normal pitch.
5271 Changing playback speed, would change pitch, leaving audio tempo at 1.2x.
5273 .PD 1
5277 .SH "VIDEO FILTERS"
5278 Video filters allow you to modify the video stream and its properties.
5279 The syntax is:
5282 .B \-vf <filter1[=parameter1:parameter2:...],filter2,...>
5283 Setup a chain of video filters.
5285 Many parameters are optional and set to default values if omitted.
5286 To explicitly use a default value set a parameter to '\-1'.
5287 Parameters w:h means width x height in pixels, x:y means x;y position counted
5288 from the upper left corner of the bigger image.
5290 .I NOTE:
5291 To get a full list of available video filters, see \-vf help.
5292 .sp 1
5293 Video filters are managed in lists.
5294 There are a few commands to manage the filter list.
5297 .B \-vf\-add <filter1[,filter2,...]>
5298 Appends the filters given as arguments to the filter list.
5301 .B \-vf\-pre <filter1[,filter2,...]>
5302 Prepends the filters given as arguments to the filter list.
5305 .B \-vf\-del <index1[,index2,...]>
5306 Deletes the filters at the given indexes.
5307 Index numbers start at 0, negative numbers address the end of the
5308 list (\-1 is the last).
5311 .B \-vf\-clr
5312 Completely empties the filter list.
5314 With filters that support it, you can access parameters by their name.
5317 .B \-vf <filter>=help
5318 Prints the parameter names and parameter value ranges for a particular
5319 filter.
5322 .B \-vf <filter=named_parameter1=value1[:named_parameter2=value2:...]>
5323 Sets a named parameter to the given value.
5324 Use on and off or yes and no to set flag parameters.
5326 Available filters are:
5329 .B crop[=w:h:x:y]
5330 Crops the given part of the image and discards the rest.
5331 Useful to remove black bands from widescreen movies.
5332 .PD 0
5333 .RSs
5334 .IPs <w>,<h>
5335 Cropped width and height, defaults to original width and height.
5336 .IPs <x>,<y>
5337 Position of the cropped picture, defaults to center.
5339 .PD 1
5342 .B cropdetect[=limit:round]
5343 Calculates necessary cropping parameters and prints the recommended parameters
5344 to stdout.
5345 .PD 0
5346 .RSs
5347 .IPs <limit>
5348 Threshold, which can be optionally specified from nothing (0) to
5349 everything (255) (default: 24).
5351 .IPs <round>
5352 Value which the width/\:height should be divisible by (default: 16).
5353 The offset is automatically adjusted to center the video.
5354 Use 2 to get only even dimensions (needed for 4:2:2 video).
5355 16 is best when encoding to most video codecs.
5357 .PD 1
5360 .B rectangle[=w:h:x:y]
5361 The plugin responds to the input.conf directive 'change_rectangle'
5362 that takes two parameters.
5363 .PD 0
5364 .RSs
5365 .IPs <w>,<h>
5366 width and height (default: \-1, maximum possible width where boundaries
5367 are still visible.)
5368 .IPs <x>,<y>
5369 top left corner position (default: \-1, uppermost leftmost)
5371 .PD 1
5374 .B expand[=w:h:x:y:o:a:r]
5375 Expands (not scales) movie resolution to the given value and places the
5376 unscaled original at coordinates x, y.
5377 Can be used for placing subtitles/\:OSD in the resulting black bands.
5378 .RSs
5379 .IPs <w>,<h>
5380 Expanded width,height (default: original width,height).
5381 Negative values for w and h are treated as offsets to the original size.
5382 .sp 1
5383 .I EXAMPLE:
5384 .PD 0
5385 .RSs
5386 .IP expand=0:\-50:0:0
5387 Adds a 50 pixel border to the bottom of the picture.
5389 .PD 1
5390 .IPs <x>,<y>
5391 position of original image on the expanded image (default: center)
5392 .IPs "<o>\ \ "
5393 OSD/\:subtitle rendering
5394 .RSss
5395 0: disable (default)
5397 1: enable
5398 .REss
5399 .IPs "<a>\ \ "
5400 Expands to fit an aspect instead of a resolution (default: 0).
5401 .sp 1
5402 .I EXAMPLE:
5403 .PD 0
5404 .RSs
5405 .IP expand=800:::::4/3
5406 Expands to 800x600, unless the source is higher resolution, in which
5407 case it expands to fill a 4/3 aspect.
5409 .PD 1
5410 .IPs "<r>\ \ "
5411 Rounds up to make both width and height divisible by <r> (default: 1).
5415 .B flip (also see \-flip)
5416 Flips the image upside down.
5419 .B "mirror\ "
5420 Mirrors the image on the Y axis.
5423 .B rotate[=<0\-7>]
5424 Rotates the image by 90 degrees and optionally flips it.
5425 For values between 4\-7 rotation is only done if the movie geometry is
5426 portrait and not landscape.
5427 .RSs
5428 .IPs 0
5429 Rotate by 90 degrees clockwise and flip (default).
5430 .IPs 1
5431 Rotate by 90 degrees clockwise.
5432 .IPs 2
5433 Rotate by 90 degrees counterclockwise.
5434 .IPs 3
5435 Rotate by 90 degrees counterclockwise and flip.
5439 .B scale[=w:h[:ilaced[:chr_drop[:par[:par2[:presize[:noup[:arnd]]]]]]]]
5440 Scales the image with the software scaler (slow) and performs a YUV<\->RGB
5441 colorspace conversion (also see \-sws).
5442 .RSs
5443 .IPs <w>,<h>
5444 scaled width/\:height (default: original width/\:height)
5446 .I NOTE:
5447 If \-zoom is used, and underlying filters (including libvo) are
5448 incapable of scaling, it defaults to d_width/\:d_height!
5449 .RSss
5450  0:   scaled d_width/\:d_height
5452 \-1:   original width/\:height
5454 \-2:   Calculate w/h using the other dimension and the prescaled aspect ratio.
5456 \-3:   Calculate w/h using the other dimension and the original aspect ratio.
5458 \-(n+8): Like \-n above, but rounding the dimension to the closest multiple of 16.
5459 .REss
5460 .IPs <ilaced>
5461 Toggle interlaced scaling.
5462 .RSss
5463 0: off (default)
5465 1: on
5466 .REss
5467 .IPs <chr_drop>
5468 chroma skipping
5469 .RSss
5470 0: Use all available input lines for chroma.
5472 1: Use only every 2. input line for chroma.
5474 2: Use only every 4. input line for chroma.
5476 3: Use only every 8. input line for chroma.
5477 .REss
5478 .IPs "<par>[:<par2>] (also see \-sws)"
5479 Set some scaling parameters depending on the type of scaler selected
5480 with \-sws.
5481 .RSss
5482 \-sws 2 (bicubic):  B (blurring) and C (ringing)
5484 0.00:0.60 default
5486 0.00:0.75 VirtualDub's "precise bicubic"
5488 0.00:0.50 Catmull-Rom spline
5490 0.33:0.33 Mitchell-Netravali spline
5492 1.00:0.00 cubic B-spline
5494 \-sws 7 (gaussian): sharpness (0 (soft) \- 100 (sharp))
5496 \-sws 9 (lanczos):  filter length (1\-10)
5497 .REss
5498 .IPs <presize>
5499 Scale to preset sizes.
5500 .RSss
5501 qntsc:   352x240 (NTSC quarter screen)
5503 qpal:    352x288 (PAL quarter screen)
5505 ntsc:    720x480 (standard NTSC)
5507 pal:     720x576 (standard PAL)
5509 sntsc:   640x480 (square pixel NTSC)
5511 spal:    768x576 (square pixel PAL)
5512 .REss
5513 .IPs <noup>
5514 Disallow upscaling past the original dimensions.
5515 .RSss
5516 0: Allow upscaling (default).
5518 1: Disallow upscaling if one dimension exceeds its original value.
5520 2: Disallow upscaling if both dimensions exceed their original values.
5521 .REss
5522 .IPs <arnd>
5523 Accurate rounding for the vertical scaler, which may be faster
5524 or slower than the default rounding.
5525 .RSss
5526 0: Disable accurate rounding (default).
5528 1: Enable accurate rounding.
5529 .REss
5533 .B dsize[=aspect|w:h:aspect-method:r]
5534 Changes the intended display size/\:aspect at an arbitrary point in the
5535 filter chain.
5536 Aspect can be given as a fraction (4/3) or floating point number
5537 (1.33).
5538 Alternatively, you may specify the exact display width and height
5539 desired.
5540 Note that this filter does
5541 .B not
5542 do any scaling itself; it just affects
5543 what later scalers (software or hardware) will do when auto-scaling to
5544 correct aspect.
5545 .RSs
5546 .IPs <w>,<h>
5547 New display width and height.
5548 Can also be these special values:
5549 .RSss
5550  0:   original display width and height
5552 \-1:   original video width and height (default)
5554 \-2:   Calculate w/h using the other dimension and the original display
5555 aspect ratio.
5557 \-3:   Calculate w/h using the other dimension and the original video
5558 aspect ratio.
5559 .REss
5560 .sp 1
5561 .I EXAMPLE:
5562 .PD 0
5563 .RSs
5564 .IP dsize=800:\-2
5565 Specifies a display resolution of 800x600 for a 4/3 aspect video, or
5566 800x450 for a 16/9 aspect video.
5568 .IPs <aspect-method>
5569 Modifies width and height according to original aspect ratios.
5570 .RSss
5571 \-1: Ignore original aspect ratio (default).
5573  0: Keep display aspect ratio by using <w> and <h> as maximum
5574 resolution.
5576  1: Keep display aspect ratio by using <w> and <h> as minimum
5577 resolution.
5579  2: Keep video aspect ratio by using <w> and <h> as maximum
5580 resolution.
5582  3: Keep video aspect ratio by using <w> and <h> as minimum
5583 resolution.
5584 .REss
5585 .sp 1
5586 .I EXAMPLE:
5587 .PD 0
5588 .RSs
5589 .IP dsize=800:600:0
5590 Specifies a display resolution of at most 800x600, or smaller, in order
5591 to keep aspect.
5593 .PD 1
5594 .IPs "<r>\ \ "
5595 Rounds up to make both width and height divisible by <r> (default: 1).
5599 .B "yuy2\ \ \ "
5600 Forces software YV12/\:I420/\:422P to YUY2 conversion.
5601 Useful for video cards/\:drivers with slow YV12 but fast YUY2 support.
5604 .B "yvu9\ \ \ "
5605 Forces software YVU9 to YV12 colorspace conversion.
5606 Deprecated in favor of the software scaler.
5609 .B "yuvcsp\ "
5610 Clamps YUV color values to the CCIR 601 range without doing real conversion.
5613 .B rgb2bgr[=swap]
5614 RGB 24/32 <\-> BGR 24/32 colorspace conversion.
5615 .PD 0
5616 .RSs
5617 .IPs "swap\ "
5618 Also perform  R <\-> B swapping.
5620 .PD 1
5623 .B palette
5624 RGB/BGR 8 \-> 15/16/24/32bpp colorspace conversion using palette.
5627 .B format[=fourcc]
5628 Restricts the colorspace for the next filter without doing any conversion.
5629 Use together with the scale filter for a real conversion.
5631 .I NOTE:
5632 For a list of available formats see format=fmt=help.
5633 .PD 0
5634 .RSs
5635 .IPs <fourcc>
5636 format name like rgb15, bgr24, yv12, etc (default: yuy2)
5638 .PD 1
5641 .B noformat[=fourcc]
5642 Restricts the colorspace for the next filter without doing any conversion.
5643 Unlike the format filter, this will allow any colorspace
5644 .B except
5645 the one you specify.
5647 .I NOTE:
5648 For a list of available formats see noformat=fmt=help.
5649 .PD 0
5650 .RSs
5651 .IPs <fourcc>
5652 format name like rgb15, bgr24, yv12, etc (default: yv12)
5654 .PD 1
5657 .B pp[=filter1[:option1[:option2...]]/[\-]filter2...] (also see \-pphelp)
5658 Enables the specified chain of postprocessing subfilters.
5659 Subfilters must be separated by '/' and can be disabled by
5660 prepending a '\-'.
5661 Each subfilter and some options have a short and a long name that can be
5662 used interchangeably, i.e.\& dr/dering are the same.
5663 All subfilters share common options to determine their scope:
5664 .PD 0
5665 .RSs
5666 .IPs a/autoq
5667 Automatically switch the subfilter off if the CPU is too slow.
5668 .IPs c/chrom
5669 Do chrominance filtering, too (default).
5670 .IPs y/nochrom
5671 Do luminance filtering only (no chrominance).
5672 .IPs n/noluma
5673 Do chrominance filtering only (no luminance).
5675 .PD 1
5676 .sp 1
5679 .I NOTE:
5680 \-pphelp shows a list of available subfilters.
5681 .sp 1
5682 Available subfilters are
5684 .RSs
5685 .IPs hb/hdeblock[:difference[:flatness]]
5686 horizontal deblocking filter
5687 .RSss
5688 <difference>: Difference factor where higher values mean
5689 more deblocking (default: 32).
5691 <flatness>: Flatness threshold where lower values mean
5692 more deblocking (default: 39).
5693 .REss
5694 .IPs vb/vdeblock[:difference[:flatness]]
5695 vertical deblocking filter
5696 .RSss
5697 <difference>: Difference factor where higher values mean
5698 more deblocking (default: 32).
5700 <flatness>: Flatness threshold where lower values mean
5701 more deblocking (default: 39).
5702 .REss
5703 .IPs ha/hadeblock[:difference[:flatness]]
5704 accurate horizontal deblocking filter
5705 .RSss
5706 <difference>: Difference factor where higher values mean
5707 more deblocking (default: 32).
5709 <flatness>: Flatness threshold where lower values mean
5710 more deblocking (default: 39).
5711 .REss
5712 .IPs va/vadeblock[:difference[:flatness]]
5713 accurate vertical deblocking filter
5714 .RSss
5715 <difference>: Difference factor where higher values mean
5716 more deblocking (default: 32).
5718 <flatness>: Flatness threshold where lower values mean
5719 more deblocking (default: 39).
5720 .REss
5721 .sp 1
5722 The horizontal and vertical deblocking filters share the
5723 difference and flatness values so you cannot set
5724 different horizontal and vertical thresholds.
5725 .sp 1
5726 .IPs h1/x1hdeblock
5727 experimental horizontal deblocking filter
5728 .IPs v1/x1vdeblock
5729 experimental vertical deblocking filter
5730 .IPs dr/dering
5731 deringing filter
5732 .IPs tn/tmpnoise[:threshold1[:threshold2[:threshold3]]]
5733 temporal noise reducer
5734 .RSss
5735 <threshold1>: larger -> stronger filtering
5737 <threshold2>: larger -> stronger filtering
5739 <threshold3>: larger -> stronger filtering
5740 .REss
5741 .IPs al/autolevels[:f/fullyrange]
5742 automatic brightness / contrast correction
5743 .RSss
5744 f/fullyrange: Stretch luminance to (0\-255).
5745 .REss
5746 .IPs lb/linblenddeint
5747 Linear blend deinterlacing filter that deinterlaces the given block
5748 by filtering all lines with a (1 2 1) filter.
5749 .IPs li/linipoldeint
5750 Linear interpolating deinterlacing filter that deinterlaces the given block
5751 by linearly interpolating every second line.
5752 .IPs ci/cubicipoldeint
5753 Cubic interpolating deinterlacing filter deinterlaces the given block
5754 by cubically interpolating every second line.
5755 .IPs md/mediandeint
5756 Median deinterlacing filter that deinterlaces the given block
5757 by applying a median filter to every second line.
5758 .IPs fd/ffmpegdeint
5759 FFmpeg deinterlacing filter that deinterlaces the given block
5760 by filtering every second line with a (\-1 4 2 4 \-1) filter.
5761 .IPs l5/lowpass5
5762 Vertically applied FIR lowpass deinterlacing filter that deinterlaces
5763 the given block by filtering all lines with a (\-1 2 6 2 \-1) filter.
5764 .IPs fq/forceQuant[:quantizer]
5765 Overrides the quantizer table from the input with the constant
5766 quantizer you specify.
5767 .RSss
5768 <quantizer>: quantizer to use
5769 .REss
5770 .IPs de/default
5771 default pp filter combination (hb:a,vb:a,dr:a)
5772 .IPs fa/fast
5773 fast pp filter combination (h1:a,v1:a,dr:a)
5774 .IPs "ac\ \ \ "
5775 high quality pp filter combination (ha:a:128:7,va:a,dr:a)
5778 .sp 1
5779 .I EXAMPLE:
5781 .PD 0
5782 .RSs
5783 .IPs "\-vf pp=hb/vb/dr/al"
5784 horizontal and vertical deblocking, deringing and automatic
5785 brightness/\:contrast
5786 .IPs "\-vf pp=de/\-al"
5787 default filters without brightness/\:contrast correction
5788 .IPs "\-vf pp=default/tmpnoise:1:2:3"
5789 Enable default filters & temporal denoiser.
5790 .IPs "\-vf pp=hb:y/vb:a"
5791 Horizontal deblocking on luminance only, and switch vertical deblocking
5792 on or off automatically depending on available CPU time.
5794 .PD 1
5797 .B spp[=quality[:qp[:mode]]]
5798 Simple postprocessing filter that compresses and decompresses the
5799 image at several (or \- in the case of quality level 6 \- all)
5800 shifts and averages the results.
5801 .RSs
5802 .IPs <quality>
5803 0\-6 (default: 3)
5804 .IPs "<qp>\ "
5805 Force quantization parameter (default: 0, use QP from video).
5806 .IPs <mode>
5807 0: hard thresholding (default)
5809 1: soft thresholding (better deringing, but blurrier)
5811 4: like 0, but also use B-frames' QP (may cause flicker)
5813 5: like 1, but also use B-frames' QP (may cause flicker)
5817 .B uspp[=quality[:qp]]
5818 Ultra simple & slow postprocessing filter that compresses and
5819 decompresses the image at several (or \- in the case of quality
5820 level 8 \- all) shifts and averages the results.
5821 The way this differs from the behavior of spp is that uspp actually
5822 encodes & decodes each case with libavcodec Snow, whereas spp uses
5823 a simplified intra only 8x8 DCT similar to MJPEG.
5824 .RSs
5825 .IPs <quality>
5826 0\-8 (default: 3)
5827 .IPs "<qp>\ "
5828 Force quantization parameter (default: 0, use QP from video).
5832 .B fspp[=quality[:qp[:strength[:bframes]]]]
5833 faster version of the simple postprocessing filter
5834 .RSs
5835 .IPs <quality>
5836 4\-5 (equivalent to spp; default: 4)
5837 .IPs "<qp>\ "
5838 Force quantization parameter (default: 0, use QP from video).
5839 .IPs <\-15\-32>
5840 Filter strength, lower values mean more details but also more artifacts,
5841 while higher values make the image smoother but also blurrier (default:
5842 0 \- PSNR optimal).
5843 .IPs <bframes>
5844 0: do not use QP from B-frames (default)
5846 1: use QP from B-frames too (may cause flicker)
5850 .B pp7[=qp[:mode]]
5851 Variant of the spp filter, similar to spp=6 with 7 point DCT where
5852 only the center sample is used after IDCT.
5853 .RSs
5854 .IPs "<qp>\ "
5855 Force quantization parameter (default: 0, use QP from video).
5856 .IPs <mode>
5857 0: hard thresholding
5859 1: soft thresholding (better deringing, but blurrier)
5861 2: medium thresholding (default, good results)
5865 .B qp=equation
5866 quantization parameter (QP) change filter
5867 .RSs
5868 .IPs <equation>
5869 some equation like "2+2*sin(PI*qp)"
5873 .B geq=equation
5874 generic equation change filter
5875 .RSs
5876 .IPs <equation>
5877 Some equation, e.g.\&  'p(W-X\\,Y)' to flip the image horizontally.
5878 You can use whitespace to make the equation more readable.
5879 There are a couple of constants that can be used in the equation:
5880 .RSss
5881 PI: the number pi
5883 E: the number e
5885 X / Y: the coordinates of the current sample
5887 W / H: width and height of the image
5889 SW / SH: width/height scale depending on the currently filtered plane, e.g.\&
5890 1,1 and 0.5,0.5 for YUV 4:2:0.
5892 p(x,y): returns the value of the pixel at location x/y of the current plane.
5893 .REss
5897 .B "test\ \ \ "
5898 Generate various test patterns.
5901 .B rgbtest
5902 Generate an RGB test pattern useful for detecting RGB vs BGR issues.
5903 You should see a red, green and blue stripe from top to bottom.
5906 .B lavc[=quality:fps]
5907 Fast software YV12 to MPEG-1 conversion with libavcodec for use with DVB/\:DXR3/\:IVTV/\:V4L2.
5908 .RSs
5909 .IPs <quality>
5910 1\-31: fixed qscale
5912 32\-:  fixed bitrate in kbits
5913 .IPs <fps>
5914 force output fps (float value) (default: 0, autodetect based on height)
5918 .B dvbscale[=aspect]
5919 Set up optimal scaling for DVB cards, scaling the x axis in hardware and
5920 calculating the y axis scaling in software to keep aspect.
5921 Only useful together with expand and scale.
5922 .RSs
5923 .IPs <aspect>
5924 Control aspect ratio, calculate as DVB_HEIGHT*ASPECTRATIO (default:
5925 576*4/3=768), set it to 576*(16/9)=1024 for a 16:9 TV.
5927 .sp 1
5929 .I EXAMPLE:
5931 .PD 0
5932 .RSs
5933 .IPs "\-vf dvbscale,scale=\-1:0,expand=\-1:576:\-1:\-1:1,lavc"
5934 FIXME: Explain what this does.
5936 .PD 1
5939 .B noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]]
5940 Adds noise.
5941 .PD 0
5942 .RSs
5943 .IPs <0\-100>
5944 luma noise
5945 .IPs <0\-100>
5946 chroma noise
5947 .IPs u
5948 uniform noise (gaussian otherwise)
5949 .IPs t
5950 temporal noise (noise pattern changes between frames)
5951 .IPs a
5952 averaged temporal noise (smoother, but a lot slower)
5953 .IPs h
5954 high quality (slightly better looking, slightly slower)
5955 .IPs p
5956 mix random noise with a (semi)regular pattern
5958 .PD 1
5961 .B denoise3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
5962 This filter aims to reduce image noise producing smooth images and making still
5963 images really still (This should enhance compressibility.).
5964 .PD 0
5965 .RSs
5966 .IPs <luma_spatial>
5967 spatial luma strength (default: 4)
5968 .IPs <chroma_spatial>
5969 spatial chroma strength (default: 3)
5970 .IPs <luma_tmp>
5971 luma temporal strength (default: 6)
5972 .IPs <chroma_tmp>
5973 chroma temporal strength (default: luma_tmp*chroma_spatial/luma_spatial)
5975 .PD 1
5978 .B hqdn3d[=luma_spatial:chroma_spatial:luma_tmp:chroma_tmp]
5979 High precision/\:quality version of the denoise3d filter.
5980 Parameters and usage are the same.
5983 .B ow[=depth[:luma_strength[:chroma_strength]]]
5984 Overcomplete Wavelet denoiser.
5985 .PD 0
5986 .RSs
5987 .IPs <depth>
5988 Larger depth values will denoise lower frequency components more, but
5989 slow down filtering (default: 8).
5990 .IPs <luma_strength>
5991 luma strength (default: 1.0)
5992 .IPs <chroma_strength>
5993 chroma strength (default: 1.0)
5995 .PD 1
5998 .B eq[=brightness:contrast] (OBSOLETE)
5999 Software equalizer with interactive controls just like the hardware
6000 equalizer, for cards/\:drivers that do not support brightness and
6001 contrast controls in hardware.
6002 Might also be useful with MEncoder, either for fixing poorly captured
6003 movies, or for slightly reducing contrast to mask artifacts and get by
6004 with lower bitrates.
6005 .PD 0
6006 .RSs
6007 .IPs <\-100\-100>
6008 initial brightness
6009 .IPs <\-100\-100>
6010 initial contrast
6012 .PD 1
6015 .B eq2[=gamma:contrast:brightness:saturation:rg:gg:bg:weight]
6016 Alternative software equalizer that uses lookup tables (very slow),
6017 allowing gamma correction in addition to simple brightness
6018 and contrast adjustment.
6019 Note that it uses the same MMX optimized code as \-vf eq if all
6020 gamma values are 1.0.
6021 The parameters are given as floating point values.
6022 .PD 0
6023 .RSs
6024 .IPs <0.1\-10>
6025 initial gamma value (default: 1.0)
6026 .IPs <\-2\-2>
6027 initial contrast, where negative values result in a
6028 negative image (default: 1.0)
6029 .IPs <\-1\-1>
6030 initial brightness (default: 0.0)
6031 .IPs <0\-3>
6032 initial saturation (default: 1.0)
6033 .IPs <0.1\-10>
6034 gamma value for the red component (default: 1.0)
6035 .IPs <0.1\-10>
6036 gamma value for the green component (default: 1.0)
6037 .IPs <0.1\-10>
6038 gamma value for the blue component (default: 1.0)
6039 .IPs <0\-1>
6040 The weight parameter can be used to reduce the effect of a high gamma value on
6041 bright image areas, e.g.\& keep them from getting overamplified and just plain
6042 white.
6043 A value of 0.0 turns the gamma correction all the way down while 1.0 leaves it
6044 at its full strength (default: 1.0).
6046 .PD 1
6049 .B hue[=hue:saturation]
6050 Software equalizer with interactive controls just like the hardware
6051 equalizer, for cards/\:drivers that do not support hue and
6052 saturation controls in hardware.
6053 .PD 0
6054 .RSs
6055 .IPs <\-180\-180>
6056 initial hue (default: 0.0)
6057 .IPs <\-100\-100>
6058 initial saturation, where negative values result
6059 in a negative chroma (default: 1.0)
6061 .PD 1
6064 .B halfpack[=f]
6065 Convert planar YUV 4:2:0 to half-height packed 4:2:2, downsampling luma but
6066 keeping all chroma samples.
6067 Useful for output to low-resolution display devices when hardware downscaling
6068 is poor quality or is not available.
6069 Can also be used as a primitive luma-only deinterlacer with very low CPU
6070 usage.
6071 .PD 0
6072 .RSs
6073 .IPs "<f>\ \ "
6074 By default, halfpack averages pairs of lines when downsampling.
6075 Any value different from 0 or 1 gives the default (averaging) behavior.
6076 .RSss
6077 0: Only use even lines when downsampling.
6079 1: Only use odd lines when downsampling.
6080 .REss
6082 .PD 1
6085 .B ilpack[=mode]
6086 When interlaced video is stored in YUV 4:2:0 formats, chroma
6087 interlacing does not line up properly due to vertical downsampling of
6088 the chroma channels.
6089 This filter packs the planar 4:2:0 data into YUY2 (4:2:2) format with
6090 the chroma lines in their proper locations, so that in any given
6091 scanline, the luma and chroma data both come from the same field.
6092 .PD 0
6093 .RSs
6094 .IPs <mode>
6095 Select the sampling mode.
6096 .RSss
6097 0: nearest-neighbor sampling, fast but incorrect
6099 1: linear interpolation (default)
6100 .REss
6102 .PD 1
6105 .B harddup
6106 Only useful with MEncoder.
6107 If harddup is used when encoding, it will force duplicate frames to be
6108 encoded in the output.
6109 This uses slightly more space, but is necessary for output to MPEG
6110 files or if you plan to demux and remux the video stream after
6111 encoding.
6112 Should be placed at or near the end of the filter chain unless you
6113 have a good reason to do otherwise.
6116 .B softskip
6117 Only useful with MEncoder.
6118 Softskip moves the frame skipping (dropping) step of encoding from
6119 before the filter chain to some point during the filter chain.
6120 This allows filters which need to see all frames (inverse telecine,
6121 temporal denoising, etc.) to function properly.
6122 Should be placed after the filters which need to see all frames and
6123 before any subsequent filters that are CPU-intensive.
6126 .B decimate[=max:hi:lo:frac]
6127 Drops frames that do not differ greatly from the previous frame in
6128 order to reduce framerate.
6129 The main use of this filter is for very-low-bitrate encoding (e.g.\&
6130 streaming over dialup modem), but it could in theory be used for
6131 fixing movies that were inverse-telecined incorrectly.
6132 .PD 0
6133 .RSs
6134 .IPs <max>
6135 Sets the maximum number of consecutive frames which can be
6136 dropped (if positive), or the minimum interval between
6137 dropped frames (if negative).
6138 .IPs <hi>,<lo>,<frac>
6139 A frame is a candidate for dropping if no 8x8 region differs by more
6140 than a threshold of <hi>, and if not more than <frac> portion (1
6141 meaning the whole image) differs by more than a threshold of <lo>.
6142 Values of <hi> and <lo> are for 8x8 pixel blocks and represent actual
6143 pixel value differences, so a threshold of 64 corresponds to 1 unit of
6144 difference for each pixel, or the same spread out differently over the
6145 block.
6147 .PD 1
6150 .B dint[=sense:level]
6151 The drop-deinterlace (dint) filter detects and drops the first from a set
6152 of interlaced video frames.
6153 .PD 0
6154 .RSs
6155 .IPs <0.0\-1.0>
6156 relative difference between neighboring pixels (default: 0.1)
6157 .IPs <0.0\-1.0>
6158 What part of the image has to be detected as interlaced to
6159 drop the frame (default: 0.15).
6161 .PD 1
6164 .B lavcdeint (OBSOLETE)
6165 FFmpeg deinterlacing filter, same as \-vf pp=fd
6168 .B kerndeint[=thresh[:map[:order[:sharp[:twoway]]]]]
6169 Donald Graft's adaptive kernel deinterlacer.
6170 Deinterlaces parts of a video if a configurable threshold is exceeded.
6171 .PD 0
6172 .RSs
6173 .IPs <0\-255>
6174 threshold (default: 10)
6175 .IPs <map>
6176 .RSss
6177 0: Ignore pixels exceeding the threshold (default).
6179 1: Paint pixels exceeding the threshold white.
6180 .REss
6181 .IPs <order>
6182 .RSss
6183 0: Leave fields alone (default).
6185 1: Swap fields.
6186 .REss
6187 .IPs <sharp>
6188 .RSss
6189 0: Disable additional sharpening (default).
6191 1: Enable additional sharpening.
6192 .REss
6193 .IPs <twoway>
6194 .RSss
6195 0: Disable twoway sharpening (default).
6197 1: Enable twoway sharpening.
6198 .REss
6200 .PD 1
6203 .B unsharp[=l|cWxH:amount[:l|cWxH:amount]]
6204 unsharp mask / gaussian blur
6205 .RSs
6206 .IPs "l\ \ \ \ "
6207 Apply effect on luma component.
6208 .IPs "c\ \ \ \ "
6209 Apply effect on chroma components.
6210 .IPs <width>x<height>
6211 width and height of the matrix, odd sized in both directions
6212 (min = 3x3, max = 13x11 or 11x13, usually something between 3x3 and 7x7)
6213 .IPs amount
6214 Relative amount of sharpness/\:blur to add to the image
6215 (a sane range should be \-1.5\-1.5).
6216 .RSss
6217 <0: blur
6219 >0: sharpen
6220 .REss
6224 .B "swapuv\ "
6225 Swap U & V plane.
6228 .B il[=d|i][s][:[d|i][s]]
6229 (De)interleaves lines.
6230 The goal of this filter is to add the ability to process interlaced images
6231 pre-field without deinterlacing them.
6232 You can filter your interlaced DVD and play it on a TV without breaking the
6233 interlacing.
6234 While deinterlacing (with the postprocessing filter) removes interlacing
6235 permanently (by smoothing, averaging, etc) deinterleaving splits the frame into
6236 2 fields (so called half pictures), so you can process (filter) them
6237 independently and then re-interleave them.
6238 .PD 0
6239 .RSs
6240 .IPs d
6241 deinterleave (placing one above the other)
6242 .IPs i
6243 interleave
6244 .IPs s
6245 swap fields (exchange even & odd lines)
6247 .PD 1
6250 .B fil[=i|d]
6251 (De)interleaves lines.
6252 This filter is very similar to the il filter but much faster, the main
6253 disadvantage is that it does not always work.
6254 Especially if combined with other filters it may produce randomly messed
6255 up images, so be happy if it works but do not complain if it does not for
6256 your combination of filters.
6257 .PD 0
6258 .RSs
6259 .IPs d
6260 Deinterleave fields, placing them side by side.
6261 .IPs i
6262 Interleave fields again (reversing the effect of fil=d).
6264 .PD 1
6267 .B field[=n]
6268 Extracts a single field from an interlaced image using stride arithmetic
6269 to avoid wasting CPU time.
6270 The optional argument n specifies whether to extract the even or the odd
6271 field (depending on whether n is even or odd).
6274 .B detc[=var1=value1:var2=value2:...]
6275 Attempts to reverse the 'telecine' process to recover a clean,
6276 non-interlaced stream at film framerate.
6277 This was the first and most primitive inverse telecine filter to be
6278 added to MPlayer/\:MEncoder.
6279 It works by latching onto the telecine 3:2 pattern and following it as
6280 long as possible.
6281 This makes it suitable for perfectly-telecined material, even in the
6282 presence of a fair degree of noise, but it will fail in the presence
6283 of complex post-telecine edits.
6284 Development on this filter is no longer taking place, as ivtc, pullup,
6285 and filmdint are better for most applications.
6286 The following arguments (see syntax above) may be used to control
6287 detc's behavior:
6288 .RSs
6289 .IPs "<dr>\ "
6290 Set the frame dropping mode.
6291 .RSss
6292 0: Do not drop frames to maintain fixed output framerate (default).
6294 1: Always drop a frame when there have been no drops or telecine
6295 merges in the past 5 frames.
6297 2: Always maintain exact 5:4 input to output frame ratio.
6299 .I NOTE:
6300 Use mode 1 or 2 with MEncoder.
6301 .REss
6302 .IPs "<am>\ "
6303 Analysis mode.
6304 .RSss
6305 0: Fixed pattern with initial frame number specified by <fr>.
6307 1: aggressive search for telecine pattern (default)
6308 .REss
6309 .IPs "<fr>\ "
6310 Set initial frame number in sequence.
6311 0\-2 are the three clean progressive frames; 3 and 4 are the two
6312 interlaced frames.
6313 The default, \-1, means 'not in telecine sequence'.
6314 The number specified here is the type for the imaginary previous
6315 frame before the movie starts.
6316 .IPs "<t0>, <t1>, <t2>, <t3>"
6317 Threshold values to be used in certain modes.
6321 .B ivtc[=1]
6322 Experimental 'stateless' inverse telecine filter.
6323 Rather than trying to lock on to a pattern like the detc filter does,
6324 ivtc makes its decisions independently for each frame.
6325 This will give much better results for material that has undergone
6326 heavy editing after telecine was applied, but as a result it is not as
6327 forgiving of noisy input, for example TV capture.
6328 The optional parameter (ivtc=1) corresponds to the dr=1 option for the
6329 detc filter, and should be used with MEncoder but not with MPlayer.
6330 As with detc, you must specify the correct output framerate (\-ofps
6331 24000/1001) when using MEncoder.
6332 Further development on ivtc has stopped, as the pullup and filmdint
6333 filters appear to be much more accurate.
6336 .B pullup[=jl:jr:jt:jb:sb:mp]
6337 Third-generation pulldown reversal (inverse telecine) filter,
6338 capable of handling mixed hard-telecine, 24000/1001 fps progressive, and 30000/1001
6339 fps progressive content.
6340 The pullup filter is designed to be much more robust than detc or
6341 ivtc, by taking advantage of future context in making its decisions.
6342 Like ivtc, pullup is stateless in the sense that it does not lock onto
6343 a pattern to follow, but it instead looks forward to the following
6344 fields in order to identify matches and rebuild progressive frames.
6345 It is still under development, but believed to be quite accurate.
6346 .RSs
6347 .IPs "jl, jr, jt, and jb"
6348 These options set the amount of "junk" to ignore at
6349 the left, right, top, and bottom of the image, respectively.
6350 Left/\:right are in units of 8 pixels, while top/\:bottom are in units of
6351 2 lines.
6352 The default is 8 pixels on each side.
6354 .IPs "sb (strict breaks)"
6355 Setting this option to 1 will reduce the chances of
6356 pullup generating an occasional mismatched frame, but it may also
6357 cause an excessive number of frames to be dropped during high motion
6358 sequences.
6359 Conversely, setting it to \-1 will make pullup match fields more
6360 easily.
6361 This may help processing of video where there is slight blurring
6362 between the fields, but may also cause there to be interlaced frames
6363 in the output.
6365 .IPs "mp (metric plane)"
6366 This option may be set to 1 or 2 to use a chroma
6367 plane instead of the luma plane for doing pullup's computations.
6368 This may improve accuracy on very clean source material, but more
6369 likely will decrease accuracy, especially if there is chroma noise
6370 (rainbow effect) or any grayscale video.
6371 The main purpose of setting mp to a chroma plane is to reduce CPU load
6372 and make pullup usable in realtime on slow machines.
6373 .REss
6375 .sp 1
6376 .I NOTE:
6377 Always follow pullup with the softskip filter when encoding to ensure
6378 that pullup is able to see each frame.
6379 Failure to do so will lead to incorrect output and will usually crash,
6380 due to design limitations in the codec/\:filter layer.
6381 .REss
6384 .B filmdint[=options]
6385 Inverse telecine filter, similar to the pullup filter above.
6386 It is designed to handle any pulldown pattern, including mixed soft and
6387 hard telecine and limited support for movies that are slowed down or sped
6388 up from their original framerate for TV.
6389 Only the luma plane is used to find the frame breaks.
6390 If a field has no match, it is deinterlaced with simple linear
6391 approximation.
6392 If the source is MPEG-2, this must be the first filter to allow
6393 access to the field-flags set by the MPEG-2 decoder.
6394 Depending on the source MPEG, you may be fine ignoring this advice, as
6395 long as you do not see lots of "Bottom-first field" warnings.
6396 With no options it does normal inverse telecine, and should be used
6397 together with mencoder \-fps 30000/1001 \-ofps 24000/1001.
6398 When this filter is used with mplayer, it will result in an uneven
6399 framerate during playback, but it is still generally better than using
6400 pp=lb or no deinterlacing at all.
6401 Multiple options can be specified separated by /.
6402 .RSs
6403 .IPs crop=<w>:<h>:<x>:<y>
6404 Just like the crop filter, but faster, and works on mixed hard and soft
6405 telecined content as well as when y is not a multiple of 4.
6406 If x or y would require cropping fractional pixels from the chroma
6407 planes, the crop area is extended.
6408 This usually means that x and y must be even.
6409 .IPs io=<ifps>:<ofps>
6410 For each ifps input frames the filter will output ofps frames.
6411 The ratio of ifps/\:ofps should match the \-fps/\-ofps ratio.
6412 This could be used to filter movies that are broadcast on TV at a frame
6413 rate different from their original framerate.
6414 .IPs luma_only=<n>
6415 If n is nonzero, the chroma plane is copied unchanged.
6416 This is useful for YV12 sampled TV, which discards one of the chroma
6417 fields.
6418 .IPs mmx2=<n>
6419 On x86, if n=1, use MMX2 optimized functions, if n=2, use 3DNow!
6420 optimized functions, otherwise, use plain C.
6421 If this option is not specified, MMX2 and 3DNow! are auto-detected, use
6422 this option to override auto-detection.
6423 .IPs fast=<n>
6424 The larger n will speed up the filter at the expense of accuracy.
6425 The default value is n=3.
6426 If n is odd, a frame immediately following a frame marked with the
6427 REPEAT_FIRST_FIELD MPEG flag is assumed to be progressive, thus filter
6428 will not spend any time on soft-telecined MPEG-2 content.
6429 This is the only effect of this flag if MMX2 or 3DNow! is available.
6430 Without MMX2 and 3DNow, if n=0 or 1, the same calculations will be used
6431 as with n=2 or 3.
6432 If n=2 or 3, the number of luma levels used to find the frame breaks is
6433 reduced from 256 to 128, which results in a faster filter without losing
6434 much accuracy.
6435 If n=4 or 5, a faster, but much less accurate metric will be used to
6436 find the frame breaks, which is more likely to misdetect high vertical
6437 detail as interlaced content.
6438 .IPs verbose=<n>
6439 If n is nonzero, print the detailed metrics for each frame.
6440 Useful for debugging.
6441 .IPs dint_thres=<n>
6442 Deinterlace threshold.
6443 Used during de-interlacing of unmatched frames.
6444 Larger value means less deinterlacing, use n=256 to completely turn off
6445 deinterlacing.
6446 Default is n=8.
6447 .IPs comb_thres=<n>
6448 Threshold for comparing a top and bottom fields.
6449 Defaults to 128.
6450 .IPs diff_thres=<n>
6451 Threshold to detect temporal change of a field.
6452 Default is 128.
6453 .IPs sad_thres=<n>
6454 Sum of Absolute Difference threshold, default is 64.
6458 .B softpulldown
6459 This filter works only correct with MEncoder and acts on the MPEG-2 flags
6460 used for soft 3:2 pulldown (soft telecine).
6461 If you want to use the ivtc or detc filter on movies that are partly soft
6462 telecined, inserting this filter before them should make them more reliable.
6465 .B divtc[=options]
6466 Inverse telecine for deinterlaced video.
6467 If 3:2-pulldown telecined video has lost one of the fields or is deinterlaced
6468 using a method that keeps one field and interpolates the other, the result is
6469 a juddering video that has every fourth frame duplicated.
6470 This filter is intended to find and drop those duplicates and restore the
6471 original film framerate.
6472 When using this filter, you must specify \-ofps that is 4/5 of
6473 the fps of the input file and place the softskip later in the
6474 filter chain to make sure that divtc sees all the frames.
6475 Two different modes are available:
6476 One pass mode is the default and is straightforward to use,
6477 but has the disadvantage that any changes in the telecine
6478 phase (lost frames or bad edits) cause momentary judder
6479 until the filter can resync again.
6480 Two pass mode avoids this by analyzing the whole video
6481 beforehand so it will have forward knowledge about the
6482 phase changes and can resync at the exact spot.
6483 These passes do
6484 .B not
6485 correspond to pass one and two of the encoding process.
6486 You must run an extra pass using divtc pass one before the
6487 actual encoding throwing the resulting video away.
6488 Use \-nosound \-ovc raw \-o /dev/null to avoid
6489 wasting CPU power for this pass.
6490 You may add something like crop=2:2:0:0 after divtc
6491 to speed things up even more.
6492 Then use divtc pass two for the actual encoding.
6493 If you use multiple encoder passes, use divtc
6494 pass two for all of them.
6495 The options are:
6496 .RSs
6497 .IPs pass=1|2
6498 Use two pass mode.
6499 .IPs file=<filename>
6500 Set the two pass log filename (default: "framediff.log").
6501 .IPs threshold=<value>
6502 Set the minimum strength the telecine pattern must have for the filter to
6503 believe in it (default: 0.5).
6504 This is used to avoid recognizing false pattern from the parts of the video
6505 that are very dark or very still.
6506 .IPs window=<numframes>
6507 Set the number of past frames to look at when searching for pattern
6508 (default: 30).
6509 Longer window improves the reliability of the pattern search, but shorter
6510 window improves the reaction time to the changes in the telecine phase.
6511 This only affects the one pass mode.
6512 The two pass mode currently uses fixed window that extends to both future
6513 and past.
6514 .IPs phase=0|1|2|3|4
6515 Sets the initial telecine phase for one pass mode (default: 0).
6516 The two pass mode can see the future, so it is able to use the correct
6517 phase from the beginning, but one pass mode can only guess.
6518 It catches the correct phase when it finds it, but this option can be used
6519 to fix the possible juddering at the beginning.
6520 The first pass of the two pass mode also uses this, so if you save the output
6521 from the first pass, you get constant phase result.
6522 .IPs deghost=<value>
6523 Set the deghosting threshold (0\-255 for one pass mode, \-255\-255 for two pass
6524 mode, default 0).
6525 If nonzero, deghosting mode is used.
6526 This is for video that has been deinterlaced by blending the fields
6527 together instead of dropping one of the fields.
6528 Deghosting amplifies any compression artifacts in the blended frames, so the
6529 parameter value is used as a threshold to exclude those pixels from
6530 deghosting that differ from the previous frame less than specified value.
6531 If two pass mode is used, then negative value can be used to make the
6532 filter analyze the whole video in the beginning of pass-2 to determine
6533 whether it needs deghosting or not and then select either zero or the
6534 absolute value of the parameter.
6535 Specify this option for pass-2, it makes no difference on pass-1.
6539 .B phase[=t|b|p|a|u|T|B|A|U][:v]
6540 Delay interlaced video by one field time so that the field order
6541 changes.
6542 The intended use is to fix PAL movies that have been captured with the
6543 opposite field order to the film-to-video transfer.
6544 The options are:
6545 .RSs
6546 .IPs t
6547 Capture field order top-first, transfer bottom-first.
6548 Filter will delay the bottom field.
6549 .IPs b
6550 Capture bottom-first, transfer top-first.
6551 Filter will delay the top field.
6552 .IPs p
6553 Capture and transfer with the same field order.
6554 This mode only exists for the documentation of the other options to refer to,
6555 but if you actually select it, the filter will faithfully do nothing ;-)
6556 .IPs a
6557 Capture field order determined automatically by field flags, transfer opposite.
6558 Filter selects among t and b modes on a frame by frame basis using field flags.
6559 If no field information is available, then this works just like u.
6560 .IPs u
6561 Capture unknown or varying, transfer opposite.
6562 Filter selects among t and b on a frame by frame basis by analyzing the
6563 images and selecting the alternative that produces best match between the
6564 fields.
6565 .IPs T
6566 Capture top-first, transfer unknown or varying.
6567 Filter selects among t and p using image analysis.
6568 .IPs B
6569 Capture bottom-first, transfer unknown or varying.
6570 Filter selects among b and p using image analysis.
6571 .IPs A
6572 Capture determined by field flags, transfer unknown or varying.
6573 Filter selects among t, b and p using field flags and image analysis.
6574 If no field information is available, then this works just like U.
6575 This is the default mode.
6576 .IPs U
6577 Both capture and transfer unknown or varying.
6578 Filter selects among t, b and p using image analysis only.
6579 .IPs v
6580 Verbose operation.
6581 Prints the selected mode for each frame and the average squared difference
6582 between fields for t, b, and p alternatives.
6586 .B telecine[=start]
6587 Apply 3:2 'telecine' process to increase framerate by 20%.
6588 This most likely will not work correctly with MPlayer, but it can
6589 be used with 'mencoder \-fps 30000/1001 \-ofps 30000/1001 \-vf telecine'.
6590 Both fps options are essential!
6591 (A/V sync will break if they are wrong.)
6592 The optional start parameter tells the filter where in the telecine
6593 pattern to start (0\-3).
6596 .B tinterlace[=mode]
6597 Temporal field interlacing \- merge pairs of frames into an interlaced
6598 frame, halving the framerate.
6599 Even frames are moved into the upper field, odd frames to the lower field.
6600 This can be used to fully reverse the effect of the tfields filter (in mode 0).
6601 Available modes are:
6602 .PD 0
6603 .RSs
6604 .IPs 0
6605 Move odd frames into the upper field, even into the lower field, generating
6606 a full-height frame at half framerate.
6607 .IPs 1
6608 Only output odd frames, even frames are dropped; height unchanged.
6609 .IPs 2
6610 Only output even frames, odd frames are dropped; height unchanged.
6611 .IPs 3
6612 Expand each frame to full height, but pad alternate lines with black;
6613 framerate unchanged.
6614 .IPs 4
6615 Interleave even lines from even frames with odd lines from odd frames.
6616 Height unchanged at half framerate.
6618 .PD 1
6621 .B tfields[=mode[:field_dominance]]
6622 Temporal field separation \- split fields into frames, doubling the
6623 output framerate.
6624 Like the telecine filter, tfields will only work properly with
6625 MEncoder, and only if both \-fps and \-ofps are set to the
6626 desired (double) framerate!
6627 .PD 0
6628 .RSs
6629 .IPs <mode>
6630 0: Leave fields unchanged (will jump/\:flicker).
6632 1: Interpolate missing lines. (The algorithm used might not be so good.)
6634 2: Translate fields by 1/4 pixel with linear interpolation (no jump).
6636 4: Translate fields by 1/4 pixel with 4tap filter (higher quality) (default).
6637 .IPs <field_dominance>\ (DEPRECATED)
6638 \-1: auto (default)
6639 Only works if the decoder exports the appropriate information and
6640 no other filters which discard that information come before tfields
6641 in the filter chain, otherwise it falls back to 0 (top field first).
6643 0: top field first
6645 1: bottom field first
6647 .I NOTE:
6648 This option will possibly be removed in a future version.
6649 Use \-field\-dominance instead.
6651 .PD 1
6654 .B yadif=[mode[:field_dominance]]
6655 Yet another deinterlacing filter
6656 .PD 0
6657 .RSs
6658 .IPs <mode>
6659 0: Output 1 frame for each frame.
6661 1: Output 1 frame for each field.
6663 2: Like 0 but skips spatial interlacing check.
6665 3: Like 1 but skips spatial interlacing check.
6666 .IPs <field_dominance>\ (DEPRECATED)
6667 Operates like tfields.
6669 .I NOTE:
6670 This option will possibly be removed in a future version.
6671 Use \-field\-dominance instead.
6673 .PD 1
6676 .B mcdeint=[mode[:parity[:qp]]]
6677 Motion compensating deinterlacer.
6678 It needs one field per frame as input and must thus be used together
6679 with tfields=1 or yadif=1/3 or equivalent.
6680 .PD 0
6681 .RSs
6682 .IPs <mode>
6683 0: fast
6685 1: medium
6687 2: slow, iterative motion estimation
6689 3: extra slow, like 2 plus multiple reference frames
6690 .IPs <parity>
6691 0 or 1 selects which field to use (note: no autodetection yet!).
6692 .IPs "<qp>\ "
6693 Higher values should result in a smoother motion vector
6694 field but less optimal individual vectors.
6696 .PD 1
6699 .B boxblur=radius:power[:radius:power]
6700 box blur
6701 .PD 0
6702 .RSs
6703 .IPs <radius>
6704 blur filter strength
6705 .IPs <power>
6706 number of filter applications
6708 .PD 1
6711 .B sab=radius:pf:colorDiff[:radius:pf:colorDiff]
6712 shape adaptive blur
6713 .PD 0
6714 .RSs
6715 .IPs <radius>
6716 blur filter strength (~0.1\-4.0) (slower if larger)
6717 .IPs "<pf>\ "
6718 prefilter strength (~0.1\-2.0)
6719 .IPs <colorDiff>
6720 maximum difference between pixels to still be considered (~0.1\-100.0)
6722 .PD 1
6725 .B smartblur=radius:strength:threshold[:radius:strength:threshold]
6726 smart blur
6727 .PD 0
6728 .RSs
6729 .IPs <radius>
6730 blur filter strength (~0.1\-5.0) (slower if larger)
6731 .IPs <strength>
6732 blur (0.0\-1.0) or sharpen (\-1.0\-0.0)
6733 .IPs <threshold>
6734 filter all (0), filter flat areas (0\-30) or filter edges (\-30\-0)
6736 .PD 1
6739 .B perspective=x0:y0:x1:y1:x2:y2:x3:y3:t
6740 Correct the perspective of movies not filmed perpendicular to the screen.
6741 .PD 0
6742 .RSs
6743 .IPs <x0>,<y0>,...
6744 coordinates of the top left, top right, bottom left, bottom right corners
6745 .IPs "<t>\ \ "
6746 linear (0) or cubic resampling (1)
6748 .PD 1
6751 .B "2xsai\ \ "
6752 Scale and smooth the image with the 2x scale and interpolate algorithm.
6755 .B "1bpp\ \ \ "
6756 1bpp bitmap to YUV/\:BGR 8/\:15/\:16/\:32 conversion
6759 .B down3dright[=lines]
6760 Reposition and resize stereoscopic images.
6761 Extracts both stereo fields and places them side by side, resizing
6762 them to maintain the original movie aspect.
6763 .PD 0
6764 .RSs
6765 .IPs <lines>
6766 number of lines to select from the middle of the image (default: 12)
6768 .PD 1
6771 .B bmovl=hidden:opaque:fifo
6772 The bitmap overlay filter reads bitmaps from a FIFO and displays them
6773 on top of the movie, allowing some transformations on the image.
6774 Also see TOOLS/bmovl-test.c for a small bmovl test program.
6775 .PD 0
6776 .RSs
6777 .IPs <hidden>
6778 Set the default value of the 'hidden' flag (0=visible, 1=hidden).
6779 .IPs <opaque>
6780 Set the default value of the 'opaque' flag (0=transparent, 1=opaque).
6781 .IPs <fifo>
6782 path/\:filename for the FIFO (named pipe connecting 'mplayer \-vf bmovl' to the
6783 controlling application)
6785 .PD 1
6786 .sp 1
6788 FIFO commands are:
6790 .PD 0
6791 .RSs
6792 .IPs "RGBA32 width height xpos ypos alpha clear"
6793 followed by width*height*4 Bytes of raw RGBA32 data.
6794 .IPs "ABGR32 width height xpos ypos alpha clear"
6795 followed by width*height*4 Bytes of raw ABGR32 data.
6796 .IPs "RGB24 width height xpos ypos alpha clear"
6797 followed by width*height*3 Bytes of raw RGB24 data.
6798 .IPs "BGR24 width height xpos ypos alpha clear"
6799 followed by width*height*3 Bytes of raw BGR24 data.
6800 .IPs "ALPHA width height xpos ypos alpha"
6801 Change alpha transparency of the specified area.
6802 .IPs "CLEAR width height xpos ypos"
6803 Clear area.
6804 .IPs OPAQUE
6805 Disable all alpha transparency.
6806 Send "ALPHA 0 0 0 0 0" to enable it again.
6807 .IPs "HIDE\ "
6808 Hide bitmap.
6809 .IPs "SHOW\ "
6810 Show bitmap.
6812 .PD 1
6813 .sp 1
6815 Arguments are:
6817 .PD 0
6818 .RSs
6819 .IPs "<width>, <height>"
6820 image/area size
6821 .IPs "<xpos>, <ypos>"
6822 Start blitting at position x/y.
6823 .IPs <alpha>
6824 Set alpha difference.
6825 If you set this to \-255 you can then send a sequence of ALPHA-commands to set
6826 the area to \-225, \-200, \-175 etc for a nice fade-in-effect! ;)
6827 .RSss
6828 0:    same as original
6830 255:  Make everything opaque.
6832 \-255: Make everything transparent.
6833 .REss
6834 .IPs <clear>
6835 Clear the framebuffer before blitting.
6836 .RSss
6837 0: The image will just be blitted on top of the old one, so you do not need to
6838 send 1.8MB of RGBA32 data every time a small part of the screen is updated.
6840 1: clear
6841 .REss
6843 .PD 1
6846 .B framestep=I|[i]step
6847 Renders only every nth frame or every intra frame (keyframe).
6848 .sp 1
6849 If you call the filter with I (uppercase) as the parameter, then
6850 .B only
6851 keyframes are rendered.
6852 For DVDs it generally means one in every 15/12 frames (IBBPBBPBBPBBPBB),
6853 for AVI it means every scene change or every keyint value (see \-lavcopts
6854 keyint= value if you use MEncoder to encode the video).
6855 .sp 1
6856 When a keyframe is found, an 'I!' string followed by a newline character is
6857 printed, leaving the current line of MPlayer/\:MEncoder output on the screen,
6858 because it contains the time (in seconds) and frame number of the keyframe
6859 (You can use this information to split the AVI.).
6860 .sp 1
6861 If you call the filter with a numeric parameter 'step' then only one in
6862 every 'step' frames is rendered.
6863 .sp 1
6864 If you put an 'i' (lowercase) before the number then an 'I!' is printed
6865 (like the I parameter).
6866 .sp 1
6867 If you give only the i then nothing is done to the frames, only I! is
6868 printed.
6871 .B tile=xtiles:ytiles:output:start:delta
6872 Tile a series of images into a single, bigger image.
6873 If you omit a parameter or use a value less than 0, then the default
6874 value is used.
6875 You can also stop when you are satisfied (... \-vf tile=10:5 ...).
6876 It is probably a good idea to put the scale filter before the tile :-)
6877 .sp 1
6878 The parameters are:
6879 .sp 1
6880 .PD 0
6881 .RSs
6882 .IPs <xtiles>
6883 number of tiles on the x axis (default: 5)
6884 .IPs <ytiles>
6885 number of tiles on the y axis (default: 5)
6886 .IPs <output>
6887 Render the tile when 'output' number of frames are reached, where 'output'
6888 should be a number less than xtile * ytile.
6889 Missing tiles are left blank.
6890 You could, for example, write an 8 * 7 tile every 50 frames to have one
6891 image every 2 seconds @ 25 fps.
6892 .IPs <start>
6893 outer border thickness in pixels (default: 2)
6894 .IPs <delta>
6895 inner border thickness in pixels (default: 4)
6897 .PD 1
6900 .B delogo[=x:y:w:h:t]
6901 Suppresses a TV station logo by a simple interpolation of the
6902 surrounding pixels.
6903 Just set a rectangle covering the logo and watch it disappear (and
6904 sometimes something even uglier appear \- your mileage may vary).
6905 .PD 0
6906 .RSs
6907 .IPs <x>,<y>
6908 top left corner of the logo
6909 .IPs <w>,<h>
6910 width and height of the cleared rectangle
6911 .IPs <t>
6912 Thickness of the fuzzy edge of the rectangle (added to w and h).
6913 When set to \-1, a green rectangle is drawn on the screen to
6914 simplify finding the right x,y,w,h parameters.
6916 .PD 1
6919 .B remove\-logo=/path/to/logo_bitmap_file_name.pgm
6920 Suppresses a TV station logo, using a PGM or PPM image
6921 file to determine which pixels comprise the logo.
6922 The width and height of the image file must match
6923 those of the video stream being processed.
6924 Uses the filter image and a circular blur
6925 algorithm to remove the logo.
6926 .RSs
6927 .IPs /path/to/logo_bitmap_file_name.pgm
6928 [path] + filename of the filter image.
6932 .B zrmjpeg[=options]
6933 Software YV12 to MJPEG encoder for use with the zr2 video
6934 output device.
6935 .RSs
6936 .IPs maxheight=<h>|maxwidth=<w>
6937 These options set the maximum width and height the zr card
6938 can handle (the MPlayer filter layer currently cannot query those).
6939 .IPs {dc10+,dc10,buz,lml33}-{PAL|NTSC}
6940 Use these options to set maxwidth and maxheight automatically to the
6941 values known for card/\:mode combo.
6942 For example, valid options are: dc10-PAL and buz-NTSC (default: dc10+PAL)
6943 .IPs color|bw
6944 Select color or black and white encoding.
6945 Black and white encoding is faster.
6946 Color is the default.
6947 .IPs hdec={1,2,4}
6948 Horizontal decimation 1, 2 or 4.
6949 .IPs vdec={1,2,4}
6950 Vertical decimation 1, 2 or 4.
6951 .IPs quality=1\-20
6952 Set JPEG compression quality [BEST] 1 \- 20 [VERY BAD].
6953 .IPs fd|nofd
6954 By default, decimation is only performed if the Zoran hardware
6955 can upscale the resulting MJPEG images to the original size.
6956 The option fd instructs the filter to always perform the requested
6957 decimation (ugly).
6961 .B screenshot
6962 Allows acquiring screenshots of the movie using slave mode
6963 commands that can be bound to keypresses.
6964 See the slave mode documentation and the INTERACTIVE CONTROL
6965 section for details.
6966 Files named 'shotNNNN.png' will be saved in the working directory,
6967 using the first available number \- no files will be overwritten.
6968 The filter has no overhead when not used and accepts an arbitrary
6969 colorspace, so it is safe to add it to the configuration file.
6973 .B "ass\ \ \ \ "
6974 Moves SSA/ASS subtitle rendering to an arbitrary point in the filter chain.
6975 Only useful with the \-ass option.
6976 .sp 1
6977 .I EXAMPLE:
6978 .PD 0
6979 .RSs
6980 .IPs "\-vf ass,screenshot"
6981 Moves SSA/ASS rendering before the screenshot filter.
6982 Screenshots taken this way will contain subtitles.
6984 .PD 1
6987 .B blackframe[=amount:threshold]
6988 Detect frames that are (almost) completely black.
6989 Can be useful to detect chapter transitions or commercials.
6990 Output lines consist of the frame number of the detected frame, the
6991 percentage of blackness, the frame type and the frame number of the last
6992 encountered keyframe.
6993 .RSs
6994 .IPs <amount>
6995 Percentage of the pixels that have to be below the threshold (default: 98).
6996 .IPs <threshold>
6997 Threshold below which a pixel value is considered black (default: 32).
7002 .SH "GENERAL ENCODING OPTIONS (MENCODER ONLY)"
7005 .B \-audio\-delay <any floating-point number>
7006 Delays either audio or video by setting a delay field in the header
7007 (default: 0.0).
7008 This does not delay either stream while encoding, but the player will
7009 see the delay field and compensate accordingly.
7010 Positive values delay the audio, and negative values delay the video.
7011 Note that this is the exact opposite of the \-delay option.
7012 For example, if a video plays correctly with \-delay 0.2, you can
7013 fix the video with MEncoder by using \-audio\-delay \-0.2.
7014 .sp 1
7015 Currently, this option only works with the default muxer (\-of avi).
7016 If you are using a different muxer, then you must use \-delay instead.
7019 .B \-audio\-density <1\-50>
7020 Number of audio chunks per second (default is 2 for 0.5s long audio chunks).
7022 .I NOTE:
7023 CBR only, VBR ignores this as it puts each packet in a new chunk.
7026 .B \-audio\-preload <0.0\-2.0>
7027 Sets up the audio buffering time interval (default: 0.5s).
7030 .B \-fafmttag <format>
7031 Can be used to override the audio format tag of the output file.
7032 .sp 1
7033 .I EXAMPLE:
7034 .PD 0
7035 .RSs
7036 .IPs "\-fafmttag 0x55"
7037 Will have the output file contain 0x55 (mp3) as audio format tag.
7039 .PD 1
7042 .B \-ffourcc <fourcc>
7043 Can be used to override the video fourcc of the output file.
7044 .sp 1
7045 .I EXAMPLE:
7046 .PD 0
7047 .RSs
7048 .IPs "\-ffourcc div3"
7049 Will have the output file contain 'div3' as video fourcc.
7051 .PD 1
7054 .B \-force\-avi\-aspect <0.2\-3.0>
7055 Override the aspect stored in the AVI OpenDML vprp header.
7056 This can be used to change the aspect ratio with '\-ovc copy'.
7059 .B \-frameno\-file <filename> (DEPRECATED)
7060 Specify the name of the audio file with framenumber mappings created in
7061 the first (audio only) pass of a special three pass encoding mode.
7063 .I NOTE:
7064 Using this mode will most likely give you A-V desync.
7065 Do not use it.
7066 It is kept for backwards compatibility only and will possibly
7067 be removed in a future version.
7070 .B \-hr\-edl\-seek
7071 Use a more precise, but much slower method for skipping areas.
7072 Areas marked for skipping are not seeked over, instead all
7073 frames are decoded, but only the necessary frames are encoded.
7074 This allows starting at non-keyframe boundaries.
7076 .I NOTE:
7077 Not guaranteed to work right with '\-ovc copy'.
7080 .B \-info <option1:option2:...> (AVI only)
7081 Specify the info header of the resulting AVI file.
7082 .sp 1
7083 Available options are:
7084 .RSs
7085 .IPs "help\ "
7086 Show this description.
7087 .IPs name=<value>
7088 title of the work
7089 .IPs artist=<value>
7090 artist or author of the work
7091 .IPs genre=<value>
7092 original work category
7093 .IPs subject=<value>
7094 contents of the work
7095 .IPs copyright=<value>
7096 copyright information
7097 .IPs srcform=<value>
7098 original format of the digitized material
7099 .IPs comment=<value>
7100 general comments about the work
7104 .B \-noautoexpand
7105 Do not automatically insert the expand filter into the MEncoder filter chain.
7106 Useful to control at which point of the filter chain subtitles are rendered
7107 when hardcoding subtitles onto a movie.
7110 .B \-noencodedups
7111 Do not attempt to encode duplicate frames in duplicate; always output
7112 zero-byte frames to indicate duplicates.
7113 Zero-byte frames will be written anyway unless a filter or encoder
7114 capable of doing duplicate encoding is loaded.
7115 Currently the only such filter is harddup.
7118 .B \-noodml (\-of avi only)
7119 Do not write OpenDML index for AVI files >1GB.
7122 .B \-noskip
7123 Do not skip frames.
7126 .B \-o <filename>
7127 Outputs to the given filename.
7129 If you want a default output filename, you can put this option in the
7130 MEncoder config file.
7133 .B \-oac <codec name>
7134 Encode with the given audio codec (no default set).
7136 .I NOTE:
7137 Use \-oac help to get a list of available audio codecs.
7138 .sp 1
7139 .I EXAMPLE:
7140 .PD 0
7141 .RSs
7142 .IPs "\-oac copy"
7143 no encoding, just streamcopy
7144 .IPs "\-oac pcm"
7145 Encode to uncompressed PCM.
7146 .IPs "\-oac mp3lame"
7147 Encode to MP3 (using LAME).
7148 .IPs "\-oac lavc"
7149 Encode with a libavcodec codec.
7151 .PD 1
7154 .B \-of <format> (BETA CODE!)
7155 Encode to the specified container format (default: AVI).
7157 .I NOTE:
7158 Use \-of help to get a list of available container formats.
7159 .sp 1
7160 .I EXAMPLE:
7161 .PD 0
7162 .RSs
7163 .IPs "\-of avi"
7164 Encode to AVI.
7165 .IPs "\-of mpeg"
7166 Encode to MPEG (also see \-mpegopts).
7167 .IPs "\-of lavf"
7168 Encode with libavformat muxers (also see \-lavfopts).
7169 .IPs "\-of rawvideo"
7170 raw video stream (no muxing \- one video stream only)
7171 .IPs "\-of rawaudio"
7172 raw audio stream (no muxing \- one audio stream only)
7174 .PD 1
7177 .B \-ofps <fps>
7178 Specify a frames per second (fps) value for the output file,
7179 which can be different from that of the source material.
7180 Must be set for variable fps (ASF, some MOV) and progressive
7181 (30000/1001 fps telecined MPEG) files.
7184 .B \-ovc <codec name>
7185 Encode with the given video codec (no default set).
7187 .I NOTE:
7188 Use \-ovc help to get a list of available video codecs.
7189 .sp 1
7190 .I EXAMPLE:
7191 .PD 0
7192 .RSs
7193 .IPs "\-ovc copy"
7194 no encoding, just streamcopy
7195 .IPs "\-ovc raw"
7196 Encode to an arbitrary uncompressed format (use '\-vf format' to select).
7197 .IPs "\-ovc lavc"
7198 Encode with a libavcodec codec.
7200 .PD 1
7203 .B \-passlogfile <filename>
7204 Dump first pass information to <filename> instead of the default divx2pass.log
7205 in two pass encoding mode.
7208 .B \-skiplimit <value>
7209 Specify the maximum number of frames that may be skipped after
7210 encoding one frame (\-noskiplimit for unlimited).
7213 .B \-vobsubout <basename>
7214 Specify the basename for the output .idx and .sub files.
7215 This turns off subtitle rendering in the encoded movie and diverts it to
7216 VOBsub subtitle files.
7219 .B \-vobsuboutid <langid>
7220 Specify the language two letter code for the subtitles.
7221 This overrides what is read from the DVD or the .ifo file.
7224 .B \-vobsuboutindex <index>
7225 Specify the index of the subtitles in the output files (default: 0).
7229 .SH "CODEC SPECIFIC ENCODING OPTIONS (MENCODER ONLY)"
7230 You can specify codec specific encoding parameters using the following
7231 syntax:
7234 .B \-<codec>opts <option1[=value],option2,...>
7237 Where <codec> may be: lavc, xvidenc, lame, toolame, twolame,
7238 nuv, xvfw, faac, x264enc, mpeg, lavf.
7241 .SS lame (\-lameopts)
7244 .B "help\ \ \ "
7245 get help
7248 .B vbr=<0\-4>
7249 variable bitrate method
7250 .PD 0
7251 .RSs
7252 .IPs 0
7254 .IPs 1
7256 .IPs 2
7257 rh (default)
7258 .IPs 3
7260 .IPs 4
7261 mtrh
7263 .PD 1
7266 .B "abr\ \ \ \ "
7267 average bitrate
7270 .B "cbr\ \ \ \ "
7271 constant bitrate
7272 Also forces CBR mode encoding on subsequent ABR presets modes.
7275 .B br=<0\-1024>
7276 bitrate in kbps (CBR and ABR only)
7279 .B q=<0\-9>
7280 quality (0 \- highest, 9 \- lowest) (VBR only)
7283 .B aq=<0\-9>
7284 algorithmic quality (0 \- best/slowest, 9 \- worst/fastest)
7287 .B ratio=<1\-100>
7288 compression ratio
7291 .B vol=<0\-10>
7292 audio input gain
7295 .B mode=<0\-3>
7296 (default: auto)
7297 .PD 0
7298 .RSs
7299 .IPs 0
7300 stereo
7301 .IPs 1
7302 joint-stereo
7303 .IPs 2
7304 dualchannel
7305 .IPs 3
7306 mono
7308 .PD 1
7311 .B padding=<0\-2>
7312 .PD 0
7313 .RSs
7314 .IPs 0
7315 none
7316 .IPs 1
7318 .IPs 2
7319 adjust
7321 .PD 1
7324 .B "fast\ \ \ "
7325 Switch on faster encoding on subsequent VBR presets modes.
7326 This results in slightly lower quality and higher bitrates.
7329 .B highpassfreq=<freq>
7330 Set a highpass filtering frequency in Hz.
7331 Frequencies below the specified one will be cut off.
7332 A value of \-1 will disable filtering, a value of 0
7333 will let LAME choose values automatically.
7336 .B lowpassfreq=<freq>
7337 Set a lowpass filtering frequency in Hz.
7338 Frequencies above the specified one will be cut off.
7339 A value of \-1 will disable filtering, a value of 0
7340 will let LAME choose values automatically.
7343 .B preset=<value>
7344 preset values
7345 .RSs
7346 .IPs "help\ "
7347 Print additional options and information about presets settings.
7348 .IPs medium
7349 VBR encoding, good quality, 150\-180 kbps bitrate range
7350 .IPs standard
7351 VBR encoding, high quality, 170\-210 kbps bitrate range
7352 .IPs extreme
7353 VBR encoding, very high quality, 200\-240 kbps bitrate range
7354 .IPs insane
7355 CBR encoding, highest preset quality, 320 kbps bitrate
7356 .IPs <8\-320>
7357 ABR encoding at average given kbps bitrate
7359 .sp 1
7361 .I EXAMPLES:
7363 .PD 0
7364 .RSs
7365 .IPs fast:preset=standard
7366 suitable for most people and most music types and already quite high quality
7367 .IPs cbr:preset=192
7368 Encode with ABR presets at a 192 kbps forced constant bitrate.
7369 .IPs preset=172
7370 Encode with ABR presets at a 172 kbps average bitrate.
7371 .IPs preset=extreme
7372 for people with extremely good hearing and similar equipment
7374 .PD 1
7377 .SS toolame and twolame (\-toolameopts and \-twolameopts respectively)
7380 .B br=<32\-384>
7381 In CBR mode this parameter indicates the bitrate in kbps,
7382 when in VBR mode it is the minimum bitrate allowed per frame.
7383 VBR mode will not work with a value below 112.
7386 .B vbr=<\-50\-50> (VBR only)
7387 variability range; if negative the encoder shifts the average bitrate
7388 towards the lower limit, if positive towards the higher.
7389 When set to 0 CBR is used (default).
7392 .B maxvbr=<32\-384> (VBR only)
7393 maximum bitrate allowed per frame, in kbps
7396 .B mode=<stereo  |  jstereo  |  mono  |  dual>
7397 (default: mono for 1-channel audio, stereo otherwise)
7400 .B psy=<\-1\-4>
7401 psychoacoustic model (default: 2)
7404 .B errprot=<0 | 1>
7405 Include error protection.
7408 .B debug=<0\-10>
7409 debug level
7411 .PD 1
7414 .SS faac (\-faacopts)
7417 .B br=<bitrate>
7418 average bitrate in kbps (mutually exclusive with quality)
7421 .B quality=<1\-1000>
7422 quality mode, the higher the better (mutually exclusive with br)
7425 .B object=<1\-4>
7426 object type complexity
7427 .PD 0
7428 .RSs
7429 .IPs 1
7430 MAIN (default)
7431 .IPs 2
7433 .IPs 3
7435 .IPs 4
7436 LTP (extremely slow)
7438 .PD 1
7441 .B mpeg=<2|4>
7442 MPEG version (default: 4)
7445 .B "tns\ \ \ \ "
7446 Enables temporal noise shaping.
7449 .B cutoff=<0\-sampling_rate/2>
7450 cutoff frequency (default: sampling_rate/2)
7453 .B "raw\ \ \ \ "
7454 Stores the bitstream as raw payload with extradata in the container header
7455 (default: 0, corresponds to ADTS).
7456 Do not set this flag if not explicitly required or you will not be able to
7457 remux the audio stream later on.
7459 .PD 1
7462 .SS lavc (\-lavcopts)
7464 Many libavcodec (lavc for short) options are tersely documented.
7465 Read the source for full details.
7467 .I EXAMPLE:
7468 .PD 0
7469 .RSs
7470 .IPs vcodec=msmpeg4:vbitrate=1800:vhq:keyint=250
7472 .PD 1
7475 .B acodec=<value>
7476 audio codec (default: mp2)
7477 .PD 0
7478 .RSs
7479 .IPs "ac3\ \ "
7480 Dolby Digital (AC-3)
7481 .IPs adpcm_*
7482 Adaptive PCM formats \- see the HTML documentation for details.
7483 .IPs "flac\ "
7484 Free Lossless Audio Codec (FLAC)
7485 .IPs "g726\ "
7486 G.726 ADPCM
7487 .IPs libamr_nb
7488 3GPP Adaptive Multi-Rate (AMR) narrow-band
7489 .IPs libamr_wb
7490 3GPP Adaptive Multi-Rate (AMR) wide-band
7491 .IPs libfaac
7492 Advanced Audio Coding (AAC) \- using FAAC
7493 .IPs libmp3lame
7494 MPEG-1 audio layer 3 (MP3) \- using LAME
7495 .IPs "mp2\ \ "
7496 MPEG-1 audio layer 2 (MP2)
7497 .IPs pcm_*
7498 PCM formats \- see the HTML documentation for details.
7499 .IPs roq_dpcm
7500 Id Software RoQ DPCM
7501 .IPs sonic
7502 experimental simple lossy codec
7503 .IPs sonicls
7504 experimental simple lossless codec
7505 .IPs vorbis
7506 Vorbis
7507 .IPs wmav1
7508 Windows Media Audio v1
7509 .IPs wmav2
7510 Windows Media Audio v2
7512 .PD 1
7515 .B abitrate=<value>
7516 audio bitrate in kbps (default: 224)
7519 .B atag=<value>
7520 Use the specified Windows audio format tag (e.g.\& atag=0x55).
7523 .B bit_exact
7524 Use only bit exact algorithms (except (I)DCT).
7525 Additionally bit_exact disables several optimizations and thus
7526 should only be used for regression tests, which need binary
7527 identical files even if the encoder version changes.
7528 This also suppresses the user_data header in MPEG-4 streams.
7529 Do not use this option unless you know exactly what you are doing.
7532 .B threads=<1\-8>
7533 Maximum number of threads to use (default: 1).
7534 May have a slight negative effect on motion estimation.
7538 .B vcodec=<value>
7539 Employ the specified codec (default: mpeg4).
7540 .PD 0
7541 .RSs
7542 .IPs "asv1\ "
7543 ASUS Video v1
7544 .IPs "asv2\ "
7545 ASUS Video v2
7546 .IPs dvvideo
7547 Sony Digital Video
7548 .IPs "ffv1\ "
7549 FFmpeg's lossless video codec
7550 .IPs ffvhuff
7551 nonstandard 20% smaller HuffYUV using YV12
7552 .IPs "flv\ \ "
7553 Sorenson H.263 used in Flash Video
7554 .IPs "h261\ "
7555 H.261
7556 .IPs "h263\ "
7557 H.263
7558 .IPs h263p
7559 H.263+
7560 .IPs huffyuv
7561 HuffYUV
7562 .IPs libtheora
7563 Theora
7564 .IPs libx264
7565 x264 H.264/AVC MPEG-4 Part 10
7566 .IPs libxvid
7567 Xvid MPEG-4 Part 2 (ASP)
7568 .IPs ljpeg
7569 Lossless JPEG
7570 .IPs mjpeg
7571 Motion JPEG
7572 .IPs mpeg1video
7573 MPEG-1 video
7574 .IPs mpeg2video
7575 MPEG-2 video
7576 .IPs mpeg4
7577 MPEG-4 (DivX 4/5)
7578 .IPs msmpeg4
7579 DivX 3
7580 .IPs msmpeg4v2
7581 MS MPEG4v2
7582 .IPs roqvideo
7583 ID Software RoQ Video
7584 .IPs "rv10\ "
7585 an old RealVideo codec
7586 .IPs "snow (also see: vstrict)"
7587 FFmpeg's experimental wavelet-based codec
7588 .IPs "svq1\ "
7589 Apple Sorenson Video 1
7590 .IPs "wmv1\ "
7591 Windows Media Video, version 1 (AKA WMV7)
7592 .IPs "wmv2\ "
7593 Windows Media Video, version 2 (AKA WMV8)
7595 .PD 1
7598 .B vqmin=<1\-31>
7599 minimum quantizer (pass 1/2)
7600 .RSs
7601 .IPs 1
7602 Not recommended (much larger file, little quality difference and weird side
7603 effects: msmpeg4, h263 will be very low quality, ratecontrol will be confused
7604 resulting in lower quality and some decoders will not be able to decode it).
7605 .IPs 2
7606 Recommended for normal mpeg4/\:mpeg1video encoding (default).
7607 .IPs 3
7608 Recommended for h263(p)/\:msmpeg4.
7609 The reason for preferring 3 over 2 is that 2 could lead to overflows.
7610 (This will be fixed for h263(p) by changing the quantizer per MB in
7611 the future, msmpeg4 cannot be fixed as it does not support that.)
7615 .B lmin=<0.01\-255.0>
7616 Minimum frame-level Lagrange multiplier for ratecontrol (default: 2.0).
7617 Lavc will rarely use quantizers below the value of lmin.
7618 Lowering lmin will make lavc more likely to choose lower quantizers for
7619 some frames, but not lower than the value of vqmin.
7620 Likewise, raising lmin will make lavc less likely to choose low
7621 quantizers, even if vqmin would have allowed them.
7622 You probably want to set lmin approximately equal to vqmin.
7623 When adaptive quantization is in use, changing lmin/lmax may have less
7624 of an effect; see mblmin/mblmax.
7628 .B lmax=<0.01\-255.0>
7629 maximum Lagrange multiplier for ratecontrol (default: 31.0)
7633 .B mblmin=<0.01\-255.0>
7634 Minimum macroblock-level Lagrange multiplier for ratecontrol
7635 (default:2.0).
7636 This parameter affects adaptive quantization options like qprd,
7637 lumi_mask, etc..
7641 .B mblmax=<0.01\-255.0>
7642 Maximum macroblock-level Lagrange multiplier for ratecontrol
7643 (default: 31.0).
7647 .B vqscale=<0\-31>
7648 Constant quantizer /\: constant quality encoding (selects fixed quantizer mode).
7649 A lower value means better quality but larger files (default: \-1).
7650 In case of snow codec, value 0 means lossless encoding.
7651 Since the other codecs do not support this, vqscale=0 will have an undefined
7652 effect.
7653 1 is not recommended (see vqmin for details).
7656 .B vqmax=<1\-31>
7657 Maximum quantizer (pass 1/2), 10\-31 should be a sane range (default: 31).
7660 .B mbqmin=<1\-31>
7661 obsolete, use vqmin
7664 .B mbqmax=<1\-31>
7665 obsolete, use vqmax
7668 .B vqdiff=<1\-31>
7669 maximum quantizer difference between consecutive I- or P-frames
7670 (pass 1/2) (default: 3)
7673 .B vmax_b_frames=<0\-4>
7674 maximum number of B-frames between non-B-frames:
7675 .PD 0
7676 .RSs
7677 .IPs 0
7678 no B-frames (default)
7679 .IPs 0\-2
7680 sane range for MPEG-4
7682 .PD 1
7685 .B vme=<0\-5>
7686 motion estimation method.
7687 Available methods are:
7688 .PD 0
7689 .RSs
7690 .IPs 0
7691 none (very low quality)
7692 .IPs 1
7693 full (slow, currently unmaintained and disabled)
7694 .IPs 2
7695 log (low quality, currently unmaintained and disabled)
7696 .IPs 3
7697 phods (low quality, currently unmaintained and disabled)
7698 .IPs 4
7699 EPZS: size=1 diamond, size can be adjusted with the *dia options
7700 (default)
7701 .IPs 5
7702 X1 (experimental, currently aliased to EPZS)
7703 .IPs 8
7704 iter (iterative overlapped block, only used in snow)
7706 .PD 1
7707 .sp 1
7710 .I NOTE:
7711 0\-3 currently ignores the amount of bits spent,
7712 so quality may be low.
7716 .B me_range=<0\-9999>
7717 motion estimation search range (default: 0 (unlimited))
7720 .B mbd=<0\-2> (see also *cmp, qpel)
7721 Macroblock decision algorithm (high quality mode), encode each macro
7722 block in all modes and choose the best.
7723 This is slow but results in better quality and file size.
7724 When mbd is set to 1 or 2, the value of mbcmp is ignored when comparing
7725 macroblocks.
7726 If any comparison setting (precmp, subcmp, cmp, or mbcmp) is nonzero,
7727 however, a slower but better half-pel motion search will be used,
7728 regardless of what mbd is set to.
7729 If qpel is set, quarter-pel motion search will be used regardless.
7730 .PD 0
7731 .RSs
7732 .IPs 0
7733 Use comparison function given by mbcmp (default).
7734 .IPs 1
7735 Select the MB mode which needs the fewest bits (=vhq).
7736 .IPs 2
7737 Select the MB mode which has the best rate distortion.
7739 .PD 1
7742 .B "vhq\ \ \ \ "
7743 Same as mbd=1, kept for compatibility reasons.
7746 .B "v4mv\ \ \ "
7747 Allow 4 motion vectors per macroblock (slightly better quality).
7748 Works better if used with mbd>0.
7751 .B "obmc\ \ \ "
7752 overlapped block motion compensation (H.263+)
7755 .B "loop\ \ \ "
7756 loop filter (H.263+)
7757 note, this is broken
7760 .B inter_threshold <\-1000\-1000>
7761 Does absolutely nothing at the moment.
7764 .B keyint=<0\-300>
7765 maximum interval between keyframes in frames (default: 250 or one
7766 keyframe every ten seconds in a 25fps movie.
7767 This is the recommended default for MPEG-4).
7768 Most codecs require regular keyframes in order to limit the accumulation of mismatch error.
7769 Keyframes are also needed for seeking, as seeking is only possible to a keyframe \- but
7770 keyframes need more space than other frames, so larger numbers here mean
7771 slightly smaller files but less precise seeking.
7772 0 is equivalent to 1, which makes every frame a keyframe.
7773 Values >300 are not recommended as the quality might be bad depending upon
7774 decoder, encoder and luck.
7775 It is common for MPEG-1/2 to use values <=30.
7778 .B sc_threshold=<\-1000000000\-1000000000>
7779 Threshold for scene change detection.
7780 A keyframe is inserted by libavcodec when it detects a scene change.
7781 You can specify the sensitivity of the detection with this option.
7782 \-1000000000 means there is a scene change detected at every frame,
7783 1000000000 means no scene changes are detected (default: 0).
7786 .B sc_factor=<any positive integer>
7787 Causes frames with higher quantizers to be more likely to trigger a
7788 scene change detection and make libavcodec use an I-frame (default: 1).
7789 1\-16 is a sane range.
7790 Values between 2 and 6 may yield increasing PSNR (up to approximately
7791 0.04 dB) and better placement of I-frames in high-motion scenes.
7792 Higher values than 6 may give very slightly better PSNR (approximately
7793 0.01 dB more than sc_factor=6), but noticably worse visual quality.
7796 .B vb_strategy=<0\-2> (pass one only)
7797 strategy to choose between I/P/B-frames:
7798 .PD 0
7799 .RSs
7800 .IPs 0
7801 Always use the maximum number of B-frames (default).
7802 .IPs 1
7803 Avoid B-frames in high motion scenes.
7804 See the b_sensitivity option to tune this strategy.
7805 .IPs 2
7806 Places B-frames more or less optimally to yield maximum quality (slower).
7807 You may want to reduce the speed impact of this option by tuning the
7808 option brd_scale.
7810 .PD 1
7813 .B b_sensitivity=<any integer greater than 0>
7814 Adjusts how sensitively vb_strategy=1 detects motion and avoids using
7815 B-frames (default: 40).
7816 Lower sensitivities will result in more B-frames.
7817 Using more B-frames usually improves PSNR, but too many B-frames can
7818 hurt quality in high-motion scenes.
7819 Unless there is an extremely high amount of motion, b_sensitivity can
7820 safely be lowered below the default; 10 is a reasonable value in most
7821 cases.
7824 .B brd_scale=<0\-10>
7825 Downscales frames for dynamic B-frame decision (default: 0).
7826 Each time brd_scale is increased by one, the frame dimensions are
7827 divided by two, which improves speed by a factor of four.
7828 Both dimensions of the fully downscaled frame must be even numbers, so
7829 brd_scale=1 requires the original dimensions to be multiples of four,
7830 brd_scale=2 requires multiples of eight, etc.
7831 In other words, the dimensions of the original frame must both be
7832 divisible by 2^(brd_scale+1) with no remainder.
7835 .B bidir_refine=<0\-4>
7836 Refine the two motion vectors used in bidirectional macroblocks,
7837 rather than re-using vectors from the forward and backward searches.
7838 This option has no effect without B-frames.
7839 .PD 0
7840 .RSs
7841 .IPs 0
7842 Disabled (default).
7843 .IPs 1\-4
7844 Use a wider search (larger values are slower).
7846 .PD 1
7849 .B vpass=<1\-3>
7850 Activates internal two (or more) pass mode, only specify if you wish to
7851 use two (or more) pass encoding.
7852 .PD 0
7853 .RSs
7854 .IPs 1
7855 first pass (also see turbo)
7856 .IPs 2
7857 second pass
7858 .IPs 3
7859 Nth pass (second and subsequent passes of N-pass encoding)
7862 Here is how it works, and how to use it:
7864 The first pass (vpass=1) writes the statistics file.
7865 You might want to deactivate some CPU-hungry options, like "turbo"
7866 mode does.
7868 In two pass mode, the second pass (vpass=2) reads the statistics file and
7869 bases ratecontrol decisions on it.
7871 In N-pass mode, the second pass (vpass=3, that is not a typo)
7872 does both: It first reads the statistics, then overwrites them.
7873 You might want to backup divx2pass.log before doing this if there is
7874 any possibility that you will have to cancel MEncoder.
7875 You can use all encoding options, except very CPU-hungry options like "qns".
7877 You can run this same pass over and over to refine the encode.
7878 Each subsequent pass will use the statistics from the previous pass to improve.
7879 The final pass can include any CPU-hungry encoding options.
7881 If you want a 2 pass encode, use first vpass=1, and then vpass=2.
7883 If you want a 3 or more pass encode, use vpass=1 for the first pass
7884 and then vpass=3 and then vpass=3 again and again until you are
7885 satisfied with the encode.
7887 .PD 1
7888 .sp 1
7890 huffyuv:
7892 .PD 0
7893 .RSs
7894 .IPs "pass 1"
7895 Saves statistics.
7896 .IPs "pass 2"
7897 Encodes with an optimal Huffman table based upon statistics
7898 from the first pass.
7900 .PD 1
7903 .B turbo (two pass only)
7904 Dramatically speeds up pass one using faster algorithms and disabling
7905 CPU-intensive options.
7906 This will probably reduce global PSNR a little bit (around 0.01dB) and
7907 change individual frame type and PSNR a little bit more (up to 0.03dB).
7910 .B aspect=<x/y>
7911 Store movie aspect internally, just like with MPEG files.
7912 Much nicer than rescaling, because quality is not decreased.
7913 Only MPlayer will play these files correctly, other players will display
7914 them with wrong aspect.
7915 The aspect parameter can be given as a ratio or a floating point number.
7916 .sp 1
7918 .I EXAMPLE:
7920 .RSs
7921 .PD 0
7922 .IPs "aspect=16/9 or aspect=1.78"
7923 .PD 1
7927 .B autoaspect
7928 Same as the aspect option, but automatically computes aspect, taking
7929 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
7930 filter chain.
7931 Does not incur a performance penalty, so you can safely leave it
7932 always on.
7935 .B vbitrate=<value>
7936 Specify bitrate (pass 1/2) (default: 800).
7938 .I WARNING:
7939 1kbit = 1000 bits
7940 .PD 0
7941 .RSs
7942 .IPs 4\-16000
7943 (in kbit)
7944 .IPs 16001\-24000000
7945 (in bit)
7947 .PD 1
7950 .B vratetol=<value>
7951 approximated file size tolerance in kbit.
7952 1000\-100000 is a sane range.
7953 (warning: 1kbit = 1000 bits)
7954 (default: 8000)
7956 .I NOTE:
7957 vratetol should not be too large during the second pass or there might
7958 be problems if vrc_(min|max)rate is used.
7961 .B vrc_maxrate=<value>
7962 maximum bitrate in kbit/\:sec (pass 1/2)
7963 (default: 0, unlimited)
7966 .B vrc_minrate=<value>
7967 minimum bitrate in kbit/\:sec (pass 1/2)
7968 (default: 0, unlimited)
7971 .B vrc_buf_size=<value>
7972 buffer size in kbit (pass 1/2).
7973 For MPEG-1/2 this also sets the vbv buffer size, use 327 for VCD,
7974 917 for SVCD and 1835 for DVD.
7977 .B vrc_buf_aggressivity
7978 currently useless
7981 .B vrc_strategy
7982 Ratecontrol method.
7983 Note that some of the ratecontrol-affecting options will have no effect
7984 if vrc_strategy is not set to 0.
7985 .PD 0
7986 .RSs
7987 .IPs 0
7988 Use internal lavc ratecontrol (default).
7989 .IPs 1
7990 Use Xvid ratecontrol (experimental; requires MEncoder to be compiled
7991 with support for Xvid 1.1 or higher).
7993 .PD 1
7996 .B vb_qfactor=<\-31.0\-31.0>
7997 quantizer factor between B- and non-B-frames (pass 1/2) (default: 1.25)
8000 .B vi_qfactor=<\-31.0\-31.0>
8001 quantizer factor between I- and non-I-frames (pass 1/2) (default: 0.8)
8004 .B vb_qoffset=<\-31.0\-31.0>
8005 quantizer offset between B- and non-B-frames (pass 1/2) (default: 1.25)
8008 .B vi_qoffset=<\-31.0\-31.0>
8009 (pass 1/2) (default: 0.0)
8011 if v{b|i}_qfactor > 0
8013 I/B-frame quantizer = P-frame quantizer * v{b|i}_qfactor + v{b|i}_qoffset
8015 else
8017 do normal ratecontrol (do not lock to next P-frame quantizer) and
8018 set q= \-q * v{b|i}_qfactor + v{b|i}_qoffset
8020 .I HINT:
8021 To do constant quantizer encoding with different quantizers for
8022 I/P- and B-frames you can use:
8023 lmin= <ip_quant>:lmax= <ip_quant>:vb_qfactor= <b_quant/\:ip_quant>.
8026 .B vqblur=<0.0\-1.0> (pass one)
8027 Quantizer blur (default: 0.5), larger values will average the
8028 quantizer more over time (slower change).
8029 .PD 0
8030 .RSs
8031 .IPs 0.0
8032 Quantizer blur disabled.
8033 .IPs 1.0
8034 Average the quantizer over all previous frames.
8036 .PD 1
8039 .B vqblur=<0.0\-99.0> (pass two)
8040 Quantizer gaussian blur (default: 0.5), larger values will average
8041 the quantizer more over time (slower change).
8044 .B vqcomp=<0.0\-1.0>
8045 Quantizer compression, vrc_eq depends upon this (pass 1/2) (default: 0.5).
8046 For instance, assuming the default rate control equation is used,
8047 if vqcomp=1.0, the ratecontrol allocates to each frame the number of bits
8048 needed to encode them all at the same QP.
8049 If vqcomp=0.0, the ratecontrol allocates the same number of bits to each
8050 frame, i.e. strict CBR.
8051 .I NOTE:
8052 Those are extreme settings and should never be used.
8053 Perceptual quality will be optimal somewhere in between these two extremes.
8056 .B vrc_eq=<equation>
8057 main ratecontrol equation (pass 1/2)
8059 .RSs
8060 .IPs "1\ \ \ \ "
8061 constant bitrate
8062 .IPs "tex\ \ "
8063 constant quality
8064 .IPs 1+(tex/\:avgTex-1)*qComp
8065 approximately the equation of the old ratecontrol code
8066 .IPs tex^qComp
8067 with qcomp 0.5 or something like that (default)
8071 infix operators:
8073 .RSs
8074 .IPs +,\-,*,/,^
8078 variables:
8080 .RSs
8081 .IPs "tex\ \ "
8082 texture complexity
8083 .IPs iTex,pTex
8084 intra, non-intra texture complexity
8085 .IPs avgTex
8086 average texture complexity
8087 .IPs avgIITex
8088 average intra texture complexity in I-frames
8089 .IPs avgPITex
8090 average intra texture complexity in P-frames
8091 .IPs avgPPTex
8092 average non-intra texture complexity in P-frames
8093 .IPs avgBPTex
8094 average non-intra texture complexity in B-frames
8095 .IPs "mv\ \ \ "
8096 bits used for motion vectors
8097 .IPs fCode
8098 maximum length of motion vector in log2 scale
8099 .IPs iCount
8100 number of intra macroblocks / number of macroblocks
8101 .IPs "var\ \ "
8102 spatial complexity
8103 .IPs mcVar
8104 temporal complexity
8105 .IPs qComp
8106 qcomp from the command line
8107 .IPs "isI, isP, isB"
8108 Is 1 if picture type is I/P/B else 0.
8109 .IPs "Pi,E\ "
8110 See your favorite math book.
8114 functions:
8116 .RSs
8117 .IPs max(a,b),min(a,b)
8118 maximum / minimum
8119 .IPs gt(a,b)
8120 is 1 if a>b, 0 otherwise
8121 .IPs lt(a,b)
8122 is 1 if a<b, 0 otherwise
8123 .IPs eq(a,b)
8124 is 1 if a==b, 0 otherwise
8125 .IPs "sin, cos, tan, sinh, cosh, tanh, exp, log, abs"
8129 .B vrc_override=<options>
8130 User specified quality for specific parts (ending, credits, ...) (pass 1/2).
8131 The options are <start-frame>, <end-frame>, <quality>[/<start-frame>,
8132 <end-frame>, <quality>[/...]]:
8133 .PD 0
8134 .RSs
8135 .IPs "quality (2\-31)"
8136 quantizer
8137 .IPs "quality (\-500\-0)"
8138 quality correction in %
8140 .PD 1
8143 .B vrc_init_cplx=<0\-1000>
8144 initial complexity (pass 1)
8147 .B vrc_init_occupancy=<0.0\-1.0>
8148 initial buffer occupancy, as a fraction of vrc_buf_size (default: 0.9)
8151 .B vqsquish=<0|1>
8152 Specify how to keep the quantizer between qmin and qmax (pass 1/2).
8153 .PD 0
8154 .RSs
8155 .IPs 0
8156 Use clipping.
8157 .IPs 1
8158 Use a nice differentiable function (default).
8160 .PD 1
8163 .B vlelim=<\-1000\-1000>
8164 Sets single coefficient elimination threshold for luminance.
8165 Negative values will also consider the DC coefficient (should be at least \-4
8166 or lower for encoding at quant=1):
8167 .PD 0
8168 .RSs
8169 .IPs 0
8170 disabled (default)
8171 .IPs \-4
8172 JVT recommendation
8174 .PD 1
8177 .B vcelim=<\-1000\-1000>
8178 Sets single coefficient elimination threshold for chrominance.
8179 Negative values will also consider the DC coefficient (should be at least \-4
8180 or lower for encoding at quant=1):
8181 .PD 0
8182 .RSs
8183 .IPs 0
8184 disabled (default)
8185 .IPs 7
8186 JVT recommendation
8188 .PD 1
8191 .B vstrict=<\-2|\-1|0|1>
8192 strict standard compliance
8193 .PD 0
8194 .RSs
8195 .IPs 0
8196 disabled
8197 .IPs 1
8198 Only recommended if you want to feed the output into the
8199 MPEG-4 reference decoder.
8200 .IPs \-1
8201 Allow libavcodec specific extensions (default).
8202 .IPs \-2
8203 Enables experimental codecs and features which may not be playable
8204 with future MPlayer versions (snow).
8206 .PD 1
8209 .B "vdpart\ "
8210 Data partitioning.
8211 Adds 2 Bytes per video packet, improves error-resistance when transferring over
8212 unreliable channels (e.g.\& streaming over the internet).
8213 Each video packet will be encoded in 3 separate partitions:
8214 .PD 0
8215 .RSs
8216 .IPs "1. MVs"
8217 movement
8218 .IPs "2. DC coefficients"
8219 low res picture
8220 .IPs "3. AC coefficients"
8221 details
8223 .PD 1
8225 MV & DC are most important, losing them looks far worse than losing
8226 the AC and the 1. & 2. partition.
8227 (MV & DC) are far smaller than the 3. partition (AC) meaning that errors
8228 will hit the AC partition much more often than the MV & DC partitions.
8229 Thus, the picture will look better with partitioning than without,
8230 as without partitioning an error will trash AC/\:DC/\:MV equally.
8234 .B vpsize=<0\-10000> (also see vdpart)
8235 Video packet size, improves error-resistance.
8236 .PD 0
8237 .RSs
8238 .IPs "0\ \ \ \ "
8239 disabled (default)
8240 .IPs 100\-1000
8241 good choice
8243 .PD 1
8246 .B "ss\ \ \ \ \ "
8247 slice structured mode for H.263+
8250 .B "gray\ \ \ "
8251 grayscale only encoding (faster)
8254 .B vfdct=<0\-10>
8255 DCT algorithm
8256 .PD 0
8257 .RSs
8258 .IPs 0
8259 Automatically select a good one (default).
8260 .IPs 1
8261 fast integer
8262 .IPs 2
8263 accurate integer
8264 .IPs 3
8266 .IPs 4
8267 mlib
8268 .IPs 5
8269 AltiVec
8270 .IPs 6
8271 floating point AAN
8273 .PD 1
8276 .B idct=<0\-99>
8277 IDCT algorithm
8279 .I NOTE:
8280 To the best of our knowledge all these IDCTs do pass the IEEE1180 tests.
8281 .PD 0
8282 .RSs
8283 .IPs 0
8284 Automatically select a good one (default).
8285 .IPs 1
8286 JPEG reference integer
8287 .IPs 2
8288 simple
8289 .IPs 3
8290 simplemmx
8291 .IPs 4
8292 libmpeg2mmx (inaccurate, do not use for encoding with keyint >100)
8293 .IPs 5
8295 .IPs 6
8296 mlib
8297 .IPs 7
8299 .IPs 8
8300 AltiVec
8301 .IPs 9
8303 .IPs 10
8304 simplearm
8305 .IPs 11
8306 H.264
8307 .IPs 12
8309 .IPs 13
8311 .IPs 14
8312 xvidmmx
8313 .IPs 15
8314 CAVS
8315 .IPs 16
8316 simplearmv5te
8317 .IPs 17
8318 simplearmv6
8320 .PD 1
8323 .B lumi_mask=<0.0\-1.0>
8324 Luminance masking is a 'psychosensory' setting that is supposed to
8325 make use of the fact that the human eye tends to notice fewer details
8326 in very bright parts of the picture.
8327 Luminance masking compresses bright areas stronger than medium ones,
8328 so it will save bits that can be spent again on other frames, raising
8329 overall subjective quality, while possibly reducing PSNR.
8331 .I WARNING:
8332 Be careful, overly large values can cause disastrous things.
8334 .I WARNING:
8335 Large values might look good on some monitors but may look horrible
8336 on other monitors.
8337 .PD 0
8338 .RSs
8339 .IPs "0.0\ \ "
8340 disabled (default)
8341 .IPs 0.0\-0.3
8342 sane range
8344 .PD 1
8347 .B dark_mask=<0.0\-1.0>
8348 Darkness masking is a 'psychosensory' setting that is supposed to
8349 make use of the fact that the human eye tends to notice fewer details
8350 in very dark parts of the picture.
8351 Darkness masking compresses dark areas stronger than medium ones,
8352 so it will save bits that can be spent again on other frames, raising
8353 overall subjective quality, while possibly reducing PSNR.
8355 .I WARNING:
8356 Be careful, overly large values can cause disastrous things.
8358 .I WARNING:
8359 Large values might look good on some monitors but may look horrible
8360 on other monitors / TV / TFT.
8361 .PD 0
8362 .RSs
8363 .IPs "0.0\ \ "
8364 disabled (default)
8365 .IPs 0.0\-0.3
8366 sane range
8368 .PD 1
8371 .B tcplx_mask=<0.0\-1.0>
8372 Temporal complexity masking (default: 0.0 (disabled)).
8373 Imagine a scene with a bird flying across the whole scene; tcplx_mask
8374 will raise the quantizers of the bird's macroblocks (thus decreasing their
8375 quality), as the human eye usually does not have time to see all the bird's
8376 details.
8377 Be warned that if the masked object stops (e.g.\& the bird lands) it is
8378 likely to look horrible for a short period of time, until the encoder
8379 figures out that the object is not moving and needs refined blocks.
8380 The saved bits will be spent on other parts of the video, which may increase
8381 subjective quality, provided that tcplx_mask is carefully chosen.
8384 .B scplx_mask=<0.0\-1.0>
8385 Spatial complexity masking.
8386 Larger values help against blockiness, if no deblocking filter is used for
8387 decoding, which is maybe not a good idea.
8389 Imagine a scene with grass (which usually has great spatial complexity),
8390 a blue sky and a house; scplx_mask will raise the quantizers of the grass'
8391 macroblocks, thus decreasing its quality, in order to spend more bits on
8392 the sky and the house.
8394 .I HINT:
8395 Crop any black borders completely as they will reduce the quality
8396 of the macroblocks (also applies without scplx_mask).
8397 .PD 0
8398 .RSs
8399 .IPs "0.0\ \ "
8400 disabled (default)
8401 .IPs 0.0\-0.5
8402 sane range
8404 .PD 1
8405 .sp 1
8407 .I NOTE:
8408 This setting does not have the same effect as using a custom matrix that
8409 would compress high frequencies harder, as scplx_mask will reduce the
8410 quality of P blocks even if only DC is changing.
8411 The result of scplx_mask will probably not look as good.
8415 .B p_mask=<0.0\-1.0> (also see vi_qfactor)
8416 Reduces the quality of inter blocks.
8417 This is equivalent to increasing the quality of intra blocks, because the
8418 same average bitrate will be distributed by the rate controller to the
8419 whole video sequence (default: 0.0 (disabled)).
8420 p_mask=1.0 doubles the bits allocated to each intra block.
8423 .B border_mask=<0.0\-1.0>
8424 border-processing for MPEG-style encoders.
8425 Border processing increases the quantizer for macroblocks which are less
8426 than 1/5th of the frame width/height away from the frame border,
8427 since they are often visually less important.
8430 .B "naq\ \ \ \ "
8431 Normalize adaptive quantization (experimental).
8432 When using adaptive quantization (*_mask), the average per-MB quantizer may no
8433 longer match the requested frame-level quantizer.
8434 Naq will attempt to adjust the per-MB quantizers to maintain the proper
8435 average.
8438 .B "ildct\ \ "
8439 Use interlaced DCT.
8442 .B "ilme\ \ \ "
8443 Use interlaced motion estimation (mutually exclusive with qpel).
8446 .B "alt\ \ \ \ "
8447 Use alternative scantable.
8450 .B "top=<\-1\-1>\ \ \ "
8451 .PD 0
8452 .RSs
8453 .IPs \-1
8454 automatic
8455 .IPs 0
8456 bottom field first
8457 .IPs 1
8458 top field first
8460 .PD 1
8463 .B format=<value>
8464 .PD 0
8465 .RSs
8466 .IPs "YV12\ "
8467 default
8468 .IPs "444P\ "
8469 for ffv1
8470 .IPs "422P\ "
8471 for HuffYUV, lossless JPEG, dv and ffv1
8472 .IPs "411P\ "
8473 for lossless JPEG, dv and ffv1
8474 .IPs "YVU9\ "
8475 for lossless JPEG, ffv1 and svq1
8476 .IPs "BGR32"
8477 for lossless JPEG and ffv1
8479 .PD 1
8482 .B "pred\ \ \ "
8483 (for HuffYUV)
8484 .PD 0
8485 .RSs
8486 .IPs 0
8487 left prediction
8488 .IPs 1
8489 plane/\:gradient prediction
8490 .IPs 2
8491 median prediction
8493 .PD 1
8496 .B "pred\ \ \ "
8497 (for lossless JPEG)
8498 .PD 0
8499 .RSs
8500 .IPs 0
8501 left prediction
8502 .IPs 1
8503 top prediction
8504 .IPs 2
8505 topleft prediction
8506 .IPs 3
8507 plane/\:gradient prediction
8508 .IPs 6
8509 mean prediction
8511 .PD 1
8514 .B "coder\ \ "
8515 (for ffv1)
8516 .PD 0
8517 .RSs
8518 .IPs 0
8519 vlc coding (Golomb-Rice)
8520 .IPs 1
8521 arithmetic coding (CABAC)
8523 .PD 1
8526 .B context
8527 (for ffv1)
8528 .PD 0
8529 .RSs
8530 .IPs 0
8531 small context model
8532 .IPs 1
8533 large context model
8535 .PD 1
8536 .sp 1
8538 (for ffvhuff)
8540 .PD 0
8541 .RSs
8542 .IPs 0
8543 predetermined Huffman tables (builtin or two pass)
8544 .IPs 1
8545 adaptive Huffman tables
8547 .PD 1
8550 .B "qpel\ \ \ "
8551 Use quarter pel motion compensation (mutually exclusive with ilme).
8553 .I HINT:
8554 This seems only useful for high bitrate encodings.
8557 .B mbcmp=<0\-2000>
8558 Sets the comparison function for the macroblock decision, has only
8559 an effect if mbd=0.
8560 .PD 0
8561 .RSs
8562 .IPs "0 (SAD)"
8563 sum of absolute differences, fast (default)
8564 .IPs "1 (SSE)"
8565 sum of squared errors
8566 .IPs "2 (SATD)"
8567 sum of absolute Hadamard transformed differences
8568 .IPs "3 (DCT)"
8569 sum of absolute DCT transformed differences
8570 .IPs "4 (PSNR)"
8571 sum of squared quantization errors (avoid, low quality)
8572 .IPs "5 (BIT)"
8573 number of bits needed for the block
8574 .IPs "6 (RD)"
8575 rate distortion optimal, slow
8576 .IPs "7 (ZERO)"
8578 .IPs "8 (VSAD)"
8579 sum of absolute vertical differences
8580 .IPs "9 (VSSE)"
8581 sum of squared vertical differences
8582 .IPs "10 (NSSE)"
8583 noise preserving sum of squared differences
8584 .IPs "11 (W53)"
8585 5/3 wavelet, only used in snow
8586 .IPs "12 (W97)"
8587 9/7 wavelet, only used in snow
8588 .IPs "+256\ "
8589 Also use chroma, currently does not work (correctly) with B-frames.
8591 .PD 1
8594 .B ildctcmp=<0\-2000>
8595 Sets the comparison function for interlaced DCT decision
8596 (see mbcmp for available comparison functions).
8599 .B precmp=<0\-2000>
8600 Sets the comparison function for motion estimation pre pass
8601 (see mbcmp for available comparison functions) (default: 0).
8604 .B cmp=<0\-2000>
8605 Sets the comparison function for full pel motion estimation
8606 (see mbcmp for available comparison functions) (default: 0).
8609 .B subcmp=<0\-2000>
8610 Sets the comparison function for sub pel motion estimation
8611 (see mbcmp for available comparison functions) (default: 0).
8614 .B skipcmp=<0\-2000>
8615 FIXME: Document this.
8618 .B nssew=<0\-1000000>
8619 This setting controls NSSE weight, where larger weights will result in
8620 more noise.
8621 0 NSSE is identical to SSE
8622 You may find this useful if you prefer to keep some noise in your encoded
8623 video rather than filtering it away before encoding (default: 8).
8626 .B predia=<\-99\-6>
8627 diamond type and size for motion estimation pre-pass
8630 .B dia=<\-99\-6>
8631 Diamond type & size for motion estimation.
8632 Motion search is an iterative process.
8633 Using a small diamond does not limit the search to finding only small
8634 motion vectors.
8635 It is just somewhat more likely to stop before finding the very best motion
8636 vector, especially when noise is involved.
8637 Bigger diamonds allow a wider search for the best motion vector, thus are
8638 slower but result in better quality.
8640 Big normal diamonds are better quality than shape-adaptive diamonds.
8642 Shape-adaptive diamonds are a good tradeoff between speed and quality.
8644 .I NOTE:
8645 The sizes of the normal diamonds and shape adaptive ones do not have
8646 the same meaning.
8647 .RSs
8648 .IPs \-3
8649 shape adaptive (fast) diamond with size 3
8650 .IPs \-2
8651 shape adaptive (fast) diamond with size 2
8652 .IPs \-1
8653 uneven multi-hexagon search (slow)
8654 .IPs  1
8655 normal size=1 diamond (default) =EPZS type diamond
8658       0
8659      000
8660       0
8662 .IPs 2
8663 normal size=2 diamond
8666       0
8667      000
8668     00000
8669      000
8670       0
8675 .B "trell\ \ "
8676 Trellis searched quantization.
8677 This will find the optimal encoding for each 8x8 block.
8678 Trellis searched quantization is quite simply an optimal quantization in
8679 the PSNR versus bitrate sense (Assuming that there would be no rounding
8680 errors introduced by the IDCT, which is obviously not the case.).
8681 It simply finds a block for the minimum of error and lambda*bits.
8682 .PD 0
8683 .RSs
8684 .IPs lambda
8685 quantization parameter (QP) dependent constant
8686 .IPs "bits\ "
8687 amount of bits needed to encode the block
8688 .IPs error
8689 sum of squared errors of the quantization
8691 .PD 1
8694 .B "cbp\ \ \ \ "
8695 Rate distorted optimal coded block pattern.
8696 Will select the coded block pattern which minimizes distortion + lambda*rate.
8697 This can only be used together with trellis quantization.
8700 .B "mv0\ \ \ \ "
8701 Try to encode each MB with MV=<0,0> and choose the better one.
8702 This has no effect if mbd=0.
8705 .B mv0_threshold=<any non-negative integer>
8706 When surrounding motion vectors are <0,0> and the motion estimation
8707 score of the current block is less than mv0_threshold, <0,0> is used for
8708 the motion vector and further motion estimation is skipped (default:
8709 256).
8710 Lowering mv0_threshold to 0 can give a slight (0.01dB) PSNR increase and
8711 possibly make the encoded video look slightly better; raising
8712 mv0_threshold past 320 results in diminished PSNR and visual quality.
8713 Higher values speed up encoding very slightly (usually less than 1%,
8714 depending on the other options used).
8716 .I NOTE:
8717 This option does not require mv0 to be enabled.
8720 .B qprd (mbd=2 only)
8721 rate distorted optimal quantization parameter (QP) for the given
8722 lambda of each macroblock
8725 .B last_pred=<0\-99>
8726 amount of motion predictors from the previous frame
8727 .PD 0
8728 .RSs
8729 .IPs 0
8730 (default)
8731 .IPs a
8732 Will use 2a+1 x 2a+1 macroblock square of motion vector predictors from the
8733 previous frame.
8735 .PD 1
8738 .B preme=<0\-2>
8739 motion estimation pre-pass
8740 .PD 0
8741 .RSs
8742 .IPs 0
8743 disabled
8744 .IPs 1
8745 only after I-frames (default)
8746 .IPs 2
8747 always
8749 .PD 1
8752 .B subq=<1\-8>
8753 subpel refinement quality (for qpel) (default: 8 (high quality))
8755 .I NOTE:
8756 This has a significant effect on speed.
8759 .B refs=<1\-8>
8760 number of reference frames to consider for motion compensation
8761 (Snow only) (default: 1)
8764 .B "psnr\ \ \ "
8765 print the PSNR (peak signal to noise ratio) for the whole video after encoding
8766 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log'.
8767 Returned values are in dB (decibel), the higher the better.
8770 .B mpeg_quant
8771 Use MPEG quantizers instead of H.263.
8774 .B "aic\ \ \ \ "
8775 Enable AC prediction for MPEG-4 or advanced intra prediction for H.263+.
8776 This will improve quality very slightly (around 0.02 dB PSNR) and slow
8777 down encoding very slightly (about 1%).
8779 .I NOTE:
8780 vqmin should be 8 or larger for H.263+ AIC.
8783 .B "aiv\ \ \ \ "
8784 alternative inter vlc for H.263+
8787 .B "umv\ \ \ \ "
8788 unlimited MVs (H.263+ only)
8789 Allows encoding of arbitrarily long MVs.
8792 .B ibias=<\-256\-256>
8793 intra quantizer bias (256 equals 1.0, MPEG style quantizer default: 96,
8794 H.263 style quantizer default: 0)
8796 .I NOTE:
8797 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
8798 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
8801 .B pbias=<\-256\-256>
8802 inter quantizer bias (256 equals 1.0, MPEG style quantizer default: 0,
8803 H.263 style quantizer default: \-64)
8805 .I NOTE:
8806 The H.263 MMX quantizer cannot handle positive biases (set vfdct=1 or 2),
8807 the MPEG MMX quantizer cannot handle negative biases (set vfdct=1 or 2).
8809 .I HINT:
8810 A more positive bias (\-32 \- \-16 instead of \-64) seems to improve the PSNR.
8813 .B nr=<0\-100000>
8814 Noise reduction, 0 means disabled.
8815 0\-600 is a useful range for typical content, but you may want to turn it
8816 up a bit more for very noisy content (default: 0).
8817 Given its small impact on speed, you might want to prefer to use this over
8818 filtering noise away with video filters like denoise3d or hqdn3d.
8821 .B qns=<0\-3>
8822 Quantizer noise shaping.
8823 Rather than choosing quantization to most closely match the source video
8824 in the PSNR sense, it chooses quantization such that noise (usually ringing)
8825 will be masked by similar-frequency content in the image.
8826 Larger values are slower but may not result in better quality.
8827 This can and should be used together with trellis quantization, in which case
8828 the trellis quantization (optimal for constant weight) will be used as
8829 startpoint for the iterative search.
8830 .PD 0
8831 .RSs
8832 .IPs 0
8833 disabled (default)
8834 .IPs 1
8835 Only lower the absolute value of coefficients.
8836 .IPs 2
8837 Only change coefficients before the last non-zero coefficient + 1.
8838 .IPs 3
8839 Try all.
8841 .PD 1
8844 .B inter_matrix=<comma separated matrix>
8845 Use custom inter matrix.
8846 It needs a comma separated string of 64 integers.
8849 .B intra_matrix=<comma separated matrix>
8850 Use custom intra matrix.
8851 It needs a comma separated string of 64 integers.
8854 .B vqmod_amp
8855 experimental quantizer modulation
8858 .B vqmod_freq
8859 experimental quantizer modulation
8862 .B "dc\ \ \ \ \ "
8863 intra DC precision in bits (default: 8).
8864 If you specify vcodec=mpeg2video this value can be 8, 9, 10 or 11.
8867 .B cgop (also see sc_threshold)
8868 Close all GOPs.
8869 Currently it only works if scene change detection is disabled
8870 (sc_threshold=1000000000).
8873 .B (no)lowdelay
8874 Sets the low delay flag for MPEG-1/2 (disables B-frames).
8877 .B vglobal=<0\-3>
8878 Control writing global video headers.
8879 .PD 0
8880 .RSs
8881 .IPs 0
8882 Codec decides where to write global headers (default).
8883 .IPs 1
8884 Write global headers only in extradata (needed for .mp4/MOV/NUT).
8885 .IPs 2
8886 Write global headers only in front of keyframes.
8887 .IPs 3
8888 Combine 1 and 2.
8890 .PD 1
8893 .B aglobal=<0\-3>
8894 Same as vglobal for audio headers.
8897 .B level=<value>
8898 Set CodecContext Level.
8899 Use 31 or 41 to play video on a Playstation 3.
8902 .B skip_exp=<0\-1000000>
8903 FIXME: Document this.
8906 .B skip_factor=<0\-1000000>
8907 FIXME: Document this.
8910 .B skip_threshold=<0\-1000000>
8911 FIXME: Document this.
8914 .SS nuv (\-nuvopts)
8916 Nuppel video is based on RTJPEG and LZO.
8917 By default frames are first encoded with RTJPEG and then compressed with LZO,
8918 but it is possible to disable either or both of the two passes.
8919 As a result, you can in fact output raw i420, LZO compressed i420, RTJPEG,
8920 or the default LZO compressed RTJPEG.
8922 .I NOTE:
8923 The nuvrec documentation contains some advice and examples about the
8924 settings to use for the most common TV encodings.
8927 .B c=<0\-20>
8928 chrominance threshold (default: 1)
8931 .B l=<0\-20>
8932 luminance threshold (default: 1)
8935 .B "lzo\ \ \ \ "
8936 Enable LZO compression (default).
8939 .B "nolzo\ \ "
8940 Disable LZO compression.
8943 .B q=<3\-255>
8944 quality level (default: 255)
8947 .B "raw \ \ \ "
8948 Disable RTJPEG encoding.
8951 .B "rtjpeg\ "
8952 Enable RTJPEG encoding (default).
8955 .SS xvidenc (\-xvidencopts)
8957 There are three modes available: constant bitrate (CBR), fixed quantizer and
8958 two pass.
8961 .B pass=<1|2>
8962 Specify the pass in two pass mode.
8965 .B turbo (two pass only)
8966 Dramatically speeds up pass one using faster algorithms and disabling
8967 CPU-intensive options.
8968 This will probably reduce global PSNR a little bit and change individual
8969 frame type and PSNR a little bit more.
8972 .B bitrate=<value> (CBR or two pass mode)
8973 Sets the bitrate to be used in kbits/\:second if <16000 or in bits/\:second
8974 if >16000.
8975 If <value> is negative, Xvid will use its absolute value as the target size
8976 (in kBytes) of the video and compute the associated bitrate automagically
8977 (default: 687 kbits/s).
8980 .B fixed_quant=<1\-31>
8981 Switch to fixed quantizer mode and specify the quantizer to be used.
8984 .B zones=<zone0>[/<zone1>[/...]] (CBR or two pass mode)
8985 User specified quality for specific parts (ending, credits, ...).
8986 Each zone is <start-frame>,<mode>,<value> where <mode> may be
8987 .PD 0
8988 .RSs
8989 .IPs "q"
8990 Constant quantizer override, where value=<2.0\-31.0>
8991 represents the quantizer value.
8992 .IPs "w"
8993 Ratecontrol weight override, where value=<0.01\-2.00>
8994 represents the quality correction in %.
8996 .PD 1
8997 .sp 1
8999 .I EXAMPLE:
9001 .PD 0
9002 .RSs
9003 .IPs zones=90000,q,20
9004 Encodes all frames starting with frame 90000 at constant quantizer 20.
9005 .IPs zones=0,w,0.1/10001,w,1.0/90000,q,20
9006 Encode frames 0\-10000 at 10% bitrate, encode frames 90000
9007 up to the end at constant quantizer 20.
9008 Note that the second zone is needed to delimit the first zone, as
9009 without it everything up until frame 89999 would be encoded at 10%
9010 bitrate.
9012 .PD 1
9015 .B me_quality=<0\-6>
9016 This option controls the motion estimation subsystem.
9017 The higher the value, the more precise the estimation should be (default: 6).
9018 The more precise the motion estimation is, the more bits can be saved.
9019 Precision is gained at the expense of CPU time so decrease this setting if
9020 you need realtime encoding.
9023 .B (no)qpel
9024 MPEG-4 uses a half pixel precision for its motion search by default.
9025 The standard proposes a mode where encoders are allowed to use quarter
9026 pixel precision.
9027 This option usually results in a sharper image.
9028 Unfortunately it has a great impact on bitrate and sometimes the
9029 higher bitrate use will prevent it from giving a better image
9030 quality at a fixed bitrate.
9031 It is better to test with and without this option and see whether it
9032 is worth activating.
9035 .B (no)gmc
9036 Enable Global Motion Compensation, which makes Xvid generate special
9037 frames (GMC-frames) which are well suited for Pan/\:Zoom/\:Rotating images.
9038 Whether or not the use of this option will save bits is highly
9039 dependent on the source material.
9042 .B (no)trellis
9043 Trellis Quantization is a kind of adaptive quantization method that
9044 saves bits by modifying quantized coefficients to make them more
9045 compressible by the entropy encoder.
9046 Its impact on quality is good, and if VHQ uses too much CPU for you,
9047 this setting can be a good alternative to save a few bits (and gain
9048 quality at fixed bitrate) at a lesser cost than with VHQ (default: on).
9051 .B (no)cartoon
9052 Activate this if your encoded sequence is an anime/\:cartoon.
9053 It modifies some Xvid internal thresholds so Xvid takes better decisions on
9054 frame types and motion vectors for flat looking cartoons.
9057 .B (no)chroma_me
9058 The usual motion estimation algorithm uses only the luminance information to
9059 find the best motion vector.
9060 However for some video material, using the chroma planes can help find
9061 better vectors.
9062 This setting toggles the use of chroma planes for motion estimation
9063 (default: on).
9066 .B (no)chroma_opt
9067 Enable a chroma optimizer prefilter.
9068 It will do some extra magic on color information to minimize the
9069 stepped-stairs effect on edges.
9070 It will improve quality at the cost of encoding speed.
9071 It reduces PSNR by nature, as the mathematical deviation to the original
9072 picture will get bigger, but the subjective image quality will raise.
9073 Since it works with color information, you might want to turn it off when
9074 encoding in grayscale.
9077 .B (no)hq_ac
9078 Activates high-quality prediction of AC coefficients for intra frames from
9079 neighbor blocks (default: on).
9082 .B vhq=<0\-4>
9083 The motion search algorithm is based on a search in the usual color domain
9084 and tries to find a motion vector that minimizes the difference between the
9085 reference frame and the encoded frame.
9086 With this setting activated, Xvid will also use the frequency domain (DCT)
9087 to search for a motion vector that minimizes not only the spatial
9088 difference but also the encoding length of the block.
9089 Fastest to slowest:
9090 .PD 0
9091 .RSs
9092 .IPs 0
9094 .IPs 1
9095 mode decision (inter/\:intra MB) (default)
9096 .IPs 2
9097 limited search
9098 .IPs 3
9099 medium search
9100 .IPs 4
9101 wide search
9103 .PD 1
9106 .B (no)lumi_mask
9107 Adaptive quantization allows the macroblock quantizers to vary inside
9108 each frame.
9109 This is a 'psychosensory' setting that is supposed to make use of the
9110 fact that the human eye tends to notice fewer details in very bright
9111 and very dark parts of the picture.
9112 It compresses those areas more strongly than medium ones, which will
9113 save bits that can be spent again on other frames, raising overall
9114 subjective quality and possibly reducing PSNR.
9117 .B (no)grayscale
9118 Make Xvid discard chroma planes so the encoded video is grayscale only.
9119 Note that this does not speed up encoding, it just prevents chroma data
9120 from being written in the last stage of encoding.
9123 .B (no)interlacing
9124 Encode the fields of interlaced video material.
9125 Turn this option on for interlaced content.
9127 .I NOTE:
9128 Should you rescale the video, you would need an interlace-aware resizer,
9129 which you can activate with \-vf scale=<width>:<height>:1.
9132 .B min_iquant=<0\-31>
9133 minimum I-frame quantizer (default: 2)
9136 .B max_iquant=<0\-31>
9137 maximum I-frame quantizer (default: 31)
9140 .B min_pquant=<0\-31>
9141 minimum P-frame quantizer (default: 2)
9144 .B max_pquant=<0\-31>
9145 maximum P-frame quantizer (default: 31)
9148 .B min_bquant=<0\-31>
9149 minimum B-frame quantizer (default: 2)
9152 .B max_bquant=<0\-31>
9153 maximum B-frame quantizer (default: 31)
9156 .B min_key_interval=<value> (two pass only)
9157 minimum interval between keyframes (default: 0)
9160 .B max_key_interval=<value>
9161 maximum interval between keyframes (default: 10*fps)
9164 .B quant_type=<h263|mpeg>
9165 Sets the type of quantizer to use.
9166 For high bitrates, you will find that MPEG quantization preserves more detail.
9167 For low bitrates, the smoothing of H.263 will give you less block noise.
9168 When using custom matrices, MPEG quantization
9169 .B must
9170 be used.
9173 .B quant_intra_matrix=<filename>
9174 Load a custom intra matrix file.
9175 You can build such a file with xvid4conf's matrix editor.
9178 .B quant_inter_matrix=<filename>
9179 Load a custom inter matrix file.
9180 You can build such a file with xvid4conf's matrix editor.
9183 .B keyframe_boost=<0\-1000> (two pass mode only)
9184 Shift some bits from the pool for other frame types to intra frames,
9185 thus improving keyframe quality.
9186 This amount is an extra percentage, so a value of 10 will give
9187 your keyframes 10% more bits than normal
9188 (default: 0).
9191 .B kfthreshold=<value> (two pass mode only)
9192 Works together with kfreduction.
9193 Determines the minimum distance below which you consider that
9194 two frames are considered consecutive and treated differently
9195 according to kfreduction
9196 (default: 10).
9199 .B kfreduction=<0\-100> (two pass mode only)
9200 The above two settings can be used to adjust the size of keyframes that
9201 you consider too close to the first (in a row).
9202 kfthreshold sets the range in which keyframes are reduced, and
9203 kfreduction determines the bitrate reduction they get.
9204 The last I-frame will get treated normally
9205 (default: 30).
9208 .B max_bframes=<0\-4>
9209 Maximum number of B-frames to put between I/P-frames (default: 2).
9212 .B bquant_ratio=<0\-1000>
9213 quantizer ratio between B- and non-B-frames, 150=1.50 (default: 150)
9216 .B bquant_offset=<\-1000\-1000>
9217 quantizer offset between B- and non-B-frames, 100=1.00 (default: 100)
9220 .B bf_threshold=<\-255\-255>
9221 This setting allows you to specify what priority to place on the use of
9222 B-frames.
9223 The higher the value, the higher the probability of B-frames being used
9224 (default: 0).
9225 Do not forget that B-frames usually have a higher quantizer, and therefore
9226 aggressive production of B-frames may cause worse visual quality.
9229 .B (no)closed_gop
9230 This option tells Xvid to close every GOP (Group Of Pictures bounded
9231 by two I-frames), which makes GOPs independent from each other.
9232 This just implies that the last frame of the GOP is either a P-frame or a
9233 N-frame but not a B-frame.
9234 It is usually a good idea to turn this option on (default: on).
9237 .B (no)packed
9238 This option is meant to solve frame-order issues when encoding to
9239 container formats like AVI that cannot cope with out-of-order frames.
9240 In practice, most decoders (both software and hardware) are able to deal
9241 with frame-order themselves, and may get confused when this option is
9242 turned on, so you can safely leave if off, unless you really know what
9243 you are doing.
9245 .I WARNING:
9246 This will generate an illegal bitstream, and will not be
9247 decodable by ISO-MPEG-4 decoders except DivX/\:libavcodec/\:Xvid.
9249 .I WARNING:
9250 This will also store a fake DivX version in the file so the bug
9251 autodetection of some decoders might be confused.
9254 .B frame_drop_ratio=<0\-100> (max_bframes=0 only)
9255 This setting allows the creation of variable framerate video streams.
9256 The value of the setting specifies a threshold under which, if the
9257 difference of the following frame to the previous frame is below or equal
9258 to this threshold, a frame gets not coded (a so called n-vop is placed
9259 in the stream).
9260 On playback, when reaching an n-vop the previous frame will be displayed.
9262 .I WARNING:
9263 Playing with this setting may result in a jerky video, so use it at your
9264 own risks!
9267 .B rc_reaction_delay_factor=<value>
9268 This parameter controls the number of frames the CBR rate controller
9269 will wait before reacting to bitrate changes and compensating for them
9270 to obtain a constant bitrate over an averaging range of frames.
9273 .B rc_averaging_period=<value>
9274 Real CBR is hard to achieve.
9275 Depending on the video material, bitrate can be variable, and hard to predict.
9276 Therefore Xvid uses an averaging period for which it guarantees a given
9277 amount of bits (minus a small variation).
9278 This settings expresses the "number of frames" for which Xvid averages
9279 bitrate and tries to achieve CBR.
9282 .B rc_buffer=<value>
9283 size of the rate control buffer
9286 .B curve_compression_high=<0\-100>
9287 This setting allows Xvid to take a certain percentage of bits away from
9288 high bitrate scenes and give them back to the bit reservoir.
9289 You could also use this if you have a clip with so many bits allocated
9290 to high-bitrate scenes that the low(er)-bitrate scenes start to look bad
9291 (default: 0).
9294 .B curve_compression_low=<0\-100>
9295 This setting allows Xvid to give a certain percentage of extra bits to the
9296 low bitrate scenes, taking a few bits from the entire clip.
9297 This might come in handy if you have a few low-bitrate scenes that are
9298 still blocky (default: 0).
9301 .B overflow_control_strength=<0\-100>
9302 During pass one of two pass encoding, a scaled bitrate curve is computed.
9303 The difference between that expected curve and the result obtained during
9304 encoding is called overflow.
9305 Obviously, the two pass rate controller tries to compensate for that overflow,
9306 distributing it over the next frames.
9307 This setting controls how much of the overflow is distributed every time
9308 there is a new frame.
9309 Low values allow lazy overflow control, big rate bursts are compensated for
9310 more slowly (could lead to lack of precision for small clips).
9311 Higher values will make changes in bit redistribution more abrupt, possibly
9312 too abrupt if you set it too high, creating artifacts (default: 5).
9314 .I NOTE:
9315 This setting impacts quality a lot, play with it carefully!
9318 .B max_overflow_improvement=<0\-100>
9319 During the frame bit allocation, overflow control may increase the frame
9320 size.
9321 This parameter specifies the maximum percentage by which the overflow
9322 control is allowed to increase the frame size, compared to the ideal curve
9323 allocation
9324 (default: 5).
9327 .B max_overflow_degradation=<0\-100>
9328 During the frame bit allocation, overflow control may decrease the frame
9329 size.
9330 This parameter specifies the maximum percentage by which the overflow
9331 control is allowed to decrease the frame size, compared to the ideal curve
9332 allocation
9333 (default: 5).
9336 .B container_frame_overhead=<0...>
9337 Specifies a frame average overhead per frame, in bytes.
9338 Most of the time users express their target bitrate for video w/o taking
9339 care of the video container overhead.
9340 This small but (mostly) constant overhead can cause the target file size
9341 to be exceeded.
9342 Xvid allows users to set the amount of overhead per frame the
9343 container generates (give only an average per frame).
9344 0 has a special meaning, it lets Xvid use its own default values
9345 (default: 24 \- AVI average overhead).
9348 .B profile=<profile_name>
9349 Restricts options and VBV (peak bitrate over a short period) according to
9350 the Simple, Advanced Simple and DivX profiles.
9351 The resulting videos should be playable on standalone players adhering to these
9352 profile specifications.
9353 .PD 0
9354 .RSs
9355 .IPs unrestricted
9356 no restrictions (default)
9357 .IPs "sp0\ \ "
9358 simple profile at level 0
9359 .IPs "sp1\ \ "
9360 simple profile at level 1
9361 .IPs "sp2\ \ "
9362 simple profile at level 2
9363 .IPs "sp3\ \ "
9364 simple profile at level 3
9365 .IPs "asp0\ "
9366 advanced simple profile at level 0
9367 .IPs "asp1\ "
9368 advanced simple profile at level 1
9369 .IPs "asp2\ "
9370 advanced simple profile at level 2
9371 .IPs "asp3\ "
9372 advanced simple profile at level 3
9373 .IPs "asp4\ "
9374 advanced simple profile at level 4
9375 .IPs "asp5\ "
9376 advanced simple profile at level 5
9377 .IPs dxnhandheld
9378 DXN handheld profile
9379 .IPs dxnportntsc
9380 DXN portable NTSC profile
9381 .IPs dxnportpal
9382 DXN portable PAL profile
9383 .IPs dxnhtntsc
9384 DXN home theater NTSC profile
9385 .IPs dxnhtpal
9386 DXN home theater PAL profile
9387 .IPs dxnhdtv
9388 DXN HDTV profile
9390 .PD 1
9392 .I NOTE:
9393 These profiles should be used in conjunction with an appropriate \-ffourcc.
9394 Generally DX50 is applicable, as some players do not recognize Xvid but
9395 most recognize DivX.
9399 .B par=<mode>
9400 Specifies the Pixel Aspect Ratio mode (not to be confused with DAR,
9401 the Display Aspect Ratio).
9402 PAR is the ratio of the width and height of a single pixel.
9403 So both are related like this: DAR = PAR * (width/height).
9405 MPEG-4 defines 5 pixel aspect ratios and one extended
9406 one, giving the opportunity to specify a specific pixel aspect
9407 ratio.
9408 5 standard modes can be specified:
9409 .PD 0
9410 .RSs
9411 .IPs vga11
9412 It is the usual PAR for PC content.
9413 Pixels are a square unit.
9414 .IPs pal43
9415 PAL standard 4:3 PAR.
9416 Pixels are rectangles.
9417 .IPs pal169
9418 same as above
9419 .IPs ntsc43
9420 same as above
9421 .IPs ntsc169
9422 same as above (Do not forget to give the exact ratio.)
9423 .IPs "ext\ \ "
9424 Allows you to specify your own pixel aspect ratio with par_width and
9425 par_height.
9427 .PD 1
9429 .I NOTE:
9430 In general, setting aspect and autoaspect options is enough.
9434 .B par_width=<1\-255> (par=ext only)
9435 Specifies the width of the custom pixel aspect ratio.
9438 .B par_height=<1\-255> (par=ext only)
9439 Specifies the height of the custom pixel aspect ratio.
9442 .B aspect=<x/y | f (float value)>
9443 Store movie aspect internally, just like MPEG files.
9444 Much nicer solution than rescaling, because quality is not decreased.
9445 MPlayer and a few others players will play these files correctly, others
9446 will display them with the wrong aspect.
9447 The aspect parameter can be given as a ratio or a floating point number.
9450 .B (no)autoaspect
9451 Same as the aspect option, but automatically computes aspect, taking
9452 into account all the adjustments (crop/\:expand/\:scale/\:etc.) made in the
9453 filter chain.
9456 .B "psnr\ \ \ "
9457 Print the PSNR (peak signal to noise ratio) for the whole video after encoding
9458 and store the per frame PSNR in a file with a name like 'psnr_hhmmss.log' in
9459 the current directory.
9460 Returned values are in dB (decibel), the higher the better.
9463 .B "debug\ \ "
9464 Save per-frame statistics in ./xvid.dbg. (This is not the two pass control
9465 file.)
9469 .sp 1
9470 The following option is only available in Xvid 1.1.x.
9473 .B bvhq=<0|1>
9474 This setting allows vector candidates for B-frames to be used for
9475 the encoding chosen using a rate distortion optimized operator,
9476 which is what is done for P-frames by the vhq option.
9477 This produces nicer-looking B-frames while incurring almost no
9478 performance penalty (default: 1).
9481 .sp 1
9482 The following option is only available in the 1.2.x version of Xvid.
9485 .B threads=<0\-n>
9486 Create n threads to run the motion estimation (default: 0).
9487 The maximum number of threads that can be used is the picture height
9488 divided by 16.
9491 .SS x264enc (\-x264encopts)
9494 .B bitrate=<value>
9495 Sets the average bitrate to be used in kbits/\:second (default: off).
9496 Since local bitrate may vary, this average may be inaccurate for
9497 very short videos (see ratetol).
9498 Constant bitrate can be achieved by combining this with vbv_maxrate,
9499 at significant reduction in quality.
9502 .B qp=<0\-51>
9503 This selects the quantizer to use for P-frames.
9504 I- and B-frames are offset from this value by ip_factor and pb_factor, respectively.
9505 20\-40 is a useful range.
9506 Lower values result in better fidelity, but higher bitrates.
9507 0 is lossless.
9508 Note that quantization in H.264 works differently from MPEG-1/2/4:
9509 H.264's quantization parameter (QP) is on a logarithmic scale.
9510 The mapping is approximately H264QP = 12 + 6*log2(MPEGQP).
9511 For example, MPEG at QP=2 is equivalent to H.264 at QP=18.
9514 .B crf=<1.0\-50.0>
9515 Enables constant quality mode, and selects the quality.
9516 The scale is similar to QP.
9517 Like the bitrate-based modes, this allows each frame to use a
9518 different QP based on the frame's complexity.
9521 .B pass=<1\-3>
9522 Enable 2 or 3-pass mode.
9523 It is recommended to always encode in 2 or 3-pass mode as it leads to a
9524 better bit distribution and improves overall quality.
9525 .PD 0
9526 .RSs
9527 .IPs 1
9528 first pass
9529 .IPs 2
9530 second pass (of two pass encoding)
9531 .IPs 3
9532 Nth pass (second and third passes of three pass encoding)
9535 Here is how it works, and how to use it:
9537 The first pass (pass=1) collects statistics on the video and writes them
9538 to a file.
9539 You might want to deactivate some CPU-hungry options, apart from the ones
9540 that are on by default.
9542 In two pass mode, the second pass (pass=2) reads the statistics file and
9543 bases ratecontrol decisions on it.
9545 In three pass mode, the second pass (pass=3, that is not a typo)
9546 does both: It first reads the statistics, then overwrites them.
9547 You can use all encoding options, except very CPU-hungry options.
9549 The third pass (pass=3) is the same as the second pass, except that it has
9550 the second pass' statistics to work from.
9551 You can use all encoding options, including CPU-hungry ones.
9553 The first pass may use either average bitrate or constant quantizer.
9554 ABR is recommended, since it does not require guessing a quantizer.
9555 Subsequent passes are ABR, and must specify bitrate.
9556 .REss
9559 .B turbo=<0\-2>
9560 Fast first pass mode.
9561 During the first pass of a two or more pass encode it is possible to gain
9562 speed by disabling some options with negligible or even no impact on the
9563 final pass output quality.
9564 .PD 0
9565 .RSs
9566 .IPs 0
9567 disabled (default)
9568 .IPs 1
9569 Reduce subq, frameref and disable some inter-macroblock partition analysis
9570 modes.
9571 .IPs 2
9572 Reduce subq and frameref to 1, use a diamond ME search and disable all
9573 partition analysis modes.
9576 Level 1 can increase first pass speed up to 2x with no change in the global
9577 PSNR of the final pass compared to a full quality first pass.
9579 Level 2 can increase first pass speed up to 4x with about +/\- 0.05dB change
9580 in the global PSNR of the final pass compared to a full quality first pass.
9581 .REss
9584 .B keyint=<value>
9585 Sets maximum interval between IDR-frames (default: 250).
9586 Larger values save bits, thus improve quality, at the cost of seeking
9587 precision.
9588 Unlike MPEG-1/2/4, H.264 does not suffer from DCT drift with large
9589 values of keyint.
9592 .B keyint_min=<1\-keyint/2>
9593 Sets minimum interval between IDR-frames (default: 25).
9594 If scenecuts appear within this interval, they are still encoded as
9595 I-frames, but do not start a new GOP.
9596 In H.264, I-frames do not necessarily bound a closed GOP because it is
9597 allowable for a P-frame to be predicted from more frames than just the one
9598 frame before it (also see frameref).
9599 Therefore, I-frames are not necessarily seekable.
9600 IDR-frames restrict subsequent P-frames from referring to any frame
9601 prior to the IDR-frame.
9604 .B scenecut=<\-1\-100>
9605 Controls how aggressively to insert extra I-frames (default: 40).
9606 With small values of scenecut, the codec often has to force an I-frame
9607 when it would exceed keyint.
9608 Good values of scenecut may find a better location for the I-frame.
9609 Large values use more I-frames than necessary, thus wasting bits.
9610 \-1 disables scene-cut detection, so I-frames are inserted only once
9611 every other keyint frames, even if a scene-cut occurs earlier.
9612 This is not recommended and wastes bitrate as scenecuts encoded as P-frames
9613 are just as big as I-frames, but do not reset the "keyint counter".
9616 .B frameref=<1\-16>
9617 Number of previous frames used as predictors in B- and P-frames (default: 1).
9618 This is effective in anime, but in live-action material the improvements
9619 usually drop off very rapidly above 6 or so reference frames.
9620 This has no effect on decoding speed, but does increase the memory needed for
9621 decoding.
9622 Some decoders can only handle a maximum of 15 reference frames.
9625 .B bframes=<0\-16>
9626 maximum number of consecutive B-frames between I- and P-frames (default: 0)
9629 .B (no)b_adapt
9630 Automatically decides when to use B-frames and how many, up to the maximum
9631 specified above (default: on).
9632 If this option is disabled, then the maximum number of B-frames is used.
9635 .B b_bias=<\-100\-100>
9636 Controls the decision performed by b_adapt.
9637 A higher b_bias produces more B-frames (default: 0).
9640 .B (no)b_pyramid
9641 Allows B-frames to be used as references for predicting other frames.
9642 For example, consider 3 consecutive B-frames: I0 B1 B2 B3 P4.
9643 Without this option, B-frames follow the same pattern as MPEG-[124].
9644 So they are coded in the order I0 P4 B1 B2 B3, and all the B-frames
9645 are predicted from I0 and P4.
9646 With this option, they are coded as I0 P4 B2 B1 B3.
9647 B2 is the same as above, but B1 is predicted from I0 and B2, and
9648 B3 is predicted from B2 and P4.
9649 This usually results in slightly improved compression, at almost no
9650 speed cost.
9651 However, this is an experimental option: it is not fully tuned and
9652 may not always help.
9653 Requires bframes >= 2.
9654 Disadvantage: increases decoding delay to 2 frames.
9657 .B (no)deblock
9658 Use deblocking filter (default: on).
9659 As it takes very little time compared to its quality gain, it is not
9660 recommended to disable it.
9663 .B deblock=<\-6\-6>,<\-6\-6>
9664 The first parameter is AlphaC0 (default: 0).
9665 This adjusts thresholds for the H.264 in-loop deblocking filter.
9666 First, this parameter adjusts the maximum amount of change that the filter is
9667 allowed to cause on any one pixel.
9668 Secondly, this parameter affects the threshold for difference across the
9669 edge being filtered.
9670 A positive value reduces blocking artifacts more, but will also smear details.
9672 The second parameter is Beta (default: 0).
9673 This affects the detail threshold.
9674 Very detailed blocks are not filtered, since the smoothing caused by the
9675 filter would be more noticeable than the original blocking.
9677 The default behavior of the filter almost always achieves optimal quality,
9678 so it is best to either leave it alone, or make only small adjustments.
9679 However, if your source material already has some blocking or noise which
9680 you would like to remove, it may be a good idea to turn it up a little bit.
9683 .B (no)cabac
9684 Use CABAC (Context-Adaptive Binary Arithmetic Coding) (default: on).
9685 Slightly slows down encoding and decoding, but should save 10\-15% bitrate.
9686 Unless you are looking for decoding speed, you should not disable it.
9689 .B qp_min=<1\-51> (ABR or two pass)
9690 Minimum quantizer, 10\-30 seems to be a useful range (default: 10).
9693 .B qp_max=<1\-51> (ABR or two pass)
9694 maximum quantizer (default: 51)
9697 .B qp_step=<1\-50> (ABR or two pass)
9698 maximum value by which the quantizer may be incremented/decremented between
9699 frames (default: 4)
9702 .B ratetol=<0.1\-100.0> (ABR or two pass)
9703 allowed variance in average bitrate (no particular units) (default: 1.0)
9706 .B vbv_maxrate=<value> (ABR or two pass)
9707 maximum local bitrate, in kbits/\:second (default: disabled)
9710 .B vbv_bufsize=<value> (ABR or two pass)
9711 averaging period for vbv_maxrate, in kbits
9712 (default: none, must be specified if vbv_maxrate is enabled)
9715 .B vbv_init=<0.0\-1.0> (ABR or two pass)
9716 initial buffer occupancy, as a fraction of vbv_bufsize (default: 0.9)
9719 .B ip_factor=<value>
9720 quantizer factor between I- and P-frames (default: 1.4)
9723 .B pb_factor=<value>
9724 quantizer factor between P- and B-frames (default: 1.3)
9727 .B qcomp=<0\-1> (ABR or two pass)
9728 quantizer compression (default: 0.6).
9729 A lower value makes the bitrate more constant,
9730 while a higher value makes the quantization parameter more constant.
9733 .B cplx_blur=<0\-999> (two pass only)
9734 Temporal blur of the estimated frame complexity, before curve compression
9735 (default: 20).
9736 Lower values allow the quantizer value to jump around more,
9737 higher values force it to vary more smoothly.
9738 cplx_blur ensures that each I-frame has quality comparable to the following
9739 P-frames, and ensures that alternating high and low complexity frames
9740 (e.g. low fps animation) do not waste bits on fluctuating quantizer.
9743 .B qblur=<0\-99> (two pass only)
9744 Temporal blur of the quantization parameter, after curve compression
9745 (default: 0.5).
9746 Lower values allow the quantizer value to jump around more,
9747 higher values force it to vary more smoothly.
9750 .B zones=<zone0>[/<zone1>[/...]]
9751 User specified quality for specific parts (ending, credits, ...).
9752 Each zone is <start-frame>,<end-frame>,<option> where option may be
9753 .PD 0
9754 .RSs
9755 .IPs "q=<0\-51>"
9756 quantizer
9757 .IPs "b=<0.01\-100.0>"
9758 bitrate multiplier
9760 .PD 1
9762 .I NOTE:
9763 The quantizer option is not strictly enforced.
9764 It affects only the planning stage of ratecontrol, and is still subject
9765 to overflow compensation and qp_min/qp_max.
9769 .B direct_pred=<name>
9770 Determines the type of motion prediction used for direct macroblocks
9771 in B-frames.
9772 .PD 0
9773 .RSs
9774 .IPs none
9775 Direct macroblocks are not used.
9776 .IPs spatial
9777 Motion vectors are extrapolated from neighboring blocks.
9778 (default)
9779 .IPs temporal
9780 Motion vectors are interpolated from the following P-frame.
9781 .IPs auto
9782 The codec selects between spatial and temporal for each frame.
9784 .PD 1
9786 Spatial and temporal are approximately the same speed and PSNR,
9787 the choice between them depends on the video content.
9788 Auto is slightly better, but slower.
9789 Auto is most effective when combined with multipass.
9790 direct_pred=none is both slower and lower quality.
9794 .B (no)weight_b
9795 Use weighted prediction in B-frames.
9796 Without this option, bidirectionally predicted macroblocks give
9797 equal weight to each reference frame.
9798 With this option, the weights are determined by the temporal position
9799 of the B-frame relative to the references.
9800 Requires bframes > 1.
9803 .B partitions=<list>
9804 Enable some optional macroblock types (default: p8x8,b8x8,i8x8,i4x4).
9805 .PD 0
9806 .RSs
9807 .IPs p8x8
9808 Enable types p16x8, p8x16, p8x8.
9809 .IPs p4x4
9810 Enable types p8x4, p4x8, p4x4.
9811 p4x4 is recommended only with subq >= 5, and only at low resolutions.
9812 .IPs b8x8
9813 Enable types b16x8, b8x16, b8x8.
9814 .IPs i8x8
9815 Enable type i8x8.
9816 i8x8 has no effect unless 8x8dct is enabled.
9817 .IPs i4x4
9818 Enable type i4x4.
9819 .IPs all
9820 Enable all of the above types.
9821 .IPs none
9822 Disable all of the above types.
9824 .PD 1
9826 Regardless of this option, macroblock types p16x16, b16x16, and i16x16
9827 are always enabled.
9829 The idea is to find the type and size that best describe a certain area
9830 of the picture.
9831 For example, a global pan is better represented by 16x16 blocks, while
9832 small moving objects are better represented by smaller blocks.
9836 .B (no)8x8dct
9837 Adaptive spatial transform size: allows macroblocks to choose between
9838 4x4 and 8x8 DCT.
9839 Also allows the i8x8 macroblock type.
9840 Without this option, only 4x4 DCT is used.
9843 .B me=<name>
9844 Select fullpixel motion estimation algorithm.
9845 .PD 0
9846 .RSs
9847 .IPs dia
9848 diamond search, radius 1 (fast)
9849 .IPs hex
9850 hexagon search, radius 2 (default)
9851 .IPs umh
9852 uneven multi-hexagon search (slow)
9853 .IPs esa
9854 exhaustive search (very slow, and no better than umh)
9856 .PD 1
9859 .B me_range=<4\-64>
9860 radius of exhaustive or multi-hexagon motion search (default: 16)
9863 .B subq=<1\-7>
9864 Adjust subpel refinement quality.
9865 This parameter controls quality versus speed tradeoffs involved in the motion
9866 estimation decision process.
9867 subq=5 can compress up to 10% better than subq=1.
9868 .PD 0
9869 .RSs
9870 .IPs 1
9871 Runs fullpixel precision motion estimation on all candidate
9872 macroblock types.
9873 Then selects the best type.
9874 Then refines the motion of that type to fast quarterpixel precision (fastest).
9875 .IPs 2
9876 Runs halfpixel precision motion estimation on all candidate macroblock types.
9877 Then selects the best type.
9878 Then refines the motion of that type to fast quarterpixel precision.
9879 .IPs 3
9880 As 2, but uses a slower quarterpixel refinement.
9881 .IPs 4
9882 Runs fast quarterpixel precision motion estimation on all candidate
9883 macroblock types.
9884 Then selects the best type.
9885 Then finishes the quarterpixel refinement for that type.
9886 .IPs 5
9887 Runs best quality quarterpixel precision motion estimation on all
9888 candidate macroblock types, before selecting the best type (default).
9889 .IPs 6
9890 Enables rate-distortion optimization of macroblock types in
9891 I- and P-frames.
9892 .IPs 7
9893 Enables rate-distortion optimization of motion vectors and intra modes. (best)
9895 .PD 1
9897 In the above, "all candidates" does not exactly mean all enabled types:
9898 4x4, 4x8, 8x4 are tried only if 8x8 is better than 16x16.
9902 .B (no)chroma_me
9903 Takes into account chroma information during subpixel motion search
9904 (default: enabled).
9905 Requires subq>=5.
9908 .B (no)mixed_refs
9909 Allows each 8x8 or 16x8 motion partition to independently select a
9910 reference frame.
9911 Without this option, a whole macroblock must use the same reference.
9912 Requires frameref>1.
9915 .B (no)brdo
9916 Enables rate-distortion optimization of macroblock types in B-frames.
9917 Requires subq>=6.
9920 .B (no)bime
9921 Refine the two motion vectors used in bidirectional macroblocks,
9922 rather than re-using vectors from the forward and backward searches.
9923 This option has no effect without B-frames.
9926 .B trellis=<0\-2>
9927 rate-distortion optimal quantization
9928 .PD 0
9929 .RSs
9930 .IPs 0
9931 disabled (default)
9932 .IPs 1
9933 enabled only for the final encode
9934 .IPs 2
9935 enabled during all mode decisions (slow, requires subq>=6)
9937 .PD 1
9940 .B deadzone_inter=<0\-32>
9941 Set the size of the inter luma quantization deadzone for non-trellis
9942 quantization (default: 21).
9943 Lower values help to preserve fine details and film grain (typically useful
9944 for high bitrate/quality encode), while higher values help filter out
9945 these details to save bits that can be spent again on other macroblocks
9946 and frames (typically useful for bitrate-starved encodes).
9947 It is recommended that you start by tweaking deadzone_intra before changing
9948 this parameter.
9951 .B deadzone_intra=<0\-32>
9952 Set the size of the intra luma quantization deadzone for non-trellis
9953 quantization (default: 11).
9954 This option has the same effect as deadzone_inter except that it affects
9955 intra frames.
9956 It is recommended that you start by tweaking this parameter before changing
9957 deadzone_inter.
9960 .B (no)fast_pskip
9961 Performs early skip detection in P-frames (default: enabled).
9962 This usually improves speed at no cost, but it can sometimes produce
9963 artifacts in areas with no details, like sky.
9966 .B (no)dct_decimate
9967 Eliminate dct blocks in P-frames containing only a small single coefficient
9968 (default: enabled).
9969 This will remove some details, so it will save bits that can be spent
9970 again on other frames, hopefully raising overall subjective quality.
9971 If you are compressing non-anime content with a high target bitrate, you
9972 may want to disable this to preserve as much detail as possible.
9975 .B nr=<0\-100000>
9976 Noise reduction, 0 means disabled.
9977 100\-1000 is a useful range for typical content, but you may want to turn it
9978 up a bit more for very noisy content (default: 0).
9979 Given its small impact on speed, you might want to prefer to use this over
9980 filtering noise away with video filters like denoise3d or hqdn3d.
9983 .B chroma_qp_offset=<\-12\-12>
9984 Use a different quantizer for chroma as compared to luma.
9985 Useful values are in the range <\-2\-2> (default: 0).
9988 .B cqm=<flat|jvt|<filename>>
9989 Either uses a predefined custom quantization matrix or loads a JM format
9990 matrix file.
9991 .PD 0
9992 .RSs
9993 .IPs "flat\ "
9994 Use the predefined flat 16 matrix (default).
9995 .IPs "jvt\ \ "
9996 Use the predefined JVT matrix.
9997 .IPs <filename>
9998 Use the provided JM format matrix file.
9999 .PD 1
10002 .I NOTE:
10003 Windows CMD.EXE users may experience problems with parsing the command line
10004 if they attempt to use all the CQM lists.
10005 This is due to a command line length limitation.
10006 In this case it is recommended the lists be put into a JM format CQM
10007 file and loaded as specified above.
10011 .B cqm4iy=<list> (also see cqm)
10012 Custom 4x4 intra luminance matrix, given as a list of 16 comma separated
10013 values in the 1\-255 range.
10016 .B cqm4ic=<list> (also see cqm)
10017 Custom 4x4 intra chrominance matrix, given as a list of 16 comma
10018 separated values in the 1\-255 range.
10021 .B cqm4py=<list> (also see cqm)
10022 Custom 4x4 inter luminance matrix, given as a list of 16 comma separated
10023 values in the 1\-255 range.
10026 .B cqm4pc=<list> (also see cqm)
10027 Custom 4x4 inter chrominance matrix, given as a list of 16 comma
10028 separated values in the 1\-255 range.
10031 .B cqm8iy=<list> (also see cqm)
10032 Custom 8x8 intra luminance matrix, given as a list of 64 comma separated
10033 values in the 1\-255 range.
10036 .B cqm8py=<list> (also see cqm)
10037 Custom 8x8 inter luminance matrix, given as a list of 64 comma separated
10038 values in the 1\-255 range.
10041 .B level_idc=<10\-51>
10042 Set the bitstream's level as defined by annex A of the H.264 standard
10043 (default: 51 \- level 5.1).
10044 This is used for telling the decoder what capabilities it needs to support.
10045 Use this parameter only if you know what it means,
10046 and you have a need to set it.
10049 .B threads=<0\-16>
10050 Spawn threads to encode in parallel on multiple CPUs (default: 1).
10051 This has a slight penalty to compression quality.
10052 0 or 'auto' tells x264 to detect how many CPUs you have and pick an
10053 appropriate number of threads.
10056 .B (no)global_header
10057 Causes SPS and PPS to appear only once, at the beginning of the bitstream
10058 (default: disabled).
10059 Some players, such as the Sony PSP, require the use of this option.
10060 The default behavior causes SPS and PPS to repeat prior to each IDR frame.
10063 .B (no)interlaced
10064 Treat the video content as interlaced.
10067 .B log=<\-1\-3>
10068 Adjust the amount of logging info printed to the screen.
10069 .PD 0
10070 .RSs
10071 .IPs "\-1"
10072 none
10073 .IPs " 0"
10074 Print errors only.
10075 .IPs " 1"
10076 warnings
10077 .IPs " 2"
10078 PSNR and other analysis statistics when the encode finishes (default)
10079 .IPs " 3"
10080 PSNR, QP, frametype, size, and other statistics for every frame
10082 .PD 1
10085 .B (no)psnr
10086 Print signal-to-noise ratio statistics.
10088 .I NOTE:
10089 The 'Y', 'U', 'V', and 'Avg' PSNR fields in the summary are not
10090 mathematically sound (they are simply the average of per-frame PSNRs).
10091 They are kept only for comparison to the JM reference codec.
10092 For all other purposes, please use either the 'Global' PSNR, or the per-frame
10093 PSNRs printed by log=3.
10096 .B (no)ssim
10097 Print the Structural Similarity Metric results.
10098 This is an alternative to PSNR, and may be better correlated with the
10099 perceived quality of the compressed video.
10102 .B (no)visualize
10103 Enable x264 visualizations during encoding.
10104 If the x264 on your system supports it, a new window will be opened during
10105 the encoding process, in which x264 will attempt to present an overview of
10106 how each frame gets encoded.
10107 Each block type on the visualized movie will be colored as follows:
10108 .PD 0
10109 .RSs
10110 .IPs red/pink
10111 intra block
10112 .IPs "blue\ "
10113 inter block
10114 .IPs green
10115 skip block
10116 .IPs yellow
10117 B-block
10119 .PD 1
10121 This feature can be considered experimental and subject to change.
10122 In particular, it depends on x264 being compiled with visualizations enabled.
10123 Note that as of writing this, x264 pauses after encoding and visualizing
10124 each frame, waiting for the user to press a key, at which point the next
10125 frame will be encoded.
10129 .SS xvfw (\-xvfwopts)
10131 Encoding with Video for Windows codecs is mostly obsolete unless you wish
10132 to encode to some obscure fringe codec.
10135 .B codec=<name>
10136 The name of the binary codec file with which to encode.
10139 .B compdata=<file>
10140 The name of the codec settings file (like firstpass.mcf) created by vfw2menc.
10143 .SS MPEG muxer (\-mpegopts)
10145 The MPEG muxer can generate 5 types of streams, each of which has reasonable
10146 default parameters that the user can override.
10147 Generally, when generating MPEG files, it is advisable to disable
10148 MEncoder's frame-skip code (see \-noskip, \-mc as well as the
10149 harddup and softskip video filters).
10151 .I EXAMPLE:
10152 .PD 0
10153 .RSs
10154 .IPs format=mpeg2:tsaf:vbitrate=8000
10156 .PD 1
10159 .B format=<mpeg1 | mpeg2 | xvcd | xsvcd | dvd | pes1 | pes2>
10160 stream format (default: mpeg2).
10161 pes1 and pes2 are very broken formats (no pack header and no padding),
10162 but VDR uses them; do not choose them unless you know exactly what you
10163 are doing.
10166 .B size=<up to 65535>
10167 Pack size in bytes, do not change unless you know exactly what
10168 you are doing (default: 2048).
10171 .B muxrate=<int>
10172 Nominal muxrate in kbit/s used in the pack headers (default: 1800 kb/s).
10173 Will be updated as necessary in the case of 'format=mpeg1' or 'mpeg2'.
10176 .B "tsaf\ \ \ "
10177 Sets timestamps on all frames, if possible; recommended when format=dvd.
10178 If dvdauthor complains with a message like "..audio sector out of range...",
10179 you probably did not enable this option.
10182 .B interleaving2
10183 Uses a better algorithm to interleave audio and video packets, based on the
10184 principle that the muxer will always try to fill the stream with the largest
10185 percentage of free space.
10188 .B vdelay=<1\-32760>
10189 Initial video delay time, in milliseconds (default: 0),
10190 use it if you want to delay video with respect to audio.
10191 It doesn't work with :drop.
10194 .B adelay=<1\-32760>
10195 Initial audio delay time, in milliseconds (default: 0),
10196 use it if you want to delay audio with respect to video.
10199 .B "drop\ \ \ "
10200 When used with vdelay the muxer drops the part of audio that was
10201 anticipated.
10204 .B vwidth, vheight=<1\-4095>
10205 Set the video width and height when video is MPEG-1/2.
10208 .B vpswidth, vpsheight=<1\-4095>
10209 Set pan and scan video width and height when video is MPEG-2.
10212 .B vaspect=<1 | 4/3 | 16/9 | 221/100>
10213 Sets the display aspect ratio for MPEG-2 video.
10214 Do not use it on MPEG-1 or the resulting aspect ratio will be completely wrong.
10217 .B vbitrate=<int>
10218 Sets the video bitrate in kbit/s for MPEG-1/2 video.
10221 .B vframerate=<24000/1001 | 24 | 25 | 30000/1001 | 30 | 50 | 60000/1001 | 60 >
10222 Sets the framerate for MPEG-1/2 video.
10223 This option will be ignored if used with the telecine option.
10226 .B telecine
10227 Enables 3:2 pulldown soft telecine mode: The muxer will make the
10228 video stream look like it was encoded at 30000/1001 fps.
10229 It only works with MPEG-2 video when the output framerate is
10230 24000/1001 fps, convert it with \-ofps if necessary.
10231 Any other framerate is incompatible with this option.
10234 .B film2pal
10235 Enables FILM to PAL and NTSC to PAL soft telecine mode: The muxer
10236 will make the video stream look like it was encoded at 25 fps.
10237 It only works with MPEG-2 video when the output framerate is
10238 24000/1001 fps, convert it with \-ofps if necessary.
10239 Any other framerate is incompatible with this option.
10242 .B tele_src and tele_dest
10243 Enables arbitrary telecining using Donand Graft's DGPulldown code.
10244 You need to specify the original and the desired framerate; the
10245 muxer will make the video stream look like it was encoded at
10246 the desired framerate.
10247 It only works with MPEG-2 video when the input framerate is smaller
10248 than the output framerate and the framerate increase is <= 1.5.
10249 .sp 1
10251 .I EXAMPLE:
10253 .PD 0
10254 .RSs
10255 .IPs tele_src=25,tele_dest=30000/1001
10256 PAL to NTSC telecining
10258 .PD 1
10261 .B vbuf_size=<40\-1194>
10262 Sets the size of the video decoder's buffer, expressed in kilobytes.
10263 Specify it only if the bitrate of the video stream is too high for
10264 the chosen format and if you know perfectly well what you are doing.
10265 A too high value may lead to an unplayable movie, depending on the player's
10266 capabilities.
10267 When muxing HDTV video a value of 400 should suffice.
10270 .B abuf_size=<4\-64>
10271 Sets the size of the audio decoder's buffer, expressed in kilobytes.
10272 The same principle as for vbuf_size applies.
10275 .SS FFmpeg libavformat demuxers (\-lavfdopts)
10278 .B analyzeduration=<value>
10279 Maximum length in seconds to analyze the stream properties.
10282 .B format=<value>
10283 Force a specific libavformat demuxer.
10286 .B probesize=<value>
10287 Maximum amount of data to probe during the detection phase.
10288 In the case of MPEG-TS this value identifies the maximum number
10289 of TS packets to scan.
10292 .B cryptokey=<hexstring>
10293 Encryption key the demuxer should use.
10294 This is the raw binary data of the key converted to a hexadecimal string.
10298 .SS FFmpeg libavformat muxers (\-lavfopts) (also see \-of lavf)
10301 .B delay=<value>
10302 Currently only meaningful for MPEG[12]: Maximum allowed distance,
10303 in seconds, between the reference timer of the output stream (SCR)
10304 and the decoding timestamp (DTS) for any stream present
10305 (demux to decode delay).
10306 Default is 0.7 (as mandated by the standards defined by MPEG).
10307 Higher values require larger buffers and must not be used.
10310 .B format=<container_format>
10311 Override which container format to mux into
10312 (default: autodetect from output file extension).
10313 .PD 0
10314 .RSs
10315 .IPs "mpg\ \ "
10316 MPEG-1 systems and MPEG-2 PS
10317 .IPs "asf\ \ "
10318 Advanced Streaming Format
10319 .IPs "avi\ \ "
10320 Audio Video Interleave file
10321 .IPs "wav\ \ "
10322 Waveform Audio
10323 .IPs "swf\ \ "
10324 Macromedia Flash
10325 .IPs "flv\ \ "
10326 Macromedia Flash video files
10327 .IPs "rm\ \ \ "
10328 RealAudio and RealVideo
10329 .IPs "au\ \ \ "
10330 SUN AU format
10331 .IPs "nut\ \ "
10332 NUT open container format (experimental)
10333 .IPs "mov\ \ "
10334 QuickTime
10335 .IPs "mp4\ \ "
10336 MPEG-4 format
10337 .IPs "dv\ \ \ "
10338 Sony Digital Video container
10340 .PD 1
10342 .B muxrate=<rate>
10343 Nominal bitrate of the multiplex, in bits per second;
10344 currently it is meaningful only for MPEG[12].
10345 Sometimes raising it is necessary in order to avoid "buffer underflows".
10348 .B packetsize=<size>
10349 Size, expressed in bytes, of the unitary packet for the chosen format.
10350 When muxing to MPEG[12] implementations the default values are:
10351 2324 for [S]VCD, 2048 for all others formats.
10354 .B preload=<distance>
10355 Currently only meaningful for MPEG[12]: Initial distance,
10356 in seconds, between the reference timer of the output stream (SCR)
10357 and the decoding timestamp (DTS) for any stream present
10358 (demux to decode delay).
10362 .\" --------------------------------------------------------------------------
10363 .\" environment variables
10364 .\" --------------------------------------------------------------------------
10366 .SH ENVIRONMENT VARIABLES
10368 There are a number of environment variables that can be used to
10369 control the behavior of MPlayer and MEncoder.
10372 .B MPLAYER_CHARSET (also see \-msgcharset)
10373 Convert console messages to the specified charset (default: autodetect).
10374 A value of "noconv" means no conversion.
10377 .B MPLAYER_HOME
10378 Directory where MPlayer looks for user settings.
10381 .B MPLAYER_VERBOSE (also see \-v and \-msglevel)
10382 Set the initial verbosity level across all message modules (default: 0).
10383 The resulting verbosity corresponds to that of \-msglevel 5 plus the
10384 value of MPLAYER_VERBOSE.
10386 .SS libaf:
10389 .B LADSPA_PATH
10390 If LADSPA_PATH is set, it searches for the specified file.
10391 If it is not set, you must supply a fully specified pathname.
10392 FIXME: This is also mentioned in the ladspa section.
10394 .SS libdvdcss:
10397 .B DVDCSS_CACHE
10398 Specify a directory in which to store title key values.
10399 This will speed up descrambling of DVDs which are in the cache.
10400 The DVDCSS_CACHE directory is created if it does not exist,
10401 and a subdirectory is created named after the DVD's title
10402 or manufacturing date.
10403 If DVDCSS_CACHE is not set or is empty, libdvdcss will use
10404 the default value which is "${HOME}/.dvdcss/" under Unix and
10405 "C:\\Documents and Settings\\$USER\\Application Data\\dvdcss\\" under Win32.
10406 The special value "off" disables caching.
10409 .B DVDCSS_METHOD
10410 Sets the authentication and decryption method that
10411 libdvdcss will use to read scrambled discs.
10412 Can be one of title, key or disc.
10413 .PD 0
10414 .RSs
10415 .IPs "key\ \ "
10416 is the default method.
10417 libdvdcss will use a set of calculated player keys to try and get the disc key.
10418 This can fail if the drive does not recognize any of the player keys.
10419 .IPs "disc\ "
10420 is a fallback method when key has failed.
10421 Instead of using player keys, libdvdcss will crack the disc key using
10422 a brute force algorithm.
10423 This process is CPU intensive and requires 64 MB of memory to store
10424 temporary data.
10425 .IPs title
10426 is the fallback when all other methods have failed.
10427 It does not rely on a key exchange with the DVD drive, but rather uses
10428 a crypto attack to guess the title key.
10429 On rare cases this may fail because there is not enough encrypted data
10430 on the disc to perform a statistical attack, but in the other hand it
10431 is the only way to decrypt a DVD stored on a hard disc, or a DVD with
10432 the wrong region on an RPC2 drive.
10434 .PD 1
10437 .B DVDCSS_RAW_DEVICE
10438 Specify the raw device to use.
10439 Exact usage will depend on your operating system, the Linux
10440 utility to set up raw devices is raw(8) for instance.
10441 Please note that on most operating systems, using a raw device
10442 requires highly aligned buffers: Linux requires a 2048 bytes
10443 alignment (which is the size of a DVD sector).
10446 .B DVDCSS_VERBOSE
10447 Sets the libdvdcss verbosity level.
10448 .PD 0
10449 .RSs
10450 .IPs 0
10451 Outputs no messages at all.
10452 .IPs 1
10453 Outputs error messages to stderr.
10454 .IPs 2
10455 Outputs error messages and debug messages to stderr.
10457 .PD 1
10460 .B DVDREAD_NOKEYS
10461 Skip retrieving all keys on startup.
10462 Currently disabled.
10465 .B HOME
10466 FIXME: Document this.
10468 .SS libao2:
10471 .B AO_SUN_DISABLE_SAMPLE_TIMING
10472 FIXME: Document this.
10475 .B AUDIODEV
10476 FIXME: Document this.
10479 .B AUDIOSERVER
10480 Specifies the Network Audio System server to which the
10481 nas audio output driver should connect and the transport
10482 that should be used.
10483 If unset DISPLAY is used instead.
10484 The transport can be one of tcp and unix.
10485 Syntax is tcp/<somehost>:<someport>, <somehost>:<instancenumber>
10486 or [unix]:<instancenumber>.
10487 The NAS base port is 8000 and <instancenumber> is added to that.
10488 .sp 1
10490 .I EXAMPLES:
10492 .PD 0
10493 .RSs
10494 .IPs AUDIOSERVER=somehost:0
10495 Connect to NAS server on somehost using default port and transport.
10496 .IPs AUDIOSERVER=tcp/somehost:8000
10497 Connect to NAS server on somehost listening on TCP port 8000.
10498 .IPs AUDIOSERVER=(unix)?:0
10499 Connect to NAS server instance 0 on localhost using unix domain sockets.
10501 .PD 1
10504 .B DISPLAY
10505 FIXME: Document this.
10507 .SS vidix:
10510 .B VIDIX_CRT
10511 FIXME: Document this.
10513 .SS osdep:
10516 .B TERM
10517 FIXME: Document this.
10519 .SS libvo:
10522 .B DISPLAY
10523 FIXME: Document this.
10526 .B FRAMEBUFFER
10527 FIXME: Document this.
10530 .B HOME
10531 FIXME: Document this.
10533 .SS libmpdemux:
10536 .B HOME
10537 FIXME: Document this.
10540 .B HOMEPATH
10541 FIXME: Document this.
10544 .B http_proxy
10545 FIXME: Document this.
10548 .B LOGNAME
10549 FIXME: Document this.
10552 .B USERPROFILE
10553 FIXME: Document this.
10555 .SS libmpcodecs:
10558 .B XANIM_MOD_DIR
10559 FIXME: Document this.
10561 .SS GUI:
10564 .B CHARSET
10565 FIXME: Document this.
10568 .B DISPLAY
10569 FIXME: Document this.
10572 .B HOME
10573 FIXME: Document this.
10575 .SS libavformat:
10578 .B AUDIO_FLIP_LEFT
10579 FIXME: Document this.
10582 .B BKTR_DEV
10583 FIXME: Document this.
10586 .B BKTR_FORMAT
10587 FIXME: Document this.
10590 .B BKTR_FREQUENCY
10591 FIXME: Document this.
10594 .B http_proxy
10595 FIXME: Document this.
10598 .B no_proxy
10599 FIXME: Document this.
10603 .\" --------------------------------------------------------------------------
10604 .\" Files
10605 .\" --------------------------------------------------------------------------
10607 .SH FILES
10610 /usr/\:local/\:etc/\:mplayer/\:mplayer.conf
10611 MPlayer system-wide settings
10614 /usr/\:local/\:etc/\:mplayer/\:mencoder.conf
10615 MEncoder system-wide settings
10618 ~/.mplayer/\:config
10619 MPlayer user settings
10622 ~/.mplayer/\:mencoder.conf
10623 MEncoder user settings
10626 ~/.mplayer/\:input.conf
10627 input bindings (see '\-input keylist' for the full list)
10630 ~/.mplayer/\:gui.conf
10631 GUI configuration file
10634 ~/.mplayer/\:gui.pl
10635 GUI playlist
10638 ~/.mplayer/\:font/
10639 font directory (There must be a font.desc file and files with .RAW extension.)
10642 ~/.mplayer/\:DVDkeys/
10643 cached CSS keys
10646 Assuming that /path/\:to/\:movie.avi is played, MPlayer searches for sub files
10647 in this order:
10649 /path/\:to/\:movie.sub
10651 ~/.mplayer/\:sub/\:movie.sub
10653 .PD 1
10656 .\" --------------------------------------------------------------------------
10657 .\" Examples
10658 .\" --------------------------------------------------------------------------
10660 .SH EXAMPLES OF MPLAYER USAGE
10663 .B Quickstart DVD playing:
10665 mplayer dvd://1
10669 .B Play in Japanese with English subtitles:
10671 mplayer dvd://1 \-alang ja \-slang en
10675 .B Play only chapters 5, 6, 7:
10677 mplayer dvd://1 \-chapter 5\-7
10681 .B Play only titles 5, 6, 7:
10683 mplayer dvd://5\-7
10687 .B Play a multiangle DVD:
10689 mplayer dvd://1 \-dvdangle 2
10693 .B Play from a different DVD device:
10695 mplayer dvd://1 \-dvd\-device /dev/\:dvd2
10699 .B Play DVD video from a directory with VOB files:
10701 mplayer dvd://1 \-dvd\-device /path/\:to/\:directory/
10705 .B Copy a DVD title to hard disk, saving to file "title1.vob":
10707 mplayer dvd://1 \-dumpstream \-dumpfile title1.vob
10711 .B Play a DVD with dvdnav from path /dev/sr1:
10713 mplayer dvdnav:////dev/sr1
10717 .B Stream from HTTP:
10719 mplayer http://mplayer.hq/example.avi
10723 .B Stream using RTSP:
10725 mplayer rtsp://server.example.com/streamName
10729 .B Convert subtitles to MPsub format:
10731 mplayer dummy.avi \-sub source.sub \-dumpmpsub
10735 .B Convert subtitles to MPsub format without watching the movie:
10737 mplayer /dev/\:zero \-rawvideo pal:fps=xx \-demuxer rawvideo \-vc null \-vo null \-noframedrop \-benchmark \-sub source.sub \-dumpmpsub
10741 .B input from standard V4L:
10743 mplayer tv:// \-tv driver=v4l:width=640:height=480:outfmt=i420 \-vc rawi420 \-vo xv
10747 .B Playback on Zoran cards (old style, deprecated):
10749 mplayer \-vo zr \-vf scale=352:288 file.avi
10753 .B Playback on Zoran cards (new style):
10755 mplayer \-vo zr2 \-vf scale=352:288,zrmjpeg file.avi
10759 .B Play DTS-CD with passthrough:
10761 mplayer \-ac hwdts \-rawaudio format=0x2001 \-cdrom\-device /dev/cdrom cdda://
10764 You can also use \-afm hwac3 instead of \-ac hwdts.
10765 Adjust '/dev/cdrom' to match the CD-ROM device on your system.
10766 If your external receiver supports decoding raw DTS streams,
10767 you can directly play it via cdda:// without setting format, hwac3 or hwdts.
10770 .B Play a 6-channel AAC file with only two speakers:
10772 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
10775 You might want to play a bit with the pan values (e.g multiply with a value) to
10776 increase volume or avoid clipping.
10779 .B checkerboard invert with geq filter:
10781 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'
10785 .SH EXAMPLES OF MENCODER USAGE
10788 .B Encode DVD title #2, only selected chapters:
10790 mencoder dvd://2 \-chapter 10\-15 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10794 .B Encode DVD title #2, resizing to 640x480:
10796 mencoder dvd://2 \-vf scale=640:480 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10800 .B Encode DVD title #2, resizing to 512xHHH (keep aspect ratio):
10802 mencoder dvd://2 \-vf scale \-zoom \-xy 512 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4
10806 .B The same, but with bitrate set to 1800kbit and optimized macroblocks:
10808 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mpeg4:mbd=1:vbitrate=1800
10812 .B The same, but with MJPEG compression:
10814 mencoder dvd://2 \-o title2.avi \-oac copy \-ovc lavc \-lavcopts vcodec=mjpeg:mbd=1:vbitrate=1800
10818 .B Encode all *.jpg files in the current directory:
10820 mencoder "mf://*.jpg" \-mf fps=25 \-o output.avi \-ovc lavc \-lavcopts vcodec=mpeg4
10824 .B Encode from a tuner (specify a format with \-vf format):
10826 mencoder \-tv driver=v4l:width=640:height=480 tv:// \-o tv.avi \-ovc raw
10830 .B Encode from a pipe:
10832 rar p test-SVCD.rar | mencoder \-ovc lavc \-lavcopts vcodec=mpeg4:vbitrate=800 \-ofps 24 \-
10836 .\" --------------------------------------------------------------------------
10837 .\" Bugs, authors, standard disclaimer
10838 .\" --------------------------------------------------------------------------
10840 .SH BUGS
10841 Don't panic.
10842 If you find one, report it to us, but please make sure you have read all
10843 of the documentation first.
10844 Also look out for smileys. :)
10845 Many bugs are the result of incorrect setup or parameter usage.
10846 The bug reporting section of the documentation
10847 (http://www.mplayerhq.hu/\:DOCS/\:HTML/\:en/\:bugreports.html)
10848 explains how to create useful bug reports.
10852 .SH AUTHORS
10853 MPlayer was initially written by Arpad Gereoffy.
10854 See the AUTHORS file for a list of some of the many other contributors.
10856 MPlayer is (C) 2000\-2008 The MPlayer Team
10858 This man page was written mainly by Gabucino, Jonas Jermann and Diego Biurrun.
10859 It is maintained by Diego Biurrun.
10860 Please send mails about it to the MPlayer-DOCS mailing list.
10861 Translation specific mails belong on the MPlayer-translations mailing list.
10862 .\" end of file