diff DOCS/documentation.html @ 1714:b42b78566029

*** empty log message ***

--- a/DOCS/documentation.html	Mon Aug 27 15:25:11 2001 +0000
+++ b/DOCS/documentation.html	Mon Aug 27 16:34:31 2001 +0000
@@ -18,6 +18,7 @@
      <LI><A HREF="#1.2">1.2 History</A></LI>
      <LI><A HREF="#1.3">1.3 Installation</A></LI>
      <LI><A HREF="#1.4">1.4 What about the GUI?</A>
+     <LI><A HREF="#1.5">1.5 Subtitles and OSD</A>
      </LI></UL>
 </LI><LI><A HREF="#2">2. Features</A>
      <UL><LI><A HREF="codecs.html">2.1 Video Formats, Audio & Video Codecs</A>
@@ -94,6 +95,7 @@
      </LI><LI><A HREF="#6.4">6.4 StrongARM</A>
      </LI></UL>
 </LI><LI><A HREF="#A">A. Authors</A>
+</LI><UL><LI><A HREF="#A2">A/2. Maintainers</A></LI></UL>
 </LI><LI><A HREF="#B">B. Mailing lists</A>
 </LI><LI><A HREF="bugreports.html">C. How to report bugs</A>
 
@@ -213,6 +215,58 @@
 It's still under development, but it will be merged and released real soon.
 BTW he needs some nice skins, if you are a good graphician, contact him!!!</P>
 
+<P><B><A NAME=1.5>1.5. Subtitles and OSD</A></B></P>
+
+<P>Yes, <B>MPlayer</B> also supports many kinds of subtitles. Currently
+7 kinds of subtitle can be used by the subreader code. To see what are
+these subtitle formats, see subreader.c, line ~20.</P>
+
+<P>Subtitles are displayed with a technique called <B>'OSD', On Screen Display</B>.
+OSD is used to display current time, volume bar, seek bar etc.</P>
+
+<P><B>INSTALLING OSD and SUB</B></P>
+
+<P>You need an <B>MPlayer</B> font package to be able to use OSD/SUB feature.
+There are many ways to get it:
+<UL>
+
+<LI>use the font generator tool at TOOLS/subfont-c
+It's a complete tool to convert from TTF/Type1/etc font to mplayer font pkg.
+(read TOOLS/subfont-c/README for details)
+
+<LI>use the font generator GIMP plugin at TOOLS/subfont-GIMP
+(note: you must have HSI RAW plugin too, see URL below)
+
+<LI>download ready-to-use font packages from <B>MPlayer</B> site.
+Note: currently available fonts are limited for iso 8859-1/2 support,
+and there are a few special versions for korean, russian etc codepages.
+You better build fonts yourself with the tool mentioned above.
+Font should have appropriate font.desc file which maps unicode font
+positions to the actual code page of the subtitles text. Other solution
+is to have subtitles encoded in utf8 encoding and use -utf8 option
+or just name the subtitles file <video_name>.utf and have it in the same
+dir as the video file. Recoding from different codepages to utf8 could be
+done by using konwert (debian) or iconv (RedHat) programs.<BR>
+Some URLs:
+<UL>
+  <LI><A HREF="ftp://ftp.mplayerhq.hu/MPlayer/releases/">ftp://ftp.mplayerhq.hu/MPlayer/releases/</A> - ISO fonts, OBSOLETED!
+  <LI><A HREF="ftp://ftp.mplayerhq.hu/MPlayer/contrib/fonts/">ftp://ftp.mplayerhq.hu/MPlayer/contrib/fonts/</A> - various fonts by users
+  <LI><A HREF="http://realtime.ssu.ac.kr/~lethean/mplayer">http://realtime.ssu.ac.kr/~lethean/mplayer</A> - korean fonts & RAW plugin
+</UL>
+</P>
+<P>After that, UNZIP the files to ~/.mplayer/font/ .
+Now you have to see a clock at the upper left corner of the movie
+(switch it off with 'o') .</P>
+
+<P>OSD has 3 states: (switch with 'o')<BR>
+<UL>
+  <LI>clock + volume bar + seek bar + subtitles (default)
+  <LI>volume bar + seek bar + subtitles
+  <LI>subtitles only
+</UL>
+
+<P>You can change default behaviour by setting <CODE>osdlevel=</CODE> variable in config file.</P>
+
 <P><B><A NAME=2>2. Features</A></B></P>
 
 <P><A NAME=2.1>2.1. <A HREF="codecs.html">Video Formats, Audio & Video Codecs</A></P>
