processing.video

Class Capture

java.lang.Object

processing.core.PImage

processing.video.Capture

All Implemented Interfaces:

Cloneable, PConstants

public class Capture
extends PImage
implements PConstants

( begin auto-generated from Capture.xml ) Datatype for storing and manipulating video frames from an attached capture device such as a camera. Use Capture.list() to show the names of any attached devices. Using the version of the constructor without name will attempt to use the last device used by a QuickTime program. ( end auto-generated )

Advanced

Class for storing and manipulating video frames from an attached capture device such as a camera.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	available
protected Object	bufferSink
protected int	bufHeight
protected int	bufWidth
protected Method	captureEventMethod
protected boolean	capturing
protected String	copyMask
protected int[]	copyPixels
protected static String	devicePropertyName
protected Object	eventHandler
protected boolean	firstFrame
float	frameRate
protected String	frameRateString
protected static String	indexPropertyName
protected org.gstreamer.Buffer	natBuffer
protected org.gstreamer.elements.BufferDataAppSink	natSink
protected boolean	newFrame
protected boolean	outdatedPixels
org.gstreamer.Pipeline	pipeline
protected boolean	pipelineReady
protected int	reqHeight
protected int	reqWidth
protected org.gstreamer.elements.RGBDataAppSink	rgbSink
protected Method	sinkCopyMethod
protected Method	sinkDisposeMethod
protected Method	sinkGetMethod
protected Method	sinkSetMethod
protected org.gstreamer.Element	sourceElement
protected static String	sourceElementName
protected String	sourceName
protected boolean	useBufferSink
protected static boolean	useResMacHack

Fields inherited from class processing.core.PImage

ALPHA_MASK, BLUE_MASK, format, GREEN_MASK, height, loaded, modified, mx1, mx2, my1, my2, parent, pixelDensity, pixelHeight, pixels, pixelWidth, RED_MASK, saveImageFormats, width

Fields inherited from interface processing.core.PConstants

ADD, ALPHA, ALT, AMBIENT, ARC, ARGB, ARROW, BACKSPACE, BASELINE, BEVEL, BEZIER_VERTEX, BLEND, BLUR, BOTTOM, BOX, BREAK, BURN, CENTER, CHATTER, CHORD, CLAMP, CLOSE, CODED, COMPLAINT, CONTROL, CORNER, CORNERS, CROSS, CURVE_VERTEX, CUSTOM, DARKEST, DEG_TO_RAD, DELETE, DIAMETER, DIFFERENCE, DILATE, DIRECTIONAL, DISABLE_BUFFER_READING, DISABLE_DEPTH_MASK, DISABLE_DEPTH_SORT, DISABLE_DEPTH_TEST, DISABLE_NATIVE_FONTS, DISABLE_OPENGL_ERRORS, DISABLE_OPTIMIZED_STROKE, DISABLE_STROKE_PERSPECTIVE, DISABLE_STROKE_PURE, DISABLE_TEXTURE_MIPMAPS, DODGE, DOWN, DXF, ELLIPSE, ENABLE_BUFFER_READING, ENABLE_DEPTH_MASK, ENABLE_DEPTH_SORT, ENABLE_DEPTH_TEST, ENABLE_NATIVE_FONTS, ENABLE_OPENGL_ERRORS, ENABLE_OPTIMIZED_STROKE, ENABLE_STROKE_PERSPECTIVE, ENABLE_STROKE_PURE, ENABLE_TEXTURE_MIPMAPS, ENTER, EPSILON, ERODE, ESC, EXCLUSION, FX2D, GIF, GRAY, GROUP, HALF_PI, HAND, HARD_LIGHT, HINT_COUNT, HSB, IMAGE, INVERT, JAVA2D, JPEG, LANDSCAPE, LEFT, LIGHTEST, LINE, LINE_LOOP, LINE_STRIP, LINES, LINUX, MACOSX, MAX_FLOAT, MAX_INT, MIN_FLOAT, MIN_INT, MITER, MODEL, MODELVIEW, MOVE, MULTIPLY, NORMAL, OPAQUE, OPEN, OPENGL, ORTHOGRAPHIC, OTHER, OVERLAY, P2D, P3D, PATH, PDF, PERSPECTIVE, PI, PIE, platformNames, POINT, POINTS, POLYGON, PORTRAIT, POSTERIZE, PROBLEM, PROJECT, PROJECTION, QUAD, QUAD_BEZIER_VERTEX, QUAD_STRIP, QUADRATIC_VERTEX, QUADS, QUARTER_PI, RAD_TO_DEG, RADIUS, RECT, REPEAT, REPLACE, RETURN, RGB, RIGHT, ROUND, SCREEN, SHAPE, SHIFT, SOFT_LIGHT, SPAN, SPHERE, SPOT, SQUARE, SUBTRACT, SVG, TAB, TARGA, TAU, TEXT, THIRD_PI, THRESHOLD, TIFF, TOP, TRIANGLE, TRIANGLE_FAN, TRIANGLE_STRIP, TRIANGLES, TWO_PI, UP, VERTEX, WAIT, WHITESPACE, WINDOWS, X, Y, Z

