From 7ea25f74c6080bf4c3235f9b2350e3dfe08d5b6d Mon Sep 17 00:00:00 2001 From: Yuri Pourre Date: Mon, 15 Jan 2018 12:16:32 -0200 Subject: [PATCH] Update READMEs --- .../driver-ffmpeg-cli/README.md | 31 ++++++++-- .../driver-fswebcam/README.md | 11 ++-- .../driver-gstreamer/README.md | 10 ++-- webcam-capture-drivers/driver-ipcam/README.md | 14 ++--- webcam-capture-drivers/driver-jmf/README.md | 10 ++-- .../driver-lti-civil/README.md | 4 +- .../driver-opencv/README.md | 16 ++++- .../driver-openimaj/README.md | 58 +++++++++++++++++++ webcam-capture-drivers/driver-vlcj/README.md | 58 ++++++++++++++++++- 9 files changed, 174 insertions(+), 38 deletions(-) create mode 100644 webcam-capture-drivers/driver-openimaj/README.md diff --git a/webcam-capture-drivers/driver-ffmpeg-cli/README.md b/webcam-capture-drivers/driver-ffmpeg-cli/README.md index 2ffee07d..69d5e680 100644 --- a/webcam-capture-drivers/driver-ffmpeg-cli/README.md +++ b/webcam-capture-drivers/driver-ffmpeg-cli/README.md @@ -15,16 +15,35 @@ code, or you would like to perform any enhancement, feel free to send pull request. Due to other urgent issues, I wont put any effort to enhance and/or fix this driver. -## How To Use It + +## How To Use Set new driver before you start using Webcam class: ```java -Webcam.setDriver(new FFmpegCliDriver()); -Webcam webcam = Webcam.getDefault(); -webcam.open(); -// ... do your stuff -webcam.close(); +public class TakePictureExample { + + // set capture driver for ffmpeg tool + static { + Webcam.setDriver(new FFmpegCliDriver()); + } + + public static void main(String[] args) throws IOException { + + // get default webcam and open it + Webcam webcam = Webcam.getDefault(); + webcam.open(); + + // get image from webcam device + BufferedImage image = webcam.getImage(); + + // save image to PNG file + ImageIO.write(image, "JPG", new File("test.jpg")); + + // close webcam + webcam.close(); + } +} ``` ## License diff --git a/webcam-capture-drivers/driver-fswebcam/README.md b/webcam-capture-drivers/driver-fswebcam/README.md index bb32035c..814815c4 100644 --- a/webcam-capture-drivers/driver-fswebcam/README.md +++ b/webcam-capture-drivers/driver-fswebcam/README.md @@ -10,10 +10,9 @@ $ sudo apt-get install fswebcam ## Download -The latest **stable** ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-fswebcam/0.3.10/webcam-capture-driver-fswebcam-0.3.10-dist.zip). - -The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-fswebcam&v=0.3.11-SNAPSHOT). +The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-fswebcam/0.3.12-SNAPSHOT/webcam-capture-driver-fswebcam-0.3.12-20171213.184511-7.jar). +The latest **stable** ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-fswebcam/0.3.11/webcam-capture-driver-fswebcam-0.3.11-dist.zip). ## Maven @@ -23,7 +22,7 @@ Stable: com.github.sarxos webcam-capture-driver-fswebcam - 0.3.10 + 0.3.11 ``` @@ -39,7 +38,7 @@ Snapshot: com.github.sarxos webcam-capture-driver-fswebcam - 0.3.11-SNAPSHOT + 0.3.12-SNAPSHOT ``` @@ -85,7 +84,7 @@ There are several known issues. If you have an idea of how those can be fixed, p ## License -Copyright (C) 2014 - 2015 Bartosz Firyn +Copyright (C) 2012 - 2017 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/driver-gstreamer/README.md b/webcam-capture-drivers/driver-gstreamer/README.md index 8da31157..1f10bbaf 100644 --- a/webcam-capture-drivers/driver-gstreamer/README.md +++ b/webcam-capture-drivers/driver-gstreamer/README.md @@ -18,9 +18,9 @@ the correct one! It is **not** compatible with GStreamer 1.0 and above! ## Download -The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-gstreamer&v=0.3.10-SNAPSHOT). +The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-gstreamer/0.3.12-SNAPSHOT/webcam-capture-driver-gstreamer-0.3.12-20171213.184528-7.jar). -The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-gstreamer/0.3.10-RC7/webcam-capture-driver-gstreamer-0.3.10-RC7-dist.zip). +The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-gstreamer/0.3.11/webcam-capture-driver-gstreamer-0.3.11-dist.zip). ## Maven @@ -30,7 +30,7 @@ Stable: com.github.sarxos webcam-capture-driver-gstreamer - 0.3.10 + 0.3.11 ``` @@ -46,7 +46,7 @@ Snapshot: com.github.sarxos webcam-capture-driver-gstreamer - 0.3.11-SNAPSHOT + 0.3.12-SNAPSHOT ``` @@ -68,7 +68,7 @@ public static void main(String[] args) { ## License -Copyright (C) 2012 - 2014 Bartosz Firyn +Copyright (C) 2012 - 2017 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/driver-ipcam/README.md b/webcam-capture-drivers/driver-ipcam/README.md index b18033ca..102f0949 100644 --- a/webcam-capture-drivers/driver-ipcam/README.md +++ b/webcam-capture-drivers/driver-ipcam/README.md @@ -25,25 +25,19 @@ help :) Later, when your class is ready, I will be happy to merge it with offici ## Download -The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-ipcam&v=0.3.10-SNAPSHOT). +The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-ipcam/0.3.12-SNAPSHOT/webcam-capture-driver-ipcam-0.3.12-20171213.184535-7.jar). -The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-ipcam/0.3.10-RC7/webcam-capture-driver-ipcam-0.3.10-RC7-dist.zip). +The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-ipcam/0.3.11/webcam-capture-driver-ipcam-0.3.11-dist.zip). ## Maven Stable: -```xml - - SarXos Repository - http://www.sarxos.pl/repo/maven2 - -``` ```xml com.github.sarxos webcam-capture-driver-ipcam - 0.3.10-RC7 + 0.3.11 ``` @@ -59,7 +53,7 @@ Snapshot: com.github.sarxos webcam-capture-driver-ipcam - 0.3.10-SNAPSHOT + 0.3.12-SNAPSHOT ``` diff --git a/webcam-capture-drivers/driver-jmf/README.md b/webcam-capture-drivers/driver-jmf/README.md index 40b66919..e50bbb45 100644 --- a/webcam-capture-drivers/driver-jmf/README.md +++ b/webcam-capture-drivers/driver-jmf/README.md @@ -10,9 +10,9 @@ It can also be used with the alternative [FMJ](http://fmj-sf.net/). ## Download -The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-jmf&v=0.3.10-SNAPSHOT). +The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-jmf/0.3.12-SNAPSHOT/webcam-capture-driver-jmf-0.3.12-20171213.184548-7.jar). -The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-jmf/0.3.10-RC7/webcam-capture-driver-jmf-0.3.10-RC7-dist.zip). +The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-jmf/0.3.11/webcam-capture-driver-jmf-0.3.11-dist.zip). ## Maven @@ -23,7 +23,7 @@ Release: com.github.sarxos webcam-capture-driver-jmf - 0.3.9 + 0.3.11 ``` @@ -39,7 +39,7 @@ Stable: com.github.sarxos webcam-capture-driver-jmf - 0.3.10-RC7 + 0.3.12-SNAPSHOT ``` @@ -77,7 +77,7 @@ public static void main(String[] args) { ## License -Copyright (C) 2012 - 2014 Bartosz Firyn +Copyright (C) 2012 - 2017 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/driver-lti-civil/README.md b/webcam-capture-drivers/driver-lti-civil/README.md index fda0cef3..1e8eb488 100644 --- a/webcam-capture-drivers/driver-lti-civil/README.md +++ b/webcam-capture-drivers/driver-lti-civil/README.md @@ -15,7 +15,9 @@ do not have Mac OS machine to perform tests. ## Download -TBD +The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-lti-civil/0.3.12-SNAPSHOT/webcam-capture-driver-lti-civil-0.3.12-20171213.184558-6.jar). + +The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-lti-civil/0.3.11/webcam-capture-driver-lti-civil-0.3.11-dist.zip). ## Maven diff --git a/webcam-capture-drivers/driver-opencv/README.md b/webcam-capture-drivers/driver-opencv/README.md index 3e2bd509..dd3ad59f 100644 --- a/webcam-capture-drivers/driver-opencv/README.md +++ b/webcam-capture-drivers/driver-opencv/README.md @@ -1,10 +1,20 @@ -# webcam-capture-driver-jmf +# webcam-capture-driver-opencv This is capture driver which uses [JavaCV](https://github.com/bytedeco/javacv) interface to [OpenCV](http://opencv.org/) to access camera devices. ## Maven +Stable: + +```xml + + com.github.sarxos + webcam-capture-driver-javacv + 0.3.11 + +``` + Snapshot: ```xml @@ -25,11 +35,11 @@ Snapshot: ```java static { - Webcam.setDriver(new JmfDriver()); + Webcam.setDriver(new JavaCvDriver()); } public static void main(String[] args) { - JFrame frame = new JFrame("JMF Webcam Capture Driver Demo"); + JFrame frame = new JFrame("JavaCv Capture Driver Demo"); frame.add(new WebcamPanel(Webcam.getDefault())); frame.pack(); frame.setVisible(true); diff --git a/webcam-capture-drivers/driver-openimaj/README.md b/webcam-capture-drivers/driver-openimaj/README.md new file mode 100644 index 00000000..60f9bd44 --- /dev/null +++ b/webcam-capture-drivers/driver-openimaj/README.md @@ -0,0 +1,58 @@ +# webcam-capture-driver-openimaj + +This is capture driver which uses [OpenIMAJ](http://openimaj.org) to access camera devices. + +## Maven + +Stable: + +```xml + + com.github.sarxos + webcam-capture-driver-openimaj + 0.3.11 + +``` + +Snapshot: + +```xml + + Sonatype OSS Snapshot Repository + http://oss.sonatype.org/content/repositories/snapshots + +``` +```xml + + com.github.sarxos + webcam-capture-driver-openimaj + 0.3.12-SNAPSHOT + +``` + +## Example + +```java +static { + Webcam.setDriver(new OpenImajDriver()); +} + +public static void main(String[] args) { + JFrame frame = new JFrame("OpenIMAJDriver Capture Driver Demo"); + frame.add(new WebcamPanel(Webcam.getDefault())); + frame.pack(); + frame.setVisible(true); + frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); +} +``` + +## License + +Copyright (C) 2012 - 2017 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: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + diff --git a/webcam-capture-drivers/driver-vlcj/README.md b/webcam-capture-drivers/driver-vlcj/README.md index a79276ce..5bd86300 100644 --- a/webcam-capture-drivers/driver-vlcj/README.md +++ b/webcam-capture-drivers/driver-vlcj/README.md @@ -8,11 +8,65 @@ The vlcj library is distributed according to the terms of the [GPL](http://www.g ## Maven -Not yet available. +Stable: + +```xml + + com.github.sarxos + webcam-capture-driver-vlcj + 0.3.11 + +``` + +Snapshot: + +```xml + + Sonatype OSS Snapshot Repository + http://oss.sonatype.org/content/repositories/snapshots + +``` +```xml + + com.github.sarxos + webcam-capture-driver-vlcj + 0.3.12-SNAPSHOT + +``` + +## How To Use + +Set capture driver before you start using Webcam class: + +```java +public class TakePictureExample { + + // set capture driver for fswebcam tool + static { + Webcam.setDriver(new VlcjDriver()); + } + + public static void main(String[] args) throws IOException { + + // get default webcam and open it + Webcam webcam = Webcam.getDefault(); + webcam.open(); + + // get image from webcam device + BufferedImage image = webcam.getImage(); + + // save image to PNG file + ImageIO.write(image, "JPG", new File("test.jpg")); + + // close webcam + webcam.close(); + } +} +``` ## Capture Driver License -Copyright (C) 2012 - 2015 Bartosz Firyn +Copyright (C) 2012 - 2017 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: