16 | * Application uses per default 'DirectBuffer' strategy, if you want to compare it to
17 | * the classic JavaFXConverter approach provide one parameter called '
18 | */
19 | public class WebcamFXApp extends Application {
20 |
21 | String fxml = "/net/ladstatt/javacv/fx/webcam.fxml";
22 |
23 | public static void main(String[] args) {
24 | launch(args);
25 | }
26 |
27 | public void start(final Stage stage) throws Exception {
28 | stage.setTitle("WebcamFX");
29 | FXMLLoader fxmlLoader = mkFxmlLoader(fxml);
30 | Parent parent = fxmlLoader.load();
31 | final WebcamFXController controller = fxmlLoader.getController();
32 | stage.setScene(new Scene(parent));
33 |
34 | stage.setOnCloseRequest(windowEvent -> {
35 | controller.shutdown();
36 | stage.close();
37 | });
38 |
39 | stage.show();
40 | }
41 |
42 | private FXMLLoader mkFxmlLoader(String fxmlResource) {
43 | URL location = this.getClass().getResource(fxmlResource);
44 | FXMLLoader fxmlLoader = new FXMLLoader();
45 | fxmlLoader.setLocation(location);
46 | fxmlLoader.setBuilderFactory(new JavaFXBuilderFactory());
47 | return fxmlLoader;
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # javacv-webcam
2 |
3 | A project which shows how to use JavaFX together with OpenCV / JavaCV bindings.
4 |
5 | This project can be used as a starting point for experiments with OpenCV and Java. It showcases the usage of the PixelBuffer API which permits a fast display / rendering of a webcam image stream with JavaFX.
6 |
7 | Furthermore it uses [javafx-maven-plugin](https://github.com/openjfx/javafx-maven-plugin) to generate a custom java image.
8 |
9 | You will need at least [Java11](https://adoptopenjdk.net) and [Maven 3.6.2](https://maven.apache.org/) to build.
10 |
11 | ## Compile and run with javafx-maven-plugin
12 |
13 | For a quick glimpse of what this project does just checkout the code and enter
14 |
15 | mvn javafx:run -Djavacpp.platform.custom -Djavacpp.platform.host
16 |
17 | Note: Providing javacpp properties is not mandatory, but it reduces download size for bytedeco significantly (only fetches
18 | libs for your platform - remember to always provide those parameters though).
19 |
20 | After downloading dependencies and compiling a window should appear with your webcam image stream.
21 |
22 | If you want to create a custom jre distribution, enter
23 |
24 | mvn javafx:jlink -Djavacpp.platform.custom -Djavacpp.platform.host
25 |
26 | which creates a custom JDK11 based distribution. You can start the application by entering
27 |
28 | ./target/javacv-webcam/bin/jwebcam
29 |
30 | If you peek into the ``javacv-webcam`` directory.
31 |
32 | Attention: If you are using Windows or Linux you'll have to adapt module-info.java to include native libraries of suitable for those platforms. On MacOsX, you may have problems with permissions to access your webcam from a java application, make sure to allow access in your system preferences.
33 |
34 | ## Compile and run with client-maven-plugin
35 |
36 | This project contains also a configuration for compiling it to a native image using [GraalVM](https://www.graalvm.org/). You have
37 | to download and install GraalVM in a recent version (I tested it with 20.2.0) and then compile and run it with following command:
38 |
39 | mvn clean client:build client:run -Djavacpp.platform.custom -Djavacpp.platform.host -Dgraalvm.home=/path/to/your/graalvm/distribution
40 |
41 | After downloading necessary toolings, dependencies and compiling and linking (takes some time) a JavaFX application which uses
42 | your webcam will start.
43 |
44 | ## Links
45 |
46 | - Have a look at [https://openjfx.io](https://openjfx.io) where you can find more information and introductory examples for developing JavaFX applications.
47 | - [https://github.com/bytedeco/javacv](https://github.com/bytedeco/javacv) is the home of JavaCV which enables Java Developers to use native libraries like [OpenCV](https://opencv.org).
48 | - Some posts on [http://ladstatt.blogspot.com/](https://ladstatt.blogspot.com) may be of interest, too.
49 |
50 |
51 |
--------------------------------------------------------------------------------
/src/main/java/net/ladstatt/javacv/fx/WebcamFXController.java:
--------------------------------------------------------------------------------
1 | package net.ladstatt.javacv.fx;
2 |
3 |
4 | import javafx.application.Platform;
5 | import javafx.beans.property.SimpleBooleanProperty;
6 | import javafx.fxml.FXML;
7 | import javafx.fxml.Initializable;
8 | import javafx.scene.image.*;
9 | import org.bytedeco.javacv.Frame;
10 | import org.bytedeco.javacv.FrameGrabber;
11 | import org.bytedeco.javacv.OpenCVFrameConverter;
12 | import org.bytedeco.javacv.OpenCVFrameGrabber;
13 | import org.bytedeco.opencv.global.opencv_imgproc;
14 | import org.bytedeco.opencv.opencv_core.Mat;
15 |
16 | import java.net.URL;
17 | import java.nio.ByteBuffer;
18 | import java.util.ResourceBundle;
19 |
20 | import static org.opencv.imgproc.Imgproc.COLOR_BGR2BGRA;
21 |
22 | public class WebcamFXController implements Initializable {
23 |
24 | @FXML
25 | ImageView videoView;
26 |
27 | Mat javaCVMat = new Mat();
28 |
29 | /**
30 | * create buffer only once saves much time!
31 | */
32 | WritablePixelFormat formatByte = PixelFormat.getByteBgraPreInstance();
33 |
34 | OpenCVFrameConverter javaCVConv = new OpenCVFrameConverter.ToMat();
35 |
36 | /**
37 | * controls if application closes
38 | */
39 | SimpleBooleanProperty cameraActiveProperty = new SimpleBooleanProperty(true);
40 |
41 | OpenCVFrameGrabber frameGrabber = new OpenCVFrameGrabber(0);
42 |
43 | ByteBuffer buffer;
44 |
45 | protected void updateView(Frame frame) {
46 | int w = frame.imageWidth;
47 | int h = frame.imageHeight;
48 |
49 | Mat mat = javaCVConv.convert(frame);
50 | opencv_imgproc.cvtColor(mat, javaCVMat, COLOR_BGR2BGRA);
51 | if (buffer == null) {
52 | buffer = javaCVMat.createBuffer();
53 | }
54 |
55 | PixelBuffer pb = new PixelBuffer(w, h, buffer, formatByte);
56 | final WritableImage wi = new WritableImage(pb);
57 | Platform.runLater(() -> videoView.setImage(wi));
58 |
59 | }
60 |
61 |
62 | public void setCameraActive(Boolean isActive) {
63 | cameraActiveProperty.set(isActive);
64 | }
65 |
66 | public Boolean getCameraActive() {
67 | return cameraActiveProperty.get();
68 | }
69 |
70 | public void shutdown() {
71 | setCameraActive(false);
72 | }
73 |
74 | void setVideoView(Frame mat) {
75 | updateView(mat);
76 | }
77 |
78 | public void initialize(URL url, ResourceBundle resourceBundle) {
79 | try {
80 | frameGrabber.start();
81 | } catch (FrameGrabber.Exception e) {
82 | e.printStackTrace();
83 | }
84 | new Thread(() -> {
85 | while (getCameraActive()) {
86 | try {
87 | Frame frame = frameGrabber.grab();
88 | setVideoView(frame);
89 | } catch (FrameGrabber.Exception e) {
90 | e.printStackTrace();
91 | }
92 | }
93 | try {
94 | frameGrabber.release();
95 | } catch (FrameGrabber.Exception e) {
96 | e.printStackTrace();
97 | }
98 | }).start();
99 | }
100 |
101 | }
102 |
--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
1 |
3 | 4.0.0
4 | net.ladstatt.javacv
5 | javacv-webcam
6 | 2020.3.1-SNAPSHOT
7 |
8 | net.ladstatt.javacv.javacv-webcam
9 |
10 | jar
11 |
12 |
13 | UTF-8
14 | 16-ea+2
15 | 1.5.4
16 | net.ladstatt.javacv.fx.WebcamFXApp
17 |
18 | 0.1.33
19 | host
20 |
23 |
24 |
25 |
26 | org.openjfx
27 | javafx-controls
28 | ${openjfx.version}
29 |
30 |
31 | org.openjfx
32 | javafx-fxml
33 | ${openjfx.version}
34 |
35 |
36 |
37 | org.bytedeco
38 | javacv-platform
39 | ${javacv.version}
40 |
41 |
42 |
43 | org.bytedeco
44 | leptonica-platform
45 |
46 |
47 |
48 |
49 |
50 |
51 |
52 |
53 | org.apache.maven.plugins
54 | maven-compiler-plugin
55 | 3.8.1
56 |
57 | 11
58 | 9
59 | 9
60 |
61 |
62 |
63 | org.apache.maven.plugins
64 | maven-enforcer-plugin
65 | 3.0.0-M3
66 |
67 |
68 | enforce-jdk
69 |
70 | enforce
71 |
72 |
73 |
74 |
75 | 3.6.2
76 |
77 |
78 | 11
79 |
80 |
81 |
82 |
83 |
84 |
85 |
86 | com.gluonhq
87 | client-maven-plugin
88 | ${client.plugin.version}
89 |
90 | ${client.target}
91 | ${main.class}
92 | true
93 |
94 | display
95 | lifecycle
96 | statusbar
97 | storage
98 |
99 |
100 | net.ladstatt.javacv.fx.WebcamFXController
101 | org.bytedeco.javacpp.presets.javacpp
102 | org.bytedeco.openblas.global.openblas_nolapack
103 | org.bytedeco.javacpp.Loader
104 |
105 |
106 | .*.dylib$
107 |
108 | --allow-incomplete-classpath
109 | ${graalvm.home}
110 |
111 |
112 |
113 | org.openjfx
114 | javafx-maven-plugin
115 | 0.0.5
116 |
117 | true
118 | net.ladstatt.javacv.webcam/${main.class}
119 | javacv-webcam
120 | true
121 | true
122 | true
123 | jwebcam
124 |
125 |
126 |
127 |
128 |
129 |
130 |
131 |
132 |
133 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "[]"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright [yyyy] [name of copyright owner]
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------