@u4/opencv-build

npm-opencv-build

A simple script to auto build recent OpenCV + contrib version via npm. This script is used to auto build opencv4nodejs.

Changes in this fork

• OpenCV build is not triggered by npm install but by new OpenCVBuilder().install()
• OpenCV build can now be configured with new OpenCVBuilder({autoBuildOpencvVersion: "3.4.16", autoBuildBuildCuda: true, autoBuildWithoutContrib: false }).install()
• Each OPENCV_VERSION will be build in his own directory.
• Each AUTOBUILD_FLAGS will be build in his own directory. (induce massive time gain during development)
• if MSBuild.exe localisation for VS 2019
• Script output is now colorized.
• Add some usefull log.
• Big code refactor.
• Enfoce typing.
• Add comments and documentations.

Install

npm install opencv-build

Requirements

• cmake

Windows

for old nodejs

npm install --global windows-build-tools

OpenCVBuildEnv options

A prebuild options can be provide to avoid any recompilation, acceptex values are: "latestBuild", "latestVersion", "oldestBuild", "oldestVersion". the prebuild option intend to be use at runtime.

all the argument used to be provided in the opencv4nodejs section of a package.json can also be provide in OpenCVBuildEnv Options.

Environment Variables

It's possible to specify build environment variables by inserting them into the package.json where the dependency is declared an object like:

{
  "opencv4nodejs": {
    "autoBuildFlags": "-DOPENCV_GENERATE_PKGCONFIG=ON -DOPENCV_PC_FILE_NAME=opencv.pc",
    "autoBuildOpencvVersion": "4.5.4"
  }
}

The following opencv4nodejs parameters can be passed:

autoBuildBuildCuda

Can be set using the environment variables OPENCV4NODEJS_BUILD_CUDA

set any value to enable, the following cMake flag will be added:

• DWITH_CUDA=ON
• DBUILD_opencv_cudacodec=OFF // video codec (NVCUVID) is deprecated in cuda 10, so don't add it
• DCUDA_FAST_MATH=ON // optional
• DWITH_CUBLAS=ON // optional

autoBuildFlags

Can be set using the environment variables OPENCV4NODEJS_AUTOBUILD_FLAGS

Append option to CMake flags.

autoBuildOpencvVersion

Can be set using the environment variables OPENCV4NODEJS_AUTOBUILD_OPENCV_VERSION

Choose the openCV version you want to build default value is 3.4.16.

autoBuildWithoutContrib

Can be set using the environment variables OPENCV4NODEJS_AUTOBUILD_WITHOUT_CONTRIB

Set any value to enable, this option will skip openCV Contribs.

disableAutoBuild

Can be set using the environment variables OPENCV4NODEJS_DISABLE_AUTOBUILD

Set any value to disable compilation from sources.

opencvIncludeDir

Over write the OPENCV_INCLUDE_DIR environment variables

opencvLibDir

Over write the OPENCV_LIB_DIR environment variables

opencvBinDir

Over write the OPENCV_BIN_DIR environment variables

build test

OPENCV4NODEJS_AUTOBUILD_FLAGS=-DBUILD_LIST=core,imgproc,imgcodecs,videoio,highgui,video,calib3d,features2d,objdetect,dnn,ml,flann,photo,stitching,gapi
npm run build && OPENCV4NODEJS_AUTOBUILD_OPENCV_VERSION=3.4.15 OPENCV4NODEJS_AUTOBUILD_WITHOUT_CONTRIB=1 npm run do-install

npm run build && OPENCV4NODEJS_AUTOBUILD_OPENCV_VERSION=4.5.4 OPENCV4NODEJS_AUTOBUILD_WITHOUT_CONTRIB=1 npm run do-install