1. drvn0310.zip Driver
2. README.txt File Contents

README.txt Driver File Contents (drvn0310.zip)

Oculus-TCi Device Driver for Windows NT
Version 3.10
August 1st , 2000
P/N: WA-TCIS-DRVNx

Table of Content

1. Installation Instructions;
2. Disk Contents;
3. Configuration;
4. Limitations;
5. What's new;

--------------------------------------------------------------------------

1. Installation Instructions

	1.1	Uninstall any previous installed version

	1.2	Insert the Driver Distribution disk into drive A:
	  	Using Windows Explorer, Run SETUP.EXE and follow the instructions.
		The installation program will restart the OS so that the configuration
		can take effect.


2. Disk Contents

Please see the TCi User's Guide for information on the distribution files.

In Tci-Driver directory :

	BGITPCI.DLL	Required DLL
	CAD41KA1.CAM	Camera File
	CAD71KT.CAM	Camera File
	CAMSPEC.DOC	Camera file format documentation
	CCIR.CAM	Camera File
	DXC9000.CAM	Camera File
	KDK14D.CAM	Camera File
	KDK16_10.CAM	Camera File
	KDK16_8.CAM	Camera File
	KDKES101.CAM	Camera File
	KDKES102.CAM	Camera File
	KDKMP14.CAM	Camera File
	KP-F100.CAM	Camera File
	KPF1.CAM	Camera File
	MSGDLL.DLL	Message Viewer driver interface DLL
	MSGVIEW.EXE	Message Viewer Program
	ODTCI.DLL	Oculus-TCi driver interface DLL
	PCIDIAG.EXE	PCI Diagnostic program
	PCIDIAG.HLP	PCI Diagnostic program help file
	PCIDUMP.EXE	PCI devices configuration viewer
	README.TXT	This file
	HISTORY.TXT	Description of previous releases.
	RS170.CAM	Camera File
	SKC100.CAM	Camera File
	TCICFG.DLL	Oculus-TCi configuration driver interface DLL
	TCICONF.EXE	Oculus-TCi configuration program
	TM1000.CAM	Camera File
	TM1040.CAM	Camera File
	TM130010.CAM	Camera File
	TM13008.CAM	Camera File
	TM6701.CAM	Camera File
	TM9700.CAM	Camera File
	TM9701.CAM	Camera File
	TMC-9700.CAM	Camera File
	VGA.CAM		Camera File
	XC-55.CAM	Camera File

In Windows NT \system32\drivers directory :

	BGITIRQ.SYS	Required driver
	BGITPCI.SYS	Required driver
	ODXMEM.SYS	Memory Manager driver
	ODXMSG.SYS	Message Viewer driver
	TCIDRV.SYS	Oculus-TCi device driver for Windows NT  

In Windows NT \system32 directory :

	COMDLG32.OCX	Required Ole2 Object	
	GRID32.OCX	Required Ole2 Object
	MFC40.DLL	Required DLL
	MSVCRT.DLL	Required DLL
	MSVCRTD.DLL	Required DLL
	MSVCRT40.DLL	Required DLL
	ODX32.DLL	Odx driver interface DLL
	OLEPRO32.DLL	Required DLL
	TABCTL32.OCX	Required Ole2 Object	
	THREED32.OCX	Required Ole2 Object	
	VB40032.DLL	Required DLL
	CVDI.DLL	Required DLL

For Installation Only
	CORNTPRI.EXE	Utility program for installation only
	REGSVR32.EXE	Utility program for installation only

3. Configuration

	Configuration of the driver is contained in the ODX.INI file located in the Windows NT directory.


4. Limitations

	TCi-Acquisition:
	- The MJPEG module may not work on some computers.

	TCi-VGA:
	- May not work on some computers.

	TCi-VGA ULTRA:
	- The MJPEG module is not supported.

	MJPEG and DDV Module:
	- Cannot be used with Digital or RGB Camera.

	Tci ULTRA II
	-  ULTRA II cannot be used in Dual Overlay Mode with an AGP Vga Card.
	-  System can freeze with TCI-VGA ULTRA or ULTRA II (Dual Monitor or
	    Passthrough) with LX Chipset (Pentium II).
	-  System can freeze if the Primary VGA Card has an S3 Vga Chip with
	    LX Chipset (Pentium II).
	-  High color (15 bits) and True color (32 bits) Overlay are not supported
	    in Dual Overlay Mode with 640x484 30Hz NTSC Output.
	-  Red color cannot be drawn in true color overlay due to an hardware limitation.
	    Use 0xFF0001 or 0xFF0100 instead of 0xFF0000 to bypass limitation.

	ALL Boards
	-  When grabbing directly to the vga minor device, the mouse pointer should not
	   have any special effects enabled.  Using windows 2000, the non standard pointers
	   do not use the hardware cursor feature of the vga card, therefore the cursor is stored
	   directly in the vga display memory.  When the board is grabbing into the
	   vga minor device the cursor in vga memory could get overwritten.  


