org.bytedeco.javacv

Class PS3EyeFrameGrabber

java.lang.Object

org.bytedeco.javacv.FrameGrabber

org.bytedeco.javacv.PS3EyeFrameGrabber

All Implemented Interfaces:

Closeable, AutoCloseable

public class PS3EyeFrameGrabber
extends FrameGrabber

Minimal Sony PS3 Eye camera grabber implementation. It allows grabbing of frames at higher speed than OpenCVFrameGrabber or VideoInputFrameGrabber. Underlying implementation of last two grabbers is limited to 30 FPS. PS3 allows grabbing at maximum speed of 75 FPS in VGA and 187 FPS in QVGA modes. This code was developed and tested with CLEyeMulticam.dll, version 1.2.0.1008. The dll library is part of Code Laboratories CL-Eye Platform SDK and is distributed as part of CLEyeMulticam Redistributable Dynamic Link Library. For license, download and installation see http://www.codelaboratories.com. The grab() method returns an internal instance of IplImage image with fresh camera frame. This returned image have to be considered "read only" and the caller needs to create it's own copy or clone that image. Calling of release() method for this image shall be avoided. Based on used resolution the image is in format either 640x480 or 320x240, IPL_DEPTH_8U, 4 channel (color) or 1 channel (gray). timestamp is set to actual value of System.nanoTime()/1000 obtained after return from the CL driver. Typical use case scenario: create new instance of PS3MiniGrabber set camera parameters start() grabber wait at least 2 frames grab() in loop stop() grabber release() internal resources Note: This code depends on the cl.eye.CLCamera class from Code Laboratories CL-Eye Platform SDK. It is suggested to download SDK and edit the sample file ....\cl\eye\CLCamera.java. A few references to processing.core.PApplet class shall be removed and the file recompiled. The tailored file is not included here namely because of unclear licence.

Author:

jmasa, jmasa@cmail.cz

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	PS3EyeFrameGrabber.Triggered

Nested classes/interfaces inherited from class org.bytedeco.javacv.FrameGrabber

FrameGrabber.Array, FrameGrabber.Exception, FrameGrabber.ImageMode, FrameGrabber.PropertyEditor, FrameGrabber.SampleMode

Field Summary

Fields

Modifier and Type	Field and Description
protected PS3EyeFrameGrabber.Triggered	triggered

Fields inherited from class org.bytedeco.javacv.FrameGrabber

aspectRatio, audioBitrate, audioChannels, audioCodec, audioMetadata, audioOptions, audioStream, bpp, deinterlace, format, frameNumber, frameRate, gamma, imageHeight, imageMode, imageWidth, list, maxDelay, metadata, numBuffers, options, pixelFormat, sampleFormat, sampleMode, sampleRate, SENSOR_PATTERN_BGGR, SENSOR_PATTERN_GBRG, SENSOR_PATTERN_GRBG, SENSOR_PATTERN_RGGB, sensorPattern, timeout, timestamp, triggerMode, videoBitrate, videoCodec, videoMetadata, videoOptions, videoStream

Constructor Summary

Constructors

Constructor and Description
PS3EyeFrameGrabber() Default grabber, camera idx = 0, color mode, VGA resolution, 60 FPS frame rate.
PS3EyeFrameGrabber(int cameraIndex) Color mode, VGA resolution, 60 FPS frame rate.
PS3EyeFrameGrabber(int cameraIndex, int imageWidth, int imageHeight, int framerate)
PS3EyeFrameGrabber(int cameraIndex, int imageWidth, int imageHeight, int framerate, Object applet) Creates grabber, the caller can control basic image and grabbing parameters.

Method Summary

