From 86bec767a44ea2ae1d16e0f7f0549cf020aa1220 Mon Sep 17 00:00:00 2001 From: Bartosz Firyn Date: Sun, 21 Jul 2013 20:54:46 +0200 Subject: [PATCH] Add licenses, change README file --- .../webcam-capture-driver-vlcj/.classpath | 1 + .../webcam-capture-driver-vlcj/README.md | 13 +- .../src/etc/licenses/bridj-0.6.3.LICENSE | 19 ++ .../src/etc/licenses/jna-3.5.2.LICENSE | 25 +++ .../src/etc/licenses/vlcj-2.4.1.LICENSE | 165 ++++++++++++++++++ .../sarxos/webcam/ds/vlcj/VlcjDevice.java | 42 +++-- 6 files changed, 241 insertions(+), 24 deletions(-) create mode 100644 webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/bridj-0.6.3.LICENSE create mode 100644 webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/jna-3.5.2.LICENSE create mode 100644 webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/vlcj-2.4.1.LICENSE diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/.classpath b/webcam-capture-drivers/webcam-capture-driver-vlcj/.classpath index c2ce1e7b..aab55df7 100644 --- a/webcam-capture-drivers/webcam-capture-driver-vlcj/.classpath +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/.classpath @@ -13,6 +13,7 @@ + diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/README.md b/webcam-capture-drivers/webcam-capture-driver-vlcj/README.md index 9ca51964..cdcf30ad 100644 --- a/webcam-capture-drivers/webcam-capture-driver-vlcj/README.md +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/README.md @@ -1,15 +1,24 @@ # webcam-capture-driver-vlcj -This capture driver use [VLCj](http://code.google.com/p/vlcj/) as a +This capture driver use [vlcj](http://caprica.github.io/vlcj/) as a underlying capturing framework. +This driver should not be used when you need good performance and high +FPS rate. Because vlcj save each image to the file prior it's returned +by the API, the FPS rate is pretty small. In my case (HP Elitebook 8460p, +quad core, 4 GB RAM, fast SSD disk) it was about ~12 FPS, which is very +low when you compare it to the other capture drivers (e.g. +[gstreamer capture driver](https://github.com/sarxos/webcam-capture/tree/master/webcam-capture-drivers/webcam-capture-driver-gstreamer) or +[openimaj capture driver](https://github.com/sarxos/webcam-capture/tree/master/webcam-capture-drivers/webcam-capture-driver-openimaj), where both can easily +stream 30 FPS). + ## Maven Not yet available. ## License -Copyright (C) 2012 Bartosz Firyn +Copyright (C) 2012 - 2013 Bartosz Firyn Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/bridj-0.6.3.LICENSE b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/bridj-0.6.3.LICENSE new file mode 100644 index 00000000..0e05f127 --- /dev/null +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/bridj-0.6.3.LICENSE @@ -0,0 +1,19 @@ +Copyright (c) 2010-2012, Olivier Chafik +All rights reserved. +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. + * Neither the name of Olivier Chafik nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY +DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/jna-3.5.2.LICENSE b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/jna-3.5.2.LICENSE new file mode 100644 index 00000000..2769f24e --- /dev/null +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/jna-3.5.2.LICENSE @@ -0,0 +1,25 @@ +JNA is dual-licensed under 2 alternative Open Source/Free +licenses: LGPL 2.1 and Apache License 2.0. (starting with +JNA version 4.0.0). + +What this means is that one can choose either one of these +licenses (for purposes of re-distributing JNA; usually by +including it as one of jars another application or +library uses) by downloading corresponding jar file, +using it, and living happily everafter. + +You may obtain a copy of the LGPL License at: + +http://www.gnu.org/licenses/licenses.html + +A copy is also included in the downloadable source code package +containing JNA, in file "LGPL2.1", under the same directory +as this file. + +You may obtain a copy of the ASL License at: + +http://www.apache.org/licenses/ + +A copy is also included in the downloadable source code package +containing JNA, in file "ASL2.0", under the same directory +as this file. diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/vlcj-2.4.1.LICENSE b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/vlcj-2.4.1.LICENSE new file mode 100644 index 00000000..cca7fc27 --- /dev/null +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/etc/licenses/vlcj-2.4.1.LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/webcam-capture-drivers/webcam-capture-driver-vlcj/src/main/java/com/github/sarxos/webcam/ds/vlcj/VlcjDevice.java b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/main/java/com/github/sarxos/webcam/ds/vlcj/VlcjDevice.java index 89204b8f..3f5d69d8 100644 --- a/webcam-capture-drivers/webcam-capture-driver-vlcj/src/main/java/com/github/sarxos/webcam/ds/vlcj/VlcjDevice.java +++ b/webcam-capture-drivers/webcam-capture-driver-vlcj/src/main/java/com/github/sarxos/webcam/ds/vlcj/VlcjDevice.java @@ -65,7 +65,12 @@ public static final OS getOS() { } /** - * NOT STABLE, EXPERIMENTAL STUFF!!! + * Capture driver which use vlcj project API to fetch images from camera. It + * should not be used when you need performance since vlcj saves snapshot image + * to disk prior it is returned - this affects performance and drop FPS rate + * down. In my case (HP Elitebook 8460p, 4 cores, 4 GB RAM, fast SSD disk) it + * was about ~12 FPS, which is very low when you compare it to the other capture + * drivers. * * @author Bartosz Firyn (SarXos) */ @@ -74,56 +79,49 @@ public class VlcjDevice implements WebcamDevice { private static final Logger LOG = LoggerFactory.getLogger(VlcjDevice.class); /** - * Artificial view sizes. In future this should be read from media item. + * Artificial view sizes. The vlcj is not able to detect resolutions + * supported by the webcam. If you would like to detect resolutions and have + * high-quality with good performance images streaming, you should rather + * use gstreamer or v4lvj capture drivers. */ - //@formatter:off private final static Dimension[] DIMENSIONS = new Dimension[] { WebcamResolution.QQVGA.getSize(), WebcamResolution.QVGA.getSize(), WebcamResolution.VGA.getSize(), }; - //@formatter:on - //@formatter:off private final static String[] VLC_ARGS = { // VLC args by Andrew Davison: // http://fivedots.coe.psu.ac.th/~ad/jg/nui025/snapsWithoutJMF.pdf - // ... have no idea what is this ... - "--intf", - // no interface - "dummy", - - // ... have no idea what is this ... - "--vout", - + "--intf", "dummy", + // no video output - "dummy", - + "--vout", "dummy", + // no audio decoding "--no-audio", - + // do not display title "--no-video-title-show", - + // no stats "--no-stats", - + // no subtitles "--no-sub-autodetect-file", - + // no snapshot previews "--no-snapshot-preview", - + // reduce capture lag/latency "--live-caching=50", - + // turn off warnings "--quiet", }; - //@formatter:on private Dimension size = null; private MediaListItem item = null;