opencv4nodejs allows you to use the native OpenCV library in nodejs. Besides a synchronous API the package provides an asynchronous API, which allows you to build non-blocking and multithreaded computer vision tasks. opencv4nodejs supports OpenCV 3 and OpenCV 4.
The ultimate goal of this project is to provide a comprehensive collection of nodejs bindings to the API of OpenCV and the OpenCV-contrib modules. To get an overview of the currently implemented bindings, have a look at the type declarations of this package. Furthermore, contribution is highly appreciated. If you want to add missing bindings check out the contribution guide.
- How to install
- Usage with Docker
- Usage with Electron
- Usage with NW.js
- Quick Start
- Async API
- With TypeScript
- External Memory Tracking (v4.0.0)
See examples for implementation.
Face Recognition with the OpenCV face module
Check out Node.js + OpenCV for Face Recognition.
Face Landmarks with the OpenCV face module
Hand Gesture Recognition
Object Recognition with Deep Neural Networks
Single Shot Multibox Detector with COCO
How to install
npm install --save opencv4nodejs
Native node modules are built via node-gyp, which already comes with npm by default. However, node-gyp requires you to have python installed. If you are running into node-gyp specific issues have a look at known issues with node-gyp first.
Important note: node-gyp won't handle whitespaces properly, thus make sure, that the path to your project directory does not contain any whitespaces. Installing opencv4nodejs under "C:\Program Files\some_dir" or similar will not work and will fail with: "fatal error C1083: Cannot open include file: 'opencv2/core.hpp'"!**
On Windows you will furthermore need Windows Build Tools to compile OpenCV and opencv4nodejs. If you don't have Visual Studio or Windows Build Tools installed, you can easily install the VS2015 build tools:
npm install --global windows-build-tools
Installing OpenCV Manually
Setting up OpenCV on your own will require you to set an environment variable to prevent the auto build script to run:
# linux and osx:export OPENCV4NODEJS_DISABLE_AUTOBUILD=1# on windows:set OPENCV4NODEJS_DISABLE_AUTOBUILD=1
# to install OpenCV 4.1.0choco install OpenCV -y -version 4.1.0
Note, this will come without contrib modules. To install OpenCV under windows with contrib modules you have to build the library from source or you can use the auto build script.
Before installing opencv4nodejs with an own installation of OpenCV you need to expose the following environment variables:
- OPENCV_INCLUDE_DIR pointing to the directory with the subfolder opencv2 containing the header files
- OPENCV_LIB_DIR pointing to the lib directory containing the OpenCV .lib files
Also you will need to add the OpenCV binaries to your system path:
- add an environment variable OPENCV_BIN_DIR pointing to the binary directory containing the OpenCV .dll files
;%OPENCV_BIN_DIR%;to your system path variable
Note: Restart your current console session after making changes to your environment.
Under OSX we can simply install OpenCV via brew:
brew updatebrew install opencv@4brew link --force opencv@4
Under Linux we have to build OpenCV from source manually or using the auto build script.
Installing OpenCV via Auto Build Script
The auto build script comes in form of the opencv-build npm package, which will run by default when installing opencv4nodejs. The script requires you to have git and a recent version of cmake installed.
Auto Build Flags
You can customize the autobuild flags using OPENCV4NODEJS_AUTOBUILD_FLAGS=. Flags must be space-separated.
This is an advanced customization and you should have knowledge regarding the OpenCV compilation flags. Flags added by default are listed here.
Installing a Specific Version of OpenCV
You can specify the Version of OpenCV you want to install via the script by setting an environment variable:
Installing only a Subset of OpenCV modules
If you only want to build a subset of the OpenCV modules you can pass the -DBUILD_LIST cmake flag via the OPENCV4NODEJS_AUTOBUILD_FLAGS environment variable. For example
export OPENCV4NODEJS_AUTOBUILD_FLAGS=-DBUILD_LIST=dnn will build only modules required for
dnn and reduces the size and compilation time of the OpenCV package.
Configuring Environments via package.json
It's possible to specify build environment variables by inserting them into the
package.json as follows:
The following environment variables can be passed:
Disabeling installation of prebuilt OpenCV
By default opencv4nodejs-prebuilt will install a prebuilt version of OpenCV for the current platform via @nut-tree/opencv-build-(win32/linux/darwin). If you want to disable this behaviour (to e.g. provide your own OpenCV build), set the following environment variable:
# linux and osx:export OPENCV4NODEJS_PREBUILT_SKIP_DEPENDENCIES=1# on windows:set OPENCV4NODEJS_PREBUILT_SKIP_DEPENDENCIES=1