Giters

DanEscasa / javacpp-presets

The missing bridge between Java and native C++ libraries

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

JavaCPP Presets

Introduction

The JavaCPP Presets module contains Java configuration and interface classes for widely used C/C++ libraries. The configuration files in the org.bytedeco.javacpp.presets package are used by the Parser to create from C/C++ header files the Java interface files targeting the org.bytedeco.javacpp package, which is turn are used by the Generator and the native C++ compiler to produce the required JNI libraries. Moreover, helper classes make their functionality easier to use on the Java platform, including Android.

Please refer to the wiki page for more information about how to create new presets. Since additional documentation is currently lacking, please also feel free to ask questions on the mailing list.

Downloads

To install manually the JAR files, obtain the following archives and follow the instructions in the Manual Installation section below.

The binary archive contains builds for Linux, Mac OS X, Windows, and Android. The JAR files for specific child modules or platforms can also be obtained individually from the Maven Central Repository.

We can also have everything downloaded and installed automatically with:

  • Maven (inside the pom.xml file)
  <dependency>
    <groupId>org.bytedeco.javacpp-presets</groupId>
    <artifactId>${moduleName}</artifactId>
    <version>${moduleVersion}-0.9</version>
  </dependency>
  • Gradle (inside the build.gradle file)
  dependencies {
    compile group: 'org.bytedeco.javacpp-presets', name: moduleName, version: moduleVersion + '-0.9'
  }
  • SBT (inside the build.sbt file)
  libraryDependencies += "org.bytedeco.javacpp-presets" % moduleName % moduleVersion + "-0.9"

where the moduleName and moduleVersion variables correspond to the desired module. Additionally, we need to either set the platform.dependency system property to something like android-arm, or set the platform.dependencies one to true to get all the binaries for Linux, Mac OS X, and Windows.

Required Software

To use the JavaCPP Presets, you will need to download and install the following software:

Build Instructions

To rebuild the source code on the Java side, please note that the project files were created for:

Each child module in turn relies on its corresponding native libraries being already installed in the cppbuild subdirectory created by a prior execution of the included CPPBuild Scripts, explained below. To use native libraries already installed somewhere else on the system, other installation directories than cppbuild can also be specified in the .java configuration files directly. The following versions are supported:

Once everything installed and configured, simply execute

$ mvn install --projects opencv,ffmpeg,flycapture,libdc1394,libfreenect,videoinput,artoolkitplus,etc.

inside the directory containing the parent pom.xml file, by specifying only the desired child modules in the command. Please refer to the comments inside the pom.xml file for further details.

CPPBuild Scripts

Before running the Maven build, however, we recommend to install the native libraries on the native C/C++ side with the cppbuild.sh scripts. In this case, additional software is required:

With the above in working order, simply execute

$ ANDROID_NDK=/path/to/android-ndk/ bash cppbuild.sh [-platform <name>] <install | clean> [projects]

where possible platform names are: android-arm, android-x86, linux-x86, linux-x86_64, macosx-x86_64, windows-x86, windows-x86_64, etc. (The ANDROID_NDK variable is required only for Android builds.) Please note that the scripts download source archives from appropriate sites as necessary.

To compile binaries for an Android device with no FPU, first make sure this is what you want. Without FPU, the performance of either OpenCV or FFmpeg is bound to be unacceptable. If you still wish to continue down that road, then replace "armeabi-v7a" by "armeabi" and "-march=armv7-a -mfloat-abi=softfp -mfpu=vfpv3-d16" with "-march=armv5te -mtune=xscale -msoft-float", inside various files.

