Image Component Library (ICL)
Namespaces | Classes | Functions
LibDC1394-2 based IEEE-1394 Camera Grabber and Control API

Namespaces

 icl::io::dc
 internal used namespace for libdc1394 dependent help functions and classes
 

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...
 

Functions

std::string icl::io::dc::to_string (dc1394video_mode_t vm)
 translate a dc1394video_mode_t into a string representation More...
 
std::string icl::io::dc::to_string (dc1394framerate_t fr)
 translate a dc1394framerate_t into a string representation More...
 
std::string icl::io::dc::to_string (dc1394color_filter_t f)
 translate a dc1394color_filter_t into a string representation More...
 
std::string icl::io::dc::to_string (dc1394bayer_method_t bm)
 translate a dc1394bayer_method_t into a string representation More...
 
std::string icl::io::dc::to_string (dc1394feature_t f)
 translate a dc1394feature_t into a string representation More...
 
dc1394video_mode_t icl::io::dc::videomode_from_string (const std::string &s)
 translate a dc1394video_mode_t from a string representation More...
 
dc1394framerate_t icl::io::dc::framerate_from_string (const std::string &s)
 translate a dc1394framerate_t from a string representation More...
 
dc1394bayer_method_t icl::io::dc::bayermethod_from_string (const std::string &s)
 translate a dc1394bayer_method_t from a string representation More...
 
dc1394feature_t icl::io::dc::feature_from_string (const std::string &s)
 translate a dc1394feature_t from a string representation More...
 
const std::vector< std::string > & icl::io::dc::getListOfAllFeatures ()
 returns a list of all currently implemented dc1394 features More...
 
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 More...
 
void icl::io::dc::release_dc_cam (dc1394camera_t *c)
 stops the capturing and streaming process More...
 
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) More...
 
dc1394video_frame_t * icl::io::dc::get_newest_frame (dc1394camera_t *c)
 gets the newest frame from a given camera More...
 
dc1394video_frame_t * icl::io::dc::get_a_frame (dc1394camera_t *c)
 gets a new frame from the given camera More...
 
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 More...
 
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(..) More...
 
void icl::io::dc::install_signal_handler ()
 creates a signal handler for the SIGINT signal More...
 
void icl::io::dc::free_static_context ()
 (since rc 9 of libdc) releases the static dc-context More...
 

Detailed Description

Function Documentation

◆ bayermethod_from_string()

dc1394bayer_method_t icl::io::dc::bayermethod_from_string ( const std::string &  s)

translate a dc1394bayer_method_t from a string representation

◆ can_extract_image_to()

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 !!

◆ extract_image_to()

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 !!

◆ feature_from_string()

dc1394feature_t icl::io::dc::feature_from_string ( const std::string &  s)

translate a dc1394feature_t from a string representation

◆ framerate_from_string()

dc1394framerate_t icl::io::dc::framerate_from_string ( const std::string &  s)

translate a dc1394framerate_t from a string representation

◆ free_static_context()

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)

◆ get_a_frame()

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

◆ get_newest_frame()

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!

◆ getListOfAllFeatures()

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

returns a list of all currently implemented dc1394 features

◆ initialize_dc_cam()

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

◆ install_signal_handler()

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

◆ release_dc_cam()

void icl::io::dc::release_dc_cam ( dc1394camera_t *  c)

stops the capturing and streaming process

◆ set_streaming()

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)

◆ to_string() [1/5]

std::string icl::io::dc::to_string ( dc1394video_mode_t  vm)

translate a dc1394video_mode_t into a string representation

◆ to_string() [2/5]

std::string icl::io::dc::to_string ( dc1394framerate_t  fr)

translate a dc1394framerate_t into a string representation

◆ to_string() [3/5]

std::string icl::io::dc::to_string ( dc1394color_filter_t  f)

translate a dc1394color_filter_t into a string representation

◆ to_string() [4/5]

std::string icl::io::dc::to_string ( dc1394bayer_method_t  bm)

translate a dc1394bayer_method_t into a string representation

◆ to_string() [5/5]

std::string icl::io::dc::to_string ( dc1394feature_t  f)

translate a dc1394feature_t into a string representation

◆ videomode_from_string()

dc1394video_mode_t icl::io::dc::videomode_from_string ( const std::string &  s)

translate a dc1394video_mode_t from a string representation