[MPlayer-dev-eng] [PATCH] man page: Where do you want to go tommorow?

Jonas Jermann jjermann at gmx.net
Tue Aug 27 17:06:58 CEST 2002


Hi

Actually this isn't a useable patch yet as there are questions to
be answered first...

Changes:

more detailed vop description, added rtsp, aid changes (?), 
added user option, removed -gui option, added two examples,
changes to FILES section


Questions:

1. eq intensity
I don't know much about *_intensity, but I didn't find them in 
cfg* and now I'm not sure if they exist at all and if the range
really is from -1000 to 1000 (from manpage/html docs) and not
from -100 to 100. Also I couldn't set eq settings to -vo xmga
with mplayer (I had to use the device to change them) and they
went from  -128 to 128. IMHO it's a big a mess and nobody is 
sure if eq setting xy is supported for his vo/card...

2. config files
I'm not sure anymore where the system-wide config file is 
stored. Is it /etc/mplayer.conf /etc/mplayer/mplayer.conf 
/usr/local/share/mplayer/mplayer.conf or does it depend on 
configuration?

3. aid range
Can someone tell me about aid range? I'm absolutely unsure about 
it. From patch:
    MPG/RM/OGG: 0-31 AVI: 1-99 ASF: 0-127 VOB: 128-159 PCM: 160-191
Is it AC3+PCM, VOB+PCM, just VOB and could those values be 
correct (I got them from some source files, it was ac3 instead 
of vob there)?
Is OGG/RM like MPG, like AVI or completely different?
I tested 2 OGM samples (was 1 and 1,2) but someone told me it 
probably was 0, donno... Maybe OGM instead of OGG would be 
better too...
I included the changes because a user requested it.


Ideas:

