opencv/platforms/apple
Jonathan Cole 85b0fb2a9c
Merge pull request #18826 from Rightpoint:feature/colejd/build-catalyst-xcframework
Support XCFramework builds, Catalyst

* Early work on xcframework support

* Improve legibility

* Somehow this works

* Specify ABIs in a place where they won't get erased

If you pass in the C/CXX flags from the Python script, they won't be respected. By doing it in the actual toolchain, the options are respected and Catalyst successfully links.

* Clean up and push updates

* Actually use Catalyst ABI

Needed to specify EXE linker flags to get compiler tests to link to the Catalyst ABIs.

* Clean up

* Revert changes to common toolchain that don't matter

* Try some things

* Support Catalyst build in OSX scripts

* Remove unnecessary iOS reference to AssetsLibrary framework

* Getting closer

* Try some things, port to Python 3

* Some additional fixes

* Point Cmake Plist gen to osx directory for Catalyst targets

* Remove dynamic lib references for Catalyst, copy iOS instead of macos

* Add flag for building only specified archs, remove iOS catalyst refs

* Add build-xcframework.sh

* Update build-xcframework.sh

* Add presumptive Apple Silicon support

* Add arm64 iphonesimulator target

* Fix xcframework build

* Working on arm64 iOS simulator

* Support 2.7 (replace run with check_output)

* Correctly check output of uname_m against arch

* Clean up

* Use lipo for intermediate frameworks, add python script

Remove unneeded __init__.py

* Simplify python xcframework build script

* Add --only-64-bit flag

* Add --framework-name flag

* Document

* Commit to f-strings, improve console output

* Add i386 to iphonesimulator platform in xcframework generator

* Enable objc for non-Catalyst frameworks

* Fix xcframework builder for paths with spaces

* Use arch when specifying Catalyst build platform in build command

* Fix incorrect settings for framework_name argparse configuration

* Prefer underscores instead of hyphens in new flags

* Move Catalyst flags to where they'll actually get used

* Use --without=objc on Catalyst target for now

* Remove get_or_create_folder and simplify logic

* Remove unused import

* Tighten up help text

* Document

* Move common functions into cv_build_utils

* Improve documentation

* Remove old build script

* Add readme

* Check for required CMake and Xcode versions

* Clean up TODOs and re-enable `copy_samples()`

Remove TODO

Fixup

* Add missing print_function import

* Clarify CMake dependency documentation

* Revert python2 change in gen_objc

* Remove unnecessary builtins imports

* Remove trailing whitespace

* Avoid building Catalyst unless specified

This makes Catalyst support a non-breaking change, though defaults should be specified when a breaking change is possible.

* Prevent lipoing for the same archs on different platforms before build

* Rename build-xcframework.py to build_xcframework.py

* Check for duplicate archs more carefully

* Prevent sample copying error when directory already exists

This can happen when building multiple architectures for the same platform.

* Simplify code for checking for default archs

* Improve build_xcframework.py header text

* Correctly resolve Python script paths

* Parse only known args in ios/osx build_framework.py

* Pass through uncaptured args in build_xcframework to osx/ios build

* Fix typo

* Fix typo

* Fix unparameterized build path for intermediate frameworks

* Fix dyanmic info.plist path for catalyst

* Fix utf-8 Python 3 issue

* Add dynamic flag to osx script

* Rename platform to platforms, remove armv7s and i386

* Fix creation of dynamic framework on maccatalyst and macos

* Update platforms/apple/readme.md

* Add `macos_archs` flag and deprecate `archs` flag

* Allow specification of archs when generating xcframework from terminal

* Change xcframework platform argument names to match archs flag names

* Remove platforms as a concept and shadow archs flags from ios/osx .py

* Improve documentation

* Fix building of objc module on Catalyst, excluding Swift

* Clean up build folder logic a bit

* Fix framework_name flag

* Drop passthrough_args, use unknown_args instead

* minor: coding style changes

Co-authored-by: Chris Ballinger <cballinger@rightpoint.com>
2020-11-24 21:54:54 +00:00
..
__init__.py Merge pull request #18826 from Rightpoint:feature/colejd/build-catalyst-xcframework 2020-11-24 21:54:54 +00:00
build_xcframework.py Merge pull request #18826 from Rightpoint:feature/colejd/build-catalyst-xcframework 2020-11-24 21:54:54 +00:00
cv_build_utils.py Merge pull request #18826 from Rightpoint:feature/colejd/build-catalyst-xcframework 2020-11-24 21:54:54 +00:00
readme.md Merge pull request #18826 from Rightpoint:feature/colejd/build-catalyst-xcframework 2020-11-24 21:54:54 +00:00

Building for Apple Platforms

build_xcframework.py creates an xcframework supporting a variety of Apple platforms.

You'll need the following to run these steps:

  • MacOS 10.15 or later
  • Python 3.6 or later
  • CMake 3.18.5/3.19.0 or later (make sure the cmake command is available on your PATH)
  • Xcode 12.2 or later (and its command line tools)

You can then run build_xcframework.py, as below:

cd ~/<my_working_directory>
python opencv/platforms/apple/build_xcframework.py ./build_xcframework

Grab a coffee, because you'll be here for a while. By default this builds OpenCV for 8 architectures across 4 platforms:

  • iOS (--iphoneos_archs): arm64, armv7
  • iOS Simulator (--iphonesimulator_archs): x86_64, arm64
  • macOS (--macos_archs): x86_64, arm64
  • Mac Catalyst (--catalyst_archs): x86_64, arm64

If everything's fine, you will eventually get opencv2.xcframework in the output directory.

The script has some configuration options to exclude platforms and architectures you don't want to build for. Use the --help flag for more information.

Examples

You may override the defaults by specifying a value for any of the *_archs flags. For example, if you want to build for arm64 on every platform, you can do this:

python build_xcframework.py somedir --iphoneos_archs arm64 --iphonesimulator_archs arm64 --macos_archs arm64 --catalyst_archs arm64

If you want to build only for certain platforms, you can supply the --build_only_specified_archs flag, which makes the script build only the archs you directly ask for. For example, to build only for Catalyst, you can do this:

python build_xcframework.py somedir --catalyst_archs x86_64,arm64 --build_only_specified_archs