[MPlayer-dev-eng] [PATCH] Another DOCS patch
Andras Mohari
mayday at varoshaza.nagyatad.hu
Wed Aug 21 11:16:08 CEST 2002
Hi,
I'm not sure if you'll like this, but here it is anyway (:-)):
* Moved some short "Overview" sections into their empty parents and
renumbered the sections after them. The moved sections are:
1.1 Overview
2.4.1 Overview
2.5.1 Overview
2.6.1 Overview
Fixed references, too (actually, I've found only one).
Hopefully I haven't broken anything.
* Removed "2.4.3 Summary" from the TOC (there is no such section in
encoding.html).
* Removed "0." before "How to read this documentation". (0 as a section
number? I think it's OK to leave it unnumbered.)
* Synced some titles with the TOC.
* Fixed some <> errors.
And a question: what exactly does the rgb2bgr filter do? Maybe it's
just me, but I don't understand the DOCS clearly:
Performs RGB 24/32 <-> BGR 24/32 colorspace conversion (default
behavior) or RGB 24/32 <-> RGB 24/32 conversion with R <-> B
swapping (with the 'swap' option).
To me, both means the same: R<->B swapping. If I knew it better, I'd
replace those <-> with something else (or I'd write an other short
description).
--
Andras Mohari
mayday at mail.nagyatad.hu
-------------- next part --------------
diff -Naur DOCS.old/documentation.html DOCS/documentation.html
--- DOCS.old/documentation.html Wed Aug 21 09:22:01 2002
+++ DOCS/documentation.html Wed Aug 21 10:34:51 2002
@@ -29,15 +29,14 @@
<HR>
<UL>
- <LI><A HREF="#reading">0. How to read this documentation</A></LI>
+ <LI><A HREF="#reading">How to read this documentation</A></LI>
<LI><A HREF="#introduction">1. Introduction</A>
<UL>
- <LI><A HREF="#overview">1.1 Overview</A></LI>
- <LI><A HREF="#history">1.2 History</A></LI>
- <LI><A HREF="#installation">1.3 Installation</A></LI>
- <LI><A HREF="#gui">1.4 What about the GUI?</A></LI>
- <LI><A HREF="#subtitles_osd">1.5 Subtitles and OSD</A></LI>
- <LI><A HREF="#rtc">1.6 RTC</A></LI>
+ <LI><A HREF="#history">1.1 History</A></LI>
+ <LI><A HREF="#installation">1.2 Installation</A></LI>
+ <LI><A HREF="#gui">1.3 What about the GUI?</A></LI>
+ <LI><A HREF="#subtitles_osd">1.4 Subtitles and OSD</A></LI>
+ <LI><A HREF="#rtc">1.5 RTC</A></LI>
</UL>
</LI>
<LI><A HREF="#features">2. Features</A>
@@ -177,50 +176,46 @@
</LI>
<LI><A HREF="encoding.html">2.4 Encoding with MEncoder</A>
<UL>
- <LI><A HREF="encoding.html#overview">2.4.1 Overview</A></LI>
- <LI><A HREF="encoding.html#compilation">2.4.2 Compilation</A></LI>
- <LI><A HREF="encoding.html#features">2.4.3 MEncoder Features</A>
+ <LI><A HREF="encoding.html#compilation">2.4.1 Compilation</A></LI>
+ <LI><A HREF="encoding.html#features">2.4.2 MEncoder Features</A>
<UL>
- <LI><A HREF="encoding.html#summary">2.4.3 Summary</A></LI>
- <LI><A HREF="encoding.html#2pass">2.4.3.1 Encoding 2 or 3-pass DivX4</A></LI>
- <LI><A HREF="encoding.html#rescaling">2.4.3.2 Rescaling movies</A></LI>
- <LI><A HREF="encoding.html#copying">2.4.3.3 Stream copying</A></LI>
- <LI><A HREF="encoding.html#fixing">2.4.3.4 Fixing AVIs with broken index</A></LI>
- <LI><A HREF="encoding.html#libavcodec">2.4.3.5 Encoding with the libavcodec codec family</A></LI>
- <LI><A HREF="encoding.html#image_files">2.4.3.6 Encoding from multiple input image files (JPEGs or PNGs)</A></LI>
- <LI><A HREF="encoding.html#vobsub">2.4.3.7 Extracting DVD subtitles to Vobsub file</A></LI>
+ <LI><A HREF="encoding.html#2pass">2.4.2.1 Encoding 2 or 3-pass DivX4</A></LI>
+ <LI><A HREF="encoding.html#rescaling">2.4.2.2 Rescaling movies</A></LI>
+ <LI><A HREF="encoding.html#copying">2.4.2.3 Stream copying</A></LI>
+ <LI><A HREF="encoding.html#fixing">2.4.2.4 Fixing AVIs with broken index</A></LI>
+ <LI><A HREF="encoding.html#libavcodec">2.4.2.5 Encoding with the libavcodec codec family</A></LI>
+ <LI><A HREF="encoding.html#image_files">2.4.2.6 Encoding from multiple input image files (JPEGs or PNGs)</A></LI>
+ <LI><A HREF="encoding.html#vobsub">2.4.2.7 Extracting DVD subtitles to Vobsub file</A></LI>
</UL>
</LI>
- <LI><A HREF="encoding.html#options">2.4.4 Available options</A></LI>
+ <LI><A HREF="encoding.html#options">2.4.3 Available options</A></LI>
</UL>
</LI>
<LI><A HREF="#tv">2.5 TV input</A>
<UL>
- <LI><A HREF="#tv_overview">2.5.1 Overview</A></LI>
- <LI><A HREF="#tv_compilation">2.5.2 Compilation</A></LI>
- <LI><A HREF="#tv_options">2.5.3 Available options</A></LI>
- <LI><A HREF="#tv_keyboard">2.5.4 Keyboard control</A></LI>
- <LI><A HREF="#tv_examples">2.5.5 Examples</A></LI>
+ <LI><A HREF="#tv_compilation">2.5.1 Compilation</A></LI>
+ <LI><A HREF="#tv_options">2.5.2 Available options</A></LI>
+ <LI><A HREF="#tv_keyboard">2.5.3 Keyboard control</A></LI>
+ <LI><A HREF="#tv_examples">2.5.4 Examples</A></LI>
</UL>
</LI>
<LI><A HREF="#filters">2.6 Video filters</A>
<UL>
- <LI><A HREF="#filters_overview">2.6.1 Overview</A></LI>
- <LI><A HREF="#filters_usage">2.6.2 Usage</A></LI>
- <LI><A HREF="#filters_crop">2.6.3 Crop</A></LI>
- <LI><A HREF="#filters_expand">2.6.4 Expand</A></LI>
- <LI><A HREF="#filters_fame">2.6.5 Fame/Lavc</A></LI>
- <LI><A HREF="#filters_flip">2.6.6 Flip</A></LI>
- <LI><A HREF="#filters_format">2.6.7 Format</A></LI>
- <LI><A HREF="#filters_postprocess">2.6.8 Postprocess</A></LI>
- <LI><A HREF="#filters_rgb2bgr">2.6.9 RGB2BGR</A></LI>
- <LI><A HREF="#filters_rotate">2.6.10 Rotate</A></LI>
- <LI><A HREF="#filters_scale">2.6.11 Scale</A></LI>
- <LI><A HREF="#filters_yuy2">2.6.12 YUY2</A></LI>
- <LI><A HREF="#filters_mirror">2.6.13 Mirror</A></LI>
- <LI><A HREF="#filters_dvbscale">2.6.14 DVBscale</A></LI>
- <LI><A HREF="#filters_cropdetect">2.6.15 Cropdetect</A></LI>
- <LI><A HREF="#filters_rectangle">2.6.16 Rectangle</A></LI>
+ <LI><A HREF="#filters_usage">2.6.1 Usage</A></LI>
+ <LI><A HREF="#filters_crop">2.6.2 Crop</A></LI>
+ <LI><A HREF="#filters_expand">2.6.3 Expand</A></LI>
+ <LI><A HREF="#filters_fame">2.6.4 Fame/Lavc</A></LI>
+ <LI><A HREF="#filters_flip">2.6.5 Flip</A></LI>
+ <LI><A HREF="#filters_format">2.6.6 Format</A></LI>
+ <LI><A HREF="#filters_postprocess">2.6.7 Postprocess</A></LI>
+ <LI><A HREF="#filters_rgb2bgr">2.6.8 RGB2BGR</A></LI>
+ <LI><A HREF="#filters_rotate">2.6.9 Rotate</A></LI>
+ <LI><A HREF="#filters_scale">2.6.10 Scale</A></LI>
+ <LI><A HREF="#filters_yuy2">2.6.11 YUY2</A></LI>
+ <LI><A HREF="#filters_mirror">2.6.12 Mirror</A></LI>
+ <LI><A HREF="#filters_dvbscale">2.6.13 DVBscale</A></LI>
+ <LI><A HREF="#filters_cropdetect">2.6.14 Cropdetect</A></LI>
+ <LI><A HREF="#filters_rectangle">2.6.15 Rectangle</A></LI>
</UL>
</LI>
</UL>
@@ -303,7 +298,7 @@
-<H1><A NAME="reading">0. How to read this documentation</A></H1>
+<H1><A NAME="reading">How to read this documentation</A></H1>
<P>If you are a first-time installer: be sure to read everything from here to
the end of the Installation section, and follow the links you will find. If
@@ -337,8 +332,6 @@
<H1><A NAME="introduction">1. Introduction</A></H1>
-<H2><A NAME="overview">1.1 Overview</A></H2>
-
<P><B>MPlayer</B> is a movie player for LINUX (runs on many other Unices, and
<B>non-x86</B> CPUs, see the <A HREF="#ports">ports section</A>). It plays most
MPEG, VOB, AVI, OGG, VIVO, ASF/WMV, QT/MOV, FLI, RM, NuppelVideo, yuv4mpeg,
@@ -370,7 +363,7 @@
but the speed is also amazing.</P>
-<H2><A NAME="history">1.2 History</A></H2>
+<H2><A NAME="history">1.1 History</A></H2>
<P>This began a year ago...
I (A'rpi) have tried lots of players under linux (mtv,xmps,dvdview,livid/oms,videolan,
@@ -419,7 +412,7 @@
</UL>
-<H2><A NAME="installation">1.3 Installation</A></H2>
+<H2><A NAME="installation">1.2 Installation</A></H2>
<P>In this chapter I'll try to guide you through the compiling and
configuring process of <B>MPlayer</B>. It's not easy, but it won't necessarily
@@ -713,8 +706,8 @@
<P>Though not mandatory, the fonts should be installed in order to gain OSD,
and subtitle functionality. Download <CODE>mp-arial-iso-8859-*.zip</CODE>
- and/or optional (if exists) language updates. It's VERY RECOMMENDED to check
- section <A HREF="#subtitles_osd">1.5</A> for details.</P>
+ and/or optional (if exists) language updates. See the
+ <A HREF="#subtitles_osd">Subtitles and OSD</A> section for details.</P>
<PRE>
mkdir ~/.mplayer/font
@@ -724,7 +717,7 @@
</PRE>
-<H2><A NAME="gui">1.4 What about the GUI?</A></H2>
+<H2><A NAME="gui">1.3 What about the GUI?</A></H2>
<P>The GUI needs GTK (it isn't GTK, but the panels are). The skins are stored
in PNG format, so gtk, libpng (and their devel stuff) has to be installed.
@@ -754,7 +747,7 @@
file directive to use the skin in <CODE>*/Skin/newskin</CODE> directory.</P>
-<H2><A NAME="subtitles_osd">1.5 Subtitles and OSD</A></H2>
+<H2><A NAME="subtitles_osd">1.4 Subtitles and OSD</A></H2>
<P>
<B>MPlayer</B> can display subtitles along with movie files. Currently the following
@@ -889,7 +882,7 @@
in config file.</P>
-<H2><A NAME="rtc">1.6 RTC</A></H2>
+<H2><A NAME="rtc">1.5 RTC</A></H2>
There are three timing methods in <B>MPlayer</B>.
@@ -956,8 +949,6 @@
<H2><A NAME="tv"><B>2.5 TV input</B></A></H2>
-<H3><A NAME="tv_overview">2.5.1 Overview</A></H3>
-
<P>This section is about how to enable <B>watching/grabbing from V4L compatible
TV tuner</B>.</P>
@@ -965,7 +956,7 @@
without tweaking/experimenting!</B></P>
-<H3><A NAME="tv_compilation">2.5.2 Compilation</A></H3>
+<H3><A NAME="tv_compilation">2.5.1 Compilation</A></H3>
<UL>
<LI>First, you have to recompile. <CODE>./configure</CODE> will autodetect
@@ -982,7 +973,7 @@
You can specify these with the <CODE>outfmt=YV12</CODE> option, see below.</P>
-<H3><A NAME="tv_options">2.5.3 Available options</A></H3>
+<H3><A NAME="tv_options">2.5.2 Available options</A></H3>
<TABLE BORDER=0>
<TR>
@@ -1068,7 +1059,7 @@
</TABLE>
-<H3><A NAME="tv_keyboard">2.5.4 Keyboard control</A></H3>
+<H3><A NAME="tv_keyboard">2.5.3 Keyboard control</A></H3>
<TABLE BORDER=0>
<TR><TD> </TD><TD>h / k</TD><TD> </TD><TD>select previous/next channel</TD></TR>
@@ -1077,7 +1068,7 @@
</TABLE>
-<H3><A NAME="tv_examples">2.5.5 Examples</A></H3>
+<H3><A NAME="tv_examples">2.5.4 Examples</A></H3>
<P>Dummy output, to AAlib :)<BR>
<CODE> mplayer -tv on:driver=dummy:width=640:height=480 -vo aa</CODE><BR>
@@ -1092,10 +1083,8 @@
<CODE> mplayer -tv on:noaudio:driver=v4l:width=640:height=480:outfmt=i420 -vc rawi420 -vo xv</CODE></P>
-<H2><A NAME="filters">2.6 filters</A></H2>
-
+<H2><A NAME="filters">2.6 Video filters</A></H2>
-<H3><A NAME="filters_overview">2.6.1 Overview</A></H3>
<P>Both <B>MPlayer</B> and <B>MEncoder</B> support using a universal
video filter layer, which comprises numerous plugins that are listed and
@@ -1116,7 +1105,7 @@
will be explained below.</P>
-<H3><A NAME="filters_usage">2.6.2 Usage</A></H3>
+<H3><A NAME="filters_usage">2.6.1 Usage</A></H3>
<P><CODE> mplayer/mencoder -vop filter1,filter2,filter3,...</CODE>
</P>
@@ -1136,7 +1125,7 @@
<P> <CODE>mplayer -vop help</CODE></P>
-<H3><A NAME="filters_crop">2.6.3 Crop</A></H3>
+<H3><A NAME="filters_crop">2.6.2 Crop</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1148,7 +1137,7 @@
<P><CODE> -vop crop[=width:height:x:y]</CODE></P>
-<H3><A NAME="filters_expand">2.6.4 Expand</A></H3>
+<H3><A NAME="filters_expand">2.6.3 Expand</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1162,7 +1151,7 @@
<P><CODE> -vop expand[=width:height:x:y]</CODE></P>
-<H3><A NAME="filters_fame">2.6.5 Fame/Lavc</A></H3>
+<H3><A NAME="filters_fame">2.6.4 Fame/Lavc</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1176,7 +1165,7 @@
<P><CODE> -vop lavc</CODE></P>
-<H3><A NAME="filters_flip">2.6.6 Flip</A></H3>
+<H3><A NAME="filters_flip">2.6.5 Flip</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1188,7 +1177,7 @@
<P><CODE> -vop flip</CODE></P>
-<H3><A NAME="filters_format">2.6.7 Format</A></H3>
+<H3><A NAME="filters_format">2.6.6 Format</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1202,7 +1191,7 @@
<CODE>format</CODE> can be for example: rgb32, yuy2, etc...)</P>
-<H3><A NAME="filters_postprocess">2.6.8 Postprocess</A></H3>
+<H3><A NAME="filters_postprocess">2.6.7 Postprocess</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1215,12 +1204,12 @@
<P><CODE> -vop pp[=postprocess options/keywords]</CODE></P>
-<H3><A NAME="filters_rgb2bgr">2.6.9 RGB2BGR</A></H3>
+<H3><A NAME="filters_rgb2bgr">2.6.8 RGB2BGR</A></H3>
<P><B><U>Description</U></B>:</P>
-<P>Performs RGB 24/32 <-> BGR 24/32 colorspace conversion (default behavior)
- or RGB 24/32 <-> RGB 24/32 conversion with R<->B swapping (with the 'swap'
+<P>Performs RGB 24/32 <-> BGR 24/32 colorspace conversion (default behavior)
+ or RGB 24/32 <-> RGB 24/32 conversion with R <-> B swapping (with the 'swap'
option).</P>
<P><B><U>Usage</U></B>:</P>
@@ -1228,7 +1217,7 @@
<P><CODE> -vop rgb2bgr[=swap]</CODE></P>
-<H3><A NAME="filters_rotate">2.6.10 Rotate</A></H3>
+<H3><A NAME="filters_rotate">2.6.9 Rotate</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1240,7 +1229,7 @@
<P><CODE> -vop rotate[=x]</CODE></P>
-<H3><A NAME="filters_scale">2.6.11 Scale</A></H3>
+<H3><A NAME="filters_scale">2.6.10 Scale</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1259,7 +1248,7 @@
<P><CODE> -vop scale[=width:height]</CODE></P>
-<H3><A NAME="filters_yuy2">2.6.12 YUY2</A></H3>
+<H3><A NAME="filters_yuy2">2.6.11 YUY2</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1270,7 +1259,7 @@
<P><CODE> -vop yuy2</CODE></P>
-<H3><A NAME="filters_mirror">2.6.13 Mirror</A></H3>
+<H3><A NAME="filters_mirror">2.6.12 Mirror</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1281,7 +1270,7 @@
<P><CODE> -vop mirror</CODE></P>
-<H3><A NAME="filters_dvbscale">2.6.14 DVBscale</A></H3>
+<H3><A NAME="filters_dvbscale">2.6.13 DVBscale</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1292,7 +1281,7 @@
<P><CODE> -vop dvbscale</CODE></P>
-<H3><A NAME="filters_cropdetect">2.6.15 Cropdetect</A></H3>
+<H3><A NAME="filters_cropdetect">2.6.14 Cropdetect</A></H3>
<P><B><U>Description</U></B>:</P>
@@ -1307,7 +1296,7 @@
<P><CODE> -vop cropdetect[=limit]</CODE></P>
-<H3>><A NAME="filters_rectangle">2.6.16 Rectangle</A></H3>
+<H3><A NAME="filters_rectangle">2.6.15 Rectangle</A></H3>
<P><B><U>Description</U></B>:</P>
diff -Naur DOCS.old/encoding.html DOCS/encoding.html
--- DOCS.old/encoding.html Wed Aug 21 09:22:02 2002
+++ DOCS/encoding.html Wed Aug 21 10:31:38 2002
@@ -10,11 +10,9 @@
<BODY>
-<<H2>><A NAME="encoding">2.4 Encoding with MEncoder</A></<H2>>
+<H2><A NAME="encoding">2.4 Encoding with MEncoder</A></H2>
-<H3><A NAME="overview">2.4.1 Overview</A></H3>
-
<P><B>MEncoder</B> (<B>MPlayer</B>'s Movie Encoder) is a simple movie encoder,
designed to encode MPlayer-playable movies
(<B>AVI/ASF/OGG/DVD/VCD/VOB/MPG/MOV/VIV/FLI/RM/NUV/NET</B>) to other
@@ -24,7 +22,7 @@
for video manipulation.</P>
-<H3><A NAME="compilation">2.4.2 Compilation</A></H3>
+<H3><A NAME="compilation">2.4.1 Compilation</A></H3>
<UL>
<LI><B>OPTIONAL</B> - read <B>MPlayer</B>'s compilation instruction.</LI>
@@ -58,7 +56,7 @@
<I>avifile</I> library installed. <B>MEncoder</B> doesn't need it at all.</P>
-<H3><A NAME="features">2.4.3 MEncoder features</A></H3>
+<H3><A NAME="features">2.4.2 MEncoder features</A></H3>
<UL>
<LI>encoding from the wide range of fileformats and decoders of <B>MPlayer</B></LI>
@@ -91,7 +89,7 @@
</UL>
-<H4><A NAME="2pass">2.4.3.1 Encoding 2 or 3-pass DivX4</A></H4>
+<H4><A NAME="2pass">2.4.2.1 Encoding 2 or 3-pass DivX4</A></H4>
<P><U><B>2-pass encoding:</B></U> the name comes from the fact that this method
encodes the file <I>twice</I>. The first encoding (dubbed <I>pass</I>)
@@ -182,7 +180,7 @@
</UL>
-<H4><A NAME="rescaling">2.4.3.2 Rescaling movies</A></H4>
+<H4><A NAME="rescaling">2.4.2.2 Rescaling movies</A></H4>
<P>Often the need to resize movie images' size emerges. Its reasons can be many,
examples are decreasing output file size, encoding SVCDs to DivX. Ripped DVDs
@@ -204,7 +202,7 @@
output.avi</CODE></P>
-<H4><A NAME="copying">2.4.3.3 Stream copying</A></H4>
+<H4><A NAME="copying">2.4.2.3 Stream copying</A></H4>
<P><B>MEncoder</B> can handle input streams in two ways: <B>encode</B> or
<B>copy</B> them. This section is about <B>copying</B>.</P>
@@ -225,7 +223,7 @@
</UL>
-<H4><A NAME="fixing">2.4.3.4 Fixing AVIs with broken index or interleaving</A></H4>
+<H4><A NAME="fixing">2.4.2.4 Fixing AVIs with broken index or interleaving</A></H4>
<P>Easiest thing. We simply copy the video and audio streams, and
<B>MEncoder</B> generates the index. Of course this cannot fix possible bugs
@@ -236,7 +234,7 @@
<P>Command: <CODE>mencoder -idx input.avi -ovc copy -oac copy -o output.avi</CODE></P>
-<H4><A NAME="libavcodec">2.4.3.5 Encoding with the libavcodec codec family</A></H4>
+<H4><A NAME="libavcodec">2.4.2.5 Encoding with the libavcodec codec family</A></H4>
<P><A HREF="codecs.html#libavcodec">libavcodec</A> provides simple encoding to a
lot of interesting video and audio formats (currently its audio codecs are
@@ -261,7 +259,7 @@
-lavcopts vcodec=mjpeg</CODE></P>
-<H4><A NAME="image_files">2.4.3.6 Encoding from multiple input image files (JPEGs or PNGs)</A></H4>
+<H4><A NAME="image_files">2.4.2.6 Encoding from multiple input image files (JPEGs or PNGs)</A></H4>
<P><B>MEncoder</B> is capable of creating movies from one or more JPEG or PNG
files. With simple framecopy it can create MJPEG (Motion JPEG) or MPNG
@@ -303,7 +301,7 @@
-o output.avi</CODE></P>
-<H4><A NAME="vobsub">2.4.3.7 Extracting DVD subtitles to Vobsub file</A></H4>
+<H4><A NAME="vobsub">2.4.2.7 Extracting DVD subtitles to Vobsub file</A></H4>
<P><B>MEncoder</B> is capable of extracting subtitles from a DVD into
Vobsub fomat files. They consist of a pair of files ending in
@@ -344,7 +342,7 @@
-vobsuboutindex 0 -vobsuboutid fr -sid 1</CODE></P>
-<H3><A NAME="options">2.4.4 Options</A></H3>
+<H3><A NAME="options">2.4.3 Available options</A></H3>
<P>For the complete list of available <B>MEncoder</B> options and examples, please
see the man page.</P>
More information about the MPlayer-dev-eng
mailing list