Using The Imaging Source Video Devices on Linux

This page explains how to use devices manufactured by The Imaging Source on the Linux operating system.

Please note that unicap is developed and maintained independently of The Imaging Source. Support questions should be directed to the Support Forums. This page is for your information only and the information provided might be incorrect. Please contact the camera vendor for an official statement on the Linux support of their cameras.

Licensing

unicap is licensed under the terms and conditions of the GPL license. As a consequence, you are not allowed to use the library in any kind of closed source software.

unicap and video-4-linux ( and libdc1394 )

unicap is a library for an interface-independend access to video capture devices. video-4-linux and libdc1394 are two interfaces to video capture devices which are used by many existing applications.

Not all devices manufactured by The Imaging Source support either video-4-linux or libdc1394. If you have an application requiring support for one of those interfaces, please check the end of this document for information on the interfaces available for your device.

Information on Specific Devices

The Imaging Source USB CCD Cameras ( AU/BU Series )

These cameras are UVC compliant but they have a vendor specific interface class specified in the USB descriptors. Due to this, the uvcvideo driver does not detect these cameras.

To make the uvcvideo driver detect these cameras, a patch has to be applied ( available for download below ). The patch has been submitted to the uvcvideo maintainer and will be included in a future kernel version. With the patch applied, the cameras will be accessible via the video-4-linux-2 interface and thus can be used by unicap or any other application. Please see the end of this page for instructions on how to patch the uvcvideo driver.

The Imaging Source USB CMOS Cameras ( AUC/BUC Series )

These cameras are not UVC compliant but the protocol they use is similar to UVC. Due to chipset restrictions, the camera requires several unclean hacks to the UVC implementation to function. For the WVGA ( Dxx 21UC03 ) cameras, a special UVC compliant firmware with limited functionality is available.

unicap supports the USB CMOS cameras via a custom usbdevfs driver. This driver provides most of the functionality of the The Imaging Source windows drivers.

To be able to use these cameras with the video-4-linux-2 interface, the uvcvideo driver can be patched to detect these cameras and to work around some of the issues. The required patch is available for download below. Please see the end of this page for instructions on how to patch the uvcvideo driver. This patch will not go into the mainlaine kernel because of the ugliness of required hacks.

With the patch applied, the WVGA CMOS ( Dxx21UC03 cameras ) will provide streaming video with the color formats BY8 and Y800 ( ie. RAW Bayer and Monochrome ) images. To get a color image from these cameras, the application needs to process the image data ( debayering ). ucview is able to do this with the "Debayer plugin".

Limitations of The Imaging Source CMOS cameras with the uvcvideo driver

The Imaging Source GigE Vision Cameras

A unicap driver for this camera is currently being worked on.

The Imaging Source Video Converters

The DFG/USB2-lt video converter is not supported by any Linux driver and support is not planned.

The DFG/1394-1e video converter is supported by unicap and should require no additional installation step despite a working IEEE1394 ( Firewire ) setup which is present in all recent Linux distributions.

The Imaging Source Firewire Cameras

All The Imaging Source Firewire cameras are supported by unicap and should require no additional installation.

The cameras should also work fine with the libdc1394 library. Please note that since unicap does not use libdc1394, the libdc1394 compatibility of the cameras is not tested and neither The Imaging Source nor unicap-imaging can give software support for this library. Please refer to the libdc1394 project homepage for support options.

How To Patch uvcvideo

Please note: The use of the media_build branch in production environment is not recommended by its maintainers. Be aware that you may break your system installation by running the instructions below. Test the updated installation extensively before using it in a production environment.

To update and patch uvcvideo with a running kernel ( eg. the kernel provided by your distribution ), you can use the media_build.git repository from linuxtv.org. To use this repository, follow the instructions here: media_build.git repository.

After cloning the repository, download and apply one of the patches below. To apply the patch, run the following commands:

	    cd media_build
	    cd linux
	    patch -p1 < uvcvideo_add_tis_cmos.patch
	  
Then rebuild the driver by running "make" in the media_build directory. As a last step run "make install" ( you may need to be root to do this ).

The driver will need to be reinstalled after a kernel update. You may need to remove the file "v4l/.version" before recompiling/reinstalling the patched driver after a kernel update.

For support on the driver installation, please go to the forums.

Supported Devices List

The list shows which devices are supported by unicap and/or directly via either video-4-linux or libdc1394.

  Vendor Device unicap video-4-linux libdc1394
    The Imaging Source DMK 21AF04/31AF03/41AF02
DFK 21AF04/31AF03/41AF02
DMK 21BF04/31BF03/41BF02
DFK 21BF04/31BF03/41BF02
X - X
    The Imaging Source DMK 21AF04-Z2/31AF03-Z2
DFK 21AF04-Z2/31AF03-Z2
DMK 21BF04-Z2/31BF03-Z2
DFK 21BF04-Z2/31BF03-Z2
X - X
    The Imaging Source DMK 21AU04/31AU03/41AU02
DFK 21AU04/31AU03/41AU02
DMK 21BU04/31BU03/41BU02
DFK 21BU04/31BU03/41BU02
(with uvcvideo patch)
X X -
    The Imaging Source DMK 21AUC03/21BUC03
DFK 21AUC03/21BUC03
DFK 71AUC02/71BUC02
DMK 71AUC02/71BUC02
X - -
    The Imaging Source DMK 21AUC03/21BUC03
DFK 21AUC03/21BUC03
DFK 71AUC02/71BUC02
DMK 71AUC02/71BUC02
(with uvcvideo patch)
X X -
    The Imaging Source DFG/1394-1e
X - -
    The Imaging Source DFG/USB2-lt
- - -
Downloads
     Download icon uvcvideo_add_tis_ccd.patch   [1 kB, patch]
      uvcvideo patch to add support for TIS CCD cameras
 
     Download icon uvcvideo_add_tis_cmos.patch   [11 kB, patch]
      uvcvideo patch to add support for TIS CMOS cameras