Skip to content

Latest commit

 

History

History
40 lines (27 loc) · 1.37 KB

README.md

File metadata and controls

40 lines (27 loc) · 1.37 KB
Raw

OpenCV bindings for OCaml.

Quick start

Run make install to install the library with dune. You must have OpenCV installed on your system.

Run make run to run the demo. This demo requires you to provide a video file demos/basic/test.mp4 as input. It also requires you to install the owl opam package.

Run make doc to generate documentation. Open _build/default/_doc/_html/index.html to view. Alternatively, view the auto-generated docs online: API.

Pinning the dev repo

To build and install the package directly from the development repository, use opam pin add opencv https://github.com/Calsign/ocaml-opencv.git.

Goals

  • Provide access to the full OpenCV API through OCaml
  • Make it possible to use OpenCV API calls as pure functions
  • Use auto-generation of bindings as much as possible

Caveats

The bindings are currently for a small subset of the OpenCV API (core, imgproc, videoio, and highgui), but the plan is to eventually support the entire API.

Tested with OpenCV 4.3.0. Should work fine with any OpenCV 4.x, but modifications may be necessary to work with older versions.

OWL is not required to use the OpenCV bindings, but it is recommended because the mat type is compatible with OWL type Dense.Ndarray.Generic; OWL serves a role similar to numpy for Python.