1. man page, html docs, tech docs
IMHO (and some others) docs should be sthg like this:
    syntax/option descriptions -> man page
    practical use, guides, installation, etc -> html docs
    tech/detailed docs -> tech/* -> simplified in manpage
I therefore thought that many documentation sections should be 
moved to the manpage: from 2.5 (tv input), over 2.6 (vop 
filters), till end of 3 (controls) and more.  It's also easier 
to maintain the docs this way. IMHO, the html docs should more 
be like an accumulation of guides, donno...  Diego?

2. examples/syntax
I'm not sure at all, what to do with all the examples (see 1. 
idea). Examples are very important for users. They can be:
    - beside the described option in the manpage
    - at the end of manpage (that's best choice and very 
      practical IMHO)
    - in the html docs (see syntax description of vcd too...)
You can't move everything to the manpage as some things really 
are related to the documentation (dvb for example) and the list 
is already quite long (but this doesn't disturb much IMHO).
Another idea was to structure the EXAMPLES section at the end
into dvd/encoding/etc...

3. What about a more detailed TODO/IDEAS?
IMHO more things would be done by users/ppl if they were 
written down in a TODO (other: section for example ;).
Often someone get the answer "not implemented" or
"it's planned". It would give more transparency.
But actually it's much better nowadays :) donno... 
(I'm still searching for a good site which compares all
important movie players)

4. messages
For me it just looks a bit messy: -quiet, -v (-v), normal 
output, &>/dev/null </dev/null, etc... -quiet should at least 
produce zero output IMHO, now it showed all pp changes with divx4 
(autoq)! -> filled my terminal with messages...
Nick's colored output looks good too IMHO, it's also easier to 
read the important informations, especially for new users...

5. TODO/some ideas (see 3.)
sw hue,saturation,intensity eq filter?
Write down patch rule to separate cosmetics/spellcheck and real
  changes, for general syntax changes: Write down procedure 
  ('>' -> '&gt;').
Apply Nick's vidix/mplayerxp changes?
'-vo fbdev:device' instead of -vo fbdev -fb device?
'-dvd 9-12' command line possible? (like chapters)
pre7 today? ;)


Damn, I wanted to write a one line mail, now I've got over 50. 
After writing such ideas I always think: "Argl, what the heck 
did I just write" but leave it all the same. Sorry!

Regards
    Jonas
-------------- next part --------------
--- mplayer.1	2002-08-27 15:29:41.000000000 +0200
+++ mplayer.1	2002-08-27 15:43:45.000000000 +0200
@@ -2,7 +2,7 @@
 .\" This man page was/is done by Gabucino <sendmail at to.mplayer-users>
 .\" (Patches done by Jonas Jermann <sendmail at to.mplayer-users>)
 .\" 
-.TH "MPlayer" "1" "2002-06-24"
+.TH "MPlayer" "1" "2002-08-27"
 
 .SH "NAME"
 mplayer  \- Movie Player for Linux
@@ -23,7 +23,7 @@
 .RB [dvd|vcd|cdda|cddb|tv]://[title]\ [options]
 .br
 .B mplayer
-.RB [mms|mmst|http|http_proxy|rtp]://[user:pass@]URL[:port]\ [options]
+.RB [mms|mmst|http|http_proxy|rtp|rtsp]://[user:passwd@]URL[:port]\ [options]
 .br
 .B mencoder
 .RB [options]\ [\fIfile\fP\ |\ \fIURL\fP\ |\ \-\ ]\ [\-o\ file]
@@ -94,7 +94,7 @@
 .SH "DEMUXER/STREAM OPTIONS"
 .TP
 .B \-aid <id> (also see \-alang option)
-Select audio channel [MPG: 0\-31 AVI: 1\-99 ASF: 0\-127 VOB: 128\-...]
+Select audio channel [MPG/RM/OGG: 0\-31 AVI: 1\-99 ASF: 0\-127 VOB: 128\-159 PCM: 160\-191]
 .TP
 .B \-alang <two letter\ country\ code> (also see \-aid option)
 Works only for DVD playback! Selects DVD audio language. It always tries
@@ -317,7 +317,7 @@
     audioid=<value>   choose an audio output
                       of the capture card, if it
                       has more of them
-.TP
+
 .I NOTE:
 Mplayer doesn't accept colons so type dots instead in the device ID,
 eg. hw.0,0 instead of hw:0,0)
@@ -327,6 +327,9 @@
 You'll get an .avi file with no sound when you choose an odd
 samplerate and use this codec.
 .TP
+.B \-user <user name> (see \-passwd option too!)
+Specify user name for http authentication.
+.TP
 .B \-vcd <track>
 Play video CD track from device instead of plain file.
 .TP
@@ -526,31 +529,89 @@
 between them and when to use which, check the DivX4 section in the
 documentation.
 .TP
-.B \-vop <plugin3[=options],plugin2,plugin1,...>
-Activate comma separated list of video filters (see documentation).
+.B \-vop <...,plugin3[=options],plugin2,plugin1>
+Activate a comma separated list of video filters.
 Available plugins are:
 
-  crop[=w:h:x:y]       cropping
-  rectangle[=w:h:x:y]  shows cropping boundaries
-  expand[=w:h:x:y:o]   expanding and OSD
-  flip                 vertical mirroring
-  mirror               horizontal mirroring
-  rotate[=<0-3>]       rotate image +- 90 degrees
-  scale[=w:h]          software scaling
-  yuy2                 YV12/I420 \-> YUY2
+  crop[=w:h:x:y]       Crops the given part of the
+                       image and discards the rest.
+                       Useful for removing black
+                       bands from widescreen movies.
+
+  rectangle[=w:h:x:y]  Draws a white rectangle of the
+                       requested width and height at
+                       the designated 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)
+                       
+  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
-  format[=fourcc]      restrict colorspace
-  pp[=flags]           postprocessing (see \-pp)
-  lavc[=quality:fps]   YV12\->MPEG1 (libavcodec)
-  fame                 YV12\->MPEG1 (libfame)
-  dvbscale[=aspect]    optimal scaling for DVB
-                       cards (aspect=
-                       DVB_HEIGHT*ASPECTRATIO)
-  cropdetect[=limit]   black border detection
-                       (print crop values)
-  noise[=luma[u][t|a][h][p]:chroma[u][t|a][h][p]
-                       add noise
+                       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
@@ -559,26 +620,19 @@
                                   temporal noise
                          h        high quality
                          p        mix with pattern
-  eq[=bright:cont]     soft equalizer w/interactive
-                       controls like hardware eq
 
-.I parameters:
-.br
-    w,h  destination width/height
-           value   w/h = value
-           \-1      w/h = original (default)
-           0       w/h = scaled (aspect) w/h
-           \-value  w/h = original+value
-    x,y  x/y position of the subimage
-           value   x/y = value
-           \-1      x/y = center image (default)
-    o    enable/disable OSD/SUB rendering
-           0       disabled (default)
-           1       enabled
+  eq[=bright:cont]     Activates the software equalizer
+                       with interactive controls like
+                       the hardware eq controls.
+                       The values can be from -100 to
+                       100.
+
+.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 <x> (MPLAYER only)
 Scale image to x width (if sw/hw scaling available). Disables aspect calcs.
@@ -974,9 +1028,6 @@
 Frame dropping: decode all (except B) frames, video may skip.
 Useful for playback on slow VGA card/bus.
 .TP
-.B \-gui (BETA CODE)
-Start MPlayer in GUI mode.
-.TP
 .B \-h, \-\-help
 Show short summary of options.
 .TP
@@ -1556,7 +1607,7 @@
 
 .SH FILES
 .TP
-/etc/mplayer.conf
+/etc/mplayer/mplayer.conf
 system\-wide settings
 .TP
 ~/.mplayer/config
@@ -1565,6 +1616,12 @@
 ~/.mplayer/input.conf
 input bindings (see '\-input keylist' for full keylist)
 .TP
+~/.mplayer/gui.conf
+GUI configuration file
+.TP
+~/.mplayer/gui.pl
+GUI playlist
+.TP
 ~/.mplayer/font/
 font directory (There must be a font.desc file and files with .RAW extension.)
 .TP
@@ -1586,6 +1643,9 @@
 .B Quickstart DVD playing
 mplayer \-dvd 1
 .TP
+.B Play in japanese with english subtitles
+mplayer \-dvd 1 \-alang ja \-slang en 
+.TP
 .B Play only chapters 5, 6, 7
 mplayer \-dvd 1 \-chapter 5\-7
 .TP
@@ -1619,6 +1679,9 @@
 .B The same, but with libavcodec family, MPEG4 (Divx5) compression
 mencoder -dvd 2 -o title2.avi -ovc lavc -lavcopts vcodec=mpeg4:vhq:vbitrate=1800 -oac copy
 .TP
+.B The same, but with libavcodec family, MJPEG compression
+mencoder -dvd 2 -o titel2.avi -ovc lavc -lavcopts vcodec=mjpeg:vhq:vbitrate=1800 -ffourcc mjpg -oac copy
+.TP
 .B Encoding all *.jpg files in the current dir
 mencoder \\*.jpg -mf on:fps=25 -o output.avi -ovc divx4
 .TP


More information about the MPlayer-dev-eng mailing list