Rust OpenCV bindings
Experimental Rust bindings for OpenCV 3.
The API is usable but unstable and not very battle-tested; use at your own risk.
API Docs
API Documentation is, to varying success, translated from OpenCV's doxygen docs. Most likely you'll want to refer to the official OpenCV C++ documentation as well.
Getting Started
The following external dependencies are required:
- python2.7
- opencv 3.4.6 (other 3.4 versions may work, but development is done against this version)
OpenCV is a complicated dependency with a lot of different configurations that can break this crate since it relies on fragile header parsing. Try these strategies in order, continuing to the next if builds with this crate fail.
See if you already have the right version of OpenCV installed
if opencv is installed, its version can be checked with:
Install OpenCV
Install opencv 3.4.6. Check your platform's package manager or see the upstream opencv installation guides.
Compiling OpenCV
See the upstream guides for compiling OpenCV for your platform. Make sure to compile from the correct release tag! We recommend including opencv_contrib and configuring your build with the same flags the travis build uses:
Contrib modules
The following modules require contrib installed:
- bioinspired
- ccalib
- dpm
- freetype
- fuzzy
- img_hash
- phase_unwrapping
- plot
OpenCV 2 support
If you can't use opencv 3.4.6, the (no longer maintained) 0.2.4
version of this crate is known to work with opencv 2.4.7.13
(and probably other 2.4 versions).
The binding strategy
This crate works following the model of python and java's opencv wrappers - it parses the opencv C++ headers, generates a C interface to the C++ api, and wraps the C interface in Rust.
All the major modules in the C++ API are merged together in a huge
cv::
namespace. We instead made one rust module for each major
OpenCV module. So, for example, C++ cv::Mat
is opencv::core::Mat
in this crate.
The methods and field names have been snake_cased. Methods arguments with default value lose these default values, but they are reported in the API documentation.
Overloaded methods have been — manually — given different names.
All methods return a Result to hack around C++ exception handling.
Most of the API is covered, but for various reasons several modules are not yet implemented. If a missing module is near and dear to you, file an issue (or better, open a pull request!)
Contributor's Guide
The crate itself, as imported by users, consists of generated rust
code in src committed to the repo. This way, users don't have
to handle the code generation overhead in their builds. When
developing this crate, you can test changes to the binding generation
using cargo build -vv --features buildtime_bindgen
. When changing
the codegen, be sure to push changes to the generated code!
hdr_parser.py
comes from opencv python/java generator. We've tried
not to mess too much with this file, but had to make a few changes.
gen_rust.py
is initially a copy of gen_java, also from the OpenCV
generators, but it has drifted significantly from the original.
The license for the original work is MIT.
Special thanks to ttacon for yielding the crate name.