@@ -306,7 +360,7 @@
   end</PRE></P>
 
 <P>If you don't like the standard location for the lirc-config file (~/.lircrc) 
-use the -lircconf [filename] switch to specify another file.</P>
+use the -lircconf &lt;filename&gt; switch to specify another file.</P>
 
 <P><B><A NAME=3.3>3.3. Streaming from network or pipes</A></B></P>
 
@@ -465,7 +519,7 @@
 <P ALIGN=center><B><U>The <B>MPlayer</B> project:</U></B></P>
 
 <P><UL>
-<LI>Árpád Gereöffy (A'rpi/ESP-team):  [[e-mail]]
+<LI>Árpád Gereöffy (A'rpi/ESP-team):  &lt;[e-mail]&gt;
 <UL><LI>player code (mpeg stream demultiplexer and avi/asf parser, A-V sync, seek...)
 </LI><LI>mp3lib, based on mpglib sources  [MP3 audio decoder]
 </LI><LI>getch2  [keyboard handler]
@@ -480,9 +534,9 @@
 </LI><LI>DivX4Linux (ProjectMayo) support (see documentation)
 </LI></UL>
 
-</LI><LI>Zoltán Ponekker (Pontscho/Fresh!):  [[e-mail]] 
+</LI><LI>Zoltán Ponekker (Pontscho/Fresh!):  &lt;[e-mail]&gt; 
 <UL><LI>configure script and Makefiles for easy compile
-</LI><LI>GUI system (near complete!?)
+</LI><LI>GUI system
 </LI><LI>3DNow! support into mp3lib
 </LI><LI>3DNow! support into fastmemcpy.h
 </LI><LI>various X11 driver changes (keyboard handling, fullscreen, bpp detect, etc)
@@ -490,15 +544,14 @@
 </LI><LI>audio mixer (volume) support
 </LI></UL>
 
-</LI><LI>Gábor Lénárt (LGB): [[e-mail]]
+</LI><LI>Gábor Lénárt (LGB): &lt;[e-mail]&gt;
 <UL><LI>./configure script improvements
 </LI><LI>Makefile improvements
 </LI><LI>prelimenary DVD support
-</LI><LI>another GUI code (is that so..?)
 </LI><LI>various X11 cleanups and fixes
 </LI></UL>
 
-</LI><LI>Gábor Bérczi (Gabucino):  [[e-mail]]
+</LI><LI>Gábor Bérczi (Gabucino):  &lt;[e-mail]&gt;
 <UL><LI>documentation maintainer
 </LI><LI>hungarian translation of documentation
 </LI><LI>second webpage design&gfx
@@ -509,7 +562,7 @@
 </LI><LI>experimental MINIX port :)
 </LI></UL>
 
-</LI><LI>Szabolcs Berecz (Szabi): [[e-mail]]
+</LI><LI>Szabolcs Berecz (Szabi): &lt;[e-mail]&gt;
 <UL><LI>codecs.conf file parser
 </LI><LI>config file and command line parser
 </LI><LI>mga_vid fixes, module option etc.
@@ -517,31 +570,31 @@
 </LI><LI>type #7 subtitle support
 </LI></UL>
 
-</LI><LI>László Megyer (Lez, Laaz): [[e-mail]]
+</LI><LI>László Megyer (Lez, Laaz): &lt;[e-mail]&gt;
 <UL><LI>SUB reader
 </LI><LI>screensaver+DPMS disable for libvo
 </LI></UL>
 
-</LI><LI>Gyula László (Chass, Tégla): [[e-mail]]
+</LI><LI>Gyula László (Chass, Tégla): &lt;[e-mail]&gt;
 <UL><LI>first fonts (mp_font1.zip)
 </LI><LI>third (current) homepage design&gfx
 </LI></UL>
 
-</LI><LI>Zoltán Márk Vicián (Se7en): [[e-mail]]
+</LI><LI>Zoltán Márk Vicián (Se7en): &lt;[e-mail]&gt;
 <UL><LI>SVGAlib support in libvo
 </LI></UL>
 
-</LI><LI>Alex Beregszaszi (Al3x): [[e-mail]]
+</LI><LI>Alex Beregszaszi (Al3x): &lt;[e-mail]&gt;
 <UL><LI>ALSA output driver in libao2
 </LI><LI>vo_ggi output driver in libvo (www.ggi-project.org)
 </LI></UL>
 
-</LI><LI>Andreas Ackermann (Acki):  [[e-mail]]
+</LI><LI>Andreas Ackermann (Acki):  &lt;[e-mail]&gt;
 <UL><LI>LIRC support (see documentation)
 </LI><LI>DGA support in libvo
 </LI></UL>
 
-</LI><LI>Felix Bünemann (Atmos): [[e-mail]]
+</LI><LI>Felix Bünemann (Atmos): &lt;[e-mail]&gt;
 <UL><LI>SDL driver maintainer
 </LI><LI>Additional YUV formats fixes
 </LI><LI>New font (mp_font2.zip)
@@ -551,54 +604,54 @@
 </LI><LI>RAW PCM/WAVE file writer for libao2
 </LI></UL>
 
-</LI><LI>TeLeNiEkO: [[e-mail]]
+</LI><LI>TeLeNiEkO: &lt;[e-mail]&gt;
 <UL><LI>spanish translation of documentation
 </LI></UL>
 
-</LI><LI>Michael Graffam: [[e-mail]]
+</LI><LI>Michael Graffam: &lt;[e-mail]&gt;
 <UL><LI>XF86VidMode support to vo_x11 and vo_dga
 </LI><LI>Video mode switching code to vo_dga
 </LI></UL>
 
-</LI><LI>Jens Hoffmann: [[e-mail]]
+</LI><LI>Jens Hoffmann: &lt;[e-mail]&gt;
 <UL><LI>Additional YUV formats support
 </LI><LI>found the big BITMAPINFOHEADER problem -> solved ASV2 pixelization
 </LI></UL>
 
-</LI><LI>Nick Kurshev: [[e-mail]]
+</LI><LI>Nick Kurshev: &lt;[e-mail]&gt;
 <UL><LI>memcpy optimizations for AMD K7 and Intel Pentium III  (fastmemcpy.h)
 </LI><LI>CDROM tune info
 </LI><LI>further 3DNow! optimizations into mp3lib and libac3 and ffmpeg
 </LI><LI>russian translation of documentation
 </LI></UL>
 
-</LI><LI>German Gomez Garcia: [[e-mail]]
+</LI><LI>German Gomez Garcia: &lt;[e-mail]&gt;
 <UL><LI>DVD .ifo parser and chapter selection [not yet in the main trunk]
 </LI><LI>SPDIF AC3 output for SBLive!
 </LI></UL>
 
-</LI><LI>Dariush Pietrzak (Eyck): [[e-mail]]
+</LI><LI>Dariush Pietrzak (Eyck): &lt;[e-mail]&gt;
 <UL><LI>debian packaging support (see debian/* and this documentation)
 </LI><LI>support for vplayer subtitle format
 </LI><LI>prelimenary support for .RT subtitle format
 </LI></UL>
 
-</LI><LI>Marcus Comstedt: [[e-mail]]
+</LI><LI>Marcus Comstedt: &lt;[e-mail]&gt;
 <UL><LI>initial solaris8-x86 support
 </LI></UL>
 
-</LI><LI>Jürgen Keil and Marcus Comstedt: [[e-mail]] [[e-mail]]
+</LI><LI>Jürgen Keil and Marcus Comstedt: &lt;[e-mail]&gt; &lt;[e-mail]&gt;
 <UL><LI>patched <B>MPlayer</B> to work on Solaris 8 x86
 </LI><LI>configure fixes
 </LI><LI>various fixes (win32, configure, etc)
 </LI><LI>SUN audio driver in libao2
 </LI></UL>
 
-</LI><LI>Vladimir Kushnir: [[e-mail]]
+</LI><LI>Vladimir Kushnir: &lt;[e-mail]&gt;
 <UL><LI>patched <B>MPlayer</B> to work on FreeBSD x86
 </LI></UL>
 
-</LI><LI>Bertrand BAUDET: [[e-mail]]
+</LI><LI>Bertrand BAUDET: &lt;[e-mail]&gt;
 <UL><LI>network streaming support
 </LI></UL>
 
@@ -610,12 +663,12 @@
 <UL><LI>GIMP font generator plugin (TOOLS/subfont-gimp)
 </LI></UL>
 
-</LI><LI>Adam Tla/lka: [[e-mail]]
+</LI><LI>Adam Tla/lka: &lt;[e-mail]&gt;
 <UL><LI>osd/sub review, fixes, optimization, utf8 support
 </LI></LI>various fixes
 </LI></UL>
 
-</LI><LI>Folke Ashberg: [[e-mail]]
+</LI><LI>Folke Ashberg: &lt;[e-mail]&gt;
 <UL><LI>native AAlib driver (-vo aa)
 </LI></UL>
 
@@ -634,32 +687,32 @@
 <P ALIGN=center><B><U>The codecs, libs:</U></B></P>
 
 <P><UL>
-<LI>Aaron Holtzman:  [[e-mail]]
+<LI>Aaron Holtzman:  &lt;[e-mail]&gt;
 <UL><LI>ac3dec (and libac3) author  [AC3 audio decoder]
 </LI><LI>mga_vid driver  [Matrox G200/G400 YUV Back-end Scaler]
 </LI><LI>mpeg2dec        [Fast MPEG1/MPEG2 video decoder, currently used in player]
 </LI></UL>
 
-</LI><LI>Michel Lespinasse:  [[e-mail]]
+</LI><LI>Michel Lespinasse:  &lt;[e-mail]&gt;
 <UL><LI>did large libmpeg2 changes for better speed and mpeg conformance
 </LI></UL>
 
-</LI><LI>Eugene Kuznetsov:  [[e-mail]]
+</LI><LI>Eugene Kuznetsov:  &lt;[e-mail]&gt;
 <UL><LI>avifile author  [AVI player library for linux, using Win32 VfW/ACM codecs]
 </LI><LI>technical help about AVI and ASF formats, and how to get YUV using VfW...
 </LI><LI>divx4linux techical support
 </LI></UL>
 
-</LI><LI>Zdenek Kabelac:  [[e-mail]]
+</LI><LI>Zdenek Kabelac:  &lt;[e-mail]&gt;
 <UL><LI>current avifile maintainer(?)
 </LI><LI>some technical help about the win32 stuff and timers
 </LI></UL>
 
-</LI><LI>Gerard Lantau: [[e-mail]]
+</LI><LI>Gerard Lantau: &lt;[e-mail]&gt;
 <UL><LI>ffmpeg/libavcodec author,maintainer (opensource mpeg, mjpeg, divx en/decoder)
 </LI></UL>
 
-</LI><LI>Project Mayo:  [http://www.projectmayo.com]
+</LI><LI>Project Mayo:  &lt;http://www.projectmayo.com&gt;
 <UL><LI>the OpenDivX codec authors
 </LI></UL>
 
@@ -682,16 +735,95 @@
 <UL><LI>AVI FAQ author/collector. [site with many useful docs on codecs and avi fmt]
 </LI></UL>
 
-</LI><LI>Dirk Farin:      [[e-mail]]
+</LI><LI>Dirk Farin:      &lt;[e-mail]&gt;
 <UL><LI>dvdview author  [MPEG1/MPEG2 video decoder, used in v0.5-v0.8]
 </LI></UL>
 
-</LI><LI>Adam Williams:   [[e-mail]]
+</LI><LI>Adam Williams:   &lt;[e-mail]&gt;
 <UL><LI>libmpeg3 (and xmovie) author  [MPEG1/MPEG2 video decoder, used in v0.1-v0.4]
 </LI></UL>
 
 </UL></P>
 
+<P><B><A NAME=A2>Appendix A/2 - MPlayer code and documentation maintainers</A></B></P>
+
+<P>Homepage
+<UL>
+  <LI><B>Design</B>: Chass
+  <LI><B>Contents</B>: Gabucino
+</UL></P>
+<P>English documentation
+<UL>
+  <LI><B>tech-*.txt</B>: A'rpi
+  <LI><B>all the others</B>: Gabucino
+</UL></P>
+<P>Documentation translations
+<UL>
+  <LI><B>Hungarian</B>: Gabucino
+  <LI><B>Spanish</B>: TeLeNiEkO (outdated)
+  <LI><B>Russian</B>: Nick Kurshev (outdated)
+  <LI><B>Polish</B>: Dariush Pietrzak (outdated)
+  <LI><B>German</B>: Atmosfear (outdated)
+</UL></P>
+<P>Platforms/ports
+<UL>
+  <LI><B>DEBIAN packaging</B>: Dariush Pietrzak
+  <LI><B>FreeBSD support</B>: Vladimir Kushnir
+  <LI><B>Solaris 8 support</B>: Jürgen Keil
+</UL></P>
+<P>MPlayer code:
+<UL>
+  <LI><B>fileformat detection, demuxers</B>: A'rpi
+  <LI><B>DVD support</B>: (alpha version was: LGB) now: ?
+  <LI><B>network streaming</B>: Bertrand BAUDET
+  <LI><B>A-V sync code</B>: A'rpi
+  <LI><B>subtitles file parser/reader</B>: Lez (most of them)
+  <LI><B>config files & commandline parser</B>: Szabi
+  <LI><B>fastmemcpy</B>: Nick Kurshev
+  <LI><B>LIRC support</B>: Acki
+  <LI><B>SUB/OSD renderer</B>: Adam Tla/lka
+</UL></P>
+<P>libvo drivers:
+<UL>
+  <LI><B>vo_3dfx.c</B>   - OBSOLETED, use xv
+  <LI><B>vo_aa.c</B>     - Folke Ashberg
+  <LI><B>vo_dga.c</B>    - Acki
+  <LI><B>vo_fbdev.c</B>  - Szabi
+  <LI><B>vo_fsdga.c</B>  - OBSOLETED, use dga
+  <LI><B>vo_ggi.c</B>    - al3x
+  <LI><B>vo_gl.c</B>     - A'rpi
+  <LI><B>vo_md5.c</B>    - A'rpi
+  <LI><B>vo_mga.c</B>    - A'rpi
+  <LI><B>vo_null.c</B>   - A'rpi
+  <LI><B>vo_odivx.c</B>  - A'rpi
+  <LI><B>vo_pgm.c</B>    - A'rpi
+  <LI><B>vo_png.c</B>    - Atmos
+  <LI><B>vo_sdl.c</B>    - Atmos
+  <LI><B>vo_svga.c</B>   - se7en
+  <LI><B>vo_syncfb.c</B> - OBSOLETED, use mga
+  <LI><B>vo_x11.c</B>    - Pontscho
+  <LI><B>vo_xmga.c</B>   - Pontscho
+  <LI><B>vo_xv.c</B>     - Pontscho
+  <LI><B>vo_aa.c</B>     - Folke Ashberg
+</UL></P>
+<P>libao2 drivers:
+<UL>
+  <LI><B>ao_alsa5.c</B>  - al3x
+  <LI><B>ao_alsa9.c</B>  - al3x (BUGGY, use oss)
+  <LI><B>ao_null.c</B>   - A'rpi
+  <LI><B>ao_oss.c</B>    - A'rpi
+  <LI><B>ao_pcm.c</B>    - Atmos
+  <LI><B>ao_sdl.c</B>    - Atmos
+  <LI><B>ao_sun.c</B>    - Jürgen Keil
+</UL></P>
+<P>TOOLS:
+<UL>
+  <LI><B>subfont-c</B> - Artur Zaprzala: <[e-mail]>
+  <LI><B>subfont-GIMP</B> - [e-mail]
+  <LI><B>*.pl</B> - Atmos
+  <LI><B>others</B> - A'rpi
+</UL></P>
+
 <P><B><A NAME=B>Appendix B - Mailing lists</A></B></P>
 
 <P>There are some public mailing lists on <B>MPlayer</B>. Subscribing can be