Modifier and Type	Method and Description
static PS3EyeFrameGrabber	createDefault(File deviceFile)
static PS3EyeFrameGrabber	createDefault(int deviceNumber)
static PS3EyeFrameGrabber	createDefault(String devicePath)
void	dispose() Release internal resources, the same as calling release()
protected void	finalize()
CLCamera	getCamera() Return internal CLCamera object, mainly to set camera parameters, changing camera parameters must be done on stopped camera and before start() is called.
static int	getCameraCount()
static String[]	getDeviceDescriptions()
String	getUUID()
int[]	grab_raw() Grab one frame and return it as int[] (in the internal camera format RGBA).
opencv_core.IplImage	grab_RGB4() Grab and convert one frame, default timeout is (1 + 1000/framerate) [milliseconds].
Frame	grab() Grab one frame; the caller have to make a copy of returned image before processing.
static String[]	listPS3Cameras() Ask the driver for all installed PS3 cameras.
static void	main(String[] argv) Just for testing - loads the CL CLEyeMulticam.dll file, invokes driver and lists available cameras.
opencv_core.IplImage	makeImage(int[] frame) Make IplImage form raw int[] frame data Note: NO array size checks!!
void	release() Release resources: - CL driver internal resources binded with camera HW - internal IplImage After calling this function, this mini-grabber object instance can not be used anymore.
void	start() Start camera first (before grabbing).
void	stop() Stop camera.
String	toString()
void	trigger()
static void	tryLoad()

Methods inherited from class org.bytedeco.javacv.FrameGrabber

close, create, create, create, create, createArray, delayedGrab, flush, get, getAspectRatio, getAudioBitrate, getAudioChannels, getAudioCodec, getAudioMetadata, getAudioMetadata, getAudioOption, getAudioOptions, getAudioStream, getBitsPerPixel, getDefault, getDelayedFrame, getDelayedTime, getFormat, getFrameNumber, getFrameRate, getGamma, getImageHeight, getImageMode, getImageWidth, getLengthInFrames, getLengthInTime, getMaxDelay, getMetadata, getMetadata, getNumBuffers, getOption, getOptions, getPixelFormat, getSampleFormat, getSampleMode, getSampleRate, getSensorPattern, getTimeout, getTimestamp, getVideoBitrate, getVideoCodec, getVideoMetadata, getVideoMetadata, getVideoOption, getVideoOptions, getVideoStream, grabFrame, init, isDeinterlace, isTriggerMode, restart, setAspectRatio, setAudioBitrate, setAudioChannels, setAudioCodec, setAudioMetadata, setAudioMetadata, setAudioOption, setAudioOptions, setAudioStream, setBitsPerPixel, setDeinterlace, setFormat, setFrameNumber, setFrameRate, setGamma, setImageHeight, setImageMode, setImageWidth, setMaxDelay, setMetadata, setMetadata, setNumBuffers, setOption, setOptions, setPixelFormat, setSampleFormat, setSampleMode, setSampleRate, setSensorPattern, setTimeout, setTimestamp, setTriggerMode, setVideoBitrate, setVideoCodec, setVideoMetadata, setVideoMetadata, setVideoOption, setVideoOptions, setVideoStream

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

triggered

protected PS3EyeFrameGrabber.Triggered triggered

Constructor Detail

PS3EyeFrameGrabber

public PS3EyeFrameGrabber()
                   throws FrameGrabber.Exception

Default grabber, camera idx = 0, color mode, VGA resolution, 60 FPS frame rate.

Throws:

FrameGrabber.Exception

PS3EyeFrameGrabber

public PS3EyeFrameGrabber(int cameraIndex)
                   throws FrameGrabber.Exception

Color mode, VGA resolution, 60 FPS frame rate.

Parameters:

system - wide camera index

Throws:

FrameGrabber.Exception

PS3EyeFrameGrabber

public PS3EyeFrameGrabber(int cameraIndex,
                          int imageWidth,
                          int imageHeight,
                          int framerate)
                   throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

PS3EyeFrameGrabber

public PS3EyeFrameGrabber(int cameraIndex,
                          int imageWidth,
                          int imageHeight,
                          int framerate,
                          Object applet)
                   throws FrameGrabber.Exception

