drvFirewireDCAM.h File Reference

Header file for the firewireDCAM module. More...

Go to the source code of this file.

Functions
int	FDC_InitBus (void)
	Initialise the firewire bus. More...
int	FDC_Config (const char *portName, const char *camid, int speed, int maxBuffers, size_t maxMemory, int colour)
	Configuration function to configure one camera. More...
void	FDC_ResetBus ()

Detailed Description

Header file for the firewireDCAM module.

The only functions this module exports are the FDC_InitBus() and FDC_Config() to enable use of them in the IOC shell.

Function Documentation

FDC_Config()

int FDC_Config	(	const char *	portName,
		const char *	camid,
		int	speed,
		int	maxBuffers,
		size_t	maxMemory,
		int	disableScalable
	)

Configuration function to configure one camera.

This function need to be called once for each camera to be used by the IOC. A call to this function instanciates one object from the FirewireDCAM class.

Parameters

portName	Asyn port name to assign to the camera.
camid	The camera ID or serial number in a hexadecimal string. Lower case and upper case letters can be used. This is used to identify a specific camera on the bus. For instance: "0x00b09d01007139d0".
speed	The bus speed to be used. This indicates whether to use the bus in 1394A or 1394B mode. Valid values are: 400 or 800. If an invalid value is entered the function will always default to 400 (legacy mode).
maxBuffers	Maxiumum number of NDArray objects (image buffers) this driver is allowed to allocate. This driver requires 2 buffers, and each queue element in a plugin can require one buffer which will all need to be added up in this parameter.
maxMemory	Maximum memory (in bytes) that this driver is allowed to allocate. So if max. size = 1024x768 (8bpp) and maxBuffers is, say 14. maxMemory = 1024x768x14 = 11010048 bytes (~11MB)
disableScalable	Disable scalable modes if this is 1

FDC_InitBus()

int FDC_InitBus

(

void

)

Initialise the firewire bus.

This function need to be called only once to initialise the firewire bus before FDC_Config() can be called. The bus will be first be reset, then scanned for cameras and the number of cameras and their hexadecimal ID will be printed to stdout.

FDC_ResetBus()

void FDC_ResetBus

(

)