visionOS support

[wtholliday]

I'm working on visionOS support here: https://github.com/AudioKit/onnxruntime/tree/visionos

Here's a quick link to compare my branch: main...AudioKit:onnxruntime:visionos

My build command is:

python3 tools/ci_build/github/apple/build_apple_framework.py tools/ci_build/github/apple/default_mobile_visionos_framework_build_settings.json --config Release

Error I'm getting is:

onnxruntime/core/providers/coreml/builders/coreml_spec.h:12:10: fatal error: 'coreml/Model.pb.h' file not found
#include "coreml/Model.pb.h"
         ^~~~~~~~~~~~~~~~~~~

Any help greatly appreciated :)

[yufenglee]

@skottmckay, could you please help on this?

[skottmckay]

That file would usually be generated by the build. Not sure what values cmake has for a visionOS build and whether the conditions at the start of this block need updating to support it.

onnxruntime/cmake/onnxruntime_providers_coreml.cmake

Lines 11 to 37 in 465540d

	if (CMAKE_SYSTEM_NAME STREQUAL "Darwin" OR CMAKE_SYSTEM_NAME STREQUAL "iOS")
	set(COREML_PROTO_ROOT ${PROJECT_SOURCE_DIR}/../onnxruntime/core/providers/coreml/mlmodel_format)
	file(GLOB coreml_proto_srcs
	"${COREML_PROTO_ROOT}/*.proto"
	)
	onnxruntime_add_static_library(onnxruntime_coreml_proto ${coreml_proto_srcs})
	target_include_directories(onnxruntime_coreml_proto PUBLIC $<TARGET_PROPERTY:${PROTOBUF_LIB},INTERFACE_INCLUDE_DIRECTORIES> "${CMAKE_CURRENT_BINARY_DIR}")
	target_compile_definitions(onnxruntime_coreml_proto PUBLIC $<TARGET_PROPERTY:${PROTOBUF_LIB},INTERFACE_COMPILE_DEFINITIONS>)
	set_target_properties(onnxruntime_coreml_proto PROPERTIES COMPILE_FLAGS "-fvisibility=hidden")
	set_target_properties(onnxruntime_coreml_proto PROPERTIES COMPILE_FLAGS "-fvisibility-inlines-hidden")
	set(_src_sub_dir "coreml/")
	onnxruntime_protobuf_generate(
	APPEND_PATH
	GEN_SRC_SUB_DIR ${_src_sub_dir}
	IMPORT_DIRS ${COREML_PROTO_ROOT}
	TARGET onnxruntime_coreml_proto
	)
	if (NOT onnxruntime_BUILD_SHARED_LIB)
	install(TARGETS onnxruntime_coreml_proto
	ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
	LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
	RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
	FRAMEWORK DESTINATION ${CMAKE_INSTALL_BINDIR}
	)
	endif()
	endif()

[wtholliday]

Thanks! I changed some of those conditions and it builds know (branch is updated). lmk if you'd like me to make it into a proper PR.

[snnn]

Should be "visionOS".
See: https://cmake.org/cmake/help/latest/manual/cmake-toolchains.7.html#cross-compiling-for-ios-tvos-visionos-or-watchos

[skottmckay]

This PR is indirectly reworking the CoreML build setup a little to build the protobuf files on all platforms, so that specific check will go away. If there are other places that need to be aware of 'visionOS' a PR for those would be great.

[Ciyou]

I tried @wtholliday's fork and it does works with minimal build! But if I remove the --minimal_build option the build failed with below error:

ld: Undefined symbols:
  Provider_GetHost, referenced from:
      <initial-undefines>
  Provider_SetHost, referenced from:
      <initial-undefines>
clang: error: linker command failed with exit code 1 (use -v to see invocation)

My build command is:

['/opt/homebrew/opt/[email protected]/bin/python3.11', '/Users/xxx/Developer/onnxruntime/tools/ci_build/build.py', '--parallel', '--use_xcode', '--build_apple_framework', '--use_coreml', '--skip_tests', '--cmake_extra_defines=onnxruntime_BUILD_UNIT_TESTS=OFF', '--ios', '--apple_deploy_target=1.0', '--config=Release', '--apple_sysroot=xros', '--osx_arch=arm64', '--build_dir=/Users/ciyou/Developer/onnxruntime/build/apple_framework/intermediates/xros_arm64']

Wondering which piece is missing for the standard build with xros SDK. 🤔

[skottmckay]

Add "visionOS" here:

onnxruntime/cmake/onnxruntime_providers_cpu.cmake

Line 226 in 58f4921

AND NOT ${CMAKE_SYSTEM_NAME} MATCHES "Darwin|iOS"