Skip to content

Commit

Permalink
Merge pull request #609 from yuripourre/master
Browse files Browse the repository at this point in the history
Update READMEs
  • Loading branch information
sarxos authored Jan 15, 2018
2 parents 3a238cf + 7ea25f7 commit fbd3c18
Show file tree
Hide file tree
Showing 9 changed files with 174 additions and 38 deletions.
31 changes: 25 additions & 6 deletions webcam-capture-drivers/driver-ffmpeg-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
11 changes: 5 additions & 6 deletions webcam-capture-drivers/driver-fswebcam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -23,7 +22,7 @@ Stable:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-fswebcam</artifactId>
<version>0.3.10</version>
<version>0.3.11</version>
</dependency>
```

Expand All @@ -39,7 +38,7 @@ Snapshot:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-fswebcam</artifactId>
<version>0.3.11-SNAPSHOT</version>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

Expand Down Expand Up @@ -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:

Expand Down
10 changes: 5 additions & 5 deletions webcam-capture-drivers/driver-gstreamer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -30,7 +30,7 @@ Stable:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-gstreamer</artifactId>
<version>0.3.10</version>
<version>0.3.11</version>
</dependency>
```

Expand All @@ -46,7 +46,7 @@ Snapshot:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-gstreamer</artifactId>
<version>0.3.11-SNAPSHOT</version>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

Expand All @@ -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:

Expand Down
14 changes: 4 additions & 10 deletions webcam-capture-drivers/driver-ipcam/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<repository>
<id>SarXos Repository</id>
<url>http://www.sarxos.pl/repo/maven2</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-ipcam</artifactId>
<version>0.3.10-RC7</version>
<version>0.3.11</version>
</dependency>
```

Expand All @@ -59,7 +53,7 @@ Snapshot:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-ipcam</artifactId>
<version>0.3.10-SNAPSHOT</version>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

Expand Down
10 changes: 5 additions & 5 deletions webcam-capture-drivers/driver-jmf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -23,7 +23,7 @@ Release:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-jmf</artifactId>
<version>0.3.9</version>
<version>0.3.11</version>
</dependency>
```

Expand All @@ -39,7 +39,7 @@ Stable:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-jmf</artifactId>
<version>0.3.10-RC7</version>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

Expand Down Expand Up @@ -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:

Expand Down
4 changes: 3 additions & 1 deletion webcam-capture-drivers/driver-lti-civil/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
16 changes: 13 additions & 3 deletions webcam-capture-drivers/driver-opencv/README.md
Original file line number Diff line number Diff line change
@@ -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
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-javacv</artifactId>
<version>0.3.11</version>
</dependency>
```

Snapshot:

```xml
Expand All @@ -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);
Expand Down
58 changes: 58 additions & 0 deletions webcam-capture-drivers/driver-openimaj/README.md
Original file line number Diff line number Diff line change
@@ -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
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-openimaj</artifactId>
<version>0.3.11</version>
</dependency>
```

Snapshot:

```xml
<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-openimaj</artifactId>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

## 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.

58 changes: 56 additions & 2 deletions webcam-capture-drivers/driver-vlcj/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-vlcj</artifactId>
<version>0.3.11</version>
</dependency>
```

Snapshot:

```xml
<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-vlcj</artifactId>
<version>0.3.12-SNAPSHOT</version>
</dependency>
```

## 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 <https://github.com/sarxos>
Copyright (C) 2012 - 2017 Bartosz Firyn <https://github.com/sarxos>

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:

Expand Down

0 comments on commit fbd3c18

Please sign in to comment.