# HG changeset patch # User jonas # Date 1031242314 0 # Node ID a6dc13dd2fd06c0c33d741197bb7ef4b290ec814 # Parent 5fa6eb7b0f1a117841687780f42daf25de16ad24 cosmetics: notes, examples, synopsis, preparations for rewrite, removed spaces at end, moved player options at beginning and decoding before encoding options, some small changes, no content changes diff -r 5fa6eb7b0f1a -r a6dc13dd2fd0 DOCS/mplayer.1 --- a/DOCS/mplayer.1 Thu Sep 05 15:22:45 2002 +0000 +++ b/DOCS/mplayer.1 Thu Sep 05 16:11:54 2002 +0000 @@ -8,11 +8,29 @@ .\" Macro definitions .\" -------------------------------------------------------------------------- . -.de RSx -.RS +12 +.\" default indentation is 7, don't change! +.nr IN 7 +.. +.\" define indentation for suboptions +.nr SS 18 +.. +.\" add new suboption +.de IPs +.IP "\\$1" \n(SS .. -.de RSy -.RS +10 +.\" begin of first grade suboptions, end with .RE +.de RSs +.RS \n(IN+3 +.. +.\" begin of 2nd grade suboptions +.de RSss +.PD 0 +.RS \n(SS+3 +.. +.\" end of 2nd grade suboptions +.de REss +.RE +.PD 1 .. . .\" -------------------------------------------------------------------------- @@ -32,25 +50,25 @@ . .SH SYNOPSIS .B mplayer -.RB [options]\ [\fIfile\fP\ |\ \fIURL\fP\ |\ \fIplaylist\fP\ |\ \-\ ] +.RI [options]\ [ \ file\ | \ URL\ | \ playlist\ | \ -\ ] .br .B mplayer -.RB [global\ options]\ \fIfile1\fP\ [specific\ options]\ [file2]\ [specific\ options] +.RI [global\ options] \ file1\ [specific\ options]\ [file2]\ [specific\ options] .br .B mplayer -.RB [global\ options]\ {\fIgroup\ of\ files\ and\ options\fP}\ [group\ specific\ options] +.RI [global\ options]\ { group\ of\ files\ and\ options }\ [group\ specific\ options] .br .B mplayer -.RB [dvd|vcd|cdda|cddb|tv]://[title]\ [options] +.RI [ dvd | vcd | cdda | cddb | tv ] ://title\ [options] .br .B mplayer -.RB [mms|mmst|http|http_proxy|rtp|rtsp]://[user:passwd@]URL[:port]\ [options] +.RI [ mms | mmst | http | http_proxy | rtp | rtsp ] :// [user:passwd@] URL [:port]\ [options] .br .B mencoder -.RB [options]\ [\fIfile\fP\ |\ \fIURL\fP\ |\ \-\ ]\ [\-o\ file] +.RI [options]\ [ \ file\ | \ URL\ | \ -\ ]\ [\-o\ file] .br .B gmplayer -.RB [options]\ [\-skin\ skin] +.RI [options]\ [\-skin\ skin] .\" -------------------------------------------------------------------------- .\" Description @@ -63,30 +81,30 @@ FLI, RM, NuppelVideo, yuv4mpeg, FILM, RoQ files, supported by many native, XAnim, and Win32 DLL codecs. You can watch VideoCD, SVCD, DVD, 3ivx, DivX 3/4/5 and even WMV movies, too (without the avifile library). - +.P Another great feature of mplayer is the wide range of supported output drivers. It works with X11, XV, DGA, OpenGL, SVGAlib, fbdev, AAlib, DirectFB, but you can use -GGI, SDL (and this way all their drivers), VESA (on every VESA compatible card, even +GGI, SDL (and this way all their drivers), VESA (on every VESA compatible card, even without X11!) and some low level card-specific drivers (for Matrox, 3Dfx and ATI), too! .br Most of them support software or hardware scaling, so you can enjoy movies in fullscreen. MPlayer supports displaying through some hardware MPEG decoder boards, such as the Siemens DVB, DXR2 and DXR3/Hollywood+! - +.P MPlayer has an onscreen display (OSD) for status information, nice big antialiased shaded subtitles and visual feedback for keyboard controls. European/ISO 8859-1,2 (Hungarian, English, Czech, etc), Cyrillic and Korean fonts are supported along with 9 subtitle formats (MicroDVD, SubRip, SubViewer, Sami, VPlayer, RT, SSA, AQTitle and our own: MPsub). DVD subtitles (SPU streams, VobSub and Closed Captions) are supported. - +.P .B mencoder (MPlayer's Movie Encoder) is a simple movie encoder, designed to encode MPlayer-playable movies (see above) to other MPlayer-playable formats (see below). It encodes to DivX4 (1, 2 or 3 passes), XviD, codecs of libavcodec, PCM/MP3/VBRMP3 audio. It also has stream copying abilities, a powerful plugin system (crop, expand, flip, postprocess, rotate, scale, add/remove noise, rgb/yuv conversion) and more. - +.P .B gmplayer is MPlayer with a graphical user interface. It has the same options as MPlayer. @@ -99,7 +117,7 @@ .SH GENERAL NOTES .B Check the HTML documentation, too! -Every "flag" option has a "noflag" counterpart, e.g. the opposite of the \-fs +Every "flag" option has a "noflag" counterpart, e.g. the opposite of the \-fs option is \-nofs. .br You can put all of the options in a config file which will be read every time @@ -113,7 +131,7 @@ in this way. .I EXAMPLE: - +.br # Use Matrox driver by default. .br vo=xmga @@ -127,6 +145,104 @@ mf= type=png:fps=25 +.SH "PLAYER OPTIONS (MPLAYER ONLY)" +.TP +.B \-autoq (use with -vop pp!) +Dynamically changes the level of postprocess, depending on spare CPU time +available. The number you specify will be the maximum level used. Usually you +can use some big number. You may not use it together with \-pp but it is OK with +\-npp! +.TP +.B \-benchmark +Prints some statistics on CPU usage and dropped frames at the end. +Used in combination with \-nosound and \-vo null for benchmarking only video codec. +.TP +.B \-dapsync (OBSOLETE) +Use alternative A/V sync method. +.TP +.B \-framedrop (see \-hardframedrop option too!) +Frame dropping: decode all (except B) frames, video may skip. +Useful for playback on slow VGA card/bus. +.TP +.B \-h, \-\-help +Show short summary of options. +.TP +.B \-hardframedrop +More intense frame dropping (breaks decoding). Leads to image distortion! +.TP +.B \-input +This option can be used to configure certain parts of the input system. +Relative path are relative to $HOME/.mplayer. Available commands are: + + conf= Read alternative input.conf. + If given without pathname, + $HOME/.mplayer is assumed. + ar\-delay Delay in msec before we start + to autorepeat a key + (0 to disable). + ar\-rate How many key presses/second when + we autorepeat. + keylist Prints all keys that can be + bound to. + cmdlist Prints all commands that can + be bound. + js\-dev Specifies the joystick device + to use + (default is /dev/input/js0). + +.I NOTE: +Autorepeat is currently only supported by joysticks. +.TP +.B \-lircconf +Specifies a configfile for LIRC (see http://www.lirc.org) if you don't like the default ~/.lircrc. +.TP +.B \-loop +Loops movie playback times. 0 means forever. +.TP +.B \-nojoystick +Turns off joystick support. Default is on, if compiled in. +.TP +.B \-nolirc +Turns off lirc support. +.TP +.B \-nortc \ \ +Turns off usage of /dev/rtc (real-time clock). +.TP +.B \-playlist +Play files according to this file list (1 file/row or Winamp or asx format). +.TP +.B \-quiet \ \ +Display less output, status messages. +.TP +.B \-skin (BETA CODE) +Load skin from this directory (WITHOUT path name!). + +.I EXAMPLE: + \-skin fittyfene tries these: + /usr/local/share/mplayer/Skin/fittyfene + ~/.mplayer/Skin/fittyfene +.TP +.B \-slave \ \ +This option switches on slave mode. This is intended for use +of MPlayer as a backend to other programs. Instead of intercepting keyboard +events, MPlayer will read simplistic command lines from its stdin. +See section +.B SLAVE MODE PROTOCOL +For the syntax. +.TP +.B \-softsleep +Uses high quality software timers. Efficient as the RTC, doesn't need root, +but requires more CPU. +.TP +.B \-sstep +Specifies seconds between displayed frames. Useful for slideshows. +.TP +.B \-stop_xscreensaver +Turns off xscreensaver at startup and turns it on again on exit. +.TP +.B \-use-stdin + + .SH "DEMUXER/STREAM OPTIONS" .TP .B \-aid (also see \-alang option) @@ -240,7 +356,7 @@ this option gives the CSS key needed to decrypt the VOB (the key is printed when authenticating with the DVD drive using \-dvdauth). .TP -.B \-dvdnav (BETA CODE) +.B \-dvdnav (BETA CODE) Force usage of libdvdnav. .TP .B \-forceidx @@ -261,7 +377,7 @@ the exact frame. .TP .B \-idx (also see \-forceidx) -Rebuilds INDEX of the AVI if no INDEX was found, +Rebuilds INDEX of the AVI if no INDEX was found, thus allowing seeking. Useful with broken/incomplete downloads, or badly created AVIs. .TP @@ -320,7 +436,7 @@ \-ss 01:10:00 seeks to 1 hour 10 min .TP .B \-tv -This option enables the TV grabbing feature of MPlayer (see documentation). +This option enables the TV grabbing feature of MPlayer (see documentation). Available options are: on use TV input @@ -381,7 +497,7 @@ .I NOTE: Mplayer doesn't accept colons so type dots instead in the device ID, eg. hw.0,0 instead of hw:0,0) - +.br Be advised that although you can select any samplerate when using ALSA, the LAME audio codec is able to encode only the "standard" samplerates. You'll get an .avi file with no sound when you choose an odd @@ -400,353 +516,6 @@ Force audio parameters for the .vivo demuxer (for debugging purposes). -.SH "DECODING/FILTERING OPTIONS" -.TP -.B \-ac -Force usage of a specific audio codec, according to its codec name in -codecs.conf. - -.I EXAMPLE: - \-ac mp3 use mp3lib - \-ac mad use libmad - \-ac mp3acm use l3codeca.acm MP3 codec - \-ac ac3 use AC3 codec - \-ac hwac3 enable hardware AC3 passthrough - (see documentation) - \-ac vorbis use libvorbis - \-ac ffmp3 use FFmpeg's MP3 decoder (SLOW) - -See \-ac help for a full list of available codecs. -.TP -.B \-afm -Force usage of a specific audio codec family, according to its driver name -in codecs.conf and fall back to default if it failed. - -.I EXAMPLE: - \-afm ffmpeg use FFmpeg's libavcodec (mp1/2/3) - \-afm acm use a matching Win32 codec - -See \-afm help for a full list of available drivers. -.TP -.B \-aspect -Override aspect ratio of movies. It's autodetected on MPEG files, but can't be -autodetected on most AVI files. - -.I EXAMPLE: - \-aspect 4:3 or \-aspect 1.3333 - \-aspect 16:9 or \-aspect 1.7777 -.TP -.B \-flip \ -Flip image upside\-down. -.TP -.B \-lavdopts (DEBUG CODE) -If decoding with a codec from libavcodec, you can specify its parameters here. - -.I EXAMPLE: - \-lavdopts bug=1 - -Available options are: - - ver= error resilience: - -1 needed for some very broken - encoders - 0 default - 1 more aggressive error - detection - bug= manual workaround encoder bugs: - 0 default - 1 workaround for some old lavc - generated msmpeg4v3 files -.TP -.B \-nosound -Do not play/encode sound. -.TP -.B \-npp -This option allows giving more literate postprocessing options, -and is another way of calling it (not with \-pp). See \-npp help -for a full list of available options. The keywords accept a '\-' -prefix to disable the option. -.br -A ':' followed by a letter may be appended to the option to indicate its -scope: - a Automatically switches the filter off if the CPU is too slow. - c Do chrominance filtering, too. - y Do not do chrominance filtering (only luminance filtering). -.br -Each filter defaults to 'c' (chrominance). -.br -.I NOTE: --npp only controls the external postprocess filter, and you HAVE TO -load it manually by -vop pp (Usage: -vop pp -npp ), -it is not auto-loaded! - -.I EXAMPLE: - \-npp hb,vb,dr,al,lb same as \-pp 0x2007f - \-npp hb,vb,dr,al same as \-pp 0x7f - \-npp de,\-al default filters without - brightness/contrast - correction - \-npp de,tn:1:2:3 Enable default filters - & temporal denoiser. - \-npp hb:y,vb:a \-autoq 6 - Deblock horizontal only - luminance and switch - vertical deblocking on or - off automatically - depending on available - CPU time. -.TP -.B \-pp (see \-npp option too!) -Apply postprocess filter on decoded image. - -Value given by -pp is sent to the codec, if the codec has built-in postprocess -filter (newer win32 DShow DLLs, divx4linux) otherwise the external postprocess -filter plugin (-vop pp) is auto-loaded and used. -Note, that you can use the built-in and external pp at the -same time, use -pp to set internal pp, and -vop pp=value to set up the external! - -The valid range of -pp value for built-in pp filters vary on codecs, mostly -0-6, where 0=disable 6=slowest/best. - -For the external pp filter, this is the numerical mode to use postprocessing. The '\-npp' option described -above has the same effects but with letters. To have several filters at the -same time, simply add the hexadecimal values. - -.I EXAMPLE: -The following values are known to give good results: - \-pp 0x20000 (\-npp lb) deinterlacing (for DVD/MPEG2 playback e.g.) - \-pp 0x7f (\-npp hb,vb,dr,al) deblocking filter (for DivX) -.TP -.B \-ssf (BETA CODE) -Specifies SwScaler parameters. Available options are: - - lgb=[0..100] Gaussian blur filter (luma) - cgb=[0..100] Gaussian blur filter (chroma) - ls=[0..100] sharpen filter (luma) - cs=[0..100] sharpen filter (chroma) - cvs=x chroma vertical shifting - chs=x chroma horizontal shifting - -.I EXAMPLE - \-vop scale -ssf lgb=3.0 -.TP -.B \-stereo -Select type of MP2/MP3 stereo output. - - Stereo 0 - Left channel 1 - Right channel 2 -.TP -.B \-sws (see \-vop scale option too!) -This option sets the quality (and speed, respectively) of the software scaler, -with the \-zoom option. For example with x11 or other outputs which lack -hardware acceleration. Possible settings are: - - 0 fast bilinear (default) - 1 bilinear - 2 bicubic (good quality) - 3 experimental - 4 nearest neighbour (bad quality) - 5 area - 6 luma bicubic / chroma bilinear - 7 gauss - 8 sincR - 9 lanczos - 10 bicubic spline - -.I NOTE: -For \-sws 2 and 7, the sharpness can be set with the scaling parameter (p) -of \-vop scale (0 (soft) \- 100 (sharp)), for \-sws 9, it specifies the filter -length (1 \- 10). -.TP -.B \-vc -Force usage of a specific video codec, according to its codec name in codecs.conf, - -.I EXAMPLE: - \-vc divx use VFW DivX codec - \-vc divxds use DirectShow DivX codec - \-vc ffdivx use libavcodec's DivX codec - \-vc ffmpeg12 use libavcodec's MPEG1/2 codec - \-vc divx4 use Project Mayo's DivX codec - -See \-vc help for a full list of available codecs. -.TP -.B \-vfm -Force usage of a specific video codec family, according to its driver name -in codecs.conf and fall back to default if it failed. - -.I EXAMPLE: - \-vfm ffmpeg use libavcodec codecs - \-vfm vfw use VFW (Win32) codecs - \-vfm odivx use OpenDivX/DivX4 codec (YV12) - (same as \-vc odivx but fallback) - \-vfm dshow use DirectShow (Win32) codecs - \-vfm divx4 use DivX4 codec (YUY2) - (same as \-vc divx4 but fallback) - \-vfm xanim use XAnim codecs - -.I NOTE: -If libdivxdecore support was compiled in, then odivx and divx4 now contains -just the same DivX4 codec, but different APIs to reach it. For difference -between them and when to use which, check the DivX4 section in the -documentation. - -See \-vfm help for a full list of available drivers. -.TP -.B \-vop <...,plugin3[=options],plugin2,plugin1> -Activate a comma separated list of video filters. -Available plugins are: - - crop[=w:h:x:y] Crops the given part of the - image and discards the rest. - Useful to remove black bands - from widescreen movies. - - rectangle[=w:h:x:y] Draws a rectangle of the - requested width and height - at the specified coordinates - over the image (used to test - crop). - (default: maximum w/h, upper - left x/y position) - - expand[=w:h:x:y:o] Expands (not scales) movie - resolution to the given - value and places the - unscaled original at - coordinates x y. - Can be used for placing - subtitles/OSD in the - resulting black bands. - (default: original w/h, - centered x/y) - parameter (de)activates OSD - rendering. (default: 0) - - flip Flips the image upside down. - - mirror Flips the image on Y axis. - - rotate[=<0-3>] Rotates and flips the image - +/\- 90 degrees. - - scale[=w:h[:c[:p]]] Scales the image with the - software scaler (slow) and - performs a YUV<\->RGB - colorspace conversion - (see \-sws option too!). - The value 0 is used for - scaled (aspect) destination - w/h. - (default: original w/h, - destination w/h with \-zoom) - Optionaly chroma skipping - (c from 0\-3) and scaling - parameters can be specified. - (see the \-sws option for - details) - - yuy2 Forces software YV12/I420 to - YUY2 conversion. - - rgb2bgr[=swap] RGB 24/32 <\-> BGR 24/32 - colorspace conversion with - optional R <\-> B swapping. - - palette RGB/BGR 8 \-> 15/16/24/32bpp - colorspace conversion using - palette. - - format[=fourcc] Restricts the colorspace for - next filter. It does not do - any conversion! Use the - scale filter for a real - conversion. - - pp[=flags] Activates the internal - postprocessing filter. - (see \-pp option for details) - - lavc[=quality:fps] Realtime MPEG1 encoder for - use with DVB/DXR3 - (libavcodec) - - fame Realtime MPEG1 encoder for - use with DVB/DXR3 (libfame) - - dvbscale[=aspect] Set up optimal scaling for - DVB cards. - (aspect= - DVB_HEIGHT*ASPECTRATIO) - - cropdetect[=0-255] Calculates necessary - cropping parameters and - prints the recommended - parameters to stdout. - The threshold can be - optionally - specified from nothing (0) - to everything (255). - (default: 24) - - noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]] - Adds noise - <0-100> luma noise - <0-100> chroma noise - u uniform noise - t temporal noise - a averaged - temporal noise - h high quality - p mix with pattern - - eq[=bright:cont] Activates the software - equalizer with interactive - controls like the hardware - eq controls. - The values can be from -100 - to 100. - - halfpack Convert planar YUV 4:2:0 - to half-height packed 4:2:2, - downsampling luma but keeping - all chroma samples. Useful - for output to low-resolution - display devices when hardware - downscaling is poor quality - or is not available. - -.I NOTE: -The parameters are optional and if omitted, some of them are set to default values. -Use -1 to keep the default value. - -You can get the list of available plugins executing -.I mplayer \-vop help -.TP -.B \-x (MPLAYER only) -Scale image to x width (if sw/hw scaling available). Disables aspect calcs. -.TP -.B \-xvidopts