5. What's new
Version 3.10

New Features: 
	a) Windows 2000 is now supported.
	b) Support for 810 chipset.
	c) Added cvdi.dll and msvcrtd.dll files to installation.
	d) 4 "Myuser" functions have been added to read/write the PCI Configuration registers for the DEC bridge and the                       Zoran chip 36057.
	e) An entry has been added in odx.ini.  This entry is associated with a board and the name is 
	   "MJPEG BUFFERS IN SECONDARY".  If your board has a secondary buffer and a CDMZ compression module
	   then if you set this entry to 1 the code buffers of the Zoran chip will be place in the Secondary 
	   memory.
	f) A new parameter has been added in the registry.  This parameter is used when compressing with the 
	   CDMZ compression module.  The name of this parameter is CopyBufferCheck. By default CopyBufferCheck 
	   is set to 0.  When CopyBufferCheck is set to 0 it disables the version 3.03 New Features.  This
	   feature is used to make sure that copying of the compressed data does not overrun the buffer.  So if 
	   CopyBufferCheck is set to 0 the compression will not use the copy check option of version 3.03 and
	   if CopyBufferCheck is set to 1 then it will use the feature.
	   The complete registry path to access this parameter is 
		HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Service\TciDrv\Parameters

           By setting the parameter to 0, one keeps the compatibility with previous versions of the driver prior to 3.03. 
           See also the Important Note section below.

	g) A new parameter has been added in the registry to invert the normal field sequence when grabbing from an RGB 
	   camera.  The default field sequence in Interlaced mode is Odd/Even.  However, with some camera configurations,
	   it may be required to invert that sequence (even/odd).  The inversion is enabled by setting the following Key in 
	   the Registry:
		RGBFieldOrder = 1	-> Even/Odd sequence
		RGBFieldOrder = 0	-> Odd/Even sequence (default)
	   However, the Even/Odd capture does not work in trigger mode.
	   The complete registry path to access this parameter is 
		HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Service\TciDrv\Parameters
	h) Support of the still compression mode using the CDMZ. In this mode the driver grabs into the host and the driver                                  copies to the CDMZ the image to be compressed.
	i) The RGB-Se (cmi 55) supports the E-domphisa mode for sony XC-55.
        j) While using the compression or ddv module, you might acquire a bad image or a little green line on the top 
	   or bottom of the image.  If this situation occurs, modify the vdelay parameter. You can change
	   the vdelay parameter using a myuser function.  To do so add the following lines to your application.
		#include "myuser.h"
		......
		ODX_MYUSER_JPEG_SET_VDELAY(0x22);

	   This effect is caused by a synchronization problem between the bt819 and the Zr36057. You can use the following                                             values 0x22, 0x21, 0x20 or something close to 0x21.  This problem occurs often with Pal.
	
Fixes:
	a) CDMZ Compression/decompression to host in 32bits/pixel mode now works.
	b) Eliminated CDMZ decompression timeouts.
	c) Removed resource leaks.
	d) On some vga cards the memory used for the vga display was not located at the beginning of
	   Vga memory.  This was causing the tci to use the wrong address for the vga minor device.
	e) Removed possibility of grabbing inverted fields from RGB cameras.


Known bug
	a) Some values can't be used with the parameter Horizontal Start in the Sequential Grab Setup dialog box.
	   This parameter should not be Dword aligned (with some values the computer may freeze).
	b) The CDMZ displays inverted fields when acquiring in frame mode with a PAL video source.

Important note to TCi-MJPEG users: 
	If the registry key CopyBufferCheck is set to 1, the TCI Driver function JPEGData() will verify if the
	compressed data will fit in the destination buffer before copying the data. The memory check is performed
	only if you are transferring into memory.
	In the compression thread of your application you should have one variable of type JPEGDATA that is used by
	the JPEGData() function and one variable of type JPEGSTATUS that is returned by the JPEGStatus() function.
	The datalen entry of the JPEGDATA variable must be set	less than or equal to the datalen entry of the
	JPEGSTATUS variable returned by the JPEGStatus() function.
	If the datalen entry of the JPEGDATA variable is greater than the datalen entry of the JPEGSTATUS variable,
	then the call to JPEGData() will fail.  When JPEGData fails it will return a value of -1 or 0xffffffff.
	You can disable the memory check by either setting the CopyBufferCheck registry key to 0, or by setting the
	datalen entry of the JPEGDATA variable to 0.