com.github.sarxos.webcam.ds.gstreamer.GStreamerDriver Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of webcam-capture-driver-gstreamer Show documentation
Webcam Capture driver using GStreamer framework to grab frames from camera devices
The newest version!
package com.github.sarxos.webcam.ds.gstreamer;

import java.io.File;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.atomic.AtomicBoolean;

import org.gstreamer.Element;
import org.gstreamer.ElementFactory;
import org.gstreamer.Gst;
import org.gstreamer.State;
import org.gstreamer.StateChangeReturn;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.github.sarxos.webcam.WebcamDevice;
import com.github.sarxos.webcam.WebcamDriver;
import com.github.sarxos.webcam.WebcamException;
import com.github.sarxos.webcam.util.NixVideoDevUtils;
import com.sun.jna.NativeLibrary;
import com.sun.jna.Platform;


/**
 * GStreamer capture driver.
 * 
 * @author Bartosz Firyn (sarxos)
 */
public class GStreamerDriver implements WebcamDriver {

	private static final Logger LOG = LoggerFactory.getLogger(GStreamerDriver.class);

	private static final class GStreamerShutdownHook extends Thread {

		public GStreamerShutdownHook() {
			super("gstreamer-shutdown-hook");
		}

		@Override
		public void run() {
			LOG.debug("GStreamer deinitialization");
			Gst.deinit();
		}
	}

	private static final AtomicBoolean INITIALIZED = new AtomicBoolean(false);

	public GStreamerDriver() {
		init();
	}

	public GStreamerDriver(final List preferredFormats) {
		init();
		setPreferredFormats(preferredFormats);
	}

	private static final void init() {

		if (!INITIALIZED.compareAndSet(false, true)) {
			return;
		}

		if (!Platform.isWindows() && !Platform.isLinux()) {
			throw new WebcamException(String.format("%s has been designed to work only on Windows and Linux platforms", GStreamerDriver.class.getSimpleName()));
		}

		LOG.debug("GStreamer initialization");

		String gpath = null;

		if (Platform.isWindows()) {

			String path = System.getenv("PATH");

			for (String p : path.split(";")) {
				LOG.trace("Search %PATH% for gstreamer bin {}", p);
				if (p.indexOf("GStreamer\\v0.10.") != -1) {
					gpath = p;
					break;
				}
			}

			if (gpath != null) {
				LOG.debug("Add bin directory to JNA search paths {}", gpath);
				NativeLibrary.addSearchPath("gstreamer-0.10", gpath);
			} else {
				throw new WebcamException(String.format("GStreamer has not been installed or not available in PATH: %s", path));
			}
		}

		//@formatter:off
		String[] args = new String[] {
			// "--gst-plugin-path", new File(".").getAbsolutePath(),
			// "--gst-debug-level=3",
		};
		//@formatter:on

		Gst.init(GStreamerDriver.class.getSimpleName(), args);

		Runtime.getRuntime().addShutdownHook(new GStreamerShutdownHook());
	}

	public static final String FORMAT_RGB = "video/x-raw-rgb";
	public static final String FORMAT_YUV = "video/x-raw-yuv";
	public static final String FORMAT_MJPEG = "image/jpeg";

	protected static final String SRC_WINDOWS_KERNEL_STREAMING = "ksvideosrc";
	protected static final String SRC_VIDEO_FOR_LINUX_2 = "v4l2src";
	protected static final String SRC_QUICKTIME_KIT = "qtkitvideosrc";

	private List preferredFormats = new ArrayList<>(Arrays.asList(FORMAT_RGB, FORMAT_YUV, FORMAT_MJPEG));

	/**
	 * Set preferred video formats for this driver. First formats from the list are better and will
	 * be selected if available.
	 */
	public void setPreferredFormats(List preferredFormats) {
		if (preferredFormats.isEmpty()) {
			throw new IllegalArgumentException("Preferred formats list must not be empty");
		}
		this.preferredFormats = new ArrayList<>(preferredFormats);
	}

	public List getPreferredFormats() {
		return preferredFormats;
	}

	protected static String getSourceBySystem() {
		if (Platform.isWindows()) {
			return SRC_WINDOWS_KERNEL_STREAMING;
		} else if (Platform.isLinux()) {
			return SRC_VIDEO_FOR_LINUX_2;
		} else if (Platform.isMac()) {
			return SRC_QUICKTIME_KIT;
		}
		throw new IllegalStateException("Unsupported operating system");
	}

	@Override
	public List getDevices() {

		List devices = new ArrayList();

		final String srcName = getSourceBySystem();
		final Element src = ElementFactory.make(srcName, srcName);

		try {
			if (Platform.isWindows()) {

				src.setState(State.NULL);

				int m = 50;
				int i = 0;
				do {
					src.set("device-index", i);
					if (src.setState(State.READY) == StateChangeReturn.SUCCESS) {
						devices.add(new GStreamerDevice(this, i));
					} else {
						break;
					}
				} while (i < m);

			} else if (Platform.isLinux()) {
				for (File vfile : NixVideoDevUtils.getVideoFiles()) {
					devices.add(new GStreamerDevice(this, vfile));
				}
			} else {
				throw new RuntimeException("Platform unsupported by GStreamer capture driver");
			}
		} finally {
			if (src != null) {
				src.dispose();
			}
		}

		return devices;
	}

	@Override
	public boolean isThreadSafe() {
		return false;
	}

	@Override
	public String toString() {
		return getClass().getSimpleName();
	}
}