No part of this document may be reproduced, transmitted, photocopied, or translated into another language without the written consent of EPIX, Inc. Information in this document is subject to change without obligation or notice. EPIX, Inc. makes no warranty of any kind with regard to this document, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. EPIX, Inc. assumes no responsibility for any errors that may appear in this document. EPIX, Inc. reserves the right to make changes to the specifications of hardware and software at any time, without obligation or notice.
4MIP, SVIP, XCIP, XCAP, 4MEG VIDEO, 1MEG VIDEO, SILICON VIDEO MUX, QUICK SET VIDEO, 12-7MUX, IMAGE MEMORY EXPANSION, COC40, and COC402 are trademarks of EPIX, Inc.
EPIX, SILICON VIDEO, and PIXCI are registered trademarks of EPIX, Inc.
Other brand, product, and company names are trademarks or registered trademarks of their respective owners.
Printing: 16-Dec-2008
Thank you for purchasing imaging products from EPIX, Inc. We are available via the Internet, FAX, and telephone to help with installation or to answer questions about the use of our products for your application.
The PIXCI® E1, E4, EL1, E1DB, E4DB, or EL1DB imaging boards, for the PCI Express bus, are packed in a static dissipative bag. Please keep the bag and box in which the board was shipped should the need arise to return the board. Prior to opening the bag, place the bag near the PC into which the board will be installed.
We recommend installing XCAP prior to installing the PIXCI imaging board.
Please refer to the Software Installation chapter for the XCAP installation
directions, then follow the board installation instructions below.
The size and the number of images that can be stored in memory on the motherboard
is a function of the amount of memory that is not needed by the operating system.
XCAP requests 16 MB of memory for image buffers by default.
If more memory is required for image sequences, the
''Driver Assistant''
in the
''PIXCI Open/Close''
menu should be used to set the reserved memory size.
Some operating systems may require up to 256 megabytes to operate efficiently.
Do not reserve all available memory for image sequences.
The PIXCI imaging board(s) can capture and store full resolution images
to DRAM on a PCI Express motherboard.
The PIXCI imaging boards have been tested at sustained data rates of 204 megabytes per second,
and burst rates of 250 megabytes per second for an x1 slot and x1 board.
The PIXCI E4 and E4DB boards have been tested at sustained data rates of 700 megabytes per second,
and burst rates of 1000 megabytes per second for an x4 slot and x4 board.
Wider PCI Express slots may be used for the PIXCI boards, but note that some x16 slots (915 chip set)
will only operate in x1 or x16 capability, resulting in slower data rates.
Each PCI Expess slot on a motherboard may exhibit different performance characteristics.
If the motherboard manuafacturer doesn't indicate the slot which supports
the highest bandwdith, try all slots.
EPIX is an Intel approved, value added reseller and can assemble computer based imaging systems including camera(s),
RAID video to disk systems,
power supplies, monitors, and cables that have
been tested to specific sustained data rates prior to shipment.
For fast display updates, EPIX recommends motherboards with a PCI Express based display system.
The PIXCI E1, E4, EL1, E1DB, E4DB, and EL1DB imaging boards have two 26 pin Camera Link connectors and a 6 pin Lemo
connector which are accessible thru the bracket that mounts the board to the computer chassis.
The 26 pin MDR connector P1 is a Camera Link Base configuration data and control connector
as described in the Camera Link
specification.
P1 is the lower connector on the computer mounting bracket and should be used when connecting to a camera with a single camera
link connector to a board that is
configured for medium or full capabilities (E1, E4, and EL1).
On a dual base configured board, P1 and P2 provide identical capabilities.
| Signal | Pin |
| Name | Number |
| Inner Shield | 13 |
| Inner Shield | 26 |
| X0- | 25 |
| X0+ | 12 |
| X1- | 24 |
| X1+ | 11 |
| X2- | 23 |
| X2+ | 10 |
| XCLK- | 22 |
| XCLK+ | 9 |
| X3- | 21 |
| X3+ | 8 |
| SerTC+ | 20 |
| SerTC- | 7 |
| SerTFG- | 19 |
| SerTFG+ | 6 |
| CC1- | 18 |
| CC1+ | 5 |
| CC2- | 4 |
| CC2+ | 17 |
| CC3- | 16 |
| CC3+ | 3 |
| CC4- | 2 |
| CC4+ | 15 |
| Inner Shield | 1 |
| Inner Shield | 14 |
The 26 pin MDR connector P2 is the middle connector on the computer mounting bracket and
is a Camera Link Medium and Full configuration data connector as described in the Camera Link
specification.
On the E1DB, E4DB, and EL1DB connector P2 is changed to support a base camera connection and
has the same connections as P2 when so configured.
| Signal | Pin |
| Name | Number |
| Inner Shield | 13 |
| Inner Shield | 26 |
| Y0- | 25 |
| Y0+ | 12 |
| Y1- | 24 |
| Y1+ | 11 |
| Y2- | 23 |
| Y2+ | 10 |
| YCLK- | 22 |
| YCLK+ | 9 |
| Y3- | 21 |
| Y3+ | 8 |
| TERM+ | 20 |
| TERM- | 7 |
| Z0- | 19 |
| Z0+ | 6 |
| Z1- | 18 |
| Z1+ | 5 |
| Z2- | 17 |
| Z2+ | 4 |
| ZCLK- | 16 |
| ZCLK+ | 3 |
| Z3- | 15 |
| Z3+ | 2 |
| Inner Shield | 1 |
| Inner Shield | 14 |
A 6 position LEMO EGG.0B.306.CLL connector, P3, which is mounted at the top of the PCI bracket,
has some of the same signals as P4 for connecting trigger inputs and outputs.
Pin 1 is ground.
Pin 2 is +5 volts thru a 0.75 ampere thermally controlled regulator.
Pin 3, TRGM, is a negative LVDS differential trigger input, also connects to pin 3 of P4.
Pin 4, TRGP, is a positive LVDS differential trigger input, also connects to pin 4 of P4.
Pin 5, TRG0M, negative trigger output, also connects to pin 7 of P4.
Pin 6, TRGOP, positive trigger output, also connects to pin 8 of P4.
The TRGOP and TRGOM output signals are copies of the Trigger In+ and Trigger In- signals for daisy chaining the trigger input
from board to board.
| Signal | IN/ | Pin | Pin | IN/ | Signal |
| Name | OUT | Number | Number | OUT | Name |
| Ground | 1 | 2 | +5 VDC (0.75 Amp max) | ||
| TRGM | I | 3 | 4 | I | TRGP |
| NFEN | I | 5 | 6 | I | PFEN |
| TRGOM | O | 7 | 8 | O | TRGOP |
| NIO | I/O | 9 | 10 | I/O | PIO |
P4 is for signals external or internal to the computer case.
External signals can be connected with a cable to the 9 pin D-Subminiature connector
thru a second slot with a bracket to mount the D-Subminiature connector.
A differential to TTL Module and 2 meter cable are available for
connecting TTL trigger, vertical drive, and trigger out signals to the PIXCI board.
The trigger inputs and outputs are also available on the round Lemo connector, P3.
The connections for the TTL Module are available on www.epixinc.com products page.
P4 is located in the top left of the PIXCI board with pin 1 in the upper left position and pin 2 in the upper right position. It is between Lemo connector P3 and Header P5.
Pin 1 is ground.
Pin 2 is +5 volts thru a 0.75 ampere resettable thermal fuse.
Pin 3, TRGM, is a negative differential trigger input.
Pin 4, TRGP, is a positive differential trigger input.
Pin 5, NFEN, is the negative differential frame enable input for line scan applications.
Pin 6, PFEN, is the positive differential frame enable input for line scan applications.
Pin 7, TRGOM, is a negative differential trigger output.
Pin 8, TRGOP, is a positive differential trigger output. The PSTR and NSTR signals are driven from the camera control state machine. The strobe signal is delayed by two state machine clocks from the exposure signal.
Pin 9, NIO, is a negative differential board-to-board signal which can be configured as an output, input, or both.
Pin 10, PIO, is a positive differential board to board signal which can be configured as an output, input, or both.
The intended use for NIO and PIO is for board to board wiring of the exposure signal when multiple cameras must have
the same exposure signal.
One board is configured as a master (driver), the other boards as slaves (receivers).
Header P5 is located at the top center of the board between P4 and P6.
It is used as the trigger input for a second camera when the PIXCI board
is configured for dual base operation.
P5 has a similar pinout as P4, but the signals are dedicated to the second base camera connected to P2.
When the PIXCI board is configured for dual base operation a label with E1DB, E4DB, or ELDB followed by
the board serial number will be placed on the front side of the board.
Header P6 is located at the top center of the board between P5 and P7.
| Signal | IN/ | Pin | Pin | IN/ | Signal |
| Name | OUT | Number | Number | OUT | Name |
| Ground | 1 | 2 | +12 VDC (fused at 0.75 A) | ||
| Out 1 | Out | 3 | 4 | Ground | |
| Out 2 | Out | 5 | 6 | Ground | |
| In 1 | In | 7 | 8 | Ground | |
| In 2 | In | 9 | 10 | Ground | |
Pin 1 of P6 is in the upper left position.
Pin 1 is ground.
Pin 2 is +5 volts thru a 0.75 ampere thermally limited regulator. Pin 2 is in the upper right position.
Pin 3, OUT1, is a general purpose TTL output. It is not buffered and should be used only to drive other devices internal to the enclosure.
Pin 4 is ground.
Pin 5, OUT2, is a general purpose TTL output. It is not buffered and should be used only to drive other devices internal to the enclosure.
Pin 6 is ground.
Pin 7, IN1, is a general purpose TTL input. It is not buffered and should be used only to receive signals from other devices internal to the enclosure. IN1 is pulled up to 3.3 volts.
Pin 8 is ground.
Pin 9, IN2, is a general purpose TTL input. It is not buffered and should be used only to receive signals from other devices internal to the enclosure. IN2 is pulled up to 3.3 volts.
Pin 10 is ground.
Header P7 is located at the top right of the board to the right of P6.
P7 is reserved for configuration of the FPGA.
HDR3 is located in the middle and slightly to the right of center of the board. HDR3 is used for expansion to 8 TTL outputs and 8 TTL inputs. A FX6A-20P-0.8SV1 connector is optionally installed at HDR3.
XCAP-Plus, XCAP-Std, XCAP-Ltd, and XCAP-Lite are easy to install by following the instructions below.
While XCAP is easy to install, like most manufacturers of computer software, we recommend the precaution of performing a hard disk backup before installing XCAP.
> A:SETUP
or
> B:SETUP
> Z:SETUP (replace Z with drive letter for your CD)
from the EPIX, Inc. ftp site.ftp.epixinc.com/software/xcap_v30/XCAPWIN32.EXE (for 32 bit Windows)
> XCAPWIN32.EXE (for 32 bit Windows) > XCAPWIN64.EXE (for 64 bit Windows)
PCITIPS.TXT
file provides the
PC Configuration Tips,
with tips for resolving hardware and software conflicts.
Command Line: InstallDir \ XCAPWXX
Name: XCAP
replacing
''InstallDir''
with the name of the installation directory chosen above.
Select
''OK''.
The printer port authorization key is approximately the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25-pin connectors at both ends and no cable attached. If provided, connect the authorization key to any printer port. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.
Do not connect the printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!
The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.
The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.
> C:\XCAP\HARDLOCK\HLDINST -install
> CHDIR C:\XCAP\HARDLOCK
and execute:
HLDINST -install
to run the authorization key utility program.
If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.
The first time Windows 2000 starts after installation of the PIXCI® imaging board, a pop-up window with the message "Multimedia Video Controller" will flash. A window stating ''Welcome to the Found New Hardware Wizard'' appears; click ''Next'', select ''Search for the best driver for your device'', click ''Next'', check box ''Specify a location'', enter path Drivers\Win2K within the chosen installation directory, typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window reports that a driver was found, namely ...\Drivers\Win2K\EPIXXCW2.INF; click ''Next''. A window reports that Microsoft's ''Digital Signature was not found''; click ''Yes''. A window states ''Completing the Found New Hardware Wizard'' and ''This device is not configured correctly. (Code 1)'' (this error indicates that the newly installed driver will be functional only after a reboot); click ''Finish'' and restart Windows.
If the PIXCI® imaging board was already installed, and ''Cancel'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Settings'', ''Control Panel'', ''System'' (if ''System'' is not listed, click on ''View all Control Panel options''), ''Device Manager'', and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''PIXCI(R) Video Capture Board''. Click ''Properties'', ''Driver'', ''Change Driver'' or ''Update Driver''. A window stating ''Welcome'' appears; click ''Next''. A window stating ''This wizard searches for updated drivers for: PCI MultiMedia Video Device'' or ''This wizard searches for updated drivers for: PIXCI(R) Video Capture Board'' appears; select ''Search for a suitable driver for my device (recommended)'', click ''Next'', select ''Specify a Location'', enter path Drivers\Win2K within the chosen installation directory, typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next'', ''Next''. A window reports that Microsoft's: ''Digital Signature was not found''; click ''Yes''. A window reports ''This device is not configured correctly. (Code 1)'' (this error indicates that the newly installed driver will be functional only after a reboot); click ''Finish'' and restart Windows.
Use of EPIXXCW2.INF (or EPIXXCNT.INF for version 2.0 and earlier), above, provides automatic installation of EPIXXCW2.SYS (or EPIXXCNT.SYS for version 2.0 and earlier) in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.
C:\WINNT\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2 (version 2.1+)
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCNT (version 2.0-)
This entry must contain:
ErrorControl = 0x00000001
Group = "Extended base"
Start = 0x00000001
Type = 0x00000001
and may, as described below, also contain:
PIXCI = "-IM <memorysize>"
Create an entry such as:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW2 (version 2.1+)
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCNT (version 2.0-)
This entry must contain:
EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
TypesSupported = 0x00000007
Under Windows 2000, the Windows NT driver EPIXXCWT.SYS can be, and was previously, used instead of EPIXXCW2.SYS. In contrast to EPIXXCWT.SYS, the EPIXXCW2.SYS is Plug & Play compatible.
Under Windows 2000 frame buffer memory must be allocated during Windows' initialization.
The requested frame buffer memory size must be specified in the Registry entry described above, using an entry named ''PIXCI'', such as:
PIXCI = "-IM <memorysize>"
replacing the
''<memorysize>''
with the desired memory size in kBytes.
If no frame buffer memory size is specified,
a default size of 32768 kBytes is used.
Windows must be rebooted for the new specification to take effect.
Optionally,
"-MB <memory_partition_size>"
specifies that the requested
"-IM <memorysize>"
is to be allocated in blocks or partitions of the stated size.
Requesting memory partitioned into blocks may allow receiving
more memory that would be available as a single block.
However,
(a) Each frame buffer must be completely contained within a partition, and
(b) The maximum number of partitions is 256 under 32 bit operating systems.
Systems with very high resolution cameras using large frame buffers
should choose the partition size carefully, so as to minimize
the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by the -IM parameter is needed only for support of time stamping of captured frames, such as optionally used by Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.
Windows 2000 limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total computer memory size, and other factors. Under Windows 2000, the maximum amount of memory that can be allocated by this method is typically limited to 64 or 92 MByte.
Windows may provide less frame buffer memory than was requested. If no memory could be allocated, the PIXCI® imaging board will not be available, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during Windows initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if Windows is restarted.
As described above, frame buffer memory allocated by EPIXXCW2.SYS for Windows 2000, during Windows startup may be limited to a small percentage of total computer memory; typically 64 to 96 MByte.
A larger frame buffer memory can be obtained by limiting the amount of memory recognized by Windows and then instructing EPIXXCW2.SYS for Windows 2000 to explicitly use a section of memory without allocating it from Windows 2000:
[operating systems]
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000"
to:
[operating systems]
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000 [NT=64M PIXCI=256M]" /MAXMEM=64
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows 2000"
Do
not
copy this new line as shown above; the first portion of the line must be
copied from an existing configuration line in
your
C:\BOOT.INI
file.
The text between quotes appears as a boot selection prompt,
use of
''[NT=64M PIXCI=256M]''
is a suggested reminder, but not required.
Also in C:\BOOT.INI, change the timeout selection to be greater than 0:
[boot loader]
timeout=30
Otherwise the
BOOT.INI
configuration options will not be shown when Windows starts.
Keeping the original configuration line, as a boot selection option, is highly recommended as a backup.
Under Windows XP, the
BOOTCFG
command, provided with Windows, can be used to
change the
BOOT.INI
file
instead of manual editing.
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
On the
''PIXCI''
field add:
-IA <image_memory_adrs_in_kByte>
-IM <size_of_image_memory_in_kByte>
-MB <image_memory_partition_size_in_kByte>
-BH <size_of_BIOS_hole_below_4GB_in_kByte>
In practice, all four fields are on the same line.
The -MB partition size specifies the size into which image memory is partitioned for the sake of virtual memory management: (a) Each frame buffer must be completely contained within a partition, (b) A value of 0 specifies that the entire image memory is to be handled as one partition, and (c) The maximum number of partitions is 256 under 32 bit operating systems. For most systems, a value of 8192 or 16384 is suggested; though the value need not be a power of two. Systems with very high resolution cameras using large frame buffers should choose the partition size carefully, so as to minimize the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
When using more than 1 or 2 GBytes of image memory, it may be necessary to append:
-MU 0x01
to the
''PIXCI''
field, conserving system memory mapping resources by not mapping the
image memory directly into the application program's space.
It may also be necessary
to append:
-MU 0x03
which additionally conserves system resources by mapping memory only on demand.
Be careful that the -IA address is equal to (or above) the specified /MAXMEM limit - including exact base2 to base10 conversions! (i.e. for /MAXMEM=64, the smallest valid value of -IA is 65536, not 64000!). Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
On a computer populated with 4 or more GBytes of memory, some of the memory directly below the 4 GByte address overlaps other hardware resources such as BIOS, memory mapped I/O, PCI configuration space, etc.[2] and is unavailable to either the operating system or for use as frame buffers. The usable frame buffer memory is therefore reduced by the amount by which the -IA address up to the -IA address plus -IM size overlap the 4 GByte address minus -BH size up to the 4 GByte address. The -BH size may be set to 0 (or not specified) if the computer has significantly less than 4 GBytes of memory.
For example, for a computer with 1 GByte of memory, allocating 256 MByte for Windows and the remainder for frame buffer memory, use:
/MAXMEM=256
in
C:\BOOT.INI,
and use:
PIXCI = -IA 262144 -IM 786432 -MB 8192
in the registry entry.
Note that 262144 is 256×1024,
and 786432 is (1024-256)×1024.
Note that if this memory allocation method is used, program access to image data may be slower. Thus, the video display rate (and image processing) may be slower, but the video capture rate (such as sequence capture) is not adversely affected. This method of memory allocation is primarily used for video rate acquisition of long sequences, followed by off-line analysis or saving of the sequence.
Use of HLDINST.EXE, as described above, provides automatic installation of the printer port authorization key's driver, needed under Windows 2000 for XCAP-Plus, XCAP-Std, and XCAP-Ltd (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures for the printer port version of authorization keys.
C:\WINNT\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock
This key must contain values:
ErrorControl = 0x00000001
Group = "Extended Base"
Start = 0x00000002
Type = 0x00000001
or, if using REGEDT32, the values should appear as:
ErrorControl:REG_DWORD:0x1
Group:REG_SZ:ExtendedBase
Start:REG_DWORD:0x2
Type:REG_DWORD:0x1
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock\Parameters
which contains a value:
IoPortAddress0 = 0x???? (for REGEDIT)
IoPortAddress0:REG_DWORD:0x???? (for REGEDT32)
where the
''????''
is replaced with the parallel port's I/O address in hexadecimal.
As before, Windows must be shut down and restarted.
Command Line: InstallDir \ XCAPWXX
Name: XCAP
replacing
''InstallDir''
with the name of the installation directory chosen above.
Select
''OK''.
The printer port authorization key is approximately the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25-pin connectors at both ends and no cable attached. If provided, connect the authorization key to any printer port. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.
Do not connect the printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!
The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.
The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.
> C:\XCAP\HARDLOCK\HLDINST -install
> CHDIR C:\XCAP\HARDLOCK
and execute:
HLDINST -install
to run the authorization key utility program.
If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.
The first time Windows XP or XP(x64) starts after installation of the PIXCI® imaging board, a pop-up window with the message ''Multimedia Video Controller'' will flash. A window stating ''Welcome to the Found New Hardware Wizard'' appears; select ''Install from a list or a specific location. (Advanced)'', click ''Next'', select ''Search for the best driver in these locations'', uncheck box ''Search removable storage media'', check box ''Include this location in the search'', enter path Drivers\WinXP for Windows XP, or Drivers\WinXP64 for Windows XP(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window reports that a driver was found, namely ...\Drivers\WinXP\EPIXXCW2.INF, Or ...\Drivers\WinXP64\EPIXXCW6.INF for Windows XP(x64), click ''Next''. A window states ''The software that you are installing for ... has not passed compatibility testing''; click ''Continue Anyway''. A window states ''Completing the Found New Hardware Wizard'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.
If the PIXCI® imaging board was already installed, and ''Cancel'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Control Panel'', ''Performance and Maintenance'', ''System'', ''Hardware'', ''Device Manager'', and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''PIXCI(R) Video Capture Board'' (the latter appears if a PIXCI® imaging board driver was previously installed). Click ''Properties'', ''Driver'', ''Change Driver'' or ''Update Driver''. A ''Welcome'' window appears; select ''Install from a list or a specific location. (Advanced)'', click ''Next'', select ''Search for the best driver in these locations'', uncheck ''Search removable storage media'', check ''Include this location in the search'', enter path Drivers\WinXP for Windows XP, or Drivers\WinXP64 for Windows XP(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next'', ''Next''. A window reports ''The software that you are installing for ... has not passed compatibility testing''; click ''Continue Anyway''. A window reports ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.
Use of EPIXXCW2.INF or EPIXXCW6.INF, above, provides automatic installation of EPIXXCW2.SYS or EPIXXCW6.SYS in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.
C:\WINDOWS\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
for Windows XP
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
for Windows XP(x64).
This entry must contain:
ErrorControl = 0x00000001
Group = "Extended base"
Start = 0x00000001
Type = 0x00000001
and may, as described below, also contain:
PIXCI = "-IM <memorysize>"
Create an entry such as:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW2
for Windows XP
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW6
for Windows XP(x64).
This entry must contain:
EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
TypesSupported = 0x00000007
Under Windows XP or XP(x64), frame buffer memory must be allocated during Windows' initialization.
The requested frame buffer memory size must be specified in the Registry entry described above, using an entry named ''PIXCI'', such as:
PIXCI = "-IM <memorysize>"
replacing the
''<memorysize>''
with the desired memory size in kBytes.
If no frame buffer memory size is specified,
a default size of 32768 kBytes is used.
Windows must be rebooted for the new specification to take effect.
Optionally,
"-MB <memory_partition_size>"
specifies that the requested
"-IM <memorysize>"
is to be allocated in blocks or partitions of the stated size.
Requesting memory partitioned into blocks may allow receiving
more memory that would be available as a single block.
However,
(a) Each frame buffer must be completely contained within a partition, and
(b) The maximum number of partitions is 256 under 32 bit operating systems,
the maximum number of partitions is 256 under 64 bit operating systems.
Systems with very high resolution cameras using large frame buffers
should choose the partition size carefully, so as to minimize
the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by the -IM parameter is needed only for support of time stamping of captured frames, such as optionally used by Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.
Windows XP or XP(x64), limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total computer memory size, and other factors. Under Windows XP the maximum amount of memory that can be allocated by this method is typically limited to 512 MByte, but not more than half of the physical memory. Under Windows XP(x64), the typical amount of allocated memory has not yet been determined.
Windows may provide less frame buffer memory than was requested. If no memory could be allocated, the PIXCI® imaging board will not be available, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during Windows initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if Windows is restarted.
As described above, frame buffer memory allocated by EPIXXCW2.SYS for Windows XP, or EPIXXCW6.SYS for Windows XP(x64), during Windows startup may be limited to a small percentage of total computer memory; typically 512 MByte but not more than half of the physical memory under Windows XP. Under Windows XP(x64), the limits of memory allocated during Windows startup has not yet been determined, but is larger than 4 GByte.
A larger frame buffer memory can be obtained by limiting the amount of memory recognized by Windows and then instructing EPIXXCW2.SYS for Windows XP, or EPIXXCW6.SYS for Windows XP(x64), to explicitly use a section of memory without allocating it from Windows XP or XP(x64):
[operating systems]
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows XP"
to:
[operating systems]
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows XP [NT=64M PIXCI=256M]" /MAXMEM=64
multi(0)disk(0)rdisk(0)partition(7)\WINNT="Windows XP"
Do
not
copy this new line as shown above; the first portion of the line must be
copied from an existing configuration line in
your
C:\BOOT.INI
file.
The text between quotes appears as a boot selection prompt,
use of
''[NT=64M PIXCI=256M]''
is a suggested reminder, but not required.
Also in C:\BOOT.INI, change the timeout selection to be greater than 0:
[boot loader]
timeout=30
Otherwise the
BOOT.INI
configuration options will not be shown when Windows starts.
Keeping the original configuration line, as a boot selection option, is highly recommended as a backup.
Under Windows XP, the
BOOTCFG
command, provided with Windows, can be used to
change the
BOOT.INI
file instead of manual editing.
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
for Windows XP,
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
for Windows XP(x64).
On the
''PIXCI''
field add:
-IA <image_memory_adrs_in_kByte>
-IM <size_of_image_memory_in_kByte>
-MB <image_memory_partition_size_in_kByte>
-BH <size_of_BIOS_hole_below_4GB_in_kByte>
In practice, all four fields are on the same line.
The -MB partition size specifies the size into which image memory is partitioned for the sake of virtual memory management: (a) Each frame buffer must be completely contained within a partition, (b) A value of 0 specifies that the entire image memory is to be handled as one partition, and (c) The maximum number of partitions is 256 under 32 bit operating systems, the maximum number of partitions is 256 under 64 bit operating systems. For most systems, a value of 8192 or 16384 is suggested; though the value need not be a power of two. Systems with very high resolution cameras using large frame buffers should choose the partition size carefully, so as to minimize the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
When using more than 1 or 2 GBytes of image memory, it may be necessary to append:
-MU 0x01
to the
''PIXCI''
field, conserving system memory mapping resources by not mapping the
image memory directly into the application program's space.
It may also be necessary
to append:
-MU 0x03
which additionally conserves system resources by mapping memory only on demand.
Be careful that the -IA address is equal to (or above) the specified /MAXMEM limit - including exact base2 to base10 conversions! (i.e. for /MAXMEM=64, the smallest valid value of -IA is 65536, not 64000!). Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
On a computer populated with 4 or more GBytes of memory, some of the memory directly below the 4 GByte address overlaps other hardware resources such as BIOS, memory mapped I/O, PCI configuration space, etc.[4] and is unavailable to either the operating system or for use as frame buffers. The usable frame buffer memory is therefore reduced by the amount by which the -IA address up to the -IA address plus -IM size overlap the 4 GByte address minus -BH size up to the 4 GByte address. The -BH size may be set to 0 (or not specified) if the computer has significantly less than 4 GBytes of memory.
For example, for a computer with 1 GByte of memory, allocating 256 MByte for Windows and the remainder for frame buffer memory, use:
/MAXMEM=256
in
C:\BOOT.INI,
and use:
PIXCI = -IA 262144 -IM 786432 -MB 8192
in the registry entry.
Note that 262144 is 256×1024,
and 786432 is (1024-256)×1024.
Note that if this memory allocation method is used, program access to image data may be slower. Thus, the video display rate (and image processing) may be slower, but the video capture rate (such as sequence capture) is not adversely affected. This method of memory allocation is primarily used for video rate acquisition of long sequences, followed by off-line analysis or saving of the sequence.
Use of HLDINST.EXE, as described above, provides automatic installation of the printer port authorization key's driver, needed under Windows XP, or XP(x64), for XCAP-Plus, XCAP-Std, and XCAP-Ltd (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures for the printer port version of authorization keys.
C:\WINDOWS\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock
This key must contain values:
ErrorControl = 0x00000001
Group = "Extended Base"
Start = 0x00000002
Type = 0x00000001
or, if using REGEDT32, the values should appear as:
ErrorControl:REG_DWORD:0x1
Group:REG_SZ:ExtendedBase
Start:REG_DWORD:0x2
Type:REG_DWORD:0x1
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock\Parameters
which contains a value:
IoPortAddress0 = 0x???? (for REGEDIT)
IoPortAddress0:REG_DWORD:0x???? (for REGEDT32)
where the
''????''
is replaced with the parallel port's I/O address in hexadecimal.
As before, Windows must be shut down and restarted.
> A:SETUP
or
> B:SETUP
> Z:SETUP (replace Z with drive letter for your CD)
from the EPIX, Inc. ftp site.ftp.epixinc.com/software/xcap_v30/XCAPWIN32.EXE (for 32 bit Windows)
> XCAPWIN32.EXE (for 32 bit Windows) > XCAPWIN64.EXE (for 64 bit Windows)
PCITIPS.TXT
file provides the
PC Configuration Tips,
with tips for resolving hardware and software conflicts.
Command Line: InstallDir \ XCAPWXX
Name: XCAP
replacing
''InstallDir''
with the name of the installation directory chosen above.
Select
''OK''.
The printer port authorization key is approximately the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25-pin connectors at both ends and no cable attached. If provided, connect the authorization key to any printer port. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.
Do not connect the printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!
The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.
The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.
> C:\XCAP\HARDLOCK\HLDINST -install
> CHDIR C:\XCAP\HARDLOCK
and execute:
HLDINST -install
to run the authorization key utility program.
If the PIXCI® imaging board was not previously installed, the first time Windows starts after installation of the PIXCI® imaging board, Windows will notice the new device and inquire.
The first time Windows Vista or Vista(x64) starts after installation of the PIXCI® imaging board, a window titled ''Found New Hardware'' appears. Select ''Locate and install driver software (recommended)'', click ''Continue'', select ''I don't have the disk. Show me other options'', select ''Browse my computer for driver (advanced)'', enter path Drivers\WinVS for Windows Vista, or Drivers\WinVS64 for Windows Vista(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window asks ''Would you like to install this device software?''; click ''Install''. A window reports ''The software for this device has been successfully installed'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.
If the PIXCI® imaging board was already installed, and ''Ask me again later'' or ''Don't show this message again for this device'' was clicked when Windows started and announced the presence of a new ''Multimedia Video Controller'', then instruct Windows to load the appropriate driver. Click ''Start'', ''Control Panel'', ''System and Maintenance''. Select ''Device Manager'' and under ''Other Devices'' or ''Imaging Devices'' double-click ''PCI MultiMedia Video Device'' or ''Coprocessor'' or ''PIXCI(R) Video Capture Board'' (the former two may appear if a PIXCI® driver was never installed, otherwise the latter appears). A ''Properties'' window appears; click ''Driver'' (tab), and ''Update Driver''. An ''Update Driver Software'' window appears; select ''Browse my computer for driver (advanced)'', enter path Drivers\WinVS for Windows Vista, or Drivers\WinVS64 for Windows Vista(x64), within the chosen installation directory typically C:\XCAP or C:\Program Files\EPIX\XCAP\XCAP, and click ''Next''. A window asks ''Would you like to install this device software?''; click ''Install''. A window reports ''The software for this device has been successfully installed'' and ''The hardware you installed will not work until you restart your computer''; click ''Finish'' and restart Windows.
The Driver Assistant feature within XCAP simplifies configuration of the PIXCI® imaging board's driver. Under Windows Vista and Vista(x64), such a feature must have administrator privileges. To run XCAP once with administrator privilege, right click on its shortcut or on the ''XCAP for Windows'' and select ''Run as administrator''. To always run XCAP with administrator privilege, right click on its shortcut or on the ''XCAP for Windows'' and select ''Properties'', ''Shortcut'', ''Run as administrator'', and ''OK''.
Use of EPIXXCW2.INF or EPIXXCW6.INF, above, provides automatic installation of EPIXXCW2.SYS or EPIXXCW6.SYS in most circumstances. The following information allows manual installation, correcting problems, or integration with an OEM's procedures.
C:\WINDOWS\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
for Windows Vista
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
for Windows Vista(x64).
This entry must contain:
ErrorControl = 0x00000001
Group = "Extended base"
Start = 0x00000001
Type = 0x00000001
and may, as described below, also contain:
PIXCI = "-IM <memorysize>"
Create an entry such as:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW2
for Windows Vista
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EventLog\System\EPIXXCW6
for Windows Vista(x64).
This entry must contain:
EventMessageFile = "%SystemRoot%\System32\IoLogMsg.dll"
TypesSupported = 0x00000007
Under Windows Vista or Vista(x64), frame buffer memory must be allocated during Windows' initialization.
The requested frame buffer memory size must be specified in the Registry entry described above, using an entry named ''PIXCI'', such as:
PIXCI = "-IM <memorysize>"
replacing the
''<memorysize>''
with the desired memory size in kBytes.
If no frame buffer memory size is specified,
a default size of 32768 kBytes is used.
Windows must be rebooted for the new specification to take effect.
Optionally,
"-MB <memory_partition_size>"
specifies that the requested
"-IM <memorysize>"
is to be allocated in blocks or partitions of the stated size.
Requesting memory partitioned into blocks may allow receiving
more memory that would be available as a single block.
However,
(a) Each frame buffer must be completely contained within a partition, and
(b) The maximum number of partitions is 256 under 32 bit operating systems,
the maximum number of partitions is 256 under 64 bit operating systems.
Systems with very high resolution cameras using large frame buffers
should choose the partition size carefully, so as to minimize
the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by the -IM parameter is needed only for support of time stamping of captured frames, such as optionally used by Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.
Windows Vista or Vista(x64) limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the total computer memory size, and other factors. Under Windows Vista, the maximum amount of memory that can be allocated by this method is typically limited to 512 MByte, but not more than half of the physical memory; these values for Vista are not finalized. Under Windows Vista(x64), the typical amount of allocated memory has not yet been determined.
Windows may provide less frame buffer memory than was requested. If no memory could be allocated, the PIXCI® imaging board will not be available, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during Windows initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if Windows is restarted.
As described above, frame buffer memory allocated by EPIXXCW2.SYS for Windows Vista, or EPIXXCW6.SYS for Windows Vista(x64), during Windows startup may be limited to a small percentage of total computer memory; typically 512 MByte, but not more than half of the physical memory, under Windows Vista.
A larger frame buffer memory can be obtained by limiting the amount of memory recognized by Windows, and then instructing EPIXXCW2.SYS for Windows Vista, or EPIXXCW6.SYS for Windows Vista(x64), to explicitly use a section of memory without allocating it from Windows Vista or Vista(x64):
BCDEDIT
utility to create a copy of the
''{CURRENT}''
boot entry,
set the new
entry use limit memory usage via
''truncatememory'',
and changing the new entry's description.
Typical commands are:
BCDEDIT /enum
to list current entries and obtain the current entry's description,
BCDEDIT /copy {current} /d "CURRENT_ENTRY_DESCRIPTION [PIXCI=##M NT=##M"
to create a new entry with modified description and boot prompt including a reminder of the amount
of memory provided to Windows and to the PIXCI® imaging card,
BCDEDIT /enum /v
to get the ID of the new entry, and:
BCDEDIT /set <new_entry_id> truncatememory <memory_size>
to limit the Windows memory size to <memory_size>, in bytes.
Also using
BCDEDIT
change the timeout selection to be greater than 0:
BCDEDIT /timeout 30
Otherwise the boot
configuration options will not be shown when Windows starts.
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW2
for Windows Vista,
or
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EPIXXCW6
for Windows Vista(x64).
On the
''PIXCI''
field add:
-IA <image_memory_adrs_in_kByte>
-IM <size_of_image_memory_in_kByte>
-MB <image_memory_partition_size_in_kByte>
-BH <size_of_BIOS_hole_below_4GB_in_kByte>
In practice, all four fields are on the same line.
The -MB partition size specifies the size into which image memory is partitioned for the sake of virtual memory management: (a) Each frame buffer must be completely contained within a partition, (b) A value of 0 specifies that the entire image memory is to be handled as one partition, and (c) The maximum number of partitions is 256 under 32 bit operating systems, the maximum number of partitions is 256 under 64 bit operating systems. For most systems, a value of 8192 or 16384 is suggested; though the value need not be a power of two. Systems with very high resolution cameras using large frame buffers should choose the partition size carefully, so as to minimize the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
When using more than 1 or 2 GBytes of image memory, it may be necessary to append:
-MU 0x01
to the
''PIXCI''
field, conserving system memory mapping resources by not mapping the
image memory directly into the application program's space.
It may also be necessary
to append:
-MU 0x03
which additionally conserves system resources by mapping memory only on demand.
Be careful that the -IA address is equal to (or above) the specified ''truncatememory'' limit - including exact base2 to base10 conversions! Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
On a computer populated with 4 or more GBytes of memory, some of the memory directly below the 4 GByte address overlaps other hardware resources such as BIOS, memory mapped I/O, PCI configuration space, etc.[6] and is unavailable to either the operating system or for use as frame buffers. The usable frame buffer memory is therefore reduced by the amount by which the -IA address up to the -IA address plus -IM size overlap the 4 GByte address minus -BH size up to the 4 GByte address. The -BH size may be set to 0 (or not specified) if the computer has significantly less than 4 GBytes of memory.
For example, for a computer with 1 GByte of memory, allocating 256 MByte for Windows and the remainder for frame buffer memory, use:
BCDEDIT /set NEW_ENTRY_ID truncatememory 268435456
and use:
PIXCI = -IA 262144 -IM 786432 -MB 8192
in the registry entry.
Note that 262144 is 256×1024,
and 786432 is (1024-256)×1024.
Note that if this memory allocation method is used, program access to image data may be slower. Thus, the video display rate (and image processing) may be slower, but the video capture rate (such as sequence capture) is not adversely affected. This method of memory allocation is primarily used for video rate acquisition of long sequences, followed by off-line analysis or saving of the sequence.
Use of HLDINST.EXE, as described above, provides automatic installation of the printer port authorization key's driver, needed under Windows Vista or Vista(x64) for XCAP-Plus, XCAP-Std, and XCAP-Ltd (but not needed for XCAP-Lite). The following information allows manual installation, correcting problems, or integration with an OEM's procedures for the printer port version of authorization keys.
C:\WINNT\SYSTEM32\DRIVERS
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock
This key must contain values:
ErrorControl = 0x00000001
Group = "Extended Base"
Start = 0x00000002
Type = 0x00000001
or, if using REGEDT32, the values should appear as:
ErrorControl:REG_DWORD:0x1
Group:REG_SZ:ExtendedBase
Start:REG_DWORD:0x2
Type:REG_DWORD:0x1
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\HardLock\Parameters
which contains a value:
IoPortAddress0 = 0x???? (for REGEDIT)
IoPortAddress0:REG_DWORD:0x???? (for REGEDT32)
where the
''????''
is replaced with the parallel port's I/O address in hexadecimal.
As before, Windows must be shut down and restarted.
XCAP requires Linux Kernel Version 2.4.8 or later. You must have super user privileges to complete the installation procedure.
Some systems mount the CD under/mnt/cdrom/XCAP/xcaplnx_i386.bin (for 32 bit Linux) /mnt/cdrom/XCAP/xcaplnx_x86_64.bin (for 64 bit Linux)
/media
instead of
/mnt.
/usr/local/xcap.
from the EPIX, Inc. ftp site.ftp.epixinc.com/software/xcap_v30/xcaplnx_i386.bin (for 32 bit Linux) ftp.epixinc.com/software/xcap_v30/xcaplnx_x86_64.bin (for 64 bit Linux)
/usr/local/xcap.
.bin
file from your computer's hard drive.
/usr/local/bin,
/usr/bin,
or
/bin
directories, which should already be in the user's execution
''PATH''.
Several
.txt
files are installed under
help
in the installation directory
containing these installation instructions,
a list of distributed files, corrections or additions
to this manual,
or other up-to-date information.
The
pcitips.txt
file provides the
PC Configuration Tips,
with tips for resolving hardware and software conflicts.
xcaplnx
in the XCAP installation directory, such as:
/usr/local/xcap/xcaplnx
assuming use of the default installation directory,
and may use:
/usr/local/xcap/program/xcap20.png
as an icon.
Alternately, XCAP will maintain individual settings and configuration, and individual default storage of images, scripts and other data, within the current working directory.
The printer port authorization key is approximately the size and shape of a printer cable's connector (5.5×4.5×1.6 cm), but having 25-pin connectors at both ends and no cable attached. If provided, connect the authorization key to any printer port. If a printer cable was attached to the printer port, reconnect the printer cable to the back of the authorization key. The authorization key will not affect normal printer operation.
Do not connect the printer port authorization key to a 25-pin serial (RS-232) port, or to any other interface that happens to use the same style connector; the authorization key will not function, might be permanently damaged, and the warranty will be void!
The USB port authorization key is approximately the size of a small finger (6.0×1.6×0.8 cm), having a USB standard 4-pin connector at one end. If provided, connect the authorization key to a USB port. Operating system support for USB devices is required; XCAP does not add USB support to the operating system.
The authorization key must remain attached, to the printer port or USB port as appropriate, while XCAP is running. If the authorization key is missing, or disconnected while XCAP is running, then XCAP-Plus, XCAP-Std or XCAP-Ltd, will behave similar to the XCAP-Lite version; selected image processing and analysis tools will not be operational.
Within XCAP, the current graphics display (S/VGA) configuration can be checked under Utility, Linux Info, X11.
Use of the
Driver Assistant
within XCAP
provides interactive installation
of the
pixci_i386.o
driver in most circumstances.
The following information allows manual installation, correcting problems,
or integration with an OEM's procedures.
insmod -o pixci [ --force ] pixci_i386.o [ "PIXCIPARM=<driver_config_parameters>" ]
using
--force
if trying to install the driver under a different kernel than it was intended,
and using
PIXCIPARM=
to specify any optional Driver Configuration Parameters described below.
For example,
insmod -o pixci [ --force ] pixci_i386.o "PIXCIPARM=-IM 8192"
cat /proc/devices
and note the major device number which is assigned to the
pixci
block device.
Run
rm -f /dev/pixci
mknod /dev/pixci c <major_device_number> 0
chmod 666 /dev/pixci
If embedding these commands into a shell script:
rm -f /dev/pixci
mknod /dev/pixci c $(awk "\\$2==\"PIXCI(R)\" {print \\$1}" /proc/devices) 0
chmod 666 /dev/pixci
lsmod
for a list of currently installed modules and remove any named
videodev,
i2c,
i2c-char,
tuner,
msp3400,
bt878,
or
bttv
by using
rmmod.
Use of the
Driver Assistant
within XCAP
provides interactive installation
of the
pixci_i386.ko
32 bit driver
or the
pixci_x86_64.ko
64 bit driver
in most circumstances.
The following information allows manual installation, correcting problems,
or integration with an OEM's procedures.
insmod pixci_i386.ko [ "PIXCIPARM=<driver_config_parameters>" ]
or
using PIXCIPARM= to specify any optional Driver Configuration Parameters described below. For example,insmod pixci_x86_64.ko [ "PIXCIPARM=<driver_config_parameters>" ]
insmod pixci_i386.ko "PIXCIPARM=-IM 8192 -DM 1"
or
Some versions of insmod under 2.6 kernels do not accept quoted spaces in the Driver Configuration Parameters; an underscore (i.e. ''_'') may be used instead of each space. For example,insmod pixci_x86_64.ko "PIXCIPARM=-IM 8192 -DM 1"
insmod pixci_i386.ko PIXCIPARM=-IM_8192_-DM_1
cat /proc/devices
and note the major device number which is assigned to the
pixci
block device.
Run
rm -f /dev/pixci
mknod /dev/pixci c <major_device_number> 0
chmod 666 /dev/pixci
If embedding these commands into a shell script:
rm -f /dev/pixci
mknod /dev/pixci c $(awk "\\$2==\"PIXCI(R)\" {print \\$1}" /proc/devices) 0
chmod 666 /dev/pixci
lsmod
for a list of currently installed modules and remove any named
videodev,
i2c,
i2c-char,
tuner,
msp3400,
bt878,
or
bttv
by using
rmmod.
Under Linux, frame buffer memory must be allocated during the driver's installation.
The requested frame buffer memory size must be specified in the Driver Configuration Parameters, described above, using parameter
"-IM <memorysize>"
replacing the
''<memorysize>''
with the desired memory size in kBytes.
If no frame buffer memory size is specified,
a default size of 4096 kBytes is used under 32 bit Linux.
32768 kBytes is used under 64 bit Linux.
Optionally,
"-MB <memory_partition_size>"
specifies that the requested
"-IM <memorysize>"
is to be allocated in blocks or partitions of the stated size.
Requesting memory partitioned into blocks may allow receiving
more memory that would be available as a single block.
However,
(a) Each frame buffer must be completely contained within a partition, and
(b) The maximum number of partitions is 256 under 32 bit operating systems,
the maximum number of partitions is 256 under 64 bit operating systems.
Systems with very high resolution cameras using large frame buffers
should choose the partition size carefully, so as to minimize
the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
For the PIXCI® CL3SD, which has on-board frame buffer memory, memory reserved by the -IM parameter is needed only for support of time stamping of captured frames, such as optionally used by Capture - Video to Frame Buffers. Currently, 64 bytes are needed for each frame buffer's status.
Linux limits the maximum amount of allocatable frame buffer memory, dependent upon what other devices are installed, the computer's total memory size, and other factors. Installing the driver immediately after booting Linux improves the likelihood of being able to allocate large amounts of memory.
Linux may provide less frame buffer memory than was requested. If no memory could be allocated, the PIXCI® imaging board will not be available, stating ''Can't allocate frame buffer memory''. Otherwise, within XCAP, the number of available frame buffers can be checked under PIXCI®, PIXCI® Video Setup, Resolution. As the frame buffer memory is allocated once during the driver's initialization; the contents of frame buffers are retained as XCAP is closed and restarted, but lost if the driver is uninstalled or Linux is restarted.
As described above, frame buffer memory allocated by
pixci_i386.o
during its installation may be limited to a small
percentage of the computer's total memory.
A larger frame buffer memory can be obtained by limiting the amount of
memory recognized by Linux, and then instructing
pixci_i386.o
to explicitly use a section of memory without allocating
it from Linux:
/etc/lilo.conf,
restricting Linux to use no more than a set amount of memory:
by copying an existing configuration group, adding mem=XXM
(where XX is the memory size in MByte) to the
''append''
line, and changing the prompt name.
For example, changing:
image=/boot/vmlinuz
label=linux
root=/dev/hda1
append=" devfs=mount"
read-only
to
image=/boot/vmlinuz
label=linux+PIXCI
root=/dev/hda1
append=" devfs=mount mem=64M"
read-only
Add an
''append''
line, such as:
append=" mem=64M"
if not previously present.
When booting, the modified
''label=''
provides a reminder of the modified configuration being selected.
lilo
to compile and install the
/etc/lilo.conf.
-IA <image_memory_adrs_in_kByte>
-IM <size_of_image_memory_in_kByte>
-MB <image_memory_partition_size_in_kByte>
-BH <size_of_BIOS_hole_below_4GB_in_kByte>
In practice, all four fields are on the same line.
The -MB partition size specifies the size into which image memory is partitioned for the sake of virtual memory management: (a) Each frame buffer must be completely contained within a partition, (b) A value of 0 specifies that the entire image memory is to be handled as one partition, and (c) The maximum number of partitions is 256 under 32 bit operating systems. For most systems, a value of 8192 or 16384 is suggested; though the value need not be a power of two. Systems with very high resolution cameras using large frame buffers should choose the partition size carefully, so as to minimize the unusable memory remaining, smaller than a frame buffer, at the end of each partition.
Be careful that the -IA address is equal to (or above) the specified ''mem='' limit - including exact base2 to base10 conversions! (i.e. for mem=64M, the smallest valid value of -IA is 65536, not 64000!). Likewise, be certain that the -IA plus -IM values do not exceed the amount of memory available!
On a computer populated with 4 or more GBytes of memory, some of the memory directly below the 4 GByte address overlaps other hardware resources such as BIOS, memory mapped I/O, PCI configuration space, etc.[9] and is unavailable to either the operating system or for use as frame buffers. The usable frame buffer memory is therefore reduced by the amount by which the -IA address up to the -IA address plus -IM size overlap the 4 GByte address minus -BH size up to the 4 GByte address. The -BH size may be set to 0 (or not specified) if the computer has significantly less than 4 GBytes of memory.
For example, for a computer with 1 GByte of memory, allocating 256 MByte for Linux and the remainder for frame buffer memory, use:
mem=256M
in
lilo.conf,
and use:
-IA 262144 -IM 786432 -MB 8192
in the Driver Configuration Parameters.
Note that 262144 is 256×1024,
and 786432 is (1024-256)×1024.
Some Linux 2.4.x systems may use
grub.conf
or
menu.lst
instead of
lilo.conf
for boot configuration;
see
Linux 2.6.x - Forceful Frame Buffer Memory Allocation
for instructions regarding
grub.conf
or
menu.lst.
As described above, frame buffer memory allocated by
pixci_i386.ko
or
pixci_x86_64.k