Constructor Summary

Constructors

Constructor and Description
Capture(PApplet parent)
Capture(PApplet parent, int requestWidth, int requestHeight)
Capture(PApplet parent, int requestWidth, int requestHeight, int frameRate) Advanced
Capture(PApplet parent, int requestWidth, int requestHeight, String cameraName) Advanced
Capture(PApplet parent, int requestWidth, int requestHeight, String cameraName, int frameRate) Advanced
Capture(PApplet parent, String requestConfig)

Method Summary

Modifier and Type	Method and Description
protected static void	addResFromSource(ArrayList<String> res, org.gstreamer.Element src)
protected static void	addResFromSourceImpl(ArrayList<String> res, org.gstreamer.Element src)
protected static void	addResFromSourceMacHack(ArrayList<String> res, org.gstreamer.Element src)
protected static void	addResFromString(ArrayList<String> res, String str, int w, int h)
protected static void	addResFromStructure(ArrayList<String> res, org.gstreamer.Structure str, int w, int h)
boolean	available() ( begin auto-generated from Capture_available.xml ) Returns "true" when a new video frame is available to read.
protected void	checkResIsValid()
protected void	checkValidDevices(String src)
void	dispose() Disposes all the native resources associated to this capture device.
void	disposeBuffer(Object buf) NOTE: This is not official API and may/will be removed at any time.
protected void	finalize() Finalizer of the class.
int	get(int x, int y)
protected String	getFrameRate(String config)
protected void	getImpl(int sourceX, int sourceY, int sourceWidth, int sourceHeight, PImage target, int targetX, int targetY)
protected String	getName(String config)
protected void	getSinkMethods()
protected int[]	getSize(String config)
protected float	getSourceFrameRate()
boolean	hasBufferSink() NOTE: This is not official API and may/will be removed at any time.
protected void	initCopyMask()
protected void	initGStreamer(PApplet parent, int rw, int rh, String src, String idName, Object idValue, String fps)
protected void	initPipeline()
protected void	invokeEvent(int w, int h, org.gstreamer.Buffer buffer)
protected void	invokeEvent(int w, int h, IntBuffer buffer) invokeEvent() and read() are synchronized so that they can not be called simultaneously.
static String[]	list() ( begin auto-generated from Capture_list.xml ) Gets a list of all available capture devices such as a camera.
protected static String[]	list(String sourceName, String propertyName)
protected static ArrayList<String>	listDevices(String sourceName, String propertyName)
protected static ArrayList<String>	listResolutions(String sourceName, String propertyName, Object propertyValue)
void	loadPixels()
protected static String	makeResolutionString(int width, int height, int fpsNumerator, int fpsDenominator)
protected static String	makeResolutionString(int width, int height, String fpsStr)
void	post()
void	read() ( begin auto-generated from Capture_read.xml ) Reads the current video frame.
void	setBufferSink(Object sink) Sets the object to use as destination for the frames read from the stream.
void	setBufferSink(Object sink, String mask) Sets the object to use as destination for the frames read from the stream.
protected void	setEventHandlerObject(Object obj) Uses a generic object as handler of the capture.
void	start() ( begin auto-generated from Capture_start.xml ) Starts capturing frames from the selected device.
void	stop() ( begin auto-generated from Capture_stop.xml ) Stops capturing frames from an attached device.
protected boolean	validRes(String res)

