Documented the changes of compilation and the new overlay feature

CVS patchset: 357
CVS date: 2001/07/27 11:42:36

1 files changed, 49 insertions, 13 deletions

diff --git a/doc/README.dxr3 b/doc/README.dxr3
index 58aa520f1..318268bda 100644
--- a/doc/README.dxr3
+++ b/doc/README.dxr3
@@ -12,7 +12,7 @@ development site at
 
 	http://dxr3.sourceforge.net/
 
-The driver can be downloaded from
+The driver package can be downloaded from
 
 	http://dxr3.sourceforge.net/download.html
 
@@ -25,26 +25,23 @@ This driver requires the (not yet released) version
 
 	em8300-0.8 of the linux drivers. (CVS only for now)
 	
-This is still a work in progress.  Audio output currently does
-not use the dxr3 device, although the oss ioctl's will likely be
-implemented soon.
 
 Compilation
 ===========
 
 It is important to compile and install the dxr3/hw+ driver
 *before* compiling xine-lib. No doing so will cause the
-configure script to stop with an error.
+configure script to exclude dxr3 support with a warning.
 
-In order to activate the dxr3/hw+ plugin, xine-lib must be
-configured with --enable-dxr3. If you have your linux sources
-in a different location than /usr/src/linux, please specify
---with-linux-path=/your/path additionally.
+In order to activate the plugin, em8300.h must be available in 
+/usr/src/linux/include/linux. If you have non-standard linux
+directory like /usr/src/linux-2.4.5, you can specify the
+location with
 
-Example:
+./configure --with-linux-path=/usr/src/linux-2.4.5
+
+otherwise a ./configure without parameters will do.
 
-	cd xine-lib
-	./configure --enable-dxr3
 
 XINE run-time configuration
 ===========================
@@ -58,6 +55,18 @@ Some of them are important for dxr3 playback:
 	ntsc    NTSC 60Hz
 	pal     PAL 50Hz
 	pal60   PAL 60Hz
+	overlay Video output on the VGA screen
+	
+*) dxr3_keycolor: (overlay only)
+	0x80a040 Hexadecimal RGB value of the key color. Should
+		not need to be changed.
+
+*) dxr3_color_interval: (overlay only)
+	50.0	Tolerance for keycolor. A higher value allows higher
+		range of keycolors. Intended for compensation of
+		color errors on VGA output. Smaller value is better
+		for not using the "wrong" colors as overlay.
+		Meaningful range: 20.0 - 200.0
 	
 *) video_driver_name:
 	dxr3    Needed for setting the tv_mode, brightness, contrast,
@@ -69,12 +78,19 @@ Some of them are important for dxr3 playback:
 		When *not* playing MPEG1/2 content, it must be set
 		to a "real" video driver like "Xv" or "Xshm".
 
+*) audio_driver_name:
+	oss	The em8300 audio output is available as an usual
+		OSS device. Therefore the audio driver must be
+		set to oss. Can also be specified using "-A oss"
+		on the command line.
+
 It is recommented to run XINE one time before editing the config,
 since all options get written in .xinerc and have their default
 values. The dxr3 video driver can be forced using the "-V dxr3"
 command line option. Only the tvmode value has to be edited
 if the default driver setting is not correct.
 
+
 Running XINE with dxr3/hw+
 ==========================
 
@@ -85,6 +101,26 @@ screen. Remember to activate a different video out than "dxr3"
 in that case!
 
 
+VGA overlay feature
+===================
+
+In previous versions of xine support, one had to use dxr3view in order
+to use the em8300 overlay mechanism. Now, with the xine 0.5 version,
+it is possible to output the em8300 overlay directly in the video
+out window. 
+
+The initial idea and the first working sample code came from 
+Mike Lampard <mjl@datafast.net.au>. Kudos to him for this new feature.
+
+In order to activate it, "dxr3_tvmode" must be set to "overlay". But
+it won't work until the old dxr3view works too (just a check). Before
+a first use, "autocal" has to be run. This will store the right overlay
+parameters in "~/.overlay". For more information, please consult the
+dxr3 howto too.
+
+Have a look at the previous explained xinerc options dxr3_keycolor
+and dxr3_color_interval too.
+
 ________________________
 docu version information
-$Id: README.dxr3,v 1.1 2001/07/22 14:23:30 ehasenle Exp $
+$Id: README.dxr3,v 1.2 2001/07/27 11:42:36 ehasenle Exp $