PVideoInput1394DcDevice Class Reference

#include <videoio1394dc.h>

Public Member Functions
	PVideoInput1394DcDevice ()
	~PVideoInput1394DcDevice ()
PBoolean	Open (const PString &deviceName, PBoolean startImmediate=PTrue)
PBoolean	IsOpen ()
PBoolean	Close ()
PBoolean	Start ()
PBoolean	Stop ()
PBoolean	IsCapturing ()
PINDEX	GetMaxFrameBytes ()
PBoolean	GetFrameData (BYTE buffer, PINDEX bytesReturned=NULL)
PBoolean	GetFrameDataNoDelay (BYTE buffer, PINDEX bytesReturned=NULL)
int	GetBrightness ()
PBoolean	SetBrightness (unsigned newBrightness)
int	GetWhiteness ()
PBoolean	SetWhiteness (unsigned newWhiteness)
int	GetColour ()
PBoolean	SetColour (unsigned newColour)
int	GetContrast ()
PBoolean	SetContrast (unsigned newContrast)
int	GetHue ()
PBoolean	SetHue (unsigned newHue)
PBoolean	GetParameters (int whiteness, int brightness, int colour, int contrast, int *hue)
PBoolean	GetFrameSizeLimits (unsigned &minWidth, unsigned &minHeight, unsigned &maxWidth, unsigned &maxHeight)
void	ClearMapping ()
int	GetNumChannels ()
PBoolean	SetChannel (int channelNumber)
PBoolean	SetFrameRate (unsigned rate)
PBoolean	SetVideoFormat (VideoFormat videoFormat)
PBoolean	SetFrameSize (unsigned width, unsigned height)
PBoolean	SetColourFormat (const PString &colourFormat)
PBoolean	TestAllFormats ()
PBoolean	SetFrameSizeConverter (unsigned width, unsigned height, PBoolean bScaleNotCrop)
PBoolean	SetColourFormatConverter (const PString &colourFormat)
Static Public Member Functions
static PStringList	GetInputDeviceNames ()
Protected Attributes
raw1394handle_t	handle
PBoolean	is_capturing
PBoolean	UseDMA
nodeid_t *	camera_nodes
int	numCameras
dc1394_cameracapture	camera
int	capturing_duration
PString	desiredColourFormat
unsigned	desiredFrameWidth
unsigned	desiredFrameHeight

Detailed Description

This class defines a video input device that generates fictitous image data.

Constructor & Destructor Documentation

PVideoInput1394DcDevice::PVideoInput1394DcDevice ( )

Create a new video input device.

PVideoInput1394DcDevice::~PVideoInput1394DcDevice ( )

Close the video input device on destruction.

Member Function Documentation

void PVideoInput1394DcDevice::ClearMapping ( )

PBoolean PVideoInput1394DcDevice::Close ( )

Close the device.

int PVideoInput1394DcDevice::GetBrightness ( )

Get the brightness of the image. 0xffff-Very bright.

int PVideoInput1394DcDevice::GetColour ( )

Get the colour of the image. 0xffff-lots of colour.

int PVideoInput1394DcDevice::GetContrast ( )

Get the contrast of the image. 0xffff-High contrast.

PBoolean PVideoInput1394DcDevice::GetFrameData	(	BYTE *	buffer,
		PINDEX *	bytesReturned = `NULL`
	)

Grab a frame, after a delay as specified by the frame rate.

Parameters:

bytesReturned

Buffer to receive frame OPtional bytes returned.

PBoolean PVideoInput1394DcDevice::GetFrameDataNoDelay	(	BYTE *	buffer,
		PINDEX *	bytesReturned = `NULL`
	)

Grab a frame. Do not delay according to the current frame rate parameter.

Parameters:

bytesReturned

Buffer to receive frame OPtional bytes returned.

PBoolean PVideoInput1394DcDevice::GetFrameSizeLimits	(	unsigned &	minWidth,
		unsigned &	minHeight,
		unsigned &	maxWidth,
		unsigned &	maxHeight
	)

Get the minimum & maximum size of a frame on the device.

Parameters:

	minHeight	Variable to receive minimum width
	maxWidth	Variable to receive minimum height
	maxHeight	Variable to receive maximum width Variable to receive maximum height

int PVideoInput1394DcDevice::GetHue ( )

Get the hue of the image. 0xffff-High hue.

static PStringList PVideoInput1394DcDevice::GetInputDeviceNames ( ) [static]

Get a list of all of the drivers available.

PINDEX PVideoInput1394DcDevice::GetMaxFrameBytes ( )

Get the maximum frame size in bytes.

Note a particular device may be able to provide variable length frames (eg motion JPEG) so will be the maximum size of all frames.

int PVideoInput1394DcDevice::GetNumChannels ( )

PBoolean PVideoInput1394DcDevice::GetParameters	(	int *	whiteness,
		int *	brightness,
		int *	colour,
		int *	contrast,
		int *	hue
	)

Return whiteness, brightness, colour, contrast and hue in one call.

int PVideoInput1394DcDevice::GetWhiteness ( )

Get the whiteness of the image. 0xffff-Very white.

PBoolean PVideoInput1394DcDevice::IsCapturing ( )

Determine if the video device I/O capture is in progress.

PBoolean PVideoInput1394DcDevice::IsOpen ( )

Determine of the device is currently open.

PBoolean PVideoInput1394DcDevice::Open	(	const PString &	deviceName,
		PBoolean	startImmediate = `PTrue`
	)

Open the device given the device name.

Parameters:

startImmediate

Device name to open Immediately start device

PBoolean PVideoInput1394DcDevice::SetBrightness ( unsigned newBrightness )

Set brightness of the image. 0xffff-Very bright.

PBoolean PVideoInput1394DcDevice::SetChannel ( int channelNumber )

Parameters:

channelNumber

New channel number for device.

PBoolean PVideoInput1394DcDevice::SetColour ( unsigned newColour )

Set colour of the image. 0xffff-lots of colour.

PBoolean PVideoInput1394DcDevice::SetColourFormat ( const PString & colourFormat )

PBoolean PVideoInput1394DcDevice::SetColourFormatConverter ( const PString & colourFormat )

Set the colour format to be used, trying converters if available.

This function will set the colour format on the device to one that is compatible with a registered converter, and install that converter so that the correct format is used.

PBoolean PVideoInput1394DcDevice::SetContrast ( unsigned newContrast )

Set contrast of the image. 0xffff-High contrast.

PBoolean PVideoInput1394DcDevice::SetFrameRate ( unsigned rate )

Parameters:

rate

Frames per second