OpenCV

KO | EN

gitlite — search

#react #ai #llm #android #rust #docker #macos #windows #cli #kubernetes #awesome-list #vue #pytorch #open-source

(★ 22)

Swift Package for OpenCV

OpenCV Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# OpenCV SPM Package

Every time I try to use OpenCV on an Apple platform, I lose a few days to yak shaving trying to
get it to compile and including it in my project.  The build process is convoluted and
time-consuming -- there is no way to turn it into a Swift Package.

But now, one can create [*binary* packages in SPM]( https://developer.apple.com/documentation/xcode/distributing-binary-frameworks-as-swift-packages ).

So here it is.

To use it, just include the package 
 `https://github.com/r0ml/OpenCV.git`

This version includes everything you need to make your own version. If you just need the binary framework without all the sources required to rebuild it, then use 
 `https://github.com/r0ml/JustTheBinary.git`

The build process (see build.sh) enables both ObjC++ and Swift.
In your project, you will need to change the setting for `C++ and Objective-C interoperability` to `C++/Objective-C++`.

## Building your own version

First, if you wish to update the underlying version of OpenCV,
cd into opencv and do:
 git fetch --all --tags
 git checkout <tagname>

then do the same in opencv_contrib (use the same tagname)

Then, back in the root directory of the package, 
 git add opencv
 git add opencv_contrib
 git commit -am 'upgraded to opencv <tagname>'

If you wish to build your own, clone this repo (`git clone --recurse-submodules`). 
You will need cmake installed (`brew install cmake`). 
You will need XCode command line tools installed (`xcode-select --install`). 
You will need to create a version of python called `python` installed at /usr/local/bin . 
(The build scripts want an executable called `python` in the `PATH`. 
Unfortunately, if you create a link to /usr/bin/python3, it will not work! )

I have included a script called `python` in this repo which must be copied or moved to `/usr/local/bin/python`.

Then run 
```
./prepatch.sh
```

which fixes a problem with an `#include` statement in opencv and bad logic for macCatalyst support in TargetConditionals.h .

Then run

```
./build.sh
```

Because I am using OpenCV as the name of the framework, rather than opencv2, many of the includes in the headers fail to resolve properly.  The following patch fixes that, as well as changes to XCode 26 in validating iOS frameworks.

Run

```
./postpatch.sh
```

The built xcframework should be located at `build_xcframework/OpenCV.xcframework`.

## Deploying

After building the xcframework, one needs to 
  1) run `./postbuild.sh xxx` where xxx is the new version number of the updated package.  This will update the version number in the download URL, create the release zip file, and update the checksum in Package.swift
  2) commit and push the changes
  3) create a new release on github using the version number from the `postbuild.sh` step
  4) upload the `OpenCV.framework.zip` in build_xcframework as the asset in the release

## Alternate

If adding this SPM package seems to take way too long, you might try using the alternative package at  `https://github.com/r0ml/JustTheBinary`.  This contains a binary package with the same framework as available here, except (as the name suggests) it does not include all the stuff required to rebuild the framework.  It should load faster.

## LICENSE

OpenCV

OpenCV Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

OpenCV

OpenCV Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README