Although JavaCPP can pick up native libraries installed on the system, the scripts exist to facilitate the build process across multiple platforms. They also allow JavaCPP to copy the native libraries and load them at runtime from the JAR files created above by Maven, a useful feature for standalone applications or Java applets. Moreover, tricks such as the following work with JNLP:

    <resources os="Linux" arch="x86 i386 i486 i586 i686">
        <jar href="lib/opencv-linux-x86.jar"/>
        <jar href="lib/ffmpeg-linux-x86.jar"/>
    </resources>
    <resources os="Linux" arch="x86_64 amd64">
        <jar href="lib/opencv-linux-x86_64.jar"/>
        <jar href="lib/ffmpeg-linux-x86_64.jar"/>
    </resources>

Thanks to Jose Gómez for testing this out!

Manual Installation

Simply put all the desired JAR files (opencv*.jar, ffmpeg*.jar, flycapture*.jar, libdc1394*.jar, libfreenect*.jar, videoinput*.jar, and artoolkitplus*.jar, etc.), in addition to javacpp.jar, somewhere in your CLASSPATH. The JAR files available as pre-built artifacts are meant to be used with JavaCPP. They were built on Fedora 20, so they may not work on all distributions of Linux, especially older ones. The binaries for Android were compiled for ARMv7 processors featuring an FPU, so they will not work on ancient devices such as the HTC Magic or some others with an ARMv6 CPU. Here are some more specific instructions for common cases:

NetBeans (Java SE 6 or newer):

  1. In the Projects window, right-click the Libraries node of your project, and select "Add JAR/Folder...".
  2. Locate the JAR files, select them, and click OK.

Eclipse (Java SE 6 or newer):

  1. Navigate to Project > Properties > Java Build Path > Libraries and click "Add External JARs...".
  2. Locate the JAR files, select them, and click OK.

Eclipse (Android 2.2 or newer):

  1. Follow the instructions on this page: http://developer.android.com/training/basics/firstapp/
  2. Go to File > New > Folder, select your project as parent folder, type "libs/armeabi" as Folder name, and click Finish.
  3. Copy javacpp.jar, opencv.jar, ffmpeg.jar, and artoolkitplus.jar into the newly created "libs" folder.
  4. Extract all the *.so files from opencv-android-arm.jar, ffmpeg-android-arm.jar, and artoolkitplus-android-arm.jar directly into the newly created "libs/armeabi" folder, without creating any of the subdirectories found in the JAR files.
  5. Navigate to Project > Properties > Java Build Path > Libraries and click "Add JARs...".
  6. Select all of javacpp.jar, opencv.jar, ffmpeg.jar, and artoolkitplus.jar from the newly created "libs" folder.

After that, we can access almost transparently the corresponding C/C++ APIs through the interface classes found in the org.bytedeco.javacpp package. Indeed, the Parser translates the code comments from the C/C++ header files into the Java interface files, (almost) ready to be consumed by Javadoc. However, since their translation still leaves to be desired, one may wish to refer to the original documentation pages. For instance, the ones for OpenCV and FFmpeg can be found online at:

How Can I Help?

Contributions of any kind are highly welcome! At the moment, the Parser has limited capabilities, so I plan to improve it gradually to the point where it can successfully parse large C++ header files that are even more convoluted than the ones from OpenCV, but the build system could also be improved. Consequently, I am looking for help especially with the four following tasks, in no particular order:

  • Improving the Parser
  • Providing builds for more platforms, most notably linux-arm
  • Replacing the Bash/Maven build combo by something better (Gradle?)
  • Adding new presets as child modules for other C/C++ libraries (OpenNI, OpenMesh, PCL, etc.)

To contribute, please fork and create pull requests, or post your suggestions as a new "issue". Thank you very much in advance for your contribution!

Project lead: Samuel Audet [samuel.audet at gmail.com](mailto:samuel.audet at gmail.com)
Developer site: https://github.com/bytedeco/javacpp-presets
Discussion group: http://groups.google.com/group/javacpp-project

Licensed under the GNU General Public License version 2 (GPLv2) with Classpath exception.
Please refer to LICENSE.txt or http://www.gnu.org/software/classpath/license.html for details.

About

The missing bridge between Java and native C++ libraries

License:GNU General Public License v2.0