-
Notifications
You must be signed in to change notification settings - Fork 123
/
OpenCV.java
344 lines (279 loc) · 11.8 KB
/
OpenCV.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
package nu.pattern;
import org.opencv.core.Core;
import sun.reflect.CallerSensitive;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.Field;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
public class OpenCV {
private final static Logger logger = Logger.getLogger(OpenCV.class.getName());
static enum OS {
OSX("^[Mm]ac OS X$"),
LINUX("^[Ll]inux$"),
WINDOWS("^[Ww]indows.*");
private final Set<Pattern> patterns;
private OS(final String... patterns) {
this.patterns = new HashSet<Pattern>();
for (final String pattern : patterns) {
this.patterns.add(Pattern.compile(pattern));
}
}
private boolean is(final String id) {
for (final Pattern pattern : patterns) {
if (pattern.matcher(id).matches()) {
return true;
}
}
return false;
}
public static OS getCurrent() {
final String osName = System.getProperty("os.name");
for (final OS os : OS.values()) {
if (os.is(osName)) {
logger.log(Level.FINEST, "Current environment matches operating system descriptor \"{0}\".", os);
return os;
}
}
throw new UnsupportedOperationException(String.format("Operating system \"%s\" is not supported.", osName));
}
}
static enum Arch {
X86_32("i386", "i686"),
X86_64("amd64", "x86_64");
private final Set<String> patterns;
private Arch(final String... patterns) {
this.patterns = new HashSet<String>(Arrays.asList(patterns));
}
private boolean is(final String id) {
return patterns.contains(id);
}
public static Arch getCurrent() {
final String osArch = System.getProperty("os.arch");
for (final Arch arch : Arch.values()) {
if (arch.is(osArch)) {
logger.log(Level.FINEST, "Current environment matches architecture descriptor \"{0}\".", arch);
return arch;
}
}
throw new UnsupportedOperationException(String.format("Architecture \"%s\" is not supported.", osArch));
}
}
private static class UnsupportedPlatformException extends RuntimeException {
private UnsupportedPlatformException(final OS os, final Arch arch) {
super(String.format("Operating system \"%s\" and architecture \"%s\" are not supported.", os, arch));
}
}
private static class TemporaryDirectory {
final Path path;
public TemporaryDirectory() {
try {
path = Files.createTempDirectory("");
} catch (IOException e) {
throw new RuntimeException(e);
}
}
public Path getPath() {
return path;
}
public TemporaryDirectory markDeleteOnExit() {
Runtime.getRuntime().addShutdownHook(new Thread() {
@Override
public void run() {
delete();
}
});
return this;
}
public void delete() {
if (!Files.exists(path)) {
return;
}
try {
Files.walkFileTree(path, new SimpleFileVisitor<Path>() {
@Override
public FileVisitResult postVisitDirectory(final Path dir, final IOException e)
throws IOException {
Files.deleteIfExists(dir);
return super.postVisitDirectory(dir, e);
}
@Override
public FileVisitResult visitFile(final Path file, final BasicFileAttributes attrs)
throws IOException {
Files.deleteIfExists(file);
return super.visitFile(file, attrs);
}
});
} catch (IOException e) {
throw new RuntimeException(e);
}
}
}
/**
* Exactly once per {@link ClassLoader}, attempt to load the native library (via {@link System#loadLibrary(String)} with {@link Core#NATIVE_LIBRARY_NAME}). If the first attempt fails, the native binary will be extracted from the classpath to a temporary location (which gets cleaned up on shutdown), that location is added to the {@code java.library.path} system property and {@link ClassLoader#usr_paths}, and then another call to load the library is made. Note this method uses reflection to gain access to private memory in {@link ClassLoader} as there's no documented method to augment the library path at runtime. Spurious calls are safe.
*/
public static void loadShared() {
SharedLoader.getInstance();
}
/**
* @see <a href="http://en.wikipedia.org/wiki/Initialization-on-demand_holder_idiom">Initialization-on-demand holder idiom</a>
*/
private static class SharedLoader {
private Path libraryPath;
private SharedLoader() {
try {
System.loadLibrary(Core.NATIVE_LIBRARY_NAME);
logger.log(Level.FINEST, "Loaded existing OpenCV library \"{0}\" from library path.", Core.NATIVE_LIBRARY_NAME);
} catch (final UnsatisfiedLinkError ule) {
/* Only update the library path and load if the original error indicates it's missing from the library path. */
if (!String.format("no %s in java.library.path", Core.NATIVE_LIBRARY_NAME).equals(ule.getMessage())) {
logger.log(Level.FINEST, String.format("Encountered unexpected loading error."), ule);
throw ule;
}
/* Retain this path for cleaning up the library path later. */
this.libraryPath = extractNativeBinary();
addLibraryPath(libraryPath.getParent());
System.loadLibrary(Core.NATIVE_LIBRARY_NAME);
logger.log(Level.FINEST, "OpenCV library \"{0}\" loaded from extracted copy at \"{1}\".", new Object[]{Core.NATIVE_LIBRARY_NAME, System.mapLibraryName(Core.NATIVE_LIBRARY_NAME)});
}
}
/**
* Cleans up patches done to the environment.
*/
@Override
protected void finalize() throws Throwable {
super.finalize();
if (null == libraryPath) {
return;
}
removeLibraryPath(libraryPath.getParent());
}
private static class Holder {
private static final SharedLoader INSTANCE = new SharedLoader();
}
public static SharedLoader getInstance() {
return Holder.INSTANCE;
}
/**
* Adds the provided {@link Path}, normalized, to the {@link ClassLoader#usr_paths} array, as well as to the {@code java.library.path} system property. Uses the reflection API to make the field accessible, and may be unsafe in environments with a security policy.
*
* @see <a href="http://stackoverflow.com/q/15409223">Adding new paths for native libraries at runtime in Java</a>
*/
private static void addLibraryPath(final Path path) {
final String normalizedPath = path.normalize().toString();
try {
final Field field = ClassLoader.class.getDeclaredField("usr_paths");
field.setAccessible(true);
final Set<String> userPaths = new HashSet<>(Arrays.asList((String[]) field.get(null)));
userPaths.add(normalizedPath);
field.set(null, userPaths.toArray(new String[userPaths.size()]));
System.setProperty("java.library.path", System.getProperty("java.library.path") + File.pathSeparator + normalizedPath);
logger.log(Level.FINEST, "System library path now \"{0}\".", System.getProperty("java.library.path"));
} catch (IllegalAccessException e) {
throw new RuntimeException("Failed to get permissions to set library path");
} catch (NoSuchFieldException e) {
throw new RuntimeException("Failed to get field handle to set library path");
}
}
/**
* Removes the provided {@link Path}, normalized, from the {@link ClassLoader#usr_paths} array, as well as to the {@code java.library.path} system property. Uses the reflection API to make the field accessible, and may be unsafe in environments with a security policy.
*/
private static void removeLibraryPath(final Path path) {
final String normalizedPath = path.normalize().toString();
try {
final Field field = ClassLoader.class.getDeclaredField("usr_paths");
field.setAccessible(true);
final Set<String> userPaths = new HashSet<>(Arrays.asList((String[]) field.get(null)));
userPaths.remove(normalizedPath);
field.set(null, userPaths.toArray(new String[userPaths.size()]));
System.setProperty("java.library.path", System.getProperty("java.library.path").replace(File.pathSeparator + path.normalize().toString(), ""));
} catch (IllegalAccessException e) {
throw new RuntimeException("Failed to get permissions to set library path");
} catch (NoSuchFieldException e) {
throw new RuntimeException("Failed to get field handle to set library path");
}
}
}
/**
* Exactly once per {@link ClassLoader}, extract the native binary from the classpath to a temporary location (which gets cleaned up on shutdown), and load that binary (via {@link System#load(String)}). Spurious calls are safe.
*/
public static void loadLocally() {
LocalLoader.getInstance();
}
private static class LocalLoader {
private LocalLoader() {
/* Retain this path for cleaning up later. */
final Path libraryPath = extractNativeBinary();
System.load(libraryPath.normalize().toString());
logger.log(Level.FINEST, "OpenCV library \"{0}\" loaded from extracted copy at \"{1}\".", new Object[]{Core.NATIVE_LIBRARY_NAME, System.mapLibraryName(Core.NATIVE_LIBRARY_NAME)});
}
private static class Holder {
private static final LocalLoader INSTANCE = new LocalLoader();
}
public static LocalLoader getInstance() {
return Holder.INSTANCE;
}
}
/**
* Selects the appropriate packaged binary, extracts it to a temporary location (which gets deleted when the JVM shuts down), and returns a {@link Path} to that file.
*/
@CallerSensitive
private static Path extractNativeBinary() {
final OS os = OS.getCurrent();
final Arch arch = Arch.getCurrent();
return extractNativeBinary(os, arch);
}
/**
* Extracts the packaged binary for the specified platform to a temporary location (which gets deleted when the JVM shuts down), and returns a {@link Path} to that file.
*/
private static Path extractNativeBinary(final OS os, final Arch arch) {
final String location;
switch (os) {
case LINUX:
switch (arch) {
case X86_32:
location = "/nu/pattern/opencv/linux/x86_32/libopencv_java249.so";
break;
case X86_64:
location = "/nu/pattern/opencv/linux/x86_64/libopencv_java249.so";
break;
default:
throw new UnsupportedPlatformException(os, arch);
}
break;
case OSX:
switch (arch) {
case X86_64:
location = "/nu/pattern/opencv/osx/x86_64/libopencv_java249.dylib";
break;
default:
throw new UnsupportedPlatformException(os, arch);
}
break;
default:
throw new UnsupportedPlatformException(os, arch);
}
logger.log(Level.FINEST, "Selected native binary \"{0}\".", location);
final InputStream binary = OpenCV.class.getResourceAsStream(location);
final Path destination = new TemporaryDirectory().markDeleteOnExit().getPath().resolve("./" + location).normalize();
try {
logger.log(Level.FINEST, "Copying native binary to \"{0}\".", destination);
Files.createDirectories(destination.getParent());
Files.copy(binary, destination);
} catch (final IOException ioe) {
throw new IllegalStateException(String.format("Error writing native library to \"%s\".", destination), ioe);
}
logger.log(Level.FINEST, "Extracted native binary to \"{0}\".", destination);
return destination;
}
}