mirror of
https://github.com/opencv/opencv.git
synced 2024-11-30 22:40:17 +08:00
3d9cb5329c
Add experimental support for Apple VisionOS platform #24136 ### Pull Request Readiness Checklist See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request - [x] I agree to contribute to the project under Apache 2 License. - [x] To the best of my knowledge, the proposed patch is not based on a code under GPL or another license that is incompatible with OpenCV - [x] The PR is proposed to the proper branch This is dependent on cmake support for VisionOs which is currently in progress. Creating PR now to test that there are no regressions in iOS and macOS builds
117 lines
6.6 KiB
Python
Executable File
117 lines
6.6 KiB
Python
Executable File
#!/usr/bin/env python
|
|
"""
|
|
The script builds OpenCV.framework for visionOS.
|
|
"""
|
|
|
|
from __future__ import print_function
|
|
import os, os.path, sys, argparse, traceback, multiprocessing
|
|
|
|
# import common code
|
|
# sys.path.insert(0, os.path.abspath(os.path.abspath(os.path.dirname(__file__))+'/../ios'))
|
|
from build_framework import Builder
|
|
sys.path.insert(0, os.path.abspath(os.path.abspath(os.path.dirname(__file__))+'/../apple'))
|
|
from cv_build_utils import print_error, get_cmake_version
|
|
|
|
XROS_DEPLOYMENT_TARGET='1.0' # default, can be changed via command line options or environment variable
|
|
|
|
class visionOSBuilder(Builder):
|
|
|
|
def checkCMakeVersion(self):
|
|
assert get_cmake_version() >= (3, 17), "CMake 3.17 or later is required. Current version is {}".format(get_cmake_version())
|
|
|
|
def getObjcTarget(self, target):
|
|
return 'visionos'
|
|
|
|
def getToolchain(self, arch, target):
|
|
toolchain = os.path.join(self.opencv, "platforms", "ios", "cmake", "Toolchains", "Toolchain-%s_Xcode.cmake" % target)
|
|
return toolchain
|
|
|
|
def getCMakeArgs(self, arch, target):
|
|
args = Builder.getCMakeArgs(self, arch, target)
|
|
args = args + [
|
|
'-DVISIONOS_ARCH=%s' % arch
|
|
]
|
|
return args
|
|
|
|
def getBuildCommand(self, arch, target):
|
|
buildcmd = [
|
|
"xcodebuild",
|
|
"XROS_DEPLOYMENT_TARGET=" + os.environ['XROS_DEPLOYMENT_TARGET'],
|
|
"ARCHS=%s" % arch,
|
|
"-sdk", target.lower(),
|
|
"-configuration", "Debug" if self.debug else "Release",
|
|
"-parallelizeTargets",
|
|
"-jobs", str(multiprocessing.cpu_count())
|
|
]
|
|
|
|
return buildcmd
|
|
|
|
def getInfoPlist(self, builddirs):
|
|
return os.path.join(builddirs[0], "visionos", "Info.plist")
|
|
|
|
|
|
if __name__ == "__main__":
|
|
folder = os.path.abspath(os.path.join(os.path.dirname(sys.argv[0]), "../.."))
|
|
parser = argparse.ArgumentParser(description='The script builds OpenCV.framework for visionOS.')
|
|
# TODO: When we can make breaking changes, we should make the out argument explicit and required like in build_xcframework.py.
|
|
parser.add_argument('out', metavar='OUTDIR', help='folder to put built framework')
|
|
parser.add_argument('--opencv', metavar='DIR', default=folder, help='folder with opencv repository (default is "../.." relative to script location)')
|
|
parser.add_argument('--contrib', metavar='DIR', default=None, help='folder with opencv_contrib repository (default is "None" - build only main framework)')
|
|
parser.add_argument('--without', metavar='MODULE', default=[], action='append', help='OpenCV modules to exclude from the framework. To exclude multiple, specify this flag again, e.g. "--without video --without objc"')
|
|
parser.add_argument('--disable', metavar='FEATURE', default=[], action='append', help='OpenCV features to disable (add WITH_*=OFF). To disable multiple, specify this flag again, e.g. "--disable tbb --disable openmp"')
|
|
parser.add_argument('--dynamic', default=False, action='store_true', help='build dynamic framework (default is "False" - builds static framework)')
|
|
parser.add_argument('--enable_nonfree', default=False, dest='enablenonfree', action='store_true', help='enable non-free modules (disabled by default)')
|
|
parser.add_argument('--visionos_deployment_target', default=os.environ.get('XROS_DEPLOYMENT_TARGET', XROS_DEPLOYMENT_TARGET), help='specify XROS_DEPLOYMENT_TARGET')
|
|
parser.add_argument('--visionos_archs', default=None, help='select visionOS target ARCHS. Default is none')
|
|
parser.add_argument('--visionsimulator_archs', default=None, help='select visionSimulator target ARCHS. Default is none')
|
|
parser.add_argument('--debug', action='store_true', help='Build "Debug" binaries (CMAKE_BUILD_TYPE=Debug)')
|
|
parser.add_argument('--debug_info', action='store_true', help='Build with debug information (useful for Release mode: BUILD_WITH_DEBUG_INFO=ON)')
|
|
parser.add_argument('--framework_name', default='opencv2', dest='framework_name', help='Name of OpenCV framework (default: opencv2, will change to OpenCV in future version)')
|
|
parser.add_argument('--legacy_build', default=False, dest='legacy_build', action='store_true', help='Build legacy framework (default: False, equivalent to "--framework_name=opencv2 --without=objc")')
|
|
parser.add_argument('--run_tests', default=False, dest='run_tests', action='store_true', help='Run tests')
|
|
parser.add_argument('--build_docs', default=False, dest='build_docs', action='store_true', help='Build docs')
|
|
parser.add_argument('--disable-swift', default=False, dest='swiftdisabled', action='store_true', help='Disable building of Swift extensions')
|
|
|
|
args, unknown_args = parser.parse_known_args()
|
|
if unknown_args:
|
|
print("The following args are not recognized and will not be used: %s" % unknown_args)
|
|
|
|
os.environ['XROS_DEPLOYMENT_TARGET'] = args.visionos_deployment_target
|
|
print('Using XROS_DEPLOYMENT_TARGET=' + os.environ['XROS_DEPLOYMENT_TARGET'])
|
|
|
|
visionos_archs = None
|
|
if args.visionos_archs:
|
|
visionos_archs = args.visionos_archs.split(',')
|
|
print('Using visionOS ARCHS=' + str(visionos_archs))
|
|
|
|
visionsimulator_archs = None
|
|
if args.visionsimulator_archs:
|
|
visionsimulator_archs = args.visionsimulator_archs.split(',')
|
|
print('Using visionOS ARCHS=' + str(visionsimulator_archs))
|
|
|
|
# Prevent the build from happening if the same architecture is specified for multiple platforms.
|
|
# When `lipo` is run to stitch the frameworks together into a fat framework, it'll fail, so it's
|
|
# better to stop here while we're ahead.
|
|
if visionos_archs and visionsimulator_archs:
|
|
duplicate_archs = set(visionos_archs).intersection(visionsimulator_archs)
|
|
if duplicate_archs:
|
|
print_error("Cannot have the same architecture for multiple platforms in a fat framework! Consider using build_xcframework.py in the apple platform folder instead. Duplicate archs are %s" % duplicate_archs)
|
|
exit(1)
|
|
|
|
if args.legacy_build:
|
|
args.framework_name = "opencv2"
|
|
if not "objc" in args.without:
|
|
args.without.append("objc")
|
|
|
|
targets = []
|
|
if not visionos_archs and not visionsimulator_archs:
|
|
print_error("--visionos_archs and --visionsimulator_archs are undefined; nothing will be built.")
|
|
sys.exit(1)
|
|
if visionos_archs:
|
|
targets.append((visionos_archs, "XROS"))
|
|
if visionsimulator_archs:
|
|
targets.append((visionsimulator_archs, "XRSimulator")),
|
|
|
|
b = visionOSBuilder(args.opencv, args.contrib, args.dynamic, True, args.without, args.disable, args.enablenonfree, targets, args.debug, args.debug_info, args.framework_name, args.run_tests, args.build_docs, args.swiftdisabled)
|
|
b.build(args.out)
|