Creates grabber, the caller can control basic image and grabbing parameters.

Parameters:

cameraIndex - - zero based index of used camera (OS system wide)

imageWidth - - width of image

imageHeight - - height of image

framerate - - frame rate - see CLCamera for allowed frame rates based on resolution

applet - - PApplet object required by CLCamera

Throws:

Exception - - if parameters don't follow CLCamera definition or camera is not created

FrameGrabber.Exception

Method Detail

getDeviceDescriptions

public static String[] getDeviceDescriptions()
                                      throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static PS3EyeFrameGrabber createDefault(File deviceFile)
                                        throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static PS3EyeFrameGrabber createDefault(String devicePath)
                                        throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

createDefault

public static PS3EyeFrameGrabber createDefault(int deviceNumber)
                                        throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

tryLoad

public static void tryLoad()
                    throws FrameGrabber.Exception

Throws:

FrameGrabber.Exception

getCameraCount

public static int getCameraCount()

Returns:

system wide number of installed/detected Sony PS3 Eye cameras

listPS3Cameras

public static String[] listPS3Cameras()

Ask the driver for all installed PS3 cameras. Resulting array is sorted in order of camera index. Its size is defined by CLCamera.cameraCount().

Returns:

array of camera unique uuids or null if there is no PS3 camera

makeImage

public opencv_core.IplImage makeImage(int[] frame)

Make IplImage form raw int[] frame data Note: NO array size checks!!

Parameters:

frame - int[] image frame data

Returns:

internal IplImage set to frame

grab_raw

public int[] grab_raw()

Grab one frame and return it as int[] (in the internal camera format RGBA). Note: use makeImage() to create RGBA, 4-ch image

Returns:

frame as int[] without any processing or null if frame is not available

trigger

public void trigger()
             throws FrameGrabber.Exception

Specified by:

trigger in class FrameGrabber

Throws:

FrameGrabber.Exception

grab_RGB4

public opencv_core.IplImage grab_RGB4()

Grab and convert one frame, default timeout is (1 + 1000/framerate) [milliseconds]. Every successful call returns an internal (preallocated) 640x480 or 320x240, IPL_DEPTH_8U, 4-channel image. The caller shall consider it "read only" and make a copy/clone of it before further processing. The call might block for timeout [milliseconds].

Returns:

the image or null if there is no new image

grab

public Frame grab()
           throws FrameGrabber.Exception

Grab one frame; the caller have to make a copy of returned image before processing. It will throw null pointer exception if not started before grabbing.

Specified by:

grab in class FrameGrabber

Returns:

"read-only" RGB, 4-channel or GRAY/1-channel image, it throws exception if no image is available

Throws:

FrameGrabber.Exception

start

public void start()
           throws FrameGrabber.Exception

Start camera first (before grabbing).

Specified by:

start in class FrameGrabber

Throws:

FrameGrabber.Exception

stop

public void stop()
          throws FrameGrabber.Exception

Stop camera. It can be re-started if needed.

Specified by:

stop in class FrameGrabber

Throws:

FrameGrabber.Exception

release

public void release()

Release resources: - CL driver internal resources binded with camera HW - internal IplImage After calling this function, this mini-grabber object instance can not be used anymore.

Specified by:

release in class FrameGrabber

dispose

public void dispose()

Release internal resources, the same as calling release()

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

getCamera

public CLCamera getCamera()

Return internal CLCamera object, mainly to set camera parameters, changing camera parameters must be done on stopped camera and before start() is called. See CL SDK - setCameraParameter(int param, int val) function.

Returns:

internal CLCamera instance

getUUID

public String getUUID()

toString

public String toString()

Overrides:

toString in class Object

Returns:

status and camera parameters of the grabber

main

public static void main(String[] argv)

Just for testing - loads the CL CLEyeMulticam.dll file, invokes driver and lists available cameras.

Parameters:

argv - - argv is not used