Methods inherited from class processing.core.PImage

blend, blend, blendColor, blurAlpha, blurARGB, blurRGB, buildBlurKernel, checkAlpha, clone, copy, copy, copy, dilate, erode, filter, filter, get, get, getImage, getModifiedX1, getModifiedX2, getModifiedY1, getModifiedY2, getNative, init, init, isLoaded, isModified, loadTIFF, mask, mask, opaque, resize, save, saveImageIO, saveTGA, saveTIFF, set, set, setImpl, setLoaded, setLoaded, setModified, setModified, updatePixels, updatePixels

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sourceElementName

protected static String sourceElementName

devicePropertyName

protected static String devicePropertyName

indexPropertyName

protected static String indexPropertyName

useResMacHack

protected static boolean useResMacHack

frameRate

public float frameRate

pipeline

public org.gstreamer.Pipeline pipeline

capturing

protected boolean capturing

frameRateString

protected String frameRateString

bufWidth

protected int bufWidth

bufHeight

protected int bufHeight

sourceName

protected String sourceName

sourceElement

protected org.gstreamer.Element sourceElement

captureEventMethod

protected Method captureEventMethod

eventHandler

protected Object eventHandler

available

protected boolean available

pipelineReady

protected boolean pipelineReady

newFrame

protected boolean newFrame

rgbSink

protected org.gstreamer.elements.RGBDataAppSink rgbSink

copyPixels

protected int[] copyPixels

firstFrame

protected boolean firstFrame

reqWidth

protected int reqWidth

reqHeight

protected int reqHeight

useBufferSink

protected boolean useBufferSink

outdatedPixels

protected boolean outdatedPixels

bufferSink

protected Object bufferSink

sinkCopyMethod

protected Method sinkCopyMethod

sinkSetMethod

protected Method sinkSetMethod

sinkDisposeMethod

protected Method sinkDisposeMethod

sinkGetMethod

protected Method sinkGetMethod

copyMask

protected String copyMask

natBuffer

protected org.gstreamer.Buffer natBuffer

natSink

protected org.gstreamer.elements.BufferDataAppSink natSink

Constructor Detail

Capture

public Capture(PApplet parent)

Capture

public Capture(PApplet parent,
               String requestConfig)

Capture

public Capture(PApplet parent,
               int requestWidth,
               int requestHeight)

Parameters:

parent - typically use "this"

requestWidth - width of the frame

requestHeight - height of the frame

Capture

public Capture(PApplet parent,
               int requestWidth,
               int requestHeight,
               int frameRate)

Advanced

Constructor that takes resolution and framerate.

Parameters:

frameRate - number of frames to read per second

Capture

public Capture(PApplet parent,
               int requestWidth,
               int requestHeight,
               String cameraName)

Advanced

This constructor allows to specify resolution and camera name.

Parameters:

cameraName - name of the camera

Capture

public Capture(PApplet parent,
               int requestWidth,
               int requestHeight,
               String cameraName,
               int frameRate)

Advanced

This constructor allows to specify the camera name and the desired framerate, in addition to the resolution.

Method Detail

dispose

public void dispose()

Disposes all the native resources associated to this capture device. NOTE: This is not official API and may/will be removed at any time.

finalize

protected void finalize()
                 throws Throwable

Finalizer of the class.

Overrides:

finalize in class Object

Throws:

Throwable

available

public boolean available()

( begin auto-generated from Capture_available.xml ) Returns "true" when a new video frame is available to read. ( end auto-generated )

start

public void start()

( begin auto-generated from Capture_start.xml ) Starts capturing frames from the selected device. ( end auto-generated )

stop

public void stop()

( begin auto-generated from Capture_stop.xml ) Stops capturing frames from an attached device. ( end auto-generated )

