#!/usr/bin/env python """ The script builds OpenCV.framework for OSX. """ 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 MACOSX_DEPLOYMENT_TARGET='10.12' # default, can be changed via command line options or environment variable class OSXBuilder(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): # Obj-C generation target if target == "Catalyst": return 'ios' else: return 'osx' def getToolchain(self, arch, target): return None def getBuildCommand(self, arch, target): buildcmd = [ "xcodebuild", "MACOSX_DEPLOYMENT_TARGET=" + os.environ['MACOSX_DEPLOYMENT_TARGET'], "ARCHS=%s" % arch, "-sdk", "macosx" if target == "Catalyst" else target.lower(), "-configuration", "Debug" if self.debug else "Release", "-parallelizeTargets", "-jobs", str(multiprocessing.cpu_count()) ] if target == "Catalyst": buildcmd.append("-destination 'platform=macOS,arch=%s,variant=Mac Catalyst'" % arch) buildcmd.append("-UseModernBuildSystem=YES") buildcmd.append("SKIP_INSTALL=NO") buildcmd.append("BUILD_LIBRARY_FOR_DISTRIBUTION=YES") buildcmd.append("TARGETED_DEVICE_FAMILY=\"1,2\"") buildcmd.append("SDKROOT=iphoneos") buildcmd.append("SUPPORTS_MAC_CATALYST=YES") return buildcmd def getInfoPlist(self, builddirs): return os.path.join(builddirs[0], "osx", "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 OSX.') # 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('--macosx_deployment_target', default=os.environ.get('MACOSX_DEPLOYMENT_TARGET', MACOSX_DEPLOYMENT_TARGET), help='specify MACOSX_DEPLOYMENT_TARGET') parser.add_argument('--build_only_specified_archs', default=False, action='store_true', help='if enabled, only directly specified archs are built and defaults are ignored') parser.add_argument('--archs', default=None, help='(Deprecated! Prefer --macos_archs instead.) Select target ARCHS (set to "x86_64,arm64" to build Universal Binary for Big Sur and later). Default is "x86_64".') parser.add_argument('--macos_archs', default=None, help='Select target ARCHS (set to "x86_64,arm64" to build Universal Binary for Big Sur and later). Default is "x86_64"') parser.add_argument('--catalyst_archs', default=None, help='Select target ARCHS (set to "x86_64,arm64" to build Universal Binary for Big Sur and later). 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['MACOSX_DEPLOYMENT_TARGET'] = args.macosx_deployment_target print('Using MACOSX_DEPLOYMENT_TARGET=' + os.environ['MACOSX_DEPLOYMENT_TARGET']) macos_archs = None if args.archs: # The archs flag is replaced by macos_archs. If the user specifies archs, # treat it as if the user specified the macos_archs flag instead. args.macos_archs = args.archs print("--archs is deprecated! Prefer --macos_archs instead.") if args.macos_archs: macos_archs = args.macos_archs.split(',') elif not args.build_only_specified_archs: # Supply defaults macos_archs = ["x86_64"] print('Using MacOS ARCHS=' + str(macos_archs)) catalyst_archs = None if args.catalyst_archs: catalyst_archs = args.catalyst_archs.split(',') # TODO: To avoid breaking existing CI, catalyst_archs has no defaults. When we can make a breaking change, this should specify a default arch. print('Using Catalyst ARCHS=' + str(catalyst_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 macos_archs and catalyst_archs: duplicate_archs = set(macos_archs).intersection(catalyst_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 macos_archs and not catalyst_archs: print_error("--macos_archs and --catalyst_archs are undefined; nothing will be built.") sys.exit(1) if macos_archs: targets.append((macos_archs, "MacOSX")) if catalyst_archs: targets.append((catalyst_archs, "Catalyst")), b = OSXBuilder(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)