Add thread-safe support info in webcam drivers

webcam-capture-drivers/webcam-capture-driver-civil/src/main/java/com/github/sarxos/webcam/ds/civil/LtiCivilDriver.java

@@ -48,6 +48,7 @@ protected static CaptureSystem getCaptureSystem() {
 		return system;
 	}
 
+	@Override
 	public List<WebcamDevice> getDevices() {
 
 		if (!initialized) {
@@ -72,4 +73,9 @@ public List<WebcamDevice> getDevices() {
 		return devices;
 	}
 
+	@Override
+	public boolean isThreadSafe() {
+		return false;
+	}
+
 }

webcam-capture-drivers/webcam-capture-driver-ipcam/.classpath

@@ -1,11 +1,33 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<classpath>
-	<classpathentry kind="src" output="target/classes" path="src/main/java"/>
-	<classpathentry kind="src" output="target/test-classes" path="src/test/java"/>
-	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources"/>
-	<classpathentry kind="src" path="src/examples/java"/>
-	<classpathentry kind="src" path="src/examples/resources"/>
-	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
-	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER"/>
-	<classpathentry kind="output" path="target/classes"/>
-</classpath>
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path="src/examples/java"/>
+	<classpathentry kind="src" path="src/examples/resources"/>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="output" path="target/classes"/>
+</classpath>

webcam-capture-drivers/webcam-capture-driver-ipcam/src/examples/java/com/github/sarxos/webcam/ds/ipcam/JpegExample.java

@@ -21,6 +21,10 @@ public static void main(String[] args) throws MalformedURLException {
 		// available to be viewed online. Here in this example we are creating
 		// IP camera device working in PULL mode to request static JPEG images.
 
+		IpCamStorage storage = new IpCamStorage("src/examples/resources/cameras.xml");
+
+		Webcam.setDriver(new IpCamDriver(storage));
+
 		JFrame f = new JFrame("Dasding Studio Live IP Cameras");
 		f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
 		f.setLayout(new GridLayout(0, 3, 1, 1));

webcam-capture-drivers/webcam-capture-driver-ipcam/src/main/java/com/github/sarxos/webcam/ds/ipcam/IpCamDriver.java

@@ -32,4 +32,9 @@ public List<WebcamDevice> getDevices() {
 	public void register(IpCamDevice device) {
 		IpCamDeviceRegistry.register(device);
 	}
+
+	@Override
+	public boolean isThreadSafe() {
+		return true;
+	}
 }

webcam-capture-drivers/webcam-capture-driver-javacv/src/main/java/com/github/sarxos/webcam/ds/javacv/JavaCvDriver.java

@@ -51,4 +51,9 @@ public static void main(String[] args) {
 
 	}
 
+	@Override
+	public boolean isThreadSafe() {
+		return false;
+	}
+
 }

webcam-capture-drivers/webcam-capture-driver-jmf/src/main/java/com/github/sarxos/webcam/ds/jmf/JmfDriver.java

@@ -9,14 +9,15 @@
 import javax.media.CaptureDeviceManager;
 import javax.media.Format;
 
-import com.github.sarxos.webcam.WebcamDriver;
 import com.github.sarxos.webcam.WebcamDevice;
+import com.github.sarxos.webcam.WebcamDriver;
 
 
 public class JmfDriver implements WebcamDriver {
 
 	private static List<WebcamDevice> devices = null;
 
+	@Override
 	public List<WebcamDevice> getDevices() {
 
 		if (devices == null) {
@@ -35,4 +36,9 @@ public List<WebcamDevice> getDevices() {
 
 		return devices;
 	}
+
+	@Override
+	public boolean isThreadSafe() {
+		return false;
+	}
 }

webcam-capture-drivers/webcam-capture-driver-openimaj/src/main/java/com/github/sarxos/webcam/ds/openimaj/OpenImajDriver.java

@@ -36,4 +36,9 @@ public List<WebcamDevice> getDevices() {
 		return webcamDevices;
 	}
 
+	@Override
+	public boolean isThreadSafe() {
+		return false;
+	}
+
 }

webcam-capture-drivers/webcam-capture-driver-vlcj/src/main/java/com/github/sarxos/webcam/ds/vlcj/VlcjDriver.java

@@ -69,4 +69,9 @@ public List<WebcamDevice> getDevices() {
 
 		return devices;
 	}
+
+	@Override
+	public boolean isThreadSafe() {
+		return false;
+	}
 }

webcam-capture/src/example/java/com/github/sarxos/webcam/WebcamViewerExample.java

@@ -4,8 +4,6 @@
 import java.awt.event.WindowListener;
 
 import javax.swing.JFrame;
-import javax.swing.JLabel;
-import javax.swing.JPanel;
 import javax.swing.SwingUtilities;
 
 
@@ -19,9 +17,7 @@ public class WebcamViewerExample extends JFrame implements Runnable, WebcamListe
 	private static final long serialVersionUID = -2831291292491395695L;
 
 	private Webcam webcam = null;
-
-	private JPanel wait = null;
-	private WebcamPanel view = null;
+	private WebcamPanel viewer = null;
 
 	@Override
 	public void run() {
@@ -30,31 +26,30 @@ public void run() {
 		setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
 		addWindowListener(this);
 
-		wait = new JPanel();
-		wait.add(new JLabel("Initialization"));
+		webcam = Webcam.getDefault();
+		if (webcam == null) {
+			System.out.println("No webcams found...");
+			System.exit(1);
+		}
+
+		webcam.setViewSize(WebcamResolution.VGA.getSize());
+		webcam.addWebcamListener(WebcamViewerExample.this);
 
-		setContentPane(wait);
+		viewer = new WebcamPanel(webcam, false);
 
+		setContentPane(viewer);
 		pack();
 		setVisible(true);
 
-		SwingUtilities.invokeLater(new Runnable() {
+		Thread t = new Thread() {
 
 			@Override
 			public void run() {
-
-				webcam = Webcam.getDefault();
-				if (webcam == null) {
-					System.out.println("No webcams found...");
-					System.exit(1);
-				}
-
-				view = new WebcamPanel(webcam);
-
-				webcam.addWebcamListener(WebcamViewerExample.this);
-				webcam.open();
+				viewer.start();
 			}
-		});
+		};
+		t.setDaemon(true);
+		t.start();
 	}
 
 	public static void main(String[] args) {
@@ -63,23 +58,21 @@ public static void main(String[] args) {
 
 	@Override
 	public void webcamOpen(WebcamEvent we) {
-		setContentPane(view);
-		pack();
+		System.out.println("webcam open");
 	}
 
 	@Override
 	public void webcamClosed(WebcamEvent we) {
-		setContentPane(wait);
-		pack();
+		System.out.println("webcam closed");
 	}
 
 	@Override
 	public void webcamDisposed(WebcamEvent we) {
+		System.out.println("webcam disposed");
 	}
 
 	@Override
 	public void windowActivated(WindowEvent e) {
-		// TODO Auto-generated method stub
 	}
 
 	@Override
@@ -101,12 +94,14 @@ public void windowDeactivated(WindowEvent e) {
 
 	@Override
 	public void windowDeiconified(WindowEvent e) {
-		view.resume();
+		System.out.println("webcam viewer resumed");
+		viewer.resume();
 	}
 
 	@Override
 	public void windowIconified(WindowEvent e) {
-		view.pause();
+		System.out.println("webcam viewer paused");
+		viewer.pause();
 	}
 
 }

webcam-capture/src/main/java/com/github/sarxos/webcam/Webcam.java

@@ -13,7 +13,6 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-import com.github.sarxos.webcam.ds.WebcamProcessor;
 import com.github.sarxos.webcam.ds.buildin.WebcamDefaultDevice;
 import com.github.sarxos.webcam.ds.buildin.WebcamDefaultDriver;
 import com.github.sarxos.webcam.ds.cgt.WebcamCloseTask;
@@ -80,10 +79,12 @@ public void run() {
 	/**
 	 * Webcam driver (LtiCivil, JMF, FMJ, JQT, OpenCV, VLCj, etc).
 	 */
-	private static volatile WebcamDriver driver = null;
+	private static WebcamDriver driver = null;
 
-	// TODO: create only if !WebcamDriver::isThreadSafe()
-	private static final WebcamProcessor processor = new WebcamProcessor();
+	/**
+	 * Webcam tasks processor synchronize non-thread-safe operations.
+	 */
+	private static WebcamProcessor processor = null;
 
 	/**
 	 * Webcam discovery service.
@@ -150,7 +151,7 @@ public void open() {
 			return;
 		}
 
-		WebcamOpenTask task = new WebcamOpenTask(processor, device, true);
+		WebcamOpenTask task = new WebcamOpenTask(this);
 		task.open(this);
 
 		Runtime.getRuntime().addShutdownHook(hook = new ShutdownHook(this));
@@ -166,7 +167,7 @@ public void close() {
 			return;
 		}
 
-		WebcamCloseTask task = new WebcamCloseTask(processor, device, true);
+		WebcamCloseTask task = new WebcamCloseTask(this);
 		task.close(this);
 
 		Runtime.getRuntime().removeShutdownHook(hook);
@@ -314,7 +315,7 @@ public BufferedImage getImage() {
 			}
 		}
 
-		WebcamReadBufferTask task = new WebcamReadBufferTask(processor, device, true);
+		WebcamReadBufferTask task = new WebcamReadBufferTask(this);
 		return task.getImage();
 	}
 
@@ -499,6 +500,10 @@ public static synchronized WebcamDriver getDriver() {
 			driver = new WebcamDefaultDriver();
 		}
 
+		if (!driver.isThreadSafe()) {
+			processor = new WebcamProcessor();
+		}
+
 		return driver;
 	}
 
@@ -519,6 +524,10 @@ public static synchronized void setDriver(WebcamDriver driver) {
 		resetDriver();
 
 		Webcam.driver = driver;
+
+		if (!driver.isThreadSafe()) {
+			processor = new WebcamProcessor();
+		}
 	}
 
 	/**
@@ -547,6 +556,9 @@ public static synchronized void setDriver(Class<? extends WebcamDriver> driverCl
 			throw new WebcamException(e);
 		}
 
+		if (!driver.isThreadSafe()) {
+			processor = new WebcamProcessor();
+		}
 	}
 
 	/**
@@ -565,6 +577,11 @@ public static void resetDriver() {
 			discovery.shutdown();
 			discovery = null;
 		}
+
+		if (processor != null) {
+			processor.shutdown();
+			processor = null;
+		}
 	}
 
 	/**
@@ -605,6 +622,10 @@ public WebcamDevice getDevice() {
 		return device;
 	}
 
+	protected WebcamProcessor getProcessor() {
+		return processor;
+	}
+
 	/**
 	 * Completely dispose capture device. After this operation webcam cannot be
 	 * used any more and full reinstantiation is required.
@@ -619,7 +640,7 @@ protected void dispose() {
 
 		LOG.info("Disposing webcam {}", getName());
 
-		WebcamDisposeTask task = new WebcamDisposeTask(processor, device, true);
+		WebcamDisposeTask task = new WebcamDisposeTask(this);
 		task.dispose();
 
 		WebcamEvent we = new WebcamEvent(this);

webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamCompositeDriver.java

@@ -30,4 +30,16 @@ public List<WebcamDevice> getDevices() {
 		}
 		return all;
 	}
+
+	@Override
+	public boolean isThreadSafe() {
+		boolean safe = true;
+		for (WebcamDriver driver : drivers) {
+			safe &= driver.isThreadSafe();
+			if (!safe) {
+				break;
+			}
+		}
+		return safe;
+	}
 }

webcam-capture/src/main/java/com/github/sarxos/webcam/WebcamDriver.java

@@ -15,6 +15,14 @@ public interface WebcamDriver {
 	 * 
 	 * @return List of webcam devices
 	 */
-	public List<WebcamDevice> getDevices();
+	List<WebcamDevice> getDevices();
+
+	/**
+	 * Is driver thread-safe. Thread safe drivers operations does not have to be
+	 * synchronized.
+	 * 
+	 * @return True in case if driver is thread-safe, false otherwise
+	 */
+	boolean isThreadSafe();
 
 }