read

public void read()

( begin auto-generated from Capture_read.xml ) Reads the current video frame. ( end auto-generated )

Advanced

This method() and invokeEvent() are now synchronized, so that invokeEvent() can't be called whilst we're busy reading. Problematic frame error fixed by Charl P. Botha

loadPixels

public void loadPixels()

Overrides:

loadPixels in class PImage

get

public int get(int x,
               int y)

Overrides:

get in class PImage

getImpl

protected void getImpl(int sourceX,
                       int sourceY,
                       int sourceWidth,
                       int sourceHeight,
                       PImage target,
                       int targetX,
                       int targetY)

Overrides:

getImpl in class PImage

list

public static String[] list()

( begin auto-generated from Capture_list.xml ) Gets a list of all available capture devices such as a camera. Use print() to write the information to the text window. ( end auto-generated )

list

protected static String[] list(String sourceName,
                               String propertyName)

listDevices

protected static ArrayList<String> listDevices(String sourceName,
                                               String propertyName)

listResolutions

protected static ArrayList<String> listResolutions(String sourceName,
                                                   String propertyName,
                                                   Object propertyValue)

addResFromSource

protected static void addResFromSource(ArrayList<String> res,
                                       org.gstreamer.Element src)

addResFromSourceImpl

protected static void addResFromSourceImpl(ArrayList<String> res,
                                           org.gstreamer.Element src)

addResFromSourceMacHack

protected static void addResFromSourceMacHack(ArrayList<String> res,
                                              org.gstreamer.Element src)

addResFromString

protected static void addResFromString(ArrayList<String> res,
                                       String str,
                                       int w,
                                       int h)

addResFromStructure

protected static void addResFromStructure(ArrayList<String> res,
                                          org.gstreamer.Structure str,
                                          int w,
                                          int h)

makeResolutionString

protected static String makeResolutionString(int width,
                                             int height,
                                             int fpsNumerator,
                                             int fpsDenominator)

makeResolutionString

protected static String makeResolutionString(int width,
                                             int height,
                                             String fpsStr)

checkResIsValid

protected void checkResIsValid()

checkValidDevices

protected void checkValidDevices(String src)

validRes

protected boolean validRes(String res)

initGStreamer

protected void initGStreamer(PApplet parent,
                             int rw,
                             int rh,
                             String src,
                             String idName,
                             Object idValue,
                             String fps)

initPipeline

protected void initPipeline()

setEventHandlerObject

protected void setEventHandlerObject(Object obj)

Uses a generic object as handler of the capture. This object should have a captureEvent method that receives a Capture argument. This method will be called upon a new frame read event.

invokeEvent

protected void invokeEvent(int w,
                           int h,
                           IntBuffer buffer)

invokeEvent() and read() are synchronized so that they can not be called simultaneously. when they were not synchronized, this caused the infamous problematic frame crash. found and fixed by Charl P. Botha

invokeEvent

protected void invokeEvent(int w,
                           int h,
                           org.gstreamer.Buffer buffer)

getSourceFrameRate

protected float getSourceFrameRate()

getName

protected String getName(String config)

getSize

protected int[] getSize(String config)

getFrameRate

protected String getFrameRate(String config)

setBufferSink

public void setBufferSink(Object sink)

Sets the object to use as destination for the frames read from the stream. The color conversion mask is automatically set to the one required to copy the frames to OpenGL. NOTE: This is not official API and may/will be removed at any time.

Parameters:

Object - dest

setBufferSink

public void setBufferSink(Object sink,
                          String mask)

Sets the object to use as destination for the frames read from the stream. NOTE: This is not official API and may/will be removed at any time.

Parameters:

Object - dest

String - mask

hasBufferSink

public boolean hasBufferSink()

NOTE: This is not official API and may/will be removed at any time.

disposeBuffer

public void disposeBuffer(Object buf)

NOTE: This is not official API and may/will be removed at any time.

getSinkMethods

protected void getSinkMethods()

initCopyMask

protected void initCopyMask()

post

public void post()