OpenCV (packaged by OpenPnP)

OpenCV Java bindings packaged with native libraries, seamlessly delivered as a turn-key Maven dependency.

Fork Notes

Soft Fork

This is a soft fork of Pattern's OpenCV package at https://github.com/PatternConsulting/opencv. That package has not been maintained in quite some time and I needed updated OpenCV binaries for OpenPnP. I intend to maintain this fork for the foreseeable future or until Pattern resumes maintenance of their package.

Backwards Compatibility

I have left the source code packages and directories the same (nu.pattern) and only changed the Maven coordinates in the pom.xml. This way the package remains backwards compatible and it is very easy to switch between the OpenPnP version and the Pattern version.

Maven

To use this fork in your project, instead of the Pattern one, simply add the same dependency but with the groupId org.openpnp instead of nu.pattern.

Scala

I'm not uploading Scala artifacts as I don't know or use Scala. If someone wants to maintain that portion of the package, let me know.

Usage

Project

OpenPnP's OpenCV package is added to your project as any other dependency.

Maven

<project>
  
  <!-- ... -->
  
  <dependencies>
    
    <!-- ... -->
    
    <dependency>
      <groupId>org.openpnp</groupId>
      <artifactId>opencv</artifactId>
      <version>[4.3.0,)</version>
    </dependency>
    
    <!-- ... -->
    
  </dependencies>
  
  <!-- ... -->
  
</project>

A list of all published versions can be found at https://mvnrepository.com/artifact/org.openpnp/opencv.

API

Typically, using the upstream OpenCV Java bindings involves loading the native library as follows:

static {
  System.loadLibrary(org.opencv.core.Core.NATIVE_LIBRARY_NAME);
}

Fortunately, this is unchanged except for one caveat. To use the native libraries included with this package, first call nu.pattern.OpenCV.loadShared().

Note: In Java 12+ loadShared() is not available. Use loadLocally() instead, and see notes below.

This call will—exactly once per class loader—first attempt to load from the system-wide installation (exactly as if System.loadLibrary(org.opencv.core.Core.NATIVE_LIBRARY_NAME); were called without any preceding steps). If that fails, the loader will select a binary from the package appropriate for the runtime environment's operating system and architecture. It will write that native library to a temporary directory (also defined by the environment), add that directory to java.library.path. This involves writing to disk, so consider the implications. Temporary files will be garbage-collected on clean shutdown.

This approach keeps most clients decoupled from Pattern's package and loader. As long as this is done sufficiently early in execution, any library using the OpenCV Java bindings can use the usual load call as documented by the OpenCV project.

There are, however, cases where Java class loaders are frequently changing (e.g., application servers, SBT projects, Scala worksheets), and spurious attempts to load the native library will result in JNI errors. As a partial work-around, this package offers an alternative API, nu.pattern.OpenCV.loadLocally(), which—also exactly once per class loader—extracts the binary appropriate for the runtime platform, and passes it to System#load(String). Ultimately, this may eventually load the library redundantly in the same JVM, which could be unsafe in production. Use with caution and understand the implications.

It's recommended developers using any JNI library read further:

• JNI 1.2 Specifications: Library and Version Management
• Holger Hoffstätte's Comments on Native Libraries, Class Loaders, and Garbage Collection

Debugging

Java logging is used to produce log messages from nu.pattern.OpenCV.

Rationale

Developers wishing to use the Java API for OpenCV would typically go through the process of building the project, and building it for each platform they wished to support (e.g., 32-bit Linux, OS X). This project provides those binaries for inclusion as a typical dependency in Maven, Ivy, and SBT projects.

Apart from testing, this package deliberately specifies no external dependencies. It does, however, make use of modern Java APIs (such as Java NIO).

Contributing

Producing native binaries is the most cumbersome process in maintaining this package. If you can contribute binaries for the current version, please make a pull request including the build artifacts and any platform definitions in nu.pattern.OpenCV.

Support

The following platforms are supported by this package:

OS	Architecture
OS X	x86_32
OS X	x86_64
Linux	x86_64
Linux	ARMv7 (arm)
Linux	ARMv8 (arm64 / aarch64)
Windows	x86_32
Windows	x86_64

If you can help create binaries for additional platforms, please see notes under Contributing.

Credits

This package is maintained by Jason von Nieda. If you find it useful, please consider sponsoring me.

Acknowledgements

• Michael Ahlers, for originally creating and maintaining this project.
• Greg Borenstein, whose advice and OpenCV for Processing project informed this package's development.
• Alex Osborne, for helpful utility class producing temporary directories with Java NIO that are properly garbage-collected on shutdown.

Builds

Builds are automatically created and published to Maven Central by Github Actions triggered by new tags. Builds are also created for branches and pull requests, and the artifacts can be downloaded from the Actions tab. These are not automatically released to Maven Central.