LibDC1394-2 based IEEE-1394 Camera Grabber and Control API

Classes
class	icl::io::DCDevice
	Device struct, used by the DCGrabber class to identify devices. More...
class	icl::io::DCDeviceOptions
	Utility struct for DC Camera device options. More...
class	icl::io::dc::DCFrameQueue
	Internal used utility class for fast handling of DMA buffers. More...
class	icl::io::DCGrabber
	Grabber implementation for handling DC-Devices using libdc1394 (Version >= 2.0.rc9) \. More...
class	icl::io::dc::DCGrabberThread
	Internally spawned thread class to provide continuous grabbing without drop frames. More...
Namespaces
namespace	icl::io::dc
	internal used namespace for libdc1394 dependent help functions and classes
Functions
std::string	icl::io::dc::to_string (dc1394video_mode_t vm)
	translate a dc1394video_mode_t into a string representation
std::string	icl::io::dc::to_string (dc1394framerate_t fr)
	translate a dc1394framerate_t into a string representation
std::string	icl::io::dc::to_string (dc1394color_filter_t f)
	translate a dc1394color_filter_t into a string representation
std::string	icl::io::dc::to_string (dc1394bayer_method_t bm)
	translate a dc1394bayer_method_t into a string representation
std::string	icl::io::dc::to_string (dc1394feature_t f)
	translate a dc1394feature_t into a string representation
dc1394video_mode_t	icl::io::dc::videomode_from_string (const std::string &s)
	translate a dc1394video_mode_t from a string representation
dc1394framerate_t	icl::io::dc::framerate_from_string (const std::string &s)
	translate a dc1394framerate_t from a string representation
dc1394bayer_method_t	icl::io::dc::bayermethod_from_string (const std::string &s)
	translate a dc1394bayer_method_t from a string representation
dc1394feature_t	icl::io::dc::feature_from_string (const std::string &s)
	translate a dc1394feature_t from a string representation
const std::vector< std::string > &	icl::io::dc::getListOfAllFeatures ()
	returns a list of all currently implemented dc1394 features
void	icl::io::dc::initialize_dc_cam (dc1394camera_t *c, int nDMABuffers, DCDeviceOptions *options)
	(TODO) sets up a camera to some useful defaults dependent on its model id
void	icl::io::dc::release_dc_cam (dc1394camera_t *c)
	stops the capturing and streaming process
void	icl::io::dc::set_streaming (dc1394camera_t *c, bool on)
	ensures iso streaming of the given camera to have the given state (on or off)
dc1394video_frame_t *	icl::io::dc::get_newest_frame (dc1394camera_t *c)
	gets the newest frame from a given camera
dc1394video_frame_t *	icl::io::dc::get_a_frame (dc1394camera_t *c)
	gets a new frame from the given camera
void	icl::io::dc::extract_image_to (dc1394video_frame_t *f, dc1394color_filter_t bayerLayout, core::ImgBase **ppoDst, const utils::Size &desiredSizeHint, core::format desiredFormatHint, core::depth desiredDepthHint, std::vector< icl8u > &dataBuffer, dc1394bayer_method_t bayerMethod)
	converts a grabbed frame
bool	icl::io::dc::can_extract_image_to (dc1394video_frame_t *f, const utils::Size &desiredSizeHint, core::format desiredFormatHint, core::depth desiredDepthHint)
	determins if the desired parameters can be fullfilled by extract_image_to(..)
void	icl::io::dc::install_signal_handler ()
	creates a signal handler for the SIGINT signal
void	icl::io::dc::free_static_context ()
	(since rc 9 of libdc) releases the static dc-context

---

Function Documentation

dc1394bayer_method_t icl::io::dc::bayermethod_from_string

(

const std::string &

s

)

translate a dc1394bayer_method_t from a string representation

bool icl::io::dc::can_extract_image_to	(	dc1394video_frame_t *	f,
		const utils::Size &	desiredSizeHint,
		core::format	desiredFormatHint,
		core::depth	desiredDepthHint
	)

determins if the desired parameters can be fullfilled by extract_image_to(..)

TODO !!

void icl::io::dc::extract_image_to	(	dc1394video_frame_t *	f,
		dc1394color_filter_t	bayerLayout,
		core::ImgBase **	ppoDst,
		const utils::Size &	desiredSizeHint,
		core::format	desiredFormatHint,
		core::depth	desiredDepthHint,
		std::vector< icl8u > &	dataBuffer,
		dc1394bayer_method_t	bayerMethod
	)

converts a grabbed frame

the desired params are only hints, which can - but do not have to - be regarded !!

dc1394feature_t icl::io::dc::feature_from_string

(

const std::string &

s

)

translate a dc1394feature_t from a string representation

dc1394framerate_t icl::io::dc::framerate_from_string

(

const std::string &

s

)

translate a dc1394framerate_t from a string representation

void icl::io::dc::free_static_context

(

)

(since rc 9 of libdc) releases the static dc-context

E.g. when when trying to access a dc-devices using unicap, after the device was opened by a DCGrabber (note, that getDeviceList must be called)

dc1394video_frame_t* icl::io::dc::get_a_frame

(

dc1394camera_t *

c

)

gets a new frame from the given camera

The camera MUST be initialized, running and streaming

dc1394video_frame_t* icl::io::dc::get_newest_frame

(

dc1394camera_t *

c

)

gets the newest frame from a given camera

Internally this function flushes the ring buffer, queues a brand new frame, and then waits for it to be filled with the newest frame. NOTE:This is not the procedure that is used by the DCGrabber!

const std::vector<std::string>& icl::io::dc::getListOfAllFeatures

(

)

returns a list of all currently implemented dc1394 features

void icl::io::dc::initialize_dc_cam	(	dc1394camera_t *	c,
		int	nDMABuffers,
		DCDeviceOptions *	options
	)

(TODO) sets up a camera to some useful defaults dependent on its model id

void icl::io::dc::install_signal_handler

(

)

creates a signal handler for the SIGINT signal

The signal handler will enshure, that the SIGINT-signal, which is send when CTRL+C is pressed to kill a the programm, is caught. The new signal handler function ensures, that all camera threads are stopped before the programm exits

void icl::io::dc::release_dc_cam

(

dc1394camera_t *

c

)

stops the capturing and streaming process

void icl::io::dc::set_streaming	(	dc1394camera_t *	c,
		bool	on
	)

ensures iso streaming of the given camera to have the given state (on or off)

std::string icl::io::dc::to_string

(

dc1394video_mode_t

vm

)

translate a dc1394video_mode_t into a string representation

std::string icl::io::dc::to_string

(

dc1394framerate_t

fr

)

translate a dc1394framerate_t into a string representation

std::string icl::io::dc::to_string

(

dc1394color_filter_t

f

)

translate a dc1394color_filter_t into a string representation

std::string icl::io::dc::to_string

(

dc1394bayer_method_t

bm

)

translate a dc1394bayer_method_t into a string representation

std::string icl::io::dc::to_string

(

dc1394feature_t

f

)

translate a dc1394feature_t into a string representation

dc1394video_mode_t icl::io::dc::videomode_from_string

(

const std::string &

s

)

translate a dc1394video_mode_t from a string representation