Packman Build Service PMBS

Changes of Revision 2

obs-studio-plugin-backgroundremoval.changes Changed

obs-studio-plugin-backgroundremoval.spec Changed

@@ -18,16 +18,16 @@
 %define _version %(v=%{version}; echo ${v%%~*})
 
 Name:           obs-studio-plugin-backgroundremoval
-Version:        0.4.0~gh.20220502T170138.cc9d4a5
+Version:        0.5.0
 Release:        0
 Summary:	Replace OBS background when screen recording
 License:        MIT
 Group:          Productivity/Multimedia/Video/Editors and Convertors
 Url:            https://github.com/royshil/obs-backgroundremoval
 Source:         %{_tarball}-%{version}.tar.xz
-Source1:        onnxruntime-linux-x64-1.12.1.tgz
+Source1:        onnxruntime-linux-x64-1.14.1.tgz
 Source2:        %{name}-rpmlintrc
-Patch:          fix-onnx.patch
+#Patch:          fix-onnx.patch
 BuildRequires:  xz
 BuildRequires:  cmake
 BuildRequires:  git
@@ -46,19 +46,29 @@
 easy to replace the background when screen recording.
 
 %prep
-%setup -q -n %{_tarball}-%{version}
-%autopatch -p1
+%autosetup -p1 -n %{_tarball}-%{version}
 sed -i "s/^version_from_git/#&/" CMakeLists.txt
+# we're not MacOS, hence we don't have any business with framework options
+sed -i "s/set_target_properties/#set_target_properties/" CMakeLists.txt
 
 %build
 mkdir -p %{_builddir}/usr/local/
 tar xvf %{SOURCE1} --strip-components=1 -C %{_builddir}/usr/local/ --wildcards "*/include/*" "*/lib*/"
 mv %{_builddir}/usr/local/lib %{_builddir}/usr/local/%_lib
-#ls -la %{_builddir}/usr/local/include %{_builddir}/usr/local/%_lib
+#ls -la %%{_builddir}/usr/local/include %%{_builddir}/usr/local/%%_lib
 
 %cmake \
+    -DCMAKE_VERBOSE_MAKEFILE=ON \
+    -DCMAKE_CXX_FLAGS:STRING="$CXXFLAGS %{optflags} -Wno-error=sequence-point" \
     -DCMAKE_CXX_STANDARD=17 \
+    -DCMAKE_SKIP_RPATH=ON \
     -DVERSION=%{_version} \
+    -DLINUX_PORTABLE=OFF \
+    -DCPACK_SET_DESTDIR=OFF \
+    -DCMAKE_INSTALL_PREFIX=/usr \
+    -DCMAKE_INSTALL_LIBDIR=%{_libdir} \
+    -DOBS_OUTPUT_DIR=%{_libdir} \
+    -DOBS_PLUGIN_DESTINATION=%{_datadir}/obs/obs-plugins \
     -DobsIncludePath=/usr/include/obs/ \
     -DOnnxruntime_INCLUDE_DIRS="%{_builddir}/usr/local/include" \
     -DOnnxruntime_INCLUDE_DIR="%{_builddir}/usr/local/include" \
@@ -66,8 +76,10 @@
 
 %install
 %cmake_install
-mkdir %{buildroot}/usr/local/
+mkdir -p %{buildroot}/usr/local/
 cp -a %{_builddir}/usr/local/%_lib %{buildroot}/usr/local/
+# remove stray installation files
+rm -r %{buildroot}/home
 
 %post -p /sbin/ldconfig

_service Changed

_service.main Added

_servicedata Changed

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/.github/workflows/cmake.yml Deleted

@@ -1,46 +0,0 @@
-name: CMake
-
-on:
-  push:
-    branches:  main 
-  pull_request:
-    branches:  main 
-
-env:
-  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
-  BUILD_TYPE: Release
-
-jobs:
-  build:
-    # The CMake configure and build commands are platform agnostic and should work equally
-    # well on Windows or Mac.  You can convert this to a matrix build if you need
-    # cross-platform coverage.
-    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-      with:
-        fetch-depth: 0
-    
-    - name: Install prerequisites 
-      run: sudo apt-get update && sudo apt-get install -y libobs-dev libopencv-dev language-pack-en wget git
-      
-    - name: Download ONNX runtime
-      run: wget https://github.com/microsoft/onnxruntime/releases/download/v1.7.0/onnxruntime-linux-x64-1.7.0.tgz && sudo tar xzvf onnxruntime-linux-x64-1.7.0.tgz --strip-components=1 -C /usr/local/ --wildcards "*/include/*" "*/lib*/"
-
-    - name: Configure CMake
-      # Configure CMake in a 'build' subdirectory. `CMAKE_BUILD_TYPE` is only required if you are using a single-configuration generator such as make.
-      # See https://cmake.org/cmake/help/latest/variable/CMAKE_BUILD_TYPE.html?highlight=cmake_build_type
-      run: cmake -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
-
-    - name: Build
-      # Build your program with the given configuration
-      run: cmake --build ${{github.workspace}}/build --config ${{env.BUILD_TYPE}}
-
-#     - name: Test
-#       working-directory: ${{github.workspace}}/build
-#       # Execute tests defined by the CMake configuration.  
-#       # See https://cmake.org/cmake/help/latest/manual/ctest.1.html for more detail
-#       run: ctest -C ${{env.BUILD_TYPE}}
-

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/azure-pipelines.yml Deleted

@@ -1,166 +0,0 @@
-variables:
-  macosSignAndNotarize: false
-  isReleaseMode: ${{ and(eq(variables'isReleaseMode', true), startsWith(variables'Build.SourceBranch', 'refs/tags/')) }}
-
-trigger:
-  branches:
-    include:
-      - master
-  tags:
-    include:
-      - '*'
-
-jobs:
-- job: 'Build_Windows'
-  pool:
-    vmImage: 'windows-2019'
-  variables:
-    build_config: RelWithDebInfo
-    DepsBasePath: 'D:\obsdependencies'
-    DepsPath32: '$(DepsBasePath)\win32'
-    DepsPath64: '$(DepsBasePath)\win64'
-    QtBaseDir: 'D:\QtDep'
-    QTDIR32: '$(QtBaseDir)\5.10.1\msvc2017'
-    QTDIR64: '$(QtBaseDir)\5.10.1\msvc2017_64'
-    OBSPath: 'D:\obs-studio'
-  steps:
-    - checkout: self
-      submodules: true
-
-    - script: ./ci/windows/install-qt-win.cmd
-      displayName: 'Install Qt'
-      env:
-        QtBaseDir: $(QtBaseDir)
-
-    - task: Cache@2
-      displayName: Restore cached OBS Studio dependencies
-      inputs:
-        key: 'obsdeps | "$(Agent.OS)"'
-        restoreKeys: |
-          obsdeps | "$(Agent.OS)"
-        path: $(DepsBasePath)
-
-    - script: ./ci/windows/download-obs-deps.cmd
-      displayName: 'Download OBS Studio dependencies'
-
-    - task: Cache@2
-      displayName: Restore cached OBS Studio builds
-      inputs:
-        key: 'obs | "$(Agent.OS)"'
-        restoreKeys: |
-          obs | "$(Agent.OS)"
-        path: $(OBSPath)
-
-    - script: ./ci/windows/prepare-obs-windows.cmd
-      displayName: 'Checkout & CMake OBS Studio'
-      env:
-        build_config: $(build_config)
-        DepsPath32: $(DepsPath32)
-        DepsPath64: $(DepsPath64)
-        QTDIR32: $(QTDIR32)
-        QTDIR64: $(QTDIR64)
-        OBSPath: $(OBSPath)
-
-    - task: MSBuild@1
-      displayName: 'Build OBS Studio 32-bit'
-      inputs:
-        msbuildArguments: '/m /p:Configuration=$(build_config)'
-        solution: '$(OBSPath)\build32\obs-studio.sln'
-
-    - task: MSBuild@1
-      displayName: 'Build OBS Studio 64-bit'
-      inputs:
-        msbuildArguments: '/m /p:Configuration=$(build_config)'
-        solution: '$(OBSPath)\build64\obs-studio.sln'
-
-    - script: ./ci/windows/prepare-windows.cmd
-      displayName: 'CMake Plugin'
-      env:
-        build_config: $(build_config)
-        QTDIR32: $(QTDIR32)
-        QTDIR64: $(QTDIR64)
-        OBSPath: $(OBSPath)
-
-    - task: MSBuild@1
-      displayName: 'Build Plugin 32-bit'
-      inputs:
-        msbuildArguments: '/m /p:Configuration=$(build_config)'
-        solution: '.\build32\main.sln'
-
-    - task: MSBuild@1
-      displayName: 'Build Plugin 64-bit'
-      inputs:
-        msbuildArguments: '/m /p:Configuration=$(build_config)'
-        solution: '.\build64\main.sln'
-
-    - script: ./ci/windows/package-windows.cmd
-      displayName: 'Package Plugin'
-
-    - task: PublishBuildArtifacts@1
-      displayName: 'Upload package artifacts'
-      inputs:
-        pathtoPublish: './package'
-        artifactName: 'windows_build'
-
-- job: 'Build_Linux'
-  pool:
-    vmImage: 'ubuntu-18.04'
-  variables:
-      BUILD_REASON: $(Build.Reason)
-      BRANCH_SHORT_NAME: $(Build.SourceBranchName)
-      BRANCH_FULL_NAME: $(Build.SourceBranch)
-  steps:
-    - checkout: self
-      submodules: true
-
-    - script: ./ci/linux/install-dependencies-ubuntu.sh
-      displayName: 'Install dependencies'
-
-    - script: ./ci/linux/build-ubuntu.sh
-      displayName: 'Build Plugin'
-
-    - script: ./ci/linux/package-ubuntu.sh
-      displayName: 'Package Plugin'
-
-    - task: PublishBuildArtifacts@1
-      inputs:
-        pathtoPublish: './package'
-        artifactName: 'deb_build'
-
-- job: 'Build_macOS'
-  pool:
-    vmImage: 'macos-10.14'
-  steps:
-    - checkout: self
-      submodules: true
-
-    - script: ./ci/macos/install-dependencies-macos.sh
-      displayName: 'Install dependencies'
-
-    - script: ./ci/macos/install-build-obs-macos.sh
-      displayName: 'Build OBS'
-
-    - script: ./ci/macos/build-macos.sh
-      displayName: 'Build Plugin'
-
-    - task: InstallAppleCertificate@1
-      displayName: 'Install release signing certificates'
-      condition: eq(variables'isReleaseMode', true)
-      inputs:
-        certSecureFile: 'Certificates.p12'
-        certPwd: $(secrets.macOS.certificatesImportPassword)
-
-    - script: ./ci/macos/package-macos.sh
-      displayName: 'Package Plugin'
-      env:
-        RELEASE_MODE: $(isReleaseMode)
-        CODE_SIGNING_IDENTITY: $(secrets.macOS.codeSigningIdentity)
-        INSTALLER_SIGNING_IDENTITY: $(secrets.macOS.installerSigningIdentity)
-        AC_USERNAME: $(secrets.macOS.notarization.username)
-        AC_PASSWORD: $(secrets.macOS.notarization.password)
-        AC_PROVIDER_SHORTNAME: $(secrets.macOS.notarization.providerShortName)
-
-    - task: PublishBuildArtifacts@1
-      inputs:
-        pathtoPublish: './release'
-        artifactName: 'macos_build'

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/external Deleted

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/external/FindOnnxruntime.cmake Deleted

@@ -1,60 +0,0 @@
-# Try to find onnxruntime library
-# Once done this will define
-#  Onnxruntime_FOUND - if system found onnruntime library
-#  Onnxruntime_INCLUDE_DIRS - The onnruntime include directories
-#  Onnxruntime_LIBRARIES - The libraries needed to use onnxruntime
-#  Onnxruntime_LIBRARY_DIR - The directory of onnxruntime libraries
-
-set(Onnxruntime_DIR_BUILD ${CMAKE_BINARY_DIR}/onnxruntime/)
-if(APPLE AND EXISTS ${Onnxruntime_DIR_BUILD})
-    file(GLOB Onnxruntime_LIBRARIES_EX ${Onnxruntime_DIR_BUILD}/lib/lib*.a)
-    set(Onnxruntime_LIBRARIES ${Onnxruntime_LIBRARIES_EX} CACHE STRING "Onnxruntime libraries")
-    set(Onnxruntime_INCLUDE_DIR ${Onnxruntime_DIR_BUILD}/include CACHE STRING "Onnxruntime include directory")
-else()
-    if (WITH_CUDA)
-        set(ONNXRUNTIME_DIR_HINT ${CMAKE_BINARY_DIR}/nuget/Microsoft.ML.OnnxRuntime.Gpu.1.11.0/)
-    else()
-        set(ONNXRUNTIME_DIR_HINT ${CMAKE_BINARY_DIR}/nuget/Microsoft.ML.OnnxRuntime.DirectML.1.11.0/)
-    endif()
-
-    find_library(Onnxruntime_LIBRARIES
-        NAMES
-            onnxruntime
-        PATHS
-            ${Onnxruntime_DIR}
-            ${ONNXRUNTIME_DIR_HINT}runtimes/win-x64/native
-        DOC "Onnxruntime library")
-
-    find_path(Onnxruntime_INCLUDE_DIR
-        NAMES
-            "onnxruntime_cxx_api.h"
-            "onnxruntime/core/session/onnxruntime_cxx_api.h"
-        PATHS
-            ${Onnxruntime_INCLUDE_HINT}
-            ${ONNXRUNTIME_DIR_HINT}build/native/include
-        DOC "Onnxruntime include directory")
-endif()
-
-
-
-include(FindPackageHandleStandardArgs)
-# handle the QUIETLY and REQUIRED arguments and set LOGGING_FOUND to TRUE
-# if all listed variables are TRUE
-find_package_handle_standard_args(Onnxruntime DEFAULT_MSG Onnxruntime_INCLUDE_DIR Onnxruntime_LIBRARIES)
-
-if (Onnxruntime_FOUND)
-    set(Onnxruntime_INCLUDE_DIRS ${Onnxruntime_INCLUDE_DIR} CACHE STRING "Onnxruntime include directories")
-    if (APPLE)
-        set(Onnxruntime_INCLUDE_DIRS ${Onnxruntime_INCLUDE_DIRS} ${Onnxruntime_INCLUDE_DIR}/onnxruntime/core/session)
-    endif()
-    list(GET Onnxruntime_LIBRARIES 0 Onnxruntime_LIBRARY)
-    get_filename_component(Onnxruntime_LIBRARY_DIR_EX ${Onnxruntime_LIBRARY} DIRECTORY)
-    set(Onnxruntime_LIBRARY_DIR ${Onnxruntime_LIBRARY_DIR_EX} CACHE STRING "Onnxruntime library directory")
-endif()
-
-# Tell cmake GUIs to ignore the "local" variables.
-mark_as_advanced(Onnxruntime_INCLUDE_DIR
-                 Onnxruntime_LIBRARY
-                 Onnxruntime_INCLUDE_DIRS
-                 Onnxruntime_LIBRARY_DIR
-                 Onnxruntime_LIBRARIES)

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/external/MunkeiVersionFromGit.cmake Deleted

@@ -1,167 +0,0 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2016-2017 Theo Willows
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
-cmake_minimum_required( VERSION 3.0.0 )
-
-include( CMakeParseArguments )
-
-function( version_from_git )
-  # Parse arguments
-  set( options OPTIONAL FAST )
-  set( oneValueArgs
-    GIT_EXECUTABLE
-    INCLUDE_HASH
-    LOG
-    TIMESTAMP
-    )
-  set( multiValueArgs )
-  cmake_parse_arguments( ARG "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN} )
-
-  # Defaults
-  if( NOT DEFINED ARG_INCLUDE_HASH )
-    set( ARG_INCLUDE_HASH ON )
-  endif()
-
-  if( DEFINED ARG_GIT_EXECUTABLE )
-    set( GIT_EXECUTABLE "${ARG_GIT_EXECUTABLE}" )
-  else ()
-    # Find Git or bail out
-    find_package( Git )
-    if( NOT GIT_FOUND )
-      message( FATAL_ERROR "MunkeiVersionFromGit Git not found" )
-    endif( NOT GIT_FOUND )
-  endif()
-
-  # Git describe
-  execute_process(
-    COMMAND           "${GIT_EXECUTABLE}" describe --tags
-    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-    RESULT_VARIABLE   git_result
-    OUTPUT_VARIABLE   git_describe
-    ERROR_VARIABLE    git_error
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-    ERROR_STRIP_TRAILING_WHITESPACE
-    )
-  if( NOT git_result EQUAL 0 )
-    message( FATAL_ERROR
-      "MunkeiVersionFromGit Failed to execute Git: ${git_error}"
-      )
-  endif()
-
-  # Get Git tag
-  execute_process(
-    COMMAND           "${GIT_EXECUTABLE}" describe --tags --abbrev=0
-    WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
-    RESULT_VARIABLE   git_result
-    OUTPUT_VARIABLE   git_tag
-    ERROR_VARIABLE    git_error
-    OUTPUT_STRIP_TRAILING_WHITESPACE
-    ERROR_STRIP_TRAILING_WHITESPACE
-    )
-  if( NOT git_result EQUAL 0 )
-    message( FATAL_ERROR
-      "MunkeiVersionFromGit Failed to execute Git: ${git_error}"
-      )
-  endif()
-
-  if( git_tag MATCHES "^v(0|1-90-9*).(0|1-90-9*).(0|1-90-9*)(-.0-9A-Za-z-+)?(+.0-9A-Za-z-+)?$" )
-    set( version_major "${CMAKE_MATCH_1}" )
-    set( version_minor "${CMAKE_MATCH_2}" )
-    set( version_patch "${CMAKE_MATCH_3}" )
-    set( identifiers   "${CMAKE_MATCH_4}" )
-    set( metadata      "${CMAKE_MATCH_5}" )
-  else()
-    message( FATAL_ERROR
-      "MunkeiVersionFromGit Git tag isn't valid semantic version: ${git_tag}"
-      )
-  endif()
-
-  if( "${git_tag}" STREQUAL "${git_describe}" )
-    set( git_at_a_tag ON )
-  endif()
-
-  if( NOT git_at_a_tag )
-    # Extract the Git hash (if one exists)
-    string( REGEX MATCH "g0-9a-f+$" git_hash "${git_describe}" )
-  endif()
-
-  # Construct the version variables
-  set( version ${version_major}.${version_minor}.${version_patch} )
-  set( semver  ${version} )
-
-  # Identifiers
-  if( identifiers MATCHES ".+" )
-    string( SUBSTRING "${identifiers}" 1 -1 identifiers )
-    set( semver "${semver}-${identifiers}")
-  endif()
-
-  # Metadata
-  # TODO Split and join (add Git hash inbetween)
-  if( metadata MATCHES ".+" )
-    string( SUBSTRING "${metadata}" 1 -1 metadata )
-    # Split
-    string( REPLACE "." ";" metadata "${metadata}" )
-  endif()
-
-  if( NOT git_at_a_tag )
-
-    if( ARG_INCLUDE_HASH )
-      list( APPEND metadata "${git_hash}" )
-    endif( ARG_INCLUDE_HASH )
-
-    # Timestamp
-    if( DEFINED ARG_TIMESTAMP )
-      string( TIMESTAMP timestamp "${ARG_TIMESTAMP}" ${ARG_UTC} )
-      list( APPEND metadata "${timestamp}" )
-    endif( DEFINED ARG_TIMESTAMP )
-
-  endif()
-
-  # Join
-  string( REPLACE ";" "." metadata "${metadata}" )
-
-  if( metadata MATCHES ".+" )
-    set( semver "${semver}+${metadata}")
-  endif()
-
-  # Log the results
-  if( ARG_LOG )
-    message( STATUS
-      "MunkeiVersionFromGit Version: ${version}
-     Git tag:     ${git_tag}
-     Git hash:    ${git_hash}
-     Decorated:   ${git_describe}
-     Identifiers: ${identifiers}
-     Metadata:    ${metadata}
-     SemVer:      ${semver}"
-      )
-  endif( ARG_LOG )
-
-  # Set parent scope variables
-  set( GIT_TAG       ${git_tag}       PARENT_SCOPE )
-  set( SEMVER        ${semver}        PARENT_SCOPE )
-  set( VERSION       ${version}       PARENT_SCOPE )
-  set( VERSION_MAJOR ${version_major} PARENT_SCOPE )
-  set( VERSION_MINOR ${version_minor} PARENT_SCOPE )
-  set( VERSION_PATCH ${version_patch} PARENT_SCOPE )
-
-endfunction( version_from_git )

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/external/ObsPluginHelpers.cmake Deleted

@@ -1,373 +0,0 @@
-if(POLICY CMP0087)
- cmake_policy(SET CMP0087 NEW)
-endif()
-
-set(OBS_STANDALONE_PLUGIN_DIR "${CMAKE_SOURCE_DIR}/release")
-
-include(GNUInstallDirs)
-if("${CMAKE_SYSTEM_NAME}" STREQUAL "Darwin")
- set(OS_MACOS ON)
- set(OS_POSIX ON)
-elseif("${CMAKE_SYSTEM_NAME}" MATCHES "Linux|FreeBSD|OpenBSD")
- set(OS_POSIX ON)
- string(TOUPPER "${CMAKE_SYSTEM_NAME}" _SYSTEM_NAME_U)
- set(OS_${_SYSTEM_NAME_U} ON)
-elseif("${CMAKE_SYSTEM_NAME}" STREQUAL "Windows")
- set(OS_WINDOWS ON)
- set(OS_POSIX OFF)
-endif()
-
-# Old-Style plugin detected, find "modern" libobs variant instead and set global
-# include directories to fix "bad" plugin behavior
-if(DEFINED LIBOBS_INCLUDE_DIR AND NOT TARGET OBS::libobs)
- message(
- DEPRECATION
- "You are using an outdated method of adding 'libobs' to your project. Refer to the updated wiki on how to build and export 'libobs' and use it in your plugin projects."
- )
- find_package(libobs REQUIRED)
- if(TARGET OBS::libobs)
- set_target_properties(OBS::libobs PROPERTIES IMPORTED_GLOBAL TRUE)
- message(STATUS "OBS: Using modern libobs target")
-
- add_library(libobs ALIAS OBS::libobs)
- if(OS_WINDOWS)
- add_library(w32-pthreads ALIAS OBS::w32-pthreads)
- endif()
- endif()
-endif()
-
-if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND (OS_WINDOWS OR OS_MACOS))
- set(CMAKE_INSTALL_PREFIX
- "${OBS_STANDALONE_PLUGIN_DIR}"
- CACHE STRING "Directory to install OBS plugin after building" FORCE)
-endif()
-
-if(NOT CMAKE_BUILD_TYPE)
- set(CMAKE_BUILD_TYPE
- "RelWithDebInfo"
- CACHE STRING
- "OBS build type Release, RelWithDebInfo, Debug, MinSizeRel" FORCE)
- set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS Release RelWithDebInfo
- Debug MinSizeRel)
-endif()
-
-file(RELATIVE_PATH RELATIVE_INSTALL_PATH "${CMAKE_SOURCE_DIR}"
- "${CMAKE_INSTALL_PREFIX}")
-file(RELATIVE_PATH RELATIVE_BUILD_PATH "${CMAKE_SOURCE_DIR}"
- "${CMAKE_BINARY_DIR}")
-
-# Set up OS-specific environment and helper functions
-if(OS_MACOS)
- if(NOT CMAKE_OSX_ARCHITECTURES)
- set(CMAKE_OSX_ARCHITECTURES
- "x86_64"
- CACHE
- STRING
- "OBS plugin build architecture for macOS - x86_64 required at least"
- FORCE)
- endif()
-
- if(NOT CMAKE_OSX_DEPLOYMENT_TARGET)
- set(CMAKE_OSX_DEPLOYMENT_TARGET
- "10.13"
- CACHE STRING "OBS plugin deployment target for macOS - 10.13+ required"
- FORCE)
- endif()
-
- if(NOT DEFINED OBS_CODESIGN_LINKER)
- set(OBS_CODESIGN_LINKER
- ON
- CACHE BOOL "Enable linker code-signing on macOS (macOS 11+ required"
- FORCE)
- endif()
-
- if(NOT DEFINED OBS_BUNDLE_CODESIGN_IDENTITY)
- set(OBS_BUNDLE_CODESIGN_IDENTITY
- "-"
- CACHE STRING "Codesign identity for macOS" FORCE)
- endif()
-
- # Xcode configuration
- if(XCODE)
- # Tell Xcode to pretend the linker signed binaries so that editing with
- # install_name_tool preserves ad-hoc signatures. This option is supported by
- # `codesign` on macOS 11 or higher.
- #
- # See CMake Issue 21854:
- # (https://gitlab.kitware.com/cmake/cmake/-/issues/21854).
-
- set(CMAKE_XCODE_GENERATE_SCHEME ON)
- if(OBS_CODESIGN_LINKER)
- set(CMAKE_XCODE_ATTRIBUTE_OTHER_CODE_SIGN_FLAGS "-o linker-signed")
- endif()
- endif()
-
- # Set default options for bundling on macOS
- set(CMAKE_MACOSX_RPATH ON)
- set(CMAKE_SKIP_BUILD_RPATH OFF)
- set(CMAKE_BUILD_WITH_INSTALL_RPATH OFF)
- set(CMAKE_INSTALL_RPATH "@executable_path/../Frameworks/")
- set(CMAKE_INSTALL_RPATH_USE_LINK_PATH OFF)
-
- function(setup_plugin_target target)
- if(NOT DEFINED MACOSX_PLUGIN_GUI_IDENTIFIER)
- message(
- FATAL_ERROR
- "No 'MACOSX_PLUGIN_GUI_IDENTIFIER' set, but is required to build plugin bundles on macOS - example: 'com.yourname.pluginname'"
- )
- endif()
-
- if(NOT DEFINED MACOSX_PLUGIN_BUNDLE_VERSION)
- message(
- FATAL_ERROR
- "No 'MACOSX_PLUGIN_BUNDLE_VERSION' set, but is required to build plugin bundles on macOS - example: '25'"
- )
- endif()
-
- if(NOT DEFINED MACOSX_PLUGIN_SHORT_VERSION_STRING)
- message(
- FATAL_ERROR
- "No 'MACOSX_PLUGIN_SHORT_VERSION_STRING' set, but is required to build plugin bundles on macOS - example: '1.0.2'"
- )
- endif()
-
- set(MACOSX_PLUGIN_BUNDLE_NAME
- "${target}"
- PARENT_SCOPE)
- set(MACOSX_PLUGIN_BUNDLE_VERSION
- "${MACOSX_BUNDLE_BUNDLE_VERSION}"
- PARENT_SCOPE)
- set(MACOSX_PLUGIN_SHORT_VERSION_STRING
- "${MACOSX_BUNDLE_SHORT_VERSION_STRING}"
- PARENT_SCOPE)
- set(MACOSX_PLUGIN_EXECUTABLE_NAME
- "${target}"
- PARENT_SCOPE)
- set(MACOSX_PLUGIN_BUNDLE_TYPE
- "BNDL"
- PARENT_SCOPE)
-
- install(
- TARGETS ${target}
- LIBRARY DESTINATION "."
- COMPONENT obs_plugins
- NAMELINK_COMPONENT ${target}_Development)
-
- set(_COMMAND
- "${CMAKE_INSTALL_NAME_TOOL} \\
- -change ${CMAKE_PREFIX_PATH}/lib/QtWidgets.framework/Versions/5/QtWidgets @rpath/QtWidgets.framework/Versions/5/QtWidgets \\
- -change ${CMAKE_PREFIX_PATH}/lib/QtCore.framework/Versions/5/QtCore @rpath/QtCore.framework/Versions/5/QtCore \\
- -change ${CMAKE_PREFIX_PATH}/lib/QtGui.framework/Versions/5/QtGui @rpath/QtGui.framework/Versions/5/QtGui \\
- \\\"\${CMAKE_INSTALL_PREFIX}/${target}.plugin/Contents/MacOS/${target}\\\""
- )
- install(CODE "execute_process(COMMAND /bin/sh -c \"${_COMMAND}\")"
- COMPONENT obs_plugins)
-
- if(NOT XCODE)
- set(_COMMAND
- "/usr/bin/codesign --force \\
- --sign \\\"${OBS_BUNDLE_CODESIGN_IDENTITY}\\\" \\
- --options runtime \\
- --entitlements \\\"${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/entitlements.plist\\\" \\
- \\\"${CMAKE_INSTALL_PREFIX}/${target}.plugin\\\"")
- install(CODE "execute_process(COMMAND /bin/sh -c \"${_COMMAND}\")"
- COMPONENT obs_plugins)
- endif()
-
- set_target_properties(
- ${target}
- PROPERTIES
- BUNDLE ON
- BUNDLE_EXTENSION "plugin"
- OUTPUT_NAME ${target}
- MACOSX_BUNDLE_INFO_PLIST
- "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/Plugin-Info.plist.in"
- XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER
- "${MACOSX_PLUGIN_GUI_IDENTIFIER}"
- XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY "${OBS_BUNDLE_CODESIGN_IDENTITY}"
- XCODE_ATTRIBUTE_CODE_SIGN_ENTITLEMENTS
- "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/../bundle/macOS/entitlements.plist")
-
- add_custom_command(
- TARGET ${target}
- POST_BUILD
- COMMAND
- /bin/sh -c
- "codesign --force --sign \"-\" $<$<BOOL:${OBS_CODESIGN_LINKER}>:--options linker-signed >\"$<TARGET_BUNDLE_DIR:${target}>\""
- COMMENT "Codesigning ${target}"
- VERBATIM)
-
- install_bundle_resources(${target})
- endfunction()
-
- function(install_bundle_resources target)
- if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
- file(GLOB_RECURSE _DATA_FILES "${CMAKE_CURRENT_SOURCE_DIR}/data/*")
- foreach(_DATA_FILE IN LISTS _DATA_FILES)
- file(RELATIVE_PATH _RELATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/data/
- ${_DATA_FILE})
- get_filename_component(_RELATIVE_PATH "${_RELATIVE_PATH}" PATH)
- target_sources(${target} PRIVATE ${_DATA_FILE})
- set_source_files_properties(
- ${_DATA_FILE} PROPERTIES MACOSX_PACKAGE_LOCATION
- "Resources/${_RELATIVE_PATH}")
- string(REPLACE "\\" "\\\\" _GROUP_NAME "${_RELATIVE_PATH}")
- source_group("Resources\\${_GROUP_NAME}" FILES ${_DATA_FILE})
- endforeach()
- endif()
- endfunction()
-else()
- if(CMAKE_SIZEOF_VOID_P EQUAL 8)
- set(_ARCH_SUFFIX 64)
- else()
- set(_ARCH_SUFFIX 32)
- endif()
- set(OBS_OUTPUT_DIR "${CMAKE_BINARY_DIR}/rundir")
-
- if(OS_POSIX)
- option(LINUX_PORTABLE "Build portable version (Linux)" OFF)
- if(NOT LINUX_PORTABLE)
- set(OBS_LIBRARY_DESTINATION "${CMAKE_INSTALL_LIBDIR}")
- set(OBS_PLUGIN_DESTINATION "${OBS_LIBRARY_DESTINATION}/obs-plugins")
- set(CMAKE_INSTALL_RPATH "${CMAKE_INSTALL_PREFIX}/lib")
- set(OBS_DATA_DESTINATION "${CMAKE_INSTALL_DATAROOTDIR}/obs")
- else()
- set(OBS_LIBRARY_DESTINATION "bin/${_ARCH_SUFFIX}bit")
- set(OBS_PLUGIN_DESTINATION "obs-plugins/${_ARCH_SUFFIX}bit")
- set(CMAKE_INSTALL_RPATH
- "$ORIGIN/" "${CMAKE_INSTALL_PREFIX}/${OBS_LIBRARY_DESTINATION}")
- set(OBS_DATA_DESTINATION "data")
- endif()
-
- if(OS_LINUX)
- set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
- set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${LINUX_MAINTAINER_EMAIL}")
- set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}")
-
- set(CPACK_GENERATOR "DEB")
- set(CPACK_DEBIAN_PACKAGE_DEPENDS
- "obs-studio (>= 27.0.0), libqt5core5a (>= 5.9.0~beta), libqt5gui5 (>= 5.3.0), libqt5widgets5 (>= 5.7.0)"
- )
-
- if(NOT LINUX_PORTABLE)
- set(CPACK_SET_DESTDIR ON)
- endif()
- include(CPack)
- endif()
- else()
- set(OBS_LIBRARY_DESTINATION "bin/${_ARCH_SUFFIX}bit")
- set(OBS_LIBRARY32_DESTINATION "bin/32bit")
- set(OBS_LIBRARY64_DESTINATION "bin/64bit")
- set(OBS_PLUGIN_DESTINATION "obs-plugins/${_ARCH_SUFFIX}bit")
- set(OBS_PLUGIN32_DESTINATION "obs-plugins/32bit")
- set(OBS_PLUGIN64_DESTINATION "obs-plugins/64bit")
-
- set(OBS_DATA_DESTINATION "data")
- endif()
-
- function(setup_plugin_target target)
- set_target_properties(${target} PROPERTIES PREFIX "")
-
- install(
- TARGETS ${target}
- RUNTIME DESTINATION "${OBS_PLUGIN_DESTINATION}"
- COMPONENT ${target}_Runtime
- LIBRARY DESTINATION "${OBS_PLUGIN_DESTINATION}"
- COMPONENT ${target}_Runtime
- NAMELINK_COMPONENT ${target}_Development)
-
- install(
- FILES "$<TARGET_FILE:${target}>"
- DESTINATION "$<CONFIG>/${OBS_PLUGIN_DESTINATION}"
- COMPONENT obs_rundir
- EXCLUDE_FROM_ALL)
-
- if(OS_WINDOWS)
- install(
- FILES "$<TARGET_PDB_FILE:${target}>"
- CONFIGURATIONS "RelWithDebInfo" "Debug"
- DESTINATION "$<CONFIG>/${OBS_PLUGIN_DESTINATION}"
- COMPONENT obs_rundir
- OPTIONAL EXCLUDE_FROM_ALL)
- endif()
-
- if(MSVC)
- target_link_options(
- ${target}
- PRIVATE
- "LINKER:/OPT:REF"
- "$<$<NOT:$<EQUAL:${CMAKE_SIZEOF_VOID_P},8>>:LINKER\:/SAFESEH\:NO>"
- "$<$<CONFIG:DEBUG>:LINKER\:/INCREMENTAL:NO>"
- "$<$<CONFIG:RELWITHDEBINFO>:LINKER\:/INCREMENTAL:NO>")
- endif()
-
- setup_target_resources("${target}" "obs-plugins/${target}")
-
- if(OS_WINDOWS AND DEFINED OBS_BUILD_DIR)
- setup_target_for_testing(${target})
- endif()
-
- add_custom_command(
- TARGET ${target}
- POST_BUILD
- COMMAND
- "${CMAKE_COMMAND}" -DCMAKE_INSTALL_PREFIX=${OBS_OUTPUT_DIR}
- -DCMAKE_INSTALL_COMPONENT=obs_rundir
- -DCMAKE_INSTALL_CONFIG_NAME=$<CONFIG> -P
- ${CMAKE_CURRENT_BINARY_DIR}/cmake_install.cmake
- COMMENT "Installing to plugin rundir"
- VERBATIM)
- endfunction()
-
- function(setup_target_resources target destination)
- if(EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/data")
- install(
- DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data/"
- DESTINATION "${OBS_DATA_DESTINATION}/${destination}"
- USE_SOURCE_PERMISSIONS
- COMPONENT obs_plugins)
-
- install(
- DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data"
- DESTINATION "$<CONFIG>/${OBS_DATA_DESTINATION}/${destination}"
- USE_SOURCE_PERMISSIONS
- COMPONENT obs_rundir
- EXCLUDE_FROM_ALL)
- endif()
- endfunction()
-
- if(OS_WINDOWS)
- function(setup_target_for_testing target)
- install(
- FILES "$<TARGET_FILE:${target}>"
- DESTINATION "$<CONFIG>/${OBS_PLUGIN_DESTINATION}"
- COMPONENT obs_testing
- EXCLUDE_FROM_ALL)
-
- install(
- FILES "$<TARGET_PDB_FILE:${target}>"
- CONFIGURATIONS "RelWithDebInfo" "Debug"
- DESTINATION "$<CONFIG>/${OBS_PLUGIN_DESTINATION}"
- COMPONENT obs_testing
- OPTIONAL EXCLUDE_FROM_ALL)
-
- install(
- DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/data"
- DESTINATION "$<CONFIG>/${OBS_DATA_DESTINATION}/${destination}"
- USE_SOURCE_PERMISSIONS
- COMPONENT obs_testing
- EXCLUDE_FROM_ALL)
-
- add_custom_command(
- TARGET ${target}
- POST_BUILD
- COMMAND
- "${CMAKE_COMMAND}" -DCMAKE_INSTALL_PREFIX=${OBS_BUILD_DIR}/rundir
- -DCMAKE_INSTALL_COMPONENT=obs_testing
- -DCMAKE_INSTALL_CONFIG_NAME=$<CONFIG> -P
- ${CMAKE_CURRENT_BINARY_DIR}/cmake_install.cmake
- COMMENT "Installing to OBS test directory"
- VERBATIM)
- endfunction()
- endif()
-endif()

obs-backgroundremoval-0.5.0.tar.xz/.clang-format Added

@@ -0,0 +1,107 @@
+# please use clang-format version 8 or later
+
+Standard: Cpp11
+AccessModifierOffset: -8
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: false
+AlignConsecutiveDeclarations: false
+AlignEscapedNewlines: Left
+AlignOperands: true
+AlignTrailingComments: true
+#AllowAllArgumentsOnNextLine: false  # requires clang-format 9
+#AllowAllConstructorInitializersOnNextLine: false  # requires clang-format 9
+AllowAllParametersOfDeclarationOnNextLine: false
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: false
+#AllowShortLambdasOnASingleLine: Inline  # requires clang-format 9
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: false
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass: false
+  AfterControlStatement: false
+  AfterEnum: false
+  AfterFunction: true
+  AfterNamespace: false
+  AfterObjCDeclaration: false
+  AfterStruct: false
+  AfterUnion: false
+  AfterExternBlock: false
+  BeforeCatch: false
+  BeforeElse: false
+  IndentBraces: false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Custom
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakStringLiterals: false  # apparently unpredictable
+ColumnLimit: 100
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 2
+ContinuationIndentWidth: 2
+Cpp11BracedListStyle: true
+DerivePointerAlignment: false
+DisableFormat: false
+FixNamespaceComments: false
+ForEachMacros:
+  - 'json_object_foreach'
+  - 'json_object_foreach_safe'
+  - 'json_array_foreach'
+IncludeBlocks: Preserve
+IndentCaseLabels: false
+IndentPPDirectives: None
+IndentWidth: 2
+IndentWrappedFunctionNames: false
+KeepEmptyLinesAtTheStartOfBlocks: true
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+#ObjCBinPackProtocolList: Auto  # requires clang-format 7
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: true
+ObjCSpaceBeforeProtocolList: true
+
+PenaltyBreakAssignment: 10
+PenaltyBreakBeforeFirstCallParameter: 30
+PenaltyBreakComment: 10
+PenaltyBreakFirstLessLess: 0
+PenaltyBreakString: 10
+PenaltyExcessCharacter: 100
+PenaltyReturnTypeOnItsOwnLine: 60
+
+PointerAlignment: Right
+ReflowComments: false
+SortIncludes: false
+SortUsingDeclarations: false
+SpaceAfterCStyleCast: false
+#SpaceAfterLogicalNot: false  # requires clang-format 9
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+#SpaceBeforeCtorInitializerColon: true  # requires clang-format 7
+#SpaceBeforeInheritanceColon: true  # requires clang-format 7
+SpaceBeforeParens: ControlStatements
+#SpaceBeforeRangeBasedForLoopColon: true  # requires clang-format 7
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 1
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+#StatementMacros:  # requires clang-format 8
+#  - 'Q_OBJECT'
+TabWidth: 2
+#TypenameMacros:  # requires clang-format 9
+#  - 'DARRAY'
+UseTab: Never
+---
+Language: ObjC

obs-backgroundremoval-0.5.0.tar.xz/.cmake-format.json Added

obs-backgroundremoval-0.5.0.tar.xz/.github/actions Added

obs-backgroundremoval-0.5.0.tar.xz/.github/actions/build-plugin Added

obs-backgroundremoval-0.5.0.tar.xz/.github/actions/build-plugin/action.yml Added

@@ -0,0 +1,82 @@
+name: 'Setup and build plugin'
+description: 'Builds the plugin for specified architecture and build config.'
+inputs:
+  target:
+    description: 'Build target for dependencies'
+    required: true
+  config:
+    description: 'Build configuration'
+    required: false
+    default: 'Release'
+  codesign:
+    description: 'Enable codesigning (macOS only)'
+    required: false
+    default: 'false'
+  codesignIdent:
+    description: 'Developer ID for application codesigning (macOS only)'
+    required: false
+    default: '-'
+  visualStudio:
+    description: 'Visual Studio version (Windows only)'
+    required: false
+    default: 'Visual Studio 16 2019'
+  workingDirectory:
+    description: 'Working directory for packaging'
+    required: false
+    default: ${{ github.workspace }}
+runs:
+  using: 'composite'
+  steps:
+    - name: Run macOS Build
+      if: ${{ runner.os == 'macOS' }}
+      shell: zsh {0}
+      env:
+        CODESIGN_IDENT: ${{ inputs.codesignIdent }}
+      run: |
+        set -e
+
+        ${{ inputs.workingDirectory }}/scripts/makeOnnxruntime_osx.sh
+        ${{ inputs.workingDirectory }}/scripts/makeOpenCV_osx.sh
+
+        build_args=(
+          -c ${{ inputs.config }}
+          -t macos-${{ inputs.target }}
+        )
+
+        if  '${{ inputs.codesign }}' == 'true'  build_args+=(-s)
+        if (( ${+CI} && ${+RUNNER_DEBUG} )) build_args+=(--debug)
+
+        ${{ inputs.workingDirectory }}/.github/scripts/build-macos.zsh ${build_args}
+
+    - name: Run Linux Build
+      if: ${{ runner.os == 'Linux' }}
+      shell: bash
+      run: |
+        build_args=(
+          -c ${{ inputs.config }}
+          -t linux-${{ inputs.target }}
+        )
+
+        if  -n "${CI}" && -n "${RUNNER_DEBUG}" ; then
+          build_args+=(--debug)
+        fi
+
+        ${{ inputs.workingDirectory }}/.github/scripts/build-linux.sh "${build_args@}"
+
+    - name: Run Windows Build
+      if: ${{ runner.os == 'Windows' }}
+      shell: pwsh
+      run: |
+        $BuildArgs = @{
+          Target = '${{ inputs.target }}'
+          Configuration = '${{ inputs.config }}'
+          CMakeGenerator = '${{ inputs.visualStudio }}'
+        }
+
+        if ( ( Test-Path env:CI ) -and ( Test-Path env:RUNNER_DEBUG ) ) {
+          $BuildArgs += @{
+            Debug = $true
+          }
+        }
+
+        ${{ inputs.workingDirectory }}/.github/scripts/Build-Windows.ps1 @BuildArgs

obs-backgroundremoval-0.5.0.tar.xz/.github/actions/package-plugin Added

obs-backgroundremoval-0.5.0.tar.xz/.github/actions/package-plugin/action.yml Added

@@ -0,0 +1,99 @@
+name: 'Package plugin'
+description: 'Packages the plugin for specified architecture and build config.'
+inputs:
+  target:
+    description: 'Build target for dependencies'
+    required: true
+  config:
+    description: 'Build configuration'
+    required: false
+    default: 'Release'
+  codesign:
+    description: 'Enable codesigning (macOS only)'
+    required: false
+    default: 'false'
+  notarize:
+    description: 'Enable notarization (macOS only)'
+    required: false
+    default: 'false'
+  codesignIdent:
+    description: 'Developer ID for application codesigning (macOS only)'
+    required: false
+    default: '-'
+  installerIdent:
+    description: 'Developer ID for installer package codesigning (macOS only)'
+    required: false
+    default: ''
+  codesignUser:
+    description: 'Apple ID username for notarization (macOS only)'
+    required: false
+    default: ''
+  codesignPass:
+    description: 'Apple ID password for notarization (macOS only)'
+    required: false
+    default: ''
+  createInstaller:
+    description: 'Create InnoSetup installer (Windows only)'
+    required: false
+    default: 'false'
+  workingDirectory:
+    description: 'Working directory for packaging'
+    required: false
+    default: ${{ github.workspace }}
+runs:
+  using: 'composite'
+  steps:
+    - name: Run macOS packaging
+      if: ${{ runner.os == 'macOS' }}
+      shell: zsh {0}
+      env:
+        CODESIGN_IDENT: ${{ inputs.codesignIdent }}
+        CODESIGN_IDENT_INSTALLER: ${{ inputs.installerIdent }}
+        CODESIGN_IDENT_USER: ${{ inputs.codesignUser }}
+        CODESIGN_IDENT_PASS: ${{ inputs.codesignPass }}
+      run: |
+        package_args=(
+          -c ${{ inputs.config }}
+          -t macos-${{ inputs.target }}
+        )
+
+        if  '${{ inputs.codesign }}' == 'true'  package_args+=(-s)
+        if  '${{ inputs.notarize }}' == 'true'  package_args+=(-n)
+        if (( ${+CI} && ${+RUNNER_DEBUG} )) build_args+=(--debug)
+
+        ${{ inputs.workingDirectory }}/.github/scripts/package-macos.zsh ${package_args}
+
+    - name: Run Linux packaging
+      if: ${{ runner.os == 'Linux' }}
+      shell: bash
+      run: |
+        package_args=(
+          -c ${{ inputs.config }}
+          -t linux-${{ inputs.target }}
+        )
+        if  -n "${CI}" && -n "${RUNNER_DEBUG}" ; then
+          build_args+=(--debug)
+        fi
+
+        ${{ inputs.workingDirectory }}/.github/scripts/package-linux.sh "${package_args@}"
+
+    - name: Run Windows packaging
+      if: ${{ runner.os == 'Windows' }}
+      shell: pwsh
+      run: |
+        $PackageArgs = @{
+          Target = '${{ inputs.target }}'
+          Configuration = '${{ inputs.config }}'
+        }
+
+        if ( '${{ inputs.createInstaller }}' -eq 'true' ) {
+          $PackageArgs += @{BuildInstaller = $true}
+        }
+
+        if ( ( Test-Path env:CI ) -and ( Test-Path env:RUNNER_DEBUG ) ) {
+          $BuildArgs += @{
+            Debug = $true
+          }
+        }
+
+        ${{ inputs.workingDirectory }}/.github/scripts/Package-Windows.ps1 @PackageArgs

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.Aptfile Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.Brewfile Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.Brewfile.lock.json Added

@@ -0,0 +1,405 @@
+{
+  "entries": {
+    "brew": {
+      "ccache": {
+        "version": "4.7.4",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:35341df4e3899eb409b712e1f59826fac4312c78581c016acdcd15515a454209",
+              "sha256": "35341df4e3899eb409b712e1f59826fac4312c78581c016acdcd15515a454209"
+            },
+            "arm64_monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:ba78c3c27dfe4cfa628d0dd799c289056e848e5cbbbc847117f2fae6e33949a6",
+              "sha256": "ba78c3c27dfe4cfa628d0dd799c289056e848e5cbbbc847117f2fae6e33949a6"
+            },
+            "arm64_big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:237f9ce565fa10a9bd43038bec4bf035cd44b136a849c45a12a00af18397833b",
+              "sha256": "237f9ce565fa10a9bd43038bec4bf035cd44b136a849c45a12a00af18397833b"
+            },
+            "ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:ff337e38d7d1a17c55bc60325e0fd197aa1f05b42f34f6180e35756a87e05508",
+              "sha256": "ff337e38d7d1a17c55bc60325e0fd197aa1f05b42f34f6180e35756a87e05508"
+            },
+            "monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:4e58ab93aa6690b1d754154b33c4e2fe457c6c2710aa29c208d1904cdd18f2dc",
+              "sha256": "4e58ab93aa6690b1d754154b33c4e2fe457c6c2710aa29c208d1904cdd18f2dc"
+            },
+            "big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:927efbcf6927bd90df8e15f4495ae614f9bce3b98601569dc1158cfc9ed5d4c2",
+              "sha256": "927efbcf6927bd90df8e15f4495ae614f9bce3b98601569dc1158cfc9ed5d4c2"
+            },
+            "catalina": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:acde8ffc90a1c59bfe423720193dd8d4059816f850e0fa01caaa92126d96bcab",
+              "sha256": "acde8ffc90a1c59bfe423720193dd8d4059816f850e0fa01caaa92126d96bcab"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ccache/blobs/sha256:cec1be15a66689bff21cdefd5244f13149f89f134398c0f67c38d4a4a75503cb",
+              "sha256": "cec1be15a66689bff21cdefd5244f13149f89f134398c0f67c38d4a4a75503cb"
+            }
+          }
+        }
+      },
+      "coreutils": {
+        "version": "9.1",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:ae9dc313da2a3971c8e633d9f3262fd1bd431c303207b3346924aed60bb0965d",
+              "sha256": "ae9dc313da2a3971c8e633d9f3262fd1bd431c303207b3346924aed60bb0965d"
+            },
+            "arm64_monterey": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:6a9a4988eda436fb5bdb5969044579c2e618e21eee8c8bbe32614ad29fe56bd7",
+              "sha256": "6a9a4988eda436fb5bdb5969044579c2e618e21eee8c8bbe32614ad29fe56bd7"
+            },
+            "arm64_big_sur": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:85ef910aa223d48c0e73fc187aba54b86930c86f906e3d079ed0b114762bb24e",
+              "sha256": "85ef910aa223d48c0e73fc187aba54b86930c86f906e3d079ed0b114762bb24e"
+            },
+            "ventura": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:4564009003601fb30335e57453cee93deaeab1eadf4473050e9e70198c21c892",
+              "sha256": "4564009003601fb30335e57453cee93deaeab1eadf4473050e9e70198c21c892"
+            },
+            "monterey": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:7c9f988b4f9207415a5c96efd32376bc8cf2b280a7a36fbebb0b8fc334a14056",
+              "sha256": "7c9f988b4f9207415a5c96efd32376bc8cf2b280a7a36fbebb0b8fc334a14056"
+            },
+            "big_sur": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:e446ef889d70bc377d67fa2d7f6a1fbc9faaee444a9e9086a1f5bd484069e5c0",
+              "sha256": "e446ef889d70bc377d67fa2d7f6a1fbc9faaee444a9e9086a1f5bd484069e5c0"
+            },
+            "catalina": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:0d2117fa63dfcbb678c4e499f9ca0413c2c5bfa0a1bbdefde620434f2ead93a0",
+              "sha256": "0d2117fa63dfcbb678c4e499f9ca0413c2c5bfa0a1bbdefde620434f2ead93a0"
+            },
+            "x86_64_linux": {
+              "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/coreutils/blobs/sha256:3c2fbec99344b50d620695d16197eb112cb8bee6d3f9e47cb682484755b91f38",
+              "sha256": "3c2fbec99344b50d620695d16197eb112cb8bee6d3f9e47cb682484755b91f38"
+            }
+          }
+        }
+      },
+      "cmake": {
+        "version": "3.25.2",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:9b84d2b9844ae326750b498d6143eba05ba90ba85e2413ff8bbba8df52b69cb7",
+              "sha256": "9b84d2b9844ae326750b498d6143eba05ba90ba85e2413ff8bbba8df52b69cb7"
+            },
+            "arm64_monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:9c795988bd14da5691a246221bbadff427ef2bdabe213a7f97ad5e69b3f8a39e",
+              "sha256": "9c795988bd14da5691a246221bbadff427ef2bdabe213a7f97ad5e69b3f8a39e"
+            },
+            "arm64_big_sur": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:cc74b5362b7fc2d4c51ba4ac5d0859bf0557ddeb4ac2a518522f31785af102f7",
+              "sha256": "cc74b5362b7fc2d4c51ba4ac5d0859bf0557ddeb4ac2a518522f31785af102f7"
+            },
+            "ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:f502d6ccb79b82ec25b2f4222c15d29e31fb906325ea80609d0e829ead9080f2",
+              "sha256": "f502d6ccb79b82ec25b2f4222c15d29e31fb906325ea80609d0e829ead9080f2"
+            },
+            "monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:e08c954dfd2cd60b1275370d6e5bbc569af9480fb70c224f4aec44306f04cef4",
+              "sha256": "e08c954dfd2cd60b1275370d6e5bbc569af9480fb70c224f4aec44306f04cef4"
+            },
+            "big_sur": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:6e98740a0ec57228faa96fbdeb0636c46577a9b5c5c803960513e9d16f4f0737",
+              "sha256": "6e98740a0ec57228faa96fbdeb0636c46577a9b5c5c803960513e9d16f4f0737"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/cmake/blobs/sha256:6ab7740bbe65b3c5fa816e986a347007c8608083862735ad990d1497779a7d82",
+              "sha256": "6ab7740bbe65b3c5fa816e986a347007c8608083862735ad990d1497779a7d82"
+            }
+          }
+        }
+      },
+      "git": {
+        "version": "2.39.2",
+        "bottle": {
+          "rebuild": 1,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:004d8ed1b21d911aafae1966eb45b7d8a31088bcc35ac06f1fc35d3469233717",
+              "sha256": "004d8ed1b21d911aafae1966eb45b7d8a31088bcc35ac06f1fc35d3469233717"
+            },
+            "arm64_monterey": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:52d8055f553e9824469713201f52f322b5a504dafc2911a95b28b3e479ae7172",
+              "sha256": "52d8055f553e9824469713201f52f322b5a504dafc2911a95b28b3e479ae7172"
+            },
+            "arm64_big_sur": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:faf68a6e8ac990edb9fa36f16082fb7be8ef653a0c9d07d1e679df60636c5a4c",
+              "sha256": "faf68a6e8ac990edb9fa36f16082fb7be8ef653a0c9d07d1e679df60636c5a4c"
+            },
+            "ventura": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:56418ddee3eaf22b5104e7e4e2b36ceebe53dfe8144e8ec47aef7f5fa78c4561",
+              "sha256": "56418ddee3eaf22b5104e7e4e2b36ceebe53dfe8144e8ec47aef7f5fa78c4561"
+            },
+            "monterey": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:77125b873d51672df91f127226edc3a2f80b3f7004e4480897cff9a96317aa27",
+              "sha256": "77125b873d51672df91f127226edc3a2f80b3f7004e4480897cff9a96317aa27"
+            },
+            "big_sur": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:374e657887cd20afda4a3d6d68d82a88ae9d7be67b0333b6a6dcba92b346e65e",
+              "sha256": "374e657887cd20afda4a3d6d68d82a88ae9d7be67b0333b6a6dcba92b346e65e"
+            },
+            "x86_64_linux": {
+              "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/git/blobs/sha256:cafb236f45da4ad3fddafac881f17554ac10df5f0a413ceabccbdb39ef189693",
+              "sha256": "cafb236f45da4ad3fddafac881f17554ac10df5f0a413ceabccbdb39ef189693"
+            }
+          }
+        }
+      },
+      "jq": {
+        "version": "1.6",
+        "bottle": {
+          "rebuild": 1,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:4622927182fbc7bf27c4b706e005fbae2700d15e69a68ef7002aed2676b8a4f7",
+              "sha256": "4622927182fbc7bf27c4b706e005fbae2700d15e69a68ef7002aed2676b8a4f7"
+            },
+            "arm64_monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:f70e1ae8df182b242ca004492cc0a664e2a8195e2e46f30546fe78e265d5eb87",
+              "sha256": "f70e1ae8df182b242ca004492cc0a664e2a8195e2e46f30546fe78e265d5eb87"
+            },
+            "arm64_big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:674b3ae41c399f1e8e44c271b0e6909babff9fcd2e04a2127d25e2407ea4dd33",
+              "sha256": "674b3ae41c399f1e8e44c271b0e6909babff9fcd2e04a2127d25e2407ea4dd33"
+            },
+            "ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:b70ec02353c5f6cb69d947e1506e71c96d2952ed4099ae3948c6c61420b16ef9",
+              "sha256": "b70ec02353c5f6cb69d947e1506e71c96d2952ed4099ae3948c6c61420b16ef9"
+            },
+            "monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:7fee6ea327062b37d34ef5346a84810a1752cc7146fff1223fab76c9b45686e0",
+              "sha256": "7fee6ea327062b37d34ef5346a84810a1752cc7146fff1223fab76c9b45686e0"
+            },
+            "big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:bf0f8577632af7b878b6425476f5b1ab9c3bf66d65affb0c455048a173a0b6bf",
+              "sha256": "bf0f8577632af7b878b6425476f5b1ab9c3bf66d65affb0c455048a173a0b6bf"
+            },
+            "catalina": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:820a3c85fcbb63088b160c7edf125d7e55fc2c5c1d51569304499c9cc4b89ce8",
+              "sha256": "820a3c85fcbb63088b160c7edf125d7e55fc2c5c1d51569304499c9cc4b89ce8"
+            },
+            "mojave": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:71f0e76c5b22e5088426c971d5e795fe67abee7af6c2c4ae0cf4c0eb98ed21ff",
+              "sha256": "71f0e76c5b22e5088426c971d5e795fe67abee7af6c2c4ae0cf4c0eb98ed21ff"
+            },
+            "high_sierra": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:dffcffa4ea13e8f0f2b45c5121e529077e135ae9a47254c32182231662ee9b72",
+              "sha256": "dffcffa4ea13e8f0f2b45c5121e529077e135ae9a47254c32182231662ee9b72"
+            },
+            "sierra": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:bb4d19dc026c2d72c53eed78eaa0ab982e9fcad2cd2acc6d13e7a12ff658e877",
+              "sha256": "bb4d19dc026c2d72c53eed78eaa0ab982e9fcad2cd2acc6d13e7a12ff658e877"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/jq/blobs/sha256:2beea2c2c372ccf1081e9a5233fc3020470803254284aeecc071249d76b62338",
+              "sha256": "2beea2c2c372ccf1081e9a5233fc3020470803254284aeecc071249d76b62338"
+            }
+          }
+        }
+      },
+      "ninja": {
+        "version": "1.11.1",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:6202ee2d9cdb003e70bd93acca07a070eb9145f0a2fe658d22ffd8119260b4bb",
+              "sha256": "6202ee2d9cdb003e70bd93acca07a070eb9145f0a2fe658d22ffd8119260b4bb"
+            },
+            "arm64_monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:daa36dfde4c007ccbc92a7b011fb21f475619ee72ee7b9fe4e287bbf69febcc7",
+              "sha256": "daa36dfde4c007ccbc92a7b011fb21f475619ee72ee7b9fe4e287bbf69febcc7"
+            },
+            "arm64_big_sur": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:3f6aeafb7814bf2a89527aae69ae64f47fd699c8bf0b5a4213a81d3fc01ff9c7",
+              "sha256": "3f6aeafb7814bf2a89527aae69ae64f47fd699c8bf0b5a4213a81d3fc01ff9c7"
+            },
+            "ventura": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:5ed5c0e37faba8d07715936ca1f213d4c39de915aa4a2ec94fde9cfc74f30c15",
+              "sha256": "5ed5c0e37faba8d07715936ca1f213d4c39de915aa4a2ec94fde9cfc74f30c15"
+            },
+            "monterey": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:15b65736bfc5c619019cabb2c0f36f2b02a031de9a8bd6c148eba0f329e907bf",
+              "sha256": "15b65736bfc5c619019cabb2c0f36f2b02a031de9a8bd6c148eba0f329e907bf"
+            },
+            "big_sur": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:2ebce34e727724d140fb8c22ae3ac845c1c9e61339dc0f5a5ee13d7a04780a5e",
+              "sha256": "2ebce34e727724d140fb8c22ae3ac845c1c9e61339dc0f5a5ee13d7a04780a5e"
+            },
+            "catalina": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:3e89d7587da0c026f88aec5490582522f9fbfee0bd0e13d1bb773724aee84c23",
+              "sha256": "3e89d7587da0c026f88aec5490582522f9fbfee0bd0e13d1bb773724aee84c23"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/ninja/blobs/sha256:f0124cfd2fc96edec66111ffd30f51fa02be75e01a4b930bab17c8e980b28d14",
+              "sha256": "f0124cfd2fc96edec66111ffd30f51fa02be75e01a4b930bab17c8e980b28d14"
+            }
+          }
+        }
+      },
+      "onnxruntime": {
+        "version": "1.14.0",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:6397a8110629a39dedfcea808fd83810e5c3f002ce6dc0130b243387949d019c",
+              "sha256": "6397a8110629a39dedfcea808fd83810e5c3f002ce6dc0130b243387949d019c"
+            },
+            "arm64_monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:a3980307d3edcbd391db4e9bd7cd9171a36513634b0f379bf071ec60006e5dff",
+              "sha256": "a3980307d3edcbd391db4e9bd7cd9171a36513634b0f379bf071ec60006e5dff"
+            },
+            "arm64_big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:47d0d409c61af789911d9d2764eb9b48e2461ebd5bd3c8a6f4070a737f43d3d1",
+              "sha256": "47d0d409c61af789911d9d2764eb9b48e2461ebd5bd3c8a6f4070a737f43d3d1"
+            },
+            "ventura": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:a8bfecb8fb450bcd7b2cfd13fece6b1ecc27a5caa7712efcd5a9752f7627e3c4",
+              "sha256": "a8bfecb8fb450bcd7b2cfd13fece6b1ecc27a5caa7712efcd5a9752f7627e3c4"
+            },
+            "monterey": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:e923a799d0c4a5a747cb0c332a1d8f33990cd1d22e8ca4d43f3442826e4997f3",
+              "sha256": "e923a799d0c4a5a747cb0c332a1d8f33990cd1d22e8ca4d43f3442826e4997f3"
+            },
+            "big_sur": {
+              "cellar": ":any",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:a063652bc9dd0de53ca104c9971a34d63c541c210e29800dcca17e5b19f3bc85",
+              "sha256": "a063652bc9dd0de53ca104c9971a34d63c541c210e29800dcca17e5b19f3bc85"
+            },
+            "x86_64_linux": {
+              "cellar": ":any_skip_relocation",
+              "url": "https://ghcr.io/v2/homebrew/core/onnxruntime/blobs/sha256:1f1aa40cde3410bbcf749e4a61c206e29bf9b6a07c1cd70354f8f149ba6230be",
+              "sha256": "1f1aa40cde3410bbcf749e4a61c206e29bf9b6a07c1cd70354f8f149ba6230be"
+            }
+          }
+        }
+      },
+      "opencv": {
+        "version": "4.7.0_1",
+        "bottle": {
+          "rebuild": 0,
+          "root_url": "https://ghcr.io/v2/homebrew/core",
+          "files": {
+            "arm64_ventura": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:2f5b49134d26b83b1d768c1d575e5b5ff6c93462908546c2c8a974804b804bc4",
+              "sha256": "2f5b49134d26b83b1d768c1d575e5b5ff6c93462908546c2c8a974804b804bc4"
+            },
+            "arm64_monterey": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:152a45ca8b6b7f5af0c4b9f9f0c90f300be3d7caf77ae4bd608870601c0ee2f8",
+              "sha256": "152a45ca8b6b7f5af0c4b9f9f0c90f300be3d7caf77ae4bd608870601c0ee2f8"
+            },
+            "arm64_big_sur": {
+              "cellar": "/opt/homebrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:58cd9469e0a37c4999796673782a980ba2b3ad324b8731d453a45907ad4bb598",
+              "sha256": "58cd9469e0a37c4999796673782a980ba2b3ad324b8731d453a45907ad4bb598"
+            },
+            "ventura": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:1b5bd857b4fef353907a135cfa797133ee5eacb7ae28d98a0294eb0646819b53",
+              "sha256": "1b5bd857b4fef353907a135cfa797133ee5eacb7ae28d98a0294eb0646819b53"
+            },
+            "monterey": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:70ca4aac06e12e4025498316a650060c333f5d06fb1b059c06deeb31ca429bb8",
+              "sha256": "70ca4aac06e12e4025498316a650060c333f5d06fb1b059c06deeb31ca429bb8"
+            },
+            "big_sur": {
+              "cellar": "/usr/local/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:126d10a5ed97eb217d6c6638d5ea564779bbe4f0cc391ab73521bad51538fc0a",
+              "sha256": "126d10a5ed97eb217d6c6638d5ea564779bbe4f0cc391ab73521bad51538fc0a"
+            },
+            "x86_64_linux": {
+              "cellar": "/home/linuxbrew/.linuxbrew/Cellar",
+              "url": "https://ghcr.io/v2/homebrew/core/opencv/blobs/sha256:1779c8966cc98857b6af859e6bb99aa2bc196fd8ff1b63a6b4cb162a96227794",
+              "sha256": "1779c8966cc98857b6af859e6bb99aa2bc196fd8ff1b63a6b4cb162a96227794"
+            }
+          }
+        }
+      }
+    }
+  },
+  "system": {
+    "macos": {
+      "ventura": {
+        "HOMEBREW_VERSION": "4.0.3-149-g66303bd",
+        "HOMEBREW_PREFIX": "/usr/local",
+        "Homebrew/homebrew-core": "api",
+        "CLT": "14.2.0.0.1.1668646533",
+        "Xcode": "14.2",
+        "macOS": "13.2.1"
+      }
+    }
+  }
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.Wingetfile Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.build.zsh Added

@@ -0,0 +1,247 @@
+#!/usr/bin/env zsh
+
+builtin emulate -L zsh
+setopt EXTENDED_GLOB
+setopt PUSHD_SILENT
+setopt ERR_EXIT
+setopt ERR_RETURN
+setopt NO_UNSET
+setopt PIPE_FAIL
+setopt NO_AUTO_PUSHD
+setopt NO_PUSHD_IGNORE_DUPS
+setopt FUNCTION_ARGZERO
+
+## Enable for script debugging
+# setopt WARN_CREATE_GLOBAL
+# setopt WARN_NESTED_VAR
+# setopt XTRACE
+
+autoload -Uz is-at-least && if ! is-at-least 5.2; then
+ print -u2 -PR "%F{1}${funcstack1##*/}:%f Running on Zsh version %B${ZSH_VERSION}%b, but Zsh %B5.2%b is the minimum supported version. Upgrade Zsh to fix this issue."
+ exit 1
+fi
+
+_trap_error() {
+ print -u2 -PR '%F{1} ✖︎ script execution error%f'
+ print -PR -e "
+ Callstack:
+ ${(j:\n :)funcfiletrace}
+ "
+ exit 2
+}
+
+build() {
+ if (( ! ${+SCRIPT_HOME} )) typeset -g SCRIPT_HOME=${ZSH_ARGZERO:A:h}
+ local host_os=${${(s:-:)ZSH_ARGZERO:t:r}2}
+ local target="${host_os}-${CPUTYPE}"
+ local project_root=${SCRIPT_HOME:A:h:h}
+ local buildspec_file="${project_root}/buildspec.json"
+
+ trap '_trap_error' ZERR
+
+ fpath=("${SCRIPT_HOME}/utils.zsh" ${fpath})
+ autoload -Uz log_info log_error log_output set_loglevel check_${host_os} setup_${host_os} setup_obs setup_ccache
+
+ if ! -r ${buildspec_file} {
+ log_error \
+ 'No buildspec.json found. Please create a build specification for your project.' \
+ 'A buildspec.json.template file is provided in the repository to get you started.'
+ return 2
+ }
+
+ typeset -g -a skips=()
+ local -i _verbosity=1
+ local -r _version='1.0.0'
+ local -r -a _valid_targets=(
+ macos-x86_64
+ macos-arm64
+ macos-universal
+ linux-x86_64
+ linux-aarch64
+ )
+ local -r -a _valid_configs=(Debug RelWithDebInfo Release MinSizeRel)
+ if ${host_os} == 'macos' {
+ local -r -a _valid_generators=(Xcode Ninja 'Unix Makefiles')
+ local generator="${${CI:+Ninja}:-Xcode}"
+ } else {
+ local -r -a _valid_generators=(Ninja 'Unix Makefiles')
+ local generator='Ninja'
+ }
+ local -r _usage="
+Usage: %B${functrace1%:*}%b <option> <options>
+
+%BOptions%b:
+
+%F{yellow} Build configuration options%f
+ -----------------------------------------------------------------------------
+ %B-t | --target%b Specify target - default: %B%F{green}${host_os}-${CPUTYPE}%f%b
+ %B-c | --config%b Build configuration - default: %B%F{green}RelWithDebInfo%f%b
+ %B-s | --codesign%b Enable codesigning (macOS only)
+ %B--generator%b Specify build system to generate - default: %B%F{green}Ninja%f%b
+ Available generators:
+ - Ninja
+ - Unix Makefiles
+ - Xcode (macOS only)
+
+%F{yellow} Output options%f
+ -----------------------------------------------------------------------------
+ %B-q | --quiet%b Quiet (error output only)
+ %B-v | --verbose%b Verbose (more detailed output)
+ %B--skip-all|build|deps|unpack%b Skip all|building OBS|checking for dependencies|unpacking dependencies
+ %B--debug%b Debug (very detailed and added output)
+
+%F{yellow} General options%f
+ -----------------------------------------------------------------------------
+ %B-h | --help%b Print this usage help
+ %B-V | --version%b Print script version information"
+
+ local -a args
+ while (( # )) {
+ case ${1} {
+ -t|--target|-c|--config|--generator)
+ if (( # == 1 )) || ${2:0:1} == '-' {
+ log_error "Missing value for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ ;;
+ }
+ case ${1} {
+ --)
+ shift
+ args+=($@)
+ break
+ ;;
+ -t|--target)
+ if (( ! ${_valid_targets(Ie)${2}} )) {
+ log_error "Invalid value %B${2}%b for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ target=${2}
+ shift 2
+ ;;
+ -c|--config)
+ if (( ! ${_valid_configs(Ie)${2}} )) {
+ log_error "Invalid value %B${2}%b for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ BUILD_CONFIG=${2}
+ shift 2
+ ;;
+ -s|--codesign) CODESIGN=1; shift ;;
+ -q|--quiet) (( _verbosity -= 1 )) || true; shift ;;
+ -v|--verbose) (( _verbosity += 1 )); shift ;;
+ -h|--help) log_output ${_usage}; exit 0 ;;
+ -V|--version) print -Pr "${_version}"; exit 0 ;;
+ --debug) _verbosity=3; shift ;;
+ --generator)
+ if (( ! ${_valid_generators(Ie)${2}} )) {
+ log_error "Invalid value %B${2}%b for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ generator=${2}
+ shift 2
+ ;;
+ --skip-*)
+ local _skip="${${(s:-:)1}-1}"
+ local _check=(all deps unpack build)
+ (( ${_check(Ie)${_skip}} )) || log_warning "Invalid skip mode %B${_skip}%b supplied"
+ typeset -g -a skips=(${skips} ${_skip})
+ shift
+ ;;
+ *) log_error "Unknown option: %B${1}%b"; log_output ${_usage}; exit 2 ;;
+ }
+ }
+
+ set -- ${(@)args}
+ set_loglevel ${_verbosity}
+
+ check_${host_os}
+ setup_ccache
+
+ typeset -g QT_VERSION
+ typeset -g DEPLOYMENT_TARGET
+ typeset -g OBS_DEPS_VERSION
+ setup_${host_os}
+
+ local product_name
+ local product_version
+ read -r product_name product_version <<< \
+ "$(jq -r '. | {name, version} | join(" ")' ${buildspec_file})"
+
+ case ${host_os} {
+ macos)
+ sed -i '' \
+ "s/project($.*$ VERSION $.*$)/project(${product_name} VERSION ${product_version})/" \
+ "${project_root}/CMakeLists.txt"
+ ;;
+ linux)
+ sed -i'' \
+ "s/project($.*$ VERSION $.*$)/project(${product_name} VERSION ${product_version})/"\
+ "${project_root}/CMakeLists.txt"
+ ;;
+ }
+
+ setup_obs
+
+ pushd ${project_root}
+ if (( ! (${skips(Ie)all} + ${skips(Ie)build}) )) {
+ log_info "Configuring ${product_name}..."
+
+ local _plugin_deps="${project_root:h}/obs-build-dependencies/plugin-deps-${OBS_DEPS_VERSION}-qt${QT_VERSION}-${target##*-}"
+ local -a cmake_args=(
+ -DCMAKE_BUILD_TYPE=${BUILD_CONFIG:-RelWithDebInfo}
+ -DQT_VERSION=${QT_VERSION}
+ -DCMAKE_PREFIX_PATH="${_plugin_deps}"
+ )
+
+ if (( _loglevel == 0 )) cmake_args+=(-Wno_deprecated -Wno-dev --log-level=ERROR)
+ if (( _loglevel > 2 )) cmake_args+=(--debug-output)
+
+ local num_procs
+
+ case ${target} {
+ macos-*)
+ autoload -Uz read_codesign
+ if (( ${+CODESIGN} )) {
+ read_codesign
+ }
+
+ cmake_args+=(
+ -DCMAKE_FRAMEWORK_PATH="${_plugin_deps}/Frameworks"
+ -DCMAKE_OSX_ARCHITECTURES=${${target##*-}//universal/x86_64;arm64}
+ -DCMAKE_OSX_DEPLOYMENT_TARGET=${DEPLOYMENT_TARGET:-10.15}
+ -DOBS_CODESIGN_LINKER=ON
+ -DOBS_BUNDLE_CODESIGN_IDENTITY="${CODESIGN_IDENT:--}"
+ )
+ num_procs=$(( $(sysctl -n hw.ncpu) + 1 ))
+ ;;
+ linux-*)
+ if (( ${+CI} )) {
+ cmake_args+=(-DCMAKE_INSTALL_PREFIX=/usr -DLINUX_PORTABLE=OFF)
+ }
+ num_procs=$(( $(nproc) + 1 ))
+ ;;
+ }
+
+ log_debug "Attempting to configure ${product_name} with CMake arguments: ${cmake_args}"
+ cmake -S . -B build_${target##*-} -G ${generator} ${cmake_args}
+
+ log_info "Building ${product_name}..."
+ local -a cmake_args=()
+ if (( _loglevel > 1 )) cmake_args+=(--verbose)
+ if ${generator} == 'Unix Makefiles' cmake_args+=(--parallel ${num_procs})
+ cmake --build build_${target##*-} --config ${BUILD_CONFIG:-RelWithDebInfo} ${cmake_args}
+ }
+
+ log_info "Installing ${product_name}..."
+ local -a cmake_args=()
+ if (( _loglevel > 1 )) cmake_args+=(--verbose)
+ cmake --install build_${target##*-} --config ${BUILD_CONFIG:-RelWithDebInfo} --prefix "${project_root}/release" ${cmake_args}
+ popd
+}
+
+build ${@}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/.package.zsh Added

@@ -0,0 +1,193 @@
+#!/usr/bin/env zsh
+
+builtin emulate -L zsh
+setopt EXTENDED_GLOB
+setopt PUSHD_SILENT
+setopt ERR_EXIT
+setopt ERR_RETURN
+setopt NO_UNSET
+setopt PIPE_FAIL
+setopt NO_AUTO_PUSHD
+setopt NO_PUSHD_IGNORE_DUPS
+setopt FUNCTION_ARGZERO
+
+## Enable for script debugging
+# setopt WARN_CREATE_GLOBAL
+# setopt WARN_NESTED_VAR
+# setopt XTRACE
+
+autoload -Uz is-at-least && if ! is-at-least 5.2; then
+ print -u2 -PR "%F{1}${funcstack1##*/}:%f Running on Zsh version %B${ZSH_VERSION}%b, but Zsh %B5.2%b is the minimum supported version. Upgrade Zsh to fix this issue."
+ exit 1
+fi
+
+_trap_error() {
+ print -u2 -PR '%F{1} ✖︎ script execution error%f'
+ print -PR -e "
+ Callstack:
+ ${(j:\n :)funcfiletrace}
+ "
+ exit 2
+}
+
+package() {
+ if (( ! ${+SCRIPT_HOME} )) typeset -g SCRIPT_HOME=${ZSH_ARGZERO:A:h}
+ local host_os=${${(s:-:)ZSH_ARGZERO:t:r}2}
+ local target="${host_os}-${CPUTYPE}"
+ local project_root=${SCRIPT_HOME:A:h:h}
+ local buildspec_file="${project_root}/buildspec.json"
+ trap '_trap_error' ZERR
+
+ fpath=("${SCRIPT_HOME}/utils.zsh" ${fpath})
+ autoload -Uz set_loglevel log_info log_error log_output check_${host_os}
+
+ local -i _verbosity=1
+ local -r _version='1.0.0'
+ local -r -a _valid_targets=(
+ macos-x86_64
+ macos-arm64
+ macos-universal
+ linux-x86_64
+ linux-aarch64
+ )
+ local -r -a _valid_configs=(Debug RelWithDebInfo Release MinSizeRel)
+ local -r _usage="
+Usage: %B${functrace1%:*}%b <option> <options>
+
+%BOptions%b:
+
+%F{yellow} Package configuration options%f
+ -----------------------------------------------------------------------------
+ %B-t | --target%b Specify target - default: %B%F{green}${host_os}-${CPUTYPE}%f%b
+ %B-c | --config%b Build configuration - default: %B%F{green}RelWithDebInfo%f%b
+ %B-s | --codesign%b Enable codesigning (macOS only)
+ %B-n | --notarize%b Enable notarization (macOS only)
+
+%F{yellow} Output options%f
+ -----------------------------------------------------------------------------
+ %B-q | --quiet%b Quiet (error output only)
+ %B-v | --verbose%b Verbose (more detailed output)
+ %B--debug%b Debug (very detailed and added output)
+
+%F{yellow} General options%f
+ -----------------------------------------------------------------------------
+ %B-h | --help%b Print this usage help
+ %B-V | --version%b Print script version information"
+
+ local -a args
+ while (( # )) {
+ case ${1} {
+ -t|--target|-c|--config)
+ if (( # == 1 )) || ${2:0:1} == '-' {
+ log_error "Missing value for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ ;;
+ }
+ case ${1} {
+ --)
+ shift
+ args+=($@)
+ break
+ ;;
+ -t|--target)
+ if (( ! ${_valid_targets(Ie)${2}} )) {
+ log_error "Invalid value %B${2}%b for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ target=${2}
+ shift 2
+ ;;
+ -c|--config)
+ if (( ! ${_valid_configs(Ie)${2}} )) {
+ log_error "Invalid value %B${2}%b for option %B${1}%b"
+ log_output ${_usage}
+ exit 2
+ }
+ BUILD_CONFIG=${2}
+ shift 2
+ ;;
+ -s|--codesign) typeset -g CODESIGN=1; shift ;;
+ -n|--notarize) typeset -g NOTARIZE=1; typeset -g CODESIGN=1; shift ;;
+ -q|--quiet) (( _verbosity -= 1 )) || true; shift ;;
+ -v|--verbose) (( _verbosity += 1 )); shift ;;
+ -h|--help) log_output ${_usage}; exit 0 ;;
+ -V|--version) print -Pr "${_version}"; exit 0 ;;
+ --debug) _verbosity=3; shift ;;
+ *) log_error "Unknown option: %B${1}%b"; log_output ${_usage}; exit 2 ;;
+ }
+ }
+
+ set -- ${(@)args}
+ set_loglevel ${_verbosity}
+
+ check_${host_os}
+
+ local product_name
+ local product_version
+ read -r product_name product_version <<< \
+ "$(jq -r '. | {name, version} | join(" ")' ${project_root}/buildspec.json)"
+
+ if ${host_os} == 'macos' {
+ autoload -Uz check_packages read_codesign read_codesign_installer read_codesign_pass
+
+ local output_name="${product_name}-${product_version}-${host_os}-${target##*-}.pkg"
+
+ if ! -d ${project_root}/release/${product_name}.plugin {
+ log_error 'No release artifact found. Run the build script or the CMake install procedure first.'
+ return 2
+ }
+
+ if ! -f ${project_root}/build_${target##*-}/installer-macos.generated.pkgproj {
+ log_error 'Packages project file not found. Run the build script or the CMake build and install procedures first.'
+ return 2
+ }
+
+ check_packages
+
+ log_info "Packaging ${product_name}..."
+ pushd ${project_root}
+ packagesbuild \
+ --build-folder ${project_root}/release \
+ ${project_root}/build_${target##*-}/installer-macos.generated.pkgproj
+
+ if (( ${+CODESIGN} )) {
+ read_codesign_installer
+ productsign \
+ --sign "${CODESIGN_IDENT_INSTALLER}" \
+ "${project_root}/release/${product_name}.pkg" \
+ "${project_root}/release/${output_name}"
+
+ rm "${project_root}/release/${product_name}.pkg"
+ } else {
+ mv "${project_root}/release/${product_name}.pkg" \
+ "${project_root}/release/${output_name}"
+ }
+
+ if (( ${+CODESIGN} && ${+NOTARIZE} )) {
+ if ! -f "${project_root}/release/${output_name}" {
+ log_error "No package for notarization found."
+ return 2
+ }
+
+ read_codesign_installer
+ read_codesign_pass
+
+ xcrun notarytool submit "${project_root}/release/${output_name}" \
+ --keychain-profile "OBS-Codesign-Password" --wait
+ xcrun stapler staple "${project_root}/release/${output_name}"
+ }
+ popd
+ } elif ${host_os} == 'linux' {
+ local -a cmake_args=()
+ if (( _loglevel > 1 )) cmake_args+=(--verbose)
+
+ pushd ${project_root}
+ cmake --build build_${target##*-} --config ${BUILD_CONFIG:-RelWithDebInfo} -t package ${cmake_args}
+ popd
+ }
+}
+
+package ${@}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/Build-Windows.ps1 Added

@@ -0,0 +1,101 @@
+CmdletBinding()
+param(
+    ValidateSet('Debug', 'RelWithDebInfo', 'Release', 'MinSizeRel')
+    string $Configuration = 'RelWithDebInfo',
+    ValidateSet('x86', 'x64')
+    string $Target,
+    ValidateSet('Visual Studio 17 2022', 'Visual Studio 16 2019')
+    string $CMakeGenerator,
+    switch $SkipAll,
+    switch $SkipBuild,
+    switch $SkipDeps,
+    switch $SkipUnpack
+)
+
+$ErrorActionPreference = 'Stop'
+
+if ( $DebugPreference -eq 'Continue' ) {
+    $VerbosePreference = 'Continue'
+    $InformationPreference = 'Continue'
+}
+
+if ( $PSVersionTable.PSVersion -lt '7.0.0' ) {
+    Write-Warning 'The obs-deps PowerShell build script requires PowerShell Core 7. Install or upgrade your PowerShell version: https://aka.ms/pscore6'
+    exit 2
+}
+
+function Build {
+    trap {
+        Pop-Location -Stack BuildTemp -ErrorAction 'SilentlyContinue'
+        Write-Error $_
+        exit 2
+    }
+
+    $ScriptHome = $PSScriptRoot
+    $ProjectRoot = Resolve-Path -Path "$PSScriptRoot/../.."
+    $BuildSpecFile = "${ProjectRoot}/buildspec.json"
+
+    $UtilityFunctions = Get-ChildItem -Path $PSScriptRoot/utils.pwsh/*.ps1 -Recurse
+
+    foreach($Utility in $UtilityFunctions) {
+        Write-Debug "Loading $($Utility.FullName)"
+        . $Utility.FullName
+    }
+
+    $BuildSpec = Get-Content -Path ${BuildSpecFile} -Raw | ConvertFrom-Json
+    $ProductName = $BuildSpec.name
+    $ProductVersion = $BuildSpec.version
+
+    $script:DepsVersion = ''
+    $script:QtVersion = '5'
+    $script:VisualStudioVersion = ''
+    $script:PlatformSDK = '10.0.18363.657'
+
+    Setup-Host
+
+    if ( $CmakeGenerator -eq '' ) {
+        $CmakeGenerator = $script:VisualStudioVersion
+    }
+
+    (Get-Content -Path ${ProjectRoot}/CMakeLists.txt -Raw) `
+        -replace "project$(.*) VERSION (.*)$", "project(${ProductName} VERSION ${ProductVersion})" `
+        | Out-File -Path ${ProjectRoot}/CMakeLists.txt -NoNewline
+
+    Setup-Obs
+
+    Push-Location -Stack BuildTemp
+    if ( ! ( ( $SkipAll ) -or ( $SkipBuild ) ) ) {
+        Ensure-Location $ProjectRoot
+
+        $DepsPath = "plugin-deps-${script:DepsVersion}-qt${script:QtVersion}-${script:Target}"
+        $CmakeArgs = @(
+            '-G', $CmakeGenerator
+            "-DCMAKE_SYSTEM_VERSION=${script:PlatformSDK}"
+            "-DCMAKE_GENERATOR_PLATFORM=$(if (${script:Target} -eq "x86") { "Win32" } else { "x64" })"
+            "-DCMAKE_BUILD_TYPE=${Configuration}"
+            "-DCMAKE_PREFIX_PATH:PATH=$(Resolve-Path -Path "${ProjectRoot}/../obs-build-dependencies/${DepsPath}")"
+            "-DQT_VERSION=${script:QtVersion}"
+        )
+
+        Log-Debug "Attempting to configure OBS with CMake arguments: $($CmakeArgs | Out-String)"
+        Log-Information "Configuring ${ProductName}..."
+        Invoke-External cmake -S . -B build_${script:Target} @CmakeArgs
+
+        $CmakeArgs = @(
+            '--config', "${Configuration}"
+        )
+
+        if ( $VerbosePreference -eq 'Continue' ) {
+            $CmakeArgs+=('--verbose')
+        }
+
+        Log-Information "Building ${ProductName}..."
+        Invoke-External cmake --build "build_${script:Target}" @CmakeArgs
+    }
+    Log-Information "Install ${ProductName}..."
+    Invoke-External cmake --install "build_${script:Target}" --prefix "${ProjectRoot}/release" @CmakeArgs
+
+    Pop-Location -Stack BuildTemp
+}
+
+Build

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/Package-Windows.ps1 Added

@@ -0,0 +1,92 @@
+CmdletBinding()
+param(
+    ValidateSet('Debug', 'RelWithDebInfo', 'Release', 'MinSizeRel')
+    string $Configuration = 'RelWithDebInfo',
+    ValidateSet('x86', 'x64', 'x86+x64')
+    string $Target,
+    switch $BuildInstaller = $false
+)
+
+$ErrorActionPreference = 'Stop'
+
+if ( $DebugPreference -eq 'Continue' ) {
+    $VerbosePreference = 'Continue'
+    $InformationPreference = 'Continue'
+}
+
+if ( $PSVersionTable.PSVersion -lt '7.0.0' ) {
+    Write-Warning 'The obs-deps PowerShell build script requires PowerShell Core 7. Install or upgrade your PowerShell version: https://aka.ms/pscore6'
+    exit 2
+}
+
+function Package {
+    trap {
+        Write-Error $_
+        exit 2
+    }
+
+    $ScriptHome = $PSScriptRoot
+    $ProjectRoot = Resolve-Path -Path "$PSScriptRoot/../.."
+    $BuildSpecFile = "${ProjectRoot}/buildspec.json"
+
+    $UtilityFunctions = Get-ChildItem -Path $PSScriptRoot/utils.pwsh/*.ps1 -Recurse
+
+    foreach( $Utility in $UtilityFunctions ) {
+        Write-Debug "Loading $($Utility.FullName)"
+        . $Utility.FullName
+    }
+
+    $BuildSpec = Get-Content -Path ${BuildSpecFile} -Raw | ConvertFrom-Json
+    $ProductName = $BuildSpec.name
+    $ProductVersion = $BuildSpec.version
+
+    $OutputName = "${ProductName}-${ProductVersion}-windows-${Target}"
+
+    Install-BuildDependencies -WingetFile "${ScriptHome}/.Wingetfile"
+
+    Log-Information "Packaging ${ProductName}..."
+
+    $RemoveArgs = @{
+        ErrorAction = 'SilentlyContinue'
+        Path = @(
+            "${ProjectRoot}/release/${ProductName}-*-windows-*.zip"
+            "${ProjectRoot}/release/${ProductName}-*-windows-*.exe"
+        )
+    }
+
+    Remove-Item @RemoveArgs
+
+    if ( ( $BuildInstaller ) ) {
+        if ( $Target -eq 'x86+x64' ) {
+            $IsccCandidates = Get-ChildItem -Recurse -Path '*.iss'
+
+            if ( $IsccCandidates.length -gt 0 ) {
+                $IsccFile = $IsccCandidates0.FullName
+            } else {
+                $IsccFile = ''
+            }
+        } else {
+            $IsccFile = "${ProjectRoot}/build_${Target}/installer-Windows.generated.iss"
+        }
+
+        if ( ! ( Test-Path -Path $IsccFile ) ) {
+            throw 'InnoSetup install script not found. Run the build script or the CMake build and install procedures first.'
+        }
+
+        Log-Information 'Creating InnoSetup installer...'
+        Push-Location -Stack BuildTemp
+        Ensure-Location -Path "${ProjectRoot}/release"
+        Invoke-External iscc ${IsccFile} /O. /F"${OutputName}-Installer"
+        Pop-Location -Stack BuildTemp
+    }
+
+    $CompressArgs = @{
+        Path = (Get-ChildItem -Path "${ProjectRoot}/release" -Exclude "${OutputName}*.*")
+        CompressionLevel = 'Optimal'
+        DestinationPath = "${ProjectRoot}/release/${OutputName}.zip"
+    }
+
+    Compress-Archive -Force @CompressArgs
+}
+
+Package

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/build-linux.sh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/build-linux.zsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/build-macos.zsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/check-changes.sh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/check-cmake.sh Added

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+
+set -o errexit
+set -o pipefail
+
+if  ${#} -eq 1 -a "${1}" = "VERBOSE" ; then
+    VERBOSITY="-l debug"
+else
+    VERBOSITY=""
+fi
+
+if  "${CI}" ; then
+    MODE="--check"
+else
+    MODE="-i"
+fi
+
+# Runs the formatter in parallel on the code base.
+# Return codes:
+#  - 1 there are files to be formatted
+#  - 0 everything looks fine
+
+# Get CPU count
+OS=$(uname)
+NPROC=1
+if  ${OS} = "Linux"  ; then
+    NPROC=$(nproc)
+elif  ${OS} = "Darwin"  ; then
+    NPROC=$(sysctl -n hw.physicalcpu)
+fi
+
+# Discover clang-format
+if ! type cmake-format 2> /dev/null ; then
+    echo "Required cmake-format not found"
+    exit 1
+fi
+
+find . -type d $ \
+    -path ./\*build\* -o \
+    -path ./release -o \
+    -path ./deps/jansson -o \
+    -path ./plugins/decklink/\*/decklink-sdk -o \
+    -path ./plugins/enc-amf -o \
+    -path ./plugins/mac-syphon/syphon-framework -o \
+    -path ./plugins/obs-outputs/ftl-sdk -o \
+    -path ./plugins/obs-vst -o \
+    -path ./plugins/obs-browser -o \
+    -path ./plugins/win-dshow/libdshowcapture -o \
+    -path ./plugins/obs-websocket/deps \
+$ -prune -false -type f -o \
+    -name 'CMakeLists.txt' -or \
+    -name '*.cmake' \
+ | xargs -L10 -P ${NPROC} cmake-format ${MODE} ${VERBOSITY}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/check-format.sh Added

@@ -0,0 +1,60 @@
+#!/usr/bin/env bash
+# Original source https://github.com/Project-OSRM/osrm-backend/blob/master/scripts/format.sh
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+if  ${#} -eq 1 ; then
+    VERBOSITY="--verbose"
+else
+    VERBOSITY=""
+fi
+
+# Runs the Clang Formatter in parallel on the code base.
+# Return codes:
+#  - 1 there are files to be formatted
+#  - 0 everything looks fine
+
+# Get CPU count
+OS=$(uname)
+NPROC=1
+if  ${OS} = "Linux"  ; then
+    NPROC=$(nproc)
+elif  ${OS} = "Darwin"  ; then
+    NPROC=$(sysctl -n hw.physicalcpu)
+fi
+
+# Discover clang-format
+if type clang-format-13 2> /dev/null ; then
+    CLANG_FORMAT=clang-format-13
+elif type clang-format 2> /dev/null ; then
+    # Clang format found, but need to check version
+    CLANG_FORMAT=clang-format
+    V=$(clang-format --version)
+    if  $V != *"version 13.0"* ; then
+        echo "clang-format is not 13.0 (returned ${V})"
+        exit 1
+    fi
+else
+    echo "No appropriate clang-format found (expected clang-format-13.0.0, or clang-format)"
+    exit 1
+fi
+
+find . -type d $ \
+    -path ./\*build\* -o \
+    -path ./release -o \
+    -path ./cmake -o \
+    -path ./plugins/decklink/\*/decklink-sdk -o \
+    -path ./plugins/enc-amf -o \
+    -path ./plugins/mac-syphon/syphon-framework -o \
+    -path ./plugins/obs-outputs/ftl-sdk -o \
+    -path ./plugins/obs-websocket/deps \
+$ -prune -false -type f -o \
+    -name '*.h' -or \
+    -name '*.hpp' -or \
+    -name '*.m' -or \
+    -name '*.mm' -or \
+    -name '*.c' -or \
+    -name '*.cpp' \
+ | xargs -L100 -P ${NPROC} "${CLANG_FORMAT}" ${VERBOSITY} -i -style=file -fallback-style=none

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/package-linux.sh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/package-linux.zsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/package-macos.zsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Check-Git.ps1 Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Ensure-Location.ps1 Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Expand-ArchiveExt.ps1 Added

@@ -0,0 +1,70 @@
+function Expand-ArchiveExt {
+ <#
+ .SYNOPSIS
+ Expands archive files.
+ .DESCRIPTION
+ Allows extraction of zip, 7z, gz, and xz archives.
+ Requires tar and 7-zip to be available on the system.
+ Archives ending with .zip but created using LZMA compression are
+ expanded using 7-zip as a fallback.
+ .EXAMPLE
+ Expand-ArchiveExt -Path <Path-To-Your-Archive>
+ Expand-ArchiveExt -Path <Path-To-Your-Archive> -DestinationPath <Expansion-Path>
+ #>
+
+ param(
+ Parameter(Mandatory)
+ string $Path,
+ string $DestinationPath = System.IO.Path::GetFileNameWithoutExtension($Path),
+ switch $Force
+ )
+
+ switch ( System.IO.Path::GetExtension($Path) ) {
+ .zip {
+ try {
+ Expand-Archive -Path $Path -DestinationPath $DestinationPath -Force:$Force
+ } catch {
+ if ( Get-Command 7z ) {
+ Invoke-External 7z x -y $Path "-o${DestinationPath}"
+ } else {
+ throw "Fallback utility 7-zip not found. Please install 7-zip first."
+ }
+ }
+ break
+ }
+ { ( $_ -eq ".7z" ) -or ( $_ -eq ".exe" ) } {
+ if ( Get-Command 7z ) {
+ Invoke-External 7z x -y $Path "-o${DestinationPath}"
+ } else {
+ throw "Extraction utility 7-zip not found. Please install 7-zip first."
+ }
+ break
+ }
+ .gz {
+ try {
+ Invoke-External tar -x -o $DestinationPath -f $Path
+ } catch {
+ if ( Get-Command 7z ) {
+ Invoke-External 7z x -y $Path "-o${DestinationPath}"
+ } else {
+ throw "Fallback utility 7-zip not found. Please install 7-zip first."
+ }
+ }
+ break
+ }
+ .xz {
+ try {
+ Invoke-External tar -x -o $DestinationPath -f $Path
+ } catch {
+ if ( Get-Command 7z ) {
+ Invoke-External 7z x -y $Path "-o${DestinationPath}"
+ } else {
+ throw "Fallback utility 7-zip not found. Please install 7-zip first."
+ }
+ }
+ }
+ default {
+ throw "Unsupported archive extension provided."
+ }
+ }
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Install-BuildDependencies.ps1 Added

@@ -0,0 +1,60 @@
+function Install-BuildDependencies {
+ <#
+ .SYNOPSIS
+ Installs required build dependencies.
+ .DESCRIPTION
+ Additional packages might be needed for successful builds. This module contains additional
+ dependencies available for installation via winget and, if possible, adds their locations
+ to the environment path for future invocation.
+ .EXAMPLE
+ Install-BuildDependencies
+ #>
+
+ param(
+ string $WingetFile = "$PSScriptRoot/.Wingetfile"
+ )
+
+ if ( ! ( Test-Path function:Log-Warning ) ) {
+ . $PSScriptRoot/Logger.ps1
+ }
+ 
+ $Host64Bit = System.Environment::Is64BitOperatingSystem
+
+ $Paths = $Env:Path -split System.IO.Path::PathSeparator
+
+ $WingetOptions = @('install', '--accept-package-agreements', '--accept-source-agreements')
+
+ if ( $script:Quiet ) {
+ $WingetOptions += '--silent'
+ }
+
+ Get-Content $WingetFile | ForEach-Object {
+ $_, $Package, $_, $Path, $_, $Binary = (regex::Split($_, " (?=(?:^'|'^'*')*$)")) -replace ',', '' -replace "'",''
+
+ (${Env:ProgramFiles(x86)}, $Env:ProgramFiles) | ForEach-Object {
+ $Prefix = $_
+ $FullPath = "${Prefix}\${Path}"
+ if ( ( Test-Path $FullPath ) -and ! ( $Paths -contains $FullPath ) ) {
+ $Paths += $FullPath
+ $Env:Path = $Paths -join System.IO.Path::PathSeparator
+ }
+ }
+
+ Log-Debug "Checking for command ${Binary}"
+ $Found = Get-Command -ErrorAction SilentlyContinue $Binary
+
+ if ( $Found ) {
+ Log-Status "Found dependency ${Binary} as $($Found.Source)"
+ } else {
+ Log-Status "Installing package ${Package}"
+
+ try {
+ $Params = $WingetOptions + $Package
+
+ winget @Params
+ } catch {
+ throw "Error while installing winget package ${Package}: $_"
+ }
+ }
+ }
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Invoke-External.ps1 Added

@@ -0,0 +1,40 @@
+function Invoke-External {
+ <#
+ .SYNOPSIS
+ Invokes a non-PowerShell command.
+ .DESCRIPTION
+ Runs a non-PowerShell command, and captures its return code.
+ Throws an exception if the command returns non-zero.
+ .EXAMPLE
+ Invoke-External 7z x $MyArchive
+ #>
+
+ if ( $args.Count -eq 0 ) {
+ throw 'Invoke-External called without arguments.'
+ }
+
+ if ( ! ( Test-Path function:Log-Information ) ) {
+ . $PSScriptRoot/Logger.ps1
+ }
+
+ $Command = $args0
+ $CommandArgs = @()
+
+ if ( $args.Count -gt 1) {
+ $CommandArgs = $args1..($args.Count - 1)
+ }
+
+ $_EAP = $ErrorActionPreference
+ $ErrorActionPreference = "Continue"
+
+ Log-Debug "Invoke-External: ${Command} ${CommandArgs}"
+
+ & $command $commandArgs
+ $Result = $LASTEXITCODE
+
+ $ErrorActionPreference = $_EAP
+
+ if ( $Result -ne 0 ) {
+ throw "${Command} ${CommandArgs} exited with non-zero code ${Result}."
+ }
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Invoke-GitCheckout.ps1 Added

@@ -0,0 +1,117 @@
+function Set-GitConfig {
+ <#
+ .SYNOPSIS
+ Sets a git config value.
+ .DESCRIPTION
+ Allows setting single or multiple config values in a PowerShell-friendly fashion.
+ .EXAMPLE
+ Set-GitConfig advice.detachedHead false
+ #>
+
+ if ( $args.Count -lt 2 ) {
+ throw 'Set-GitConfig called without required arguments <OPTION> <VALUE>.'
+ }
+
+ Invoke-External git config @args
+}
+
+function Invoke-GitCheckout {
+ <#
+ .SYNOPSIS
+ Checks out a specified git repository.
+ .DESCRIPTION
+ Wraps the git executable with PowerShell syntax to check out
+ a specified Git repository with a given commit hash and branch,
+ or a GitHub pull request ID.
+ .EXAMPLE
+ Invoke-GitCheckout -Uri "My-Repo-Uri" -Commit "My-Commit-Hash"
+ Invoke-GitCheckout -Uri "My-Repo-Uri" -Commit "My-Commit-Hash" -Branch "main"
+ Invoke-GitCheckout -Uri "My-Repo-Uri" -Commit "My-Commit-Hash" -PullRequest 250
+ #>
+
+ param(
+ Parameter(Mandatory)
+ string $Uri,
+ Parameter(Mandatory)
+ string $Commit,
+ string $Path,
+ string $Branch = "master",
+ string $PullRequest
+ )
+
+ if ( ! ( $Uri -like "*github.com*" ) -and ( $PullRequest -ne "" ) ) {
+ throw 'Fetching pull requests is only supported with GitHub-based repositories.'
+ }
+
+ if ( ! ( Test-Path function:Log-Information ) ) {
+ . $PSScriptRoot/Logger.ps1
+ }
+
+ if ( ! ( Test-Path function:Invoke-External ) ) {
+ . $PSScriptRoot/Invoke-External.ps1
+ }
+
+ $RepositoryName = System.IO.Path::GetFileNameWithoutExtension($Uri)
+
+ if ( $Path -eq "" ) {
+ $Path = "$(Get-Location | Convert-Path)\${RepositoryName}"
+ }
+
+ Push-Location -Stack GitCheckoutTemp
+
+ if ( Test-Path $Path/.git ) {
+ Write-Information "Repository ${RepositoryName} found in ${Path}"
+
+ Set-Location $Path
+
+ Set-GitConfig advice.detachedHead false
+ Set-GitConfig remote.origin.url $Uri
+ Set-GitConfig remote.origin.tapOpt --no-tags
+
+ $Ref = "+refs/heads/{0}:refs/remotes/origin/{0}" -f $Branch
+
+ Set-GitConfig --replace-all remote.origin.fetch $Ref
+
+ if ( $PullRequest -ne "" ) {
+ try {
+ Invoke-External git show-ref --quiet --verify refs/heads/pr-$PullRequest
+ } catch {
+ Invoke-External git fetch origin $("pull/{0}/head:pull-{0}" -f $PullRequest)
+ } finally {
+ Invoke-External git checkout -f "pull-${PullRequest}"
+ }
+ }
+
+ try {
+ $null = Invoke-External git rev-parse -q --verify "${Commit}^{commit}"
+ } catch {
+ Invoke-External git fetch origin
+ }
+
+ Invoke-External git checkout -f $Commit -- | Log-Information
+ } else {
+ Invoke-External git clone $Uri $Path
+
+ Set-Location $Path
+
+ Set-GitConfig advice.detachedHead false
+
+ if ( $PullRequest -ne "" ) {
+ $Ref = "pull/{0}/head:pull-{0}" -f $PullRequest
+ $Branch = "pull-${PullRequest}"
+ Invoke-External git fetch origin $Ref
+ Invoke-External git checkout $Branch
+ }
+
+ Invoke-External git checkout -f $Commit
+ }
+
+ Log-Information "Checked out commit ${Commit} on branch ${Branch}"
+
+ if ( Test-Path ${Path}/.gitmodules ) {
+ Invoke-External git submodule foreach --recursive git submodule sync
+ Invoke-External git submodule update --init --recursive
+ }
+
+ Pop-Location -Stack GitCheckoutTemp
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Logger.ps1 Added

@@ -0,0 +1,123 @@
+function Log-Debug {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        foreach($m in $Message) {
+            Write-Debug $m
+        }
+    }
+}
+
+function Log-Verbose {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        foreach($m in $Message) {
+            Write-Verbose $m
+        }
+    }
+}
+
+function Log-Warning {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        foreach($m in $Message) {
+            Write-Warning $m
+        }
+    }
+}
+
+function Log-Error {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        foreach($m in $Message) {
+            Write-Error $m
+        }
+    }
+}
+
+function Log-Information {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        if ( ! ( $script:Quiet ) ) {
+            $StageName = $( if ( $script:StageName -ne $null ) { $script:StageName } else { '' })
+            $Icon = ' =>'
+
+            foreach($m in $Message) {
+                Write-Host -NoNewLine -ForegroundColor Blue "  ${StageName} $($Icon.PadRight(5)) "
+                Write-Host "${m}"
+            }
+        }
+    }
+}
+
+function Log-Status {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        if ( ! ( $script:Quiet ) ) {
+            $StageName = $( if ( $StageName -ne $null ) { $StageName } else { '' })
+            $Icon = '  >'
+
+            foreach($m in $Message) {
+                Write-Host -NoNewLine -ForegroundColor Green "  ${StageName} $($Icon.PadRight(5)) "
+                Write-Host "${m}"
+            }
+        }
+    }
+}
+
+function Log-Output {
+    CmdletBinding()
+    param(
+        Parameter(Mandatory,ValueFromPipeline)
+        ValidateNotNullOrEmpty()
+        string $Message
+    )
+
+    Process {
+        if ( ! ( $script:Quiet ) ) {
+            $StageName = $( if ( $script:StageName -ne $null ) { $script:StageName } else { '' })
+            $Icon = ''
+
+            foreach($m in $Message) {
+                Write-Output "  ${StageName} $($Icon.PadRight(5)) ${m}"
+            }
+        }
+    }
+}
+
+$Columns = (Get-Host).UI.RawUI.WindowSize.Width - 5

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Setup-Host.ps1 Added

@@ -0,0 +1,103 @@
+function Setup-Host {
+    if ( ! ( Test-Path function:Log-Output ) ) {
+        . $PSScriptRoot/Logger.ps1
+    }
+
+    if ( ! ( Test-Path function:Ensure-Location ) ) {
+        . $PSScriptRoot/Ensure-Location.ps1
+    }
+
+    if ( ! ( Test-Path function:Install-BuildDependencies ) ) {
+        . $PSScriptRoot/Install-BuildDependencies.ps1
+    }
+
+    if ( ! ( Test-Path function:Expand-ArchiveExt ) ) {
+        . $PSScriptRoot/Expand-ArchiveExt.ps1
+    }
+
+    Install-BuildDependencies -WingetFile "${ScriptHome}/.Wingetfile"
+
+    if ( $script:Target -eq '' ) { $script:Target = $script:HostArchitecture }
+
+    $script:QtVersion = $BuildSpec.platformConfig."windows-${script:Target}".qtVersion
+    $script:VisualStudioVersion = $BuildSpec.platformConfig."windows-${script:Target}".visualStudio
+    $script:PlatformSDK = $BuildSpec.platformConfig."windows-${script:Target}".platformSDK
+
+    if ( ! ( ( $script:SkipAll ) -or ( $script:SkipDeps ) ) ) {
+        ('prebuilt', "qt${script:QtVersion}") | ForEach-Object {
+            $_Dependency = $_
+            $_Version = $BuildSpec.dependencies."${_Dependency}".version
+            $_BaseUrl = $BuildSpec.dependencies."${_Dependency}".baseUrl
+            $_Label = $BuildSpec.dependencies."${_Dependency}".label
+            $_Hash = $BuildSpec.dependencies."${_Dependency}".hashes."windows-${script:Target}"
+
+            if ( $BuildSpec.dependencies."${_Dependency}".PSobject.Properties.Name -contains "pdb-hashes" ) {
+                $_PdbHash = $BuildSpec.dependencies."${_Dependency}".'pdb-hashes'."$windows-${script:Target}"
+            }
+
+            if ( $_Version -eq '' ) {
+                throw "No ${_Dependency} spec found in ${script:BuildSpecFile}."
+            }
+
+            Log-Information "Setting up ${_Label}..."
+
+            Push-Location -Stack BuildTemp
+            Ensure-Location -Path "$(Resolve-Path -Path "${ProjectRoot}/..")/obs-build-dependencies"
+
+            switch -wildcard ( $_Dependency ) {
+                prebuilt {
+                    $_Filename = "windows-deps-${_Version}-${script:Target}.zip"
+                    $_Uri = "${_BaseUrl}/${_Version}/${_Filename}"
+                    $_Target = "plugin-deps-${_Version}-qt${script:QtVersion}-${script:Target}"
+                    $script:DepsVersion = ${_Version}
+                }
+                "qt*" {
+                    $_Filename = "windows-deps-qt${script:QtVersion}-${_Version}-${script:Target}.zip"
+                    $_Uri = "${_BaseUrl}/${_Version}/${_Filename}"
+                    $_Target = "plugin-deps-${_Version}-qt${script:QtVersion}-${script:Target}"
+                }
+            }
+
+            if ( ! ( Test-Path -Path $_Filename ) ) {
+                $Params = @{
+                    UserAgent = 'NativeHost'
+                    Uri = $_Uri
+                    OutFile = $_Filename
+                    UseBasicParsing = $true
+                    ErrorAction = 'Stop'
+                }
+
+                Invoke-WebRequest @Params
+                Log-Status "Downloaded ${_Label} for ${script:Target}."
+            } else {
+                Log-Status "Found downloaded ${_Label}."
+            }
+
+            $_FileHash = Get-FileHash -Path $_Filename -Algorithm SHA256
+
+            if ( $_FileHash.Hash.ToLower() -ne $_Hash ) {
+                throw "Checksum of downloaded ${_Label} does not match specification. Expected '${_Hash}', 'found $(${_FileHash}.Hash.ToLower())'"
+            }
+            Log-Status "Checksum of downloaded ${_Label} matches."
+
+            if ( ! ( ( $script:SkipAll ) -or ( $script:SkipUnpack ) ) ) {
+                Push-Location -Stack BuildTemp
+                Ensure-Location -Path $_Target
+
+                Expand-ArchiveExt -Path "../${_Filename}" -DestinationPath . -Force
+
+                Pop-Location -Stack BuildTemp
+            }
+            Pop-Location -Stack BuildTemp
+        }
+    }
+}
+
+function Get-HostArchitecture {
+    $Host64Bit = System.Environment::Is64BitOperatingSystem
+    $HostArchitecture = ('x86', 'x64')$Host64Bit
+
+    return $HostArchitecture
+}
+
+$script:HostArchitecture = Get-HostArchitecture

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.pwsh/Setup-Obs.ps1 Added

@@ -0,0 +1,84 @@
+function Setup-Obs {
+    if ( ! ( Test-Path function:Log-Output ) ) {
+        . $PSScriptRoot/Logger.ps1
+    }
+
+    if ( ! ( Test-Path function:Check-Git ) ) {
+        . $PSScriptRoot/Check-Git.ps1
+    }
+
+    Check-Git
+
+    if ( ! ( Test-Path function:Ensure-Location ) ) {
+        . $PSScriptRoot/Ensure-Location.ps1
+    }
+
+    if ( ! ( Test-Path function:Invoke-GitCheckout ) ) {
+        . $PSScriptRoot/Invoke-GitCheckout.ps1
+    }
+
+    if ( ! ( Test-Path function:Invoke-External ) ) {
+        . $PSScriptRoot/Invoke-External.ps1
+    }
+
+    Log-Information 'Setting up OBS Studio...'
+
+    $ObsVersion = $BuildSpec.dependencies.'obs-studio'.version
+    $ObsRepository = $BuildSpec.dependencies.'obs-studio'.repository
+    $ObsBranch = $BuildSpec.dependencies.'obs-studio'.branch
+    $ObsHash = $BuildSpec.dependencies.'obs-studio'.hash
+
+    if ( $ObsVersion -eq '' ) {
+        throw 'No obs-studio version found in buildspec.json.'
+    }
+
+    Push-Location -Stack BuildTemp
+    Ensure-Location -Path "$(Resolve-Path -Path "${ProjectRoot}/../")/obs-studio"
+
+    if ( ! ( ( $script:SkipAll ) -or ( $script:SkipUnpack ) ) ) {
+        Invoke-GitCheckout -Uri $ObsRepository -Commit $ObsHash -Path . -Branch $ObsBranch
+    }
+
+    if ( ! ( ( $script:SkipAll ) -or ( $script:SkipBuild ) ) ) {
+        Log-Information 'Configuring OBS Studio...'
+
+        $NumProcessors = (Get-CimInstance Win32_ComputerSystem).NumberOfLogicalProcessors
+
+        if ( $NumProcessors -gt 1 ) {
+            $env:UseMultiToolTask = $true
+            $env:EnforceProcessCountAcrossBuilds = $true
+        }
+
+        $DepsPath = "plugin-deps-${script:DepsVersion}-qt${script:QtVersion}-${script:Target}"
+
+        $CmakeArgs = @(
+            '-G', $CmakeGenerator
+            "-DCMAKE_SYSTEM_VERSION=${script:PlatformSDK}"
+            "-DCMAKE_GENERATOR_PLATFORM=$(if (${script:Target} -eq "x86") { "Win32" } else { "x64" })"
+            "-DCMAKE_BUILD_TYPE=${script:Configuration}"
+            "-DQT_VERSION=${script:QtVersion}"
+            '-DENABLE_PLUGINS=OFF'
+            '-DENABLE_UI=OFF'
+            '-DENABLE_SCRIPTING=OFF'
+            "-DCMAKE_INSTALL_PREFIX:PATH=$(Resolve-Path -Path "${ProjectRoot}/../obs-build-dependencies/${DepsPath}")"
+            "-DCMAKE_PREFIX_PATH:PATH=$(Resolve-Path -Path "${ProjectRoot}/../obs-build-dependencies/${DepsPath}")"
+        )
+
+        Log-Debug "Attempting to configure OBS with CMake arguments: $($CmakeArgs | Out-String)"
+        Log-Information "Configuring OBS..."
+        Invoke-External cmake -S . -B plugin_build_${script:Target} @CmakeArgs
+
+        Log-Information 'Building libobs and obs-frontend-api...'
+        $CmakeArgs = @(
+            '--config', "$( if ( $script:Configuration -eq '' ) { 'RelWithDebInfo' } else { $script:Configuration })"
+        )
+
+        if ( $VerbosePreference -eq 'Continue' ) {
+            $CmakeArgs+=('--verbose')
+        }
+
+        Invoke-External cmake --build plugin_build_${script:Target} @CmakeArgs -t obs-frontend-api
+        Invoke-External cmake --install plugin_build_${script:Target} @CmakeArgs --component obs_libraries
+    }
+    Pop-Location -Stack BuildTemp
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/check_linux Added

@@ -0,0 +1,36 @@
+autoload -Uz log_info log_status log_error log_debug log_warning
+
+log_debug 'Checking for apt-get...'
+if (( ! ${+commandsapt-get} )) {
+ log_error 'No apt-get command found. Please install apt'
+ return 2
+} else {
+ log_debug "Apt-get located at ${commandsapt-get}"
+}
+
+local -a dependencies=("${(f)$(<${SCRIPT_HOME}/.Aptfile)}")
+local -a install_list
+local binary
+
+for dependency (${dependencies}) {
+ local -a tokens=(${(s: :)dependency//(,|:|\')/})
+
+ if ! ${tokens1} == 'package' continue
+
+ if ${#tokens} -gt 2 && ${tokens3} == 'bin' {
+ binary=${tokens4}
+ } else {
+ binary=${tokens2}
+ }
+
+ if (( ! ${+commands${binary}} )) install_list+=(${tokens2})
+}
+
+local -a _quiet=('' '--quiet')
+
+log_debug "List of dependencies to install: ${install_list}"
+if (( ${#install_list} )) {
+ if (( ! ${+CI} )) log_warning 'Dependency installation via apt may require elevated privileges'
+
+ sudo apt-get -y install ${install_list} ${_quiet(( (_loglevel == 0) + 1 ))}
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/check_macos Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/check_packages Added

@@ -0,0 +1,52 @@
+if (( ! ${+commandspackagesbuild} )) {
+ autoload -Uz log_info log_status mkcd
+
+ if (( ! ${+commandscurl} )) {
+ log_error 'curl not found. Please install curl.'
+ return 2
+ }
+
+ if (( ! ${+project_root} )) {
+ log_error "'project_root' not set. Please set before running ${0}."
+ return 2
+ }
+
+ local -a curl_opts=()
+ if (( ! ${+CI} )) {
+ curl_opts+=(--progress-bar)
+ } else {
+ curl_opts+=(--show-error --silent)
+ }
+ curl_opts+=(--location -O ${@})
+
+ log_info 'Installing Packages.app...'
+
+ pushd
+ mkcd ${project_root:h}/obs-build-dependencies
+
+ local packages_url='http://s.sudre.free.fr/Software/files/Packages.dmg'
+ local packages_hash='6afdd25386295974dad8f078b8f1e41cabebd08e72d970bf92f707c7e48b16c9'
+
+ if ! -f Packages.dmg {
+ log_status 'Download Packages.app'
+ curl ${curl_opts} ${packages_url}
+ }
+
+ local image_checksum
+ read -r image_checksum _ <<< "$(sha256sum Packages.dmg)"
+
+ if ${packages_hash} != ${image_checksum} {
+ log_error "Checksum mismatch of Packages.app download.
+Expected : ${packages_hash}
+Actual : ${image_checksum}"
+ return 2
+ }
+
+ hdiutil attach -noverify Packages.dmg &> /dev/null && log_status 'Packages.dmg image mounted.'
+
+ log_info 'Installing Packages.app...'
+ packages_volume=$(hdiutil info -plist | grep '<string>/Volumes/Packages' | sed 's/.*<string>$\/Volumes\/^<*$<\/string>/\1/')
+
+ sudo installer -pkg "${packages_volume}/packages/Packages.pkg" -target / && rehash
+ hdiutil detach ${packages_volume} &> /dev/null && log_status 'Packages.dmg image unmounted.'
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_debug Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_error Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_info Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_output Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_status Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/log_warning Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/mkcd Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/read_codesign Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/read_codesign_installer Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/read_codesign_pass Added

@@ -0,0 +1,33 @@
+##############################################################################
+# Apple Developer credentials necessary:
+#
+#   + Signing for distribution and notarization require an active Apple
+#     Developer membership
+#   + An Apple Development identity is needed for code signing
+#     (i.e. 'Apple Development: YOUR APPLE ID (PROVIDER)')
+#   + Your Apple developer ID is needed for notarization
+#   + An app-specific password is necessary for notarization from CLI
+#   + This password will be stored in your macOS keychain under the identifier
+#     'OBS-Codesign-Password'with access Apple's 'altool' only.
+##############################################################################
+
+autoload -Uz read_codesign read_codesign_user log_info
+
+if (( ! ${+CODESIGN_IDENT} )) {
+  read_codesign
+}
+
+local codesign_ident_short=$(print "${CODESIGN_IDENT}" | /usr/bin/sed -En 's/.+$(.+)$/\1/p')
+
+if (( ! ${+CODESIGN_IDENT_USER} )) {
+  read_codesign_user
+}
+
+log_info 'Setting up password for notarization keychain...'
+if (( ! ${+CODESIGN_IDENT_PASS} )) {
+  read -s CODESIGN_IDENT_PASS'?Apple Developer ID password: '
+}
+
+print ''
+log_info 'Setting up notarization keychain...'
+xcrun notarytool store-credentials 'OBS-Codesign-Password' --apple-id "${CODESIGN_IDENT_USER}" --team-id "${codesign_ident_short}" --password "${CODESIGN_IDENT_PASS}"

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/read_codesign_user Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/set_loglevel Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/setup_ccache Added

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/setup_linux Added

@@ -0,0 +1,62 @@
+autoload -Uz log_error log_status log_info mkcd
+
+if (( ! ${+project_root} )) {
+ log_error "'project_root' not set. Please set before running ${0}."
+ return 2
+}
+
+if (( ! ${+target} )) {
+ log_error "'target' not set. Please set before running ${0}."
+ return 2
+}
+
+pushd ${project_root}
+
+typeset -g QT_VERSION
+read -r QT_VERSION <<< \
+ "$(jq -r --arg target "${target}" \
+ '.platformConfig$target | { qtVersion } | join(" ")' \
+ ${project_root}/buildspec.json)"
+
+if (( ! (${skips(Ie)all} + ${skips(Ie)deps}) )) {
+ log_info 'Installing obs build dependencies...'
+
+ sudo apt-get install -y \
+ build-essential \
+ libcurl4-openssl-dev \
+ libavcodec-dev libavdevice-dev libavfilter-dev libavformat-dev libavutil-dev \
+ libswresample-dev libswscale-dev \
+ libjansson-dev \
+ libx11-xcb-dev \
+ libgles2-mesa-dev \
+ libwayland-dev \
+ libpulse-dev
+
+ local -a _qt_packages=()
+
+ if (( QT_VERSION == 5 )) {
+ _qt_packages+=(
+ qtbase5-dev
+ libqt5svg5-dev
+ qtbase5-private-dev
+ libqt5x11extras5-dev
+ )
+ } elif (( QT_VERSION == 6 )) {
+ _qt_packages+=(
+ qt6-base-dev
+ libqt6svg6-dev
+ qt6-base-private-dev
+ )
+ } else {
+ log_error "Unsupported Qt version '${QT_VERSION}' specified."
+ return 2
+ }
+
+ sudo apt-get install -y ${_qt_packages}
+}
+
+local deps_version
+read -r deps_version <<< \
+ "$(jq -r '.dependencies.prebuilt.version' ${buildspec_file})"
+
+typeset -g OBS_DEPS_VERSION=${deps_version}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/setup_macos Added

@@ -0,0 +1,127 @@
+autoload -Uz log_error log_status log_info mkcd
+
+if (( ! ${+commandscurl} )) {
+ log_error 'curl not found. Please install curl.'
+ return 2
+}
+
+if (( ! ${+commandsjq} )) {
+ log_error 'jq not found. Please install jq.'
+ return 2
+}
+
+if (( ! ${+project_root} )) {
+ log_error "'project_root' not set. Please set before running ${0}."
+ return 2
+}
+
+if (( ! ${+target} )) {
+ log_error "'target' not set. Please set before running ${0}."
+ return 2
+}
+
+local -a curl_opts=()
+if (( ! ${+CI} )) {
+ curl_opts+=(--progress-bar)
+} else {
+ curl_opts+=(--show-error --silent)
+}
+curl_opts+=(--location -O ${@})
+
+pushd ${project_root}
+
+local _qt_version
+local _deployment_target
+read -r _qt_version _deployment_target <<< \
+ "$(jq -r --arg target "${target}" \
+ '.platformConfig$target | { qtVersion, deploymentTarget } | join (" ")' \
+ ${buildspec_file})"
+
+typeset -g QT_VERSION=${_qt_version}
+typeset -g DEPLOYMENT_TARGET=${_deployment_target}
+
+if (( ! (${skips(Ie)all} + ${skips(Ie)deps}) )) {
+ mkdir -p ${project_root:h}/obs-build-dependencies
+
+ local dependency
+ local deps_version
+ local deps_baseurl
+ local deps_label
+ local deps_hash
+ local _filename
+ local _url
+ local _target
+ local artifact_checksum
+
+ for dependency ('prebuilt' "qt${QT_VERSION}") {
+ IFS=';' read -r deps_version deps_baseurl deps_label deps_hash <<< \
+ "$(jq -r --arg dependency "${dependency}" --arg target "${target}" \
+ '.dependencies$dependency | {version, baseUrl, "label", "hash": .hashes$target} | join(";")' \
+ ${buildspec_file})"
+
+ if -z "${deps_version}" {
+ log_error "No ${dependency} spec found in ${buildspec_file}."
+ return 2
+ }
+ log_info "Setting up ${deps_label}..."
+
+ pushd ${project_root:h}/obs-build-dependencies
+
+ case ${dependency} {
+ prebuilt)
+ _filename="macos-deps-${deps_version}-${target##*-}.tar.xz"
+ _url="${deps_baseurl}/${deps_version}/${_filename}"
+ _target="plugin-deps-${deps_version}-qt${QT_VERSION}-${target##*-}"
+ typeset -g OBS_DEPS_VERSION=${deps_version}
+ ;;
+ qt*)
+ if (( ${+CI} )) {
+ _filename="macos-deps-qt${QT_VERSION}-${deps_version}-universal.tar.xz"
+ deps_hash="$(jq -r --arg dependency "${dependency}" \
+ '.dependencies$dependency.hashes"macos-universal"' \
+ ${buildspec_file})"
+ } else {
+ _filename="macos-deps-qt${QT_VERSION}-${deps_version}-${target##*-}.tar.xz"
+ }
+ _url="${deps_baseurl}/${deps_version}/${_filename}"
+ _target="plugin-deps-${deps_version}-qt${QT_VERSION}-${target##*-}"
+ ;;
+ }
+
+ if ! -f ${_filename} {
+ log_debug "Running curl ${curl_opts} ${_url}"
+ curl ${curl_opts} ${_url} && \
+ log_status "Downloaded ${deps_label} for ${target}."
+ } else {
+ log_status "Found downloaded ${deps_label}"
+ }
+
+ read -r artifact_checksum _ <<< "$(sha256sum ${_filename})"
+ if ${deps_hash} != ${artifact_checksum} {
+ log_error "Checksum of downloaded ${deps_label} does not match specification.
+ Expected : ${deps_hash}
+ Actual : ${artifact_checksum}"
+ return 2
+ }
+ log_status "Checksum of downloaded ${deps_label} matches."
+
+ if (( ! (${skips(Ie)all} + ${skips(Ie)unpack}) )) {
+ mkdir -p ${_target} && pushd ${_target}
+
+ XZ_OPT=-T0 tar -xzf ../${_filename} && log_status "${deps_label} extracted."
+ popd
+ }
+ }
+
+ popd
+ pushd ${project_root:h}/obs-build-dependencies
+ xattr -r -d com.apple.quarantine *
+ log_status 'Removed quarantine flag from downloaded dependencies...'
+ popd
+} else {
+ local deps_version
+ read -r deps_version <<< \
+ "$(jq -r '.dependencies.prebuilt.version' ${buildspec_file})"
+
+ typeset -g OBS_DEPS_VERSION=${deps_version}
+}

obs-backgroundremoval-0.5.0.tar.xz/.github/scripts/utils.zsh/setup_obs Added

@@ -0,0 +1,122 @@
+autoload -Uz log_error log_info log_status
+
+if (( ! ${+buildspec_file} )) {
+ log_error "'buildspec_file' not set. Please set before running ${0}."
+ return 2
+}
+
+if (( ! ${+commandsgit} )) {
+ log_error 'git not found. Please install git.'
+ return 2
+}
+
+if (( ! ${+commandsjq} )) {
+ log_error 'jq not found. Please install jq.'
+ return 2
+}
+
+if (( ! ${+project_root} )) {
+ log_error "'project_root' not set. Please set before running ${0}."
+ return 2
+}
+
+if (( ! ${+target} )) {
+ log_error "'target' not set. Please set before running ${0}."
+ return 2
+}
+
+log_info 'Setting up OBS-Studio...'
+
+local obs_version
+local obs_repo
+local obs_branch
+local obs_hash
+
+read -r obs_version obs_repo obs_branch obs_hash <<< \
+ "$(jq -r --arg key "obs-studio" \
+ '.dependencies$key | {version, repository, branch, hash} | join(" ")' \
+ ${buildspec_file})"
+
+if -z ${obs_version} {
+ log_error "No obs-studio version found in buildspec.json"
+ return 2
+}
+
+pushd
+mkcd ${project_root:h}/obs-studio
+
+if (( ! (${skips(Ie)all} + ${skips(Ie)unpack}) )) {
+ if -d .git {
+ git config advice.detachedHead false
+ git config remote.pluginbuild.url "${obs_repo:-https://github.com/obsproject/obs-studio.git}"
+ git config remote.pluginbuild.fetch "+refs/heads/${obs_branch:-master}:refs/remotes/origin/${obs_branch:-master}"
+
+ git rev-parse -q --verify "${obs_hash}^{commit}" > /dev/null || git fetch pluginbuild
+ git checkout ${obs_branch:-master} -B ${product_name}
+ git reset --hard "${obs_hash}"
+ log_status 'Found existing obs-studio repository.'
+ } else {
+ git clone "${obs_repo:-https://github.com/obsproject/obs-studio.git}" "${PWD}"
+ git config advice.detachedHead false
+ git checkout -f "${obs_hash}" --
+ git checkout ${obs_branch:-master} -b ${product_name}
+ log_status 'obs-studio checked out.'
+ }
+
+ git submodule foreach --recursive git submodule sync
+ git submodule update --init --recursive
+}
+
+if (( ! (${skips(Ie)all} + ${skips(Ie)build}) )) {
+ log_info 'Configuring obs-studio...'
+
+ local -a cmake_args=(
+ -DCMAKE_BUILD_TYPE=${BUILD_CONFIG:-Release}
+ -DQT_VERSION=${QT_VERSION}
+ -DENABLE_PLUGINS=OFF
+ -DENABLE_UI=OFF
+ -DENABLE_SCRIPTING=OFF
+ -DCMAKE_INSTALL_PREFIX="${project_root:h}/obs-build-dependencies/plugin-deps-${OBS_DEPS_VERSION}-qt${QT_VERSION}-${target##*-}"
+ -DCMAKE_PREFIX_PATH="${project_root:h}/obs-build-dependencies/plugin-deps-${OBS_DEPS_VERSION}-qt${QT_VERSION}-${target##*-}"
+ )
+
+ if (( _loglevel == 0 )) cmake_args+=(-Wno_deprecated -Wno-dev --log-level=ERROR)
+ if (( _loglevel > 2 )) cmake_args+=(--debug-output)
+
+ local num_procs
+
+ case ${target} {
+ macos-*)
+ autoload -Uz read_codesign
+ if (( ${+CODESIGN} )) {
+ read_codesign
+ }
+
+ cmake_args+=(
+ -DCMAKE_OSX_ARCHITECTURES=${${target##*-}//universal/x86_64;arm64}
+ -DCMAKE_OSX_DEPLOYMENT_TARGET=${DEPLOYMENT_TARGET:-10.15}
+ -DOBS_CODESIGN_LINKER=ON
+ -DOBS_BUNDLE_CODESIGN_IDENTITY="${CODESIGN_IDENT:--}"
+ )
+ num_procs=$(( $(sysctl -n hw.ncpu) + 1 ))
+ ;;
+ linux-*)
+ cmake_args+=(
+ -DENABLE_PIPEWIRE=OFF
+ )
+ num_procs=$(( $(nproc) + 1 ))
+ ;;
+ }
+
+ log_debug "Attempting to configure OBS with CMake arguments: ${cmake_args}"
+ cmake -S . -B plugin_build_${target##*-} -G ${generator} ${cmake_args}
+
+ log_info 'Building libobs and obs-frontend-api...'
+ local -a cmake_args=()
+ if (( _loglevel > 1 )) cmake_args+=(--verbose)
+ if ${generator} == 'Unix Makefiles' cmake_args+=(--parallel ${num_procs})
+ cmake --build plugin_build_${target##*-} --config ${BUILD_CONFIG:-Release} ${cmake_args} -t obs-frontend-api
+ cmake --install plugin_build_${target##*-} --config ${BUILD_CONFIG:-Release} --component obs_libraries ${cmake_args}
+}
+
+popd

obs-backgroundremoval-0.5.0.tar.xz/.github/workflows/flatpak.yml Added

@@ -0,0 +1,54 @@
+# This is a basic workflow that is manually triggered
+
+name: Build flatpak
+
+# Controls when the action will run. Workflow runs when manually triggered using the UI
+# or API.
+on:
+  workflow_dispatch: {}
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "greet"
+  build:
+    name: Build flatpak
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        arch: x86_64
+    container:
+      image: bilelmoussaoui/flatpak-github-actions:kde-6.4
+      options: --privileged
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+
+      - name: 'Setup build environment'
+        id: setup
+        run: |
+          git config --global --add safe.directory $GITHUB_WORKSPACE
+          echo "commitHash=$(git rev-parse --short=9 HEAD)" >> $GITHUB_OUTPUT
+
+      - name: Build Flatpak Manifest
+        uses: flatpak/flatpak-github-actions/flatpak-builder@v5
+        with:
+          arch: ${{ matrix.arch }}
+          bundle: obs-studio-plugin-background-removal-${{ steps.setup.outputs.commitHash }}.flatpak
+          build-bundle: false
+          manifest-path: ci/flatpak/com.obsproject.Studio.Plugin.backgroundremoval.yaml
+          cache-key: flatpak-builder-${{ hashFiles('ci/flatpak/com.obsproject.Studio.Plugin.backgroundremoval.yaml') }}
+          branch: stable
+
+      # /__w/obs-backgroundremoval/obs-backgroundremoval/
+      - name: Build Bundle
+        shell: bash
+        run: |
+          flatpak build-bundle --runtime repo com.obs.Studio.Plugin.backgroundremoval-${{ steps.setup.outputs.commitHash }}.flatpak com.obsproject.Studio.Plugin.backgroundremoval stable
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: com.obs.Studio.Plugin.backgroundremoval-${{ steps.setup.outputs.commitHash }}.flatpak
+          path: com.obs.Studio.Plugin.backgroundremoval-${{ steps.setup.outputs.commitHash }}.flatpak

obs-backgroundremoval-0.5.0.tar.xz/.github/workflows/main.yml Added

@@ -0,0 +1,388 @@
+name: Plugin Build
+
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+    branches:
+      - master
+      - main
+    tags:
+      - '*'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+    branches:
+      - master
+      - main
+
+env:
+  PLUGIN_NAME: 'obs-backgroundremoval'
+
+jobs:
+  clang_check:
+    name: 01 - Code Format Check
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Install clang-format
+        run: sudo apt-get install -y clang-format-13
+
+      - name: Run clang-format
+        run: ./.github/scripts/check-format.sh && ./.github/scripts/check-changes.sh
+
+      - name: Install cmake-format
+        run: sudo pip install cmakelang
+
+      - name: Run cmake-format
+        run: ./.github/scripts/check-cmake.sh
+
+  macos_build:
+    name: 02 - macOS
+    runs-on: macos-12
+    strategy:
+      fail-fast: true
+      matrix:
+        arch: x86_64 # arm64, universal
+    if: always()
+    needs: clang_check
+    outputs:
+      commitHash: ${{ steps.setup.outputs.commitHash }}
+    env:
+      CODESIGN_IDENT: '-'
+      CODESIGN_IDENT_INSTALLER: ''
+      MACOSX_DEPLOYMENT_TARGET: '10.15'
+    defaults:
+      run:
+        shell: zsh {0}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: plugin
+          submodules: recursive
+
+      - name: Checkout obs-studio
+        uses: actions/checkout@v3
+        with:
+          repository: 'obsproject/obs-studio'
+          path: obs-studio
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Setup Environment
+        id: setup
+        working-directory: ${{ github.workspace }}/plugin
+        run: |
+          ## SETUP ENVIRONMENT SCRIPT
+          print '::group::Clean Homebrew Environment'
+          typeset -a to_remove=()
+
+          for formula (speexdsp curl php) {
+            if  -d ${HOMEBREW_PREFIX}/opt/${formula}  to_remove+=(${formula})
+          }
+
+          if (( #to_remove > 0 )) brew uninstall --ignore-dependencies ${to_remove}
+          print '::endgroup::'
+
+          print '::group::Set up code signing'
+          if  '${{ secrets.MACOS_SIGNING_APPLICATION_IDENTITY }}' != '' && \
+                '${{ secrets.MACOS_SIGNING_INSTALLER_IDENTITY }}' != '' && \
+                '${{ secrets.MACOS_SIGNING_CERT }}' != ''  {
+            print 'haveCodesignIdent=true' >> $GITHUB_OUTPUT
+          } else {
+            print 'haveCodesignIdent=false' >> $GITHUB_OUTPUT
+          }
+
+          if  '${{ secrets.MACOS_NOTARIZATION_USERNAME }}' != '' && \
+                '${{ secrets.MACOS_NOTARIZATION_PASSWORD }}' != ''  {
+            print 'haveNotarizationUser=true' >> $GITHUB_OUTPUT
+          } else {
+            print 'haveNotarizationUser=false' >> $GITHUB_OUTPUT
+          }
+          print '::endgroup::'
+
+          print "ccacheDate=$(date +"%Y-%m-%d")" >> $GITHUB_OUTPUT
+          print "commitHash=${"$(git rev-parse HEAD)"0,9}" >> $GITHUB_OUTPUT
+
+      - name: Restore Compilation Cache
+        id: ccache-cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ github.workspace }}/.ccache
+          key: macos-${{ matrix.arch }}-ccache-plugin-${{ steps.setup.outputs.ccacheDate }}
+          restore-keys: |
+            macos-${{ matrix.arch }}-ccache-plugin-
+
+      - name: Check for GitHub Labels
+        id: seekingTesters
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          if  -n "$(curl -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" -s "${{ github.event.pull_request.url }}" | jq -e '.labels | select(.name == "Seeking Testers")')"  {
+            print 'found=true' >> $GITHUB_OUTPUT
+          } else {
+            print 'found=false' >> $GITHUB_OUTPUT
+          }
+
+      - name: Install Apple Developer Certificate
+        if: ${{ github.event_name != 'pull_request' && steps.setup.outputs.haveCodesignIdent == 'true' }}
+        uses: apple-actions/import-codesign-certs@253ddeeac23f2bdad1646faac5c8c2832e800071
+        with:
+          keychain-password: ${{ github.run_id }}
+          p12-file-base64: ${{ secrets.MACOS_SIGNING_CERT }}
+          p12-password: ${{ secrets.MACOS_SIGNING_CERT_PASSWORD }}
+
+      - name: Set Signing Identity
+        if: ${{ github.event_name != 'pull_request' && steps.setup.outputs.haveCodesignIdent == 'true' }}
+        run: |
+          print "CODESIGN_IDENT=${{ secrets.MACOS_SIGNING_APPLICATION_IDENTITY }}" >> $GITHUB_ENV
+          print "CODESIGN_IDENT_INSTALLER=${{ secrets.MACOS_SIGNING_INSTALLER_IDENTITY }}" >> $GITHUB_ENV
+
+      - name: Build Plugin
+        uses: ./plugin/.github/actions/build-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+          codesign: 'true'
+          codesignIdent: ${{ env.CODESIGN_IDENT }}
+
+      - name: Package Plugin
+        uses: ./plugin/.github/actions/package-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+          codesign: ${{ github.event_name != 'pull_request' && steps.setup.outputs.haveCodesignIdent == 'true' }}
+          notarize: ${{ startsWith(github.ref, 'refs/tags/') && github.event_name != 'pull_request' && steps.setup.outputs.haveNotarizationUser == 'true' }}
+          codesignIdent: ${{ env.CODESIGN_IDENT }}
+          installerIdent: ${{ env.CODESIGN_IDENT_INSTALLER }}
+          codesignUser: ${{ secrets.MACOS_NOTARIZATION_USERNAME }}
+          codesignPass: ${{ secrets.MACOS_NOTARIZATION_PASSWORD }}
+
+      - name: Upload Build Artifact
+        if: ${{ success() && (github.event_name != 'pull_request' || steps.seekingTesters.outputs.found == 'true') }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.PLUGIN_NAME }}-macos-${{ matrix.arch }}-${{ steps.setup.outputs.commitHash }}
+          path: ${{ github.workspace }}/plugin/release/${{ env.PLUGIN_NAME }}-*-macos-${{ matrix.arch }}.pkg
+
+  linux_build:
+    name: 02 - Linux
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: true
+      matrix:
+        arch: x86_64
+    if: false # always()
+    needs: clang_check
+    outputs:
+      commitHash: ${{ steps.setup.outputs.commitHash }}
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: plugin
+          submodules: recursive
+
+      - name: Checkout obs-studio
+        uses: actions/checkout@v3
+        with:
+          repository: 'obsproject/obs-studio'
+          path: obs-studio
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Setup Environment
+        working-directory: ${{ github.workspace }}/plugin
+        id: setup
+        run: |
+          ## SETUP ENVIRONMENT SCRIPT
+          echo "ccacheDate=$(date +"%Y-%m-%d")" >> $GITHUB_OUTPUT
+          echo "commitHash=$(git rev-parse HEAD | cut -c1-9)" >> $GITHUB_OUTPUT
+
+      - name: Restore Compilation Cache
+        id: ccache-cache
+        uses: actions/cache@v3
+        with:
+          path: ${{ github.workspace }}/.ccache
+          key: linux-${{ matrix.arch }}-ccache-plugin-${{ steps.setup.outputs.ccacheDate }}
+          restore-keys: |
+            linux-${{ matrix.arch }}-ccache-plugin-
+
+      - name: Check for GitHub Labels
+        id: seekingTesters
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          ## GITHUB LABEL SCRIPT
+          if  -n "$(curl -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" -s "${{ github.event.pull_request.url }}" | jq -e '.labels | select(.name == "Seeking Testers")')" ; then
+            echo 'found=true' >> $GITHUB_OUTPUT
+          else
+            echo 'found=false' >> $GITHUB_OUTPUT
+          fi
+
+      - name: Build Plugin
+        uses: ./plugin/.github/actions/build-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+
+      - name: Package Plugin
+        uses: ./plugin/.github/actions/package-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+
+      - name: Upload Build Artifact
+        if: ${{ success() && (github.event_name != 'pull_request' || steps.seekingTesters.outputs.found == 'true') }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.PLUGIN_NAME }}-linux-${{ matrix.arch }}-${{ steps.setup.outputs.commitHash }}
+          path: ${{ github.workspace }}/plugin/release/${{ env.PLUGIN_NAME }}-*-linux-${{ matrix.arch }}.*
+
+  windows_build:
+    name: 02 - Windows
+    runs-on: windows-2022
+    strategy:
+      fail-fast: true
+      matrix:
+        arch: x64
+    if: false  # always()
+    needs: clang_check
+    outputs:
+      commitHash: ${{ steps.setup.outputs.commitHash }}
+    defaults:
+      run:
+        shell: pwsh
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          path: plugin
+          submodules: recursive
+
+      - name: Checkout obs-studio
+        uses: actions/checkout@v3
+        with:
+          repository: 'obsproject/obs-studio'
+          path: obs-studio
+          fetch-depth: 0
+          submodules: recursive
+
+      - name: Setup Environment
+        working-directory: ${{ github.workspace }}/plugin
+        id: setup
+        run: |
+          ## SETUP ENVIRONMENT SCRIPT
+          $CommitHash = (git rev-parse HEAD)0..8 -join ''
+          "commitHash=${CommitHash}" >> $env:GITHUB_OUTPUT
+
+      - name: Check for GitHub Labels
+        id: seekingTesters
+        working-directory: ${{ github.workspace }}/plugin
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          ## GITHUB LABEL SCRIPT
+          $LabelFound = try {
+            $Params = @{
+              Authentication = 'Bearer'
+              Token = (ConvertTo-SecureString '${{ secrets.GITHUB_TOKEN }}' -AsPlainText)
+              Uri = '${{ github.event.pull_request.url }}'
+              UseBasicParsing = $true
+            }
+
+            (Invoke-RestMethod @Params).labels.name.contains('Seeking Testers')
+          } catch {
+            $false
+          }
+
+          "found=$((string${LabelFound}).ToLower())" >> $env:GITHUB_OUTPUT
+
+      - name: Build Plugin
+        uses: ./plugin/.github/actions/build-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+          visualStudio: 'Visual Studio 17 2022'
+
+      - name: Package Plugin
+        uses: ./plugin/.github/actions/package-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+
+      - name: Upload Build Artifact
+        if: ${{ success() && (github.event_name != 'pull_request' || steps.seekingTesters.outputs.found == 'true') }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.PLUGIN_NAME }}-windows-${{ matrix.arch }}-${{ steps.setup.outputs.commitHash }}
+          path: ${{ github.workspace }}/plugin/release/${{ env.PLUGIN_NAME }}-*.zip
+
+      - name: Package Plugin Installer
+        if: ${{ startsWith(github.ref, 'refs/tags/') && github.event_name != 'pull_request' }}
+        uses: ./plugin/.github/actions/package-plugin
+        with:
+          workingDirectory: ${{ github.workspace }}/plugin
+          target: ${{ matrix.arch }}
+          config: RelWithDebInfo
+          createInstaller: true
+
+      - name: Upload Installer Artifact
+        if: ${{ startsWith(github.ref, 'refs/tags/') && github.event_name != 'pull_request' }}
+        uses: actions/upload-artifact@v3
+        with:
+          name: ${{ env.PLUGIN_NAME }}-windows-${{ matrix.arch }}-${{ steps.setup.outputs.commitHash }}-installer
+          path: ${{ github.workspace }}/plugin/release/${{ env.PLUGIN_NAME }}-*.exe
+
+  make-release:
+    name: 03 - Create and upload release
+    runs-on: ubuntu-22.04
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags/')
+    needs: macos_build # linux_build, windows_build
+    defaults:
+      run:
+        shell: bash
+    steps:
+      - name: Get Metadata
+        id: metadata
+        run: |
+          ## METADATA SCRIPT
+          echo "version=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
+
+      - name: Download build artifacts
+        uses: actions/download-artifact@v3
+
+      - name: Generate Checksums
+        run: |
+          ## CHECKSUM GENERATION SCRIPT
+          shopt -s extglob
+          echo "### Checksums" > ${{ github.workspace }}/CHECKSUMS.txt
+          for file in ${{ github.workspace }}/**/@(*.pkg|*.exe|*.deb|*.zip); do
+            echo "    ${file##*/}: $(sha256sum "${file}" | cut -d " " -f 1)" >> ${{ github.workspace }}/CHECKSUMS.txt
+          done
+
+      - name: Create Release
+        id: create_release
+        uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5
+        with:
+          draft: false
+          prerelease: ${{ contains(steps.metadata.outputs.version, 'rc') || contains(steps.metadata.outputs.version, 'beta') }}
+          tag_name: ${{ steps.metadata.outputs.version }}
+          name: "${{ env.PLUGIN_NAME }} ${{ steps.metadata.outputs.version }}"
+          body_path: ${{ github.workspace }}/CHECKSUMS.txt
+          files: |
+            ${{ github.workspace }}/**/*.zip
+            ${{ github.workspace }}/**/*.exe
+            ${{ github.workspace }}/**/*.deb
+            ${{ github.workspace }}/**/*.pkg

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/.gitignore -> obs-backgroundremoval-0.5.0.tar.xz/.gitignore Changed

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/CMakeLists.txt -> obs-backgroundremoval-0.5.0.tar.xz/CMakeLists.txt Changed

@@ -1,293 +1,127 @@
-cmake_minimum_required(VERSION 3.10)
+cmake_minimum_required(VERSION 3.16)
 
-include(external/MunkeiVersionFromGit.cmake)
-version_from_git()
+# Change obs-plugintemplate to your plugin's name in a machine-readable format (e.g.:
+# obs-myawesomeplugin) and set
+project(obs-backgroundremoval VERSION 0.5.0)
+add_library(${CMAKE_PROJECT_NAME} MODULE)
 
-# Change obs-plugintemplate to your plugin's name in a machine-readable format
-# (e.g.: obs-myawesomeplugin) and set
-project(obs-backgroundremoval VERSION ${VERSION})
-
-# Replace `Your Name Here` with the name (yours or your organization's) you want
-# to see as the author of the plugin (in the plugin's metadata itself and in the installers)
+# Replace `Your Name Here` with the name (yours or your organization's) you want to see as the
+# author of the plugin (in the plugin's metadata itself and in the installers)
 set(PLUGIN_AUTHOR "Roy Shilkrot")
 
-# Replace `com.example.obs-plugin-template` with a unique Bundle ID for macOS releases
-# (used both in the installer and when submitting the installer for notarization)
-set(MACOS_BUNDLEID "com.example.obs-backgroundremoval")
+# Replace `com.example.obs-plugin-template` with a unique Bundle ID for macOS releases (used both in
+# the installer and when submitting the installer for notarization)
+set(MACOS_BUNDLEID "com.royshilkrot.obs-backgroundremoval")
 
 # Replace `me@contoso.com` with the maintainer email address you want to put in Linux packages
 set(LINUX_MAINTAINER_EMAIL "roy.shil@gmail.com")
 
 option(WITH_CUDA "Build with CUDA support." OFF)
 if(WITH_CUDA)
- add_compile_definitions("WITH_CUDA=1")
+ add_compile_definitions("WITH_CUDA=1")
 endif()
 
 if(WIN32 OR MSVC)
- set(VCPKG_DIR ${CMAKE_BINARY_DIR}/vcpkg)
- set(VCPKG_INSTALLED_DIR ${VCPKG_DIR}/installed/x64-windows-static)
- set(CMAKE_TOOLCHAIN_FILE ${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake)
+ set(VCPKG_DIR ${CMAKE_BINARY_DIR}/vcpkg)
+ set(VCPKG_INSTALLED_DIR ${VCPKG_DIR}/installed/x64-windows-static)
+ set(CMAKE_TOOLCHAIN_FILE ${VCPKG_DIR}/scripts/buildsystems/vcpkg.cmake)
 
- set(OpenCV_DIR ${VCPKG_INSTALLED_DIR}/share/opencv)
- set(Protobuf_DIR ${VCPKG_INSTALLED_DIR}/share/protobuf)
- set(LibLZMA_DIR ${VCPKG_INSTALLED_DIR}/share/liblzma)
- set(quirc_DIR ${VCPKG_INSTALLED_DIR}/share/quirc)
+ set(OpenCV_DIR ${VCPKG_INSTALLED_DIR}/share/opencv)
+ set(Protobuf_DIR ${VCPKG_INSTALLED_DIR}/share/protobuf)
+ set(LibLZMA_DIR ${VCPKG_INSTALLED_DIR}/share/liblzma)
+ set(quirc_DIR ${VCPKG_INSTALLED_DIR}/share/quirc)
 
- if(NOT ${libobs_DIR})
- message(FATAL "Please provide libobs_DIR to CMake.")
- endif(NOT ${libobs_DIR})
+ if(NOT ${libobs_DIR})
+ message(FATAL "Please provide libobs_DIR to CMake.")
+ endif(NOT ${libobs_DIR})
 
- set(w32-pthreads_DIR ${libobs_DIR}/../deps/w32-pthreads)
- set(obs-frontend-api_DIR ${libobs_DIR}/../UI/obs-frontend-api)
+ set(w32-pthreads_DIR ${libobs_DIR}/../deps/w32-pthreads)
+ set(obs-frontend-api_DIR ${libobs_DIR}/../UI/obs-frontend-api)
 
- # Find lib TIFF
- find_library(TIFF_LIBRARY tiff PATHS ${VCPKG_INSTALLED_DIR}/lib)
- find_path(TIFF_INCLUDE_DIR tiff.h PATHS ${VCPKG_INSTALLED_DIR}/include)
+ # Find lib TIFF
+ find_library(TIFF_LIBRARY tiff PATHS ${VCPKG_INSTALLED_DIR}/lib)
+ find_path(TIFF_INCLUDE_DIR tiff.h PATHS ${VCPKG_INSTALLED_DIR}/include)
 
- find_file(Protobuf_PROTOC_EXECUTABLE protoc.exe PATHS ${VCPKG_INSTALLED_DIR}/tools/protobuf)
+ find_file(Protobuf_PROTOC_EXECUTABLE protoc.exe PATHS ${VCPKG_INSTALLED_DIR}/tools/protobuf)
 elseif(APPLE)
- # Apple
- if (WITH_CUDA)
- message(FATAL "Cannot use CUDA on Apple builds")
- endif()
-endif()
-
-if (UNIX)
- set(Onnxruntime_INCLUDE_HINT /usr/local/include/)
-endif()
-
-if (APPLE)
- set(OpenCV_DIR ${CMAKE_BINARY_DIR}/opencv/lib/cmake/opencv4)
+ # Apple
+ if(WITH_CUDA)
+ message(FATAL "Cannot use CUDA on Apple builds")
+ endif()
 endif()
 
-set(RELEASE_DIR "${PROJECT_SOURCE_DIR}/release" CACHE STRING "Directory for building release packages")
-
-set(CMAKE_PREFIX_PATH "${QTDIR}")
-set(CMAKE_INCLUDE_CURRENT_DIR ON)
-set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};${CMAKE_SOURCE_DIR}/external")
+set(CMAKE_MODULE_PATH "${CMAKE_MODULE_PATH};${CMAKE_SOURCE_DIR}/cmake")
 
 # In case you need C++
 set(CMAKE_CXX_STANDARD 17)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
-configure_file(
- src/plugin-macros.h.in
- ../src/plugin-macros.generated.h
-)
-configure_file(
- installer/installer-macOS.pkgproj.in
- ../installer/installer-macOS.generated.pkgproj
-)
-configure_file(
- installer/installer-Windows.iss.in
- ../installer/installer-Windows.generated.iss
-)
-
-configure_file(
- ci/ci_includes.sh.in
- ../ci/ci_includes.generated.sh
-)
-configure_file(
- ci/ci_includes.cmd.in
- ../ci/ci_includes.generated.cmd
-)
-
-set(PLUGIN_SOURCES
- src/background-filter.cpp
- src/plugin-main.cpp
- )
-
-set(PLUGIN_HEADERS
-	src/plugin-macros.generated.h)
-
-# --- Platform-independent build settings ---
-add_library(${CMAKE_PROJECT_NAME} MODULE ${PLUGIN_SOURCES} ${PLUGIN_HEADERS})
+set(PLUGIN_SOURCES ${CMAKE_SOURCE_DIR}/src/background-filter.cpp
+ ${CMAKE_SOURCE_DIR}/src/plugin-main.cpp)
+
+target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${PLUGIN_SOURCES})
+
+configure_file(src/plugin-macros.h.in ${CMAKE_SOURCE_DIR}/src/plugin-macros.generated.h)
+
+target_sources(${CMAKE_PROJECT_NAME} PRIVATE src/plugin-macros.generated.h)
 
+if(UNIX)
+ set(CMAKE_MODULE_PATH
+ ${CMAKE_MODULE_PATH}
+ "${CMAKE_SOURCE_DIR}/obs-build-dependencies/plugin-deps-2023-01-06-qt6-x86_64/lib/cmake/libobs/"
+ )
+ set(OpenCV_DIR "${CMAKE_SOURCE_DIR}/build/opencv/lib/cmake/opencv4")
+ # add -framework Foundation to the target
+ set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES LINK_FLAGS "-framework Foundation")
+endif()
+
+# Import libobs as main plugin dependency
 find_package(libobs REQUIRED)
-find_package(obs-frontend-api REQUIRED)
-include(external/ObsPluginHelpers.cmake)
+
+include(cmake/ObsPluginHelpers.cmake)
 
 find_package(Onnxruntime REQUIRED)
 
 find_package(OpenCV 4.5 REQUIRED COMPONENTS core imgproc)
 
-include_directories(
-	${LIBOBS_INCLUDE_DIR}/../UI/obs-frontend-api
- ${LIBOBS_INCLUDE_DIR}
- ${LIBOBS_INCLUDE_DIRS}
- ${Onnxruntime_INCLUDE_DIRS}
- ${OpenCV_INCLUDE_DIRS}
-)
+target_include_directories(
+ ${CMAKE_PROJECT_NAME} PRIVATE ${CMAKE_SOURCE_DIR}/src ${Onnxruntime_INCLUDE_DIRS}
+ ${OpenCV_INCLUDE_DIRS})
 
-target_link_libraries(${CMAKE_PROJECT_NAME}
- OBS::libobs OBS::obs-frontend-api
- ${Onnxruntime_LIBRARIES}
- ${OpenCV_LIBRARIES}
-)
-
-# --- End of section ---
+target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE OBS::libobs ${Onnxruntime_LIBRARIES}
+ ${OpenCV_LIBRARIES})
 
 # --- Windows-specific build settings and tasks ---
-if(WIN32)
- # Enable Multicore Builds and disable FH4 (to not depend on VCRUNTIME140_1.DLL when building with VS2019)
- if (MSVC)
- add_definitions(/MP /d2FH4- /std:c++latest /MT)
- endif()
-
-	# --- Release package helper ---
-	# The "release" folder has a structure similar OBS' one on Windows
- add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
- COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
- "${CMAKE_COMMAND}" -E remove_directory "${RELEASE_DIR}"
- )
-
- # If config is Release or RelWithDebInfo, package release files
- COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
- "${CMAKE_COMMAND}" -E make_directory
- "${RELEASE_DIR}/data/obs-plugins/${CMAKE_PROJECT_NAME}"
- "${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
- )
-
- COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
- "${CMAKE_COMMAND}" -E copy_directory
- "${PROJECT_SOURCE_DIR}/data"
- "${RELEASE_DIR}/data/obs-plugins/${CMAKE_PROJECT_NAME}"
- )
-
- COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
- "${CMAKE_COMMAND}" -E copy
- "$<TARGET_FILE:${CMAKE_PROJECT_NAME}>"
- "${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
- )
-
- # package the DirectML DLL with the plugin DLL unless using CUDA
- COMMAND if $<AND:$<NOT:$<BOOL:${WITH_CUDA}>>,$<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>>==1 (
- "${CMAKE_COMMAND}" -E copy
- "${CMAKE_BINARY_DIR}/nuget/Microsoft.AI.DirectML.1.8.0/bin/x64-win/DirectML.dll"
- "${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
- )
-
- # package the onnxruntime DLL with the plugin DLL
- COMMAND if $<OR:$<CONFIG:Release>,$<CONFIG:RelWithDebInfo>>==1 (
- "${CMAKE_COMMAND}" -E copy
- "${Onnxruntime_LIBRARY_DIR}/onnxruntime.dll"
- "${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
- )
-
- # If config is RelWithDebInfo, copy the pdb file
- COMMAND if $<CONFIG:RelWithDebInfo>==1 (
- "${CMAKE_COMMAND}" -E copy
- "$<TARGET_PDB_FILE:${CMAKE_PROJECT_NAME}>"
- "${RELEASE_DIR}/obs-plugins/${ARCH_NAME}"
- )
-
- # Copy to obs-studio dev environment for immediate testing
- COMMAND if $<CONFIG:Debug>==1 (
- "${CMAKE_COMMAND}" -E copy
- "$<TARGET_FILE:${CMAKE_PROJECT_NAME}>"
- "${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}"
- )
-
- COMMAND if $<CONFIG:Debug>==1 (
- "${CMAKE_COMMAND}" -E copy
- "$<TARGET_PDB_FILE:${CMAKE_PROJECT_NAME}>"
- "${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/obs-plugins/${ARCH_NAME}"
- )
-
- COMMAND if $<CONFIG:Debug>==1 (
- "${CMAKE_COMMAND}" -E make_directory
- "${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/${CMAKE_PROJECT_NAME}"
- )
-
- COMMAND if $<CONFIG:Debug>==1 (
- "${CMAKE_COMMAND}" -E copy_directory
- "${PROJECT_SOURCE_DIR}/data"
- "${LIBOBS_INCLUDE_DIR}/../${OBS_BUILDDIR_ARCH}/rundir/$<CONFIG>/data/obs-plugins/${CMAKE_PROJECT_NAME}"
- )
- )
-	# --- End of sub-section ---
-
- install(DIRECTORY "${RELEASE_DIR}/" DESTINATION .)
- # Tell CPack to create a zip file.
- set(CPACK_GENERATOR "ZIP")
- # Tell CPack what to name the zip file. It will append `.zip`.
- if (WITH_CUDA)
- set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}-cuda")
- endif()
-
- # Tell CPack not to put everything inside an enclosing directory.
- set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY OFF)
- # Apparently this should be always on but isn't for backwards compatibility.
- set(CPACK_VERBATIM_VARIABLES YES)
- include(CPack)
-endif()
-# --- End of section ---
+if(OS_WINDOWS)
+ configure_file(cmake/bundle/windows/installer-Windows.iss.in
+ ${CMAKE_BINARY_DIR}/installer-Windows.generated.iss)
 
-# --- Linux-specific build settings and tasks ---
-if(UNIX AND NOT APPLE)
- include(GNUInstallDirs)
+ configure_file(cmake/bundle/windows/resource.rc.in ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}.rc)
+ target_sources(${CMAKE_PROJECT_NAME} PRIVATE ${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}.rc)
 
-	set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES PREFIX "")
-	target_link_libraries(${CMAKE_PROJECT_NAME} obs-frontend-api)
+ if(MSVC)
+ target_compile_options(${CMAKE_PROJECT_NAME} PRIVATE /W4)
+ endif()
+ # --- End of section ---
 
-	file(GLOB locale_files data/locale/*.ini)
-	file(GLOB onnxmodels data/*.onnx)
+ # -- macOS specific build settings and tasks --
+elseif(OS_MACOS)
+ configure_file(cmake/bundle/macos/installer-macos.pkgproj.in
+ ${CMAKE_BINARY_DIR}/installer-macos.generated.pkgproj)
 
-	install(TARGETS ${CMAKE_PROJECT_NAME}
-		LIBRARY DESTINATION "${CMAKE_INSTALL_FULL_LIBDIR}/obs-plugins")
+ set(MACOSX_PLUGIN_GUI_IDENTIFIER "${MACOS_BUNDLEID}")
+ set(MACOSX_PLUGIN_BUNDLE_VERSION "${CMAKE_PROJECT_VERSION}")
+ set(MACOSX_PLUGIN_SHORT_VERSION_STRING "1")
 
-	install(FILES ${locale_files}
-		DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/obs/obs-plugins/${CMAKE_PROJECT_NAME}/locale")
+ target_compile_options(${CMAKE_PROJECT_NAME} PRIVATE -Wall)
+ # --- End of section ---
 
-	install(FILES ${onnxmodels}
-		DESTINATION "${CMAKE_INSTALL_FULL_DATAROOTDIR}/obs/obs-plugins/${CMAKE_PROJECT_NAME}/")
+ # --- Linux-specific build settings and tasks ---
+else()
+ target_compile_options(${CMAKE_PROJECT_NAME} PRIVATE -Wall)
 endif()
 # --- End of section ---
 
-# -- OS X specific build settings and tasks --
-if(APPLE)
- set(CMAKE_OSX_DEPLOYMENT_TARGET 10.13)
-	set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++ -fvisibility=default -framework Foundation")
-
-	set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES PREFIX "")
-	target_link_libraries(${CMAKE_PROJECT_NAME} "${OBS_FRONTEND_LIB}")
-
- # add_custom_command(TARGET ${CMAKE_PROJECT_NAME} POST_BUILD
- add_custom_target(dist DEPENDS ${CMAKE_PROJECT_NAME}
- COMMAND
- "${CMAKE_COMMAND}" -E rm -rf "${RELEASE_DIR}"
-
- COMMAND
- "${CMAKE_COMMAND}" -E make_directory
- "${RELEASE_DIR}/Resources/data/obs-plugins/${CMAKE_PROJECT_NAME}"
- "${RELEASE_DIR}/Plugins"
-
- COMMAND
- "${CMAKE_COMMAND}" -E copy_directory
- "${PROJECT_SOURCE_DIR}/data"
- "${RELEASE_DIR}/Resources/data/obs-plugins/${CMAKE_PROJECT_NAME}"
-
- COMMAND
- "${CMAKE_COMMAND}" -E copy
- "$<TARGET_FILE:${CMAKE_PROJECT_NAME}>"
- "${RELEASE_DIR}/Plugins/"
-
- COMMAND
- "${CMAKE_COMMAND}" -E rm -f
- "${CMAKE_BINARY_DIR}/${CMAKE_PROJECT_NAME}-macosx.zip"
-
- )
-
- install(DIRECTORY "${RELEASE_DIR}/" DESTINATION .)
-
- # Tell CPack to create a zip file.
- set(CPACK_GENERATOR "ZIP")
- # Tell CPack what to name the zip file. It will append `.zip`.
- set(CPACK_PACKAGE_FILE_NAME "${CMAKE_PROJECT_NAME}-macosx")
- # Tell CPack not to put everything inside an enclosing directory.
- set(CPACK_INCLUDE_TOPLEVEL_DIRECTORY OFF)
- # Apparently this should be always on but isn't for backwards compatibility.
- set(CPACK_VERBATIM_VARIABLES YES)
- include(CPack)
-endif()
-# -- End of section --
+setup_plugin_target(${CMAKE_PROJECT_NAME})
+
+# # --- End of section ---

obs-backgroundremoval-0.5.0.tar.xz/buildspec.json Added

@@ -0,0 +1,86 @@
+{
+    "dependencies": {
+        "obs-studio": {
+            "version": "29.0.2",
+            "repository": "https://github.com/obsproject/obs-studio.git",
+            "branch": "0fb8bb4b1e18ee1c870c48d35ab5b598af3b59e9",
+            "hash": "0fb8bb4b1e18ee1c870c48d35ab5b598af3b59e9"
+        },
+        "prebuilt": {
+            "version": "2023-01-06",
+            "baseUrl": "https://github.com/obsproject/obs-deps/releases/download",
+            "label": "Pre-built obs-deps",
+            "hashes": {
+                "macos-x86_64": "67d1080536efb4e47a5f4fcf47d07680ef5847d72a1170cb917fc65698b628b0",
+                "macos-arm64": "06b363a842de8d470d4fcae68823178574905de6c98c5dd21052b8a96fc9a0a3",
+                "macos-universal": "811c022a178230d3b9ad1eeb8ae9e1de0e6017b69364f50b183e36246509e0e8",
+                "windows-x64": "1026a72af2548d589e30d58edf2b3c7f2f6a16d8fd481ab33aab64d8181b1556",
+                "windows-x86": "315a9e445d518503bdd36d9fdfee2b2ba1f791355420055c0ef97cd54897a754"
+            }
+        },
+        "qt5": {
+            "version": "2022-08-02",
+            "baseUrl": "https://github.com/obsproject/obs-deps/releases/download",
+            "label": "Pre-built Qt5",
+            "hashes": {
+                "macos-x86_64": "5894ac8a7e3f1fd0035d87a5679eaad08b2193d771124eeb506bc5e54fb7c411",
+                "macos-arm64": "a32a30cf7d9efe0a08f0d58355a17be4ec9fecc9b1a7dc958ff1c16e0a73e14d",
+                "macos-universal": "b06f947cda11452cd6e7d28ae29bb6eb7e61be15445e260d49e21f555f55bd6e",
+                "windows-x64": "4ac110d268272ff073957493d9d84cfec75939b6e3d845bc3b17d9d7620d869a",
+                "windows-x86": "6c1d7dfb23fbb7a32bcbf6e963db61d408be91db56a2e2dae5f7905173445fe2"
+            },
+            "pdb-hashes": {
+                "windows-x64": "29edaf1b9442b374a2d8252d4d0936424e353e91a59fff4265cd13bb2ae71e7a",
+                "windows-x86": "67044abd25420c2e77c57f0270940df06092a2f271982a399c254e3af278bff1"
+            }
+        },
+        "qt6": {
+            "version": "2023-01-06",
+            "baseUrl": "https://github.com/obsproject/obs-deps/releases/download",
+            "label": "Pre-built Qt6",
+            "hashes": {
+                "macos-x86_64": "d6b1055e16a5569fcbee3076488bbaf0ea7323632d6ea978937b70f10cd1a50d",
+                "macos-arm64": "39980aed1e2cd82b791f3d8329f0445f01754e4af762724efbd5301ab2128af8",
+                "macos-universal": "dfa3c48ee46765029d06773ba08d84b3f11360547171c8e736019c77fabff80d",
+                "windows-x64": "525370749446703f165b9c538d94a4f7badb2715cbe3360975ca5579300f2c3c",
+                "windows-x86": "799cea49fcfeab602aefb813bc40a2673a8fd4404e4c7c142e513928ce0ccf4b"
+            },
+            "pdb-hashes": {
+                "windows-x64": "8d3e4f09042bd987b417c3b0ca9d1dcd46f11f7c62de10566dfaf72cf93eeefe",
+                "windows-x86": "0a01ed741987ee46cc7b489c82d95fb806072accac2b42a5997a5664c0b90492"
+            }
+        }
+    },
+    "platformConfig": {
+        "macos-x86_64": {
+            "qtVersion": 6,
+            "deploymentTarget": "10.15"
+        },
+        "macos-arm64": {
+            "qtVersion": 6,
+            "deploymentTarget": "11.0"
+        },
+        "macos-universal": {
+            "qtVersion": 6,
+            "deploymentTarget": "10.15"
+        },
+        "windows-x64": {
+            "qtVersion": 6,
+            "visualStudio": "Visual Studio 17 2022",
+            "platformSDK": "10.0.20348.0"
+        },
+        "windows-x86": {
+            "qtVersion": 6,
+            "visualStudio": "Visual Studio 17 2022",
+            "platformSDK": "10.0.20348.0"
+        },
+        "linux-x86_64": {
+            "qtVersion": 6
+        },
+        "linux-aarch64": {
+            "qtVersion": 6
+        }
+    },
+    "name": "obs-backgroundremoval",
+    "version": "0.5.0"
+}

obs-backgroundremoval-0.5.0.tar.xz/ci/flatpak Added

obs-backgroundremoval-0.5.0.tar.xz/ci/flatpak/com.obsproject.Studio.Plugin.backgroundremoval.metainfo.xml Added

obs-backgroundremoval-0.5.0.tar.xz/ci/flatpak/com.obsproject.Studio.Plugin.backgroundremoval.yaml Added

@@ -0,0 +1,60 @@
+# build into folder "build-dir":
+# $ flatpak-builder build-dir com.obsproject.Studio.Plugin.backgroundremoval.yaml --force-clean
+#
+# install:
+# $ flatpak-builder --user --install --force-clean build-dir com.obsproject.Studio.Plugin.backgroundremoval.yaml
+id: com.obsproject.Studio.Plugin.backgroundremoval
+runtime: com.obsproject.Studio
+runtime-version: stable
+sdk: org.kde.Sdk/x86_64/6.4
+build-extension: true
+separate-locales: false
+appstream-compose: false
+build-options:
+  prefix: /app/plugins/backgroundremoval
+modules:
+  # onnxruntime has a bash+python+cmake build script - just download/use pre-compiled library
+  # https://onnxruntime.ai/docs/build/inferencing.html
+  - name: onnxruntime
+    buildsystem: simple
+    sources:
+      - type: archive
+        url: https://github.com/microsoft/onnxruntime/releases/download/v1.11.1/onnxruntime-linux-x64-1.11.1.tgz
+        sha256: ddc03b5ae325c675ff76a6f18786ce7d310be6eb6f320087f7a0e9228115f24d
+    build-commands:
+      - mkdir -p ${FLATPAK_DEST}/include ${FLATPAK_DEST}/lib
+      - mv include/* ${FLATPAK_DEST}/include
+      - mv lib/* ${FLATPAK_DEST}/lib
+  # https://docs.opencv.org/4.x/db/d05/tutorial_config_reference.html
+  - name: opencv
+    buildsystem: cmake
+    config-opts:
+      - "-DCMAKE_BUILD_TYPE=Release"
+      - "-DBUILD_LIST=imgproc"
+    cleanup:
+    - "/bin"
+    builddir: true
+    sources:
+      - type: archive
+        url: https://github.com/opencv/opencv/archive/refs/tags/4.5.5.tar.gz
+        sha256: a1cfdcf6619387ca9e232687504da996aaa9f7b5689986b8331ec02cb61d28ad
+  - name: obs-backgroundremoval
+    buildsystem: cmake
+    builddir: true
+    config-opts:
+      - -DLIBOBS_INCLUDE_DIR=/app/include/obs
+      - -DOnnxruntime_INCLUDE_DIR=/app/plugins/backgroundremoval/include
+      - -DOnnxruntime_LIBRARIES=/app/plugins/backgroundremoval/lib/libonnxruntime.so
+    sources:
+      - type: git
+        url: https://github.com/royshil/obs-backgroundremoval.git
+        tag: v0.4.0
+        commit: 4f0348a15103cd4e516d94b629851208280cd4d4
+  - name: appdata
+    buildsystem: simple
+    build-commands:
+      - install -Dm644 --target-directory=${FLATPAK_DEST}/share/metainfo ${FLATPAK_ID}.metainfo.xml
+      - appstream-compose --basename=${FLATPAK_ID} --prefix=${FLATPAK_DEST} --origin=flatpak ${FLATPAK_ID}
+    sources:
+      - type: file
+        path: com.obsproject.Studio.Plugin.backgroundremoval.metainfo.xml

obs-backgroundremoval-0.5.0.tar.xz/ci/flatpak/flathub.json Added

obs-backgroundremoval-0.5.0.tar.xz/cmake Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/FindOnnxruntime.cmake Added

@@ -0,0 +1,64 @@
+# Try to find onnxruntime library Once done this will define Onnxruntime_FOUND - if system found
+# onnruntime library Onnxruntime_INCLUDE_DIRS - The onnruntime include directories
+# Onnxruntime_LIBRARIES - The libraries needed to use onnxruntime Onnxruntime_LIBRARY_DIR - The
+# directory of onnxruntime libraries
+
+if(APPLE)
+  set(Onnxruntime_DIR_BUILD ${CMAKE_SOURCE_DIR}/build/onnxruntime)
+  file(GLOB Onnxruntime_LIBRARIES_EX ${Onnxruntime_DIR_BUILD}/lib/lib*.a)
+
+  find_package(Protobuf REQUIRED)
+
+  set(Onnxruntime_LIBRARIES
+      ${Onnxruntime_LIBRARIES_EX} ${Protobuf_LIBRARIES}
+      CACHE STRING "Onnxruntime libraries")
+  set(Onnxruntime_INCLUDE_DIR
+      ${Onnxruntime_DIR_BUILD}/include
+      CACHE STRING "Onnxruntime include directory")
+  message(STATUS "Onnxruntime_INCLUDE_DIRS: ${Onnxruntime_INCLUDE_DIRS}")
+  message(STATUS "Onnxruntime_LIBRARY_DIRS: ${Onnxruntime_LIBRARY_DIRS}")
+  message(STATUS "Onnxruntime_LIBRARIES: ${Onnxruntime_LIBRARIES}")
+else()
+  if(WITH_CUDA)
+    set(ONNXRUNTIME_DIR_HINT ${CMAKE_BINARY_DIR}/nuget/Microsoft.ML.OnnxRuntime.Gpu.1.11.0/)
+  else()
+    set(ONNXRUNTIME_DIR_HINT ${CMAKE_BINARY_DIR}/nuget/Microsoft.ML.OnnxRuntime.DirectML.1.11.0/)
+  endif()
+
+  find_library(
+    Onnxruntime_LIBRARIES
+    NAMES onnxruntime
+    PATHS ${Onnxruntime_DIR} ${ONNXRUNTIME_DIR_HINT}runtimes/win-x64/native
+    DOC "Onnxruntime library")
+
+  find_path(
+    Onnxruntime_INCLUDE_DIR
+    NAMES "onnxruntime_cxx_api.h" "onnxruntime/core/session/onnxruntime_cxx_api.h"
+    PATHS ${Onnxruntime_INCLUDE_HINT} ${ONNXRUNTIME_DIR_HINT}build/native/include
+    DOC "Onnxruntime include directory")
+endif()
+
+include(FindPackageHandleStandardArgs)
+# handle the QUIETLY and REQUIRED arguments and set LOGGING_FOUND to TRUE if all listed variables
+# are TRUE
+find_package_handle_standard_args(Onnxruntime DEFAULT_MSG Onnxruntime_INCLUDE_DIR
+                                  Onnxruntime_LIBRARIES)
+
+if(Onnxruntime_FOUND)
+  set(Onnxruntime_INCLUDE_DIRS
+      ${Onnxruntime_INCLUDE_DIR}
+      CACHE STRING "Onnxruntime include directories")
+  if(APPLE)
+    set(Onnxruntime_INCLUDE_DIRS ${Onnxruntime_INCLUDE_DIRS} ${Onnxruntime_INCLUDE_DIR}/onnxruntime
+                                 ${Onnxruntime_INCLUDE_DIR}/onnxruntime/core/session)
+  endif()
+  list(GET Onnxruntime_LIBRARIES 0 Onnxruntime_LIBRARY)
+  get_filename_component(Onnxruntime_LIBRARY_DIR_EX ${Onnxruntime_LIBRARY} DIRECTORY)
+  set(Onnxruntime_LIBRARY_DIR
+      ${Onnxruntime_LIBRARY_DIR_EX}
+      CACHE STRING "Onnxruntime library directory")
+endif()
+
+# Tell cmake GUIs to ignore the "local" variables.
+mark_as_advanced(Onnxruntime_INCLUDE_DIR Onnxruntime_LIBRARY Onnxruntime_INCLUDE_DIRS
+                 Onnxruntime_LIBRARY_DIR Onnxruntime_LIBRARIES)

obs-backgroundremoval-0.5.0.tar.xz/cmake/ObsPluginHelpers.cmake Added

@@ -0,0 +1,699 @@
+if(POLICY CMP0087)
+ cmake_policy(SET CMP0087 NEW)
+endif()
+
+set(OBS_STANDALONE_PLUGIN_DIR ${CMAKE_SOURCE_DIR}/release)
+
+include(GNUInstallDirs)
+if(${CMAKE_SYSTEM_NAME} STREQUAL "Darwin")
+ set(OS_MACOS ON)
+ set(OS_POSIX ON)
+elseif(${CMAKE_SYSTEM_NAME} MATCHES "Linux|FreeBSD|OpenBSD")
+ set(OS_POSIX ON)
+ string(TOUPPER "${CMAKE_SYSTEM_NAME}" _SYSTEM_NAME_U)
+ set(OS_${_SYSTEM_NAME_U} ON)
+elseif(${CMAKE_SYSTEM_NAME} STREQUAL "Windows")
+ set(OS_WINDOWS ON)
+ set(OS_POSIX OFF)
+endif()
+
+# Old-Style plugin detected, find "modern" libobs variant instead and set global include directories
+# to fix "bad" plugin behavior
+if(DEFINED LIBOBS_INCLUDE_DIR AND NOT TARGET OBS::libobs)
+ message(
+ DEPRECATION
+ "You are using an outdated method of adding 'libobs' to your project. Refer to the updated wiki on how to build and export 'libobs' and use it in your plugin projects."
+ )
+ find_package(libobs REQUIRED)
+ if(TARGET OBS::libobs)
+ set_target_properties(OBS::libobs PROPERTIES IMPORTED_GLOBAL TRUE)
+ message(STATUS "OBS: Using modern libobs target")
+
+ add_library(libobs ALIAS OBS::libobs)
+ if(OS_WINDOWS)
+ add_library(w32-pthreads ALIAS OBS::w32-pthreads)
+ endif()
+ endif()
+endif()
+
+# Set macOS and Windows specific if default value is used
+if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT AND (OS_WINDOWS OR OS_MACOS))
+ set(CMAKE_INSTALL_PREFIX
+ ${OBS_STANDALONE_PLUGIN_DIR}
+ CACHE STRING "Directory to install OBS plugin after building" FORCE)
+endif()
+
+# Set default build type to RelWithDebInfo and specify allowed alternative values
+if(NOT CMAKE_BUILD_TYPE)
+ set(CMAKE_BUILD_TYPE
+ "RelWithDebInfo"
+ CACHE STRING "OBS build type Release, RelWithDebInfo, Debug, MinSizeRel" FORCE)
+ set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS Release RelWithDebInfo Debug MinSizeRel)
+endif()
+
+# Set default Qt version to AUTO, preferring an available Qt6 with a fallback to Qt5
+if(NOT QT_VERSION)
+ set(QT_VERSION
+ AUTO
+ CACHE STRING "OBS Qt version AUTO, 6, 5" FORCE)
+ set_property(CACHE QT_VERSION PROPERTY STRINGS AUTO 6 5)
+endif()
+
+# Macro to find best possible Qt version for use with the project:
+#
+# * Use QT_VERSION value as a hint for desired Qt version
+# * If "AUTO" was specified, prefer Qt6 over Qt5
+# * Creates versionless targets of desired component if none had been created by Qt itself (Qt
+# versions < 5.15)
+#
+macro(find_qt)
+ set(multiValueArgs COMPONENTS COMPONENTS_WIN COMPONENTS_MAC COMPONENTS_LINUX)
+ cmake_parse_arguments(FIND_QT "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+ # Do not use versionless targets in the first step to avoid Qt::Core being clobbered by later
+ # opportunistic find_package runs
+ set(QT_NO_CREATE_VERSIONLESS_TARGETS ON)
+
+ # Loop until _QT_VERSION is set or FATAL_ERROR aborts script execution early
+ while(NOT _QT_VERSION)
+ if(QT_VERSION STREQUAL AUTO AND NOT _QT_TEST_VERSION)
+ set(_QT_TEST_VERSION 6)
+ elseif(NOT QT_VERSION STREQUAL AUTO)
+ set(_QT_TEST_VERSION ${QT_VERSION})
+ endif()
+
+ find_package(
+ Qt${_QT_TEST_VERSION}
+ COMPONENTS Core
+ QUIET)
+
+ if(TARGET Qt${_QT_TEST_VERSION}::Core)
+ set(_QT_VERSION
+ ${_QT_TEST_VERSION}
+ CACHE INTERNAL "")
+ message(STATUS "Qt version found: ${_QT_VERSION}")
+ unset(_QT_TEST_VERSION)
+ break()
+ elseif(QT_VERSION STREQUAL AUTO)
+ if(_QT_TEST_VERSION EQUAL 6)
+ message(WARNING "Qt6 was not found, falling back to Qt5")
+ set(_QT_TEST_VERSION 5)
+ continue()
+ endif()
+ endif()
+ message(FATAL_ERROR "Neither Qt6 nor Qt5 found.")
+ endwhile()
+
+ # Enable versionless targets for the remaining Qt components
+ set(QT_NO_CREATE_VERSIONLESS_TARGETS OFF)
+
+ set(_QT_COMPONENTS ${FIND_QT_COMPONENTS})
+ if(OS_WINDOWS)
+ list(APPEND _QT_COMPONENTS ${FIND_QT_COMPONENTS_WIN})
+ elseif(OS_MACOS)
+ list(APPEND _QT_COMPONENTS ${FIND_QT_COMPONENTS_MAC})
+ else()
+ list(APPEND _QT_COMPONENTS ${FIND_QT_COMPONENTS_LINUX})
+ endif()
+
+ find_package(
+ Qt${_QT_VERSION}
+ COMPONENTS ${_QT_COMPONENTS}
+ REQUIRED)
+
+ list(APPEND _QT_COMPONENTS Core)
+
+ if("Gui" IN_LIST FIND_QT_COMPONENTS_LINUX)
+ list(APPEND _QT_COMPONENTS "GuiPrivate")
+ endif()
+
+ # Check for versionless targets of each requested component and create if necessary
+ foreach(_COMPONENT IN LISTS _QT_COMPONENTS)
+ if(NOT TARGET Qt::${_COMPONENT} AND TARGET Qt${_QT_VERSION}::${_COMPONENT})
+ add_library(Qt::${_COMPONENT} INTERFACE IMPORTED)
+ set_target_properties(Qt::${_COMPONENT} PROPERTIES INTERFACE_LINK_LIBRARIES
+ Qt${_QT_VERSION}::${_COMPONENT})
+ endif()
+ endforeach()
+endmacro()
+
+# Set relative path variables for file configurations
+file(RELATIVE_PATH RELATIVE_INSTALL_PATH ${CMAKE_SOURCE_DIR} ${CMAKE_INSTALL_PREFIX})
+file(RELATIVE_PATH RELATIVE_BUILD_PATH ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR})
+
+if(OS_POSIX)
+ # Set default GCC/clang compile options:
+ #
+ # * Treat warnings as errors
+ # * Enable extra warnings, https://clang.llvm.org/docs/DiagnosticsReference.html#wextra
+ # * Warning about usage of variable length array,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wvla
+ # * Warning about bad format specifiers,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wformat
+ # * Warning about non-strings used as format strings,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wformat-security
+ # * Warning about non-exhaustive switch blocks,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wswitch
+ # * Warning about unused parameters,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wunused-parameter
+ # * DISABLE warning about unused functions,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wunused-function
+ # * DISABLE warning about missing field initializers,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wmissing-field-initializers
+ # * DISABLE strict aliasing optimisations
+ # * C ONLY - treat implicit function declarations (use before declare) as errors,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wimplicit-function-declaration
+ # * C ONLY - DISABLE warning about missing braces around subobject initalizers,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wmissing-braces
+ # * C ONLY, Clang ONLY - Warning about implicit conversion of NULL to another type,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wnull-conversion
+ # * C & C++, Clang ONLY - Disable warning about integer conversion losing precision,
+ # https://clang.llvm.org/docs/DiagnosticsReference.html#wshorten-64-to-32
+ # * C++, GCC ONLY - Warning about implicit conversion of NULL to another type
+ # * Enable color diagnostics on Clang (CMAKE_COLOR_DIAGNOSTICS available in CMake 3.24)
+ target_compile_options(
+ ${CMAKE_PROJECT_NAME}
+ PRIVATE
+ -Werror
+ -Wextra
+ -Wvla
+ -Wformat
+ -Wformat-security
+ -Wswitch
+ -Wunused-parameter
+ -Wno-unused-function
+ -Wno-missing-field-initializers
+ -fno-strict-aliasing
+ "$<$<COMPILE_LANGUAGE:C>:-Werror-implicit-function-declaration;-Wno-missing-braces>"
+ "$<$<COMPILE_LANG_AND_ID:C,AppleClang,Clang>:-Wnull-conversion;-Wno-error=shorten-64-to-32;-fcolor-diagnostics>"
+ "$<$<COMPILE_LANG_AND_ID:CXX,AppleClang,Clang>:-Wnull-conversion;-Wno-error=shorten-64-to-32;-fcolor-diagnostics>"
+ "$<$<COMPILE_LANG_AND_ID:CXX,GNU>:-Wconversion-null>"
+ "$<$<CONFIG:DEBUG>:-DDEBUG=1;-D_DEBUG=1>")
+
+ # GCC 12.1.0 has a regression bug which trigger maybe-uninitialized warnings where there is not.
+ # (https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105562)
+ if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU" AND CMAKE_CXX_COMPILER_VERSION VERSION_EQUAL "12.1.0")
+ target_compile_options(${CMAKE_PROJECT_NAME} PRIVATE -Wno-error=maybe-uninitialized)
+ endif()
+
+ if(NOT CCACHE_SET)
+ # Try to find and enable ccache
+ find_program(CCACHE_PROGRAM "ccache")
+ set(CCACHE_SUPPORT
+ ON
+ CACHE BOOL "Enable ccache support")
+ mark_as_advanced(CCACHE_PROGRAM)
+ if(CCACHE_PROGRAM AND CCACHE_SUPPORT)
+ set(CMAKE_CXX_COMPILER_LAUNCHER
+ ${CCACHE_PROGRAM}
+ CACHE INTERNAL "")
+ set(CMAKE_C_COMPILER_LAUNCHER
+ ${CCACHE_PROGRAM}
+ CACHE INTERNAL "")
+ set(CMAKE_OBJC_COMPILER_LAUNCHER
+ ${CCACHE_PROGRAM}
+ CACHE INTERNAL "")
+ set(CMAKE_OBJCXX_COMPILER_LAUNCHER
+ ${CCACHE_PROGRAM}
+ CACHE INTERNAL "")
+ set(CMAKE_CUDA_COMPILER_LAUNCHER
+ ${CCACHE_PROGRAM}
+ CACHE INTERNAL "") # CMake 3.9+
+ set(CCACHE_SET
+ ON
+ CACHE INTERNAL "")
+ endif()
+ endif()
+endif()
+
+# Set required C++ standard to C++17
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
+
+# Get lowercase host architecture for easier comparison
+if(MSVC_CXX_ARCHITECTURE_ID)
+ string(TOLOWER ${MSVC_CXX_ARCHITECTURE_ID} _HOST_ARCH)
+else()
+ string(TOLOWER ${CMAKE_SYSTEM_PROCESSOR} _HOST_ARCH)
+endif()
+
+if(_HOST_ARCH MATCHES "i3-686|x86|x64|x86_64|amd64" AND NOT CMAKE_OSX_ARCHITECTURES STREQUAL
+ "arm64")
+ # Enable MMX, SSE and SSE2 on compatible host systems (assuming no cross-compile)
+ set(ARCH_SIMD_FLAGS -mmmx -msse -msse2)
+elseif(_HOST_ARCH MATCHES "arm64|arm64e|aarch64")
+ # Enable available built-in SIMD support in Clang and GCC
+ if(CMAKE_C_COMPILER_ID MATCHES "^(Apple)?Clang|GNU" OR CMAKE_CXX_COMPILER_ID MATCHES
+ "^(Apple)?Clang|GNU")
+ include(CheckCCompilerFlag)
+ include(CheckCXXCompilerFlag)
+
+ check_c_compiler_flag("-fopenmp-simd" C_COMPILER_SUPPORTS_OPENMP_SIMD)
+ check_cxx_compiler_flag("-fopenmp-simd" CXX_COMPILER_SUPPORTS_OPENMP_SIMD)
+ target_compile_options(
+ ${CMAKE_PROJECT_NAME}
+ PRIVATE
+ -DSIMDE_ENABLE_OPENMP
+ "$<$<AND:$<COMPILE_LANGUAGE:C>,$<BOOL:C_COMPILER_SUPPORTS_OPENMP_SIMD>>:-fopenmp-simd>"
+ "$<$<AND:$<COMPILE_LANGUAGE:CXX>,$<BOOL:CXX_COMPILER_SUPPORTS_OPENMP_SIMD>>:-fopenmp-simd>")
+ endif()
+endif()
+
+# macOS specific settings
+if(OS_MACOS)
+ # Set macOS-specific C++ standard library
+ target_compile_options(
+ ${CMAKE_PROJECT_NAME}
+ PRIVATE "$<$<COMPILE_LANG_AND_ID:OBJC,AppleClang,Clang>:-fcolor-diagnostics>" -stdlib=libc++)
+
+ # Set build architecture to host architecture by default
+ if(NOT CMAKE_OSX_ARCHITECTURES)
+ set(CMAKE_OSX_ARCHITECTURES
+ ${CMAKE_HOST_SYSTEM_PROCESSOR}
+ CACHE STRING "Build architecture for macOS" FORCE)
+ endif()
+ set_property(CACHE CMAKE_OSX_ARCHITECTURES PROPERTY STRINGS arm64 x86_64 "arm64;x86_64")
+
+ # Set deployment target to 11.0 for Apple Silicon or 10.15 for Intel and Universal builds
+ if(NOT CMAKE_OSX_DEPLOYMENT_TARGET)
+ set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGETarch=arm64 "11.0")
+ set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGETarch=x86_64 "10.15")
+
+ if("${CMAKE_OSX_ARCHITECTURES}" STREQUAL "arm64")
+ set(_MACOS_DEPLOYMENT_TARGET "11.0")
+ else()
+ set(_MACOS_DEPLOYMENT_TARGET "10.15")
+ endif()
+
+ set(CMAKE_OSX_DEPLOYMENT_TARGET
+ ${_MACOS_DEPLOYMENT_TARGET}
+ CACHE STRING
+ "Minimum macOS version to target for deployment (at runtime); newer APIs weak linked"
+ FORCE)
+ unset(_MACOS_DEPLOYMENT_TARGET)
+ endif()
+
+ set_property(CACHE CMAKE_OSX_DEPLOYMENT_TARGET PROPERTY STRINGS 13.0 12.0 11.0 10.15)
+
+ # Override macOS install directory
+ if(CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
+ set(CMAKE_INSTALL_PREFIX
+ ${CMAKE_BINARY_DIR}/install
+ CACHE STRING "Directory to install OBS to after building" FORCE)
+ endif()
+
+ # Set up codesigning for Xcode builds with team IDs or standalone builds with developer identity
+ if(NOT OBS_BUNDLE_CODESIGN_TEAM)
+ if(NOT OBS_BUNDLE_CODESIGN_IDENTITY)
+ set(OBS_BUNDLE_CODESIGN_IDENTITY
+ "-"
+ CACHE STRING "OBS code signing identity for macOS" FORCE)
+ endif()
+ set(CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY ${OBS_BUNDLE_CODESIGN_IDENTITY})
+ else()
+ # Team ID specified, warn if Xcode generator is not used and fall back to ad-hoc signing
+ if(NOT XCODE)
+ message(
+ WARNING
+ "Code signing with a team identifier is only supported with the Xcode generator. Using ad-hoc code signature instead."
+ )
+ if(NOT OBS_BUNDLE_CODESIGN_IDENTITY)
+ set(OBS_BUNDLE_CODESIGN_IDENTITY
+ "-"
+ CACHE STRING "OBS code signing identity for macOS" FORCE)
+ endif()
+ else()
+ unset(OBS_BUNDLE_CODESIGN_IDENTITY)
+ set_property(CACHE OBS_BUNDLE_CODESIGN_TEAM PROPERTY HELPSTRING
+ "OBS code signing team for macOS")
+ set(CMAKE_XCODE_ATTRIBUTE_CODE_SIGN_STYLE Automatic)
+ set(CMAKE_XCODE_ATTRIBUTE_DEVELOPMENT_TEAM ${OBS_BUNDLE_CODESIGN_TEAM})
+ endif()
+ endif()
+
+ # Set path to entitlements property list for codesigning. Entitlements should match the host
+ # binary, in this case OBS.app.
+ set(OBS_CODESIGN_ENTITLEMENTS
+ ${CMAKE_SOURCE_DIR}/cmake/bundle/macos/entitlements.plist
+ CACHE INTERNAL "Path to codesign entitlements plist")
+ # Enable linker codesigning by default. Building OBS or plugins on host systems older than macOS
+ # 10.15 is not supported
+ set(OBS_CODESIGN_LINKER
+ ON
+ CACHE BOOL "Enable linker codesigning on macOS (macOS 11+ required)")
+
+ # Tell Xcode to pretend the linker signed binaries so that editing with install_name_tool
+ # preserves ad-hoc signatures. This option is supported by codesign on macOS 11 or higher. See
+ # CMake Issue 21854: https://gitlab.kitware.com/cmake/cmake/-/issues/21854
+ if(OBS_CODESIGN_LINKER)
+ set(CMAKE_XCODE_ATTRIBUTE_OTHER_CODE_SIGN_FLAGS "-o linker-signed")
+ endif()
+
+ # Set default options for bundling on macOS
+ set(CMAKE_MACOSX_RPATH ON)
+ set(CMAKE_SKIP_BUILD_RPATH OFF)
+ set(CMAKE_BUILD_WITH_INSTALL_RPATH OFF)
+ set(CMAKE_INSTALL_RPATH "@executable_path/../Frameworks/")
+ set(CMAKE_INSTALL_RPATH_USE_LINK_PATH OFF)
+
+ # Helper function for plugin targets (macOS version)
+ function(setup_plugin_target target)
+ # Sanity check for required bundle information
+ #
+ # * Bundle identifier
+ # * Bundle version
+ # * Short version string
+ if(NOT DEFINED MACOSX_PLUGIN_GUI_IDENTIFIER)
+ message(
+ FATAL_ERROR
+ "No 'MACOSX_PLUGIN_GUI_IDENTIFIER' set, but is required to build plugin bundles on macOS - example: 'com.yourname.pluginname'"
+ )
+ endif()
+
+ if(NOT DEFINED MACOSX_PLUGIN_BUNDLE_VERSION)
+ message(
+ FATAL_ERROR
+ "No 'MACOSX_PLUGIN_BUNDLE_VERSION' set, but is required to build plugin bundles on macOS - example: '25'"
+ )
+ endif()
+
+ if(NOT DEFINED MACOSX_PLUGIN_SHORT_VERSION_STRING)
+ message(
+ FATAL_ERROR
+ "No 'MACOSX_PLUGIN_SHORT_VERSION_STRING' set, but is required to build plugin bundles on macOS - example: '1.0.2'"
+ )
+ endif()
+
+ # Set variables for automatic property list generation
+ set(MACOSX_PLUGIN_BUNDLE_NAME
+ "${target}"
+ PARENT_SCOPE)
+ set(MACOSX_PLUGIN_BUNDLE_VERSION
+ "${MACOSX_PLUGIN_BUNDLE_VERSION}"
+ PARENT_SCOPE)
+ set(MACOSX_PLUGIN_SHORT_VERSION_STRING
+ "${MACOSX_PLUGIN_SHORT_VERSION_STRING}"
+ PARENT_SCOPE)
+ set(MACOSX_PLUGIN_EXECUTABLE_NAME
+ "${target}"
+ PARENT_SCOPE)
+ set(MACOSX_PLUGIN_BUNDLE_TYPE
+ "BNDL"
+ PARENT_SCOPE)
+
+ # Set installation target to install prefix root (default for bundles)
+ install(
+ TARGETS ${target}
+ LIBRARY DESTINATION "."
+ COMPONENT obs_plugins
+ NAMELINK_COMPONENT ${target}_Development)
+
+ if(TARGET Qt::Core)
+ # Framework version has changed between Qt5 (uses wrong numerical version) and Qt6 (uses
+ # correct alphabetical version)
+ if(${_QT_VERSION} EQUAL 5)
+ set(_QT_FW_VERSION "${QT_VERSION}")
+ else()
+ set(_QT_FW_VERSION "A")
+ endif()
+
+ # Set up install-time command to fix Qt library references to point into OBS.app bundle
+ set(_COMMAND
+ "${CMAKE_INSTALL_NAME_TOOL} \\
+ -change ${CMAKE_PREFIX_PATH}/lib/QtWidgets.framework/Versions/${QT_VERSION}/QtWidgets @rpath/QtWidgets.framework/Versions/${_QT_FW_VERSION}/QtWidgets \\
+ -change ${CMAKE_PREFIX_PATH}/lib/QtCore.framework/Versions/${QT_VERSION}/QtCore @rpath/QtCore.framework/Versions/${_QT_FW_VERSION}/QtCore \\
+ -change ${CMAKE_PREFIX_PATH}/lib/QtGui.framework/Versions/${QT_VERSION}/QtGui @rpath/QtGui.framework/Versions/${_QT_FW_VERSION}/QtGui \\
+ \\\"\${CMAKE_INSTALL_PREFIX}/${target}.plugin/Contents/MacOS/${target}\\\"")
+ install(CODE "execute_process(COMMAND /bin/sh -c \"${_COMMAND}\")" COMPONENT obs_plugins)
+ unset(_QT_FW_VERSION)
+ endif()
+
+ # Set macOS bundle properties
+ set_target_properties(
+ ${target}
+ PROPERTIES PREFIX ""
+ BUNDLE ON
+ BUNDLE_EXTENSION "plugin"
+ OUTPUT_NAME ${target}
+ MACOSX_BUNDLE_INFO_PLIST
+ "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/bundle/macOS/Plugin-Info.plist.in"
+ XCODE_ATTRIBUTE_PRODUCT_BUNDLE_IDENTIFIER "${MACOSX_PLUGIN_GUI_IDENTIFIER}"
+ XCODE_ATTRIBUTE_CODE_SIGN_ENTITLEMENTS
+ "${CMAKE_CURRENT_FUNCTION_LIST_DIR}/bundle/macOS/entitlements.plist")
+
+ # If not building with Xcode, manually code-sign the plugin
+ if(NOT XCODE)
+ set(_COMMAND
+ "/usr/bin/codesign --force \\
+ --sign \\\"${OBS_BUNDLE_CODESIGN_IDENTITY}\\\" \\
+ --options runtime \\
+ --entitlements \\\"${CMAKE_CURRENT_FUNCTION_LIST_DIR}/bundle/macOS/entitlements.plist\\\" \\
+ \\\"\${CMAKE_INSTALL_PREFIX}/${target}.plugin\\\"")
+ install(CODE "execute_process(COMMAND /bin/sh -c \"${_COMMAND}\")" COMPONENT obs_plugins)
+ endif()
+
+ install_bundle_resources(${target})
+ endfunction()
+
+ # Helper function to add resources from "data" directory as bundle resources
+ function(install_bundle_resources target)
+ if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/data)
+ file(GLOB_RECURSE _DATA_FILES "${CMAKE_CURRENT_SOURCE_DIR}/data/*")
+ foreach(_DATA_FILE IN LISTS _DATA_FILES)
+ file(RELATIVE_PATH _RELATIVE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/data/ ${_DATA_FILE})
+ get_filename_component(_RELATIVE_PATH ${_RELATIVE_PATH} PATH)
+ target_sources(${target} PRIVATE ${_DATA_FILE})
+ set_source_files_properties(${_DATA_FILE} PROPERTIES MACOSX_PACKAGE_LOCATION
+ Resources/${_RELATIVE_PATH})
+ string(REPLACE "\\" "\\\\" _GROUP_NAME ${_RELATIVE_PATH})
+ source_group("Resources\\${_GROUP_NAME}" FILES ${_DATA_FILE})
+ endforeach()
+ endif()
+ endfunction()
+else()
+ # Check for target architecture (64bit vs 32bit)
+ if(CMAKE_SIZEOF_VOID_P EQUAL 8)
+ set(_ARCH_SUFFIX 64)
+ else()
+ set(_ARCH_SUFFIX 32)
+ endif()
+ set(OBS_OUTPUT_DIR ${CMAKE_BINARY_DIR}/rundir)
+
+ # Unix specific settings
+ if(OS_POSIX)
+ # Paths to binaries and plugins differ between portable and non-portable builds on Linux
+ option(LINUX_PORTABLE "Build portable version (Linux)" ON)
+ if(NOT LINUX_PORTABLE)
+ set(OBS_LIBRARY_DESTINATION ${CMAKE_INSTALL_LIBDIR})
+ set(OBS_PLUGIN_DESTINATION ${OBS_LIBRARY_DESTINATION}/obs-plugins)
+ set(CMAKE_INSTALL_RPATH ${CMAKE_INSTALL_PREFIX}/lib)
+ set(OBS_DATA_DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/obs)
+ else()
+ set(OBS_LIBRARY_DESTINATION bin/${_ARCH_SUFFIX}bit)
+ set(OBS_PLUGIN_DESTINATION obs-plugins/${_ARCH_SUFFIX}bit)
+ set(CMAKE_INSTALL_RPATH "$ORIGIN/" "${CMAKE_INSTALL_PREFIX}/${OBS_LIBRARY_DESTINATION}")
+ set(OBS_DATA_DESTINATION "data")
+ endif()
+
+ # Setup Linux-specific CPack values for "deb" package generation
+ if(OS_LINUX)
+ set(CPACK_PACKAGE_NAME "${CMAKE_PROJECT_NAME}")
+ set(CPACK_DEBIAN_PACKAGE_MAINTAINER "${LINUX_MAINTAINER_EMAIL}")
+ set(CPACK_PACKAGE_VERSION "${CMAKE_PROJECT_VERSION}")
+ set(CPACK_PACKAGE_FILE_NAME "${CPACK_PACKAGE_NAME}-${CPACK_PACKAGE_VERSION}-linux-x86_64")
+
+ set(CPACK_GENERATOR "DEB")
+ set(CPACK_DEBIAN_PACKAGE_DEPENDS
+ "obs-studio (>= 27.0.0), libqt5core5a (>= 5.9.0~beta), libqt5gui5 (>= 5.3.0), libqt5widgets5 (>= 5.7.0)"
+ )
+
+ set(CPACK_OUTPUT_FILE_PREFIX ${CMAKE_SOURCE_DIR}/release)
+
+ if(NOT LINUX_PORTABLE)
+ set(CPACK_SET_DESTDIR ON)
+ endif()
+ include(CPack)
+ endif()
+ # Windows specific settings
+ else()
+ set(OBS_LIBRARY_DESTINATION "bin/${_ARCH_SUFFIX}bit")
+ set(OBS_LIBRARY32_DESTINATION "bin/32bit")
+ set(OBS_LIBRARY64_DESTINATION "bin/64bit")
+ set(OBS_PLUGIN_DESTINATION "obs-plugins/${_ARCH_SUFFIX}bit")
+ set(OBS_PLUGIN32_DESTINATION "obs-plugins/32bit")
+ set(OBS_PLUGIN64_DESTINATION "obs-plugins/64bit")
+
+ set(OBS_DATA_DESTINATION "data")
+
+ if(MSVC)
+ # Set default Visual Studio CL.exe compile options.
+ #
+ # * Enable building with multiple processes,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/mp-build-with-multiple-processes?view=msvc-170
+ # * Enable lint-like warnings,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/compiler-option-warning-level?view=msvc-170
+ # * Enable treating all warnings as errors,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/compiler-option-warning-level?view=msvc-170
+ # * RelWithDebInfo ONLY - Enable expanding of all functions not explicitly marked for no
+ # inlining,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/ob-inline-function-expansion?view=msvc-170
+ # * Enable UNICODE support,
+ # https://docs.microsoft.com/en-us/windows/win32/learnwin32/working-with-strings#unicode-and-ansi-functions
+ # * DISABLE warnings about using POSIX function names,
+ # https://docs.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-3-c4996?view=msvc-170#posix-function-names
+ # * DISABLE warnings about unsafe CRT library functions,
+ # https://docs.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-3-c4996?view=msvc-170#unsafe-crt-library-functions
+ # * DISABLE warnings about nonstandard nameless structs/unions,
+ # https://docs.microsoft.com/en-us/cpp/error-messages/compiler-warnings/compiler-warning-level-4-c4201?view=msvc-170
+ target_compile_options(
+ ${CMAKE_PROJECT_NAME}
+ PRIVATE /MP
+ /W3
+ /WX
+ /wd4201
+ "$<$<CONFIG:RELWITHDEBINFO>:/Ob2>"
+ "$<$<CONFIG:DEBUG>:/DDEBUG=1;/D_DEBUG=1>"
+ /DUNICODE
+ /D_UNICODE
+ /D_CRT_SECURE_NO_WARNINGS
+ /D_CRT_NONSTDC_NO_WARNINGS)
+
+ # Set default Visual Studio linker options.
+ #
+ # * Enable removal of functions and data that are never used,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/opt-optimizations?view=msvc-170
+ # * Enable treating all warnings as errors,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/wx-treat-linker-warnings-as-errors?view=msvc-170
+ # * x64 ONLY - DISABLE creation of table of safe exception handlers,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/safeseh-image-has-safe-exception-handlers?view=msvc-170
+ # * Debug ONLY - DISABLE incremental linking,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/incremental-link-incrementally?view=msvc-170
+ # * RelWithDebInfo ONLY - Disable incremental linking, but enable COMDAT folding,
+ # https://docs.microsoft.com/en-us/cpp/build/reference/opt-optimizations?view=msvc-170
+ target_link_options(
+ ${CMAKE_PROJECT_NAME}
+ PRIVATE
+ "LINKER:/OPT:REF"
+ "LINKER:/WX"
+ "$<$<NOT:$<EQUAL:${CMAKE_SIZEOF_VOID_P},8>>:LINKER\:/SAFESEH\:NO>"
+ "$<$<CONFIG:DEBUG>:LINKER\:/INCREMENTAL\:NO>"
+ "$<$<CONFIG:RELWITHDEBINFO>:LINKER\:/INCREMENTAL\:NO;/OPT\:ICF>")
+ endif()
+ endif()
+
+ # Helper function for plugin targets (Windows and Linux version)
+ function(setup_plugin_target target)
+ # Set prefix to empty string to avoid automatic naming of generated library, i.e.
+ # "lib<YOUR_PLUGIN_NAME>"
+ set_target_properties(${target} PROPERTIES PREFIX "")
+
+ # Set install directories
+ install(
+ TARGETS ${target}
+ RUNTIME DESTINATION "${OBS_PLUGIN_DESTINATION}" COMPONENT ${target}_Runtime
+ LIBRARY DESTINATION "${OBS_PLUGIN_DESTINATION}"
+ COMPONENT ${target}_Runtime
+ NAMELINK_COMPONENT ${target}_Development)
+
+ # Set rundir install directory
+ install(
+ FILES $<TARGET_FILE:${target}>
+ DESTINATION $<CONFIG>/${OBS_PLUGIN_DESTINATION}
+ COMPONENT obs_rundir
+ EXCLUDE_FROM_ALL)
+
+ if(OS_WINDOWS)
+ # Set install directory for optional PDB symbol files
+ install(
+ FILES $<TARGET_PDB_FILE:${target}>
+ CONFIGURATIONS "RelWithDebInfo" "Debug"
+ DESTINATION ${OBS_PLUGIN_DESTINATION}
+ COMPONENT ${target}_Runtime
+ OPTIONAL)
+
+ # Set rundir install directory for optional PDB symbol files
+ install(
+ FILES $<TARGET_PDB_FILE:${target}>
+ CONFIGURATIONS "RelWithDebInfo" "Debug"
+ DESTINATION $<CONFIG>/${OBS_PLUGIN_DESTINATION}
+ COMPONENT obs_rundir
+ OPTIONAL EXCLUDE_FROM_ALL)
+ endif()
+
+ # Add resources from data directory
+ setup_target_resources(${target} obs-plugins/${target})
+
+ # Set up plugin for testing in available OBS build on Windows
+ if(OS_WINDOWS AND DEFINED OBS_BUILD_DIR)
+ setup_target_for_testing(${target} obs-plugins/${target})
+ endif()
+
+ # Custom command to install generated plugin into rundir
+ add_custom_command(
+ TARGET ${target}
+ POST_BUILD
+ COMMAND
+ "${CMAKE_COMMAND}" -DCMAKE_INSTALL_PREFIX=${OBS_OUTPUT_DIR}
+ -DCMAKE_INSTALL_COMPONENT=obs_rundir -DCMAKE_INSTALL_CONFIG_NAME=$<CONFIG> -P
+ ${CMAKE_CURRENT_BINARY_DIR}/cmake_install.cmake
+ COMMENT "Installing to plugin rundir"
+ VERBATIM)
+ endfunction()
+
+ # Helper function to add resources from "data" directory
+ function(setup_target_resources target destination)
+ if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/data)
+ install(
+ DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data/
+ DESTINATION ${OBS_DATA_DESTINATION}/${destination}
+ USE_SOURCE_PERMISSIONS
+ COMPONENT obs_plugins)
+
+ install(
+ DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data
+ DESTINATION $<CONFIG>/${OBS_DATA_DESTINATION}/${destination}
+ USE_SOURCE_PERMISSIONS
+ COMPONENT obs_rundir
+ EXCLUDE_FROM_ALL)
+ endif()
+ endfunction()
+
+ if(OS_WINDOWS)
+ # Additional Windows-only helper function to copy plugin to existing OBS development directory:
+ #
+ # Copies plugin with associated PDB symbol files as well as contents of data directory into the
+ # OBS rundir as specified by "OBS_BUILD_DIR".
+ function(setup_target_for_testing target destination)
+ install(
+ FILES $<TARGET_FILE:${target}>
+ DESTINATION $<CONFIG>/${OBS_PLUGIN_DESTINATION}
+ COMPONENT obs_testing
+ EXCLUDE_FROM_ALL)
+
+ install(
+ FILES $<TARGET_PDB_FILE:${target}>
+ CONFIGURATIONS "RelWithDebInfo" "Debug"
+ DESTINATION $<CONFIG>/${OBS_PLUGIN_DESTINATION}
+ COMPONENT obs_testing
+ OPTIONAL EXCLUDE_FROM_ALL)
+
+ install(
+ DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data/
+ DESTINATION $<CONFIG>/${OBS_DATA_DESTINATION}/${destination}
+ USE_SOURCE_PERMISSIONS
+ COMPONENT obs_testing
+ EXCLUDE_FROM_ALL)
+
+ add_custom_command(
+ TARGET ${target}
+ POST_BUILD
+ COMMAND
+ "${CMAKE_COMMAND}" -DCMAKE_INSTALL_PREFIX=${OBS_BUILD_DIR}/rundir
+ -DCMAKE_INSTALL_COMPONENT=obs_testing -DCMAKE_INSTALL_CONFIG_NAME=$<CONFIG> -P
+ ${CMAKE_CURRENT_BINARY_DIR}/cmake_install.cmake
+ COMMENT "Installing to OBS test directory"
+ VERBATIM)
+ endfunction()
+ endif()
+endif()

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/macos Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/macos/Plugin-Info.plist.in Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/macos/entitlements.plist Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/macos/installer-macos.pkgproj.in Added

@@ -0,0 +1,920 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>PACKAGES</key>
+	<array>
+		<dict>
+			<key>MUST-CLOSE-APPLICATION-ITEMS</key>
+			<array/>
+			<key>MUST-CLOSE-APPLICATIONS</key>
+			<false/>
+			<key>PACKAGE_FILES</key>
+			<dict>
+				<key>DEFAULT_INSTALL_LOCATION</key>
+				<string>/</string>
+				<key>HIERARCHY</key>
+				<dict>
+					<key>CHILDREN</key>
+					<array>
+						<dict>
+							<key>CHILDREN</key>
+							<array/>
+							<key>GID</key>
+							<integer>80</integer>
+							<key>PATH</key>
+							<string>Applications</string>
+							<key>PATH_TYPE</key>
+							<integer>0</integer>
+							<key>PERMISSIONS</key>
+							<integer>509</integer>
+							<key>TYPE</key>
+							<integer>1</integer>
+							<key>UID</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>CHILDREN</key>
+							<array>
+								<dict>
+									<key>CHILDREN</key>
+									<array>
+										<dict>
+											<key>CHILDREN</key>
+											<array>
+												<dict>
+													<key>CHILDREN</key>
+													<array>
+														<dict>
+															<key>BUNDLE_CAN_DOWNGRADE</key>
+															<false/>
+															<key>BUNDLE_POSTINSTALL_PATH</key>
+															<dict>
+																<key>PATH_TYPE</key>
+																<integer>0</integer>
+															</dict>
+															<key>BUNDLE_PREINSTALL_PATH</key>
+															<dict>
+																<key>PATH_TYPE</key>
+																<integer>0</integer>
+															</dict>
+															<key>CHILDREN</key>
+															<array/>
+															<key>GID</key>
+															<integer>80</integer>
+															<key>PATH</key>
+															<string>../@RELATIVE_INSTALL_PATH@/@CMAKE_PROJECT_NAME@.plugin</string>
+															<key>PATH_TYPE</key>
+															<integer>1</integer>
+															<key>PERMISSIONS</key>
+															<integer>493</integer>
+															<key>TYPE</key>
+															<integer>3</integer>
+															<key>UID</key>
+															<integer>0</integer>
+														</dict>
+													</array>
+													<key>GID</key>
+													<integer>80</integer>
+													<key>PATH</key>
+													<string>plugins</string>
+													<key>PATH_TYPE</key>
+													<integer>2</integer>
+													<key>PERMISSIONS</key>
+													<integer>509</integer>
+													<key>TYPE</key>
+													<integer>2</integer>
+													<key>UID</key>
+													<integer>0</integer>
+												</dict>
+											</array>
+											<key>GID</key>
+											<integer>80</integer>
+											<key>PATH</key>
+											<string>obs-studio</string>
+											<key>PATH_TYPE</key>
+											<integer>2</integer>
+											<key>PERMISSIONS</key>
+											<integer>509</integer>
+											<key>TYPE</key>
+											<integer>2</integer>
+											<key>UID</key>
+											<integer>0</integer>
+										</dict>
+									</array>
+									<key>GID</key>
+									<integer>80</integer>
+									<key>PATH</key>
+									<string>Application Support</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Automator</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Documentation</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Extensions</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Filesystems</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Frameworks</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Input Methods</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Internet Plug-Ins</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>LaunchAgents</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>LaunchDaemons</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>PreferencePanes</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Preferences</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>80</integer>
+									<key>PATH</key>
+									<string>Printers</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>PrivilegedHelperTools</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>1005</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>QuickLook</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>QuickTime</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Screen Savers</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Scripts</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Services</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Widgets</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>493</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+							</array>
+							<key>GID</key>
+							<integer>0</integer>
+							<key>PATH</key>
+							<string>Library</string>
+							<key>PATH_TYPE</key>
+							<integer>0</integer>
+							<key>PERMISSIONS</key>
+							<integer>493</integer>
+							<key>TYPE</key>
+							<integer>1</integer>
+							<key>UID</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>CHILDREN</key>
+							<array>
+								<dict>
+									<key>CHILDREN</key>
+									<array/>
+									<key>GID</key>
+									<integer>0</integer>
+									<key>PATH</key>
+									<string>Shared</string>
+									<key>PATH_TYPE</key>
+									<integer>0</integer>
+									<key>PERMISSIONS</key>
+									<integer>1023</integer>
+									<key>TYPE</key>
+									<integer>1</integer>
+									<key>UID</key>
+									<integer>0</integer>
+								</dict>
+							</array>
+							<key>GID</key>
+							<integer>80</integer>
+							<key>PATH</key>
+							<string>Users</string>
+							<key>PATH_TYPE</key>
+							<integer>0</integer>
+							<key>PERMISSIONS</key>
+							<integer>493</integer>
+							<key>TYPE</key>
+							<integer>1</integer>
+							<key>UID</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>GID</key>
+					<integer>0</integer>
+					<key>PATH</key>
+					<string>/</string>
+					<key>PATH_TYPE</key>
+					<integer>0</integer>
+					<key>PERMISSIONS</key>
+					<integer>493</integer>
+					<key>TYPE</key>
+					<integer>1</integer>
+					<key>UID</key>
+					<integer>0</integer>
+				</dict>
+				<key>PAYLOAD_TYPE</key>
+				<integer>0</integer>
+				<key>PRESERVE_EXTENDED_ATTRIBUTES</key>
+				<false/>
+				<key>SHOW_INVISIBLE</key>
+				<false/>
+				<key>SPLIT_FORKS</key>
+				<true/>
+				<key>TREAT_MISSING_FILES_AS_WARNING</key>
+				<false/>
+				<key>VERSION</key>
+				<integer>5</integer>
+			</dict>
+			<key>PACKAGE_SCRIPTS</key>
+			<dict>
+				<key>POSTINSTALL_PATH</key>
+				<dict>
+					<key>PATH_TYPE</key>
+					<integer>0</integer>
+				</dict>
+				<key>PREINSTALL_PATH</key>
+				<dict>
+					<key>PATH_TYPE</key>
+					<integer>0</integer>
+				</dict>
+				<key>RESOURCES</key>
+				<array/>
+			</dict>
+			<key>PACKAGE_SETTINGS</key>
+			<dict>
+				<key>AUTHENTICATION</key>
+				<integer>0</integer>
+				<key>CONCLUSION_ACTION</key>
+				<integer>0</integer>
+				<key>FOLLOW_SYMBOLIC_LINKS</key>
+				<false/>
+				<key>IDENTIFIER</key>
+				<string>@MACOS_BUNDLEID@</string>
+				<key>LOCATION</key>
+				<integer>0</integer>
+				<key>NAME</key>
+				<string>@CMAKE_PROJECT_NAME@</string>
+				<key>OVERWRITE_PERMISSIONS</key>
+				<false/>
+				<key>PAYLOAD_SIZE</key>
+				<integer>-1</integer>
+				<key>REFERENCE_PATH</key>
+				<string></string>
+				<key>RELOCATABLE</key>
+				<false/>
+				<key>USE_HFS+_COMPRESSION</key>
+				<false/>
+				<key>VERSION</key>
+				<string>@CMAKE_PROJECT_VERSION@</string>
+			</dict>
+			<key>TYPE</key>
+			<integer>0</integer>
+			<key>UUID</key>
+			<string>0B7A74BC-65CF-4FF1-AC34-5C743E8A48F5</string>
+		</dict>
+	</array>
+	<key>PROJECT</key>
+	<dict>
+		<key>PROJECT_COMMENTS</key>
+		<dict>
+			<key>NOTES</key>
+			<data>
+			</data>
+		</dict>
+		<key>PROJECT_PRESENTATION</key>
+		<dict>
+			<key>BACKGROUND</key>
+			<dict>
+				<key>APPAREANCES</key>
+				<dict>
+					<key>DARK_AQUA</key>
+					<dict/>
+					<key>LIGHT_AQUA</key>
+					<dict/>
+				</dict>
+				<key>SHARED_SETTINGS_FOR_ALL_APPAREANCES</key>
+				<true/>
+			</dict>
+			<key>INSTALLATION TYPE</key>
+			<dict>
+				<key>HIERARCHIES</key>
+				<dict>
+					<key>INSTALLER</key>
+					<dict>
+						<key>LIST</key>
+						<array>
+							<dict>
+								<key>CHILDREN</key>
+								<array/>
+								<key>DESCRIPTION</key>
+								<array/>
+								<key>OPTIONS</key>
+								<dict>
+									<key>HIDDEN</key>
+									<false/>
+									<key>STATE</key>
+									<integer>1</integer>
+								</dict>
+								<key>PACKAGE_UUID</key>
+								<string>0B7A74BC-65CF-4FF1-AC34-5C743E8A48F5</string>
+								<key>TITLE</key>
+								<array/>
+								<key>TYPE</key>
+								<integer>0</integer>
+								<key>UUID</key>
+								<string>52B6084A-F58D-45C3-BE37-76AD45F16072</string>
+							</dict>
+						</array>
+						<key>REMOVED</key>
+						<dict/>
+					</dict>
+				</dict>
+				<key>MODE</key>
+				<integer>0</integer>
+			</dict>
+			<key>INSTALLATION_STEPS</key>
+			<array>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewIntroductionController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>Introduction</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewReadMeController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>ReadMe</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewLicenseController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>License</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewDestinationSelectController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>TargetSelect</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewInstallationTypeController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>PackageSelection</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewInstallationController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>Install</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+				<dict>
+					<key>ICPRESENTATION_CHAPTER_VIEW_CONTROLLER_CLASS</key>
+					<string>ICPresentationViewSummaryController</string>
+					<key>INSTALLER_PLUGIN</key>
+					<string>Summary</string>
+					<key>LIST_TITLE_KEY</key>
+					<string>InstallerSectionTitle</string>
+				</dict>
+			</array>
+			<key>INTRODUCTION</key>
+			<dict>
+				<key>LOCALIZATIONS</key>
+				<array/>
+			</dict>
+			<key>LICENSE</key>
+			<dict>
+				<key>LOCALIZATIONS</key>
+				<array/>
+				<key>MODE</key>
+				<integer>0</integer>
+			</dict>
+			<key>README</key>
+			<dict>
+				<key>LOCALIZATIONS</key>
+				<array/>
+			</dict>
+			<key>SUMMARY</key>
+			<dict>
+				<key>LOCALIZATIONS</key>
+				<array/>
+			</dict>
+			<key>TITLE</key>
+			<dict>
+				<key>LOCALIZATIONS</key>
+				<array/>
+			</dict>
+		</dict>
+		<key>PROJECT_REQUIREMENTS</key>
+		<dict>
+			<key>LIST</key>
+			<array>
+				<dict>
+					<key>BEHAVIOR</key>
+					<integer>3</integer>
+					<key>DICTIONARY</key>
+					<dict>
+						<key>IC_REQUIREMENT_OS_DISK_TYPE</key>
+						<integer>1</integer>
+						<key>IC_REQUIREMENT_OS_DISTRIBUTION_TYPE</key>
+						<integer>0</integer>
+						<key>IC_REQUIREMENT_OS_MINIMUM_VERSION</key>
+						<integer>101300</integer>
+					</dict>
+					<key>IC_REQUIREMENT_CHECK_TYPE</key>
+					<integer>0</integer>
+					<key>IDENTIFIER</key>
+					<string>fr.whitebox.Packages.requirement.os</string>
+					<key>MESSAGE</key>
+					<array/>
+					<key>NAME</key>
+					<string>Operating System</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+			</array>
+			<key>RESOURCES</key>
+			<array/>
+			<key>ROOT_VOLUME_ONLY</key>
+			<true/>
+		</dict>
+		<key>PROJECT_SETTINGS</key>
+		<dict>
+			<key>ADVANCED_OPTIONS</key>
+			<dict>
+				<key>installer-script.domains:enable_currentUserHome</key>
+				<integer>1</integer>
+			</dict>
+			<key>BUILD_FORMAT</key>
+			<integer>0</integer>
+			<key>BUILD_PATH</key>
+			<dict>
+				<key>PATH</key>
+				<string>../@RELATIVE_BUILD_PATH@</string>
+				<key>PATH_TYPE</key>
+				<integer>1</integer>
+			</dict>
+			<key>EXCLUDED_FILES</key>
+			<array>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.DS_Store</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove .DS_Store files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove ".DS_Store" files created by the Finder.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.pbdevelopment</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove .pbdevelopment files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove ".pbdevelopment" files created by ProjectBuilder or Xcode.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>CVS</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.cvsignore</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.cvspass</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.svn</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.git</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>.gitignore</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove SCM metadata</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove helper files and folders used by the CVS, SVN or Git Source Code Management systems.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>classes.nib</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>designable.db</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>info.nib</string>
+							<key>TYPE</key>
+							<integer>0</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Optimize nib files</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove "classes.nib", "info.nib" and "designable.nib" files within .nib bundles.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>PATTERNS_ARRAY</key>
+					<array>
+						<dict>
+							<key>REGULAR_EXPRESSION</key>
+							<false/>
+							<key>STRING</key>
+							<string>Resources Disabled</string>
+							<key>TYPE</key>
+							<integer>1</integer>
+						</dict>
+					</array>
+					<key>PROTECTED</key>
+					<true/>
+					<key>PROXY_NAME</key>
+					<string>Remove Resources Disabled folders</string>
+					<key>PROXY_TOOLTIP</key>
+					<string>Remove "Resources Disabled" folders.</string>
+					<key>STATE</key>
+					<true/>
+				</dict>
+				<dict>
+					<key>SEPARATOR</key>
+					<true/>
+				</dict>
+			</array>
+			<key>NAME</key>
+			<string>@CMAKE_PROJECT_NAME@</string>
+			<key>PAYLOAD_ONLY</key>
+			<false/>
+			<key>TREAT_MISSING_PRESENTATION_DOCUMENTS_AS_WARNING</key>
+			<false/>
+		</dict>
+	</dict>
+	<key>TYPE</key>
+	<integer>0</integer>
+	<key>VERSION</key>
+	<integer>2</integer>
+</dict>
+</plist>

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/windows Added

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/windows/installer-Windows.iss.in Added

@@ -0,0 +1,64 @@
+#define MyAppName "@CMAKE_PROJECT_NAME@"
+#define MyAppVersion "@CMAKE_PROJECT_VERSION@"
+#define MyAppPublisher "@PLUGIN_AUTHOR@"
+#define MyAppURL "http://www.mywebsite.com"
+
+Setup
+; NOTE: The value of AppId uniquely identifies this application.
+; Do not use the same AppId value in installers for other applications.
+; (To generate a new GUID, click Tools | Generate GUID inside the IDE.)
+AppId={{CD703FE5-1F2C-4837-BD3D-DD840D83C3E3}
+AppName={#MyAppName}
+AppVersion={#MyAppVersion}
+AppPublisher={#MyAppPublisher}
+AppPublisherURL={#MyAppURL}
+AppSupportURL={#MyAppURL}
+AppUpdatesURL={#MyAppURL}
+DefaultDirName={code:GetDirName}
+DefaultGroupName={#MyAppName}
+OutputBaseFilename={#MyAppName}-{#MyAppVersion}-Windows-Installer
+Compression=lzma
+SolidCompression=yes
+DirExistsWarning=no
+
+Languages
+Name: "english"; MessagesFile: "compiler:Default.isl"
+
+Files
+Source: "..\release\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
+Source: "..\LICENSE"; Flags: dontcopy
+; NOTE: Don't use "Flags: ignoreversion" on any shared system files
+
+Icons
+Name: "{group}\{cm:ProgramOnTheWeb,{#MyAppName}}"; Filename: "{#MyAppURL}"
+Name: "{group}\{cm:UninstallProgram,{#MyAppName}}"; Filename: "{uninstallexe}"
+
+Code
+procedure InitializeWizard();
+var
+  GPLText: AnsiString;
+  Page: TOutputMsgMemoWizardPage;
+begin
+  ExtractTemporaryFile('LICENSE');
+  LoadStringFromFile(ExpandConstant('{tmp}\LICENSE'), GPLText);
+  Page := CreateOutputMsgMemoPage(wpWelcome,
+    'License Information', 'Please review the license terms before installing {#MyAppName}',
+    'Press Page Down to see the rest of the agreement. Once you are aware of your rights, click Next to continue.',
+    String(GPLText)
+  );
+end;
+
+// credit where it's due :
+// following function come from https://github.com/Xaymar/obs-studio_amf-encoder-plugin/blob/master/%23Resources/Installer.in.iss#L45
+function GetDirName(Value: string): string;
+var
+  InstallPath: string;
+begin
+  // initialize default path, which will be returned when the following registry
+  // key queries fail due to missing keys or for some different reason
+  Result := '{autopf}\obs-studio';
+  // query the first registry value; if this succeeds, return the obtained value
+  if RegQueryStringValue(HKLM32, 'SOFTWARE\OBS Studio', '', InstallPath) then
+    Result := InstallPath
+end;
+

obs-backgroundremoval-0.5.0.tar.xz/cmake/bundle/windows/resource.rc.in Added

obs-backgroundremoval-0.5.0.tar.xz/data/models Added

obs-backgroundremoval-0.5.0.tar.xz/data/models/SINet_Softmax_simple.onnx Changed

obs-backgroundremoval-0.5.0.tar.xz/data/models/mediapipe.onnx Changed

obs-backgroundremoval-0.5.0.tar.xz/data/models/modnet_simple.onnx Changed

obs-backgroundremoval-0.5.0.tar.xz/data/models/rvm_mobilenetv3_fp32.onnx Changed

obs-backgroundremoval-0.5.0.tar.xz/data/models/selfie_segmentation.onnx Changed

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/scripts/makeOnnxruntime_osx.sh -> obs-backgroundremoval-0.5.0.tar.xz/scripts/makeOnnxruntime_osx.sh Changed

@@ -1,20 +1,91 @@
 #!/bin/bash
 
-WORK_DIR=$(git rev-parse --show-toplevel)/build
+set -eax
+
+# get script directory
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE0}" )" &> /dev/null && pwd )"
+WORK_DIR="${SCRIPT_DIR}/../build"
 CURRENT_DIR=$(pwd)
 OUTPUT_DIR=$WORK_DIR/onnxruntime
 
-if  -d $OUTPUT_DIR ; then
-    rm -rf $OUTPUT_DIR
+function verify_onnxruntime_exists() {
+    # check that onnxruntime libraries and include files exist
+    if  ! -d $OUTPUT_DIR ; then
+        echo "onnxruntime not found in $OUTPUT_DIR"
+        return 1
+    fi
+    if  ! -d $OUTPUT_DIR/include ; then
+        echo "onnxruntime include files not found in $OUTPUT_DIR/include"
+        return 1
+    fi
+    if  ! -d $OUTPUT_DIR/lib ; then
+        echo "onnxruntime libraries not found in $OUTPUT_DIR/lib"
+        return 1
+    fi
+    if  ! -f $OUTPUT_DIR/lib/libonnx.a ; then
+        echo "onnxruntime library not found in $OUTPUT_DIR/lib/libonnx.a"
+        return 1
+    fi
+    if  ! -f $OUTPUT_DIR/include/onnxruntime/core/session/onnxruntime_c_api.h ; then
+        echo "onnxruntime includes not found in $OUTPUT_DIR/include/onnxruntime/core/session/onnxruntime_c_api.h"
+        return 1
+    fi
+    echo "onnxruntime found in $OUTPUT_DIR"
+    return 0
+}
+
+# check if onnxruntime is already built using verify_onnxruntime_exists
+if verify_onnxruntime_exists; then
+    echo "onnxruntime already built"
+    exit 0
+fi
+
+# try to download onnxruntime from s3 if not already downloaded, use wget if available
+# https://obs-backgroundremoval-build.s3.amazonaws.com/onnxruntime-1.14.0-x86_64.tar.gz
+if  ! $( which wget ) ; then
+    echo "wget is not available, please install it e.g. `$ brew install wget`"
+    exit 1
 fi
 
 if  ! -d $WORK_DIR ; then
+    echo "creating work directory $WORK_DIR"
     mkdir -p $WORK_DIR
 fi
 
+ONNXRT_TAR_FILENAME="onnxruntime-1.14.0-x86_64.tar.gz"
+ONNXRT_TAR_LOCATION="${WORK_DIR}/${ONNXRT_TAR_FILENAME}"
+if  ! -f $ONNXRT_TAR_LOCATION ; then
+    echo "onnxruntime tar file not found in $ONNXRT_TAR_LOCATION, downloading from s3"
+    wget -q -O $ONNXRT_TAR_LOCATION https://obs-backgroundremoval-build.s3.amazonaws.com/$ONNXRT_TAR_FILENAME
+fi
+if  ! -f $ONNXRT_TAR_LOCATION ; then
+    echo "onnxruntime tar file not found in $ONNXRT_TAR_LOCATION"
+    exit 1
+fi
+echo "onnxruntime tar file found in $ONNXRT_TAR_LOCATION"
+
+cd "${WORK_DIR}/.."
+echo "extracting onnxruntime tar file"
+tar -xzf $ONNXRT_TAR_LOCATION
+rm $ONNXRT_TAR_LOCATION
+cd $CURRENT_DIR
+
+# verify onnxruntime exists
+if verify_onnxruntime_exists; then
+    echo "onnxruntime successfully downloaded and extracted"
+    exit 0
+fi
+
+# build onnxruntime from source
+echo "building onnxruntime from source"
+
+if  -d $OUTPUT_DIR ; then
+    rm -rf $OUTPUT_DIR
+fi
+
 cd $WORK_DIR
 
-ONNXRT_VER=1.7.2
+ONNXRT_VER=1.14.0
 ONNXRT_DIR=$WORK_DIR/onnxruntime-$ONNXRT_VER
 
 if  ! -d $ONNXRT_DIR ; then

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/scripts/makeOpenCV_osx.sh -> obs-backgroundremoval-0.5.0.tar.xz/scripts/makeOpenCV_osx.sh Changed

@@ -1,17 +1,88 @@
 #!/bin/bash
 
-WORK_DIR=$(git rev-parse --show-toplevel)/build
+set -e
+
+SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE0}" )" &> /dev/null && pwd )"
+WORK_DIR="${SCRIPT_DIR}/../build"
 CURRENT_DIR=$(pwd)
 OUTPUT_DIR=$WORK_DIR/opencv
 
-if  -d $OUTPUT_DIR ; then
-    rm -rf $OUTPUT_DIR
+function verify_opencv_exists() {
+    # check that opencv libraries and include files exist
+    if  ! -d $OUTPUT_DIR ; then
+        echo "opencv not found in $OUTPUT_DIR"
+        return 1
+    fi
+    if  ! -d $OUTPUT_DIR/include ; then
+        echo "opencv include files not found in $OUTPUT_DIR/include"
+        return 1
+    fi
+    if  ! -d $OUTPUT_DIR/lib ; then
+        echo "opencv libraries not found in $OUTPUT_DIR/lib"
+        return 1
+    fi
+    if  ! -f $OUTPUT_DIR/lib/libopencv_core.a ; then
+        echo "opencv core library not found in $OUTPUT_DIR/lib/libopencv_core.a"
+        return 1
+    fi
+    if  ! -f $OUTPUT_DIR/lib/libopencv_imgproc.a ; then
+        echo "opencv imgproc library not found in $OUTPUT_DIR/lib/libopencv_imgproc.a"
+        return 1
+    fi
+    if  ! -f $OUTPUT_DIR/include/opencv4/opencv2/opencv.hpp ; then
+        echo "opencv includes not found in $OUTPUT_DIR/include/opencv4/opencv2/opencv.hpp"
+        return 1
+    fi
+    echo "opencv found in $OUTPUT_DIR"
+    return 0
+}
+
+# check if opencv is already built using verify_opencv_exists
+if verify_opencv_exists; then
+    echo "opencv already built"
+    exit 0
+fi
+
+# try to download opencv from s3 if not already downloaded, use wget if available
+echo "downloading opencv from s3"
+if  ! $( which wget ) ; then
+    echo "wget is not available, please install it e.g. `$ brew install wget`"
+    exit 1
 fi
 
 if  ! -d $WORK_DIR ; then
+    echo "creating work directory $WORK_DIR"
     mkdir -p $WORK_DIR
 fi
 
+OPENCV_TAR_FILENAME="opencv-4.5.2-x86_64.tar.gz"
+OPENCV_TAR_LOCATION="${WORK_DIR}/${OPENCV_TAR_FILENAME}"
+wget -q https://obs-backgroundremoval-build.s3.amazonaws.com/opencv-4.5.2-x86_64.tar.gz -O ${OPENCV_TAR_LOCATION}
+
+if  ! -f $OPENCV_TAR_LOCATION ; then
+    echo "failed to download opencv from s3"
+    exit 1
+fi
+
+# extract opencv if downloaded
+echo "extracting opencv"
+cd "${SCRIPT_DIR}/../"
+tar xzf ${OPENCV_TAR_LOCATION}
+rm ${OPENCV_TAR_LOCATION}
+cd "${CURRENT_DIR}"
+
+if verify_opencv_exists; then
+    echo "opencv successfully downloaded from s3"
+    exit 0
+fi
+
+# build opencv from source
+echo "building opencv from source"
+
+if  -d $OUTPUT_DIR ; then
+    rm -rf $OUTPUT_DIR
+fi
+
 cd $WORK_DIR
 
 # download opencv if not already downloaded

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/src/Model.h -> obs-backgroundremoval-0.5.0.tar.xz/src/Model.h Changed

@@ -2,8 +2,8 @@
 #define MODEL_H
 
 #if defined(__APPLE__)
-#include <onnxruntime/core/session/onnxruntime_cxx_api.h>
-#include <onnxruntime/core/providers/cpu/cpu_provider_factory.h>
+#include <core/session/onnxruntime_cxx_api.h>
+#include <core/providers/cpu/cpu_provider_factory.h>
 #else
 #include <onnxruntime_cxx_api.h>
 #include <cpu_provider_factory.h>
@@ -19,14 +19,13 @@
 #include <wchar.h>
 #endif
 
-template <typename T>
-T vectorProduct(const std::vector<T>& v)
+template<typename T> T vectorProduct(const std::vector<T> &v)
 {
 return accumulate(v.begin(), v.end(), (T)1, std::multiplies<T>());
 }
 
-
-static void hwc_to_chw(cv::InputArray src, cv::OutputArray dst) {
+static void hwc_to_chw(cv::InputArray src, cv::OutputArray dst)
+{
 std::vector<cv::Mat> channels;
 cv::split(src, channels);
 
@@ -36,27 +35,30 @@
 }
 
 // Concatenate three vectors to one
- cv::hconcat( channels, dst );
+ cv::hconcat(channels, dst);
 }
 
-
-class Model
-{
-private:
+/**
+ * @brief Base class for all models
+ *
+*/
+class Model {
+ private:
 /* data */
-public:
- Model(/* args */) {};
- ~Model() {};
+ public:
+ Model(/* args */){};
+ virtual ~Model(){};
 
- const char* name;
+ const char *name;
 
 #if _WIN32
 const std::wstring
 #else
 const std::string
 #endif
- getModelFilepath(const std::string& modelSelection) {
- char* modelFilepath_rawPtr = obs_module_file(modelSelection.c_str());
+ getModelFilepath(const std::string &modelSelection)
+ {
+ char *modelFilepath_rawPtr = obs_module_file(modelSelection.c_str());
 
 if (modelFilepath_rawPtr == nullptr) {
 blog(LOG_ERROR, "Unable to get model filename %s from plugin.", modelSelection.c_str());
@@ -71,30 +73,26 @@
 std::copy(modelFilepath_s.begin(), modelFilepath_s.end(), modelFilepath_ws.begin());
 return modelFilepath_ws;
 #else
-	 return modelFilepath_s;
+ return modelFilepath_s;
 #endif
 }
 
-
- virtual void populateInputOutputNames(
- const std::unique_ptr<Ort::Session>& session,
- std::vector<const char*>& inputNames,
-	 std::vector<const char*>& outputNames
- ) {
+ virtual void populateInputOutputNames(const std::unique_ptr<Ort::Session> &session,
+ std::vector<std::string> &inputNames,
+ std::vector<std::string> &outputNames)
+ {
 Ort::AllocatorWithDefaultOptions allocator;
 
 inputNames.clear();
 outputNames.clear();
-	 inputNames.push_back(session->GetInputName(0, allocator));
- 	outputNames.push_back(session->GetOutputName(0, allocator));
+ inputNames.push_back(session->GetInputNameAllocated(0, allocator).get());
+ outputNames.push_back(session->GetOutputNameAllocated(0, allocator).get());
 }
 
-
- virtual bool populateInputOutputShapes(
- const std::unique_ptr<Ort::Session>& session,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<int64_t> >& outputDims
- ) {
+ virtual bool populateInputOutputShapes(const std::unique_ptr<Ort::Session> &session,
+ std::vector<std::vector<int64_t>> &inputDims,
+ std::vector<std::vector<int64_t>> &outputDims)
+ {
 // Assuming model only has one input and one output image
 
 inputDims.clear();
@@ -115,21 +113,20 @@
 
 if (inputDims0.size() < 3 || outputDims0.size() < 3) {
 blog(LOG_ERROR, "Input or output tensor dims are < 3. input = %d, output = %d",
- (int)inputDims.size(), (int)outputDims.size());
+ (int)inputDims.size(), (int)outputDims.size());
 return false;
 }
 
 return true;
 }
 
- virtual void allocateTensorBuffers(
- const std::vector<std::vector<int64_t> >& inputDims,
- const std::vector<std::vector<int64_t> >& outputDims,
- std::vector<std::vector<float> >& outputTensorValues,
- 	std::vector<std::vector<float> >& inputTensorValues,
- std::vector<Ort::Value>& inputTensor,
- std::vector<Ort::Value>& outputTensor
- ) {
+ virtual void allocateTensorBuffers(const std::vector<std::vector<int64_t>> &inputDims,
+ const std::vector<std::vector<int64_t>> &outputDims,
+ std::vector<std::vector<float>> &outputTensorValues,
+ std::vector<std::vector<float>> &inputTensorValues,
+ std::vector<Ort::Value> &inputTensor,
+ std::vector<Ort::Value> &outputTensor)
+ {
 // Assuming model only has one input and one output images
 
 outputTensorValues.clear();
@@ -138,62 +135,54 @@
 inputTensorValues.clear();
 inputTensor.clear();
 
- Ort::MemoryInfo memoryInfo = Ort::MemoryInfo::CreateCpu(
- OrtAllocatorType::OrtDeviceAllocator, OrtMemType::OrtMemTypeDefault);
+ Ort::MemoryInfo memoryInfo = Ort::MemoryInfo::CreateCpu(OrtAllocatorType::OrtDeviceAllocator,
+ OrtMemType::OrtMemTypeDefault);
 
 // Allocate buffers and build input and output tensors
 
 for (size_t i = 0; i < inputDims.size(); i++) {
 inputTensorValues.push_back(std::vector<float>(vectorProduct(inputDimsi), 0.0f));
- blog(LOG_INFO, "Allocated %d sized float-array for input %d", (int)inputTensorValuesi.size(), (int)i);
+ blog(LOG_INFO, "Allocated %d sized float-array for input %d",
+ (int)inputTensorValuesi.size(), (int)i);
 inputTensor.push_back(Ort::Value::CreateTensor<float>(
- memoryInfo,
- inputTensorValuesi.data(),
- inputTensorValuesi.size(),
- inputDimsi.data(),
+ memoryInfo, inputTensorValuesi.data(), inputTensorValuesi.size(), inputDimsi.data(),
 inputDimsi.size()));
 }
 
 for (size_t i = 0; i < outputDims.size(); i++) {
 outputTensorValues.push_back(std::vector<float>(vectorProduct(outputDimsi), 0.0f));
- blog(LOG_INFO, "Allocated %d sized float-array for output %d", (int)outputTensorValuesi.size(), (int)i);
+ blog(LOG_INFO, "Allocated %d sized float-array for output %d",
+ (int)outputTensorValuesi.size(), (int)i);
 outputTensor.push_back(Ort::Value::CreateTensor<float>(
- memoryInfo,
- outputTensorValuesi.data(),
- outputTensorValuesi.size(),
- outputDimsi.data(),
- outputDimsi.size()));
+ memoryInfo, outputTensorValuesi.data(), outputTensorValuesi.size(),
+ outputDimsi.data(), outputDimsi.size()));
 }
 }
 
- virtual void getNetworkInputSize(
- const std::vector<std::vector<int64_t> >& inputDims,
- uint32_t& inputWidth, uint32_t& inputHeight
- ) {
+ virtual void getNetworkInputSize(const std::vector<std::vector<int64_t>> &inputDims,
+ uint32_t &inputWidth, uint32_t &inputHeight)
+ {
 // BHWC
- inputWidth = (int)inputDims02;
+ inputWidth = (int)inputDims02;
 inputHeight = (int)inputDims01;
 }
 
- virtual void prepareInputToNetwork(cv::Mat& resizedImage, cv::Mat& preprocessedImage) {
+ virtual void prepareInputToNetwork(cv::Mat &resizedImage, cv::Mat &preprocessedImage)
+ {
 preprocessedImage = resizedImage / 255.0;
 }
 
- virtual void loadInputToTensor(
- const cv::Mat& preprocessedImage,
- uint32_t inputWidth,
- uint32_t inputHeight,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
- preprocessedImage.copyTo(cv::Mat(inputHeight, inputWidth, CV_32FC3, &(inputTensorValues00)));
+ virtual void loadInputToTensor(const cv::Mat &preprocessedImage, uint32_t inputWidth,
+ uint32_t inputHeight,
+ std::vector<std::vector<float>> &inputTensorValues)
+ {
+ preprocessedImage.copyTo(
+ cv::Mat(inputHeight, inputWidth, CV_32FC3, &(inputTensorValues00)));
 }
 
- virtual cv::Mat getNetworkOutput(
- const std::vector<std::vector<int64_t> >& outputDims,
- std::vector<std::vector<float> >& outputTensorValues,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
+ virtual cv::Mat getNetworkOutput(const std::vector<std::vector<int64_t>> &outputDims,
+ std::vector<std::vector<float>> &outputTensorValues)
+ {
 // BHWC
 uint32_t outputWidth = (int)outputDims0.at(2);
 uint32_t outputHeight = (int)outputDims0.at(1);
@@ -202,59 +191,67 @@
 return cv::Mat(outputHeight, outputWidth, outputChannels, outputTensorValues0.data());
 }
 
- virtual void postprocessOutput(cv::Mat& outputImage) {}
+ virtual void assignOutputToInput(std::vector<std::vector<float>> &,
+ std::vector<std::vector<float>> &)
+ {
+ }
+
+ virtual void postprocessOutput(cv::Mat &) {}
 
- virtual void runNetworkInference(
- const std::unique_ptr<Ort::Session>& session,
- const std::vector<const char*>& inputNames,
-	 const std::vector<const char*>& outputNames,
- const std::vector<Ort::Value>& inputTensor,
- std::vector<Ort::Value>& outputTensor
- ) {
- if (inputNames.size() == 0 || outputNames.size() == 0 || inputTensor.size() == 0 || outputTensor.size() == 0) {
+ virtual void runNetworkInference(const std::unique_ptr<Ort::Session> &session,
+ const std::vector<std::string> &inputNames,
+ const std::vector<std::string> &outputNames,
+ const std::vector<Ort::Value> &inputTensor,
+ std::vector<Ort::Value> &outputTensor)
+ {
+ if (inputNames.size() == 0 || outputNames.size() == 0 || inputTensor.size() == 0 ||
+ outputTensor.size() == 0) {
 blog(LOG_INFO, "Skip network inference. Inputs or outputs are null.");
 return;
 }
 
- session->Run(
- Ort::RunOptions{nullptr},
- // inputNames.data(), &(inputTensor0), 1,
- // outputNames.data(), &(outputTensor0), 1
- inputNames.data(), inputTensor.data(), inputNames.size(),
- outputNames.data(), outputTensor.data(), outputNames.size()
- );
+ // convert inputNames to array of char*
+ std::vector<const char *> inputNamesChar;
+ for (size_t i = 0; i < inputNames.size(); i++) {
+ inputNamesChar.push_back(inputNamesi.c_str());
+ }
+ // convert outputNames to array of char*
+ std::vector<const char *> outputNamesChar;
+ for (size_t i = 0; i < outputNames.size(); i++) {
+ outputNamesChar.push_back(outputNamesi.c_str());
+ }
+
+ session->Run(Ort::RunOptions{nullptr},
+ // inputNames.data(), &(inputTensor0), 1,
+ // outputNames.data(), &(outputTensor0), 1
+ inputNamesChar.data(), inputTensor.data(), inputNamesChar.size(),
+ outputNamesChar.data(), outputTensor.data(), outputNamesChar.size());
 }
 };
 
-
-class ModelSelfie : public Model
-{
-private:
+class ModelSelfie : public Model {
+ private:
 /* data */
-public:
+ public:
 ModelSelfie(/* args */) {}
 ~ModelSelfie() {}
 
- virtual void postprocessOutput(cv::Mat& outputImage) {
+ virtual void postprocessOutput(cv::Mat &outputImage)
+ {
 cv::normalize(outputImage, outputImage, 1.0, 0.0, cv::NORM_MINMAX);
 }
 };
 
-
-class ModelMediaPipe : public Model
-{
-private:
+class ModelMediaPipe : public Model {
+ private:
 /* data */
-public:
+ public:
 ModelMediaPipe(/* args */) {}
 ~ModelMediaPipe() {}
 
- virtual cv::Mat getNetworkOutput(
- const std::vector<std::vector<int64_t> >& outputDims,
- std::vector<std::vector<float> >& outputTensorValues,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
+ virtual cv::Mat getNetworkOutput(const std::vector<std::vector<int64_t>> &outputDims,
+ std::vector<std::vector<float>> &outputTensorValues)
+ {
 uint32_t outputWidth = (int)outputDims0.at(2);
 uint32_t outputHeight = (int)outputDims0.at(1);
 int32_t outputChannels = CV_32FC2;
@@ -262,7 +259,8 @@
 return cv::Mat(outputHeight, outputWidth, outputChannels, outputTensorValues0.data());
 }
 
- virtual void postprocessOutput(cv::Mat& outputImage) {
+ virtual void postprocessOutput(cv::Mat &outputImage)
+ {
 // take 1st channel
 std::vector<cv::Mat> outputImageSplit;
 cv::split(outputImage, outputImageSplit);
@@ -277,28 +275,22 @@
 }
 };
 
-
-class ModelBCHW : public Model
-{
-public:
+class ModelBCHW : public Model {
+ public:
 ModelBCHW(/* args */) {}
 ~ModelBCHW() {}
 
- virtual void getNetworkInputSize(
- const std::vector<std::vector<int64_t> >& inputDims,
- uint32_t& inputWidth, uint32_t& inputHeight
- ) {
+ virtual void getNetworkInputSize(const std::vector<std::vector<int64_t>> &inputDims,
+ uint32_t &inputWidth, uint32_t &inputHeight)
+ {
 // BCHW
- inputWidth = (int)inputDims03;
+ inputWidth = (int)inputDims03;
 inputHeight = (int)inputDims02;
 }
 
- virtual cv::Mat getNetworkOutput(
- const std::vector<std::vector<int64_t> >& outputDims,
- std::vector<std::vector<float> >& outputTensorValues,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
+ virtual cv::Mat getNetworkOutput(const std::vector<std::vector<int64_t>> &outputDims,
+ std::vector<std::vector<float>> &outputTensorValues)
+ {
 // BCHW
 uint32_t outputWidth = (int)outputDims0.at(3);
 uint32_t outputHeight = (int)outputDims0.at(2);
@@ -307,83 +299,74 @@
 return cv::Mat(outputHeight, outputWidth, outputChannels, outputTensorValues0.data());
 }
 
- virtual void loadInputToTensor(
- const cv::Mat& preprocessedImage,
- uint32_t inputWidth,
- uint32_t inputHeight,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
- inputTensorValues0.assign(
- preprocessedImage.begin<float>(),
- preprocessedImage.end<float>()
- );
+ virtual void loadInputToTensor(const cv::Mat &preprocessedImage, uint32_t, uint32_t,
+ std::vector<std::vector<float>> &inputTensorValues)
+ {
+ inputTensorValues0.assign(preprocessedImage.begin<float>(), preprocessedImage.end<float>());
 }
 };
 
-
-class ModelSINET : public ModelBCHW
-{
-public:
+class ModelSINET : public ModelBCHW {
+ public:
 ModelSINET(/* args */) {}
 ~ModelSINET() {}
 
- virtual void prepareInputToNetwork(cv::Mat& resizedImage, cv::Mat& preprocessedImage) {
+ virtual void prepareInputToNetwork(cv::Mat &resizedImage, cv::Mat &preprocessedImage)
+ {
 cv::subtract(resizedImage, cv::Scalar(102.890434, 111.25247, 126.91212), resizedImage);
- cv::multiply(resizedImage, cv::Scalar(1.0 / 62.93292, 1.0 / 62.82138, 1.0 / 66.355705) / 255.0, resizedImage);
+ cv::multiply(resizedImage, cv::Scalar(1.0 / 62.93292, 1.0 / 62.82138, 1.0 / 66.355705) / 255.0,
+ resizedImage);
 hwc_to_chw(resizedImage, preprocessedImage);
 }
 };
 
-
-class ModelMODNET : public ModelBCHW
-{
-public:
+class ModelMODNET : public ModelBCHW {
+ public:
 ModelMODNET(/* args */) {}
 ~ModelMODNET() {}
 
- virtual void prepareInputToNetwork(cv::Mat& resizedImage, cv::Mat& preprocessedImage) {
+ virtual void prepareInputToNetwork(cv::Mat &resizedImage, cv::Mat &preprocessedImage)
+ {
 cv::subtract(resizedImage, cv::Scalar::all(127.5), resizedImage);
 resizedImage = resizedImage / 127.5;
 hwc_to_chw(resizedImage, preprocessedImage);
 }
 };
 
-class ModelRVM : public ModelBCHW
-{
-private:
+class ModelRVM : public ModelBCHW {
+ private:
 /* data */
-public:
+ public:
 ModelRVM(/* args */) {}
 ~ModelRVM() {}
 
- virtual void prepareInputToNetwork(cv::Mat& resizedImage, cv::Mat& preprocessedImage) {
+ virtual void prepareInputToNetwork(cv::Mat &resizedImage, cv::Mat &preprocessedImage)
+ {
 resizedImage = resizedImage / 256.0;
 hwc_to_chw(resizedImage, preprocessedImage);
 }
 
- virtual void populateInputOutputNames(
- const std::unique_ptr<Ort::Session>& session,
- std::vector<const char*>& inputNames,
-	 std::vector<const char*>& outputNames
- ) {
+ virtual void populateInputOutputNames(const std::unique_ptr<Ort::Session> &session,
+ std::vector<std::string> &inputNames,
+ std::vector<std::string> &outputNames)
+ {
 Ort::AllocatorWithDefaultOptions allocator;
 
 inputNames.clear();
 outputNames.clear();
 
 for (size_t i = 0; i < session->GetInputCount(); i++) {
- 	 inputNames.push_back(session->GetInputName(i, allocator));
+ inputNames.push_back(session->GetInputNameAllocated(i, allocator).get());
 }
 for (size_t i = 1; i < session->GetOutputCount(); i++) {
- 	 outputNames.push_back(session->GetOutputName(i, allocator));
+ outputNames.push_back(session->GetOutputNameAllocated(i, allocator).get());
 }
 }
 
- virtual bool populateInputOutputShapes(
- const std::unique_ptr<Ort::Session>& session,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<int64_t> >& outputDims
- ) {
+ virtual bool populateInputOutputShapes(const std::unique_ptr<Ort::Session> &session,
+ std::vector<std::vector<int64_t>> &inputDims,
+ std::vector<std::vector<int64_t>> &outputDims)
+ {
 // Assuming model only has one input and one output image
 
 inputDims.clear();
@@ -422,37 +405,32 @@
 outputDimsi3 = 192 / std::pow(2, i);
 }
 return true;
-	}
-
- virtual void loadInputToTensor(
- const cv::Mat& preprocessedImage,
- uint32_t inputWidth,
- uint32_t inputHeight,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
- inputTensorValues0.assign(
- preprocessedImage.begin<float>(),
- preprocessedImage.end<float>()
- );
+ }
+
+ virtual void loadInputToTensor(const cv::Mat &preprocessedImage, uint32_t, uint32_t,
+ std::vector<std::vector<float>> &inputTensorValues)
+ {
+ inputTensorValues0.assign(preprocessedImage.begin<float>(), preprocessedImage.end<float>());
 inputTensorValues50 = 1.0f;
 }
 
- virtual cv::Mat getNetworkOutput(
- const std::vector<std::vector<int64_t> >& outputDims,
- std::vector<std::vector<float> >& outputTensorValues,
- std::vector<std::vector<int64_t> >& inputDims,
- std::vector<std::vector<float> >& inputTensorValues
- ) {
+ virtual cv::Mat getNetworkOutput(const std::vector<std::vector<int64_t>> &outputDims,
+ std::vector<std::vector<float>> &outputTensorValues)
+ {
 // BCHW
 uint32_t outputWidth = (int)outputDims0.at(3);
 uint32_t outputHeight = (int)outputDims0.at(2);
 int32_t outputChannels = CV_32FC1;
 
+ return cv::Mat(outputHeight, outputWidth, outputChannels, outputTensorValues0.data());
+ }
+
+ virtual void assignOutputToInput(std::vector<std::vector<float>> &outputTensorValues,
+ std::vector<std::vector<float>> &inputTensorValues)
+ {
 for (size_t i = 1; i < 5; i++) {
 inputTensorValuesi.assign(outputTensorValuesi.begin(), outputTensorValuesi.end());
 }
-
- return cv::Mat(outputHeight, outputWidth, outputChannels, outputTensorValues0.data());
 }
 };

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/src/background-filter.cpp -> obs-backgroundremoval-0.5.0.tar.xz/src/background-filter.cpp Changed

@@ -2,21 +2,23 @@
 #include <media-io/video-scaler.h>
 
 #if defined(__APPLE__)
-#include <onnxruntime/core/session/onnxruntime_cxx_api.h>
-#include <onnxruntime/core/providers/cpu/cpu_provider_factory.h>
-#else
+#include <core/session/onnxruntime_cxx_api.h>
+#include <core/providers/cpu/cpu_provider_factory.h>
+#else // __APPLE__
 #include <onnxruntime_cxx_api.h>
 #include <cpu_provider_factory.h>
 #endif
+
 #ifdef WITH_CUDA
 #include <cuda_provider_factory.h>
 #endif
+
 #ifdef _WIN32
 #ifndef WITH_CUDA
 #include <dml_provider_factory.h>
 #endif
 #include <wchar.h>
-#endif
+#endif // _WIN32
 
 #include <opencv2/imgproc.hpp>
 
@@ -28,200 +30,165 @@
 #include "plugin-macros.generated.h"
 #include "Model.h"
 
+const char *MODEL_SINET = "models/SINet_Softmax_simple.onnx";
+const char *MODEL_MODNET = "models/modnet_simple.onnx";
+const char *MODEL_MEDIAPIPE = "models/mediapipe.onnx";
+const char *MODEL_SELFIE = "models/selfie_segmentation.onnx";
+const char *MODEL_RVM = "models/rvm_mobilenetv3_fp32.onnx";
 
-const char* MODEL_SINET = "SINet_Softmax_simple.onnx";
-const char* MODEL_MODNET = "modnet_simple.onnx";
-const char* MODEL_MEDIAPIPE = "mediapipe.onnx";
-const char* MODEL_SELFIE = "selfie_segmentation.onnx";
-const char* MODEL_RVM = "rvm_mobilenetv3_fp32.onnx";
-
-const char* USEGPU_CPU = "cpu";
-const char* USEGPU_DML = "dml";
-const char* USEGPU_CUDA = "cuda";
+const char *USEGPU_CPU = "cpu";
+const char *USEGPU_DML = "dml";
+const char *USEGPU_CUDA = "cuda";
 
 struct background_removal_filter {
-	std::unique_ptr<Ort::Session> session;
-	std::unique_ptr<Ort::Env> env;
-	std::vector<const char*> inputNames;
-	std::vector<const char*> outputNames;
-	std::vector<Ort::Value> inputTensor;
-	std::vector<Ort::Value> outputTensor;
-	std::vector<std::vector<int64_t> > inputDims;
-	std::vector<std::vector<int64_t> > outputDims;
-	std::vector<std::vector<float> > outputTensorValues;
-	std::vector<std::vector<float> > inputTensorValues;
-	Ort::MemoryInfo memoryInfo;
-	float threshold = 0.5f;
-	cv::Scalar backgroundColor{0, 0, 0};
-	float contourFilter = 0.05f;
-	float smoothContour = 0.5f;
-	float feather = 0.0f;
-	std::string useGPU;
-	std::string modelSelection;
-	std::unique_ptr<Model> model;
-
-	// Use the media-io converter to both scale and convert the colorspace
-	video_scaler_t* scalerToBGR;
-	video_scaler_t* scalerFromBGR;
-
-	cv::Mat backgroundMask;
-	int maskEveryXFrames = 1;
-	int maskEveryXFramesCount = 0;
-
+ std::unique_ptr<Ort::Session> session;
+ std::unique_ptr<Ort::Env> env;
+ std::vector<std::string> inputNames;
+ std::vector<std::string> outputNames;
+ std::vector<Ort::Value> inputTensor;
+ std::vector<Ort::Value> outputTensor;
+ std::vector<std::vector<int64_t>> inputDims;
+ std::vector<std::vector<int64_t>> outputDims;
+ std::vector<std::vector<float>> outputTensorValues;
+ std::vector<std::vector<float>> inputTensorValues;
+ Ort::MemoryInfo memoryInfo;
+ float threshold = 0.5f;
+ cv::Scalar backgroundColor{0, 0, 0};
+ float contourFilter = 0.05f;
+ float smoothContour = 0.5f;
+ float feather = 0.0f;
+ std::string useGPU;
+ std::string modelSelection;
+ std::unique_ptr<Model> model;
+
+ // Use the media-io converter to both scale and convert the colorspace
+ video_scaler_t *scalerToBGR;
+ video_scaler_t *scalerFromBGR;
+
+ cv::Mat backgroundMask;
+ int maskEveryXFrames = 1;
+ int maskEveryXFramesCount = 0;
 
 #if _WIN32
-	const wchar_t* modelFilepath = nullptr;
+ const wchar_t *modelFilepath = nullptr;
 #else
-	const char* modelFilepath = nullptr;
+ const char *modelFilepath = nullptr;
 #endif
 };
 
-
 static const char *filter_getname(void *unused)
 {
-	UNUSED_PARAMETER(unused);
-	return "Background Removal";
+ UNUSED_PARAMETER(unused);
+ return "Background Removal";
 }
 
-
 /** PROPERTIES */
 
 static obs_properties_t *filter_properties(void *data)
 {
-	obs_properties_t *props = obs_properties_create();
-
-	obs_property_t *p_threshold = obs_properties_add_float_slider(
-		props,
-		"threshold",
-		obs_module_text("Threshold"),
-		0.0,
-		1.0,
-		0.025);
-
-	obs_property_t *p_contour_filter = obs_properties_add_float_slider(
-		props,
-		"contour_filter",
-		obs_module_text("Contour Filter (% of image)"),
-		0.0,
-		1.0,
-		0.025);
-
-	obs_property_t *p_smooth_contour = obs_properties_add_float_slider(
-		props,
-		"smooth_contour",
-		obs_module_text("Smooth silhouette"),
-		0.0,
-		1.0,
-		0.05);
-
-	obs_property_t *p_feather = obs_properties_add_float_slider(
-		props,
-		"feather",
-		obs_module_text("Feather blend silhouette"),
-		0.0,
-		1.0,
-		0.05);
-
-	obs_property_t *p_color = obs_properties_add_color(
-		props,
-		"replaceColor",
-		obs_module_text("Background Color"));
-
-	obs_property_t *p_use_gpu = obs_properties_add_list(
-		props,
-		"useGPU",
-		obs_module_text("Inference device"),
-		OBS_COMBO_TYPE_LIST,
-		OBS_COMBO_FORMAT_STRING);
-
-	obs_property_list_add_string(p_use_gpu, obs_module_text("CPU"), USEGPU_CPU);
+ obs_properties_t *props = obs_properties_create();
+
+ obs_properties_add_float_slider(props, "threshold", obs_module_text("Threshold"), 0.0, 1.0,
+ 0.025);
+
+ obs_properties_add_float_slider(props, "contour_filter",
+ obs_module_text("Contour Filter (% of image)"), 0.0, 1.0, 0.025);
+
+ obs_properties_add_float_slider(props, "smooth_contour", obs_module_text("Smooth silhouette"),
+ 0.0, 1.0, 0.05);
+
+ obs_properties_add_float_slider(props, "feather", obs_module_text("Feather blend silhouette"),
+ 0.0, 1.0, 0.05);
+
+ obs_properties_add_color(props, "replaceColor", obs_module_text("Background Color"));
+
+ obs_property_t *p_use_gpu = obs_properties_add_list(props, "useGPU",
+ obs_module_text("Inference device"),
+ OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
+
+ obs_property_list_add_string(p_use_gpu, obs_module_text("CPU"), USEGPU_CPU);
 #ifdef WITH_CUDA
-	obs_property_list_add_string(p_use_gpu, obs_module_text("GPU - CUDA"), USEGPU_CUDA);
+ obs_property_list_add_string(p_use_gpu, obs_module_text("GPU - CUDA"), USEGPU_CUDA);
 #elif _WIN32
-	obs_property_list_add_string(p_use_gpu, obs_module_text("GPU - DirectML"), USEGPU_DML);
+ obs_property_list_add_string(p_use_gpu, obs_module_text("GPU - DirectML"), USEGPU_DML);
 #endif
 
-	obs_property_t *p_model_select = obs_properties_add_list(
-		props,
-		"model_select",
-		obs_module_text("Segmentation model"),
-		OBS_COMBO_TYPE_LIST,
-		OBS_COMBO_FORMAT_STRING);
-
-	obs_property_list_add_string(p_model_select, obs_module_text("SINet"), MODEL_SINET);
-	obs_property_list_add_string(p_model_select, obs_module_text("MODNet"), MODEL_MODNET);
-	obs_property_list_add_string(p_model_select, obs_module_text("MediaPipe"), MODEL_MEDIAPIPE);
-	obs_property_list_add_string(p_model_select, obs_module_text("Selfie Segmentation"), MODEL_SELFIE);
-	obs_property_list_add_string(p_model_select, obs_module_text("Robust Video Matting"), MODEL_RVM);
-
-	obs_property_t *p_mask_every_x_frames = obs_properties_add_int(
-		props,
-		"mask_every_x_frames",
-		obs_module_text("Calculate mask every X frame"),
-		1,
-		300,
-		1);
-
-	UNUSED_PARAMETER(data);
-	return props;
+ obs_property_t *p_model_select =
+ obs_properties_add_list(props, "model_select", obs_module_text("Segmentation model"),
+ OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
+
+ obs_property_list_add_string(p_model_select, obs_module_text("SINet"), MODEL_SINET);
+ obs_property_list_add_string(p_model_select, obs_module_text("MODNet"), MODEL_MODNET);
+ obs_property_list_add_string(p_model_select, obs_module_text("MediaPipe"), MODEL_MEDIAPIPE);
+ obs_property_list_add_string(p_model_select, obs_module_text("Selfie Segmentation"),
+ MODEL_SELFIE);
+ obs_property_list_add_string(p_model_select, obs_module_text("Robust Video Matting"), MODEL_RVM);
+
+ obs_properties_add_int(props, "mask_every_x_frames",
+ obs_module_text("Calculate mask every X frame"), 1, 300, 1);
+
+ UNUSED_PARAMETER(data);
+ return props;
 }
 
-static void filter_defaults(obs_data_t *settings) {
-	obs_data_set_default_double(settings, "threshold", 0.5);
-	obs_data_set_default_double(settings, "contour_filter", 0.05);
-	obs_data_set_default_double(settings, "smooth_contour", 0.5);
-	obs_data_set_default_double(settings, "feather", 0.0);
-	obs_data_set_default_int(settings, "replaceColor", 0x000000);
-	obs_data_set_default_string(settings, "useGPU", USEGPU_CPU);
-	obs_data_set_default_string(settings, "model_select", MODEL_MEDIAPIPE);
-	obs_data_set_default_int(settings, "mask_every_x_frames", 1);
+static void filter_defaults(obs_data_t *settings)
+{
+ obs_data_set_default_double(settings, "threshold", 0.5);
+ obs_data_set_default_double(settings, "contour_filter", 0.05);
+ obs_data_set_default_double(settings, "smooth_contour", 0.5);
+ obs_data_set_default_double(settings, "feather", 0.0);
+ obs_data_set_default_int(settings, "replaceColor", 0x000000);
+ obs_data_set_default_string(settings, "useGPU", USEGPU_CPU);
+ obs_data_set_default_string(settings, "model_select", MODEL_MEDIAPIPE);
+ obs_data_set_default_int(settings, "mask_every_x_frames", 1);
 }
 
-static void createOrtSession(struct background_removal_filter *tf) {
+static void createOrtSession(struct background_removal_filter *tf)
+{
 
-	Ort::SessionOptions sessionOptions;
+ Ort::SessionOptions sessionOptions;
 
-	sessionOptions.SetGraphOptimizationLevel(GraphOptimizationLevel::ORT_ENABLE_ALL);
-	if (tf->useGPU != USEGPU_CPU) {
-		sessionOptions.DisableMemPattern();
-		sessionOptions.SetExecutionMode(ExecutionMode::ORT_SEQUENTIAL);
-	}
+ sessionOptions.SetGraphOptimizationLevel(GraphOptimizationLevel::ORT_ENABLE_ALL);
+ if (tf->useGPU != USEGPU_CPU) {
+ sessionOptions.DisableMemPattern();
+ sessionOptions.SetExecutionMode(ExecutionMode::ORT_SEQUENTIAL);
+ }
 
-	char* modelFilepath_rawPtr = obs_module_file(tf->modelSelection.c_str());
+ char *modelFilepath_rawPtr = obs_module_file(tf->modelSelection.c_str());
 
-	if (modelFilepath_rawPtr == nullptr) {
-		blog(LOG_ERROR, "Unable to get model filename %s from plugin.", tf->modelSelection.c_str());
-		return;
-	}
+ if (modelFilepath_rawPtr == nullptr) {
+ blog(LOG_ERROR, "Unable to get model filename %s from plugin.", tf->modelSelection.c_str());
+ return;
+ }
 
-	std::string modelFilepath_s(modelFilepath_rawPtr);
-	bfree(modelFilepath_rawPtr);
+ std::string modelFilepath_s(modelFilepath_rawPtr);
+ bfree(modelFilepath_rawPtr);
 
 #if _WIN32
-	std::wstring modelFilepath_ws(modelFilepath_s.size(), L' ');
-	std::copy(modelFilepath_s.begin(), modelFilepath_s.end(), modelFilepath_ws.begin());
-	tf->modelFilepath = modelFilepath_ws.c_str();
+ std::wstring modelFilepath_ws(modelFilepath_s.size(), L' ');
+ std::copy(modelFilepath_s.begin(), modelFilepath_s.end(), modelFilepath_ws.begin());
+ tf->modelFilepath = modelFilepath_ws.c_str();
 #else
-	tf->modelFilepath = modelFilepath_s.c_str();
+ tf->modelFilepath = modelFilepath_s.c_str();
 #endif
 
-	try {
+ try {
 #ifdef WITH_CUDA
- if (tf->useGPU == USEGPU_CUDA) {
- Ort::ThrowOnError(OrtSessionOptionsAppendExecutionProvider_CUDA(sessionOptions, 0));
- }
-#else
- if (tf->useGPU == USEGPU_DML) {
- Ort::ThrowOnError(OrtSessionOptionsAppendExecutionProvider_DML(sessionOptions, 0));
- }
+ if (tf->useGPU == USEGPU_CUDA) {
+ Ort::ThrowOnError(OrtSessionOptionsAppendExecutionProvider_CUDA(sessionOptions, 0));
+ }
+#elif _WIN32
+ if (tf->useGPU == USEGPU_DML) {
+ Ort::ThrowOnError(OrtSessionOptionsAppendExecutionProvider_DML(sessionOptions, 0));
+ }
 #endif
-		tf->session.reset(new Ort::Session(*tf->env, tf->modelFilepath, sessionOptions));
-	} catch (const std::exception& e) {
-		blog(LOG_ERROR, "%s", e.what());
-		return;
-	}
+ tf->session.reset(new Ort::Session(*tf->env, tf->modelFilepath, sessionOptions));
+ } catch (const std::exception &e) {
+ blog(LOG_ERROR, "%s", e.what());
+ return;
+ }
 
-	Ort::AllocatorWithDefaultOptions allocator;
+ Ort::AllocatorWithDefaultOptions allocator;
 
 tf->model->populateInputOutputNames(tf->session, tf->inputNames, tf->outputNames);
 
@@ -232,196 +199,160 @@
 
 for (size_t i = 0; i < tf->inputNames.size(); i++) {
 blog(LOG_INFO, "Model %s input %d: name %s shape (%d dim) %d x %d x %d x %d",
- tf->modelSelection.c_str(), (int)i,
- tf->inputNamesi,
- (int)tf->inputDimsi.size(),
- (int)tf->inputDimsi0,
- ((int)tf->inputDimsi.size() > 1) ? (int)tf->inputDimsi1 : 0,
- ((int)tf->inputDimsi.size() > 2) ? (int)tf->inputDimsi2 : 0,
- ((int)tf->inputDimsi.size() > 3) ? (int)tf->inputDimsi3 : 0
- );
+ tf->modelSelection.c_str(), (int)i, tf->inputNamesi.c_str(),
+ (int)tf->inputDimsi.size(), (int)tf->inputDimsi0,
+ ((int)tf->inputDimsi.size() > 1) ? (int)tf->inputDimsi1 : 0,
+ ((int)tf->inputDimsi.size() > 2) ? (int)tf->inputDimsi2 : 0,
+ ((int)tf->inputDimsi.size() > 3) ? (int)tf->inputDimsi3 : 0);
 }
 for (size_t i = 0; i < tf->outputNames.size(); i++) {
 blog(LOG_INFO, "Model %s output %d: name %s shape (%d dim) %d x %d x %d x %d",
- tf->modelSelection.c_str(), (int)i,
- tf->outputNamesi,
- (int)tf->outputDimsi.size(),
- (int)tf->outputDimsi0,
- ((int)tf->outputDimsi.size() > 1) ? (int)tf->outputDimsi1 : 0,
- ((int)tf->outputDimsi.size() > 2) ? (int)tf->outputDimsi2 : 0,
- ((int)tf->outputDimsi.size() > 3) ? (int)tf->outputDimsi3 : 0);
+ tf->modelSelection.c_str(), (int)i, tf->outputNamesi.c_str(),
+ (int)tf->outputDimsi.size(), (int)tf->outputDimsi0,
+ ((int)tf->outputDimsi.size() > 1) ? (int)tf->outputDimsi1 : 0,
+ ((int)tf->outputDimsi.size() > 2) ? (int)tf->outputDimsi2 : 0,
+ ((int)tf->outputDimsi.size() > 3) ? (int)tf->outputDimsi3 : 0);
 }
 
-	// Allocate buffers
- tf->model->allocateTensorBuffers(
- tf->inputDims,
- tf->outputDims,
- tf->outputTensorValues,
- 	tf->inputTensorValues,
- tf->inputTensor,
- tf->outputTensor
- );
+ // Allocate buffers
+ tf->model->allocateTensorBuffers(tf->inputDims, tf->outputDims, tf->outputTensorValues,
+ tf->inputTensorValues, tf->inputTensor, tf->outputTensor);
 }
 
-
-static void destroyScalers(struct background_removal_filter *tf) {
-	blog(LOG_INFO, "Destroy scalers.");
-	if (tf->scalerToBGR != nullptr) {
-		video_scaler_destroy(tf->scalerToBGR);
-		tf->scalerToBGR = nullptr;
-	}
-	if (tf->scalerFromBGR != nullptr) {
-		video_scaler_destroy(tf->scalerFromBGR);
-		tf->scalerFromBGR = nullptr;
-	}
+static void destroyScalers(struct background_removal_filter *tf)
+{
+ blog(LOG_INFO, "Destroy scalers.");
+ if (tf->scalerToBGR != nullptr) {
+ video_scaler_destroy(tf->scalerToBGR);
+ tf->scalerToBGR = nullptr;
+ }
+ if (tf->scalerFromBGR != nullptr) {
+ video_scaler_destroy(tf->scalerFromBGR);
+ tf->scalerFromBGR = nullptr;
+ }
 }
 
-
 static void filter_update(void *data, obs_data_t *settings)
 {
-	struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
-	tf->threshold = (float)obs_data_get_double(settings, "threshold");
-
-	uint64_t color = obs_data_get_int(settings, "replaceColor");
-	tf->backgroundColor.val0 = (double)((color >> 16) & 0x0000ff);
-	tf->backgroundColor.val1 = (double)((color >> 8) & 0x0000ff);
-	tf->backgroundColor.val2 = (double)(color & 0x0000ff);
-
-	tf->contourFilter = (float)obs_data_get_double(settings, "contour_filter");
-	tf->smoothContour = (float)obs_data_get_double(settings, "smooth_contour");
-	tf->feather = (float)obs_data_get_double(settings, "feather");
-	tf->maskEveryXFrames = (int)obs_data_get_int(settings, "mask_every_x_frames");
-	tf->maskEveryXFramesCount = (int)(0);
-
-
-	const std::string newUseGpu = obs_data_get_string(settings, "useGPU");
-	const std::string newModel = obs_data_get_string(settings, "model_select");
-
-	if (tf->modelSelection.empty() ||
- tf->modelSelection != newModel ||
- tf->useGPU != newUseGpu)
-	{
-		// Re-initialize model if it's not already the selected one or switching inference device
-		tf->modelSelection = newModel;
-		tf->useGPU = newUseGpu;
-		destroyScalers(tf);
-
-		if (tf->modelSelection == MODEL_SINET) {
-			tf->model.reset(new ModelSINET);
-		}
-		if (tf->modelSelection == MODEL_MODNET) {
-			tf->model.reset(new ModelMODNET);
-		}
-		if (tf->modelSelection == MODEL_SELFIE) {
-			tf->model.reset(new ModelSelfie);
-		}
-		if (tf->modelSelection == MODEL_MEDIAPIPE) {
-			tf->model.reset(new ModelMediaPipe);
-		}
-		if (tf->modelSelection == MODEL_RVM) {
-			tf->model.reset(new ModelRVM);
-		}
-
-		createOrtSession(tf);
-	}
-}
+ struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
+ tf->threshold = (float)obs_data_get_double(settings, "threshold");
+
+ uint64_t color = obs_data_get_int(settings, "replaceColor");
+ tf->backgroundColor.val0 = (double)((color >> 16) & 0x0000ff);
+ tf->backgroundColor.val1 = (double)((color >> 8) & 0x0000ff);
+ tf->backgroundColor.val2 = (double)(color & 0x0000ff);
+
+ tf->contourFilter = (float)obs_data_get_double(settings, "contour_filter");
+ tf->smoothContour = (float)obs_data_get_double(settings, "smooth_contour");
+ tf->feather = (float)obs_data_get_double(settings, "feather");
+ tf->maskEveryXFrames = (int)obs_data_get_int(settings, "mask_every_x_frames");
+ tf->maskEveryXFramesCount = (int)(0);
+
+ const std::string newUseGpu = obs_data_get_string(settings, "useGPU");
+ const std::string newModel = obs_data_get_string(settings, "model_select");
+
+ if (tf->modelSelection.empty() || tf->modelSelection != newModel || tf->useGPU != newUseGpu) {
+ // Re-initialize model if it's not already the selected one or switching inference device
+ tf->modelSelection = newModel;
+ tf->useGPU = newUseGpu;
+ destroyScalers(tf);
+
+ if (tf->modelSelection == MODEL_SINET) {
+ tf->model.reset(new ModelSINET);
+ }
+ if (tf->modelSelection == MODEL_MODNET) {
+ tf->model.reset(new ModelMODNET);
+ }
+ if (tf->modelSelection == MODEL_SELFIE) {
+ tf->model.reset(new ModelSelfie);
+ }
+ if (tf->modelSelection == MODEL_MEDIAPIPE) {
+ tf->model.reset(new ModelMediaPipe);
+ }
+ if (tf->modelSelection == MODEL_RVM) {
+ tf->model.reset(new ModelRVM);
+ }
 
+ createOrtSession(tf);
+ }
+}
 
 /** FILTER CORE */
 
-static void *filter_create(obs_data_t *settings, obs_source_t *source)
+static void *filter_create(obs_data_t *settings, obs_source_t *)
 {
-	struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(bzalloc(sizeof(struct background_removal_filter)));
+ struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(
+ bzalloc(sizeof(struct background_removal_filter)));
 
-	std::string instanceName{"background-removal-inference"};
-	tf->env.reset(new Ort::Env(OrtLoggingLevel::ORT_LOGGING_LEVEL_ERROR, instanceName.c_str()));
+ std::string instanceName{"background-removal-inference"};
+ tf->env.reset(new Ort::Env(OrtLoggingLevel::ORT_LOGGING_LEVEL_ERROR, instanceName.c_str()));
 
- tf->modelSelection = MODEL_MEDIAPIPE;
-	filter_update(tf, settings);
+ tf->modelSelection = MODEL_MEDIAPIPE;
+ filter_update(tf, settings);
 
-	return tf;
+ return tf;
 }
 
+static void initializeScalers(cv::Size frameSize, enum video_format frameFormat,
+ struct background_removal_filter *tf)
+{
 
-static void initializeScalers(
-	cv::Size frameSize,
-	enum video_format frameFormat,
-	struct background_removal_filter *tf
-) {
-
-	struct video_scale_info dst{
-		VIDEO_FORMAT_BGR3,
-		(uint32_t)frameSize.width,
-		(uint32_t)frameSize.height,
-		VIDEO_RANGE_DEFAULT,
-		VIDEO_CS_DEFAULT
-	};
-	struct video_scale_info src{
-		frameFormat,
-		(uint32_t)frameSize.width,
-		(uint32_t)frameSize.height,
-		VIDEO_RANGE_DEFAULT,
-		VIDEO_CS_DEFAULT
-	};
-
-	// Check if scalers already defined and release them
-	destroyScalers(tf);
-
-	blog(LOG_INFO, "Initialize scalers. Size %d x %d",
-		frameSize.width, frameSize.height);
-
-	// Create new scalers
-	video_scaler_create(&tf->scalerToBGR, &dst, &src, VIDEO_SCALE_DEFAULT);
-	video_scaler_create(&tf->scalerFromBGR, &src, &dst, VIDEO_SCALE_DEFAULT);
-}
+ struct video_scale_info dst {
+ VIDEO_FORMAT_BGR3, (uint32_t)frameSize.width,
+ (uint32_t)frameSize.height, VIDEO_RANGE_DEFAULT, VIDEO_CS_DEFAULT
+ };
+ struct video_scale_info src {
+ frameFormat, (uint32_t)frameSize.width,
+ (uint32_t)frameSize.height, VIDEO_RANGE_DEFAULT, VIDEO_CS_DEFAULT
+ };
 
+ // Check if scalers already defined and release them
+ destroyScalers(tf);
 
-static cv::Mat convertFrameToBGR(
-	struct obs_source_frame *frame,
-	struct background_removal_filter *tf
-) {
-	const cv::Size frameSize(frame->width, frame->height);
+ blog(LOG_INFO, "Initialize scalers. Size %d x %d", frameSize.width, frameSize.height);
 
-	if (tf->scalerToBGR == nullptr) {
-		// Lazy initialize the frame scale & color converter
-		initializeScalers(frameSize, frame->format, tf);
-	}
+ // Create new scalers
+ video_scaler_create(&tf->scalerToBGR, &dst, &src, VIDEO_SCALE_DEFAULT);
+ video_scaler_create(&tf->scalerFromBGR, &src, &dst, VIDEO_SCALE_DEFAULT);
+}
 
-	cv::Mat imageBGR(frameSize, CV_8UC3);
-	const uint32_t bgrLinesize = (uint32_t)(imageBGR.cols * imageBGR.elemSize());
-	video_scaler_scale(tf->scalerToBGR,
-		&(imageBGR.data), &(bgrLinesize),
-		frame->data, frame->linesize);
+static cv::Mat convertFrameToBGR(struct obs_source_frame *frame,
+ struct background_removal_filter *tf)
+{
+ const cv::Size frameSize(frame->width, frame->height);
 
-	return imageBGR;
-}
+ if (tf->scalerToBGR == nullptr) {
+ // Lazy initialize the frame scale & color converter
+ initializeScalers(frameSize, frame->format, tf);
+ }
 
+ cv::Mat imageBGR(frameSize, CV_8UC3);
+ const uint32_t bgrLinesize = (uint32_t)(imageBGR.cols * imageBGR.elemSize());
+ video_scaler_scale(tf->scalerToBGR, &(imageBGR.data), &(bgrLinesize), frame->data,
+ frame->linesize);
 
-static void convertBGRToFrame(
- const cv::Mat& imageBGR,
- struct obs_source_frame *frame,
- struct background_removal_filter *tf
-) {
+ return imageBGR;
+}
+
+static void convertBGRToFrame(const cv::Mat &imageBGR, struct obs_source_frame *frame,
+ struct background_removal_filter *tf)
+{
 if (tf->scalerFromBGR == nullptr) {
 // Lazy initialize the frame scale & color converter
 initializeScalers(cv::Size(frame->width, frame->height), frame->format, tf);
 }
 
 const uint32_t rgbLinesize = (uint32_t)(imageBGR.cols * imageBGR.elemSize());
- video_scaler_scale(tf->scalerFromBGR,
- frame->data, frame->linesize,
- &(imageBGR.data), &(rgbLinesize));
+ video_scaler_scale(tf->scalerFromBGR, frame->data, frame->linesize, &(imageBGR.data),
+ &(rgbLinesize));
 }
 
-
-static void processImageForBackground(
- struct background_removal_filter *tf,
- const cv::Mat& imageBGR,
- cv::Mat& backgroundMask)
+static void processImageForBackground(struct background_removal_filter *tf, const cv::Mat &imageBGR,
+ cv::Mat &backgroundMask)
 {
 if (tf->session.get() == nullptr) {
- // Onnx runtime session is not initialized. Problem in initialization
- return;
+ // Onnx runtime session is not initialized. Problem in initialization
+ return;
 }
 try {
 // To RGB
@@ -444,11 +375,15 @@
 tf->model->loadInputToTensor(preprocessedImage, inputWidth, inputHeight, tf->inputTensorValues);
 
 // Run network inference
- tf->model->runNetworkInference(tf->session, tf->inputNames, tf->outputNames, tf->inputTensor, tf->outputTensor);
+ tf->model->runNetworkInference(tf->session, tf->inputNames, tf->outputNames, tf->inputTensor,
+ tf->outputTensor);
 
 // Get output
 // Map network output mask to cv::Mat
- cv::Mat outputImage = tf->model->getNetworkOutput(tf->outputDims, tf->outputTensorValues, tf->inputDims, tf->inputTensorValues);
+ cv::Mat outputImage = tf->model->getNetworkOutput(tf->outputDims, tf->outputTensorValues);
+
+ // Assign output to input in some models that have temporal information
+ tf->model->assignOutputToInput(tf->outputTensorValues, tf->inputTensorValues);
 
 // Post-process output
 tf->model->postprocessOutput(outputImage);
@@ -461,11 +396,11 @@
 
 // Contour processing
 if (tf->contourFilter > 0.0 && tf->contourFilter < 1.0) {
- std::vector<std::vector<cv::Point> > contours;
+ std::vector<std::vector<cv::Point>> contours;
 findContours(backgroundMask, contours, cv::RETR_EXTERNAL, cv::CHAIN_APPROX_SIMPLE);
- std::vector<std::vector<cv::Point> > filteredContours;
+ std::vector<std::vector<cv::Point>> filteredContours;
 const int64_t contourSizeThreshold = (int64_t)(backgroundMask.total() * tf->contourFilter);
- for (auto& contour : contours) {
+ for (auto &contour : contours) {
 if (cv::contourArea(contour) > contourSizeThreshold) {
 filteredContours.push_back(contour);
 }
@@ -480,100 +415,96 @@
 // Smooth mask with a fast filter (box).
 if (tf->smoothContour > 0.0) {
 int k_size = (int)(100 * tf->smoothContour);
- cv::boxFilter(backgroundMask, backgroundMask, backgroundMask.depth(), cv::Size(k_size, k_size));
+ cv::boxFilter(backgroundMask, backgroundMask, backgroundMask.depth(),
+ cv::Size(k_size, k_size));
 backgroundMask = backgroundMask > 128;
 }
- }
- catch(const std::exception& e) {
+ } catch (const std::exception &e) {
 blog(LOG_ERROR, "%s", e.what());
 }
 }
 
-
-static struct obs_source_frame * filter_render(void *data, struct obs_source_frame *frame)
+static struct obs_source_frame *filter_render(void *data, struct obs_source_frame *frame)
 {
-	struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
-
-	// Convert to BGR
-	cv::Mat imageBGR = convertFrameToBGR(frame, tf);
-
-	cv::Mat backgroundMask(imageBGR.size(), CV_8UC1, cv::Scalar(255));
-
-	tf->maskEveryXFramesCount = ++(tf->maskEveryXFramesCount) % tf->maskEveryXFrames;
-	if (tf->maskEveryXFramesCount != 0 && !tf->backgroundMask.empty()) {
-		// We are skipping processing of the mask for this frame.
-		// Get the background mask previously generated.
-		tf->backgroundMask.copyTo(backgroundMask);
-	} else {
-		// Process the image to find the mask.
-		processImageForBackground(tf, imageBGR, backgroundMask);
-
-		// Now that the mask is completed, save it off so it can be used on a later frame
-		// if we've chosen to only process the mask every X frames.
-		backgroundMask.copyTo(tf->backgroundMask);
-	}
-
-	// Apply the mask back to the main image.
-	try {
-		if (tf->feather > 0.0) {
-			// If we're going to feather/alpha blend, we need to do some processing that
-			// will combine the blended "foreground" and "masked background" images onto the main image.
-			cv::Mat maskFloat;
-			int k_size = (int)(40 * tf->feather);
-
-			// Convert Mat to float and Normalize the alpha mask to keep intensity between 0 and 1.
-			backgroundMask.convertTo(maskFloat, CV_32FC1, 1.0 / 255.0);
-			//Feather the normalized mask.
-			cv::boxFilter(maskFloat, maskFloat, maskFloat.depth(), cv::Size(k_size, k_size));
-
-			// Alpha blend
-			cv::Mat maskFloat3c;
-			cv::cvtColor(maskFloat, maskFloat3c, cv::COLOR_GRAY2BGR);
-			cv::Mat tmpImage, tmpBackground;
-			// Mutiply the unmasked foreground area of the image with ( 1 - alpha matte).
-			cv::multiply(imageBGR, cv::Scalar(1, 1, 1) - maskFloat3c, tmpImage, 1.0, CV_32FC3);
-			// Multiply the masked background area (with the background color applied) with the alpha matte.
-			cv::multiply(cv::Mat(imageBGR.size(), CV_32FC3, tf->backgroundColor), maskFloat3c, tmpBackground);
-			// Add the foreground and background images together, rescale back to an 8bit integer image
-			// and apply onto the main image.
-			cv::Mat(tmpImage + tmpBackground).convertTo(imageBGR, CV_8UC3);
-		} else {
-			// If we're not feathering/alpha blending, we can
-			// apply the mask as-is back onto the main image.
-			imageBGR.setTo(tf->backgroundColor, backgroundMask);
-		}
-	}
-	catch(const std::exception& e) {
-		blog(LOG_ERROR, "%s", e.what());
-	}
-
-	// Put masked image back on frame,
-	convertBGRToFrame(imageBGR, frame, tf);
-	return frame;
-}
+ struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
 
+ // Convert to BGR
+ cv::Mat imageBGR = convertFrameToBGR(frame, tf);
 
-static void filter_destroy(void *data)
-{
-	struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
+ cv::Mat backgroundMask(imageBGR.size(), CV_8UC1, cv::Scalar(255));
+
+ tf->maskEveryXFramesCount = ++(tf->maskEveryXFramesCount) % tf->maskEveryXFrames;
+ if (tf->maskEveryXFramesCount != 0 && !tf->backgroundMask.empty()) {
+ // We are skipping processing of the mask for this frame.
+ // Get the background mask previously generated.
+ tf->backgroundMask.copyTo(backgroundMask);
+ } else {
+ // Process the image to find the mask.
+ processImageForBackground(tf, imageBGR, backgroundMask);
 
-	if (tf) {
-		destroyScalers(tf);
-		bfree(tf);
-	}
+ // Now that the mask is completed, save it off so it can be used on a later frame
+ // if we've chosen to only process the mask every X frames.
+ backgroundMask.copyTo(tf->backgroundMask);
+ }
+
+ // Apply the mask back to the main image.
+ try {
+ if (tf->feather > 0.0) {
+ // If we're going to feather/alpha blend, we need to do some processing that
+ // will combine the blended "foreground" and "masked background" images onto the main image.
+ cv::Mat maskFloat;
+ int k_size = (int)(40 * tf->feather);
+
+ // Convert Mat to float and Normalize the alpha mask to keep intensity between 0 and 1.
+ backgroundMask.convertTo(maskFloat, CV_32FC1, 1.0 / 255.0);
+ //Feather the normalized mask.
+ cv::boxFilter(maskFloat, maskFloat, maskFloat.depth(), cv::Size(k_size, k_size));
+
+ // Alpha blend
+ cv::Mat maskFloat3c;
+ cv::cvtColor(maskFloat, maskFloat3c, cv::COLOR_GRAY2BGR);
+ cv::Mat tmpImage, tmpBackground;
+ // Mutiply the unmasked foreground area of the image with ( 1 - alpha matte).
+ cv::multiply(imageBGR, cv::Scalar(1, 1, 1) - maskFloat3c, tmpImage, 1.0, CV_32FC3);
+ // Multiply the masked background area (with the background color applied) with the alpha matte.
+ cv::multiply(cv::Mat(imageBGR.size(), CV_32FC3, tf->backgroundColor), maskFloat3c,
+ tmpBackground);
+ // Add the foreground and background images together, rescale back to an 8bit integer image
+ // and apply onto the main image.
+ cv::Mat(tmpImage + tmpBackground).convertTo(imageBGR, CV_8UC3);
+ } else {
+ // If we're not feathering/alpha blending, we can
+ // apply the mask as-is back onto the main image.
+ imageBGR.setTo(tf->backgroundColor, backgroundMask);
+ }
+ } catch (const std::exception &e) {
+ blog(LOG_ERROR, "%s", e.what());
+ }
+
+ // Put masked image back on frame,
+ convertBGRToFrame(imageBGR, frame, tf);
+ return frame;
 }
 
+static void filter_destroy(void *data)
+{
+ struct background_removal_filter *tf = reinterpret_cast<background_removal_filter *>(data);
 
+ if (tf) {
+ destroyScalers(tf);
+ bfree(tf);
+ }
+}
 
 struct obs_source_info background_removal_filter_info = {
-	.id = "background_removal",
-	.type = OBS_SOURCE_TYPE_FILTER,
-	.output_flags = OBS_SOURCE_VIDEO | OBS_SOURCE_ASYNC,
-	.get_name = filter_getname,
-	.create = filter_create,
-	.destroy = filter_destroy,
-	.get_defaults = filter_defaults,
-	.get_properties = filter_properties,
-	.update = filter_update,
-	.filter_video = filter_render,
+ .id = "background_removal",
+ .type = OBS_SOURCE_TYPE_FILTER,
+ .output_flags = OBS_SOURCE_VIDEO | OBS_SOURCE_ASYNC,
+ .get_name = filter_getname,
+ .create = filter_create,
+ .destroy = filter_destroy,
+ .get_defaults = filter_defaults,
+ .get_properties = filter_properties,
+ .update = filter_update,
+ .filter_video = filter_render,
 };

obs-backgroundremoval-0.4.0~gh.20220502T170138.cc9d4a5.tar.xz/src/plugin-main.cpp -> obs-backgroundremoval-0.5.0.tar.xz/src/plugin-main.cpp Changed

onnxruntime-linux-x64-1.12.1.tgz/lib/libonnxruntime.so.1.12.1 Deleted

onnxruntime-linux-x64-1.12.1.tgz/GIT_COMMIT_ID -> onnxruntime-linux-x64-1.14.1.tgz/GIT_COMMIT_ID Changed

onnxruntime-linux-x64-1.12.1.tgz/README.md -> onnxruntime-linux-x64-1.14.1.tgz/README.md Changed

@@ -7,22 +7,26 @@
 **ONNX Runtime training** can accelerate the model training time on multi-node NVIDIA GPUs for transformer models with a one-line addition for existing PyTorch training scripts. Learn more &rarr;(https://www.onnxruntime.ai/docs/#onnx-runtime-for-training)
 
 
-## Get Started
+## Get Started & Resources
 
-**General Information**: onnxruntime.ai(https://onnxruntime.ai)
+* **General Information**: onnxruntime.ai(https://onnxruntime.ai)
 
-**Usage documention and tutorials**: onnxruntime.ai/docs(https://onnxruntime.ai/docs)
+* **Usage documention and tutorials**: onnxruntime.ai/docs(https://onnxruntime.ai/docs)
 
-**Companion sample repositories**: 
-- ONNX Runtime Inferencing: microsoft/onnxruntime-inference-examples(https://github.com/microsoft/onnxruntime-inference-examples)
-- ONNX Runtime Training: microsoft/onnxruntime-training-examples(https://github.com/microsoft/onnxruntime-training-examples)
+* **YouTube video tutorials**: youtube.com/@ONNXRuntime(https://www.youtube.com/@ONNXRuntime)
+
+* **Upcoming Release Roadmap**(https://github.com/microsoft/onnxruntime/wiki/Upcoming-Release-Roadmap)
+
+* **Companion sample repositories**: 
+ - ONNX Runtime Inferencing: microsoft/onnxruntime-inference-examples(https://github.com/microsoft/onnxruntime-inference-examples)
+ - ONNX Runtime Training: microsoft/onnxruntime-training-examples(https://github.com/microsoft/onnxruntime-training-examples)
 
 
 ## Build Pipeline Status
 |System|CPU|GPU|EPs|
 |---|---|---|---|
 |Windows|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Windows%20CPU%20CI%20Pipeline?label=Windows+CPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=9)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Windows%20GPU%20CI%20Pipeline?label=Windows+GPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=10)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Windows%20GPU%20TensorRT%20CI%20Pipeline?label=Windows+GPU+TensorRT)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=47)|
-|Linux|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20CI%20Pipeline?label=Linux+CPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=11) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20Minimal%20Build%20E2E%20CI%20Pipeline?label=Linux+CPU+Minimal+Build)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=64) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20x64%20NoContribops%20CI%20Pipeline?label=Linux+CPU+x64+No+Contrib+Ops)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=110) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/centos7_cpu?label=Linux+CentOS7)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=78) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-linux-ci-pipeline?label=Linux+CPU+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=86)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20GPU%20CI%20Pipeline?label=Linux+GPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=12) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20GPU%20TensorRT%20CI%20Pipeline?label=Linux+GPU+TensorRT)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=45) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-distributed?label=Distributed+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=140) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-linux-gpu-ci-pipeline?label=Linux+GPU+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=84)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20NUPHAR%20CI%20Pipeline?label=Linux+NUPHAR)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=110) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20OpenVINO%20CI%20Pipeline?label=Linux+OpenVINO)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=55)|
+|Linux|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20CI%20Pipeline?label=Linux+CPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=11) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20Minimal%20Build%20E2E%20CI%20Pipeline?label=Linux+CPU+Minimal+Build)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=64) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20CPU%20x64%20NoContribops%20CI%20Pipeline?label=Linux+CPU+x64+No+Contrib+Ops)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=110) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/centos7_cpu?label=Linux+CentOS7)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=78) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-linux-ci-pipeline?label=Linux+CPU+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=86)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20GPU%20CI%20Pipeline?label=Linux+GPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=12) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20GPU%20TensorRT%20CI%20Pipeline?label=Linux+GPU+TensorRT)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=45) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-distributed?label=Distributed+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=140) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/orttraining-linux-gpu-ci-pipeline?label=Linux+GPU+Training)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=84)|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Linux%20OpenVINO%20CI%20Pipeline?label=Linux+OpenVINO)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=55)|
 |Mac|!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/MacOS%20CI%20Pipeline?label=MacOS+CPU)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=13) !Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/MacOS%20NoContribops%20CI%20Pipeline?label=MacOS+NoContribops)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=65)|||
 |Android|||!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/Android%20CI%20Pipeline?label=Android)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=53)|
 |iOS|||!Build Status(https://dev.azure.com/onnxruntime/onnxruntime/_apis/build/status/iOS%20CI%20Pipeline?label=iOS)(https://dev.azure.com/onnxruntime/onnxruntime/_build/latest?definitionId=134)|

onnxruntime-linux-x64-1.12.1.tgz/ThirdPartyNotices.txt -> onnxruntime-linux-x64-1.14.1.tgz/ThirdPartyNotices.txt Changed

@@ -210,18 +210,207 @@
 
 Copyright (c) Facebook, Inc. and Microsoft Corporation. All rights reserved.
 
-MIT License
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the
-Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
-and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
 
-THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
-ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH
-THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets ""
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright yyyy name of copyright owner
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
 
 _____
 
@@ -848,16 +1037,22 @@
 
 _____
 
-gsl-lite
+Microsoft GSL
 
-gsl-lite is based on GSL: Guidelines Support Library.
-For more information see https://github.com/martinmoene/gsl-lite
-
-Copyright (c) 2015 Martin Moene
 Copyright (c) 2015 Microsoft Corporation. All rights reserved.
 
 This code is licensed under the MIT License (MIT).
 
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
@@ -2559,6 +2754,37 @@
 SOFTWARE.
 
 _____
+nvidia/cutlass
+
+Copyright (c) 2017 - 2022 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+SPDX-License-Identifier: BSD-3-Clause
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+_____
 Boost
 
 Boost Software License - Version 1.0 - August 17th, 2003
@@ -3281,35 +3507,6 @@
 
 _____
 
-NVlabs/cub
-
-Copyright (c) 2010-2011, Duane Merrill.  All rights reserved.
-Copyright (c) 2011-2018, NVIDIA CORPORATION.  All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-   *  Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-   *  Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in the
-      documentation and/or other materials provided with the distribution.
-   *  Neither the name of the NVIDIA CORPORATION nor the
-      names of its contributors may be used to endorse or promote products
-      derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
-ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL NVIDIA CORPORATION BE LIABLE FOR ANY
-DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
-(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
-LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
-ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-_____
-
 microsoft/wil
 
 MIT License
@@ -4776,4 +4973,814 @@
 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+_____
+
+google/sentencepiece, https://github.com/google/sentencepiece
+(included when statically linked with onnxruntime-extensions)
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets ""
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright yyyy name of copyright owner
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+_____
+
+dlfcn-win32/dlfcn-win32 is licensed under the MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+_____
+
+The Python Imaging Library (PIL) is
+
+    Copyright © 1997-2011 by Secret Labs AB
+    Copyright © 1995-2011 by Fredrik Lundh
+
+Pillow is the friendly PIL fork. It is
+
+    Copyright © 2010-2023 by Alex Clark and contributors
+
+Like PIL, Pillow is licensed under the open source HPND License:
+
+By obtaining, using, and/or copying this software and/or its associated
+documentation, you agree that you have read, understood, and will comply
+with the following terms and conditions:
+
+Permission to use, copy, modify, and distribute this software and its
+associated documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appears in all copies, and that
+both that copyright notice and this permission notice appear in supporting
+documentation, and that the name of Secret Labs AB or the author not be
+used in advertising or publicity pertaining to distribution of the software
+without specific, written prior permission.
+
+SECRET LABS AB AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
+IN NO EVENT SHALL SECRET LABS AB OR THE AUTHOR BE LIABLE FOR ANY SPECIAL,
+INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE
+OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+
+_____
+
+openssl/openssl, https://github.com/openssl/openssl
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+_____
+
+Tencent/rapidjson, https://github.com/Tencent/rapidjson
+
+Tencent is pleased to support the open source community by making RapidJSON available. 
+ 
+Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip.  All rights reserved.
+
+If you have downloaded a copy of the RapidJSON binary from Tencent, please note that the RapidJSON binary is licensed under the MIT License.
+If you have downloaded a copy of the RapidJSON source code from Tencent, please note that RapidJSON source code is licensed under the MIT License, except for the third-party components listed below which are subject to different license terms.  Your integration of RapidJSON into your own projects may require compliance with the MIT License, as well as the other licenses applicable to the third-party components included within RapidJSON. To avoid the problematic JSON license in your own projects, it's sufficient to exclude the bin/jsonchecker/ directory, as it's the only code under the JSON license.
+A copy of the MIT License is included in this file.
+
+Other dependencies and licenses:
+
+Open Source Software Licensed Under the BSD License:
+--------------------------------------------------------------------
+
+The msinttypes r29 
+Copyright (c) 2006-2013 Alexander Chemeris 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of  copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+Open Source Software Licensed Under the JSON License:
+--------------------------------------------------------------------
+
+json.org 
+Copyright (c) 2002 JSON.org
+All Rights Reserved.
+
+JSON_checker
+Copyright (c) 2002 JSON.org
+All Rights Reserved.
+
+
+Terms of the JSON License:
+---------------------------------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+The Software shall be used for Good, not Evil.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Terms of the MIT License:
+--------------------------------------------------------------------
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+_____
+
+boostorg/boost, https://github.com/boostorg/boost
+
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+
+_____
+
+libb64/libb64, https://github.com/libb64/libb64
+
+Copyright-Only Dedication (based on United States law) or Public Domain Certification
+
+The person or persons who have associated work with this document (the "Dedicator" or "Certifier") hereby either (a) certifies that, to the best of his knowledge, the work of authorship identified is in the public domain of the country from which the work is published, or (b) hereby dedicates whatever copyright the dedicators holds in the work of authorship identified below (the "Work") to the public domain. A certifier, moreover, dedicates any copyright interest he may have in the associated work, and for these purposes, is described as a "dedicator" below.
+
+A certifier has taken reasonable steps to verify the copyright status of this work. Certifier recognizes that his good faith efforts may not shield him from liability if in fact the work certified is not in the public domain.
+
+Dedicator makes this dedication for the benefit of the public at large and to the detriment of the Dedicator's heirs and successors. Dedicator intends this dedication to be an overt act of relinquishment in perpetuity of all present and future rights under copyright law, whether vested or contingent, in the Work. Dedicator understands that such relinquishment of all rights includes the relinquishment of all rights to enforce (by lawsuit or otherwise) those copyrights in the Work.
+
+Dedicator recognizes that, once placed in the public domain, the Work may be freely reproduced, distributed, transmitted, used, modified, built upon, or otherwise exploited by anyone for any purpose, commercial or non-commercial, and in any way, including by methods that have not yet been invented or conceived.
+
+_____
+
+posix pthread library, https://sourceforge.net/projects/pthreads4w
+
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets ""
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright yyyy name of copyright owner
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+_____
+
+Triton Inference Server & Client, https://github.com/triton-inference-server
+
+Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+ * Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+ * Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+ * Neither the name of NVIDIA CORPORATION nor the names of its
+   contributors may be used to endorse or promote products derived
+   from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+_____
+
+microsoft/mimalloc, https://github.com/microsoft/mimalloc
+
+MIT License
+
+Copyright (c) 2018-2021 Microsoft Corporation, Daan Leijen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

onnxruntime-linux-x64-1.12.1.tgz/VERSION_NUMBER -> onnxruntime-linux-x64-1.14.1.tgz/VERSION_NUMBER Changed

onnxruntime-linux-x64-1.12.1.tgz/include/onnxruntime_c_api.h -> onnxruntime-linux-x64-1.14.1.tgz/include/onnxruntime_c_api.h Changed

@@ -4,22 +4,22 @@
 // See docs\c_cxx\README.md on generating the Doxygen documentation from this file
 
 /** \mainpage C & C++ APIs
-*
-* <h1>C</h1>
-*
-* ::OrtApi - Click here to go to the structure with all C API functions.
-*
-* <h1>C++</h1>
-*
-* ::Ort - Click here to go to the namespace holding all of the C++ wrapper classes
-*
-* It is a set of header only wrapper classes around the C API. The goal is to turn the C style return value error codes into C++ exceptions, and to
-* automate memory management through standard C++ RAII principles.
-*
-* \addtogroup Global
-* ONNX Runtime C API
-* @{
-*/
+ *
+ * <h1>C</h1>
+ *
+ * ::OrtApi - Click here to go to the structure with all C API functions.
+ *
+ * <h1>C++</h1>
+ *
+ * ::Ort - Click here to go to the namespace holding all of the C++ wrapper classes
+ *
+ * It is a set of header only wrapper classes around the C API. The goal is to turn the C style return value error codes into C++ exceptions, and to
+ * automate memory management through standard C++ RAII principles.
+ *
+ * \addtogroup Global
+ * ONNX Runtime C API
+ * @{
+ */
 
 #pragma once
 #include <stdlib.h>
@@ -27,10 +27,10 @@
 #include <string.h>
 
 /** \brief The API version defined in this header
-*
-* This value is used by some API functions to behave as this version of the header expects.
-*/
-#define ORT_API_VERSION 12
+ *
+ * This value is used by some API functions to behave as this version of the header expects.
+ */
+#define ORT_API_VERSION 14
 
 #ifdef __cplusplus
 extern "C" {
@@ -120,8 +120,9 @@
 // __VA_ARGS__ on Windows and Linux are different
 #define ORT_API(RETURN_TYPE, NAME, ...) RETURN_TYPE ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
 
-#define ORT_API_STATUS(NAME, ...) \
- _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION ORT_MUST_USE_RESULT
+#define ORT_API_STATUS(NAME, ...) \
+ _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) \
+ NO_EXCEPTION ORT_MUST_USE_RESULT
 
 // XXX: Unfortunately, SAL annotations are known to not work with function pointers
 #define ORT_API2_STATUS(NAME, ...) \
@@ -129,7 +130,6 @@
 
 // Used in *.cc files. Almost as same as ORT_API_STATUS, except without ORT_MUST_USE_RESULT and ORT_EXPORT
 #define ORT_API_STATUS_IMPL(NAME, ...) \
- GSL_SUPPRESS(r .11) \
 _Success_(return == 0) _Check_return_ _Ret_maybenull_ OrtStatusPtr ORT_API_CALL NAME(__VA_ARGS__) NO_EXCEPTION
 
 #define ORT_CLASS_RELEASE(X) void(ORT_API_CALL * Release##X)(_Frees_ptr_opt_ Ort##X * input)
@@ -150,8 +150,8 @@
 */
 
 /** Copied from TensorProto::DataType
-* Currently, Ort doesn't support complex64, complex128
-*/
+ * Currently, Ort doesn't support complex64, complex128
+ */
 typedef enum ONNXTensorElementDataType {
 ONNX_TENSOR_ELEMENT_DATA_TYPE_UNDEFINED,
 ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT, // maps to c type float
@@ -251,7 +251,7 @@
 ORT_RUNTIME_CLASS(Status); // nullptr for Status* indicates success
 ORT_RUNTIME_CLASS(MemoryInfo);
 ORT_RUNTIME_CLASS(IoBinding);
-ORT_RUNTIME_CLASS(Session); //Don't call ReleaseSession from Dllmain (because session owns a thread pool)
+ORT_RUNTIME_CLASS(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
 ORT_RUNTIME_CLASS(Value);
 ORT_RUNTIME_CLASS(RunOptions);
 ORT_RUNTIME_CLASS(TypeInfo);
@@ -267,6 +267,7 @@
 ORT_RUNTIME_CLASS(PrepackedWeightsContainer);
 ORT_RUNTIME_CLASS(TensorRTProviderOptionsV2);
 ORT_RUNTIME_CLASS(CUDAProviderOptionsV2);
+ORT_RUNTIME_CLASS(CANNProviderOptions);
 ORT_RUNTIME_CLASS(Op);
 ORT_RUNTIME_CLASS(OpAttr);
 
@@ -277,11 +278,11 @@
 #endif
 
 /** \brief Memory allocation interface
-*
-* Structure of function pointers that defines a memory allocator. This can be created and filled in by the user for custom allocators.
-*
-* When an allocator is passed to any function, be sure that the allocator object is not destroyed until the last allocated object using it is freed.
-*/
+ *
+ * Structure of function pointers that defines a memory allocator. This can be created and filled in by the user for custom allocators.
+ *
+ * When an allocator is passed to any function, be sure that the allocator object is not destroyed until the last allocated object using it is freed.
+ */
 typedef struct OrtAllocator {
 uint32_t version; ///< Must be initialized to ORT_API_VERSION
 void*(ORT_API_CALL* Alloc)(struct OrtAllocator* this_, size_t size); ///< Returns a pointer to an allocated block of `size` bytes
@@ -294,10 +295,10 @@
 const char* message);
 
 /** \brief Graph optimization level
-*
-* Refer to https://www.onnxruntime.ai/docs/resources/graph-optimizations.html
-* for an in-depth understanding of Graph Optimizations
-*/
+ *
+ * Refer to https://www.onnxruntime.ai/docs/resources/graph-optimizations.html
+ * for an in-depth understanding of Graph Optimizations
+ */
 typedef enum GraphOptimizationLevel {
 ORT_DISABLE_ALL = 0,
 ORT_ENABLE_BASIC = 1,
@@ -311,8 +312,8 @@
 } ExecutionMode;
 
 /** \brief Language projection identifiers
-* /see OrtApi::SetLanguageProjection
-*/
+ * /see OrtApi::SetLanguageProjection
+ */
 typedef enum OrtLanguageProjection {
 ORT_PROJECTION_C = 0,
 ORT_PROJECTION_CPLUSPLUS = 1,
@@ -337,7 +338,7 @@
 } OrtAllocatorType;
 
 /** \brief Memory types for allocated memory, execution provider specific types should be extended in each provider.
-*/
+ */
 // Whenever this struct is updated, please also update the MakeKey function in onnxruntime / core / framework / execution_provider.cc
 typedef enum OrtMemType {
 OrtMemTypeCPUInput = -2, ///< Any CPU memory used by non-CPU execution provider
@@ -346,8 +347,16 @@
 OrtMemTypeDefault = 0, ///< The default allocator for execution provider
 } OrtMemType;
 
+/** \brief This mimics OrtDevice type constants so they can be returned in the API
+ */
+typedef enum OrtMemoryInfoDeviceType {
+ OrtMemoryInfoDeviceType_CPU = 0,
+ OrtMemoryInfoDeviceType_GPU = 1,
+ OrtMemoryInfoDeviceType_FPGA = 2
+} OrtMemoryInfoDeviceType;
+
 /** \brief Algorithm to use for cuDNN Convolution Op
-*/
+ */
 typedef enum OrtCudnnConvAlgoSearch {
 OrtCudnnConvAlgoSearchExhaustive, // expensive exhaustive benchmarking using cudnnFindConvolutionForwardAlgorithmEx
 OrtCudnnConvAlgoSearchHeuristic, // lightweight heuristic based search using cudnnGetConvolutionForwardAlgorithm_v7
@@ -355,126 +364,156 @@
 } OrtCudnnConvAlgoSearch;
 
 /** \brief CUDA Provider Options
-*
-* \see OrtApi::SessionOptionsAppendExecutionProvider_CUDA
-*/
+ *
+ * \see OrtApi::SessionOptionsAppendExecutionProvider_CUDA
+ */
 typedef struct OrtCUDAProviderOptions {
 #ifdef __cplusplus
- OrtCUDAProviderOptions() : device_id{}, cudnn_conv_algo_search{OrtCudnnConvAlgoSearchExhaustive}, gpu_mem_limit{SIZE_MAX}, arena_extend_strategy{}, do_copy_in_default_stream{1}, has_user_compute_stream{}, user_compute_stream{}, default_memory_arena_cfg{} {}
+ OrtCUDAProviderOptions()
+ : device_id{},
+ cudnn_conv_algo_search{OrtCudnnConvAlgoSearchExhaustive},
+ gpu_mem_limit{SIZE_MAX},
+ arena_extend_strategy{},
+ do_copy_in_default_stream{1},
+ has_user_compute_stream{},
+ user_compute_stream{},
+ default_memory_arena_cfg{},
+ tunable_op_enabled{false} {}
 #endif
 
 /** \brief CUDA device Id
- * Defaults to 0.
- */
+ * Defaults to 0.
+ */
 int device_id;
 
 /** \brief CUDA Convolution algorithm search configuration.
- * See enum OrtCudnnConvAlgoSearch for more details.
- * Defaults to OrtCudnnConvAlgoSearchExhaustive.
- */
+ * See enum OrtCudnnConvAlgoSearch for more details.
+ * Defaults to OrtCudnnConvAlgoSearchExhaustive.
+ */
 OrtCudnnConvAlgoSearch cudnn_conv_algo_search;
 
 /** \brief CUDA memory limit (To use all possible memory pass in maximum size_t)
- * Defaults to SIZE_MAX.
- * \note If a ::OrtArenaCfg has been applied, it will override this field
- */
+ * Defaults to SIZE_MAX.
+ * \note If a ::OrtArenaCfg has been applied, it will override this field
+ */
 size_t gpu_mem_limit;
 
 /** \brief Strategy used to grow the memory arena
- * 0 = kNextPowerOfTwo 
- * 1 = kSameAsRequested 
- * Defaults to 0.
- * \note If a ::OrtArenaCfg has been applied, it will override this field
- */
+ * 0 = kNextPowerOfTwo 
+ * 1 = kSameAsRequested 
+ * Defaults to 0.
+ * \note If a ::OrtArenaCfg has been applied, it will override this field
+ */
 int arena_extend_strategy;
 
 /** \brief Flag indicating if copying needs to take place on the same stream as the compute stream in the CUDA EP
- * 0 = Use separate streams for copying and compute.
- * 1 = Use the same stream for copying and compute.
- * Defaults to 1.
- * WARNING: Setting this to 0 may result in data races for some models.
- * Please see issue #4829 for more details.
- */
+ * 0 = Use separate streams for copying and compute.
+ * 1 = Use the same stream for copying and compute.
+ * Defaults to 1.
+ * WARNING: Setting this to 0 may result in data races for some models.
+ * Please see issue #4829 for more details.
+ */
 int do_copy_in_default_stream;
 
 /** \brief Flag indicating if there is a user provided compute stream
- * Defaults to 0.
- */
+ * Defaults to 0.
+ */
 int has_user_compute_stream;
 
 /** \brief User provided compute stream.
- * If provided, please set `has_user_compute_stream` to 1.
- */
+ * If provided, please set `has_user_compute_stream` to 1.
+ */
 void* user_compute_stream;
 
 /** \brief CUDA memory arena configuration parameters
- */
+ */
 OrtArenaCfg* default_memory_arena_cfg;
 
+ /** \brief Enable TunableOp.
+ * Set it to 1 to enable TunableOp. Otherwise, it is disabled by default.
+ * This option can be superseded by environment variable ORT_CUDA_TUNABLE_OP_ENABLED.
+ */
+ int tunable_op_enabled;
+
 } OrtCUDAProviderOptions;
 
 /** \brief ROCM Provider Options
-*
-* \see OrtApi::SessionOptionsAppendExecutionProvider_ROCM
-*/
+ *
+ * \see OrtApi::SessionOptionsAppendExecutionProvider_ROCM
+ */
 typedef struct OrtROCMProviderOptions {
 #ifdef __cplusplus
- OrtROCMProviderOptions() : device_id{}, miopen_conv_exhaustive_search{0}, gpu_mem_limit{SIZE_MAX}, arena_extend_strategy{}, do_copy_in_default_stream{1}, has_user_compute_stream{}, user_compute_stream{}, default_memory_arena_cfg{} {}
+ OrtROCMProviderOptions()
+ : device_id{},
+ miopen_conv_exhaustive_search{0},
+ gpu_mem_limit{SIZE_MAX},
+ arena_extend_strategy{},
+ do_copy_in_default_stream{1},
+ has_user_compute_stream{},
+ user_compute_stream{},
+ default_memory_arena_cfg{},
+ tunable_op_enabled{false} {}
 #endif
 
 /** \brief ROCM device Id
- * Defaults to 0.
- */
+ * Defaults to 0.
+ */
 int device_id;
 
 /** \brief ROCM MIOpen Convolution algorithm exaustive search option.
- * Defaults to 0 (false).
- */
+ * Defaults to 0 (false).
+ */
 int miopen_conv_exhaustive_search;
 
 /** \brief ROCM memory limit (To use all possible memory pass in maximum size_t)
- * Defaults to SIZE_MAX.
- * \note If a ::OrtArenaCfg has been applied, it will override this field
- */
+ * Defaults to SIZE_MAX.
+ * \note If a ::OrtArenaCfg has been applied, it will override this field
+ */
 size_t gpu_mem_limit;
 
 /** \brief Strategy used to grow the memory arena
- * 0 = kNextPowerOfTwo 
- * 1 = kSameAsRequested 
- * Defaults to 0.
- * \note If a ::OrtArenaCfg has been applied, it will override this field
- */
+ * 0 = kNextPowerOfTwo 
+ * 1 = kSameAsRequested 
+ * Defaults to 0.
+ * \note If a ::OrtArenaCfg has been applied, it will override this field
+ */
 int arena_extend_strategy;
 
 /** \brief Flag indicating if copying needs to take place on the same stream as the compute stream in the ROCM EP
- * 0 = Use separate streams for copying and compute.
- * 1 = Use the same stream for copying and compute.
- * Defaults to 1.
- * WARNING: Setting this to 0 may result in data races for some models.
- * Please see issue #4829 for more details.
- */
+ * 0 = Use separate streams for copying and compute.
+ * 1 = Use the same stream for copying and compute.
+ * Defaults to 1.
+ * WARNING: Setting this to 0 may result in data races for some models.
+ * Please see issue #4829 for more details.
+ */
 int do_copy_in_default_stream;
 
 /** \brief Flag indicating if there is a user provided compute stream
- * Defaults to 0.
- */
+ * Defaults to 0.
+ */
 int has_user_compute_stream;
 
 /** \brief User provided compute stream.
- * If provided, please set `has_user_compute_stream` to 1.
- */
+ * If provided, please set `has_user_compute_stream` to 1.
+ */
 void* user_compute_stream;
 
 /** \brief ROCM memory arena configuration parameters
- */
+ */
 OrtArenaCfg* default_memory_arena_cfg;
 
+ /** \brief Enable TunableOp.
+ * Set it to 1 to enable TunableOp. Otherwise, it is disabled by default.
+ * This option can be superseded by environment variable ORT_ROCM_TUNABLE_OP_ENABLED.
+ */
+ int tunable_op_enabled;
+
 } OrtROCMProviderOptions;
 
 /** \brief TensorRT Provider Options
-*
-* \see OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
-*/
+ *
+ * \see OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
+ */
 typedef struct OrtTensorRTProviderOptions {
 int device_id; ///< CUDA device id (0 = default device)
 int has_user_compute_stream; // indicator of user specified CUDA compute stream.
@@ -500,9 +539,9 @@
 } OrtTensorRTProviderOptions;
 
 /** \brief MIGraphX Provider Options
-*
-* \see OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX
-*/
+ *
+ * \see OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX
+ */
 typedef struct OrtMIGraphXProviderOptions {
 int device_id; // hip device id.
 int migraphx_fp16_enable; // enable MIGraphX FP16 precision. Default 0 = false, nonzero = true
@@ -510,110 +549,116 @@
 } OrtMIGraphXProviderOptions;
 
 /** \brief OpenVINO Provider Options
-*
-* \see OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO
-*/
+ *
+ * \see OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO
+ */
 typedef struct OrtOpenVINOProviderOptions {
 #ifdef __cplusplus
 OrtOpenVINOProviderOptions() : device_type{}, enable_vpu_fast_compile{}, device_id{},
- num_of_threads{}, use_compiled_network{}, blob_dump_path{},
+ num_of_threads{}, cache_dir{},
 context{}, enable_opencl_throttling{}, enable_dynamic_shapes{} {}
 #endif
 /** \brief Device type string
- *
- * Valid settings are one of: "CPU_FP32", "GPU_FP32", "GPU_FP16", "MYRIAD_FP16", "VAD-M_FP16" or "VAD-F_FP32"
- */
+ *
+ * Valid settings are one of: "CPU_FP32", "CPU_FP16", "GPU_FP32", "GPU_FP16", "MYRIAD_FP16", "VAD-M_FP16" or "VAD-F_FP32"
+ */
 const char* device_type;
 unsigned char enable_vpu_fast_compile; ///< 0 = disabled, nonzero = enabled
 const char* device_id;
 size_t num_of_threads; ///< 0 = Use default number of threads
- unsigned char use_compiled_network; ///< 0 = disabled, nonzero = enabled
- const char* blob_dump_path; // path is set to empty by default
+ const char* cache_dir; // path is set to empty by default
 void* context;
- unsigned char enable_opencl_throttling; ///< 0 = disabled, nonzero = enabled
- unsigned char enable_dynamic_shapes; ///< 0 = disabled, nonzero = enabled
+ unsigned char enable_opencl_throttling; ///< 0 = disabled, nonzero = enabled
+ unsigned char enable_dynamic_shapes; ///< 0 = disabled, nonzero = enabled
 } OrtOpenVINOProviderOptions;
 
 struct OrtApi;
 typedef struct OrtApi OrtApi;
 
+struct OrtTrainingApi;
+typedef struct OrtTrainingApi OrtTrainingApi;
+
 /** \brief The helper interface to get the right version of OrtApi
-*
-* Get a pointer to this structure through ::OrtGetApiBase
-*/
+ *
+ * Get a pointer to this structure through ::OrtGetApiBase
+ */
 struct OrtApiBase {
 /** \brief Get a pointer to the requested version of the ::OrtApi
- *
- * \paramin version Must be ::ORT_API_VERSION
- * \return The ::OrtApi for the version requested, nullptr will be returned if this version is unsupported, for example when using a runtime
- * older than the version created with this header file.
- */
+ *
+ * \paramin version Must be ::ORT_API_VERSION
+ * \return The ::OrtApi for the version requested, nullptr will be returned if this version is unsupported, for example when using a runtime
+ * older than the version created with this header file.
+ */
 const OrtApi*(ORT_API_CALL* GetApi)(uint32_t version)NO_EXCEPTION;
 const char*(ORT_API_CALL* GetVersionString)(void)NO_EXCEPTION; ///< Returns a null terminated string of the version of the Onnxruntime library (eg: "1.8.1")
 };
 typedef struct OrtApiBase OrtApiBase;
 
 /** \brief The Onnxruntime library's entry point to access the C API
-*
-* Call this to get the a pointer to an ::OrtApiBase
-*/
+ *
+ * Call this to get the a pointer to an ::OrtApiBase
+ */
 ORT_EXPORT const OrtApiBase* ORT_API_CALL OrtGetApiBase(void) NO_EXCEPTION;
 
 /** \brief Thread work loop function
-*
-* Onnxruntime will provide the working loop on custom thread creation
-* Argument is an onnxruntime built-in type which will be provided when thread pool calls OrtCustomCreateThreadFn
-*/
+ *
+ * Onnxruntime will provide the working loop on custom thread creation
+ * Argument is an onnxruntime built-in type which will be provided when thread pool calls OrtCustomCreateThreadFn
+ */
 typedef void (*OrtThreadWorkerFn)(void* ort_worker_fn_param);
 
-typedef const struct OrtCustomHandleType { char __place_holder; } * OrtCustomThreadHandle;
+typedef const struct OrtCustomHandleType {
+ char __place_holder;
+}* OrtCustomThreadHandle;
 
 /** \brief Ort custom thread creation function
-*
-* The function should return a thread handle to be used in onnxruntime thread pools
-* Onnxruntime will throw exception on return value of nullptr or 0, indicating that the function failed to create a thread
-*/
+ *
+ * The function should return a thread handle to be used in onnxruntime thread pools
+ * Onnxruntime will throw exception on return value of nullptr or 0, indicating that the function failed to create a thread
+ */
 typedef OrtCustomThreadHandle (*OrtCustomCreateThreadFn)(void* ort_custom_thread_creation_options, OrtThreadWorkerFn ort_thread_worker_fn, void* ort_worker_fn_param);
 
 /** \brief Custom thread join function
-*
-* Onnxruntime thread pool destructor will call the function to join a custom thread.
-* Argument ort_custom_thread_handle is the value returned by OrtCustomCreateThreadFn
-*/
+ *
+ * Onnxruntime thread pool destructor will call the function to join a custom thread.
+ * Argument ort_custom_thread_handle is the value returned by OrtCustomCreateThreadFn
+ */
 typedef void (*OrtCustomJoinThreadFn)(OrtCustomThreadHandle ort_custom_thread_handle);
 
+typedef OrtStatus*(ORT_API_CALL* RegisterCustomOpsFn)(OrtSessionOptions* options, const OrtApiBase* api);
+
 /** \brief The C API
-*
-* All C API functions are defined inside this structure as pointers to functions.
-* Call OrtApiBase::GetApi to get a pointer to it
-*
-* \nosubgrouping
-*/
+ *
+ * All C API functions are defined inside this structure as pointers to functions.
+ * Call OrtApiBase::GetApi to get a pointer to it
+ *
+ * \nosubgrouping
+ */
 struct OrtApi {
 /// \name OrtStatus
 /// @{
 
 /**
- * \brief Create an OrtStatus from a null terminated string
- *
- * \paramin code
- * \paramin msg A null-terminated string. Its contents will be copied.
- * \return A new OrtStatus object, must be destroyed with OrtApi::ReleaseStatus
- */
+ * \brief Create an OrtStatus from a null terminated string
+ *
+ * \paramin code
+ * \paramin msg A null-terminated string. Its contents will be copied.
+ * \return A new OrtStatus object, must be destroyed with OrtApi::ReleaseStatus
+ */
 OrtStatus*(ORT_API_CALL* CreateStatus)(OrtErrorCode code, _In_ const char* msg)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
 
 /** \brief Get OrtErrorCode from OrtStatus
- *
- * \paramin status
- * \return OrtErrorCode that \p status was created with
- */
+ *
+ * \paramin status
+ * \return OrtErrorCode that \p status was created with
+ */
 OrtErrorCode(ORT_API_CALL* GetErrorCode)(_In_ const OrtStatus* status) NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
 
 /** \brief Get error string from OrtStatus
- *
- * \paramin status
- * \return The error message inside the `status`. Do not free the returned value.
- */
+ *
+ * \paramin status
+ * \return The error message inside the `status`. Do not free the returned value.
+ */
 const char*(ORT_API_CALL* GetErrorMessage)(_In_ const OrtStatus* status)NO_EXCEPTION ORT_ALL_ARGS_NONNULL;
 
 /// @}
@@ -621,44 +666,44 @@
 /// @{
 
 /** \brief Create an OrtEnv
- *
- * \paramin log_severity_level The log severity level.
- * \paramin logid The log identifier.
- * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin log_severity_level The log severity level.
+ * \paramin logid The log identifier.
+ * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateEnv, OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
 
 /** \brief Create an OrtEnv
- *
- * \paramin logging_function A pointer to a logging function.
- * \paramin logger_param A pointer to arbitrary data passed as the ::OrtLoggingFunction `param` parameter to
- * `logging_function`.
- * \paramin log_severity_level The log severity level.
- * \paramin logid The log identifier.
- * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin logging_function A pointer to a logging function.
+ * \paramin logger_param A pointer to arbitrary data passed as the ::OrtLoggingFunction `param` parameter to
+ * `logging_function`.
+ * \paramin log_severity_level The log severity level.
+ * \paramin logid The log identifier.
+ * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateEnvWithCustomLogger, OrtLoggingFunction logging_function, _In_opt_ void* logger_param,
 OrtLoggingLevel log_severity_level, _In_ const char* logid, _Outptr_ OrtEnv** out);
 
 /** \brief Enable Telemetry
- *
- * \note Telemetry events are on by default since they are lightweight
- * \paramin env
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \note Telemetry events are on by default since they are lightweight
+ * \paramin env
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(EnableTelemetryEvents, _In_ const OrtEnv* env);
 /** \brief Disable Telemetry
- *
- * \see OrtApi::EnableTelemetryEvents
- * \paramin env
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::EnableTelemetryEvents
+ * \paramin env
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(DisableTelemetryEvents, _In_ const OrtEnv* env);
 
 /// @}
@@ -666,14 +711,14 @@
 /// @{
 
 /** \brief Create an OrtSession from a model file
- *
- * \paramin env
- * \paramin model_path
- * \paramin options
- * \paramout out Returned newly created OrtSession. Must be freed with OrtApi::ReleaseSession
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin env
+ * \paramin model_path
+ * \paramin options
+ * \paramout out Returned newly created OrtSession. Must be freed with OrtApi::ReleaseSession
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 // TODO: document the path separator convention? '/' vs '\'
 // TODO: should specify the access characteristics of model_path. Is this read only during the
 // execution of CreateSession, or does the OrtSession retain a handle to the file/directory
@@ -683,36 +728,36 @@
 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
 
 /** \brief Create an OrtSession from memory
- *
- * \paramin env
- * \paramin model_data
- * \paramin model_data_length
- * \paramin options
- * \paramout out Returned newly created OrtSession. Must be freed with OrtApi::ReleaseSession
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin env
+ * \paramin model_data
+ * \paramin model_data_length
+ * \paramin options
+ * \paramout out Returned newly created OrtSession. Must be freed with OrtApi::ReleaseSession
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSessionFromArray, _In_ const OrtEnv* env, _In_ const void* model_data, size_t model_data_length,
 _In_ const OrtSessionOptions* options, _Outptr_ OrtSession** out);
 
 /** \brief Run the model in an ::OrtSession
- *
- * Will not return until the model run has completed. Multiple threads might be used to run the model based on
- * the options in the ::OrtSession and settings used when creating the ::OrtEnv
- *
- * \paramin session
- * \paramin run_options If nullptr, will use a default ::OrtRunOptions
- * \paramin input_names Array of null terminated UTF8 encoded strings of the input names
- * \paramin inputs Array of ::OrtValue%s of the input values
- * \paramin input_len Number of elements in the input_names and inputs arrays
- * \paramin output_names Array of null terminated UTF8 encoded strings of the output names
- * \paramin output_names_len Number of elements in the output_names and outputs array
- * \paramout outputs Array of ::OrtValue%s that the outputs are stored in. This can also be
- * an array of nullptr values, in this case ::OrtValue objects will be allocated and pointers
- * to them will be set into the `outputs` array.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Will not return until the model run has completed. Multiple threads might be used to run the model based on
+ * the options in the ::OrtSession and settings used when creating the ::OrtEnv
+ *
+ * \paramin session
+ * \paramin run_options If nullptr, will use a default ::OrtRunOptions
+ * \paramin input_names Array of null terminated UTF8 encoded strings of the input names
+ * \paramin inputs Array of ::OrtValue%s of the input values
+ * \paramin input_len Number of elements in the input_names and inputs arrays
+ * \paramin output_names Array of null terminated UTF8 encoded strings of the output names
+ * \paramin output_names_len Number of elements in the output_names and outputs array
+ * \paramout outputs Array of ::OrtValue%s that the outputs are stored in. This can also be
+ * an array of nullptr values, in this case ::OrtValue objects will be allocated and pointers
+ * to them will be set into the `outputs` array.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(Run, _Inout_ OrtSession* session, _In_opt_ const OrtRunOptions* run_options,
 _In_reads_(input_len) const char* const* input_names,
 _In_reads_(input_len) const OrtValue* const* inputs, size_t input_len,
@@ -724,182 +769,182 @@
 /// @{
 
 /** \brief Create an ::OrtSessionOptions object
- *
- * To use additional providers, you must build ORT with the extra providers enabled. Then call one of these
- * functions to enable them in the session: 
- * OrtSessionOptionsAppendExecutionProvider_CPU 
- * OrtSessionOptionsAppendExecutionProvider_CUDA 
- * OrtSessionOptionsAppendExecutionProvider_(remaining providers...) 
- * The order they are called indicates the preference order as well. In other words call this method
- * on your most preferred execution provider first followed by the less preferred ones.
- * If none are called Ort will use its internal CPU execution provider.
- *
- * \paramout options The newly created OrtSessionOptions. Must be freed with OrtApi::ReleaseSessionOptions
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * To use additional providers, you must build ORT with the extra providers enabled. Then call one of these
+ * functions to enable them in the session: 
+ * OrtSessionOptionsAppendExecutionProvider_CPU 
+ * OrtSessionOptionsAppendExecutionProvider_CUDA 
+ * OrtSessionOptionsAppendExecutionProvider_(remaining providers...) 
+ * The order they are called indicates the preference order as well. In other words call this method
+ * on your most preferred execution provider first followed by the less preferred ones.
+ * If none are called Ort will use its internal CPU execution provider.
+ *
+ * \paramout options The newly created OrtSessionOptions. Must be freed with OrtApi::ReleaseSessionOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSessionOptions, _Outptr_ OrtSessionOptions** options);
 
 /** \brief Set filepath to save optimized model after graph level transformations
- *
- * \paramin options
- * \paramin optimized_model_filepath
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ * \paramin optimized_model_filepath
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetOptimizedModelFilePath, _Inout_ OrtSessionOptions* options,
 _In_ const ORTCHAR_T* optimized_model_filepath);
 
 /** \brief Create a copy of an existing ::OrtSessionOptions
- *
- * \paramin in_options OrtSessionOptions to copy
- * \paramout out_options Returned newly created ::OrtSessionOptions. Must be freed with OrtApi::ReleaseSessionOptions
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin in_options OrtSessionOptions to copy
+ * \paramout out_options Returned newly created ::OrtSessionOptions. Must be freed with OrtApi::ReleaseSessionOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CloneSessionOptions, _In_ const OrtSessionOptions* in_options,
 _Outptr_ OrtSessionOptions** out_options);
 
 /** \brief Set execution mode
- *
- * Controls whether you want to execute operators in your graph sequentially or in parallel. Usually when the model
- * has many branches, setting this option to ExecutionMode.ORT_PARALLEL will give you better performance.
- * See docs/ONNX_Runtime_Perf_Tuning.md for more details.
- *
- * \paramin options
- * \paramin execution_mode
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Controls whether you want to execute operators in your graph sequentially or in parallel. Usually when the model
+ * has many branches, setting this option to ExecutionMode.ORT_PARALLEL will give you better performance.
+ * See docs/ONNX_Runtime_Perf_Tuning.md for more details.
+ *
+ * \paramin options
+ * \paramin execution_mode
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetSessionExecutionMode, _Inout_ OrtSessionOptions* options, ExecutionMode execution_mode);
 
 /** \brief Enable profiling for a session
- *
- * \paramin options
- * \paramin profile_file_prefix
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ * \paramin profile_file_prefix
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(EnableProfiling, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* profile_file_prefix);
 
 /** \brief Disable profiling for a session
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(DisableProfiling, _Inout_ OrtSessionOptions* options);
 
 /** \brief Enable the memory pattern optimization
- *
- * The idea is if the input shapes are the same, we could trace the internal memory allocation
- * and generate a memory pattern for future request. So next time we could just do one allocation
- * with a big chunk for all the internal memory allocation.
- * \note Memory pattern optimization is only available when Sequential Execution mode is enabled (see OrtApi::SetSessionExecutionMode)
- *
- * \see OrtApi::DisableMemPattern
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * The idea is if the input shapes are the same, we could trace the internal memory allocation
+ * and generate a memory pattern for future request. So next time we could just do one allocation
+ * with a big chunk for all the internal memory allocation.
+ * \note Memory pattern optimization is only available when Sequential Execution mode is enabled (see OrtApi::SetSessionExecutionMode)
+ *
+ * \see OrtApi::DisableMemPattern
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(EnableMemPattern, _Inout_ OrtSessionOptions* options);
 
 /** \brief Disable the memory pattern optimization
- *
- * \see OrtApi::EnableMemPattern
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::EnableMemPattern
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(DisableMemPattern, _Inout_ OrtSessionOptions* options);
 
 /** \brief Enable the memory arena on CPU
- *
- * Arena may pre-allocate memory for future usage.
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Arena may pre-allocate memory for future usage.
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(EnableCpuMemArena, _Inout_ OrtSessionOptions* options);
 
 /** \brief Disable the memory arena on CPU
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(DisableCpuMemArena, _Inout_ OrtSessionOptions* options);
 
 /** \brief Set session log id
- *
- * \paramin options
- * \paramin logid The log identifier.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ * \paramin logid The log identifier.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetSessionLogId, _Inout_ OrtSessionOptions* options, const char* logid);
 
 /** \brief Set session log verbosity level
- *
- * Applies to session load, initialization, etc
- *
- * \paramin options
- * \paramin session_log_verbosity_level \snippet{doc} snippets.dox Log Verbosity Level
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Applies to session load, initialization, etc
+ *
+ * \paramin options
+ * \paramin session_log_verbosity_level \snippet{doc} snippets.dox Log Verbosity Level
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetSessionLogVerbosityLevel, _Inout_ OrtSessionOptions* options, int session_log_verbosity_level);
 
 /** \brief Set session log severity level
- *
- * \paramin options
- * \paramin session_log_severity_level The log severity level (refer to ::OrtLoggingLevel for possible values).
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options
+ * \paramin session_log_severity_level The log severity level (refer to ::OrtLoggingLevel for possible values).
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetSessionLogSeverityLevel, _Inout_ OrtSessionOptions* options, int session_log_severity_level);
 
 /** \brief Set the optimization level to apply when loading a graph
- *
- * Please see https://www.onnxruntime.ai/docs/resources/graph-optimizations.html for an in-depth explanation
- * \paramin,out options The session options object
- * \paramin graph_optimization_level The optimization level
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Please see https://www.onnxruntime.ai/docs/resources/graph-optimizations.html for an in-depth explanation
+ * \paramin,out options The session options object
+ * \paramin graph_optimization_level The optimization level
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetSessionGraphOptimizationLevel, _Inout_ OrtSessionOptions* options,
 GraphOptimizationLevel graph_optimization_level);
 
 /** \brief Sets the number of threads used to parallelize the execution within nodes
- *
- * When running a single node operation, ex. add, this sets the maximum number of threads to use.
- *
- * \note If built with OpenMP, this has no effect on the number of threads used. In this case
- * use the OpenMP env variables to configure the number of intra op num threads.
- *
- * \paramin options
- * \paramin intra_op_num_threads Number of threads to use 
- * A value of 0 will use the default number of threads 
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * When running a single node operation, ex. add, this sets the maximum number of threads to use.
+ *
+ * \note If built with OpenMP, this has no effect on the number of threads used. In this case
+ * use the OpenMP env variables to configure the number of intra op num threads.
+ *
+ * \paramin options
+ * \paramin intra_op_num_threads Number of threads to use 
+ * A value of 0 will use the default number of threads 
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetIntraOpNumThreads, _Inout_ OrtSessionOptions* options, int intra_op_num_threads);
 
 /** \brief Sets the number of threads used to parallelize the execution of the graph
- *
- * If nodes can be run in parallel, this sets the maximum number of threads to use to run them in parallel.
- *
- * \note If sequential execution is enabled this value is ignored, it acts as if it was set to 1.
- *
- * \paramin options
- * \paramin inter_op_num_threads Number of threads to use 
- * A value of 0 will use the default number of threads 
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If nodes can be run in parallel, this sets the maximum number of threads to use to run them in parallel.
+ *
+ * \note If sequential execution is enabled this value is ignored, it acts as if it was set to 1.
+ *
+ * \paramin options
+ * \paramin inter_op_num_threads Number of threads to use 
+ * A value of 0 will use the default number of threads 
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetInterOpNumThreads, _Inout_ OrtSessionOptions* options, int inter_op_num_threads);
 
 /// @}
@@ -907,23 +952,23 @@
 /// @{
 
 /** \brief Create a custom op domain
- *
- * \paramin domain
- * \paramout out Newly created domain. Must be freed with OrtApi::ReleaseCustomOpDomain
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin domain
+ * \paramout out Newly created domain. Must be freed with OrtApi::ReleaseCustomOpDomain
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateCustomOpDomain, _In_ const char* domain, _Outptr_ OrtCustomOpDomain** out);
 
 /** \brief Add a custom op to a custom op domain
- *
- * \note The OrtCustomOp* pointer must remain valid until the ::OrtCustomOpDomain using it is released
- *
- * \paramin custom_op_domain
- * \paramin op
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \note The OrtCustomOp* pointer must remain valid until the ::OrtCustomOpDomain using it is released
+ *
+ * \paramin custom_op_domain
+ * \paramin op
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CustomOpDomain_Add, _Inout_ OrtCustomOpDomain* custom_op_domain, _In_ const OrtCustomOp* op);
 
 /// @}
@@ -931,30 +976,32 @@
 /// @{
 
 /** \brief Add custom op domain to a session options
- *
- * \note The OrtCustomOpDomain* must not be deleted until all sessions using it are released
- *
- * \paramin options
- * \paramin custom_op_domain
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \note The OrtCustomOpDomain* must not be deleted until all sessions using it are released
+ *
+ * \paramin options
+ * \paramin custom_op_domain
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(AddCustomOpDomain, _Inout_ OrtSessionOptions* options, _In_ OrtCustomOpDomain* custom_op_domain);
 
- /** \brief Register custom ops from a shared library
- *
- * Loads a shared library (dll on windows, so on linux, etc) named 'library_path' and looks for this entry point:
- *		OrtStatus* RegisterCustomOps(OrtSessionOptions * options, const OrtApiBase* api);
- * It then passes in the provided session options to this function along with the api base.
- * The handle to the loaded library is returned in library_handle. It can be freed by the caller after all sessions using the passed in
- * session options are destroyed, or if an error occurs and it is non null.
- *
- * \paramin options
- * \paramin library_path
- * \paramout library_handle OS specific handle to the loaded library (Use FreeLibrary on Windows, dlclose on Linux, etc.. to unload)
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ /** \deprecated Use OrtApi::RegisterCustomOpsLibrary_V2.
+ *
+ * Registers custom ops from a shared library.
+ *
+ * Loads a shared library (dll on windows, so on linux, etc) named 'library_path' and looks for this entry point:
+ *		OrtStatus* RegisterCustomOps(OrtSessionOptions * options, const OrtApiBase* api);
+ * It then passes in the provided session options to this function along with the api base.
+ * The handle to the loaded library is returned in library_handle. It can be freed by the caller after all sessions using the passed in
+ * session options are destroyed, or if an error occurs and it is non null.
+ *
+ * \paramin options
+ * \paramin library_path
+ * \paramout library_handle OS specific handle to the loaded library (Use FreeLibrary on Windows, dlclose on Linux, etc.. to unload)
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(RegisterCustomOpsLibrary, _Inout_ OrtSessionOptions* options, _In_ const char* library_path, _Outptr_ void** library_handle);
 
 /// @}
@@ -962,103 +1009,103 @@
 /// @{
 
 /** \brief Get input count for a session
- *
- * This number must also match the number of inputs passed to OrtApi::Run
- *
- * \see OrtApi::SessionGetInputTypeInfo, OrtApi::SessionGetInputName, OrtApi::Session
- *
- * \paramin session
- * \paramout out Number of inputs
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This number must also match the number of inputs passed to OrtApi::Run
+ *
+ * \see OrtApi::SessionGetInputTypeInfo, OrtApi::SessionGetInputName, OrtApi::Session
+ *
+ * \paramin session
+ * \paramout out Number of inputs
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetInputCount, _In_ const OrtSession* session, _Out_ size_t* out);
 
 /** \brief Get output count for a session
- *
- * This number must also match the number of outputs returned by OrtApi::Run
- *
- * \see OrtApi::SessionGetOutputTypeInfo, OrtApi::SessionGetOutputName, OrtApi::Session
- *
- * \paramin session
- * \paramout out Number of outputs
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This number must also match the number of outputs returned by OrtApi::Run
+ *
+ * \see OrtApi::SessionGetOutputTypeInfo, OrtApi::SessionGetOutputName, OrtApi::Session
+ *
+ * \paramin session
+ * \paramout out Number of outputs
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOutputCount, _In_ const OrtSession* session, _Out_ size_t* out);
 
 /** \brief Get overridable initializer count
- *
- * \see OrtApi::SessionGetOverridableInitializerTypeInfo, OrtApi::SessionGetOverridableInitializerName
- *
- * \paramin session
- * \paramin out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::SessionGetOverridableInitializerTypeInfo, OrtApi::SessionGetOverridableInitializerName
+ *
+ * \paramin session
+ * \paramin out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOverridableInitializerCount, _In_ const OrtSession* session, _Out_ size_t* out);
 
 /** \brief Get input type information
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetInputCount returns (exclusive)
- * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetInputCount returns (exclusive)
+ * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetInputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
 
 /** \brief Get output type information
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOutputCount returns (exclusive)
- * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOutputCount returns (exclusive)
+ * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOutputTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
 
 /** \brief Get overridable initializer type information
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOverridableInitializerCount returns (exclusive)
- * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOverridableInitializerCount returns (exclusive)
+ * \paramout type_info Must be freed with OrtApi::ReleaseTypeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOverridableInitializerTypeInfo, _In_ const OrtSession* session, size_t index, _Outptr_ OrtTypeInfo** type_info);
 
 /** \brief Get input name
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetInputCount returns (exclusive)
- * \paramin allocator
- * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetInputCount returns (exclusive)
+ * \paramin allocator
+ * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetInputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
 /** \brief Get output name
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOutputCount returns (exclusive)
- * \paramin allocator
- * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOutputCount returns (exclusive)
+ * \paramin allocator
+ * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOutputName, _In_ const OrtSession* session, size_t index, _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
 /** \brief Get overridable initializer name
- *
- * \paramin session
- * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOverridableInitializerCount returns (exclusive)
- * \paramin allocator
- * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin index Must be between 0 (inclusive) and what OrtApi::SessionGetOverridableInitializerCount returns (exclusive)
+ * \paramin allocator
+ * \paramout value Set to a null terminated UTF-8 encoded string allocated using `allocator`. Must be freed using `allocator`.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetOverridableInitializerName, _In_ const OrtSession* session, size_t index,
 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
@@ -1067,11 +1114,11 @@
 /// @{
 
 /** \brief Create an OrtRunOptions
- *
- * \paramout out Returned newly created ::OrtRunOptions. Must be freed with OrtApi::ReleaseRunOptions
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramout out Returned newly created ::OrtRunOptions. Must be freed with OrtApi::ReleaseRunOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateRunOptions, _Outptr_ OrtRunOptions** out);
 
 /** \brief Set per-run log verbosity level
@@ -1140,23 +1187,23 @@
 ORT_API2_STATUS(RunOptionsGetRunTag, _In_ const OrtRunOptions* options, _Out_ const char** run_tag);
 
 /** \brief Set terminate flag
- *
- * If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error.
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error.
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(RunOptionsSetTerminate, _Inout_ OrtRunOptions* options);
 
 /** \brief Clears the terminate flag
- *
- * Used so the OrtRunOptions instance can be used in a new OrtApi::Run call without it instantly terminating
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Used so the OrtRunOptions instance can be used in a new OrtApi::Run call without it instantly terminating
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(RunOptionsUnsetTerminate, _Inout_ OrtRunOptions* options);
 
 /// @}
@@ -1164,100 +1211,100 @@
 /// @{
 
 /** \brief Create a tensor
- *
- * Create a tensor using a supplied ::OrtAllocator
- *
- * \paramin allocator
- * \paramin shape Pointer to the tensor shape dimensions.
- * \paramin shape_len The number of tensor shape dimensions.
- * \paramin type
- * \paramout out Returns newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Create a tensor using a supplied ::OrtAllocator
+ *
+ * \paramin allocator
+ * \paramin shape Pointer to the tensor shape dimensions.
+ * \paramin shape_len The number of tensor shape dimensions.
+ * \paramin type
+ * \paramout out Returns newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* shape, size_t shape_len,
 ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
 
 /** \brief Create a tensor backed by a user supplied buffer
- *
- * Create a tensor with user's buffer. You can fill the buffer either before calling this function or after.
- * p_data is owned by caller. ReleaseValue won't release p_data.
- *
- * \paramin info Memory description of where the p_data buffer resides (CPU vs GPU etc).
- * \paramin p_data Pointer to the data buffer.
- * \paramin p_data_len The number of bytes in the data buffer.
- * \paramin shape Pointer to the tensor shape dimensions.
- * \paramin shape_len The number of tensor shape dimensions.
- * \paramin type The data type.
- * \paramout out Returns newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Create a tensor with user's buffer. You can fill the buffer either before calling this function or after.
+ * p_data is owned by caller. ReleaseValue won't release p_data.
+ *
+ * \paramin info Memory description of where the p_data buffer resides (CPU vs GPU etc).
+ * \paramin p_data Pointer to the data buffer.
+ * \paramin p_data_len The number of bytes in the data buffer.
+ * \paramin shape Pointer to the tensor shape dimensions.
+ * \paramin shape_len The number of tensor shape dimensions.
+ * \paramin type The data type.
+ * \paramout out Returns newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateTensorWithDataAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
 size_t p_data_len, _In_ const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type,
 _Outptr_ OrtValue** out);
 
 /** \brief Return if an ::OrtValue is a tensor type
- *
- * \paramin value A tensor type (string tensors are not supported)
- * \paramout out Set to 1 iff ::OrtValue is a tensor, 0 otherwise
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value A tensor type (string tensors are not supported)
+ * \paramout out Set to 1 iff ::OrtValue is a tensor, 0 otherwise
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(IsTensor, _In_ const OrtValue* value, _Out_ int* out);
 
 /** \brief Get a pointer to the raw data inside a tensor
- *
- * Used to read/write/modify the internal tensor data directly.
- * \note The returned pointer is valid until the \p value is destroyed.
- *
- * \paramin value A tensor type (string tensors are not supported)
- * \paramout out Filled in with a pointer to the internal storage
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Used to read/write/modify the internal tensor data directly.
+ * \note The returned pointer is valid until the \p value is destroyed.
+ *
+ * \paramin value A tensor type (string tensors are not supported)
+ * \paramout out Filled in with a pointer to the internal storage
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTensorMutableData, _In_ OrtValue* value, _Outptr_ void** out);
 
 /** \brief Set all strings at once in a string tensor
- *
- * \paramin,out value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
- * \paramin s An array of strings. Each string in this array must be null terminated.
- * \paramin s_len Count of strings in s (Must match the size of \p value's tensor shape)
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin,out value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
+ * \paramin s An array of strings. Each string in this array must be null terminated.
+ * \paramin s_len Count of strings in s (Must match the size of \p value's tensor shape)
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(FillStringTensor, _Inout_ OrtValue* value, _In_ const char* const* s, size_t s_len);
 
 /** \brief Get total byte length for all strings in a string tensor
- *
- * Typically used with OrtApi::GetStringTensorContent
- *
- * \paramin value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
- * \paramout len Total byte length of all strings (does not include trailing nulls)
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Typically used with OrtApi::GetStringTensorContent
+ *
+ * \paramin value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
+ * \paramout len Total byte length of all strings (does not include trailing nulls)
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetStringTensorDataLength, _In_ const OrtValue* value, _Out_ size_t* len);
 
 /** \brief Get all strings from a string tensor
- *
- * An example of the results: 
- * Given \p value is a string tensor with the strings { "This" "is" "a" "test" } 
- * \p s must have a size of 11 bytes 
- * \p offsets must have 4 elements 
- * After the call, these values will be filled in: 
- * \p s will contain "Thisisatest" 
- * \p offsets will contain { 0, 4, 6, 7 } 
- * The length of the last string is just s_len - offsetslast
- *
- * \paramin value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
- * \paramin s Buffer to sequentially write all tensor strings to. Each string is NOT null-terminated.
- * \paramin s_len Number of bytes of buffer pointed to by \p s (Get it from OrtApi::GetStringTensorDataLength)
- * \paramout offsets Array of start offsets into the strings written to \p s
- * \paramin offsets_len Number of elements in offsets
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * An example of the results: 
+ * Given \p value is a string tensor with the strings { "This" "is" "a" "test" } 
+ * \p s must have a size of 11 bytes 
+ * \p offsets must have 4 elements 
+ * After the call, these values will be filled in: 
+ * \p s will contain "Thisisatest" 
+ * \p offsets will contain { 0, 4, 6, 7 } 
+ * The length of the last string is just s_len - offsetslast
+ *
+ * \paramin value A tensor of type ONNX_TENSOR_ELEMENT_DATA_TYPE_STRING
+ * \paramin s Buffer to sequentially write all tensor strings to. Each string is NOT null-terminated.
+ * \paramin s_len Number of bytes of buffer pointed to by \p s (Get it from OrtApi::GetStringTensorDataLength)
+ * \paramout offsets Array of start offsets into the strings written to \p s
+ * \paramin offsets_len Number of elements in offsets
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetStringTensorContent, _In_ const OrtValue* value, _Out_writes_bytes_all_(s_len) void* s,
 size_t s_len, _Out_writes_all_(offsets_len) size_t* offsets, size_t offsets_len);
 
@@ -1266,22 +1313,22 @@
 /// @{
 
 /** \brief Get ::OrtTensorTypeAndShapeInfo from an ::OrtTypeInfo
- *
- * \paramin type_info
- * \paramout out Do not free this value, it will be valid until type_info is freed.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin type_info
+ * \paramout out Do not free this value, it will be valid until type_info is freed.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CastTypeInfoToTensorInfo, _In_ const OrtTypeInfo* type_info,
 _Outptr_result_maybenull_ const OrtTensorTypeAndShapeInfo** out);
 
 /** \brief Get ::ONNXType from ::OrtTypeInfo
- *
- * \paramin type_info
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin type_info
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetOnnxTypeFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ enum ONNXType* out);
 
 /// @}
@@ -1289,93 +1336,93 @@
 /// @{
 
 /** \brief Create an ::OrtTensorTypeAndShapeInfo object
- *
- * \paramout out Returns newly created ::OrtTensorTypeAndShapeInfo. Must be freed with OrtApi::ReleaseTensorTypeAndShapeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramout out Returns newly created ::OrtTensorTypeAndShapeInfo. Must be freed with OrtApi::ReleaseTensorTypeAndShapeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateTensorTypeAndShapeInfo, _Outptr_ OrtTensorTypeAndShapeInfo** out);
 
 /** \brief Set element type in ::OrtTensorTypeAndShapeInfo
- *
- * \paramin info
- * \paramin type
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info
+ * \paramin type
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetTensorElementType, _Inout_ OrtTensorTypeAndShapeInfo* info, enum ONNXTensorElementDataType type);
 
 /** \brief Set shape information in ::OrtTensorTypeAndShapeInfo
- *
- * \paramin info
- * \paramin dim_values Array with `dim_count` elements. Can contain negative values.
- * \paramin dim_count Number of elements in `dim_values`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info
+ * \paramin dim_values Array with `dim_count` elements. Can contain negative values.
+ * \paramin dim_count Number of elements in `dim_values`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetDimensions, OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
 
 /** \brief Get element type in ::OrtTensorTypeAndShapeInfo
- *
- * \see OrtApi::SetTensorElementType
- *
- * \paramin info
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::SetTensorElementType
+ *
+ * \paramin info
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTensorElementType, _In_ const OrtTensorTypeAndShapeInfo* info,
 _Out_ enum ONNXTensorElementDataType* out);
 
 /** \brief Get dimension count in ::OrtTensorTypeAndShapeInfo
- *
- * \see OrtApi::GetDimensions
- *
- * \paramin info
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::GetDimensions
+ *
+ * \paramin info
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetDimensionsCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
 
 /** \brief Get dimensions in ::OrtTensorTypeAndShapeInfo
- *
- * \paramin info
- * \paramout dim_values Array with `dim_values_length` elements. On return, filled with the dimensions stored in the ::OrtTensorTypeAndShapeInfo
- * \paramin dim_values_length Number of elements in `dim_values`. Use OrtApi::GetDimensionsCount to get this value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info
+ * \paramout dim_values Array with `dim_values_length` elements. On return, filled with the dimensions stored in the ::OrtTensorTypeAndShapeInfo
+ * \paramin dim_values_length Number of elements in `dim_values`. Use OrtApi::GetDimensionsCount to get this value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetDimensions, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values,
 size_t dim_values_length);
 
 /** \brief Get symbolic dimension names in ::OrtTensorTypeAndShapeInfo
- *
- * \paramin info
- * \paramin dim_params Array with `dim_params_length` elements. On return filled with pointers to null terminated strings of the dimension names
- * \paramin dim_params_length Number of elements in `dim_params`. Use OrtApi::GetDimensionsCount to get this value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info
+ * \paramin dim_params Array with `dim_params_length` elements. On return filled with pointers to null terminated strings of the dimension names
+ * \paramin dim_params_length Number of elements in `dim_params`. Use OrtApi::GetDimensionsCount to get this value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSymbolicDimensions, _In_ const OrtTensorTypeAndShapeInfo* info,
 _Out_writes_all_(dim_params_length) const char* dim_params, size_t dim_params_length);
 
 /** \brief Get total number of elements in a tensor shape from an ::OrtTensorTypeAndShapeInfo
- *
- * Return the number of elements specified by the tensor shape (all dimensions multiplied by each other).
- * For 0 dimensions, 1 is returned. If any dimension is less than 0, the result is always -1.
- *
- * Examples: 
- * = 1 
- * 1,3,4 = 12 
- * 2,0,4 = 0 
- * -1,3,4 = -1 
- *
- * \paramin info
- * \paramout out Number of elements
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Return the number of elements specified by the tensor shape (all dimensions multiplied by each other).
+ * For 0 dimensions, 1 is returned. If any dimension is less than 0, the result is always -1.
+ *
+ * Examples: 
+ * = 1 
+ * 1,3,4 = 12 
+ * 2,0,4 = 0 
+ * -1,3,4 = -1 
+ *
+ * \paramin info
+ * \paramout out Number of elements
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTensorShapeElementCount, _In_ const OrtTensorTypeAndShapeInfo* info, _Out_ size_t* out);
 
 /// @}
@@ -1383,30 +1430,30 @@
 /// @{
 
 /** \brief Get type and shape information from a tensor ::OrtValue
- *
- * \paramin value Must be a tensor (not a map/sequence/etc) or will return failure
- * \paramout out Newly created ::OrtTensorTypeAndShapeInfo. Must be freed with OrtApi::ReleaseTensorTypeAndShapeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value Must be a tensor (not a map/sequence/etc) or will return failure
+ * \paramout out Newly created ::OrtTensorTypeAndShapeInfo. Must be freed with OrtApi::ReleaseTensorTypeAndShapeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTensorTypeAndShape, _In_ const OrtValue* value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
 
 /** \brief Get type information of an OrtValue
- *
- * \paramin value
- * \paramout out Newly created ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value
+ * \paramout out Newly created ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTypeInfo, _In_ const OrtValue* value, _Outptr_result_maybenull_ OrtTypeInfo** out);
 
 /** \brief Get ONNXType of an ::OrtValue
- *
- * \paramin value
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetValueType, _In_ const OrtValue* value, _Out_ enum ONNXType* out);
 
 /// @}
@@ -1414,62 +1461,62 @@
 /// @{
 
 /** \brief Create an ::OrtMemoryInfo
- *
- * \paramin name
- * \paramin type
- * \paramin id
- * \paramin mem_type
- * \paramout out Newly created ::OrtMemoryInfo. Must be freed with OrtAPi::ReleaseMemoryInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin name
+ * \paramin type
+ * \paramin id
+ * \paramin mem_type
+ * \paramout out Newly created ::OrtMemoryInfo. Must be freed with OrtAPi::ReleaseMemoryInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateMemoryInfo, _In_ const char* name, enum OrtAllocatorType type, int id,
 enum OrtMemType mem_type, _Outptr_ OrtMemoryInfo** out);
 
 /** \brief Create an ::OrtMemoryInfo for CPU memory
- *
- * Special case version of OrtApi::CreateMemoryInfo for CPU based memory. Same as using OrtApi::CreateMemoryInfo with name = "Cpu" and id = 0.
- *
- * \paramin type
- * \paramin mem_type
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Special case version of OrtApi::CreateMemoryInfo for CPU based memory. Same as using OrtApi::CreateMemoryInfo with name = "Cpu" and id = 0.
+ *
+ * \paramin type
+ * \paramin mem_type
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateCpuMemoryInfo, enum OrtAllocatorType type, enum OrtMemType mem_type,
 _Outptr_ OrtMemoryInfo** out);
 
 /** \brief Compare ::OrtMemoryInfo objects for equality
- *
- * Compares all settings of each ::OrtMemoryInfo for equality
- *
- * \paramin info1
- * \paramin info2
- * \paramout out Set to 0 if equal, -1 if not equal
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Compares all settings of each ::OrtMemoryInfo for equality
+ *
+ * \paramin info1
+ * \paramin info2
+ * \paramout out Set to 0 if equal, -1 if not equal
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CompareMemoryInfo, _In_ const OrtMemoryInfo* info1, _In_ const OrtMemoryInfo* info2, _Out_ int* out);
 
 /** \brief Get name from ::OrtMemoryInfo
- *
- * \paramin ptr
- * \paramout out Writes null terminated string to this pointer. Do NOT free the returned pointer. It is valid for the lifetime of the ::OrtMemoryInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ptr
+ * \paramout out Writes null terminated string to this pointer. Do NOT free the returned pointer. It is valid for the lifetime of the ::OrtMemoryInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(MemoryInfoGetName, _In_ const OrtMemoryInfo* ptr, _Out_ const char** out);
 
 /** \brief Get the id from ::OrtMemoryInfo
- */
+ */
 ORT_API2_STATUS(MemoryInfoGetId, _In_ const OrtMemoryInfo* ptr, _Out_ int* out);
 
 /** \brief Get the ::OrtMemType from ::OrtMemoryInfo
- */
+ */
 ORT_API2_STATUS(MemoryInfoGetMemType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtMemType* out);
 
 /** \brief Get the ::OrtAllocatorType from ::OrtMemoryInfo
- */
+ */
 ORT_API2_STATUS(MemoryInfoGetType, _In_ const OrtMemoryInfo* ptr, _Out_ OrtAllocatorType* out);
 
 /// @}
@@ -1484,13 +1531,13 @@
 ORT_API2_STATUS(AllocatorGetInfo, _In_ const OrtAllocator* ort_allocator, _Outptr_ const struct OrtMemoryInfo** out);
 
 /** \brief Get the default allocator
- *
- * The default allocator is a CPU based, non-arena. Always returns the same pointer to the same default allocator.
- *
- * \paramout out Returned value should NOT be freed
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * The default allocator is a CPU based, non-arena. Always returns the same pointer to the same default allocator.
+ *
+ * \paramout out Returned value should NOT be freed
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetAllocatorWithDefaultOptions, _Outptr_ OrtAllocator** out);
 
 /// @}
@@ -1498,16 +1545,16 @@
 /// @{
 
 /** \brief Override session symbolic dimensions
- *
- * Override symbolic dimensions (by specific denotation strings) with actual values if known at session initialization time to enable
- * optimizations that can take advantage of fixed values (such as memory planning, etc)
- *
- * \paramin options
- * \paramin dim_denotation
- * \paramin dim_value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Override symbolic dimensions (by specific denotation strings) with actual values if known at session initialization time to enable
+ * optimizations that can take advantage of fixed values (such as memory planning, etc)
+ *
+ * \paramin options
+ * \paramin dim_denotation
+ * \paramin dim_value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(AddFreeDimensionOverride, _Inout_ OrtSessionOptions* options, _In_ const char* dim_denotation,
 _In_ int64_t dim_value);
 
@@ -1516,196 +1563,198 @@
 /// @{
 
 /* Internal information (not seen in Doxygen)
- *
- * APIs to support non-tensor types - map and sequence.
- * Currently only the following types are supported
- * Note: the following types should be kept in sync with data_types.h
- * Map types
- * =========
- * std::map<std::string, std::string>
- * std::map<std::string, int64_t>
- * std::map<std::string, float>
- * std::map<std::string, double>
- * std::map<int64_t, std::string>
- * std::map<int64_t, int64_t>
- * std::map<int64_t, float>
- * std::map<int64_t, double>
- *
- * Sequence types
- * ==============
- * std::vector<std::string>
- * std::vector<int64_t>
- * std::vector<float>
- * std::vector<double>
- * std::vector<std::map<std::string, float>>
- * std::vector<std::map<int64_t, float>
- */
+ *
+ * APIs to support non-tensor types - map and sequence.
+ * Currently only the following types are supported
+ * Note: the following types should be kept in sync with data_types.h
+ * Map types
+ * =========
+ * std::map<std::string, std::string>
+ * std::map<std::string, int64_t>
+ * std::map<std::string, float>
+ * std::map<std::string, double>
+ * std::map<int64_t, std::string>
+ * std::map<int64_t, int64_t>
+ * std::map<int64_t, float>
+ * std::map<int64_t, double>
+ *
+ * Sequence types
+ * ==============
+ * std::vector<std::string>
+ * std::vector<int64_t>
+ * std::vector<float>
+ * std::vector<double>
+ * std::vector<std::map<std::string, float>>
+ * std::vector<std::map<int64_t, float>
+ */
 
 /** \brief Get non tensor data from an ::OrtValue
- *
- * If `value` is of type ONNX_TYPE_MAP, you need to retrieve the keys and values
- * separately. Use index=0 to retrieve keys and index=1 to retrieve values.
- * If `value` is of type ONNX_TYPE_SEQUENCE, use index to retrieve the index'th element
- * of the sequence.
- *
- * \paramin value
- * \paramin index See above for usage based on `value` type
- * \paramin allocator Allocator used to allocate ::OrtValue
- * \paramout out Created ::OrtValue that holds the element requested. Must be freed with OrtApi::ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If `value` is of type ONNX_TYPE_MAP, you need to retrieve the keys and values
+ * separately. Use index=0 to retrieve keys and index=1 to retrieve values.
+ * If `value` is of type ONNX_TYPE_SEQUENCE, use index to retrieve the index'th element
+ * of the sequence.
+ *
+ * \paramin value
+ * \paramin index See above for usage based on `value` type
+ * \paramin allocator Allocator used to allocate ::OrtValue
+ * \paramout out Created ::OrtValue that holds the element requested. Must be freed with OrtApi::ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetValue, _In_ const OrtValue* value, int index, _Inout_ OrtAllocator* allocator,
 _Outptr_ OrtValue** out);
 
 /** \brief Get non tensor value count from an ::OrtValue
- *
- * If `value` is of type ONNX_TYPE_MAP 2 will always be returned. For ONNX_TYPE_SEQUENCE
- * the number of elements in the sequence will be returned
- *
- * \paramin value
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If `value` is of type ONNX_TYPE_MAP 2 will always be returned. For ONNX_TYPE_SEQUENCE
+ * the number of elements in the sequence will be returned
+ *
+ * \paramin value
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetValueCount, _In_ const OrtValue* value, _Out_ size_t* out);
 
 /** \brief Create a map or sequence ::OrtValue
- *
- * To construct a map (ONNX_TYPE_MAP), use num_values = 2 and `in` should be an array of 2 ::OrtValue%s
- * representing keys and values. 
- *
- * To construct a sequence (ONNX_TYPE_SEQUENCE), use num_values = N where N is the number of the elements in the
- * sequence. 'in' should be an array of N ::OrtValue%s.
- *
- * \paramin in See above for details
- * \paramin num_values
- * \paramin value_type Must be either ONNX_TYPE_MAP or ONNX_TYPE_SEQUENCE
- * \paramout out Newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * To construct a map (ONNX_TYPE_MAP), use num_values = 2 and `in` should be an array of 2 ::OrtValue%s
+ * representing keys and values. 
+ *
+ * To construct a sequence (ONNX_TYPE_SEQUENCE), use num_values = N where N is the number of the elements in the
+ * sequence. 'in' should be an array of N ::OrtValue%s.
+ *
+ * \paramin in See above for details
+ * \paramin num_values
+ * \paramin value_type Must be either ONNX_TYPE_MAP or ONNX_TYPE_SEQUENCE
+ * \paramout out Newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateValue, _In_reads_(num_values) const OrtValue* const* in, size_t num_values,
 enum ONNXType value_type, _Outptr_ OrtValue** out);
 
 /** \brief Create an opaque (custom user defined type) ::OrtValue
- *
- * Constructs an ::OrtValue that contains a value of non-standard type created for
- * experiments or while awaiting standardization. ::OrtValue in this case would contain
- * an internal representation of the Opaque type. Opaque types are distinguished from
- * each other by two strings 1) domain and 2) type name. The combination of the two
- * must be unique, so the type representation is properly identified internally. The combination
- * must be properly registered from within ORT at both compile/run time or by another API.
- *
- * To construct the ::OrtValue pass domain and type names, also a pointer to a data container
- * the type of which must be known to both ORT and the client program. That data container may or may
- * not match the internal representation of the Opaque type. The sizeof(data_container) is passed for
- * verification purposes.
- *
- * \paramin domain_name Null terminated string of the domain name
- * \paramin type_name Null terminated string of the type name
- * \paramin data_container User pointer Data to populate ::OrtValue
- * \paramin data_container_size Size in bytes of what `data_container` points to
- * \paramout out Newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Constructs an ::OrtValue that contains a value of non-standard type created for
+ * experiments or while awaiting standardization. ::OrtValue in this case would contain
+ * an internal representation of the Opaque type. Opaque types are distinguished from
+ * each other by two strings 1) domain and 2) type name. The combination of the two
+ * must be unique, so the type representation is properly identified internally. The combination
+ * must be properly registered from within ORT at both compile/run time or by another API.
+ *
+ * To construct the ::OrtValue pass domain and type names, also a pointer to a data container
+ * the type of which must be known to both ORT and the client program. That data container may or may
+ * not match the internal representation of the Opaque type. The sizeof(data_container) is passed for
+ * verification purposes.
+ *
+ * \paramin domain_name Null terminated string of the domain name
+ * \paramin type_name Null terminated string of the type name
+ * \paramin data_container User pointer Data to populate ::OrtValue
+ * \paramin data_container_size Size in bytes of what `data_container` points to
+ * \paramout out Newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateOpaqueValue, _In_z_ const char* domain_name, _In_z_ const char* type_name,
 _In_ const void* data_container, size_t data_container_size, _Outptr_ OrtValue** out);
 
 /** \brief Get internal data from an opaque (custom user defined type) ::OrtValue
- *
- * Copies internal data from an opaque value into a user provided buffer
- *
- * \see OrtApi::CreateOpaqueValue
- *
- * \paramin domain_name Null terminated string of the domain name
- * \paramin type_name Null terminated string of the type name
- * \paramin in The opaque ::OrtValue
- * \paramout data_container Buffer to copy data into
- * \paramout data_container_size Size in bytes of the buffer pointed to by data_container. Must match the size of the internal buffer.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Copies internal data from an opaque value into a user provided buffer
+ *
+ * \see OrtApi::CreateOpaqueValue
+ *
+ * \paramin domain_name Null terminated string of the domain name
+ * \paramin type_name Null terminated string of the type name
+ * \paramin in The opaque ::OrtValue
+ * \paramout data_container Buffer to copy data into
+ * \paramout data_container_size Size in bytes of the buffer pointed to by data_container. Must match the size of the internal buffer.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetOpaqueValue, _In_ const char* domain_name, _In_ const char* type_name, _In_ const OrtValue* in,
 _Out_ void* data_container, size_t data_container_size);
 
 /// @}
 /// \name OrtKernelInfo
+ /// Custom operator APIs.
 /// @{
 
 /** \brief Get a float stored as an attribute in the graph node
- *
- * \paramin info ::OrtKernelInfo instance
- * \paramin name Null terminated string of the name of the attribute
- * \paramout out Pointer to memory where the attribute will be stored
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info ::OrtKernelInfo instance
+ * \paramin name Null terminated string of the name of the attribute
+ * \paramout out Pointer to memory where the attribute will be stored
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelInfoGetAttribute_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
 _Out_ float* out);
 
 /** \brief Fetch a 64-bit int stored as an attribute in the graph node
- *
- * \paramin info ::OrtKernelInfo instance
- * \paramin name Null terminated string of the name of the attribute
- * \paramout out Pointer to memory where the attribute will be stored
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin info ::OrtKernelInfo instance
+ * \paramin name Null terminated string of the name of the attribute
+ * \paramout out Pointer to memory where the attribute will be stored
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelInfoGetAttribute_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
 _Out_ int64_t* out);
 
 /** \brief Fetch a string stored as an attribute in the graph node
- *
- * If `out` is nullptr, the value of `size` is set to the true size of the string
- * attribute, and a success status is returned.
- *
- * If the `size` parameter is greater than or equal to the actual string attribute's size,
- * the value of `size` is set to the true size of the string attribute, the provided memory
- * is filled with the attribute's contents, and a success status is returned.
- *
- * If the `size` parameter is less than the actual string attribute's size and `out`
- * is not nullptr, the value of `size` is set to the true size of the string attribute
- * and a failure status is returned.)
- *
- * \paramin info ::OrtKernelInfo instance
- * \paramin name Null terminated string of the name of the attribute
- * \paramout out Pointer to memory where the attribute will be stored
- * \paramin,out size See above comments for details
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If `out` is nullptr, the value of `size` is set to the true size of the string
+ * attribute, and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the actual string attribute's size,
+ * the value of `size` is set to the true size of the string attribute, the provided memory
+ * is filled with the attribute's contents, and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual string attribute's size and `out`
+ * is not nullptr, the value of `size` is set to the true size of the string attribute
+ * and a failure status is returned.)
+ *
+ * \paramin info ::OrtKernelInfo instance
+ * \paramin name Null terminated string of the name of the attribute
+ * \paramout out Pointer to memory where the attribute will be stored
+ * \paramin,out size See above comments for details
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelInfoGetAttribute_string, _In_ const OrtKernelInfo* info, _In_ const char* name, _Out_ char* out,
 _Inout_ size_t* size);
 
 /// @}
 /// \name OrtKernelContext
+ /// Custom operator APIs.
 /// @{
 
 /** \brief Used for custom operators, get the input count of a kernel
- *
- * \see ::OrtCustomOp
- */
+ *
+ * \see ::OrtCustomOp
+ */
 ORT_API2_STATUS(KernelContext_GetInputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
 
 /** \brief Used for custom operators, get the output count of a kernel
- *
- * \see ::OrtCustomOp
- */
+ *
+ * \see ::OrtCustomOp
+ */
 ORT_API2_STATUS(KernelContext_GetOutputCount, _In_ const OrtKernelContext* context, _Out_ size_t* out);
 
 /** \brief Used for custom operators, get an input of a kernel
- *
- * \see ::OrtCustomOp
- */
+ *
+ * \see ::OrtCustomOp
+ */
 ORT_API2_STATUS(KernelContext_GetInput, _In_ const OrtKernelContext* context, _In_ size_t index,
 _Out_ const OrtValue** out);
 
 /** \brief Used for custom operators, get an output of a kernel
- *
- * \see ::OrtCustomOp
- */
+ *
+ * \see ::OrtCustomOp
+ */
 ORT_API2_STATUS(KernelContext_GetOutput, _Inout_ OrtKernelContext* context, _In_ size_t index,
 _In_ const int64_t* dim_values, size_t dim_count, _Outptr_ OrtValue** out);
 
@@ -1724,7 +1773,7 @@
 /// @}
 /// \name OrtSession
 /// @{
- ORT_CLASS_RELEASE(Session); //Don't call ReleaseSession from Dllmain (because session owns a thread pool)
+ ORT_CLASS_RELEASE(Session); // Don't call ReleaseSession from Dllmain (because session owns a thread pool)
 /// @}
 /// \name OrtValue
 /// @{
@@ -1755,47 +1804,47 @@
 /// @{
 
 /** \brief Get denotation from type information
- *
- * Augments ::OrtTypeInfo to return denotations on the type.
- *
- * This is used by WinML to determine if an input/output is intended to be an Image or a Tensor.
- *
- * \paramin type_info
- * \paramout denotation Pointer to the null terminated denotation string is written to this pointer. This pointer is valid until the object is destroyed or the name is changed, do not free.
- * \paramout len Length in bytes of the string returned in `denotation`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Augments ::OrtTypeInfo to return denotations on the type.
+ *
+ * This is used by WinML to determine if an input/output is intended to be an Image or a Tensor.
+ *
+ * \paramin type_info
+ * \paramout denotation Pointer to the null terminated denotation string is written to this pointer. This pointer is valid until the object is destroyed or the name is changed, do not free.
+ * \paramout len Length in bytes of the string returned in `denotation`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetDenotationFromTypeInfo, _In_ const OrtTypeInfo* type_info, _Out_ const char** const denotation,
 _Out_ size_t* len);
 
 /** \brief Get detailed map information from an ::OrtTypeInfo
- *
- * This augments ::OrtTypeInfo to return an ::OrtMapTypeInfo when the type is a map.
- * The OrtMapTypeInfo has additional information about the map's key type and value type.
- *
- * This is used by WinML to support model reflection APIs.
- *
- * \paramout type_info
- * \paramout out A pointer to the ::OrtMapTypeInfo. Do not free this value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This augments ::OrtTypeInfo to return an ::OrtMapTypeInfo when the type is a map.
+ * The OrtMapTypeInfo has additional information about the map's key type and value type.
+ *
+ * This is used by WinML to support model reflection APIs.
+ *
+ * \paramout type_info
+ * \paramout out A pointer to the ::OrtMapTypeInfo. Do not free this value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CastTypeInfoToMapTypeInfo, _In_ const OrtTypeInfo* type_info,
 _Outptr_result_maybenull_ const OrtMapTypeInfo** out);
 
 /** \brief Cast ::OrtTypeInfo to an ::OrtSequenceTypeInfo
- *
- * This api augments ::OrtTypeInfo to return an ::OrtSequenceTypeInfo when the type is a sequence.
-	* The ::OrtSequenceTypeInfo has additional information about the sequence's element type.
- *
- * This is used by WinML to support model reflection APIs.
-	*
- * \paramin type_info
-	* \paramout out A pointer to the OrtSequenceTypeInfo. Do not free this value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This api augments ::OrtTypeInfo to return an ::OrtSequenceTypeInfo when the type is a sequence.
+ * The ::OrtSequenceTypeInfo has additional information about the sequence's element type.
+ *
+ * This is used by WinML to support model reflection APIs.
+ *
+ * \paramin type_info
+ * \paramout out A pointer to the OrtSequenceTypeInfo. Do not free this value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CastTypeInfoToSequenceTypeInfo, _In_ const OrtTypeInfo* type_info,
 _Outptr_result_maybenull_ const OrtSequenceTypeInfo** out);
 
@@ -1804,25 +1853,25 @@
 /// @{
 
 /** \brief Get key type from an ::OrtMapTypeInfo
- *
- * Key types are restricted to being scalar types.
- *
- * This is used by WinML to support model reflection APIs.
- *
- * \paramin map_type_info
- * \paramout out
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Key types are restricted to being scalar types.
+ *
+ * This is used by WinML to support model reflection APIs.
+ *
+ * \paramin map_type_info
+ * \paramout out
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetMapKeyType, _In_ const OrtMapTypeInfo* map_type_info, _Out_ enum ONNXTensorElementDataType* out);
 
 /** \brief Get the value type from an ::OrtMapTypeInfo
- *
- * \paramin map_type_info
- * \paramout type_info
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin map_type_info
+ * \paramout type_info
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetMapValueType, _In_ const OrtMapTypeInfo* map_type_info, _Outptr_ OrtTypeInfo** type_info);
 
 /// @}
@@ -1830,14 +1879,14 @@
 /// @{
 
 /** \brief Get element type from an ::OrtSequenceTypeInfo
- *
- * This is used by WinML to support model reflection APIs.
- *
- * \paramin sequence_type_info
- * \paramout type_info
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This is used by WinML to support model reflection APIs.
+ *
+ * \paramin sequence_type_info
+ * \paramout type_info
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSequenceElementType, _In_ const OrtSequenceTypeInfo* sequence_type_info,
 _Outptr_ OrtTypeInfo** type_info);
 
@@ -1855,24 +1904,24 @@
 /// @{
 
 /** \brief End profiling and return filename of the profile data
- *
- * Profiling is turned on through OrtApi::EnableProfiling
- *
- * \paramin session
- * \paramin allocator
- * \paramout out Null terminated string of the filename, allocated using `allocator`. Must be freed using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Profiling is turned on through OrtApi::EnableProfiling
+ *
+ * \paramin session
+ * \paramin allocator
+ * \paramout out Null terminated string of the filename, allocated using `allocator`. Must be freed using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionEndProfiling, _In_ OrtSession* session, _Inout_ OrtAllocator* allocator, _Outptr_ char** out);
 
 /** \brief Get ::OrtModelMetadata from an ::OrtSession
- *
- * \paramin session
- * \paramout out Newly created ::OrtModelMetadata. Must be freed using OrtApi::ReleaseModelMetadata
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramout out Newly created ::OrtModelMetadata. Must be freed using OrtApi::ReleaseModelMetadata
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetModelMetadata, _In_ const OrtSession* session, _Outptr_ OrtModelMetadata** out);
 
 /// @}
@@ -1880,69 +1929,69 @@
 /// @{
 
 /** \brief Get `producer name` from an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetProducerName, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
 /** \brief Get `graph name` from an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetGraphName, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
 /** \brief Get `domain` from an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetDomain, _In_ const OrtModelMetadata* model_metadata, _Inout_ OrtAllocator* allocator,
 _Outptr_ char** value);
 
 /** \brief Get `description` from an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetDescription, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
 /** \brief Return data for a key in the custom metadata map in an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramin key Null terminated string
- * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
- * `value` will be set to nullptr if the given key is not found in the custom metadata map.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramin key Null terminated string
+ * \paramout value Set to a null terminated string allocated using `allocator`. Must be freed using `allocator`
+ * `value` will be set to nullptr if the given key is not found in the custom metadata map.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataLookupCustomMetadataMap, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _In_ const char* key, _Outptr_result_maybenull_ char** value);
 
 /** \brief Get version number from an ::OrtModelMetadata
- *
- * \paramin model_metadata
- * \paramout value Set to the version number
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramout value Set to the version number
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetVersion, _In_ const OrtModelMetadata* model_metadata, _Out_ int64_t* value);
 
 ORT_CLASS_RELEASE(ModelMetadata);
@@ -1952,18 +2001,18 @@
 /// @{
 
 /** \brief Create an OrtEnv
- *
- * Create an environment with global threadpools that will be shared across sessions.
- * Use this in conjunction with OrtApi::DisablePerSessionThreads or else the session will use
- * its own thread pools.
- *
- * \paramin log_severity_level The log severity level.
- * \paramin logid The log identifier.
- * \paramin tp_options
- * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Create an environment with global threadpools that will be shared across sessions.
+ * Use this in conjunction with OrtApi::DisablePerSessionThreads or else the session will use
+ * its own thread pools.
+ *
+ * \paramin log_severity_level The log severity level.
+ * \paramin logid The log identifier.
+ * \paramin tp_options
+ * \paramout out Returned newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateEnvWithGlobalThreadPools, OrtLoggingLevel log_severity_level, _In_ const char* logid,
 _In_ const OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
 
@@ -1972,14 +2021,14 @@
 /// @{
 
 /** \brief Use global thread pool on a session
- *
- * Disable using per session thread pool and use the shared global threadpool.
- * This should be used in conjunction with OrtApi::CreateEnvWithGlobalThreadPools.
- *
- * \paramin options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Disable using per session thread pool and use the shared global threadpool.
+ * This should be used in conjunction with OrtApi::CreateEnvWithGlobalThreadPools.
+ *
+ * \paramin options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(DisablePerSessionThreads, _Inout_ OrtSessionOptions* options);
 
 /// @}
@@ -1987,10 +2036,10 @@
 /// @{
 
 /** \brief Create an ::OrtThreadingOptions
- *
- * \paramout out Newly created ::OrtThreadingOptions. Must be freed with OrtApi::ReleaseThreadingOptions
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramout out Newly created ::OrtThreadingOptions. Must be freed with OrtApi::ReleaseThreadingOptions
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateThreadingOptions, _Outptr_ OrtThreadingOptions** out);
 
 ORT_CLASS_RELEASE(ThreadingOptions);
@@ -2000,16 +2049,16 @@
 /// @{
 
 /**
- *
- * \paramin model_metadata
- * \paramin allocator
- * \paramout keys Array of null terminated strings (array count = num_keys) allocated using `allocator`.
- * The strings and the pointer array must be freed using `allocator`
- * `keys` will be set to nullptr if the custom metadata map is empty.
- * \paramout num_keys Set to the number of elements in the `keys` array
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin model_metadata
+ * \paramin allocator
+ * \paramout keys Array of null terminated strings (array count = num_keys) allocated using `allocator`.
+ * The strings and the pointer array must be freed using `allocator`
+ * `keys` will be set to nullptr if the custom metadata map is empty.
+ * \paramout num_keys Set to the number of elements in the `keys` array
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetCustomMetadataMapKeys, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _Outptr_result_buffer_maybenull_(*num_keys) char*** keys, _Out_ int64_t* num_keys);
 
@@ -2018,12 +2067,12 @@
 /// @{
 
 /**
- *
- * Override symbolic dimensions (by specific name strings) with actual values
- * if known at session initialization time to enable optimizations that can
- * take advantage of fixed values (such as memory planning, etc)
- *
- */
+ *
+ * Override symbolic dimensions (by specific name strings) with actual values
+ * if known at session initialization time to enable optimizations that can
+ * take advantage of fixed values (such as memory planning, etc)
+ *
+ */
 ORT_API2_STATUS(AddFreeDimensionOverrideByName,
 _Inout_ OrtSessionOptions* options, _In_ const char* dim_name,
 _In_ int64_t dim_value);
@@ -2033,25 +2082,25 @@
 /// @{
 
 /** \brief Get the names of all available providers
- *
- * \note The providers in the list are not guaranteed to be usable. They may fail to load due to missing system dependencies.
- * For example, if the CUDA/cuDNN libraries are not installed, the CUDA provider will report an error when it is added to the session options.
- *
- * \paramout out_ptr Set to a pointer to an array of null terminated strings of the available providers. The entries and the
- * array itself must be freed using OrtApi::ReleaseAvailableProviders
- * \paramout provider_length Set to the number of entries in the `out_ptr` array
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \note The providers in the list are not guaranteed to be usable. They may fail to load due to missing system dependencies.
+ * For example, if the CUDA/cuDNN libraries are not installed, the CUDA provider will report an error when it is added to the session options.
+ *
+ * \paramout out_ptr Set to a pointer to an array of null terminated strings of the available providers. The entries and the
+ * array itself must be freed using OrtApi::ReleaseAvailableProviders
+ * \paramout provider_length Set to the number of entries in the `out_ptr` array
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetAvailableProviders, _Outptr_ char*** out_ptr, _Out_ int* provider_length);
 
 /** \brief Release data from OrtApi::GetAvailableProviders
- *
- * \paramin ptr The `out_ptr` result from OrtApi::GetAvailableProviders.
- * \paramin providers_length The `provider_length` result from OrtApi::GetAvailableProviders
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ptr The `out_ptr` result from OrtApi::GetAvailableProviders.
+ * \paramin providers_length The `provider_length` result from OrtApi::GetAvailableProviders
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ReleaseAvailableProviders, _In_ char** ptr,
 _In_ int providers_length);
 
@@ -2060,34 +2109,34 @@
 /// @{
 
 /** \brief Get the length of a single string in a string tensor
- *
- * \paramin value A string tensor
- * \paramin index Index of the string in the tensor
- * \paramout out Set to number of bytes of the string element
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value A string tensor
+ * \paramin index Index of the string in the tensor
+ * \paramout out Set to number of bytes of the string element
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetStringTensorElementLength, _In_ const OrtValue* value, size_t index, _Out_ size_t* out);
 
 /** \brief Get a single string from a string tensor
- *
- * \paramin value A string tensor
- * \paramin s_len Number of bytes in the `s` buffer. Must match the value returned by OrtApi::GetStringTensorElementLength.
- * \paramin index Index of the string in the tensor
- * \paramout s The string element contents in UTF-8 encoding. The string is NOT null-terminated.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value A string tensor
+ * \paramin s_len Number of bytes in the `s` buffer. Must match the value returned by OrtApi::GetStringTensorElementLength.
+ * \paramin index Index of the string in the tensor
+ * \paramout s The string element contents in UTF-8 encoding. The string is NOT null-terminated.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetStringTensorElement, _In_ const OrtValue* value, size_t s_len, size_t index, _Out_writes_bytes_all_(s_len) void* s);
 
 /** \brief Set a single string in a string tensor
- *
- * \paramin value A string tensor
- * \paramin s A null terminated UTF-8 encoded string
- * \paramin index Index of the string in the tensor to set
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value A string tensor
+ * \paramin s A null terminated UTF-8 encoded string
+ * \paramin index Index of the string in the tensor to set
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(FillStringTensorElement, _Inout_ OrtValue* value, _In_ const char* s, size_t index);
 
 /// @}
@@ -2095,17 +2144,17 @@
 /// @{
 
 /** \brief Set a session configuration entry as a pair of strings
- *
- * If a configuration with same key exists, this will overwrite the configuration with the given config_value.
- *
- * The config_key and the format of config_value are defined in onnxruntime_session_options_config_keys.h
- *
- * \paramin options
- * \paramin config_key A null terminated string representation of the config key
- * \paramin config_value A null terminated string representation of the config value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If a configuration with same key exists, this will overwrite the configuration with the given config_value.
+ *
+ * The config_key and the format of config_value are defined in onnxruntime_session_options_config_keys.h
+ *
+ * \paramin options
+ * \paramin config_key A null terminated string representation of the config key
+ * \paramin config_value A null terminated string representation of the config value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(AddSessionConfigEntry, _Inout_ OrtSessionOptions* options,
 _In_z_ const char* config_key, _In_z_ const char* config_value);
 
@@ -2114,18 +2163,18 @@
 /// @{
 
 /** \brief Create an allocator for an ::OrtSession following an ::OrtMemoryInfo
- *
- * \paramin session
- * \paramin mem_info valid ::OrtMemoryInfo instance
- * \paramout out Newly created ::OrtAllocator. Must be freed with OrtApi::ReleaseAllocator
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin session
+ * \paramin mem_info valid ::OrtMemoryInfo instance
+ * \paramout out Newly created ::OrtAllocator. Must be freed with OrtApi::ReleaseAllocator
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateAllocator, _In_ const OrtSession* session, _In_ const OrtMemoryInfo* mem_info,
 _Outptr_ OrtAllocator** out);
 
 /** \brief Release an ::OrtAllocator obtained from OrtApi::CreateAllocator
- */
+ */
 ORT_CLASS_RELEASE(Allocator);
 
 /// @}
@@ -2133,28 +2182,28 @@
 /// @{
 
 /** \brief Run a model using Io Bindings for the inputs & outputs
- *
- * \see OrtApi::Run
- *
- * \paramin session
- * \paramin run_options
- * \paramin binding_ptr
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \see OrtApi::Run
+ *
+ * \paramin session
+ * \paramin run_options
+ * \paramin binding_ptr
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(RunWithBinding, _Inout_ OrtSession* session, _In_ const OrtRunOptions* run_options, _In_ const OrtIoBinding* binding_ptr);
 
 /** \brief Create an ::OrtIoBinding instance
- *
- * An IoBinding object allows one to bind pre-allocated ::OrtValue%s to input names.
- * Thus if you want to use a raw on device buffer as input or output you can avoid
- * extra copy during runtime.
- *
- * \paramin session
- * \paramout out Newly created ::OrtIoBinding. Must be freed with OrtApi::ReleaseIoBinding
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * An IoBinding object allows one to bind pre-allocated ::OrtValue%s to input names.
+ * Thus if you want to use a raw on device buffer as input or output you can avoid
+ * extra copy during runtime.
+ *
+ * \paramin session
+ * \paramout out Newly created ::OrtIoBinding. Must be freed with OrtApi::ReleaseIoBinding
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateIoBinding, _Inout_ OrtSession* session, _Outptr_ OrtIoBinding** out);
 
 /// @}
@@ -2162,87 +2211,87 @@
 /// @{
 
 /** \brief Release an ::OrtIoBinding obtained from OrtApi::CreateIoBinding
- */
+ */
 ORT_CLASS_RELEASE(IoBinding);
 
 /** \brief Bind an ::OrtValue to an ::OrtIoBinding input
- *
- * When using OrtApi::RunWithBinding this value is used for the named input
- *
- * \paramin binding_ptr
- * \paramin name Name for the model input
- * \paramin val_ptr ::OrtValue of Tensor type.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * When using OrtApi::RunWithBinding this value is used for the named input
+ *
+ * \paramin binding_ptr
+ * \paramin name Name for the model input
+ * \paramin val_ptr ::OrtValue of Tensor type.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(BindInput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
 
 /** \brief Bind an ::OrtValue to an ::OrtIoBinding output
- *
- * When using OrtApi::RunWithBinding this value is used for the named output
- *
- * \paramin binding_ptr
- * \paramin name Null terminated string of the model output name
- * \paramin val_ptr ::OrtValue of Tensor type.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * When using OrtApi::RunWithBinding this value is used for the named output
+ *
+ * \paramin binding_ptr
+ * \paramin name Null terminated string of the model output name
+ * \paramin val_ptr ::OrtValue of Tensor type.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(BindOutput, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtValue* val_ptr);
 
 /** \brief Bind an ::OrtIoBinding output to a device
- *
- * Binds the ::OrtValue to a device which is specified by ::OrtMemoryInfo.
- * You can either create an instance of ::OrtMemoryInfo with a device id or obtain one from the allocator that you have created/are using
- * This is useful when one or more outputs have dynamic shapes and, it is hard to pre-allocate and bind a chunk of
- * memory within ::OrtValue ahead of time.
- *
- * \see OrtApi::RunWithBinding
- *
- * \paramin binding_ptr
- * \paramin name Null terminated string of the device name
- * \paramin mem_info_ptr
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Binds the ::OrtValue to a device which is specified by ::OrtMemoryInfo.
+ * You can either create an instance of ::OrtMemoryInfo with a device id or obtain one from the allocator that you have created/are using
+ * This is useful when one or more outputs have dynamic shapes and, it is hard to pre-allocate and bind a chunk of
+ * memory within ::OrtValue ahead of time.
+ *
+ * \see OrtApi::RunWithBinding
+ *
+ * \paramin binding_ptr
+ * \paramin name Null terminated string of the device name
+ * \paramin mem_info_ptr
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(BindOutputToDevice, _Inout_ OrtIoBinding* binding_ptr, _In_ const char* name, _In_ const OrtMemoryInfo* mem_info_ptr);
 
 /** \brief Get the names of an ::OrtIoBinding's outputs
- *
- * Returns the names of the outputs in the order they were bound. This is useful after running the model
- * with bound outputs because the returned names are in order in which output ::OrtValue are returned. This is useful if
- * the order of outputs and their names is not known.
- *
- * \paramin binding_ptr
- * \paramin allocator Allocator used to allocate continuous buffers for output strings and lengths.
- * \paramout buffer Returns an array of non-null terminated UTF-8 strings. The number of strings stored is returned in the count parameter.
- * This buffer is allocated using `allocator` and must be freed using it.
- * \paramout lengths Returns an array of `count` lengths of the strings returned in `buffer`
- * This buffer is allocated using `allocator` and must be freed using it.
- * \paramout count Number of strings returned. If `binding_ptr` has no bound outputs, zero is returned,
- * no memory allocation is performed and buffer and lengths are set to nullptr.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Returns the names of the outputs in the order they were bound. This is useful after running the model
+ * with bound outputs because the returned names are in order in which output ::OrtValue are returned. This is useful if
+ * the order of outputs and their names is not known.
+ *
+ * \paramin binding_ptr
+ * \paramin allocator Allocator used to allocate continuous buffers for output strings and lengths.
+ * \paramout buffer Returns an array of non-null terminated UTF-8 strings. The number of strings stored is returned in the count parameter.
+ * This buffer is allocated using `allocator` and must be freed using it.
+ * \paramout lengths Returns an array of `count` lengths of the strings returned in `buffer`
+ * This buffer is allocated using `allocator` and must be freed using it.
+ * \paramout count Number of strings returned. If `binding_ptr` has no bound outputs, zero is returned,
+ * no memory allocation is performed and buffer and lengths are set to nullptr.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetBoundOutputNames, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
 _Out_ char** buffer, _Out_writes_all_(count) size_t** lengths, _Out_ size_t* count);
 
 /** \brief Get the output ::OrtValue objects from an ::OrtIoBinding
- *
- * Returns an array of pointers to individually allocated ::OrtValue%s that contain results of a model execution with OrtApi::RunWithBinding
- * The array contains the same number of ::OrtValue%s and they are in the same order as they were bound with OrtApi::BindOutput
- * or OrtApi::BindOutputToDevice.
- *
- * The returned ::OrtValue%s must be released using OrtApi::ReleaseValue after they are no longer needed.
- * The array is allocated using the specified instance of the allocator and must be freed using the same allocator after
- * all the ::OrtValue%s contained therein are individually released.
- *
- * \paramin binding_ptr
- * \paramin allocator Allocator used to allocate output array
- * \paramout output Set to the allocated array of allocated ::OrtValue outputs. Set to nullptr if there are 0 outputs.
- * \paramout output_count Set to number of ::OrtValue%s returned
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Returns an array of pointers to individually allocated ::OrtValue%s that contain results of a model execution with OrtApi::RunWithBinding
+ * The array contains the same number of ::OrtValue%s and they are in the same order as they were bound with OrtApi::BindOutput
+ * or OrtApi::BindOutputToDevice.
+ *
+ * The returned ::OrtValue%s must be released using OrtApi::ReleaseValue after they are no longer needed.
+ * The array is allocated using the specified instance of the allocator and must be freed using the same allocator after
+ * all the ::OrtValue%s contained therein are individually released.
+ *
+ * \paramin binding_ptr
+ * \paramin allocator Allocator used to allocate output array
+ * \paramout output Set to the allocated array of allocated ::OrtValue outputs. Set to nullptr if there are 0 outputs.
+ * \paramout output_count Set to number of ::OrtValue%s returned
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetBoundOutputValues, _In_ const OrtIoBinding* binding_ptr, _In_ OrtAllocator* allocator,
 _Out_writes_all_(output_count) OrtValue*** output, _Out_ size_t* output_count);
 
@@ -2259,19 +2308,19 @@
 /// @{
 
 /** \brief Direct memory access to a specified tensor element
- *
- * For example, given a tensor with shape of 3,224,224, a pointer to the element at location 2,150,128 can be retrieved
- *
- * This function only works for numeric type tensors (No strings, etc).
- * This is a no-copy method whose returned pointer is valid until the passed in ::OrtValue is free'd.
- *
- * \paramin value
- * \paramin location_values Pointer to an array of index values that specify an element's location relative to its shape
- * \paramin location_values_count Number of elements in location_values. Must match the number of elements in the tensor's shape.
- * \paramout out Set to a pointer to the element specified
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * For example, given a tensor with shape of 3,224,224, a pointer to the element at location 2,150,128 can be retrieved
+ *
+ * This function only works for numeric type tensors (No strings, etc).
+ * This is a no-copy method whose returned pointer is valid until the passed in ::OrtValue is free'd.
+ *
+ * \paramin value
+ * \paramin location_values Pointer to an array of index values that specify an element's location relative to its shape
+ * \paramin location_values_count Number of elements in location_values. Must match the number of elements in the tensor's shape.
+ * \paramout out Set to a pointer to the element specified
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(TensorAt, _Inout_ OrtValue* value, const int64_t* location_values, size_t location_values_count, _Outptr_ void** out);
 
 /// @}
@@ -2279,33 +2328,33 @@
 /// @{
 
 /** \brief Create an allocator and register it with the ::OrtEnv
- *
- * Enables sharing the allocator between multiple sessions that use the same env instance.
- * Lifetime of the created allocator will be valid for the duration of the environment.
- * Returns an error if an allocator with the same ::OrtMemoryInfo is already registered.
- *
- * See https://onnxruntime.ai/docs/reference/api/c-api.html for details.
- *
- * \paramin env ::OrtEnv instance
- * \paramin mem_info
- * \paramin arena_cfg Pass nullptr for defaults
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Enables sharing the allocator between multiple sessions that use the same env instance.
+ * Lifetime of the created allocator will be valid for the duration of the environment.
+ * Returns an error if an allocator with the same ::OrtMemoryInfo is already registered.
+ *
+ * See https://onnxruntime.ai/docs/reference/api/c-api.html for details.
+ *
+ * \paramin env ::OrtEnv instance
+ * \paramin mem_info
+ * \paramin arena_cfg Pass nullptr for defaults
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateAndRegisterAllocator, _Inout_ OrtEnv* env, _In_ const OrtMemoryInfo* mem_info,
 _In_ const OrtArenaCfg* arena_cfg);
 
 /** \brief Set language projection
- *
- * Set the language projection for collecting telemetry data when Env is created.
- *
- * The default is ORT_PROJECTION_C, which means it will classify the language not in the list to C also.
- *
- * \paramin ort_env
- * \paramin projection
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Set the language projection for collecting telemetry data when Env is created.
+ *
+ * The default is ORT_PROJECTION_C, which means it will classify the language not in the list to C also.
+ *
+ * \paramin ort_env
+ * \paramin projection
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetLanguageProjection, _In_ const OrtEnv* ort_env, _In_ OrtLanguageProjection projection);
 
 /// @}
@@ -2313,14 +2362,14 @@
 /// @{
 
 /** \brief Return the time that profiling was started
- *
- * \note The timer precision varies per platform. On Windows and MacOS, the precision will be ~100ns
- *
- * \paramin session
- * \paramout out nanoseconds of profiling's start time
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \note The timer precision varies per platform. On Windows and MacOS, the precision will be ~100ns
+ *
+ * \paramin session
+ * \paramout out nanoseconds of profiling's start time
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionGetProfilingStartTimeNs, _In_ const OrtSession* session, _Outptr_ uint64_t* out);
 
 /// @}
@@ -2328,44 +2377,44 @@
 /// @{
 
 /** \brief Set global intra-op thread count
- *
- * This configures the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools
- *
- * \paramin tp_options
- * \paramin intra_op_num_threads Number of threads, special values: 
- * 0 = Use default thread count 
- * 1 = The invoking thread will be used; no threads will be created in the thread pool.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This configures the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools
+ *
+ * \paramin tp_options
+ * \paramin intra_op_num_threads Number of threads, special values: 
+ * 0 = Use default thread count 
+ * 1 = The invoking thread will be used; no threads will be created in the thread pool.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalIntraOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int intra_op_num_threads);
 
 /** \brief Set global inter-op thread count
- *
- * This configures the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools
- *
- * \paramin tp_options
- * \paramin inter_op_num_threads Number of threads, special values: 
- * 0 = Use default thread count 
- * 1 = The invoking thread will be used; no threads will be created in the thread pool.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This configures the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools
+ *
+ * \paramin tp_options
+ * \paramin inter_op_num_threads Number of threads, special values: 
+ * 0 = Use default thread count 
+ * 1 = The invoking thread will be used; no threads will be created in the thread pool.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalInterOpNumThreads, _Inout_ OrtThreadingOptions* tp_options, int inter_op_num_threads);
 
 /** \brief Set global spin control options
- *
- * This will configure the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools.
- * Allow spinning of thread pools when their queues are empty. This will set the value for both
- * inter_op and intra_op threadpools.
- *
- * \paramin tp_options
- * \paramin allow_spinning Valid values are 0 or 1. 
- * 0 = It won't spin (recommended if CPU usage is high) 
- * 1 = Threadpool will spin to wait for queue to become non-empty
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This will configure the global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools.
+ * Allow spinning of thread pools when their queues are empty. This will set the value for both
+ * inter_op and intra_op threadpools.
+ *
+ * \paramin tp_options
+ * \paramin allow_spinning Valid values are 0 or 1. 
+ * 0 = It won't spin (recommended if CPU usage is high) 
+ * 1 = Threadpool will spin to wait for queue to become non-empty
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalSpinControl, _Inout_ OrtThreadingOptions* tp_options, int allow_spinning);
 
 /// @}
@@ -2373,19 +2422,19 @@
 /// @{
 
 /** \brief Add a pre-allocated initializer to a session
- *
- * If a model contains an initializer with a name that is same as the name passed to this call,
- * ORT will use this initializer instance instead of deserializing one from the model file. This
- * is useful when you want to share the same initializer across sessions.
- *
- * \paramin options
- * \paramin name Null terminated string of the initializer name
- * \paramin val ::OrtValue containing the initializer. Its lifetime and the underlying initializer buffer must be
- * managed by the user (created using the OrtApi::CreateTensorWithDataAsOrtValue) and it must outlive the session object
- * to which it is added.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If a model contains an initializer with a name that is same as the name passed to this call,
+ * ORT will use this initializer instance instead of deserializing one from the model file. This
+ * is useful when you want to share the same initializer across sessions.
+ *
+ * \paramin options
+ * \paramin name Null terminated string of the initializer name
+ * \paramin val ::OrtValue containing the initializer. Its lifetime and the underlying initializer buffer must be
+ * managed by the user (created using the OrtApi::CreateTensorWithDataAsOrtValue) and it must outlive the session object
+ * to which it is added.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(AddInitializer, _Inout_ OrtSessionOptions* options, _In_z_ const char* name,
 _In_ const OrtValue* val);
 
@@ -2394,20 +2443,20 @@
 /// @{
 
 /**
- * Create a custom environment with global threadpools and logger that will be shared across sessions.
- * Use this in conjunction with OrtApi::DisablePerSessionThreads or else the session will use
- * its own thread pools.
- *
- * \paramin logging_function A pointer to a logging function.
- * \paramin logger_param A pointer to arbitrary data passed as the ::OrtLoggingFunction `param` parameter to
- * `logging_function`.
- * \paramin log_severity_level The log severity level.
- * \paramin logid The log identifier.
- * \paramin tp_options
- * \paramout out Newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * Create a custom environment with global threadpools and logger that will be shared across sessions.
+ * Use this in conjunction with OrtApi::DisablePerSessionThreads or else the session will use
+ * its own thread pools.
+ *
+ * \paramin logging_function A pointer to a logging function.
+ * \paramin logger_param A pointer to arbitrary data passed as the ::OrtLoggingFunction `param` parameter to
+ * `logging_function`.
+ * \paramin log_severity_level The log severity level.
+ * \paramin logid The log identifier.
+ * \paramin tp_options
+ * \paramout out Newly created OrtEnv. Must be freed with OrtApi::ReleaseEnv
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateEnvWithCustomLoggerAndGlobalThreadPools, OrtLoggingFunction logging_function, _In_opt_ void* logger_param, OrtLoggingLevel log_severity_level,
 _In_ const char* logid, _In_ const struct OrtThreadingOptions* tp_options, _Outptr_ OrtEnv** out);
 
@@ -2416,38 +2465,38 @@
 /// @{
 
 /** \brief Append CUDA provider to session options
- *
- * If CUDA is not available (due to a non CUDA enabled build, or if CUDA is not installed on the system), this function will return failure.
- *
- * \paramin options
- * \paramin cuda_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If CUDA is not available (due to a non CUDA enabled build, or if CUDA is not installed on the system), this function will return failure.
+ *
+ * \paramin options
+ * \paramin cuda_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_CUDA,
 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptions* cuda_options);
 
 /** \brief Append ROCM execution provider to the session options
- *
- * If ROCM is not available (due to a non ROCM enabled build, or if ROCM is not installed on the system), this function will return failure.
- *
- * \paramin options
- * \paramin rocm_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If ROCM is not available (due to a non ROCM enabled build, or if ROCM is not installed on the system), this function will return failure.
+ *
+ * \paramin options
+ * \paramin rocm_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_ROCM,
 _In_ OrtSessionOptions* options, _In_ const OrtROCMProviderOptions* rocm_options);
 
 /** \brief Append OpenVINO execution provider to the session options
- *
- * If OpenVINO is not available (due to a non OpenVINO enabled build, or if OpenVINO is not installed on the system), this function will fail.
- *
- * \paramin options
- * \paramin provider_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If OpenVINO is not available (due to a non OpenVINO enabled build, or if OpenVINO is not installed on the system), this function will fail.
+ *
+ * \paramin options
+ * \paramin provider_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_OpenVINO,
 _In_ OrtSessionOptions* options, _In_ const OrtOpenVINOProviderOptions* provider_options);
 
@@ -2456,15 +2505,15 @@
 /// @{
 
 /** \brief Set threading flush-to-zero and denormal-as-zero
- *
- * Sets global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools.
- * Flush-to-zero and denormal-as-zero are applied to threads in both intra and inter global thread pool.
- * \note This option is not needed if the models used have no denormals. Having no denormals is recommended as this option may hurt model accuracy.
- *
- * \paramin tp_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Sets global thread pool options to be used in the call to OrtApi::CreateEnvWithGlobalThreadPools.
+ * Flush-to-zero and denormal-as-zero are applied to threads in both intra and inter global thread pool.
+ * \note This option is not needed if the models used have no denormals. Having no denormals is recommended as this option may hurt model accuracy.
+ *
+ * \paramin tp_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalDenormalAsZero, _Inout_ OrtThreadingOptions* tp_options);
 
 /// @}
@@ -2472,17 +2521,17 @@
 /// @{
 
 /** \deprecated Use OrtApi::CreateArenaCfgV2
- *
- * This will create the configuration of an arena that can eventually be used to define an arena based allocator's behavior
- *
- * \paramin max_mem Use 0 to allow ORT to choose the default
- * \paramin arena_extend_strategy Use -1 to allow ORT to choose the default, 0 = kNextPowerOfTwo, 1 = kSameAsRequested
- * \paramin initial_chunk_size_bytes Use -1 to allow ORT to choose the default
- * \paramin max_dead_bytes_per_chunk Use -1 to allow ORT to choose the default
- * \paramin out A pointer to an OrtArenaCfg instance
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This will create the configuration of an arena that can eventually be used to define an arena based allocator's behavior
+ *
+ * \paramin max_mem Use 0 to allow ORT to choose the default
+ * \paramin arena_extend_strategy Use -1 to allow ORT to choose the default, 0 = kNextPowerOfTwo, 1 = kSameAsRequested
+ * \paramin initial_chunk_size_bytes Use -1 to allow ORT to choose the default
+ * \paramin max_dead_bytes_per_chunk Use -1 to allow ORT to choose the default
+ * \paramin out A pointer to an OrtArenaCfg instance
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateArenaCfg, _In_ size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes,
 int max_dead_bytes_per_chunk, _Outptr_ OrtArenaCfg** out);
 
@@ -2493,16 +2542,16 @@
 /// @{
 
 /**
- * Use this to obtain the description of the graph present in the model
- * (doc_string field of the GraphProto message within the ModelProto message).
- * If it doesn't exist, an empty string will be returned.
- *
- * \paramin model_metadata An instance of ::OrtModelMetadata
- * \paramin allocator Allocator used to allocate the string that will be returned back
- * \paramout value Set to a null terminated string allocated using `allocator`. The caller is responsible for freeing it using `allocator`
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * Use this to obtain the description of the graph present in the model
+ * (doc_string field of the GraphProto message within the ModelProto message).
+ * If it doesn't exist, an empty string will be returned.
+ *
+ * \paramin model_metadata An instance of ::OrtModelMetadata
+ * \paramin allocator Allocator used to allocate the string that will be returned back
+ * \paramout value Set to a null terminated string allocated using `allocator`. The caller is responsible for freeing it using `allocator`
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(ModelMetadataGetGraphDescription, _In_ const OrtModelMetadata* model_metadata,
 _Inout_ OrtAllocator* allocator, _Outptr_ char** value);
 
@@ -2511,14 +2560,14 @@
 /// @{
 
 /** \brief Append TensorRT provider to session options
- *
- * If TensorRT is not available (due to a non TensorRT enabled build, or if TensorRT is not installed on the system), this function will return failure.
- *
- * \paramin options
- * \paramin tensorrt_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If TensorRT is not available (due to a non TensorRT enabled build, or if TensorRT is not installed on the system), this function will return failure.
+ *
+ * \paramin options
+ * \paramin tensorrt_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_TensorRT,
 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptions* tensorrt_options);
 
@@ -2527,79 +2576,80 @@
 /// @{
 
 /** \brief Set current GPU device ID
- *
- * Set the current device id of the GPU execution provider (CUDA/tensorrt/rocm). The device id should be less
- * than the total number of devices available. This is only useful when multiple-GPUs are installed and it is
- * required to restrict execution to a single GPU.
- *
- * \paramin device_id
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Set the current device id of the GPU execution provider (CUDA/tensorrt/rocm). The device id should be less
+ * than the total number of devices available. This is only useful when multiple-GPUs are installed and it is
+ * required to restrict execution to a single GPU.
+ *
+ * \paramin device_id
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetCurrentGpuDeviceId, _In_ int device_id);
 
 /** \brief Get current GPU device ID
- *
- * Get the current device id of the GPU execution provider (CUDA/tensorrt/rocm).
- *
- * \see OrtApi::SetCurrentGpuDeviceId
- *
- * \paramout device_id
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Get the current device id of the GPU execution provider (CUDA/tensorrt/rocm).
+ *
+ * \see OrtApi::SetCurrentGpuDeviceId
+ *
+ * \paramout device_id
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetCurrentGpuDeviceId, _In_ int* device_id);
 
 /// @}
 /// \name OrtKernelInfo
+ /// Custom operator APIs.
 /// @{
 
 /** \brief Fetch an array of int64_t values stored as an attribute in the graph node
- *
- *
- * If `out` is nullptr, the value of `size` is set to the true size of the attribute
- * array's size, and a success status is returned.
- *
- * If the `size` parameter is greater than or equal to the actual attribute array's size,
- * the value of `size` is set to the true size of the attribute array's size,
- * the provided memory is filled with the attribute's contents,
- * and a success status is returned.
- *
- * If the `size` parameter is less than the actual attribute array's size and `out`
- * is not nullptr, the value of `size` is set to the true size of the attribute array's size
- * and a failure status is returned.)
- *
- * \paramin info instance
- * \paramin name name of the attribute to be parsed
- * \paramout out pointer to memory where the attribute's contents are to be stored
- * \paramin, out size actual size of attribute array
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ *
+ * If `out` is nullptr, the value of `size` is set to the true size of the attribute
+ * array's size, and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the actual attribute array's size,
+ * the value of `size` is set to the true size of the attribute array's size,
+ * the provided memory is filled with the attribute's contents,
+ * and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual attribute array's size and `out`
+ * is not nullptr, the value of `size` is set to the true size of the attribute array's size
+ * and a failure status is returned.)
+ *
+ * \paramin info instance
+ * \paramin name name of the attribute to be parsed
+ * \paramout out pointer to memory where the attribute's contents are to be stored
+ * \paramin, out size actual size of attribute array
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelInfoGetAttributeArray_float, _In_ const OrtKernelInfo* info, _In_ const char* name,
 _Out_ float* out, _Inout_ size_t* size);
 
 /** \brief Fetch an array of int64_t values stored as an attribute in the graph node
- *
- * If `out` is nullptr, the value of `size` is set to the true size of the attribute
- * array's size, and a success status is returned.
- *
- * If the `size` parameter is greater than or equal to the actual attribute array's size,
- * the value of `size` is set to the true size of the attribute array's size,
- * the provided memory is filled with the attribute's contents,
- * and a success status is returned.
- *
- * If the `size` parameter is less than the actual attribute array's size and `out`
- * is not nullptr, the value of `size` is set to the true size of the attribute array's size
- * and a failure status is returned.)
- *
- * \paramin info instance
- * \paramin name name of the attribute to be parsed
- * \paramout out pointer to memory where the attribute's contents are to be stored
- * \paramin, out size actual size of attribute array
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If `out` is nullptr, the value of `size` is set to the true size of the attribute
+ * array's size, and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the actual attribute array's size,
+ * the value of `size` is set to the true size of the attribute array's size,
+ * the provided memory is filled with the attribute's contents,
+ * and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual attribute array's size and `out`
+ * is not nullptr, the value of `size` is set to the true size of the attribute array's size
+ * and a failure status is returned.)
+ *
+ * \paramin info instance
+ * \paramin name name of the attribute to be parsed
+ * \paramout out pointer to memory where the attribute's contents are to be stored
+ * \paramin, out size actual size of attribute array
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelInfoGetAttributeArray_int64, _In_ const OrtKernelInfo* info, _In_ const char* name,
 _Out_ int64_t* out, _Inout_ size_t* size);
 
@@ -2608,32 +2658,32 @@
 /// @{
 
 /** \brief Create an ::OrtArenaCfg
- *
- * Create the configuration of an arena that can eventually be used to define an arena based allocator's behavior.
- *
- * Supported keys are (See https://onnxruntime.ai/docs/reference/api/c-api.html for details on what the
- * following parameters mean and how to choose these values.):
- * "max_mem": Maximum memory that can be allocated by the arena based allocator.
- * Use 0 for ORT to pick the best value. Default is 0.
- * "arena_extend_strategy": 0 = kNextPowerOfTwo, 1 = kSameAsRequested.
- * Use -1 to allow ORT to choose the default.
- * "initial_chunk_size_bytes": (Possible) Size of the first allocation in the arena.
- * Only relevant if arena strategy is `kNextPowerOfTwo`. Use -1 to allow ORT to choose the default.
- * Ultimately, the first allocation size is determined by the allocation memory request.
- * "max_dead_bytes_per_chunk": Threshold of unused memory in an allocated chunk of arena memory after
- * crossing which the current chunk is chunked into 2.
- * "initial_growth_chunk_size_bytes": (Possible) Size of the second allocation in the arena.
- * Only relevant if arena strategy is `kNextPowerOfTwo`. Use -1 to allow ORT to choose the default.
- * Ultimately, the allocation size is determined by the allocation memory request.
- * Further allocation sizes are governed by the arena extend strategy.
- *
- * \paramin arena_config_keys Keys to configure the arena
- * \paramin arena_config_values Values to configure the arena
- * \paramin num_keys Number of keys in `arena_config_keys` and `arena_config_values`
- * \paramout out Newly created ::OrtArenaCfg. Must be freed with OrtApi::ReleaseArenaCfg
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Create the configuration of an arena that can eventually be used to define an arena based allocator's behavior.
+ *
+ * Supported keys are (See https://onnxruntime.ai/docs/reference/api/c-api.html for details on what the
+ * following parameters mean and how to choose these values.):
+ * "max_mem": Maximum memory that can be allocated by the arena based allocator.
+ * Use 0 for ORT to pick the best value. Default is 0.
+ * "arena_extend_strategy": 0 = kNextPowerOfTwo, 1 = kSameAsRequested.
+ * Use -1 to allow ORT to choose the default.
+ * "initial_chunk_size_bytes": (Possible) Size of the first allocation in the arena.
+ * Only relevant if arena strategy is `kNextPowerOfTwo`. Use -1 to allow ORT to choose the default.
+ * Ultimately, the first allocation size is determined by the allocation memory request.
+ * "max_dead_bytes_per_chunk": Threshold of unused memory in an allocated chunk of arena memory after
+ * crossing which the current chunk is chunked into 2.
+ * "initial_growth_chunk_size_bytes": (Possible) Size of the second allocation in the arena.
+ * Only relevant if arena strategy is `kNextPowerOfTwo`. Use -1 to allow ORT to choose the default.
+ * Ultimately, the allocation size is determined by the allocation memory request.
+ * Further allocation sizes are governed by the arena extend strategy.
+ *
+ * \paramin arena_config_keys Keys to configure the arena
+ * \paramin arena_config_values Values to configure the arena
+ * \paramin num_keys Number of keys in `arena_config_keys` and `arena_config_values`
+ * \paramout out Newly created ::OrtArenaCfg. Must be freed with OrtApi::ReleaseArenaCfg
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateArenaCfgV2, _In_reads_(num_keys) const char* const* arena_config_keys,
 _In_reads_(num_keys) const size_t* arena_config_values, _In_ size_t num_keys,
 _Outptr_ OrtArenaCfg** out);
@@ -2643,17 +2693,17 @@
 /// @{
 
 /** \brief Set a single run configuration entry as a pair of strings
- *
- * If a configuration with same key exists, this will overwrite the configuration with the given config_value
- *
- * The config_key and the format of config_value are defined in onnxruntime_run_options_config_keys.h
- *
- * \paramin options
- * \paramin config_key A null terminated string representation of the config key
- * \paramin config_value A null terminated string representation of the config value
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If a configuration with same key exists, this will overwrite the configuration with the given config_value
+ *
+ * The config_key and the format of config_value are defined in onnxruntime_run_options_config_keys.h
+ *
+ * \paramin options
+ * \paramin config_key A null terminated string representation of the config key
+ * \paramin config_value A null terminated string representation of the config value
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(AddRunConfigEntry, _Inout_ OrtRunOptions* options,
 _In_z_ const char* config_key, _In_z_ const char* config_value);
 
@@ -2662,23 +2712,23 @@
 /// @{
 
 /** \brief Create an ::OrtPrepackedWeightsContainer
- *
- * This container will hold pre-packed buffers of shared initializers for sharing between sessions
- * (i.e.) if there are shared initializers that can be shared between sessions, the pre-packed buffers
- * of these (if any) may possibly be shared to provide memory footprint savings. Pass this container
- * to sessions that you would like to share pre-packed buffers of shared initializers at session
- * creation time.
- *
- * \paramout out Newly created ::OrtPrepackedWeightsContainer. Must be freed with OrtApi::ReleasePrepackedWeightsContainer
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * This container will hold pre-packed buffers of shared initializers for sharing between sessions
+ * (i.e.) if there are shared initializers that can be shared between sessions, the pre-packed buffers
+ * of these (if any) may possibly be shared to provide memory footprint savings. Pass this container
+ * to sessions that you would like to share pre-packed buffers of shared initializers at session
+ * creation time.
+ *
+ * \paramout out Newly created ::OrtPrepackedWeightsContainer. Must be freed with OrtApi::ReleasePrepackedWeightsContainer
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreatePrepackedWeightsContainer, _Outptr_ OrtPrepackedWeightsContainer** out);
 
 /** \brief Release OrtPrepackedWeightsContainer instance
- *
- * \note instance must not be released until the sessions using it are released
- */
+ *
+ * \note instance must not be released until the sessions using it are released
+ */
 ORT_CLASS_RELEASE(PrepackedWeightsContainer);
 
 /// @}
@@ -2686,44 +2736,44 @@
 /// @{
 
 /** \brief Create session with prepacked weights container
- *
- * Same functionality offered by OrtApi::CreateSession except that a container that contains
- * pre-packed weights' buffers is written into/read from by the created session.
- * This is useful when used in conjunction with OrtApi::AddInitializer which injects
- * shared initializer info into sessions. Wherever possible, the pre-packed versions of these
- * shared initializers are cached in this container so that multiple sessions can just re-use
- * these instead of duplicating these in memory.
- *
- * \paramin env OrtEnv instance instance
- * \paramin model_path Null terminated string of the path (wchar on Windows, char otherwise)
- * \paramin options
- * \paramin prepacked_weights_container
- * \paramout out Newly created ::OrtSession. Must be freed with OrtApi::ReleaseSession
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Same functionality offered by OrtApi::CreateSession except that a container that contains
+ * pre-packed weights' buffers is written into/read from by the created session.
+ * This is useful when used in conjunction with OrtApi::AddInitializer which injects
+ * shared initializer info into sessions. Wherever possible, the pre-packed versions of these
+ * shared initializers are cached in this container so that multiple sessions can just re-use
+ * these instead of duplicating these in memory.
+ *
+ * \paramin env OrtEnv instance instance
+ * \paramin model_path Null terminated string of the path (wchar on Windows, char otherwise)
+ * \paramin options
+ * \paramin prepacked_weights_container
+ * \paramout out Newly created ::OrtSession. Must be freed with OrtApi::ReleaseSession
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSessionWithPrepackedWeightsContainer, _In_ const OrtEnv* env, _In_ const ORTCHAR_T* model_path,
 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
 _Outptr_ OrtSession** out);
 
 /** \brief Create session from memory with prepacked weights container
- *
- * Same functionality offered by OrtApi::CreateSessionFromArray except that a container that contains
- * pre-packed weights' buffers is written into/read from by the created session.
- * This is useful when used in conjunction with OrtApi::AddInitializer which injects
- * shared initializer info into sessions. Wherever possible, the pre-packed versions of these
- * shared initializers are cached in this container so that multiple sessions can just re-use
- * these instead of duplicating these in memory.
- *
- * \paramin env
- * \paramin model_data Array of bytes holding the model
- * \paramin model_data_length Number of bytes in `model_data_model`
- * \paramin options
- * \paramin prepacked_weights_container
- * \paramout out Newly created ::OrtSession. Must be freed with OrtApi::ReleaseSession
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Same functionality offered by OrtApi::CreateSessionFromArray except that a container that contains
+ * pre-packed weights' buffers is written into/read from by the created session.
+ * This is useful when used in conjunction with OrtApi::AddInitializer which injects
+ * shared initializer info into sessions. Wherever possible, the pre-packed versions of these
+ * shared initializers are cached in this container so that multiple sessions can just re-use
+ * these instead of duplicating these in memory.
+ *
+ * \paramin env
+ * \paramin model_data Array of bytes holding the model
+ * \paramin model_data_length Number of bytes in `model_data_model`
+ * \paramin options
+ * \paramin prepacked_weights_container
+ * \paramout out Newly created ::OrtSession. Must be freed with OrtApi::ReleaseSession
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSessionFromArrayWithPrepackedWeightsContainer, _In_ const OrtEnv* env,
 _In_ const void* model_data, size_t model_data_length,
 _In_ const OrtSessionOptions* options, _Inout_ OrtPrepackedWeightsContainer* prepacked_weights_container,
@@ -2734,22 +2784,22 @@
 /// @{
 
 /** \brief Append TensorRT execution provider to the session options
- *
- * If TensorRT is not available (due to a non TensorRT enabled build), this function will return failure.
- *
- * This is slightly different from OrtApi::SessionOptionsAppendExecutionProvider_TensorRT, it takes an
- * ::OrtTensorRTProviderOptions which is publicly defined. This takes an opaque ::OrtTensorRTProviderOptionsV2
- * which must be created with OrtApi::CreateTensorRTProviderOptions.
- *
- * For OrtApi::SessionOptionsAppendExecutionProvider_TensorRT, the user needs to instantiate ::OrtTensorRTProviderOptions
- * as well as allocate/release buffers for some members of ::OrtTensorRTProviderOptions.
- * Here, OrtApi::CreateTensorRTProviderOptions and Ortapi::ReleaseTensorRTProviderOptions will do the memory management for you.
- *
- * \paramin options
- * \paramin tensorrt_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * If TensorRT is not available (due to a non TensorRT enabled build), this function will return failure.
+ *
+ * This is slightly different from OrtApi::SessionOptionsAppendExecutionProvider_TensorRT, it takes an
+ * ::OrtTensorRTProviderOptions which is publicly defined. This takes an opaque ::OrtTensorRTProviderOptionsV2
+ * which must be created with OrtApi::CreateTensorRTProviderOptions.
+ *
+ * For OrtApi::SessionOptionsAppendExecutionProvider_TensorRT, the user needs to instantiate ::OrtTensorRTProviderOptions
+ * as well as allocate/release buffers for some members of ::OrtTensorRTProviderOptions.
+ * Here, OrtApi::CreateTensorRTProviderOptions and Ortapi::ReleaseTensorRTProviderOptions will do the memory management for you.
+ *
+ * \paramin options
+ * \paramin tensorrt_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_TensorRT_V2,
 _In_ OrtSessionOptions* options, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options);
 
@@ -2758,50 +2808,50 @@
 /// @{
 
 /** \brief Create an OrtTensorRTProviderOptionsV2
- *
- * \paramout out Newly created ::OrtTensorRTProviderOptionsV2. Must be released with OrtApi::ReleaseTensorRTProviderOptions
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramout out Newly created ::OrtTensorRTProviderOptionsV2. Must be released with OrtApi::ReleaseTensorRTProviderOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateTensorRTProviderOptions, _Outptr_ OrtTensorRTProviderOptionsV2** out);
 
 /** \brief Set options in a TensorRT Execution Provider.
- *
- * Please refer to https://www.onnxruntime.ai/docs/reference/execution-providers/TensorRT-ExecutionProvider.html#c-api-example
- * to know the available keys and values. Key should be in null terminated string format of the member of ::OrtTensorRTProviderOptionsV2
- * and value should be its related range.
- *
- * For example, key="trt_max_workspace_size" and value="2147483648"
- *
- * \paramin tensorrt_options
- * \paramin provider_options_keys Array of UTF-8 null-terminated string for provider options keys
- * \paramin provider_options_values Array of UTF-8 null-terminated string for provider options values
- * \paramin num_keys Number of elements in the `provider_option_keys` and `provider_options_values` arrays
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Please refer to https://www.onnxruntime.ai/docs/reference/execution-providers/TensorRT-ExecutionProvider.html#c-api-example
+ * to know the available keys and values. Key should be in null terminated string format of the member of ::OrtTensorRTProviderOptionsV2
+ * and value should be its related range.
+ *
+ * For example, key="trt_max_workspace_size" and value="2147483648"
+ *
+ * \paramin tensorrt_options
+ * \paramin provider_options_keys Array of UTF-8 null-terminated string for provider options keys
+ * \paramin provider_options_values Array of UTF-8 null-terminated string for provider options values
+ * \paramin num_keys Number of elements in the `provider_option_keys` and `provider_options_values` arrays
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(UpdateTensorRTProviderOptions, _Inout_ OrtTensorRTProviderOptionsV2* tensorrt_options,
 _In_reads_(num_keys) const char* const* provider_options_keys,
 _In_reads_(num_keys) const char* const* provider_options_values,
 _In_ size_t num_keys);
 
 /** \brief Get serialized TensorRT provider options string.
- *
- * For example, "trt_max_workspace_size=2147483648;trt_max_partition_iterations=10;trt_int8_enable=1;......"
- *
- * \param tensorrt_options - OrTensorRTProviderOptionsV2 instance
- * \param allocator - a ptr to an instance of OrtAllocator obtained with OrtApi::CreateAllocator or OrtApi::GetAllocatorWithDefaultOptions
- * the specified allocator will be used to allocate continuous buffers for output strings and lengths.
- * \param ptr - is a UTF-8 null terminated string allocated using 'allocator'. The caller is responsible for using the same allocator to free it.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * For example, "trt_max_workspace_size=2147483648;trt_max_partition_iterations=10;trt_int8_enable=1;......"
+ *
+ * \param tensorrt_options - OrTensorRTProviderOptionsV2 instance
+ * \param allocator - a ptr to an instance of OrtAllocator obtained with OrtApi::CreateAllocator or OrtApi::GetAllocatorWithDefaultOptions
+ * the specified allocator will be used to allocate continuous buffers for output strings and lengths.
+ * \param ptr - is a UTF-8 null terminated string allocated using 'allocator'. The caller is responsible for using the same allocator to free it.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetTensorRTProviderOptionsAsString, _In_ const OrtTensorRTProviderOptionsV2* tensorrt_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
 
 /** \brief Release an ::OrtTensorRTProviderOptionsV2
- *
- * \note This is an exception in the naming convention of other Release* functions, as the name of the method does not have the V2 suffix, but the type does
- */
+ *
+ * \note This is an exception in the naming convention of other Release* functions, as the name of the method does not have the V2 suffix, but the type does
+ */
 void(ORT_API_CALL* ReleaseTensorRTProviderOptions)(_Frees_ptr_opt_ OrtTensorRTProviderOptionsV2* input);
 
 /// @}
@@ -2809,11 +2859,11 @@
 /// @{
 
 /** \brief Enable custom operators
- *
- * See onnxruntime-extensions: https://github.com/microsoft/onnxruntime-extensions.git
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * See onnxruntime-extensions: https://github.com/microsoft/onnxruntime-extensions.git
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(EnableOrtCustomOps, _Inout_ OrtSessionOptions* options);
 
 /// @}
@@ -2821,32 +2871,32 @@
 /// @{
 
 /** \brief Register a custom allocator
- *
- * Enables sharing between multiple sessions that use the same env instance.
- * Returns an error if an allocator with the same ::OrtMemoryInfo is already registered.
- *
- * The behavior of this is exactly the same as OrtApi::CreateAndRegisterAllocator except
- * instead of ORT creating an allocator based on provided info, in this case
- * ORT uses the user-provided custom allocator.
- * See https://onnxruntime.ai/docs/reference/api/c-api.html for details.
- *
- * \paramin env
- * \paramin allocator User provided allocator
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Enables sharing between multiple sessions that use the same env instance.
+ * Returns an error if an allocator with the same ::OrtMemoryInfo is already registered.
+ *
+ * The behavior of this is exactly the same as OrtApi::CreateAndRegisterAllocator except
+ * instead of ORT creating an allocator based on provided info, in this case
+ * ORT uses the user-provided custom allocator.
+ * See https://onnxruntime.ai/docs/reference/api/c-api.html for details.
+ *
+ * \paramin env
+ * \paramin allocator User provided allocator
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(RegisterAllocator, _Inout_ OrtEnv* env, _In_ OrtAllocator* allocator);
 
 /** \brief Unregister a custom allocator
- *
- * It is an error if you provide an ::OrtMemoryInfo not corresponding to any
- * registered allocators for sharing.
- *
- * \paramin env
- * \paramin mem_info
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * It is an error if you provide an ::OrtMemoryInfo not corresponding to any
+ * registered allocators for sharing.
+ *
+ * \paramin env
+ * \paramin mem_info
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(UnregisterAllocator, _Inout_ OrtEnv* env,
 _In_ const OrtMemoryInfo* mem_info);
 
@@ -2855,228 +2905,228 @@
 /// @{
 
 /** \brief Sets *out to 1 iff an ::OrtValue is a SparseTensor, and 0 otherwise
- *
- * \paramin value existing ::OrtValue
- * \paramout out unless an error occurs, contains 1 iff the value contains an instance
- * of sparse tensor or 0 otherwise.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin value existing ::OrtValue
+ * \paramout out unless an error occurs, contains 1 iff the value contains an instance
+ * of sparse tensor or 0 otherwise.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(IsSparseTensor, _In_ const OrtValue* value, _Out_ int* out);
 
 /** \brief Create an ::OrtValue with a sparse tensor that is empty.
- *
- * Use FillSparseTensor<Format>() functions to populate sparse tensor with non-zero values and
- * format specific indices data.
- * Use ReleaseValue to destroy the sparse tensor, this will also release the buffer inside the output value
- * if any was allocated.
- * \paramin,out allocator allocator to use when performing an allocation. Allocation will be performed
- * by FillSparseTensor<Format>() APIs. The lifespan of the allocator instance must eclipse the lifespan
- * this sparse tensor instance as the same allocator will be used to free memory.
- * \paramin dense_shape shape of the original dense tensor
- * \paramin dense_shape_len number of shape dimensions being passed
- * \paramin type must be one of TENSOR_ELEMENT_DATA_TYPE_xxxx
- * \paramout out Should be freed by calling ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * Use FillSparseTensor<Format>() functions to populate sparse tensor with non-zero values and
+ * format specific indices data.
+ * Use ReleaseValue to destroy the sparse tensor, this will also release the buffer inside the output value
+ * if any was allocated.
+ * \paramin,out allocator allocator to use when performing an allocation. Allocation will be performed
+ * by FillSparseTensor<Format>() APIs. The lifespan of the allocator instance must eclipse the lifespan
+ * this sparse tensor instance as the same allocator will be used to free memory.
+ * \paramin dense_shape shape of the original dense tensor
+ * \paramin dense_shape_len number of shape dimensions being passed
+ * \paramin type must be one of TENSOR_ELEMENT_DATA_TYPE_xxxx
+ * \paramout out Should be freed by calling ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSparseTensorAsOrtValue, _Inout_ OrtAllocator* allocator, _In_ const int64_t* dense_shape,
 size_t dense_shape_len, ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
 
 /**
- * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
- * This will allocate required memory and copy the supplied NNZ values and COO indices into that memory allocation.
- * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
- *
- * \paramin,out ort_value ::OrtValue to populate with data
- * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
- * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
- * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
- * \paramin values_shape pointer to values shape array
- * \paramin values_shape_len length of the values_shape
- * \paramin values pointer to an array of values. For strings, pass const char**.
- * \paramin indices_data pointer to a location of COO indices
- * \paramin indices_num number of COO indices
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
+ * This will allocate required memory and copy the supplied NNZ values and COO indices into that memory allocation.
+ * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
+ *
+ * \paramin,out ort_value ::OrtValue to populate with data
+ * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
+ * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
+ * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
+ * \paramin values_shape pointer to values shape array
+ * \paramin values_shape_len length of the values_shape
+ * \paramin values pointer to an array of values. For strings, pass const char**.
+ * \paramin indices_data pointer to a location of COO indices
+ * \paramin indices_num number of COO indices
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(FillSparseTensorCoo, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
 _In_ const int64_t* indices_data, size_t indices_num);
 
 /**
- * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
- * This will allocate required memory and copy the supplied NNZ values and CSR indices into that memory allocation.
- * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
- *
- * \paramin,out ort_value ::OrtValue to populate with data
- * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
- * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
- * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
- * \paramin values_shape pointer to values shape array
- * \paramin values_shape_len length of the values_shape
- * \paramin values - pointer to an array of values. For strings, pass const char**.
- * \paramin inner_indices_data pointer to a location of CSR inner indices
- * \paramin inner_indices_num number of CSR inner indices
- * \paramin outer_indices_data pointer to a location of CSR outer indices
- * \paramin outer_indices_num number of CSR outer indices
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
+ * This will allocate required memory and copy the supplied NNZ values and CSR indices into that memory allocation.
+ * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
+ *
+ * \paramin,out ort_value ::OrtValue to populate with data
+ * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
+ * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
+ * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
+ * \paramin values_shape pointer to values shape array
+ * \paramin values_shape_len length of the values_shape
+ * \paramin values - pointer to an array of values. For strings, pass const char**.
+ * \paramin inner_indices_data pointer to a location of CSR inner indices
+ * \paramin inner_indices_num number of CSR inner indices
+ * \paramin outer_indices_data pointer to a location of CSR outer indices
+ * \paramin outer_indices_num number of CSR outer indices
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(FillSparseTensorCsr, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
 _In_ const int64_t* inner_indices_data, size_t inner_indices_num,
 _In_ const int64_t* outer_indices_data, size_t outer_indices_num);
 
 /**
- * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
- * This will allocate required memory and copy the supplied NNZ values and BlockSparse indices into that memory allocation.
- * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
- *
- * \paramin,out ort_value ::OrtValue to populate with data
- * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
- * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
- * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
- * \paramin values_shape
- * \paramin values_shape_len
- * \paramin values structure with values information
- * \paramin indices_shape_data pointer to a location of indices shape
- * \paramin indices_shape_len length of the block sparse indices shape
- * \paramin indices_data pointer to a location of indices data. Shape will determine the length of the indices data.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * This fills populates an empty tensor that was created using OrtApi::CreateSparseTensorAsOrtValue.
+ * This will allocate required memory and copy the supplied NNZ values and BlockSparse indices into that memory allocation.
+ * Memory allocation is performed using the allocator that was specified with OrtApi::CreateSparseTensorAsOrtValue.
+ *
+ * \paramin,out ort_value ::OrtValue to populate with data
+ * \paramin data_mem_info serves to identify the location of the data to be copied. If the allocator specified
+ * at the creation time has memory info that is not the same as mem_info argument to this function a X-device copy will be performed.
+ * String data is assumed to be on CPU and will only be copied into a CPU allocated buffer.
+ * \paramin values_shape
+ * \paramin values_shape_len
+ * \paramin values structure with values information
+ * \paramin indices_shape_data pointer to a location of indices shape
+ * \paramin indices_shape_len length of the block sparse indices shape
+ * \paramin indices_data pointer to a location of indices data. Shape will determine the length of the indices data.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(FillSparseTensorBlockSparse, _Inout_ OrtValue* ort_value, _In_ const OrtMemoryInfo* data_mem_info,
 _In_ const int64_t* values_shape, size_t values_shape_len, _In_ const void* values,
 _In_ const int64_t* indices_shape_data, size_t indices_shape_len,
 _In_ const int32_t* indices_data);
 
 /**
- * Create an ::OrtValue with a sparse tensor. This is the first step.
- * Next, use Use<Format>Indices() functions to supply sparse tensor with
- * format specific indices data and set its sparse format to a specific enum value.
- * This will not perform memory allocations. It will
- * use supplied user buffer which should outlive the created sparse tensor.
- * Use OrtApi::ReleaseValue to destroy the sparse tensor. It would not release the supplied values buffer.
- * This function can not be used to map strings from the user allocated memory. Strings must always be copied
- * and have UTF-8 encoding. Therefore, use OrtApi::CreateSparseTensorAsOrtValue above and then fill it with data
- * using appropriate Make*() function.
- *
- * \paramin info memory info where sparse values reside.
- * \paramin,out p_data pointer to a user allocated buffer with values. To create a full sparse tensor with no non-zero
- * values, pass nullptr
- * \paramin dense_shape shape of the original dense tensor
- * \paramin dense_shape_len number of shape dimensions being passed
- * \paramin values_shape shape of the values data. To create a fully sparse tensor with no non-zero values,
- * pass {0} shape.
- * \paramin values_shape_len number of values shape dimensions
- * \paramin type must be one of TENSOR_ELEMENT_DATA_TYPE_xxxx
- * \paramout out Should be freed by calling ReleaseValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * Create an ::OrtValue with a sparse tensor. This is the first step.
+ * Next, use Use<Format>Indices() functions to supply sparse tensor with
+ * format specific indices data and set its sparse format to a specific enum value.
+ * This will not perform memory allocations. It will
+ * use supplied user buffer which should outlive the created sparse tensor.
+ * Use OrtApi::ReleaseValue to destroy the sparse tensor. It would not release the supplied values buffer.
+ * This function can not be used to map strings from the user allocated memory. Strings must always be copied
+ * and have UTF-8 encoding. Therefore, use OrtApi::CreateSparseTensorAsOrtValue above and then fill it with data
+ * using appropriate Make*() function.
+ *
+ * \paramin info memory info where sparse values reside.
+ * \paramin,out p_data pointer to a user allocated buffer with values. To create a full sparse tensor with no non-zero
+ * values, pass nullptr
+ * \paramin dense_shape shape of the original dense tensor
+ * \paramin dense_shape_len number of shape dimensions being passed
+ * \paramin values_shape shape of the values data. To create a fully sparse tensor with no non-zero values,
+ * pass {0} shape.
+ * \paramin values_shape_len number of values shape dimensions
+ * \paramin type must be one of TENSOR_ELEMENT_DATA_TYPE_xxxx
+ * \paramout out Should be freed by calling ReleaseValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(CreateSparseTensorWithValuesAsOrtValue, _In_ const OrtMemoryInfo* info, _Inout_ void* p_data,
 _In_ const int64_t* dense_shape, size_t dense_shape_len,
 _In_ const int64_t* values_shape, size_t values_shape_len,
 ONNXTensorElementDataType type, _Outptr_ OrtValue** out);
 
 /**
- * This assigns Coo format indices to the SparseTensor that was created by
- * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
- * ORT_SPARSE_COO. This will not allocate any additional memory for data. The life span of
- * indices_data buffer should eclipse the life span of this ::OrtValue.
- *
- * \paramin,out ort_value ::OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
- * \paramin,out indices_data pointer to a user pre-allocated buffer or nullptr for fully sparse tensors.
- * \paramin indices_num number of COO indices. Should either be 0 for fully sparse tensors, be equal
- * to the number of nnz values specified to OrtApi::CreateSparseTensorWithValuesAsOrtValue for 1-D {nnz} indices or
- * be twice as number of nnz values for a 2-D indices {nnz, 2}
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * This assigns Coo format indices to the SparseTensor that was created by
+ * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
+ * ORT_SPARSE_COO. This will not allocate any additional memory for data. The life span of
+ * indices_data buffer should eclipse the life span of this ::OrtValue.
+ *
+ * \paramin,out ort_value ::OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
+ * \paramin,out indices_data pointer to a user pre-allocated buffer or nullptr for fully sparse tensors.
+ * \paramin indices_num number of COO indices. Should either be 0 for fully sparse tensors, be equal
+ * to the number of nnz values specified to OrtApi::CreateSparseTensorWithValuesAsOrtValue for 1-D {nnz} indices or
+ * be twice as number of nnz values for a 2-D indices {nnz, 2}
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(UseCooIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* indices_data, size_t indices_num);
 
 /**
- * The assigns CSR format indices to the SparseTensor that was created by
- * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
- * ORT_SPARSE_CSRC. This will not allocate any additional memory for data. The life spans of
- * inner_data and outer_data buffers should eclipse the life span of this ::OrtValue.
- *
- * \paramin,out ort_value ::OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
- * \paramin,out inner_data pointer to a user pre-allocated buffer or nullptr for fully sparse tensors.
- * \paramin inner_num number of inner CSR indices. Should either be 0 for fully sparse tensors or be equal
- * to the number of nnz values specified to OrtApi::CreateSparseTensorWithValuesAsOrtValue.
- * \paramin,out outer_data pointer to user pre-allocated buffer or nullptr for fully sparse tensors.
- * \paramin outer_num number of CSR outer indices. Should either be 0 for fully sparse tensors or
- * equal to rows + 1 of the dense shape.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * The assigns CSR format indices to the SparseTensor that was created by
+ * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
+ * ORT_SPARSE_CSRC. This will not allocate any additional memory for data. The life spans of
+ * inner_data and outer_data buffers should eclipse the life span of this ::OrtValue.
+ *
+ * \paramin,out ort_value ::OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
+ * \paramin,out inner_data pointer to a user pre-allocated buffer or nullptr for fully sparse tensors.
+ * \paramin inner_num number of inner CSR indices. Should either be 0 for fully sparse tensors or be equal
+ * to the number of nnz values specified to OrtApi::CreateSparseTensorWithValuesAsOrtValue.
+ * \paramin,out outer_data pointer to user pre-allocated buffer or nullptr for fully sparse tensors.
+ * \paramin outer_num number of CSR outer indices. Should either be 0 for fully sparse tensors or
+ * equal to rows + 1 of the dense shape.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(UseCsrIndices, _Inout_ OrtValue* ort_value, _Inout_ int64_t* inner_data, size_t inner_num,
 _Inout_ int64_t* outer_data, size_t outer_num);
 
 /**
- * The assigns BlockSparse format indices to the SparseTensor that was created by
- * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
- * ORT_SPARSE_BLOCK_SPARSE. This will not allocate any additional memory for data. The life span of
- * indices_data buffer must eclipse the lifespan of this ::OrtValue.
- *
- * \paramin,out ort_value OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
- * \paramin indices_shape pointer to indices shape. Use {0} for fully sparse tensors
- * \paramin indices_shape_len length of the indices shape
- * \paramin,out indices_data pointer to user pre-allocated buffer or nullptr for fully sparse tensors.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * The assigns BlockSparse format indices to the SparseTensor that was created by
+ * OrtApi::CreateSparseTensorWithValuesAsOrtValue above. It also sets OrtSparseFormat to
+ * ORT_SPARSE_BLOCK_SPARSE. This will not allocate any additional memory for data. The life span of
+ * indices_data buffer must eclipse the lifespan of this ::OrtValue.
+ *
+ * \paramin,out ort_value OrtValue instance constructed with OrtApi::CreateSparseTensorWithValuesAsOrtValue
+ * \paramin indices_shape pointer to indices shape. Use {0} for fully sparse tensors
+ * \paramin indices_shape_len length of the indices shape
+ * \paramin,out indices_data pointer to user pre-allocated buffer or nullptr for fully sparse tensors.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(UseBlockSparseIndices, _Inout_ OrtValue* ort_value, const int64_t* indices_shape, size_t indices_shape_len, _Inout_ int32_t* indices_data);
 
 /** \brief Returns sparse tensor format enum iff a given ort value contains an instance of sparse tensor.
- *
- * \paramin ort_value ::OrtValue that contains an instance of sparse tensor
- * \paramout out pointer to out parameter
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ort_value ::OrtValue that contains an instance of sparse tensor
+ * \paramout out pointer to out parameter
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSparseTensorFormat, _In_ const OrtValue* ort_value, _Out_ enum OrtSparseFormat* out);
 
 /** \brief Returns data type and shape of sparse tensor values (nnz) iff ::OrtValue contains a SparseTensor.
- *
- * \paramin ort_value An ::OrtValue that contains a fully constructed sparse tensor
- * \paramout out Must be freed by OrtApi::ReleaseTensorTypeAndShapeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ort_value An ::OrtValue that contains a fully constructed sparse tensor
+ * \paramout out Must be freed by OrtApi::ReleaseTensorTypeAndShapeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSparseTensorValuesTypeAndShape, _In_ const OrtValue* ort_value, _Outptr_ OrtTensorTypeAndShapeInfo** out);
 
 /** \brief Returns numeric data for sparse tensor values (nnz). For string values use GetStringTensor*().
- *
- * \paramin ort_value an instance of ::OrtValue containing sparse tensor
- * \paramout out returns a pointer to values data. Do not attempt to free this ptr.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ort_value an instance of ::OrtValue containing sparse tensor
+ * \paramout out returns a pointer to values data. Do not attempt to free this ptr.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSparseTensorValues, _In_ const OrtValue* ort_value, _Outptr_ const void** out);
 
 /** \brief Returns data type, shape for the type of indices specified by indices_format.
- *
- * \paramin ort_value ::OrtValue containing sparse tensor.
- * \paramin indices_format One of the indices formats. It is an error to request a format that the sparse
- * tensor does not contain.
- * \paramout out an instance of ::OrtTensorTypeAndShapeInfo. Must be freed by OrtApi::ReleaseTensorTypeAndShapeInfo
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ort_value ::OrtValue containing sparse tensor.
+ * \paramin indices_format One of the indices formats. It is an error to request a format that the sparse
+ * tensor does not contain.
+ * \paramout out an instance of ::OrtTensorTypeAndShapeInfo. Must be freed by OrtApi::ReleaseTensorTypeAndShapeInfo
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSparseTensorIndicesTypeShape, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Outptr_ OrtTensorTypeAndShapeInfo** out);
 
 /** \brief Returns indices data for the type of the indices specified by indices_format
- *
- * \paramin ort_value ::OrtValue containing sparse tensor.
- * \paramin indices_format One of the indices formats. It is an error to request a format that the sparse tensor does not contain.
- * \paramout num_indices Pointer to where the number of indices entries is returned
- * \paramout indices Returned pointer to the indices data. Do not free the returned pointer as it refers to internal data owned by the ::OrtValue
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin ort_value ::OrtValue containing sparse tensor.
+ * \paramin indices_format One of the indices formats. It is an error to request a format that the sparse tensor does not contain.
+ * \paramout num_indices Pointer to where the number of indices entries is returned
+ * \paramout indices Returned pointer to the indices data. Do not free the returned pointer as it refers to internal data owned by the ::OrtValue
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(GetSparseTensorIndices, _In_ const OrtValue* ort_value, enum OrtSparseIndicesFormat indices_format, _Out_ size_t* num_indices, _Outptr_ const void** indices);
 /// @}
 /// \name OrtSessionOptions
@@ -3095,20 +3145,23 @@
 * \snippet{doc} snippets.dox OrtStatus Return Value
 */
 ORT_API2_STATUS(HasValue, _In_ const OrtValue* value, _Out_ int* out);
+
 /// @}
 /// \name OrtKernelContext
+ /// Custom operator APIs.
 /// @{
+
 /** \brief Used for custom operators, gets the GPU compute stream to use to launch the custom a GPU kernel
- * \see ::OrtCustomOp
- * \paramin context OrtKernelContext instance
- * \paramout out Returns pointer to a GPU compute stream that can be used to launch the custom GPU kernel.
- * If retrieving the GPU compute stream is not relevant (GPU not enabled in the build, kernel partitioned to
- * some other EP), then a nullptr is returned as the output param.
- * Do not free or mutate the returned pointer as it refers to internal data owned by the underlying session.
- * Only use it for custom kernel launching.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * \see ::OrtCustomOp
+ * \paramin context OrtKernelContext instance
+ * \paramout out Returns pointer to a GPU compute stream that can be used to launch the custom GPU kernel.
+ * If retrieving the GPU compute stream is not relevant (GPU not enabled in the build, kernel partitioned to
+ * some other EP), then a nullptr is returned as the output param.
+ * Do not free or mutate the returned pointer as it refers to internal data owned by the underlying session.
+ * Only use it for custom kernel launching.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(KernelContext_GetGPUComputeStream, _In_ const OrtKernelContext* context, _Outptr_ void** out);
 
 /// @}
@@ -3142,105 +3195,105 @@
 /// \name SessionOptions
 /// @{
 /** \brief Set custom thread creation function
- *
- * \paramin options Session options
- * \paramin ort_custom_create_thread_fn Custom thread creation function
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options Session options
+ * \paramin ort_custom_create_thread_fn Custom thread creation function
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsSetCustomCreateThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
 
 /** \brief Set creation options for custom thread
- *
- * \paramin options Session options
- * \paramin ort_custom_thread_creation_options Custom thread creation options (can be nullptr)
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options Session options
+ * \paramin ort_custom_thread_creation_options Custom thread creation options (can be nullptr)
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsSetCustomThreadCreationOptions, _Inout_ OrtSessionOptions* options, _In_ void* ort_custom_thread_creation_options);
 
 /** \brief Set custom thread join function
- *
- * \paramin options Session options
- * \paramin ort_custom_join_thread_fn Custom join thread function, must not be nullptr when ort_custom_create_thread_fn is set
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paramin options Session options
+ * \paramin ort_custom_join_thread_fn Custom join thread function, must not be nullptr when ort_custom_create_thread_fn is set
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SessionOptionsSetCustomJoinThreadFn, _Inout_ OrtSessionOptions* options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
 /// @}
 
 /// \name OrtThreadingOptions
 /// @{
 /** \brief Set custom thread creation function for global thread pools
- *
- * \paraminout tp_options
- * \paramin ort_custom_create_thread_fn Custom thread creation function
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paraminout tp_options
+ * \paramin ort_custom_create_thread_fn Custom thread creation function
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalCustomCreateThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomCreateThreadFn ort_custom_create_thread_fn);
 
 /** \brief Set custom thread creation options for global thread pools
- *
- * \paraminout tp_options
- * \paramin ort_custom_thread_creation_options Custom thread creation options (can be nullptr)
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paraminout tp_options
+ * \paramin ort_custom_thread_creation_options Custom thread creation options (can be nullptr)
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalCustomThreadCreationOptions, _Inout_ OrtThreadingOptions* tp_options, _In_ void* ort_custom_thread_creation_options);
 
 /** \brief Set custom thread join function for global thread pools
- *
- * \paraminout tp_options
- * \paramin ort_custom_join_thread_fn Custom thread join function, must not be nullptr when global ort_custom_create_thread_fn is set
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ *
+ * \paraminout tp_options
+ * \paramin ort_custom_join_thread_fn Custom thread join function, must not be nullptr when global ort_custom_create_thread_fn is set
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SetGlobalCustomJoinThreadFn, _Inout_ OrtThreadingOptions* tp_options, _In_ OrtCustomJoinThreadFn ort_custom_join_thread_fn);
 /// @}
 
 /** \brief Synchronize bound inputs. The call may be necessary for some providers, such as cuda,
- * in case the system that allocated bound memory operated on a different stream. However, the
- * operation is provider specific and could be a no-op.
- *
- * \paraminout binding_ptr
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * in case the system that allocated bound memory operated on a different stream. However, the
+ * operation is provider specific and could be a no-op.
+ *
+ * \paraminout binding_ptr
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SynchronizeBoundInputs, _Inout_ OrtIoBinding* binding_ptr);
 
 /** \brief Synchronize bound outputs. The call may be necessary for some providers, such as cuda,
- * in case the system that allocated bound memory operated on a different stream. However, the
- * operation is provider specific and could be a no-op.
- *
- * \paraminout binding_ptr
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- */
+ * in case the system that allocated bound memory operated on a different stream. However, the
+ * operation is provider specific and could be a no-op.
+ *
+ * \paraminout binding_ptr
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
 ORT_API2_STATUS(SynchronizeBoundOutputs, _Inout_ OrtIoBinding* binding_ptr);
 
 /// \name OrtSessionOptions
 /// @{
 
 /** \brief Append CUDA execution provider to the session options
- *
- * If CUDA is not available (due to a non CUDA enabled build), this function will return failure.
- *
- * This is slightly different from OrtApi::SessionOptionsAppendExecutionProvider_CUDA, it takes an
- * ::OrtCUDAProviderOptions which is publicly defined. This takes an opaque ::OrtCUDAProviderOptionsV2
- * which must be created with OrtApi::CreateCUDAProviderOptions.
- *
- * For OrtApi::SessionOptionsAppendExecutionProvider_CUDA, the user needs to instantiate ::OrtCUDAProviderOptions
- * as well as allocate/release buffers for some members of ::OrtCUDAProviderOptions.
- * Here, OrtApi::CreateCUDAProviderOptions and Ortapi::ReleaseCUDAProviderOptions will do the memory management for you.
- *
- * \paramin options
- * \paramin cuda_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.11.
- */
+ *
+ * If CUDA is not available (due to a non CUDA enabled build), this function will return failure.
+ *
+ * This is slightly different from OrtApi::SessionOptionsAppendExecutionProvider_CUDA, it takes an
+ * ::OrtCUDAProviderOptions which is publicly defined. This takes an opaque ::OrtCUDAProviderOptionsV2
+ * which must be created with OrtApi::CreateCUDAProviderOptions.
+ *
+ * For OrtApi::SessionOptionsAppendExecutionProvider_CUDA, the user needs to instantiate ::OrtCUDAProviderOptions
+ * as well as allocate/release buffers for some members of ::OrtCUDAProviderOptions.
+ * Here, OrtApi::CreateCUDAProviderOptions and Ortapi::ReleaseCUDAProviderOptions will do the memory management for you.
+ *
+ * \paramin options
+ * \paramin cuda_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.11.
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_CUDA_V2,
 _In_ OrtSessionOptions* options, _In_ const OrtCUDAProviderOptionsV2* cuda_options);
 
@@ -3249,112 +3302,112 @@
 /// @{
 
 /** \brief Create an OrtCUDAProviderOptionsV2
- *
- * \paramout out Newly created ::OrtCUDAProviderOptionsV2. Must be released with OrtApi::ReleaseCudaProviderOptions
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.11.
- */
+ *
+ * \paramout out Newly created ::OrtCUDAProviderOptionsV2. Must be released with OrtApi::ReleaseCudaProviderOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.11.
+ */
 ORT_API2_STATUS(CreateCUDAProviderOptions, _Outptr_ OrtCUDAProviderOptionsV2** out);
 
 /** \brief Set options in a CUDA Execution Provider.
- *
- * Please refer to https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#configuration-options
- * to know the available keys and values. Key should be in null terminated string format of the member of ::OrtCUDAProviderOptionsV2
- * and value should be its related range.
- *
- * For example, key="device_id" and value="0"
- *
- * \paramin cuda_options
- * \paramin provider_options_keys Array of UTF-8 null-terminated string for provider options keys
- * \paramin provider_options_values Array of UTF-8 null-terminated string for provider options values
- * \paramin num_keys Number of elements in the `provider_option_keys` and `provider_options_values` arrays
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.11.
- */
+ *
+ * Please refer to https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#configuration-options
+ * to know the available keys and values. Key should be in null terminated string format of the member of ::OrtCUDAProviderOptionsV2
+ * and value should be its related range.
+ *
+ * For example, key="device_id" and value="0"
+ *
+ * \paramin cuda_options
+ * \paramin provider_options_keys Array of UTF-8 null-terminated string for provider options keys
+ * \paramin provider_options_values Array of UTF-8 null-terminated string for provider options values
+ * \paramin num_keys Number of elements in the `provider_option_keys` and `provider_options_values` arrays
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.11.
+ */
 ORT_API2_STATUS(UpdateCUDAProviderOptions, _Inout_ OrtCUDAProviderOptionsV2* cuda_options,
 _In_reads_(num_keys) const char* const* provider_options_keys,
 _In_reads_(num_keys) const char* const* provider_options_values,
 _In_ size_t num_keys);
 
 /**
- * Get serialized CUDA provider options string.
- *
- * For example, "device_id=0;arena_extend_strategy=0;......"
- *
- * \param cuda_options - OrtCUDAProviderOptionsV2 instance
- * \param allocator - a ptr to an instance of OrtAllocator obtained with CreateAllocator() or GetAllocatorWithDefaultOptions()
- * the specified allocator will be used to allocate continuous buffers for output strings and lengths.
- * \param ptr - is a UTF-8 null terminated string allocated using 'allocator'. The caller is responsible for using the same allocator to free it.
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.11.
- */
+ * Get serialized CUDA provider options string.
+ *
+ * For example, "device_id=0;arena_extend_strategy=0;......"
+ *
+ * \param cuda_options - OrtCUDAProviderOptionsV2 instance
+ * \param allocator - a ptr to an instance of OrtAllocator obtained with CreateAllocator() or GetAllocatorWithDefaultOptions()
+ * the specified allocator will be used to allocate continuous buffers for output strings and lengths.
+ * \param ptr - is a UTF-8 null terminated string allocated using 'allocator'. The caller is responsible for using the same allocator to free it.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.11.
+ */
 ORT_API2_STATUS(GetCUDAProviderOptionsAsString, _In_ const OrtCUDAProviderOptionsV2* cuda_options, _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
 
 /** \brief Release an ::OrtCUDAProviderOptionsV2
- *
- * \note This is an exception in the naming convention of other Release* functions, as the name of the method does not have the V2 suffix, but the type does
- *
- * \since Version 1.11.
- */
+ *
+ * \note This is an exception in the naming convention of other Release* functions, as the name of the method does not have the V2 suffix, but the type does
+ *
+ * \since Version 1.11.
+ */
 void(ORT_API_CALL* ReleaseCUDAProviderOptions)(_Frees_ptr_opt_ OrtCUDAProviderOptionsV2* input);
 
 /// @}
 
 /** \brief Append MIGraphX provider to session options
- *
- * If MIGraphX is not available (due to a non MIGraphX enabled build, or if MIGraphX is not installed on the system), this function will return failure.
- *
- * \paramin options
- * \paramin migraphx_options
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.11.
- */
+ *
+ * If MIGraphX is not available (due to a non MIGraphX enabled build, or if MIGraphX is not installed on the system), this function will return failure.
+ *
+ * \paramin options
+ * \paramin migraphx_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.11.
+ */
 ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_MIGraphX,
 _In_ OrtSessionOptions* options, _In_ const OrtMIGraphXProviderOptions* migraphx_options);
 
- /** \brief Replace initialized Tensors with external data with the data provided in initializers.
- *
- * The function will find the initialized TensorProtos with external data in the graph with the provided names and
- * replace them with the provided tensors. The API verifies that the TensorProto being replaced
- * has an external data reference and has the same name, dimensions and data type as its replacement. The replacement
- * will occur before any of the optimizations take place. The data will be copied into the graph
- * since TensorProto can't refer to the user provided buffers.
- *
- * Once the model has been loaded, the OrtValue(s) added to SessionOptions instance will be removed
- * from the internal SessionOptions copy to save memory, the user provided buffers can then be deallocated
- * and the SessionOptions instance that refers to them can be destroyed.
- *
- * \paramin options
- * \paramin initializer_names Array of null terminated UTF-8 encoded strings of the initializers names.
- * \paramin initializers Array of ::OrtValue type
- * \paramin initializers_num Number of elements in the initializer_names and initializers
- *
- * \snippet{doc} snippets.dox OrtStatus Return Value
- *
- * \since Version 1.12.
- */
+ /** \brief Replace initialized Tensors with external data with the data provided in initializers.
+ *
+ * The function will find the initialized TensorProtos with external data in the graph with the provided names and
+ * replace them with the provided tensors. The API verifies that the TensorProto being replaced
+ * has an external data reference and has the same name, dimensions and data type as its replacement. The replacement
+ * will occur before any of the optimizations take place. The data will be copied into the graph
+ * since TensorProto can't refer to the user provided buffers.
+ *
+ * Once the model has been loaded, the OrtValue(s) added to SessionOptions instance will be removed
+ * from the internal SessionOptions copy to save memory, the user provided buffers can then be deallocated
+ * and the SessionOptions instance that refers to them can be destroyed.
+ *
+ * \paramin options
+ * \paramin initializer_names Array of null terminated UTF-8 encoded strings of the initializers names.
+ * \paramin initializers Array of ::OrtValue type
+ * \paramin initializers_num Number of elements in the initializer_names and initializers
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.12.
+ */
 ORT_API2_STATUS(AddExternalInitializers, _In_ OrtSessionOptions* options,
 _In_reads_(input_len) const char* const* initializer_names,
 _In_reads_(input_len) const OrtValue* const* initializers, size_t initializers_num);
 
 /** \brief: Create attribute of onnxruntime operator
- * 
- * \paramin name Name of the attribute
- * \paramin data Data content of the attribute
- * \paramin len Number of bytes stored in data
- * \paramin type Data type
- * \paramout op_attr Attribute that has been created, which must be released by OrtApi::ReleaseOpAttr
- * 
- * \since Version 1.12.
- */
+ *
+ * \paramin name Name of the attribute
+ * \paramin data Data content of the attribute
+ * \paramin len Number of bytes stored in data
+ * \paramin type Data type
+ * \paramout op_attr Attribute that has been created, which must be released by OrtApi::ReleaseOpAttr
+ *
+ * \since Version 1.12.
+ */
 ORT_API2_STATUS(CreateOpAttr,
 _In_ const char* name,
 _In_ const void* data,
@@ -3363,30 +3416,30 @@
 _Outptr_ OrtOpAttr** op_attr);
 
 /* \brief: Release op attribute
- *
- * \paramin opAttr Attribute created by OrtApi::CreateOpAttr
- * 
- * \since Version 1.12.
- */
+ *
+ * \paramin opAttr Attribute created by OrtApi::CreateOpAttr
+ *
+ * \since Version 1.12.
+ */
 ORT_CLASS_RELEASE(OpAttr);
 
 /** \brief: Create onnxruntime native operator
- * 
- * \paramin info Kernel info 
- * \paramin op_name Operator name
- * \paramin domain Operator domain
- * \paramin version Operator opset version
- * \paramin type_constraint_names Name of the type contraints, such as "T" or "T1"
- * \paramin type_constraint_values Type of each contraints
- * \paramin type_constraint_count Number of contraints
- * \paramin attr_values Attributes used to initialize the operator
- * \paramin attr_count Number of the attributes
- * \paramin input_count Number of inputs
- * \paramin output_count Number of outputs
- * \paramout ort_op Operator that has been created
- * 
- * \since Version 1.12.
- */
+ *
+ * \paramin info Kernel info
+ * \paramin op_name Operator name
+ * \paramin domain Operator domain
+ * \paramin version Operator opset version
+ * \paramin type_constraint_names Name of the type contraints, such as "T" or "T1"
+ * \paramin type_constraint_values Type of each contraints
+ * \paramin type_constraint_count Number of contraints
+ * \paramin attr_values Attributes used to initialize the operator
+ * \paramin attr_count Number of the attributes
+ * \paramin input_count Number of inputs
+ * \paramin output_count Number of outputs
+ * \paramout ort_op Operator that has been created
+ *
+ * \since Version 1.12.
+ */
 ORT_API2_STATUS(CreateOp,
 _In_ const OrtKernelInfo* info,
 _In_ const char* op_name,
@@ -3402,17 +3455,17 @@
 _Outptr_ OrtOp** ort_op);
 
 /** \brief: Invoke the operator created by OrtApi::CreateOp
- * The inputs must follow the order as specified in onnx specification
- * 
- * \paramin context Kernel context
- * \paramin ort_op Operator that has been created
- * \paramin input_values Array of inputs
- * \paramin input_count Number of inputs
- * \paramin output_values Array of outputs
- * \paramin output_count Number of outputs
- * 
- * \since Version 1.12.
- */
+ * The inputs must follow the order as specified in onnx specification
+ *
+ * \paramin context Kernel context
+ * \paramin ort_op Operator that has been created
+ * \paramin input_values Array of inputs
+ * \paramin input_count Number of inputs
+ * \paramin output_values Array of outputs
+ * \paramin output_count Number of outputs
+ *
+ * \since Version 1.12.
+ */
 ORT_API2_STATUS(InvokeOp,
 _In_ const OrtKernelContext* context,
 _In_ const OrtOp* ort_op,
@@ -3422,14 +3475,15 @@
 _In_ int output_count);
 
 /* \brief: Release an onnxruntime operator
- *
- * \paramin Op Operator created by OrtApi::CreateOp
- * 
- * \since Version 1.12.
- */
+ *
+ * \paramin Op Operator created by OrtApi::CreateOp
+ *
+ * \since Version 1.12.
+ */
 ORT_CLASS_RELEASE(Op);
 
 /** \brief: Append execution provider to the session options.
+ * \paramin options
 * \paramin provider_name - provider to add.
 * \paramin provider_options_keys - keys to configure the provider options
 * \paramin provider_options_values - values to configure the provider options
@@ -3450,7 +3504,6 @@
 * GPU_FLOAT16 => zdl::DlSystem::Runtime_t::GPU_FLOAT16;
 * DSP, DSP_FIXED8_TF => zdl::DlSystem::Runtime_t::DSP.
 * AIP_FIXED_TF, AIP_FIXED8_TF => zdl::DlSystem::Runtime_t::AIP_FIXED_TF.
- * SNPE Runtime_t refers to https://developer.qualcomm.com/docs/snpe/group__c__plus__plus__apis.html
 * "priority": execution priority, options: "low", "normal".
 * "buffer_type": ITensor or user buffers, options: "ITENSOR", user buffer with different types - "TF8", "TF16", "UINT8", "FLOAT".
 * "ITENSOR" -- default, ITensor which is float only.
@@ -3458,7 +3511,8 @@
 * If SNPE is not available (due to a non Snpe enabled build or its dependencies not being installed), this function will fail.
 *
 * XNNPACK supported keys:
- * None currently
+ * "intra_op_num_threads": number of thread-pool size to use for XNNPACK execution provider.
+ * default value is 0, which means to use the session thread-pool size.
 *
 * \since Version 1.12.
 */
@@ -3469,23 +3523,365 @@
 _In_ size_t num_keys);
 
 /* \brief: Get a copy of kernel info
- *
- * \paramin info Kernel info
- * \paramout info_copy Copy of kernel info
- *
- * \since Version 1.12.
- */
+ *
+ * \paramin info Kernel info
+ * \paramout info_copy Copy of kernel info
+ *
+ * \since Version 1.12.
+ */
 ORT_API2_STATUS(CopyKernelInfo,
 _In_ const OrtKernelInfo* info,
 _Outptr_ OrtKernelInfo** info_copy);
 
 /* \brief: Release kernel info
- * 
- * \paramin KernelInfo A copy of kernel info returned by CopyKernelInfo
- * 
- * \since Version 1.12.
- */
+ *
+ * \paramin KernelInfo A copy of kernel info returned by CopyKernelInfo
+ *
+ * \since Version 1.12.
+ */
 ORT_CLASS_RELEASE(KernelInfo);
+
+ /* \brief: Get the training C Api
+ *
+ * \since Version 1.13
+ */
+ const OrtTrainingApi*(ORT_API_CALL* GetTrainingApi)(uint32_t version)NO_EXCEPTION;
+
+ /** \brief Append CANN provider to session options
+ *
+ * If CANN is not available (due to a non CANN enabled build, or if CANN is not installed on the system), this function will return failure.
+ *
+ * \paramin options
+ * \paramin cann_options
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.13.
+ */
+ ORT_API2_STATUS(SessionOptionsAppendExecutionProvider_CANN,
+ _In_ OrtSessionOptions* options, _In_ const OrtCANNProviderOptions* cann_options);
+
+ /** \brief Create an OrtCANNProviderOptions
+ *
+ * \paramout out created ::OrtCANNProviderOptions. Must be released with OrtApi::ReleaseCANNProviderOptions
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.13.
+ */
+ ORT_API2_STATUS(CreateCANNProviderOptions, _Outptr_ OrtCANNProviderOptions** out);
+
+ /** \brief Set options in a CANN Execution Provider.
+ *
+ * \paramin cann_options
+ * \paramin provider_options_keys Array of UTF-8 null-terminated string for provider options keys
+ * \paramin provider_options_values Array of UTF-8 null-terminated string for provider options values
+ * \paramin num_keys Number of elements in the `provider_option_keys` and `provider_options_values` arrays
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.13.
+ */
+ ORT_API2_STATUS(UpdateCANNProviderOptions, _Inout_ OrtCANNProviderOptions* cann_options,
+ _In_reads_(num_keys) const char* const* provider_options_keys,
+ _In_reads_(num_keys) const char* const* provider_options_values,
+ _In_ size_t num_keys);
+
+ /** \brief Get serialized CANN provider options string.
+ *
+ * \paramin cann_options OrtCANNProviderOptions instance
+ * \paramin allocator a ptr to an instance of OrtAllocator obtained with CreateAllocator()
+ * or GetAllocatorWithDefaultOptions(), the specified allocator will be used to allocate
+ * continuous buffers for output strings and lengths.
+ * \paramout ptr is a UTF-8 null terminated string allocated using 'allocator'.
+ * The caller is responsible for using the same allocator to free it.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ *
+ * \since Version 1.13.
+ */
+ ORT_API2_STATUS(GetCANNProviderOptionsAsString, _In_ const OrtCANNProviderOptions* cann_options,
+ _Inout_ OrtAllocator* allocator, _Outptr_ char** ptr);
+
+ /** \brief Release an OrtCANNProviderOptions
+ *
+ * \paramin the pointer of OrtCANNProviderOptions which will been deleted
+ *
+ * \since Version 1.13.
+ */
+ void(ORT_API_CALL* ReleaseCANNProviderOptions)(_Frees_ptr_opt_ OrtCANNProviderOptions* input);
+
+ /* \brief Get OrtDevice type from MemoryInfo
+ *
+ * \since Version 1.14
+ */
+ void(ORT_API_CALL* MemoryInfoGetDeviceType)(_In_ const OrtMemoryInfo* ptr, _Out_ OrtMemoryInfoDeviceType* out);
+
+ /* \brief Update the OrtEnv instance with custom log severity level
+ *
+ * \paramin ort_env The OrtEnv instance being used
+ * \paramin log_severity_level The log severity level.
+ *
+ * \since Version 1.14.
+ */
+ ORT_API2_STATUS(UpdateEnvWithCustomLogLevel, _In_ OrtEnv* ort_env, OrtLoggingLevel log_severity_level);
+
+ /* \brief Set affinities for intra op threads
+ *
+ * Affinity string follows format:
+ * logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
+ * Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
+ * e.g. 1,2,3;4,5
+ * specifies affinities for two threads, with the 1st thread attach to the 1st, 2nd, and 3rd processor, and 2nd thread to the 4th and 5th.
+ * To ease the configuration, an "interval" is also allowed:
+ * e.g. 1-8;8-16;17-24
+ * orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
+ * Note:
+ * 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1,
+ * ort does not set affinity on the main thread which is started and managed by the calling app;
+ * 2. For windows, ort will infer the group id from a logical processor id, for example, assuming there are two groups with each has 64 logical processors,
+ * an id of 64 will be inferred as the last processor of the 1st group, while 65 will be interpreted as the 1st processor of the second group.
+ * Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
+ *
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(SetGlobalIntraOpThreadAffinity, _Inout_ OrtThreadingOptions* tp_options, const char* affinity_string);
+
+ /** \brief Register custom ops from a shared library.
+ *
+ * Loads a shared library (.dll on windows, .so on linux, etc) named 'library_name' and looks for this entry point:
+ *		OrtStatus* RegisterCustomOps(OrtSessionOptions * options, const OrtApiBase* api);
+ * It then passes in the provided session options to this function along with the api base.
+ *
+ * The handle to the loaded library is automatically released by ORT when the last OrtSession that references the
+ * library handle is released. If no OrtSession is created, then the library handle is released when the provided
+ * OrtSessionOptions is released.
+ *
+ * \paramin options The session options.
+ * \paramin library_name The name of the shared library to load and register. Refer to OS-specific dynamic library
+ * loading utilities (e.g., LoadLibraryEx on Windows or dlopen on Linux/MacOS) for information
+ * on the format of library names and search paths.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(RegisterCustomOpsLibrary_V2, _Inout_ OrtSessionOptions* options, _In_ const ORTCHAR_T* library_name);
+
+ /** \brief Register custom ops by calling a RegisterCustomOpsFn function.
+ *
+ * Searches for registration_func_name and if found calls it.
+ *
+ * The library containing the function must either be linked against or previously loaded by the executable.
+ *
+ * If you want ONNX Runtime to load the library and manage its lifetime, use RegisterCustomOpsLibrary_V2.
+ *
+ * RegisterCustomOpsUsingFunction can be used in scenarios where it may not be possible for ONNX Runtime to load
+ * the library from a path. e.g. mobile platforms where the library must be linked into the app.
+ *
+ * The registration function must have the signature of RegisterCustomOpsFn:
+ * OrtStatus* (*fn)(OrtSessionOptions* options, const OrtApiBase* api);
+ *
+ * See https://onnxruntime.ai/docs/reference/operators/add-custom-op.html for details on how the registration
+ * function should be implemented.
+ *
+ * \paramin options OrtSessionOptions that is passed through as the first argument in the call to the
+ * registration function.
+ * \paramin registration_func_name Name of registration function to use.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(RegisterCustomOpsUsingFunction, _Inout_ OrtSessionOptions* options,
+ _In_ const char* registration_func_name);
+
+ /// @}
+ /// \name OrtKernelInfo
+ /// Custom operator APIs.
+ /// @{
+
+ /** \brief Get the number of inputs from ::OrtKernelInfo.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query the number of inputs
+ * during kernel/session creation.
+ *
+ * \paramin info Instance of ::OrtKernelInfo.
+ * \paramout out Pointer to variable assigned with the result on success.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetInputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
+
+ /** \brief Get the number of outputs from ::OrtKernelInfo.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query the number of outputs
+ * during kernel/session creation.
+ *
+ * \paramin info Instance of ::OrtKernelInfo.
+ * \paramout out Pointer to variable assigned with the result on success.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetOutputCount, _In_ const OrtKernelInfo* info, _Out_ size_t* out);
+
+ /** \brief Get the name of a ::OrtKernelInfo's input.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query an input's name
+ * during kernel/session creation.
+ *
+ * If `out` is nullptr, the value of `size` is set to the size of the name
+ * string (including null-terminator), and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the name string's size,
+ * the value of `size` is set to the true size of the string (including null-terminator),
+ * the provided memory is filled with the string's contents, and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual string's size and `out`
+ * is not nullptr, the value of `size` is set to the true size of the string
+ * and a failure status is returned.
+ *
+ * \paramin info An instance of ::OrtKernelInfo.
+ * \paramin index The index of the input name to get. Returns a failure status if out-of-bounds.
+ * \paramout out Memory location into which to write the UTF-8 null-terminated string representing the input's name.
+ * \paramin,out size Pointer to the size of the `out` buffer. See above comments for details.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetInputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
+ _Inout_ size_t* size);
+
+ /** \brief Get the name of a ::OrtKernelInfo's output.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query an output's name
+ * during kernel/session creation.
+ *
+ * If `out` is nullptr, the value of `size` is set to the size of the name
+ * string (including null-terminator), and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the name string's size,
+ * the value of `size` is set to the true size of the string (including null-terminator),
+ * the provided memory is filled with the string's contents, and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual string's size and `out`
+ * is not nullptr, the value of `size` is set to the true size of the string
+ * and a failure status is returned.
+ *
+ * \paramin info An instance of ::OrtKernelInfo.
+ * \paramin index The index of the output name to get. Returns a failure status if out-of-bounds.
+ * \paramout out Memory location into which to write the UTF-8 null-terminated string representing the output's
+ * name.
+ * \paramin,out size Pointer to the size of the `out` buffer. See above comments for details.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetOutputName, _In_ const OrtKernelInfo* info, size_t index, _Out_ char* out,
+ _Inout_ size_t* size);
+
+ /** \brief Get the type information for a ::OrtKernelInfo's input.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query the shape and type information
+ * of an input during kernel/session creation.
+ *
+ * \paramin info An instance of ::OrtKernelInfo.
+ * \paramout type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetInputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
+ _Outptr_ OrtTypeInfo** type_info);
+
+ /** \brief Get the type information for a ::OrtKernelInfo's output.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to query the shape and type information
+ * of an output during kernel/session creation.
+ *
+ * \paramin info An instance of ::OrtKernelInfo.
+ * \paramout type_info Pointer set to the resulting ::OrtTypeInfo. Must be freed with OrtApi::ReleaseTypeInfo.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(KernelInfo_GetOutputTypeInfo, _In_ const OrtKernelInfo* info, size_t index,
+ _Outptr_ OrtTypeInfo** type_info);
+
+ /** \brief Get a ::OrtValue tensor stored as an attribute in the graph node.
+ *
+ * Used in the CreateKernel callback of an OrtCustomOp to get a tensor attribute.
+ *
+ * \paramin info ::OrtKernelInfo instance.
+ * \paramin name UTF-8 null-terminated string representing the attribute's name.
+ * \paramin allocator Allocator used to allocate the internal tensor state.
+ * \paramout out Returns newly created ::OrtValue. Must be freed with OrtApi::ReleaseValue,
+ * which will also free internal tensor state allocated with the provided allocator.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ */
+ ORT_API2_STATUS(KernelInfoGetAttribute_tensor, _In_ const OrtKernelInfo* info, _In_z_ const char* name,
+ _Inout_ OrtAllocator* allocator, _Outptr_ OrtValue** out);
+
+ /// @}
+ /// \name OrtSessionOptions
+ /// Custom operator APIs
+ /// @{
+
+ /** \brief Checks if the given session configuration entry exists.
+ *
+ * The config_key formats are defined in onnxruntime_session_options_config_keys.h
+ *
+ * Can be used in a custom operator library to check for session configuration entries
+ * that target one or more custom operators in the library. Example: The config entry
+ * custom_op.myop.some_key targets a custom op named "myop".
+ *
+ * \paramin options The ::OrtSessionOptions instance.
+ * \paramin config_key A null-terminated UTF-8 string representation of the configuration key.
+ * \paramout out Pointer set to 1 if the entry exists and 0 otherwise.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(HasSessionConfigEntry, _In_ const OrtSessionOptions* options,
+ _In_z_ const char* config_key, _Out_ int* out);
+
+ /** \brief Get a session configuration value.
+ *
+ * Returns a failure status if the configuration key does not exist.
+ * The config_key and the format of config_value are defined in onnxruntime_session_options_config_keys.h
+ *
+ * If `config_value` is nullptr, the value of `size` is set to the true size of the string
+ * value (including null-terminator), and a success status is returned.
+ *
+ * If the `size` parameter is greater than or equal to the actual string value's size,
+ * the value of `size` is set to the true size of the string value, the provided memory
+ * is filled with the value's contents, and a success status is returned.
+ *
+ * If the `size` parameter is less than the actual string value's size and `config_value`
+ * is not nullptr, the value of `size` is set to the true size of the string value
+ * and a failure status is returned.
+ *
+ * Can be used in a custom operator library to get session configuration entries
+ * that target one or more custom operators in the library. Example: The config entry
+ * custom_op.myop.some_key targets a custom op named "myop".
+ *
+ * \paramin options The session options.
+ * \paramin config_key A null-terminated UTF-8 string representation of the config key.
+ * \paramin config_value Pointer to memory where the null-terminated UTF-8 string value will be stored.
+ * \paramin,out size Pointer to the size of the `config_value` buffer. See above comments for details.
+ *
+ * \snippet{doc} snippets.dox OrtStatus Return Value
+ * \since Version 1.14
+ */
+ ORT_API2_STATUS(GetSessionConfigEntry, _In_ const OrtSessionOptions* options,
+ _In_z_ const char* config_key, _Out_ char* config_value, _Inout_ size_t* size);
+
+ /// @}
+
+#ifdef __cplusplus
+ OrtApi(const OrtApi&) = delete; // Prevent users from accidentally copying the API structure, it should always be passed as a pointer
+#endif
 };
 
 /*
@@ -3493,23 +3889,26 @@
 * 1 Create an OrtCustomOpDomain with the domain name used by the custom ops
 * 2 Create an OrtCustomOp structure for each op and add them to the domain
 * 3 Call OrtAddCustomOpDomain to add the custom domain of ops to the session options
-*/
-#define OrtCustomOpApi OrtApi
+ */
 
 // Specifies some characteristics of inputs/outputs of custom ops:
 // Specify if the inputs/outputs are one of:
 // 1) Non-optional (input/output must be present in the node)
 // 2) Optional (input/output may be absent in the node)
+// 3) Variadic: A variadic input or output specifies N (i.e., the minimum arity) or more operands.
+// Only the last input or output of a custom op may be marked as variadic.
+// The homogeneity of the variadic input or output determines whether all operands must be of the same
+// tensor element type.
 typedef enum OrtCustomOpInputOutputCharacteristic {
- // TODO: Support 'Variadic' inputs/outputs
 INPUT_OUTPUT_REQUIRED = 0,
 INPUT_OUTPUT_OPTIONAL,
+ INPUT_OUTPUT_VARIADIC,
 } OrtCustomOpInputOutputCharacteristic;
 
 /*
 * The OrtCustomOp structure defines a custom op's schema and its kernel callbacks. The callbacks are filled in by
 * the implementor of the custom op.
-*/
+ */
 struct OrtCustomOp {
 uint32_t version; // Must be initialized to ORT_API_VERSION
 
@@ -3536,6 +3935,31 @@
 // Returns the characteristics of the input & output tensors
 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetInputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
 OrtCustomOpInputOutputCharacteristic(ORT_API_CALL* GetOutputCharacteristic)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
+
+ // Returns the memory type of the input tensors. This API allows the custom op
+ // to place the inputs on specific devices. By default, it returns
+ // OrtMemTypeDefault, which means the input is placed on the default device for
+ // the execution provider. If the inputs need to be with different memory tyeps,
+ // this function can be overridden to return the specific memory types.
+ OrtMemType(ORT_API_CALL* GetInputMemoryType)(_In_ const struct OrtCustomOp* op, _In_ size_t index);
+
+ // Returns the minimum number of input arguments expected for the variadic input.
+ // Applicable only for custom ops that have a variadic input.
+ int(ORT_API_CALL* GetVariadicInputMinArity)(_In_ const struct OrtCustomOp* op);
+
+ // Returns true (non-zero) if all arguments of a variadic input have to be of the same type (homogeneous),
+ // and false (zero) otherwise.
+ // Applicable only for custom ops that have a variadic input.
+ int(ORT_API_CALL* GetVariadicInputHomogeneity)(_In_ const struct OrtCustomOp* op);
+
+ // Returns the minimum number of output values expected for the variadic output.
+ // Applicable only for custom ops that have a variadic output.
+ int(ORT_API_CALL* GetVariadicOutputMinArity)(_In_ const struct OrtCustomOp* op);
+
+ // Returns true (non-zero) if all outputs values of a variadic output have to be of the same type (homogeneous),
+ // and false (zero) otherwise.
+ // Applicable only for custom ops that have a variadic output.
+ int(ORT_API_CALL* GetVariadicOutputHomogeneity)(_In_ const struct OrtCustomOp* op);
 };
 
 /*
@@ -3543,7 +3967,7 @@
 * This function always exists, but will only succeed if Onnxruntime was built with CUDA support and the CUDA provider shared library exists
 *
 * \param device_id CUDA device id, starts from zero.
-*/
+ */
 ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_CUDA, _In_ OrtSessionOptions* options, int device_id);
 
 /*
@@ -3553,7 +3977,7 @@
 * HIP support and the MIGraphX provider shared library exists
 *
 * \param device_id HIP device id, starts from zero.
-*/
+ */
 ORT_API_STATUS(OrtSessionOptionsAppendExecutionProvider_MIGraphX, _In_ OrtSessionOptions* options, int device_id);
 
 #ifdef __cplusplus

onnxruntime-linux-x64-1.12.1.tgz/include/onnxruntime_cxx_api.h -> onnxruntime-linux-x64-1.14.1.tgz/include/onnxruntime_cxx_api.h Changed

@@ -4,13 +4,23 @@
 // Summary: The Ort C++ API is a header only wrapper around the Ort C API.
 //
 // The C++ API simplifies usage by returning values directly instead of error codes, throwing exceptions on errors
-// and automatically releasing resources in the destructors.
+// and automatically releasing resources in the destructors. The primary purpose of C++ API is exception safety so
+// all the resources follow RAII and do not leak memory.
 //
 // Each of the C++ wrapper classes holds only a pointer to the C internal object. Treat them like smart pointers.
-// To create an empty object, pass 'nullptr' to the constructor (for example, Env e{nullptr};).
+// To create an empty object, pass 'nullptr' to the constructor (for example, Env e{nullptr};). However, you can't use them
+// until you assign an instance that actually holds an underlying object.
 //
-// Only move assignment between objects is allowed, there are no copy constructors. Some objects have explicit 'Clone'
-// methods for this purpose.
+// For Ort objects only move assignment between objects is allowed, there are no copy constructors.
+// Some objects have explicit 'Clone' methods for this purpose.
+//
+// ConstXXXX types are copyable since they do not own the underlying C object, so you can pass them to functions as arguments
+// by value or by reference. ConstXXXX types are restricted to const only interfaces.
+//
+// UnownedXXXX are similar to ConstXXXX but also allow non-const interfaces.
+//
+// The lifetime of the corresponding owning object must eclipse the lifetimes of the ConstXXXX/UnownedXXXX types. They exists so you do not
+// have to fallback to C types and the API with the usual pitfalls. In general, do not use C API from your C++ code.
 
 #pragma once
 #include "onnxruntime_c_api.h"
@@ -29,14 +39,14 @@
 #endif
 
 /** \brief All C++ Onnxruntime APIs are defined inside this namespace
-* 
-*/
+ *
+ */
 namespace Ort {
 
 /** \brief All C++ methods that can fail will throw an exception of this type
-* 
-* If <tt>ORT_NO_EXCEPTIONS</tt> is defined, then any error will result in a call to abort()
-*/
+ *
+ * If <tt>ORT_NO_EXCEPTIONS</tt> is defined, then any error will result in a call to abort()
+ */
 struct Exception : std::exception {
 Exception(std::string&& string, OrtErrorCode code) : message_{std::move(string)}, code_{code} {}
 
@@ -65,7 +75,8 @@
 throw Ort::Exception(string, code)
 #endif
 
-// This is used internally by the C++ API. This class holds the global variable that points to the OrtApi, it's in a template so that we can define a global variable in a header and make
+// This is used internally by the C++ API. This class holds the global variable that points to the OrtApi,
+// it's in a template so that we can define a global variable in a header and make
 // it transparent to the users of the API.
 template <typename T>
 struct Global {
@@ -77,6 +88,22 @@
 #ifdef ORT_API_MANUAL_INIT
 const OrtApi* Global<T>::api_{};
 inline void InitApi() { Global<void>::api_ = OrtGetApiBase()->GetApi(ORT_API_VERSION); }
+
+// Used by custom operator libraries that are not linked to onnxruntime. Sets the global API object, which is
+// required by C++ APIs.
+//
+// Example mycustomop.cc:
+//
+// #define ORT_API_MANUAL_INIT
+// #include <onnxruntime_cxx_api.h>
+// #undef ORT_API_MANUAL_INIT
+//
+// OrtStatus* ORT_API_CALL RegisterCustomOps(OrtSessionOptions* options, const OrtApiBase* api_base) {
+// Ort::InitApi(api_base->GetApi(ORT_API_VERSION));
+// // ...
+// }
+//
+inline void InitApi(const OrtApi* api) { Global<void>::api_ = api; }
 #else
 #if defined(_MSC_VER) && !defined(__clang__)
 #pragma warning(push)
@@ -93,9 +120,83 @@
 /// This returns a reference to the OrtApi interface in use
 inline const OrtApi& GetApi() { return *Global<void>::api_; }
 
-/// This is a C++ wrapper for OrtApi::GetAvailableProviders() and returns a vector of strings representing the available execution providers.
+/// <summary>
+/// This is a C++ wrapper for OrtApi::GetAvailableProviders() and
+/// returns a vector of strings representing the available execution providers.
+/// </summary>
+/// <returns>vector of strings</returns>
 std::vector<std::string> GetAvailableProviders();
 
+/** \brief IEEE 754 half-precision floating point data type
+ * \details It is necessary for type dispatching to make use of C++ API
+ * The type is implicitly convertible to/from uint16_t.
+ * The size of the structure should align with uint16_t and one can freely cast
+ * uint16_t buffers to/from Ort::Float16_t to feed and retrieve data.
+ *
+ * Generally, you can feed any of your types as float16/blfoat16 data to create a tensor
+ * on top of it, providing it can form a continuous buffer with 16-bit elements with no padding.
+ * And you can also feed a array of uint16_t elements directly. For example,
+ *
+ * \code{.unparsed}
+ * uint16_t values = { 15360, 16384, 16896, 17408, 17664};
+ * constexpr size_t values_length = sizeof(values) / sizeof(values0);
+ * std::vector<int64_t> dims = {values_length}; // one dimensional example
+ * Ort::MemoryInfo info("Cpu", OrtDeviceAllocator, 0, OrtMemTypeDefault);
+ * // Note we are passing bytes count in this api, not number of elements -> sizeof(values)
+ * auto float16_tensor = Ort::Value::CreateTensor(info, values, sizeof(values),
+ * dims.data(), dims.size(), ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16);
+ * \endcode
+ *
+ * Here is another example, a little bit more elaborate. Let's assume that you use your own float16 type and you want to use
+ * a templated version of the API above so the type is automatically set based on your type. You will need to supply an extra
+ * template specialization.
+ *
+ * \code{.unparsed}
+ * namespace yours { struct half {}; } // assume this is your type, define this:
+ * namespace Ort {
+ * template<>
+ * struct TypeToTensorType<yours::half> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16; };
+ * } //namespace Ort
+ *
+ * std::vector<yours::half> values;
+ * std::vector<int64_t> dims = {values.size()}; // one dimensional example
+ * Ort::MemoryInfo info("Cpu", OrtDeviceAllocator, 0, OrtMemTypeDefault);
+ * // Here we are passing element count -> values.size()
+ * auto float16_tensor = Ort::Value::CreateTensor<yours::half>(info, values.data(), values.size(), dims.data(), dims.size());
+ *
+ * \endcode
+ */
+struct Float16_t {
+ uint16_t value;
+ constexpr Float16_t() noexcept : value(0) {}
+ constexpr Float16_t(uint16_t v) noexcept : value(v) {}
+ constexpr operator uint16_t() const noexcept { return value; }
+ constexpr bool operator==(const Float16_t& rhs) const noexcept { return value == rhs.value; };
+ constexpr bool operator!=(const Float16_t& rhs) const noexcept { return value != rhs.value; };
+};
+
+static_assert(sizeof(Float16_t) == sizeof(uint16_t), "Sizes must match");
+
+/** \brief bfloat16 (Brain Floating Point) data type
+ * \details It is necessary for type dispatching to make use of C++ API
+ * The type is implicitly convertible to/from uint16_t.
+ * The size of the structure should align with uint16_t and one can freely cast
+ * uint16_t buffers to/from Ort::BFloat16_t to feed and retrieve data.
+ *
+ * See also code examples for Float16_t above.
+ */
+struct BFloat16_t {
+ uint16_t value;
+ constexpr BFloat16_t() noexcept : value(0) {}
+ constexpr BFloat16_t(uint16_t v) noexcept : value(v) {}
+ constexpr operator uint16_t() const noexcept { return value; }
+ constexpr bool operator==(const BFloat16_t& rhs) const noexcept { return value == rhs.value; };
+ constexpr bool operator!=(const BFloat16_t& rhs) const noexcept { return value != rhs.value; };
+};
+
+static_assert(sizeof(BFloat16_t) == sizeof(uint16_t), "Sizes must match");
+
+namespace detail {
 // This is used internally by the C++ API. This macro is to make it easy to generate overloaded methods for all of the various OrtRelease* functions for every Ort* type
 // This can't be done in the C API since C doesn't have function overloading.
 #define ORT_DEFINE_RELEASE(NAME) \
@@ -104,6 +205,7 @@
 ORT_DEFINE_RELEASE(Allocator);
 ORT_DEFINE_RELEASE(MemoryInfo);
 ORT_DEFINE_RELEASE(CustomOpDomain);
+ORT_DEFINE_RELEASE(ThreadingOptions);
 ORT_DEFINE_RELEASE(Env);
 ORT_DEFINE_RELEASE(RunOptions);
 ORT_DEFINE_RELEASE(Session);
@@ -114,164 +216,183 @@
 ORT_DEFINE_RELEASE(TypeInfo);
 ORT_DEFINE_RELEASE(Value);
 ORT_DEFINE_RELEASE(ModelMetadata);
-ORT_DEFINE_RELEASE(ThreadingOptions);
 ORT_DEFINE_RELEASE(IoBinding);
 ORT_DEFINE_RELEASE(ArenaCfg);
+ORT_DEFINE_RELEASE(Status);
+ORT_DEFINE_RELEASE(OpAttr);
+ORT_DEFINE_RELEASE(Op);
+ORT_DEFINE_RELEASE(KernelInfo);
 
 #undef ORT_DEFINE_RELEASE
 
-/** \brief IEEE 754 half-precision floating point data type
- * \details It is necessary for type dispatching to make use of C++ API
- * The type is implicitly convertible to/from uint16_t.
- * The size of the structure should align with uint16_t and one can freely cast
- * uint16_t buffers to/from Ort::Float16_t to feed and retrieve data.
- * 
- * Generally, you can feed any of your types as float16/blfoat16 data to create a tensor
- * on top of it, providing it can form a continuous buffer with 16-bit elements with no padding.
- * And you can also feed a array of uint16_t elements directly. For example,
- * 
- * \code{.unparsed}
- * uint16_t values = { 15360, 16384, 16896, 17408, 17664};
- * constexpr size_t values_length = sizeof(values) / sizeof(values0);
- * std::vector<int64_t> dims = {values_length}; // one dimensional example
- * Ort::MemoryInfo info("Cpu", OrtDeviceAllocator, 0, OrtMemTypeDefault);
- * // Note we are passing bytes count in this api, not number of elements -> sizeof(values)
- * auto float16_tensor = Ort::Value::CreateTensor(info, values, sizeof(values), 
- * dims.data(), dims.size(), ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16);
- * \endcode
- * 
- * Here is another example, a little bit more elaborate. Let's assume that you use your own float16 type and you want to use
- * a templated version of the API above so the type is automatically set based on your type. You will need to supply an extra
- * template specialization.
- * 
- * \code{.unparsed}
- * namespace yours { struct half {}; } // assume this is your type, define this:
- * namespace Ort { 
- * template<>
- * struct TypeToTensorType<yours::half> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16; };
- * } //namespace Ort
- * 
- * std::vector<yours::half> values;
- * std::vector<int64_t> dims = {values.size()}; // one dimensional example
- * Ort::MemoryInfo info("Cpu", OrtDeviceAllocator, 0, OrtMemTypeDefault);
- * // Here we are passing element count -> values.size()
- * auto float16_tensor = Ort::Value::CreateTensor<yours::half>(info, values.data(), values.size(), dims.data(), dims.size());
- * 
- * \endcode
- */
-struct Float16_t {
- uint16_t value;
- constexpr Float16_t() noexcept : value(0) {}
- constexpr Float16_t(uint16_t v) noexcept : value(v) {}
- constexpr operator uint16_t() const noexcept { return value; }
- constexpr bool operator==(const Float16_t& rhs) const noexcept { return value == rhs.value; };
- constexpr bool operator!=(const Float16_t& rhs) const noexcept { return value != rhs.value; };
-};
-
-static_assert(sizeof(Float16_t) == sizeof(uint16_t), "Sizes must match");
-
-/** \brief bfloat16 (Brain Floating Point) data type
- * \details It is necessary for type dispatching to make use of C++ API
- * The type is implicitly convertible to/from uint16_t.
- * The size of the structure should align with uint16_t and one can freely cast
- * uint16_t buffers to/from Ort::BFloat16_t to feed and retrieve data.
- * 
- * See also code examples for Float16_t above.
- */
-struct BFloat16_t {
- uint16_t value;
- constexpr BFloat16_t() noexcept : value(0) {}
- constexpr BFloat16_t(uint16_t v) noexcept : value(v) {}
- constexpr operator uint16_t() const noexcept { return value; }
- constexpr bool operator==(const BFloat16_t& rhs) const noexcept { return value == rhs.value; };
- constexpr bool operator!=(const BFloat16_t& rhs) const noexcept { return value != rhs.value; };
+/** \brief This is a tagging template type. Use it with Base<T> to indicate that the C++ interface object
+ * has no ownership of the underlying C object.
+ */
+template <typename T>
+struct Unowned {
+ using Type = T;
 };
 
-static_assert(sizeof(BFloat16_t) == sizeof(uint16_t), "Sizes must match");
+/** \brief Used internally by the C++ API. C++ wrapper types inherit from this.
+ * This is a zero cost abstraction to wrap the C API objects and delete them on destruction.
+ *
+ * All of the C++ classes
+ * a) serve as containers for pointers to objects that are created by the underlying C API.
+ * Their size is just a pointer size, no need to dynamically allocate them. Use them by value.
+ * b) Each of struct XXXX, XXX instances function as smart pointers to the underlying C API objects.
+ * they would release objects owned automatically when going out of scope, they are move-only.
+ * c) ConstXXXX and UnownedXXX structs function as non-owning, copyable containers for the above pointers.
+ * ConstXXXX allow calling const interfaces only. They give access to objects that are owned by somebody else
+ * such as Onnxruntime or instances of XXXX classes.
+ * d) serve convenient interfaces that return C++ objects and further enhance exception and type safety so they can be used
+ * in C++ code.
+ *
+ */
 
-/** \brief Used internally by the C++ API. C++ wrapper types inherit from this
-* 
-* This is a zero cost abstraction to wrap the C API objects and delete them on destruction.
-* There is a secondary class 'Unowned<T>' that is used to prevent deletion on destruction (Used for return types that are
-* not owned by the caller)
-* 
-*/
+/// <summary>
+/// This is a non-const pointer holder that is move-only. Disposes of the pointer on destruction.
+/// </summary>
 template <typename T>
 struct Base {
 using contained_type = T;
 
- Base() = default;
- Base(T* p) : p_{p} {
- if (!p)
- ORT_CXX_API_THROW("Allocation failure", ORT_FAIL);
- }
+ constexpr Base() = default;
+ constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
 ~Base() { OrtRelease(p_); }
 
- operator T*() { return p_; }
- operator const T*() const { return p_; }
-
- /// \brief Releases ownership of the contained pointer
- T* release() {
- T* p = p_;
- p_ = nullptr;
- return p;
- }
-
- protected:
 Base(const Base&) = delete;
 Base& operator=(const Base&) = delete;
+
 Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
- void operator=(Base&& v) noexcept {
+ Base& operator=(Base&& v) noexcept {
 OrtRelease(p_);
 p_ = v.release();
+ return *this;
 }
 
- T* p_{};
+ constexpr operator contained_type*() const noexcept { return p_; }
+
+ /// \brief Relinquishes ownership of the contained C object pointer
+ /// The underlying object is not destroyed
+ contained_type* release() {
+ T* p = p_;
+ p_ = nullptr;
+ return p;
+ }
 
- template <typename>
- friend struct Unowned; // This friend line is needed to keep the centos C++ compiler from giving an error
+ protected:
+ contained_type* p_{};
 };
 
-/** \brief Wraps an object that inherits from Ort::Base and stops it from deleting the contained pointer on destruction
-* 
-* This has the effect of making it not own the memory held by Ort::Base.
-*/
+// Undefined. For const types use Base<Unowned<const T>>
 template <typename T>
-struct Unowned : T {
- Unowned(typename T::contained_type* p) : T{p} {}
- Unowned(Unowned&& v) : T{v.p_} {}
- ~Unowned() { this->release(); }
-};
+struct Base<const T>;
+
+/// <summary>
+/// Covers unowned pointers owned by either the ORT
+/// or some other instance of CPP wrappers.
+/// Used for ConstXXX and UnownedXXXX types that are copyable.
+/// Also convenient to wrap raw OrtXX pointers .
+/// </summary>
+/// <typeparam name="T"></typeparam>
+template <typename T>
+struct Base<Unowned<T>> {
+ using contained_type = typename Unowned<T>::Type;
 
-struct AllocatorWithDefaultOptions;
-struct MemoryInfo;
-struct Env;
-struct TypeInfo;
-struct Value;
-struct ModelMetadata;
+ constexpr Base() = default;
+ constexpr explicit Base(contained_type* p) noexcept : p_{p} {}
+
+ ~Base() = default;
+
+ Base(const Base&) = default;
+ Base& operator=(const Base&) = default;
+
+ Base(Base&& v) noexcept : p_{v.p_} { v.p_ = nullptr; }
+ Base& operator=(Base&& v) noexcept {
+ p_ = nullptr;
+ std::swap(p_, v.p_);
+ return *this;
+ }
+
+ constexpr operator contained_type*() const noexcept { return p_; }
+
+ protected:
+ contained_type* p_{};
+};
 
-namespace detail {
 // Light functor to release memory with OrtAllocator
 struct AllocatedFree {
 OrtAllocator* allocator_;
 explicit AllocatedFree(OrtAllocator* allocator)
 : allocator_(allocator) {}
- void operator()(void* ptr) const { if(ptr) allocator_->Free(allocator_, ptr); }
+ void operator()(void* ptr) const {
+ if (ptr) allocator_->Free(allocator_, ptr);
+ }
 };
+
 } // namespace detail
 
+struct AllocatorWithDefaultOptions;
+struct Env;
+struct TypeInfo;
+struct Value;
+struct ModelMetadata;
+
 /** \brief unique_ptr typedef used to own strings allocated by OrtAllocators
 * and release them at the end of the scope. The lifespan of the given allocator
 * must eclipse the lifespan of AllocatedStringPtr instance
 */
 using AllocatedStringPtr = std::unique_ptr<char, detail::AllocatedFree>;
 
+/** \brief The Status that holds ownership of OrtStatus received from C API
+ * Use it to safely destroy OrtStatus* returned from the C API. Use appropriate
+ * constructors to construct an instance of a Status object from exceptions.
+ */
+struct Status : detail::Base<OrtStatus> {
+ explicit Status(std::nullptr_t) {} ///< Create an empty object, must be assigned a valid one to be used
+ explicit Status(OrtStatus* status); ///< Takes ownership of OrtStatus instance returned from the C API. Must be non-null
+ explicit Status(const Exception&); ///< Creates status instance out of exception
+ explicit Status(const std::exception&); ///< Creates status instance out of exception
+ std::string GetErrorMessage() const;
+ OrtErrorCode GetErrorCode() const;
+};
+
+/** \brief The ThreadingOptions
+ *
+ * The ThreadingOptions used for set global threadpools' options of The Env.
+ */
+struct ThreadingOptions : detail::Base<OrtThreadingOptions> {
+ /// \brief Wraps OrtApi::CreateThreadingOptions
+ ThreadingOptions();
+
+ /// \brief Wraps OrtApi::SetGlobalIntraOpNumThreads
+ ThreadingOptions& SetGlobalIntraOpNumThreads(int intra_op_num_threads);
+
+ /// \brief Wraps OrtApi::SetGlobalInterOpNumThreads
+ ThreadingOptions& SetGlobalInterOpNumThreads(int inter_op_num_threads);
+
+ /// \brief Wraps OrtApi::SetGlobalSpinControl
+ ThreadingOptions& SetGlobalSpinControl(int allow_spinning);
+
+ /// \brief Wraps OrtApi::SetGlobalDenormalAsZero
+ ThreadingOptions& SetGlobalDenormalAsZero();
+
+ /// \brief Wraps OrtApi::SetGlobalCustomCreateThreadFn
+ ThreadingOptions& SetGlobalCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn);
+
+ /// \brief Wraps OrtApi::SetGlobalCustomThreadCreationOptions
+ ThreadingOptions& SetGlobalCustomThreadCreationOptions(void* ort_custom_thread_creation_options);
+
+ /// \brief Wraps OrtApi::SetGlobalCustomJoinThreadFn
+ ThreadingOptions& SetGlobalCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn);
+};
+
 /** \brief The Env (Environment)
-*
-* The Env holds the logging state used by all other objects.
-* Note: One Env must be created before using any other Onnxruntime functionality
-*/
-struct Env : Base<OrtEnv> {
+ *
+ * The Env holds the logging state used by all other objects.
+ * Note: One Env must be created before using any other Onnxruntime functionality
+ */
+struct Env : detail::Base<OrtEnv> {
 explicit Env(std::nullptr_t) {} ///< Create an empty Env object, must be assigned a valid one to be used
 
 /// \brief Wraps OrtApi::CreateEnv
@@ -293,22 +414,28 @@
 Env& EnableTelemetryEvents(); ///< Wraps OrtApi::EnableTelemetryEvents
 Env& DisableTelemetryEvents(); ///< Wraps OrtApi::DisableTelemetryEvents
 
+ Env& UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level); ///< Wraps OrtApi::UpdateEnvWithCustomLogLevel
+
 Env& CreateAndRegisterAllocator(const OrtMemoryInfo* mem_info, const OrtArenaCfg* arena_cfg); ///< Wraps OrtApi::CreateAndRegisterAllocator
 };
 
 /** \brief Custom Op Domain
-*
-*/
-struct CustomOpDomain : Base<OrtCustomOpDomain> {
+ *
+ */
+struct CustomOpDomain : detail::Base<OrtCustomOpDomain> {
 explicit CustomOpDomain(std::nullptr_t) {} ///< Create an empty CustomOpDomain object, must be assigned a valid one to be used
 
 /// \brief Wraps OrtApi::CreateCustomOpDomain
 explicit CustomOpDomain(const char* domain);
 
- void Add(OrtCustomOp* op); ///< Wraps CustomOpDomain_Add
+ // This does not take ownership of the op, simply registers it.
+ void Add(const OrtCustomOp* op); ///< Wraps CustomOpDomain_Add
 };
 
-struct RunOptions : Base<OrtRunOptions> {
+/** \brief RunOptions
+ *
+ */
+struct RunOptions : detail::Base<OrtRunOptions> {
 explicit RunOptions(std::nullptr_t) {} ///< Create an empty RunOptions object, must be assigned a valid one to be used
 RunOptions(); ///< Wraps OrtApi::CreateRunOptions
 
@@ -324,430 +451,710 @@
 RunOptions& AddConfigEntry(const char* config_key, const char* config_value); ///< Wraps OrtApi::AddRunConfigEntry
 
 /** \brief Terminates all currently executing Session::Run calls that were made using this RunOptions instance
- *
- * If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error
- * Wraps OrtApi::RunOptionsSetTerminate 
- */
+ *
+ * If a currently executing session needs to be force terminated, this can be called from another thread to force it to fail with an error
+ * Wraps OrtApi::RunOptionsSetTerminate
+ */
 RunOptions& SetTerminate();
 
 /** \brief Clears the terminate flag so this RunOptions instance can be used in a new Session::Run call without it instantly terminating
- *
- * Wraps OrtApi::RunOptionsUnsetTerminate
- */
+ *
+ * Wraps OrtApi::RunOptionsUnsetTerminate
+ */
 RunOptions& UnsetTerminate();
 };
 
+
+namespace detail {
+// Utility function that returns a SessionOption config entry key for a specific custom operator.
+// Ex: custom_op.custom_op_name.config
+std::string MakeCustomOpConfigEntryKey(const char* custom_op_name, const char* config);
+} // namespace detail
+
+/// <summary>
+/// Class that represents session configuration entries for one or more custom operators.
+///
+/// Example:
+/// Ort::CustomOpConfigs op_configs;
+/// op_configs.AddConfig("my_custom_op", "device_type", "CPU");
+///
+/// Passed to Ort::SessionOptions::RegisterCustomOpsLibrary.
+/// </summary>
+struct CustomOpConfigs {
+ CustomOpConfigs() = default;
+ ~CustomOpConfigs() = default;
+ CustomOpConfigs(const CustomOpConfigs&) = default;
+ CustomOpConfigs& operator=(const CustomOpConfigs&) = default;
+ CustomOpConfigs(CustomOpConfigs&& o) = default;
+ CustomOpConfigs& operator=(CustomOpConfigs&& o) = default;
+
+ /** \brief Adds a session configuration entry/value for a specific custom operator.
+ *
+ * \param custom_op_name The name of the custom operator for which to add a configuration entry.
+ * Must match the name returned by the CustomOp's GetName() method.
+ * \param config_key The name of the configuration entry.
+ * \param config_value The value of the configuration entry.
+ * \return A reference to this object to enable call chaining.
+ */
+ CustomOpConfigs& AddConfig(const char* custom_op_name, const char* config_key, const char* config_value);
+
+ /** \brief Returns a flattened map of custom operator configuration entries and their values.
+ *
+ * The keys has been flattened to include both the custom operator name and the configuration entry key name.
+ * For example, a prior call to AddConfig("my_op", "key", "value") corresponds to the flattened key/value pair
+ * {"my_op.key", "value"}.
+ *
+ * \return An unordered map of flattened configurations.
+ */
+ const std::unordered_map<std::string, std::string>& GetFlattenedConfigs() const;
+
+ private:
+ std::unordered_map<std::string, std::string> flat_configs_;
+};
+
 /** \brief Options object used when creating a new Session object
-*
-* Wraps ::OrtSessionOptions object and methods
-*/
-struct SessionOptions : Base<OrtSessionOptions> {
- explicit SessionOptions(std::nullptr_t) {} ///< Create an empty SessionOptions object, must be assigned a valid one to be used
- SessionOptions(); ///< Wraps OrtApi::CreateSessionOptions
- explicit SessionOptions(OrtSessionOptions* p) : Base<OrtSessionOptions>{p} {} ///< Used for interop with the C API
+ *
+ * Wraps ::OrtSessionOptions object and methods
+ */
+
+struct SessionOptions;
+
+namespace detail {
+// we separate const-only methods because passing const ptr to non-const methods
+// is only discovered when inline methods are compiled which is counter-intuitive
+template <typename T>
+struct ConstSessionOptionsImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
 SessionOptions Clone() const; ///< Creates and returns a copy of this SessionOptions object. Wraps OrtApi::CloneSessionOptions
 
- SessionOptions& SetIntraOpNumThreads(int intra_op_num_threads); ///< Wraps OrtApi::SetIntraOpNumThreads
- SessionOptions& SetInterOpNumThreads(int inter_op_num_threads); ///< Wraps OrtApi::SetInterOpNumThreads
- SessionOptions& SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level); ///< Wraps OrtApi::SetSessionGraphOptimizationLevel
+ std::string GetConfigEntry(const char* config_key) const; ///< Wraps OrtApi::GetSessionConfigEntry
+ bool HasConfigEntry(const char* config_key) const; ///< Wraps OrtApi::HasSessionConfigEntry
+ std::string GetConfigEntryOrDefault(const char* config_key, const std::string& def);
+};
+
+template <typename T>
+struct SessionOptionsImpl : ConstSessionOptionsImpl<T> {
+ using B = ConstSessionOptionsImpl<T>;
+ using B::B;
+
+ SessionOptionsImpl& SetIntraOpNumThreads(int intra_op_num_threads); ///< Wraps OrtApi::SetIntraOpNumThreads
+ SessionOptionsImpl& SetInterOpNumThreads(int inter_op_num_threads); ///< Wraps OrtApi::SetInterOpNumThreads
+ SessionOptionsImpl& SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level); ///< Wraps OrtApi::SetSessionGraphOptimizationLevel
 
- SessionOptions& EnableCpuMemArena(); ///< Wraps OrtApi::EnableCpuMemArena
- SessionOptions& DisableCpuMemArena(); ///< Wraps OrtApi::DisableCpuMemArena
+ SessionOptionsImpl& EnableCpuMemArena(); ///< Wraps OrtApi::EnableCpuMemArena
+ SessionOptionsImpl& DisableCpuMemArena(); ///< Wraps OrtApi::DisableCpuMemArena
 
- SessionOptions& SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_file); ///< Wraps OrtApi::SetOptimizedModelFilePath
+ SessionOptionsImpl& SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_file); ///< Wraps OrtApi::SetOptimizedModelFilePath
 
- SessionOptions& EnableProfiling(const ORTCHAR_T* profile_file_prefix); ///< Wraps OrtApi::EnableProfiling
- SessionOptions& DisableProfiling(); ///< Wraps OrtApi::DisableProfiling
+ SessionOptionsImpl& EnableProfiling(const ORTCHAR_T* profile_file_prefix); ///< Wraps OrtApi::EnableProfiling
+ SessionOptionsImpl& DisableProfiling(); ///< Wraps OrtApi::DisableProfiling
 
- SessionOptions& EnableOrtCustomOps(); ///< Wraps OrtApi::EnableOrtCustomOps
+ SessionOptionsImpl& EnableOrtCustomOps(); ///< Wraps OrtApi::EnableOrtCustomOps
 
- SessionOptions& EnableMemPattern(); ///< Wraps OrtApi::EnableMemPattern
- SessionOptions& DisableMemPattern(); ///< Wraps OrtApi::DisableMemPattern
+ SessionOptionsImpl& EnableMemPattern(); ///< Wraps OrtApi::EnableMemPattern
+ SessionOptionsImpl& DisableMemPattern(); ///< Wraps OrtApi::DisableMemPattern
 
- SessionOptions& SetExecutionMode(ExecutionMode execution_mode); ///< Wraps OrtApi::SetSessionExecutionMode
+ SessionOptionsImpl& SetExecutionMode(ExecutionMode execution_mode); ///< Wraps OrtApi::SetSessionExecutionMode
 
- SessionOptions& SetLogId(const char* logid); ///< Wraps OrtApi::SetSessionLogId
- SessionOptions& SetLogSeverityLevel(int level); ///< Wraps OrtApi::SetSessionLogSeverityLevel
+ SessionOptionsImpl& SetLogId(const char* logid); ///< Wraps OrtApi::SetSessionLogId
+ SessionOptionsImpl& SetLogSeverityLevel(int level); ///< Wraps OrtApi::SetSessionLogSeverityLevel
 
- SessionOptions& Add(OrtCustomOpDomain* custom_op_domain); ///< Wraps OrtApi::AddCustomOpDomain
+ SessionOptionsImpl& Add(OrtCustomOpDomain* custom_op_domain); ///< Wraps OrtApi::AddCustomOpDomain
 
- SessionOptions& DisablePerSessionThreads(); ///< Wraps OrtApi::DisablePerSessionThreads
+ SessionOptionsImpl& DisablePerSessionThreads(); ///< Wraps OrtApi::DisablePerSessionThreads
 
- SessionOptions& AddConfigEntry(const char* config_key, const char* config_value); ///< Wraps OrtApi::AddSessionConfigEntry
- SessionOptions& AddInitializer(const char* name, const OrtValue* ort_val); ///< Wraps OrtApi::AddInitializer
- SessionOptions& AddExternalInitializers(const std::vector<std::string>& names, const std::vector<Value>& ort_values); ///< Wraps OrtApi::AddExternalInitializers
+ SessionOptionsImpl& AddConfigEntry(const char* config_key, const char* config_value); ///< Wraps OrtApi::AddSessionConfigEntry
 
- SessionOptions& AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA
- SessionOptions& AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2
- SessionOptions& AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM
- SessionOptions& AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO
- SessionOptions& AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
- SessionOptions& AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
- SessionOptions& AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX
+ SessionOptionsImpl& AddInitializer(const char* name, const OrtValue* ort_val); ///< Wraps OrtApi::AddInitializer
+ SessionOptionsImpl& AddExternalInitializers(const std::vector<std::string>& names, const std::vector<Value>& ort_values); ///< Wraps OrtApi::AddExternalInitializers
+
+ SessionOptionsImpl& AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA
+ SessionOptionsImpl& AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_CUDA_V2
+ SessionOptionsImpl& AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_ROCM
+ SessionOptionsImpl& AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_OpenVINO
+ SessionOptionsImpl& AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
+ SessionOptionsImpl& AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_TensorRT
+ SessionOptionsImpl& AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options); ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_MIGraphX
+ ///< Wraps OrtApi::SessionOptionsAppendExecutionProvider_CANN
+ SessionOptionsImpl& AppendExecutionProvider_CANN(const OrtCANNProviderOptions& provider_options);
 /// Wraps OrtApi::SessionOptionsAppendExecutionProvider. Currently supports SNPE and XNNPACK.
- SessionOptions& AppendExecutionProvider(const std::string& provider_name,
- const std::unordered_map<std::string, std::string>& provider_options = {});
+ SessionOptionsImpl& AppendExecutionProvider(const std::string& provider_name,
+ const std::unordered_map<std::string, std::string>& provider_options = {});
+
+ SessionOptionsImpl& SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn); ///< Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn
+ SessionOptionsImpl& SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options); ///< Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions
+ SessionOptionsImpl& SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn); ///< Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn
+
+ ///< Registers the custom operator from the specified shared library via OrtApi::RegisterCustomOpsLibrary_V2.
+ ///< The custom operator configurations are optional. If provided, custom operator configs are set via
+ ///< OrtApi::AddSessionConfigEntry.
+ SessionOptionsImpl& RegisterCustomOpsLibrary(const ORTCHAR_T* library_name, const CustomOpConfigs& custom_op_configs = {});
+
+ SessionOptionsImpl& RegisterCustomOpsUsingFunction(const char* function_name); ///< Wraps OrtApi::RegisterCustomOpsUsingFunction
+};
+} // namespace detail
 
- SessionOptions& SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn); ///< Wraps OrtApi::SessionOptionsSetCustomCreateThreadFn
- SessionOptions& SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options); ///< Wraps OrtApi::SessionOptionsSetCustomThreadCreationOptions
- SessionOptions& SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn); ///< Wraps OrtApi::SessionOptionsSetCustomJoinThreadFn
+using UnownedSessionOptions = detail::SessionOptionsImpl<detail::Unowned<OrtSessionOptions>>;
+using ConstSessionOptions = detail::ConstSessionOptionsImpl<detail::Unowned<const OrtSessionOptions>>;
+
+/** \brief Wrapper around ::OrtSessionOptions
+ *
+ */
+struct SessionOptions : detail::SessionOptionsImpl<OrtSessionOptions> {
+ explicit SessionOptions(std::nullptr_t) {} ///< Create an empty SessionOptions object, must be assigned a valid one to be used
+ SessionOptions(); ///< Wraps OrtApi::CreateSessionOptions
+ explicit SessionOptions(OrtSessionOptions* p) : SessionOptionsImpl<OrtSessionOptions>{p} {} ///< Used for interop with the C API
+ UnownedSessionOptions GetUnowned() const { return UnownedSessionOptions{this->p_}; }
+ ConstSessionOptions GetConst() const { return ConstSessionOptions{this->p_}; }
 };
 
 /** \brief Wrapper around ::OrtModelMetadata
-*
-*/
-struct ModelMetadata : Base<OrtModelMetadata> {
+ *
+ */
+struct ModelMetadata : detail::Base<OrtModelMetadata> {
 explicit ModelMetadata(std::nullptr_t) {} ///< Create an empty ModelMetadata object, must be assigned a valid one to be used
 explicit ModelMetadata(OrtModelMetadata* p) : Base<OrtModelMetadata>{p} {} ///< Used for interop with the C API
 
- /** \deprecated use GetProducerNameAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetProducerName(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetProducerName
-
 /** \brief Returns a copy of the producer name.
- * 
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetProducerNameAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetProducerName
 
- /** \deprecated use GetGraphNameAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetGraphName(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetGraphName
-
 /** \brief Returns a copy of the graph name.
- * 
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetGraphNameAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetGraphName
 
- /** \deprecated use GetDomainAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetDomain(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetDomain
-
 /** \brief Returns a copy of the domain name.
- * 
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetDomainAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetDomain
 
- /** \deprecated use GetDescriptionAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetDescription(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetDescription
-
 /** \brief Returns a copy of the description.
- * 
- * \param allocator to allocate memory for the copy of the string returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param allocator to allocate memory for the copy of the string returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetDescriptionAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetDescription
 
- /** \deprecated use GetGraphDescriptionAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetGraphDescription(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetGraphDescription
-
 /** \brief Returns a copy of the graph description.
- * 
- * \param allocator to allocate memory for the copy of the string returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
- AllocatedStringPtr GetGraphDescriptionAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetGraphDescription
-
- /** \deprecated use GetCustomMetadataMapKeysAllocated()
- * deprecated 
- * This interface produces multiple pointers that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char** GetCustomMetadataMapKeys(OrtAllocator* allocator, _Out_ int64_t& num_keys) const; ///< Wraps OrtApi::ModelMetadataGetCustomMetadataMapKeys
+ *
+ * \param allocator to allocate memory for the copy of the string returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
+ AllocatedStringPtr GetGraphDescriptionAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetGraphDescription
 
+ /** \brief Returns a vector of copies of the custom metadata keys.
+ *
+ * \param allocator to allocate memory for the copy of the string returned
+ * \return a instance std::vector of smart pointers that would deallocate the buffers when out of scope.
+ * The OrtAllocator instance must be valid at the point of memory release.
+ */
 std::vector<AllocatedStringPtr> GetCustomMetadataMapKeysAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataGetCustomMetadataMapKeys
 
- /** \deprecated use LookupCustomMetadataMapAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* LookupCustomMetadataMap(const char* key, OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataLookupCustomMetadataMap
-
 /** \brief Looks up a value by a key in the Custom Metadata map
- * 
- * \param zero terminated string key to lookup
- * \param allocator to allocate memory for the copy of the string returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * maybe nullptr if key is not found.
- * 
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param key zero terminated string key to lookup
+ * \param allocator to allocate memory for the copy of the string returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * maybe nullptr if key is not found.
+ *
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr LookupCustomMetadataMapAllocated(const char* key, OrtAllocator* allocator) const; ///< Wraps OrtApi::ModelMetadataLookupCustomMetadataMap
 
- int64_t GetVersion() const; ///< Wraps OrtApi::ModelMetadataGetVersion
+ int64_t GetVersion() const; ///< Wraps OrtApi::ModelMetadataGetVersion
 };
 
-/** \brief Wrapper around ::OrtSession
-*
-*/
-struct Session : Base<OrtSession> {
- explicit Session(std::nullptr_t) {} ///< Create an empty Session object, must be assigned a valid one to be used
- Session(Env& env, const ORTCHAR_T* model_path, const SessionOptions& options); ///< Wraps OrtApi::CreateSession
- Session(Env& env, const ORTCHAR_T* model_path, const SessionOptions& options, OrtPrepackedWeightsContainer* prepacked_weights_container); ///< Wraps OrtApi::CreateSessionWithPrepackedWeightsContainer
- Session(Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options); ///< Wraps OrtApi::CreateSessionFromArray
-
- /** \brief Run the model returning results in an Ort allocated vector.
- * 
- * Wraps OrtApi::Run
- *
- * The caller provides a list of inputs and a list of the desired outputs to return.
- *
- * See the output logs for more information on warnings/errors that occur while processing the model.
- * Common errors are.. (TODO)
- * 
- * \paramin run_options
- * \paramin input_names Array of null terminated strings of length input_count that is the list of input names
- * \paramin input_values Array of Value objects of length input_count that is the list of input values
- * \paramin input_count Number of inputs (the size of the input_names & input_values arrays)
- * \paramin output_names Array of C style strings of length output_count that is the list of output names
- * \paramin output_count Number of outputs (the size of the output_names array)
- * \return A std::vector of Value objects that directly maps to the output_count (eg. output_name0 is the first entry of the returned vector)
- */
- std::vector<Value> Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
- const char* const* output_names, size_t output_count);
+struct IoBinding;
 
- /** \brief Run the model returning results in user provided outputs
- * Same as Run(const RunOptions&, const char* const*, const Value*, size_t,const char* const*, size_t)
- */
- void Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
- const char* const* output_names, Value* output_values, size_t output_count);
+namespace detail {
 
- void Run(const RunOptions& run_options, const struct IoBinding&); ///< Wraps OrtApi::RunWithBinding
+// we separate const-only methods because passing const ptr to non-const methods
+// is only discovered when inline methods are compiled which is counter-intuitive
+template <typename T>
+struct ConstSessionImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
 size_t GetInputCount() const; ///< Returns the number of model inputs
 size_t GetOutputCount() const; ///< Returns the number of model outputs
 size_t GetOverridableInitializerCount() const; ///< Returns the number of inputs that have defaults that can be overridden
 
- /** \deprecated use GetInputNameAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetInputName(size_t index, OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionGetInputName
-
 /** \brief Returns a copy of input name at the specified index.
- * 
- * \param index must less than the value returned by GetInputCount()
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param index must less than the value returned by GetInputCount()
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetInputNameAllocated(size_t index, OrtAllocator* allocator) const;
 
- /** \deprecated use GetOutputNameAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetOutputName(size_t index, OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionGetOutputName
-
 /** \brief Returns a copy of output name at then specified index.
- * 
- * \param index must less than the value returned by GetOutputCount()
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param index must less than the value returned by GetOutputCount()
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetOutputNameAllocated(size_t index, OrtAllocator* allocator) const;
 
- /** \deprecated use GetOverridableInitializerNameAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* GetOverridableInitializerName(size_t index, OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionGetOverridableInitializerName
-
 /** \brief Returns a copy of the overridable initializer name at then specified index.
- * 
- * \param index must less than the value returned by GetOverridableInitializerCount()
- * \param allocator to allocate memory for the copy of the name returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
+ *
+ * \param index must less than the value returned by GetOverridableInitializerCount()
+ * \param allocator to allocate memory for the copy of the name returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
 AllocatedStringPtr GetOverridableInitializerNameAllocated(size_t index, OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionGetOverridableInitializerName
 
- /** \deprecated use EndProfilingAllocated()
- * deprecated 
- * This interface produces a pointer that must be released
- * by the specified allocator and is often leaked. Not exception safe.
- */
- char* EndProfiling(OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionEndProfiling
-
- /** \brief Returns a copy of the profiling file name.
- * 
- * \param allocator to allocate memory for the copy of the string returned
- * \return a instance of smart pointer that would deallocate the buffer when out of scope.
- * The OrtAllocator instances must be valid at the point of memory release.
- */
- AllocatedStringPtr EndProfilingAllocated(OrtAllocator* allocator) const; ///< Wraps OrtApi::SessionEndProfiling
- uint64_t GetProfilingStartTimeNs() const; ///< Wraps OrtApi::SessionGetProfilingStartTimeNs
- ModelMetadata GetModelMetadata() const; ///< Wraps OrtApi::SessionGetModelMetadata
+ uint64_t GetProfilingStartTimeNs() const; ///< Wraps OrtApi::SessionGetProfilingStartTimeNs
+ ModelMetadata GetModelMetadata() const; ///< Wraps OrtApi::SessionGetModelMetadata
 
 TypeInfo GetInputTypeInfo(size_t index) const; ///< Wraps OrtApi::SessionGetInputTypeInfo
 TypeInfo GetOutputTypeInfo(size_t index) const; ///< Wraps OrtApi::SessionGetOutputTypeInfo
 TypeInfo GetOverridableInitializerTypeInfo(size_t index) const; ///< Wraps OrtApi::SessionGetOverridableInitializerTypeInfo
 };
 
-/** \brief Wrapper around ::OrtTensorTypeAndShapeInfo
-*
-*/
-struct TensorTypeAndShapeInfo : Base<OrtTensorTypeAndShapeInfo> {
- explicit TensorTypeAndShapeInfo(std::nullptr_t) {} ///< Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used
- explicit TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* p) : Base<OrtTensorTypeAndShapeInfo>{p} {} ///< Used for interop with the C API
+template <typename T>
+struct SessionImpl : ConstSessionImpl<T> {
+ using B = ConstSessionImpl<T>;
+ using B::B;
 
- ONNXTensorElementDataType GetElementType() const; ///< Wraps OrtApi::GetTensorElementType
- size_t GetElementCount() const; ///< Wraps OrtApi::GetTensorShapeElementCount
+ /** \brief Run the model returning results in an Ort allocated vector.
+ *
+ * Wraps OrtApi::Run
+ *
+ * The caller provides a list of inputs and a list of the desired outputs to return.
+ *
+ * See the output logs for more information on warnings/errors that occur while processing the model.
+ * Common errors are.. (TODO)
+ *
+ * \paramin run_options
+ * \paramin input_names Array of null terminated strings of length input_count that is the list of input names
+ * \paramin input_values Array of Value objects of length input_count that is the list of input values
+ * \paramin input_count Number of inputs (the size of the input_names & input_values arrays)
+ * \paramin output_names Array of C style strings of length output_count that is the list of output names
+ * \paramin output_count Number of outputs (the size of the output_names array)
+ * \return A std::vector of Value objects that directly maps to the output_names array (eg. output_name0 is the first entry of the returned vector)
+ */
+ std::vector<Value> Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
+ const char* const* output_names, size_t output_count);
 
- size_t GetDimensionsCount() const; ///< Wraps OrtApi::GetDimensionsCount
- void GetDimensions(int64_t* values, size_t values_count) const; ///< Wraps OrtApi::GetDimensions
- void GetSymbolicDimensions(const char** values, size_t values_count) const; ///< Wraps OrtApi::GetSymbolicDimensions
+ /** \brief Run the model returning results in user provided outputs
+ * Same as Run(const RunOptions&, const char* const*, const Value*, size_t,const char* const*, size_t)
+ */
+ void Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
+ const char* const* output_names, Value* output_values, size_t output_count);
 
- std::vector<int64_t> GetShape() const; ///< Uses GetDimensionsCount & GetDimensions to return a std::vector of the shape
+ void Run(const RunOptions& run_options, const IoBinding&); ///< Wraps OrtApi::RunWithBinding
+
+ /** \brief End profiling and return a copy of the profiling file name.
+ *
+ * \param allocator to allocate memory for the copy of the string returned
+ * \return a instance of smart pointer that would deallocate the buffer when out of scope.
+ * The OrtAllocator instances must be valid at the point of memory release.
+ */
+ AllocatedStringPtr EndProfilingAllocated(OrtAllocator* allocator); ///< Wraps OrtApi::SessionEndProfiling
 };
 
-/** \brief Wrapper around ::OrtSequenceTypeInfo
-*
-*/
-struct SequenceTypeInfo : Base<OrtSequenceTypeInfo> {
- explicit SequenceTypeInfo(std::nullptr_t) {} ///< Create an empty SequenceTypeInfo object, must be assigned a valid one to be used
- explicit SequenceTypeInfo(OrtSequenceTypeInfo* p) : Base<OrtSequenceTypeInfo>{p} {} ///< Used for interop with the C API
+} // namespace detail
 
- TypeInfo GetSequenceElementType() const; ///< Wraps OrtApi::GetSequenceElementType
+using ConstSession = detail::ConstSessionImpl<detail::Unowned<const OrtSession>>;
+using UnownedSession = detail::SessionImpl<detail::Unowned<OrtSession>>;
+
+/** \brief Wrapper around ::OrtSession
+ *
+ */
+struct Session : detail::SessionImpl<OrtSession> {
+ explicit Session(std::nullptr_t) {} ///< Create an empty Session object, must be assigned a valid one to be used
+ Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options); ///< Wraps OrtApi::CreateSession
+ Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options,
+ OrtPrepackedWeightsContainer* prepacked_weights_container); ///< Wraps OrtApi::CreateSessionWithPrepackedWeightsContainer
+ Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options); ///< Wraps OrtApi::CreateSessionFromArray
+ Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options,
+ OrtPrepackedWeightsContainer* prepacked_weights_container); ///< Wraps OrtApi::CreateSessionFromArrayWithPrepackedWeightsContainer
+
+ ConstSession GetConst() const { return ConstSession{this->p_}; }
+ UnownedSession GetUnowned() const { return UnownedSession{this->p_}; }
 };
 
-/** \brief Wrapper around ::OrtMapTypeInfo
-*
-*/
-struct MapTypeInfo : Base<OrtMapTypeInfo> {
- explicit MapTypeInfo(std::nullptr_t) {} ///< Create an empty MapTypeInfo object, must be assigned a valid one to be used
- explicit MapTypeInfo(OrtMapTypeInfo* p) : Base<OrtMapTypeInfo>{p} {} ///< Used for interop with the C API
+namespace detail {
+template <typename T>
+struct MemoryInfoImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
- ONNXTensorElementDataType GetMapKeyType() const; ///< Wraps OrtApi::GetMapKeyType
- TypeInfo GetMapValueType() const; ///< Wraps OrtApi::GetMapValueType
-};
+ std::string GetAllocatorName() const;
+ OrtAllocatorType GetAllocatorType() const;
+ int GetDeviceId() const;
+ OrtMemoryInfoDeviceType GetDeviceType() const;
+ OrtMemType GetMemoryType() const;
 
-struct TypeInfo : Base<OrtTypeInfo> {
- explicit TypeInfo(std::nullptr_t) {} ///< Create an empty TypeInfo object, must be assigned a valid one to be used
- explicit TypeInfo(OrtTypeInfo* p) : Base<OrtTypeInfo>{p} {} ///< C API Interop
+ template <typename U>
+ bool operator==(const MemoryInfoImpl& o) const;
+};
+} // namespace detail
 
- Unowned<TensorTypeAndShapeInfo> GetTensorTypeAndShapeInfo() const; ///< Wraps OrtApi::CastTypeInfoToTensorInfo
- Unowned<SequenceTypeInfo> GetSequenceTypeInfo() const; ///< Wraps OrtApi::CastTypeInfoToSequenceTypeInfo
- Unowned<MapTypeInfo> GetMapTypeInfo() const; ///< Wraps OrtApi::CastTypeInfoToMapTypeInfo
+// Const object holder that does not own the underlying object
+using ConstMemoryInfo = detail::MemoryInfoImpl<detail::Unowned<const OrtMemoryInfo>>;
 
- ONNXType GetONNXType() const;
+/** \brief Wrapper around ::OrtMemoryInfo
+ *
+ */
+struct MemoryInfo : detail::MemoryInfoImpl<OrtMemoryInfo> {
+ static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1);
+ explicit MemoryInfo(std::nullptr_t) {} ///< No instance is created
+ explicit MemoryInfo(OrtMemoryInfo* p) : MemoryInfoImpl<OrtMemoryInfo>{p} {} ///< Take ownership of a pointer created by C Api
+ MemoryInfo(const char* name, OrtAllocatorType type, int id, OrtMemType mem_type);
+ ConstMemoryInfo GetConst() const { return ConstMemoryInfo{this->p_}; }
 };
 
-struct Value : Base<OrtValue> {
- // This structure is used to feed sparse tensor values
- // information for use with FillSparseTensor<Format>() API
- // if the data type for the sparse tensor values is numeric
- // use data.p_data, otherwise, use data.str pointer to feed
- // values. data.str is an array of const char* that are zero terminated.
- // number of strings in the array must match shape size.
- // For fully sparse tensors use shape {0} and set p_data/str
- // to nullptr.
- struct OrtSparseValuesParam {
- const int64_t* values_shape;
- size_t values_shape_len;
- union {
- const void* p_data;
- const char** str;
- } data;
- };
-
- // Provides a way to pass shape in a single
- // argument
- struct Shape {
- const int64_t* shape;
- size_t shape_len;
- };
+namespace detail {
+template <typename T>
+struct TensorTypeAndShapeInfoImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
- /** \brief Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
- * \tparam T The numeric datatype. This API is not suitable for strings.
- * \param info Memory description of where the p_data buffer resides (CPU vs GPU etc).
- * \param p_data Pointer to the data buffer.
- * \param p_data_element_count The number of elements in the data buffer.
- * \param shape Pointer to the tensor shape dimensions.
- * \param shape_len The number of tensor shape dimensions.
- */
- template <typename T>
- static Value CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count, const int64_t* shape, size_t shape_len);
+ ONNXTensorElementDataType GetElementType() const; ///< Wraps OrtApi::GetTensorElementType
+ size_t GetElementCount() const; ///< Wraps OrtApi::GetTensorShapeElementCount
 
- /** \brief Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
- * \param info Memory description of where the p_data buffer resides (CPU vs GPU etc).
- * \param p_data Pointer to the data buffer.
- * \param p_data_byte_count The number of bytes in the data buffer.
- * \param shape Pointer to the tensor shape dimensions.
- * \param shape_len The number of tensor shape dimensions.
- * \param type The data type.
+ size_t GetDimensionsCount() const; ///< Wraps OrtApi::GetDimensionsCount
+
+ /** \deprecated use GetShape() returning std::vector
+ * deprecated
+ * This interface is unsafe to use
 */
- static Value CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count, const int64_t* shape, size_t shape_len,
- ONNXTensorElementDataType type);
+ deprecated("use GetShape()") void GetDimensions(int64_t* values, size_t values_count) const; ///< Wraps OrtApi::GetDimensions
+
+ void GetSymbolicDimensions(const char** values, size_t values_count) const; ///< Wraps OrtApi::GetSymbolicDimensions
+
+ std::vector<int64_t> GetShape() const; ///< Uses GetDimensionsCount & GetDimensions to return a std::vector of the shape
+};
+
+} // namespace detail
+
+using ConstTensorTypeAndShapeInfo = detail::TensorTypeAndShapeInfoImpl<detail::Unowned<const OrtTensorTypeAndShapeInfo>>;
+
+/** \brief Wrapper around ::OrtTensorTypeAndShapeInfo
+ *
+ */
+struct TensorTypeAndShapeInfo : detail::TensorTypeAndShapeInfoImpl<OrtTensorTypeAndShapeInfo> {
+ explicit TensorTypeAndShapeInfo(std::nullptr_t) {} ///< Create an empty TensorTypeAndShapeInfo object, must be assigned a valid one to be used
+ explicit TensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* p) : TensorTypeAndShapeInfoImpl{p} {} ///< Used for interop with the C API
+ ConstTensorTypeAndShapeInfo GetConst() const { return ConstTensorTypeAndShapeInfo{this->p_}; }
+};
+
+namespace detail {
+template <typename T>
+struct SequenceTypeInfoImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
+ TypeInfo GetSequenceElementType() const; ///< Wraps OrtApi::GetSequenceElementType
+};
+
+} // namespace detail
+
+using ConstSequenceTypeInfo = detail::SequenceTypeInfoImpl<detail::Unowned<const OrtSequenceTypeInfo>>;
+
+/** \brief Wrapper around ::OrtSequenceTypeInfo
+ *
+ */
+struct SequenceTypeInfo : detail::SequenceTypeInfoImpl<OrtSequenceTypeInfo> {
+ explicit SequenceTypeInfo(std::nullptr_t) {} ///< Create an empty SequenceTypeInfo object, must be assigned a valid one to be used
+ explicit SequenceTypeInfo(OrtSequenceTypeInfo* p) : SequenceTypeInfoImpl<OrtSequenceTypeInfo>{p} {} ///< Used for interop with the C API
+ ConstSequenceTypeInfo GetConst() const { return ConstSequenceTypeInfo{this->p_}; }
+};
+
+namespace detail {
+template <typename T>
+struct MapTypeInfoImpl : detail::Base<T> {
+ using B = Base<T>;
+ using B::B;
+ ONNXTensorElementDataType GetMapKeyType() const; ///< Wraps OrtApi::GetMapKeyType
+ TypeInfo GetMapValueType() const; ///< Wraps OrtApi::GetMapValueType
+};
+
+} // namespace detail
+
+using ConstMapTypeInfo = detail::MapTypeInfoImpl<detail::Unowned<const OrtMapTypeInfo>>;
+
+/** \brief Wrapper around ::OrtMapTypeInfo
+ *
+ */
+struct MapTypeInfo : detail::MapTypeInfoImpl<OrtMapTypeInfo> {
+ explicit MapTypeInfo(std::nullptr_t) {} ///< Create an empty MapTypeInfo object, must be assigned a valid one to be used
+ explicit MapTypeInfo(OrtMapTypeInfo* p) : MapTypeInfoImpl<OrtMapTypeInfo>{p} {} ///< Used for interop with the C API
+ ConstMapTypeInfo GetConst() const { return ConstMapTypeInfo{this->p_}; }
+};
+
+namespace detail {
+template <typename T>
+struct TypeInfoImpl : detail::Base<T> {
+ using B = Base<T>;
+ using B::B;
+
+ ConstTensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const; ///< Wraps OrtApi::CastTypeInfoToTensorInfo
+ ConstSequenceTypeInfo GetSequenceTypeInfo() const; ///< Wraps OrtApi::CastTypeInfoToSequenceTypeInfo
+ ConstMapTypeInfo GetMapTypeInfo() const; ///< Wraps OrtApi::CastTypeInfoToMapTypeInfo
+
+ ONNXType GetONNXType() const;
+};
+} // namespace detail
+
+/// <summary>
+/// Contains a constant, unowned OrtTypeInfo that can be copied and passed around by value.
+/// Provides access to const OrtTypeInfo APIs.
+/// </summary>
+using ConstTypeInfo = detail::TypeInfoImpl<detail::Unowned<const OrtTypeInfo>>;
+
+/// <summary>
+/// Type information that may contain either TensorTypeAndShapeInfo or
+/// the information about contained sequence or map depending on the ONNXType.
+/// </summary>
+struct TypeInfo : detail::TypeInfoImpl<OrtTypeInfo> {
+ explicit TypeInfo(std::nullptr_t) {} ///< Create an empty TypeInfo object, must be assigned a valid one to be used
+ explicit TypeInfo(OrtTypeInfo* p) : TypeInfoImpl<OrtTypeInfo>{p} {} ///< C API Interop
+
+ ConstTypeInfo GetConst() const { return ConstTypeInfo{this->p_}; }
+};
+
+namespace detail {
+// This structure is used to feed sparse tensor values
+// information for use with FillSparseTensor<Format>() API
+// if the data type for the sparse tensor values is numeric
+// use data.p_data, otherwise, use data.str pointer to feed
+// values. data.str is an array of const char* that are zero terminated.
+// number of strings in the array must match shape size.
+// For fully sparse tensors use shape {0} and set p_data/str
+// to nullptr.
+struct OrtSparseValuesParam {
+ const int64_t* values_shape;
+ size_t values_shape_len;
+ union {
+ const void* p_data;
+ const char** str;
+ } data;
+};
+
+// Provides a way to pass shape in a single
+// argument
+struct Shape {
+ const int64_t* shape;
+ size_t shape_len;
+};
+
+template <typename T>
+struct ConstValueImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
+
+ /// <summary>
+ /// Obtains a pointer to a user defined data for experimental purposes
+ /// </summary>
+ template <typename R>
+ void GetOpaqueData(const char* domain, const char* type_name, R&) const; ///< Wraps OrtApi::GetOpaqueValue
+
+ bool IsTensor() const; ///< Returns true if Value is a tensor, false for other types like map/sequence/etc
+ bool HasValue() const; /// < Return true if OrtValue contains data and returns false if the OrtValue is a None
+
+ size_t GetCount() const; // If a non tensor, returns 2 for map and N for sequence, where N is the number of elements
+ Value GetValue(int index, OrtAllocator* allocator) const;
+
+ /// <summary>
+ /// This API returns a full length of string data contained within either a tensor or a sparse Tensor.
+ /// For sparse tensor it returns a full length of stored non-empty strings (values). The API is useful
+ /// for allocating necessary memory and calling GetStringTensorContent().
+ /// </summary>
+ /// <returns>total length of UTF-8 encoded bytes contained. No zero terminators counted.</returns>
+ size_t GetStringTensorDataLength() const;
+
+ /// <summary>
+ /// The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor
+ /// into a supplied buffer. Use GetStringTensorDataLength() to find out the length of the buffer to allocate.
+ /// The user must also allocate offsets buffer with the number of entries equal to that of the contained
+ /// strings.
+ ///
+ /// Strings are always assumed to be on CPU, no X-device copy.
+ /// </summary>
+ /// <param name="buffer">user allocated buffer</param>
+ /// <param name="buffer_length">length in bytes of the allocated buffer</param>
+ /// <param name="offsets">a pointer to the offsets user allocated buffer</param>
+ /// <param name="offsets_count">count of offsets, must be equal to the number of strings contained.
+ /// that can be obtained from the shape of the tensor or from GetSparseTensorValuesTypeAndShapeInfo()
+ /// for sparse tensors</param>
+ void GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const;
+
+ /// <summary>
+ /// Returns a const typed pointer to the tensor contained data.
+ /// No type checking is performed, the caller must ensure the type matches the tensor type.
+ /// </summary>
+ /// <typeparam name="T"></typeparam>
+ /// <returns>const pointer to data, no copies made</returns>
+ template <typename R>
+ const R* GetTensorData() const; ///< Wraps OrtApi::GetTensorMutableData /// <summary>
+
+ /// <summary>
+ /// Returns a non-typed pointer to a tensor contained data.
+ /// </summary>
+ /// <returns>const pointer to data, no copies made</returns>
+ const void* GetTensorRawData() const;
+
+ /// <summary>
+ /// The API returns type information for data contained in a tensor. For sparse
+ /// tensors it returns type information for contained non-zero values.
+ /// It returns dense shape for sparse tensors.
+ /// </summary>
+ /// <returns>TypeInfo</returns>
+ TypeInfo GetTypeInfo() const;
+
+ /// <summary>
+ /// The API returns type information for data contained in a tensor. For sparse
+ /// tensors it returns type information for contained non-zero values.
+ /// It returns dense shape for sparse tensors.
+ /// </summary>
+ /// <returns>TensorTypeAndShapeInfo</returns>
+ TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const;
+
+ /// <summary>
+ /// This API returns information about the memory allocation used to hold data.
+ /// </summary>
+ /// <returns>Non owning instance of MemoryInfo</returns>
+ ConstMemoryInfo GetTensorMemoryInfo() const;
+
+ /// <summary>
+ /// The API copies UTF-8 encoded bytes for the requested string element
+ /// contained within a tensor or a sparse tensor into a provided buffer.
+ /// Use GetStringTensorElementLength() to obtain the length of the buffer to allocate.
+ /// </summary>
+ /// <param name="buffer_length"></param>
+ /// <param name="element_index"></param>
+ /// <param name="buffer"></param>
+ void GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const;
+
+ /// <summary>
+ /// The API returns a byte length of UTF-8 encoded string element
+ /// contained in either a tensor or a spare tensor values.
+ /// </summary>
+ /// <param name="element_index"></param>
+ /// <returns>byte length for the specified string element</returns>
+ size_t GetStringTensorElementLength(size_t element_index) const;
 
 #if !defined(DISABLE_SPARSE_TENSORS)
 /// <summary>
- /// This is a simple forwarding method to the other overload that helps deducing
- /// data type enum value from the type of the buffer.
+ /// The API returns the sparse data format this OrtValue holds in a sparse tensor.
+ /// If the sparse tensor was not fully constructed, i.e. Use*() or Fill*() API were not used
+ /// the value returned is ORT_SPARSE_UNDEFINED.
+ /// </summary>
+ /// <returns>Format enum</returns>
+ OrtSparseFormat GetSparseFormat() const;
+
+ /// <summary>
+ /// The API returns type and shape information for stored non-zero values of the
+ /// sparse tensor. Use GetSparseTensorValues() to obtain values buffer pointer.
+ /// </summary>
+ /// <returns>TensorTypeAndShapeInfo values information</returns>
+ TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo() const;
+
+ /// <summary>
+ /// The API returns type and shape information for the specified indices. Each supported
+ /// indices have their own enum values even if a give format has more than one kind of indices.
+ /// Use GetSparseTensorIndicesData() to obtain pointer to indices buffer.
+ /// </summary>
+ /// <param name="format">enum requested</param>
+ /// <returns>type and shape information</returns>
+ TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat format) const;
+
+ /// <summary>
+ /// The API retrieves a pointer to the internal indices buffer. The API merely performs
+ /// a convenience data type casting on the return type pointer. Make sure you are requesting
+ /// the right type, use GetSparseTensorIndicesTypeShapeInfo();
+ /// </summary>
+ /// <typeparam name="T">type to cast to</typeparam>
+ /// <param name="indices_format">requested indices kind</param>
+ /// <param name="num_indices">number of indices entries</param>
+ /// <returns>Pinter to the internal sparse tensor buffer containing indices. Do not free this pointer.</returns>
+ template <typename R>
+ const R* GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const;
+
+ /// <summary>
+ /// Returns true if the OrtValue contains a sparse tensor
 /// </summary>
- /// <typeparam name="T">numeric datatype. This API is not suitable for strings.</typeparam>
- /// <param name="info">Memory description where the user buffers reside (CPU vs GPU etc)</param>
- /// <param name="p_data">pointer to the user supplied buffer, use nullptr for fully sparse tensors</param>
- /// <param name="dense_shape">a would be dense shape of the tensor</param>
- /// <param name="values_shape">non zero values shape. Use a single 0 shape for fully sparse tensors.</param>
 /// <returns></returns>
- template <typename T>
- static Value CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
- const Shape& values_shape);
+ bool IsSparseTensor() const;
 
 /// <summary>
- /// Creates an OrtValue instance containing SparseTensor. This constructs
- /// a sparse tensor that makes use of user allocated buffers. It does not make copies
- /// of the user provided data and does not modify it. The lifespan of user provided buffers should
- /// eclipse the life span of the resulting OrtValue. This call constructs an instance that only contain
- /// a pointer to non-zero values. To fully populate the sparse tensor call Use<Format>Indices() API below
- /// to supply a sparse format specific indices.
- /// This API is not suitable for string data. Use CreateSparseTensor() with allocator specified so strings
- /// can be properly copied into the allocated buffer.
+ /// The API returns a pointer to an internal buffer of the sparse tensor
+ /// containing non-zero values. The API merely does casting. Make sure you
+ /// are requesting the right data type by calling GetSparseTensorValuesTypeAndShapeInfo()
+ /// first.
 /// </summary>
- /// <param name="info">Memory description where the user buffers reside (CPU vs GPU etc)</param>
- /// <param name="p_data">pointer to the user supplied buffer, use nullptr for fully sparse tensors</param>
- /// <param name="dense_shape">a would be dense shape of the tensor</param>
- /// <param name="values_shape">non zero values shape. Use a single 0 shape for fully sparse tensors.</param>
- /// <param name="type">data type</param>
- /// <returns>Ort::Value instance containing SparseTensor</returns>
- static Value CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
- const Shape& values_shape, ONNXTensorElementDataType type);
+ /// <typeparam name="T">numeric data types only. Use GetStringTensor*() to retrieve strings.</typeparam>
+ /// <returns>a pointer to the internal values buffer. Do not free this pointer.</returns>
+ template <typename R>
+ const R* GetSparseTensorValues() const;
+
+#endif
+};
+
+template <typename T>
+struct ValueImpl : ConstValueImpl<T> {
+ using B = ConstValueImpl<T>;
+ using B::B;
+
+ /// <summary>
+ /// Returns a non-const typed pointer to an OrtValue/Tensor contained buffer
+ /// No type checking is performed, the caller must ensure the type matches the tensor type.
+ /// </summary>
+ /// <returns>non-const pointer to data, no copies made</returns>
+ template <typename R>
+ R* GetTensorMutableData();
+
+ /// <summary>
+ /// Returns a non-typed non-const pointer to a tensor contained data.
+ /// </summary>
+ /// <returns>pointer to data, no copies made</returns>
+ void* GetTensorMutableRawData();
+
+ /// <summary>
+ // Obtain a reference to an element of data at the location specified
+ /// by the vector of dims.
+ /// </summary>
+ /// <typeparam name="R"></typeparam>
+ /// <param name="location">in expressed by a vecotr of dimensions offsets</param>
+ /// <returns></returns>
+ template <typename R>
+ R& At(const std::vector<int64_t>& location);
+
+ /// <summary>
+ /// Set all strings at once in a string tensor
+ /// </summary>
+ /// <param name="s">in An array of strings. Each string in this array must be null terminated.</param>
+ /// <param name="s_len">in Count of strings in s (Must match the size of \p value's tensor shape)</param>
+ void FillStringTensor(const char* const* s, size_t s_len);
 
 /// <summary>
+ /// Set a single string in a string tensor
+ /// </summary>
+ /// <param name="s">in A null terminated UTF-8 encoded string</param>
+ /// <param name="index">in Index of the string in the tensor to set</param>
+ void FillStringTensorElement(const char* s, size_t index);
+
+#if !defined(DISABLE_SPARSE_TENSORS)
+ /// <summary>
 /// Supplies COO format specific indices and marks the contained sparse tensor as being a COO format tensor.
 /// Values are supplied with a CreateSparseTensor() API. The supplied indices are not copied and the user
 /// allocated buffers lifespan must eclipse that of the OrtValue.
@@ -779,51 +1186,6 @@
 /// <param name="indices_data">user allocated buffer with indices or nullptr for fully spare tensors</param>
 void UseBlockSparseIndices(const Shape& indices_shape, int32_t* indices_data);
 
-#endif // !defined(DISABLE_SPARSE_TENSORS)
-
- /** \brief Creates a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue.
- * \tparam T The numeric datatype. This API is not suitable for strings.
- * \param allocator The allocator to use.
- * \param shape Pointer to the tensor shape dimensions.
- * \param shape_len The number of tensor shape dimensions.
- */
- template <typename T>
- static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len);
-
- /** \brief Creates a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue.
- * \param allocator The allocator to use.
- * \param shape Pointer to the tensor shape dimensions.
- * \param shape_len The number of tensor shape dimensions.
- * \param type The data type.
- */
- static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type);
-
-#if !defined(DISABLE_SPARSE_TENSORS)
- /// <summary>
- /// This is a simple forwarding method the below CreateSparseTensor.
- /// This helps to specify data type enum in terms of C++ data type.
- /// Use CreateSparseTensor<T>
- /// </summary>
- /// <typeparam name="T">numeric data type only. String data enum must be specified explicitly.</typeparam>
- /// <param name="allocator">allocator to use</param>
- /// <param name="dense_shape">a would be dense shape of the tensor</param>
- /// <returns>Ort::Value</returns>
- template <typename T>
- static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape);
-
- /// <summary>
- /// Creates an instance of OrtValue containing sparse tensor. The created instance has no data.
- /// The data must be supplied by on of the FillSparseTensor<Format>() methods that take both non-zero values
- /// and indices. The data will be copied into a buffer that would be allocated using the supplied allocator.
- /// Use this API to create OrtValues that contain sparse tensors with all supported data types including
- /// strings.
- /// </summary>
- /// <param name="allocator">allocator to use. The allocator lifespan must eclipse that of the resulting OrtValue</param>
- /// <param name="dense_shape">a would be dense shape of the tensor</param>
- /// <param name="type">data type</param>
- /// <returns>an instance of Ort::Value</returns>
- static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape, ONNXTensorElementDataType type);
-
 /// <summary>
 /// The API will allocate memory using the allocator instance supplied to the CreateSparseTensor() API
 /// and copy the values and COO indices into it. If data_mem_info specifies that the data is located
@@ -866,43 +1228,68 @@
 const Shape& indices_shape,
 const int32_t* indices_data);
 
- /// <summary>
- /// The API returns the sparse data format this OrtValue holds in a sparse tensor.
- /// If the sparse tensor was not fully constructed, i.e. Use*() or Fill*() API were not used
- /// the value returned is ORT_SPARSE_UNDEFINED.
- /// </summary>
- /// <returns>Format enum</returns>
- OrtSparseFormat GetSparseFormat() const;
+#endif
+};
 
- /// <summary>
- /// The API returns type and shape information for stored non-zero values of the
- /// sparse tensor. Use GetSparseTensorValues() to obtain values buffer pointer.
- /// </summary>
- /// <returns>TensorTypeAndShapeInfo values information</returns>
- TensorTypeAndShapeInfo GetSparseTensorValuesTypeAndShapeInfo() const;
+} // namespace detail
 
- /// <summary>
- /// The API returns type and shape information for the specified indices. Each supported
- /// indices have their own enum values even if a give format has more than one kind of indices.
- /// Use GetSparseTensorIndicesData() to obtain pointer to indices buffer.
- /// </summary>
- /// <param name="format">enum requested</param>
- /// <returns>type and shape information</returns>
- TensorTypeAndShapeInfo GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat format) const;
+using ConstValue = detail::ConstValueImpl<detail::Unowned<const OrtValue>>;
+using UnownedValue = detail::ValueImpl<detail::Unowned<OrtValue>>;
 
- /// <summary>
- /// The API retrieves a pointer to the internal indices buffer. The API merely performs
- /// a convenience data type casting on the return type pointer. Make sure you are requesting
- /// the right type, use GetSparseTensorIndicesTypeShapeInfo();
- /// </summary>
- /// <typeparam name="T">type to cast to</typeparam>
- /// <param name="indices_format">requested indices kind</param>
- /// <param name="num_indices">number of indices entries</param>
- /// <returns>Pinter to the internal sparse tensor buffer containing indices. Do not free this pointer.</returns>
+/** \brief Wrapper around ::OrtValue
+ *
+ */
+struct Value : detail::ValueImpl<OrtValue> {
+ using Base = detail::ValueImpl<OrtValue>;
+ using OrtSparseValuesParam = detail::OrtSparseValuesParam;
+ using Shape = detail::Shape;
+
+ explicit Value(std::nullptr_t) {} ///< Create an empty Value object, must be assigned a valid one to be used
+ explicit Value(OrtValue* p) : Base{p} {} ///< Used for interop with the C API
+ Value(Value&&) = default;
+ Value& operator=(Value&&) = default;
+
+ ConstValue GetConst() const { return ConstValue{this->p_}; }
+ UnownedValue GetUnowned() const { return UnownedValue{this->p_}; }
+
+ /** \brief Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
+ * \tparam T The numeric datatype. This API is not suitable for strings.
+ * \param info Memory description of where the p_data buffer resides (CPU vs GPU etc).
+ * \param p_data Pointer to the data buffer.
+ * \param p_data_element_count The number of elements in the data buffer.
+ * \param shape Pointer to the tensor shape dimensions.
+ * \param shape_len The number of tensor shape dimensions.
+ */
+ template <typename T>
+ static Value CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count, const int64_t* shape, size_t shape_len);
+
+ /** \brief Creates a tensor with a user supplied buffer. Wraps OrtApi::CreateTensorWithDataAsOrtValue.
+ * \param info Memory description of where the p_data buffer resides (CPU vs GPU etc).
+ * \param p_data Pointer to the data buffer.
+ * \param p_data_byte_count The number of bytes in the data buffer.
+ * \param shape Pointer to the tensor shape dimensions.
+ * \param shape_len The number of tensor shape dimensions.
+ * \param type The data type.
+ */
+ static Value CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count, const int64_t* shape, size_t shape_len,
+ ONNXTensorElementDataType type);
+
+ /** \brief Creates a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue.
+ * \tparam T The numeric datatype. This API is not suitable for strings.
+ * \param allocator The allocator to use.
+ * \param shape Pointer to the tensor shape dimensions.
+ * \param shape_len The number of tensor shape dimensions.
+ */
 template <typename T>
- const T* GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const;
+ static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len);
 
-#endif // !defined(DISABLE_SPARSE_TENSORS)
+ /** \brief Creates a tensor using a supplied OrtAllocator. Wraps OrtApi::CreateTensorAsOrtValue.
+ * \param allocator The allocator to use.
+ * \param shape Pointer to the tensor shape dimensions.
+ * \param shape_len The number of tensor shape dimensions.
+ * \param type The data type.
+ */
+ static Value CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len, ONNXTensorElementDataType type);
 
 static Value CreateMap(Value& keys, Value& values); ///< Wraps OrtApi::CreateValue
 static Value CreateSequence(std::vector<Value>& values); ///< Wraps OrtApi::CreateValue
@@ -910,113 +1297,74 @@
 template <typename T>
 static Value CreateOpaque(const char* domain, const char* type_name, const T&); ///< Wraps OrtApi::CreateOpaqueValue
 
- template <typename T>
- void GetOpaqueData(const char* domain, const char* type_name, T&) const; ///< Wraps OrtApi::GetOpaqueValue
-
- explicit Value(std::nullptr_t) {} ///< Create an empty Value object, must be assigned a valid one to be used
- explicit Value(OrtValue* p) : Base<OrtValue>{p} {} ///< Used for interop with the C API
- Value(Value&&) = default;
- Value& operator=(Value&&) = default;
-
- bool IsTensor() const; ///< Returns true if Value is a tensor, false for other types like map/sequence/etc
- bool HasValue() const; /// < Return true if OrtValue contains data and returns false if the OrtValue is a None
-
 #if !defined(DISABLE_SPARSE_TENSORS)
 /// <summary>
- /// Returns true if the OrtValue contains a sparse tensor
+ /// This is a simple forwarding method to the other overload that helps deducing
+ /// data type enum value from the type of the buffer.
 /// </summary>
+ /// <typeparam name="T">numeric datatype. This API is not suitable for strings.</typeparam>
+ /// <param name="info">Memory description where the user buffers reside (CPU vs GPU etc)</param>
+ /// <param name="p_data">pointer to the user supplied buffer, use nullptr for fully sparse tensors</param>
+ /// <param name="dense_shape">a would be dense shape of the tensor</param>
+ /// <param name="values_shape">non zero values shape. Use a single 0 shape for fully sparse tensors.</param>
 /// <returns></returns>
- bool IsSparseTensor() const;
-#endif
-
- size_t GetCount() const; // If a non tensor, returns 2 for map and N for sequence, where N is the number of elements
- Value GetValue(int index, OrtAllocator* allocator) const;
-
- /// <summary>
- /// This API returns a full length of string data contained within either a tensor or a sparse Tensor.
- /// For sparse tensor it returns a full length of stored non-empty strings (values). The API is useful
- /// for allocating necessary memory and calling GetStringTensorContent().
- /// </summary>
- /// <returns>total length of UTF-8 encoded bytes contained. No zero terminators counted.</returns>
- size_t GetStringTensorDataLength() const;
-
- /// <summary>
- /// The API copies all of the UTF-8 encoded string data contained within a tensor or a sparse tensor
- /// into a supplied buffer. Use GetStringTensorDataLength() to find out the length of the buffer to allocate.
- /// The user must also allocate offsets buffer with the number of entries equal to that of the contained
- /// strings.
- ///
- /// Strings are always assumed to be on CPU, no X-device copy.
- /// </summary>
- /// <param name="buffer">user allocated buffer</param>
- /// <param name="buffer_length">length in bytes of the allocated buffer</param>
- /// <param name="offsets">a pointer to the offsets user allocated buffer</param>
- /// <param name="offsets_count">count of offsets, must be equal to the number of strings contained.
- /// that can be obtained from the shape of the tensor or from GetSparseTensorValuesTypeAndShapeInfo()
- /// for sparse tensors</param>
- void GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const;
-
- template <typename T>
- T* GetTensorMutableData(); ///< Wraps OrtApi::GetTensorMutableData
-
- template <typename T>
- const T* GetTensorData() const; ///< Wraps OrtApi::GetTensorMutableData
-
-#if !defined(DISABLE_SPARSE_TENSORS)
- /// <summary>
- /// The API returns a pointer to an internal buffer of the sparse tensor
- /// containing non-zero values. The API merely does casting. Make sure you
- /// are requesting the right data type by calling GetSparseTensorValuesTypeAndShapeInfo()
- /// first.
- /// </summary>
- /// <typeparam name="T">numeric data types only. Use GetStringTensor*() to retrieve strings.</typeparam>
- /// <returns>a pointer to the internal values buffer. Do not free this pointer.</returns>
- template <typename T>
- const T* GetSparseTensorValues() const;
-#endif
-
 template <typename T>
- T& At(const std::vector<int64_t>& location);
-
- /// <summary>
- /// The API returns type information for data contained in a tensor. For sparse
- /// tensors it returns type information for contained non-zero values.
- /// It returns dense shape for sparse tensors.
- /// </summary>
- /// <returns>TypeInfo</returns>
- TypeInfo GetTypeInfo() const;
+ static Value CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
+ const Shape& values_shape);
 
 /// <summary>
- /// The API returns type information for data contained in a tensor. For sparse
- /// tensors it returns type information for contained non-zero values.
- /// It returns dense shape for sparse tensors.
+ /// Creates an OrtValue instance containing SparseTensor. This constructs
+ /// a sparse tensor that makes use of user allocated buffers. It does not make copies
+ /// of the user provided data and does not modify it. The lifespan of user provided buffers should
+ /// eclipse the life span of the resulting OrtValue. This call constructs an instance that only contain
+ /// a pointer to non-zero values. To fully populate the sparse tensor call Use<Format>Indices() API below
+ /// to supply a sparse format specific indices.
+ /// This API is not suitable for string data. Use CreateSparseTensor() with allocator specified so strings
+ /// can be properly copied into the allocated buffer.
 /// </summary>
- /// <returns>TensorTypeAndShapeInfo</returns>
- TensorTypeAndShapeInfo GetTensorTypeAndShapeInfo() const;
+ /// <param name="info">Memory description where the user buffers reside (CPU vs GPU etc)</param>
+ /// <param name="p_data">pointer to the user supplied buffer, use nullptr for fully sparse tensors</param>
+ /// <param name="dense_shape">a would be dense shape of the tensor</param>
+ /// <param name="values_shape">non zero values shape. Use a single 0 shape for fully sparse tensors.</param>
+ /// <param name="type">data type</param>
+ /// <returns>Ort::Value instance containing SparseTensor</returns>
+ static Value CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
+ const Shape& values_shape, ONNXTensorElementDataType type);
 
 /// <summary>
- /// The API returns a byte length of UTF-8 encoded string element
- /// contained in either a tensor or a spare tensor values.
+ /// This is a simple forwarding method to the below CreateSparseTensor.
+ /// This helps to specify data type enum in terms of C++ data type.
+ /// Use CreateSparseTensor<T>
 /// </summary>
- /// <param name="element_index"></param>
- /// <returns>byte length for the specified string element</returns>
- size_t GetStringTensorElementLength(size_t element_index) const;
+ /// <typeparam name="T">numeric data type only. String data enum must be specified explicitly.</typeparam>
+ /// <param name="allocator">allocator to use</param>
+ /// <param name="dense_shape">a would be dense shape of the tensor</param>
+ /// <returns>Ort::Value</returns>
+ template <typename T>
+ static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape);
 
 /// <summary>
- /// The API copies UTF-8 encoded bytes for the requested string element
- /// contained within a tensor or a sparse tensor into a provided buffer.
- /// Use GetStringTensorElementLength() to obtain the length of the buffer to allocate.
+ /// Creates an instance of OrtValue containing sparse tensor. The created instance has no data.
+ /// The data must be supplied by on of the FillSparseTensor<Format>() methods that take both non-zero values
+ /// and indices. The data will be copied into a buffer that would be allocated using the supplied allocator.
+ /// Use this API to create OrtValues that contain sparse tensors with all supported data types including
+ /// strings.
 /// </summary>
- /// <param name="buffer_length"></param>
- /// <param name="element_index"></param>
- /// <param name="buffer"></param>
- void GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const;
+ /// <param name="allocator">allocator to use. The allocator lifespan must eclipse that of the resulting OrtValue</param>
+ /// <param name="dense_shape">a would be dense shape of the tensor</param>
+ /// <param name="type">data type</param>
+ /// <returns>an instance of Ort::Value</returns>
+ static Value CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape, ONNXTensorElementDataType type);
 
- void FillStringTensor(const char* const* s, size_t s_len);
- void FillStringTensorElement(const char* s, size_t index);
+#endif // !defined(DISABLE_SPARSE_TENSORS)
 };
 
-// Represents native memory allocation
+/// <summary>
+/// Represents native memory allocation coming from one of the
+/// OrtAllocators registered with OnnxRuntime.
+/// Use it to wrap an allocation made by an allocator
+/// so it can be automatically released when no longer needed.
+/// </summary>
 struct MemoryAllocation {
 MemoryAllocation(OrtAllocator* allocator, void* p, size_t size);
 ~MemoryAllocation();
@@ -1034,81 +1382,99 @@
 size_t size_;
 };
 
-struct AllocatorWithDefaultOptions {
- AllocatorWithDefaultOptions();
-
- operator OrtAllocator*() { return p_; }
- operator const OrtAllocator*() const { return p_; }
+namespace detail {
+template <typename T>
+struct AllocatorImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
 void* Alloc(size_t size);
- // The return value will own the allocation
 MemoryAllocation GetAllocation(size_t size);
 void Free(void* p);
+ ConstMemoryInfo GetInfo() const;
+};
 
- const OrtMemoryInfo* GetInfo() const;
+} // namespace detail
 
- private:
- OrtAllocator* p_{};
+/** \brief Wrapper around ::OrtAllocator default instance that is owned by Onnxruntime
+ *
+ */
+struct AllocatorWithDefaultOptions : detail::AllocatorImpl<detail::Unowned<OrtAllocator>> {
+ explicit AllocatorWithDefaultOptions(std::nullptr_t) {} ///< Convenience to create a class member and then replace with an instance
+ AllocatorWithDefaultOptions();
 };
 
-struct MemoryInfo : Base<OrtMemoryInfo> {
- static MemoryInfo CreateCpu(OrtAllocatorType type, OrtMemType mem_type1);
-
- explicit MemoryInfo(std::nullptr_t) {}
- explicit MemoryInfo(OrtMemoryInfo* p) : Base<OrtMemoryInfo>{p} {} ///< Used for interop with the C API
- MemoryInfo(const char* name, OrtAllocatorType type, int id, OrtMemType mem_type);
+/** \brief Wrapper around ::OrtAllocator
+ *
+ */
+struct Allocator : detail::AllocatorImpl<OrtAllocator> {
+ explicit Allocator(std::nullptr_t) {} ///< Convenience to create a class member and then replace with an instance
+ Allocator(const Session& session, const OrtMemoryInfo*);
+};
 
- std::string GetAllocatorName() const;
- OrtAllocatorType GetAllocatorType() const;
- int GetDeviceId() const;
- OrtMemType GetMemoryType() const;
+using UnownedAllocator = detail::AllocatorImpl<detail::Unowned<OrtAllocator>>;
 
- bool operator==(const MemoryInfo& o) const;
-};
+namespace detail {
+namespace binding_utils {
+// Bring these out of template
+std::vector<std::string> GetOutputNamesHelper(const OrtIoBinding* binding, OrtAllocator*);
+std::vector<Value> GetOutputValuesHelper(const OrtIoBinding* binding, OrtAllocator*);
+} // namespace binding_utils
 
-struct Allocator : public Base<OrtAllocator> {
- Allocator(const Session& session, const MemoryInfo&);
+template <typename T>
+struct ConstIoBindingImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
 
- void* Alloc(size_t size) const;
- // The return value will own the allocation
- MemoryAllocation GetAllocation(size_t size);
- void Free(void* p) const;
- Unowned<const MemoryInfo> GetInfo() const;
+ std::vector<std::string> GetOutputNames() const;
+ std::vector<std::string> GetOutputNames(OrtAllocator*) const;
+ std::vector<Value> GetOutputValues() const;
+ std::vector<Value> GetOutputValues(OrtAllocator*) const;
 };
 
-struct IoBinding : public Base<OrtIoBinding> {
- explicit IoBinding(Session& session);
+template <typename T>
+struct IoBindingImpl : ConstIoBindingImpl<T> {
+ using B = ConstIoBindingImpl<T>;
+ using B::B;
+
 void BindInput(const char* name, const Value&);
 void BindOutput(const char* name, const Value&);
- void BindOutput(const char* name, const MemoryInfo&);
- std::vector<std::string> GetOutputNames() const;
- std::vector<std::string> GetOutputNames(Allocator&) const;
- std::vector<Value> GetOutputValues() const;
- std::vector<Value> GetOutputValues(Allocator&) const;
+ void BindOutput(const char* name, const OrtMemoryInfo*);
 void ClearBoundInputs();
 void ClearBoundOutputs();
 void SynchronizeInputs();
 void SynchronizeOutputs();
+};
 
- private:
- std::vector<std::string> GetOutputNamesHelper(OrtAllocator*) const;
- std::vector<Value> GetOutputValuesHelper(OrtAllocator*) const;
+} // namespace detail
+
+using ConstIoBinding = detail::ConstIoBindingImpl<detail::Unowned<const OrtIoBinding>>;
+using UnownedIoBinding = detail::IoBindingImpl<detail::Unowned<OrtIoBinding>>;
+
+/** \brief Wrapper around ::OrtIoBinding
+ *
+ */
+struct IoBinding : detail::IoBindingImpl<OrtIoBinding> {
+ explicit IoBinding(std::nullptr_t) {} ///< Create an empty object for convenience. Sometimes, we want to initialize members later.
+ explicit IoBinding(Session& session);
+ ConstIoBinding GetConst() const { return ConstIoBinding{this->p_}; }
+ UnownedIoBinding GetUnowned() const { return UnownedIoBinding{this->p_}; }
 };
 
 /*! \struct Ort::ArenaCfg
- * \brief it is a structure that represents the configuration of an arena based allocator
- * \details Please see docs/C_API.md for details
- */
-struct ArenaCfg : Base<OrtArenaCfg> {
+ * \brief it is a structure that represents the configuration of an arena based allocator
+ * \details Please see docs/C_API.md for details
+ */
+struct ArenaCfg : detail::Base<OrtArenaCfg> {
 explicit ArenaCfg(std::nullptr_t) {} ///< Create an empty ArenaCfg object, must be assigned a valid one to be used
 /**
- * Wraps OrtApi::CreateArenaCfg
- * \param max_mem - use 0 to allow ORT to choose the default
- * \param arena_extend_strategy - use -1 to allow ORT to choose the default, 0 = kNextPowerOfTwo, 1 = kSameAsRequested
- * \param initial_chunk_size_bytes - use -1 to allow ORT to choose the default
- * \param max_dead_bytes_per_chunk - use -1 to allow ORT to choose the default
- * See docs/C_API.md for details on what the following parameters mean and how to choose these values
- */
+ * Wraps OrtApi::CreateArenaCfg
+ * \param max_mem - use 0 to allow ORT to choose the default
+ * \param arena_extend_strategy - use -1 to allow ORT to choose the default, 0 = kNextPowerOfTwo, 1 = kSameAsRequested
+ * \param initial_chunk_size_bytes - use -1 to allow ORT to choose the default
+ * \param max_dead_bytes_per_chunk - use -1 to allow ORT to choose the default
+ * See docs/C_API.md for details on what the following parameters mean and how to choose these values
+ */
 ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk);
 };
 
@@ -1116,67 +1482,302 @@
 // Custom OPs (only needed to implement custom OPs)
 //
 
+/// <summary>
+/// This struct provides life time management for custom op attribute
+/// </summary>
+struct OpAttr : detail::Base<OrtOpAttr> {
+ OpAttr(const char* name, const void* data, int len, OrtOpAttrType type);
+};
+
+/// <summary>
+/// This class wraps a raw pointer OrtKernelContext* that is being passed
+/// to the custom kernel Compute() method. Use it to safely access context
+/// attributes, input and output parameters with exception safety guarantees.
+/// See usage example in onnxruntime/test/testdata/custom_op_library/custom_op_library.cc
+/// </summary>
+struct KernelContext {
+ explicit KernelContext(OrtKernelContext* context);
+ size_t GetInputCount() const;
+ size_t GetOutputCount() const;
+ ConstValue GetInput(size_t index) const;
+ UnownedValue GetOutput(size_t index, const int64_t* dim_values, size_t dim_count) const;
+ UnownedValue GetOutput(size_t index, const std::vector<int64_t>& dims) const;
+ void* GetGPUComputeStream() const;
+
+ private:
+ OrtKernelContext* ctx_;
+};
+
+struct KernelInfo;
+
+namespace detail {
+namespace attr_utils {
+void GetAttr(const OrtKernelInfo* p, const char* name, float&);
+void GetAttr(const OrtKernelInfo* p, const char* name, int64_t&);
+void GetAttr(const OrtKernelInfo* p, const char* name, std::string&);
+void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<float>&);
+void GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<int64_t>&);
+} // namespace attr_utils
+
+template <typename T>
+struct KernelInfoImpl : Base<T> {
+ using B = Base<T>;
+ using B::B;
+
+ KernelInfo Copy() const;
+
+ template <typename R> // R is only implemented for float, int64_t, and string
+ R GetAttribute(const char* name) const {
+ R val;
+ attr_utils::GetAttr(this->p_, name, val);
+ return val;
+ }
+
+ template <typename R> // R is only implemented for std::vector<float>, std::vector<int64_t>
+ std::vector<R> GetAttributes(const char* name) const {
+ std::vector<R> result;
+ attr_utils::GetAttrs(this->p_, name, result);
+ return result;
+ }
+
+ Value GetTensorAttribute(const char* name, OrtAllocator* allocator) const;
+
+ size_t GetInputCount() const;
+ size_t GetOutputCount() const;
+
+ std::string GetInputName(size_t index) const;
+ std::string GetOutputName(size_t index) const;
+
+ TypeInfo GetInputTypeInfo(size_t index) const;
+ TypeInfo GetOutputTypeInfo(size_t index) const;
+};
+
+} // namespace detail
+
+using ConstKernelInfo = detail::KernelInfoImpl<detail::Unowned<const OrtKernelInfo>>;
+
+/// <summary>
+/// This struct owns the OrtKernInfo* pointer when a copy is made.
+/// For convenient wrapping of OrtKernelInfo* passed to kernel constructor
+/// and query attributes, warp the pointer with Ort::Unowned<KernelInfo> instance
+/// so it does not destroy the pointer the kernel does not own.
+/// </summary>
+struct KernelInfo : detail::KernelInfoImpl<OrtKernelInfo> {
+ explicit KernelInfo(std::nullptr_t) {} ///< Create an empty instance to initialize later
+ explicit KernelInfo(OrtKernelInfo* info); ///< Take ownership of the instance
+ ConstKernelInfo GetConst() const { return ConstKernelInfo{this->p_}; }
+};
+
+/// <summary>
+/// Create and own custom defined operation.
+/// </summary>
+struct Op : detail::Base<OrtOp> {
+ explicit Op(std::nullptr_t) {} ///< Create an empty Operator object, must be assigned a valid one to be used
+
+ explicit Op(OrtOp*); ///< Take ownership of the OrtOp
+
+ static Op Create(const OrtKernelInfo* info, const char* op_name, const char* domain,
+ int version, const char** type_constraint_names,
+ const ONNXTensorElementDataType* type_constraint_values,
+ size_t type_constraint_count,
+ const OpAttr* attr_values,
+ size_t attr_count,
+ size_t input_count, size_t output_count);
+
+ void Invoke(const OrtKernelContext* context,
+ const Value* input_values,
+ size_t input_count,
+ Value* output_values,
+ size_t output_count);
+
+ // For easier refactoring
+ void Invoke(const OrtKernelContext* context,
+ const OrtValue* const* input_values,
+ size_t input_count,
+ OrtValue* const* output_values,
+ size_t output_count);
+};
+
+/// <summary>
+/// This entire structure is deprecated, but we not marking
+/// it as a whole yet since we want to preserve for the next release.
+/// </summary>
 struct CustomOpApi {
 CustomOpApi(const OrtApi& api) : api_(api) {}
 
- template <typename T> // T is only implemented for std::vector<float>, std::vector<int64_t>, float, int64_t, and string
- T KernelInfoGetAttribute(_In_ const OrtKernelInfo* info, _In_ const char* name);
+ /** \deprecated use Ort::Value::GetTensorTypeAndShape()
+ * deprecated
+ * This interface produces a pointer that must be released. Not exception safe.
+ */
+ deprecated("use Ort::Value::GetTensorTypeAndShape()") OrtTensorTypeAndShapeInfo* GetTensorTypeAndShape(_In_ const OrtValue* value);
+
+ /** \deprecated use Ort::TensorTypeAndShapeInfo::GetElementCount()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::TensorTypeAndShapeInfo::GetElementCount()") size_t GetTensorShapeElementCount(_In_ const OrtTensorTypeAndShapeInfo* info);
+
+ /** \deprecated use Ort::TensorTypeAndShapeInfo::GetElementType()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::TensorTypeAndShapeInfo::GetElementType()") ONNXTensorElementDataType GetTensorElementType(const OrtTensorTypeAndShapeInfo* info);
+
+ /** \deprecated use Ort::TensorTypeAndShapeInfo::GetDimensionsCount()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::TensorTypeAndShapeInfo::GetDimensionsCount()") size_t GetDimensionsCount(_In_ const OrtTensorTypeAndShapeInfo* info);
+
+ /** \deprecated use Ort::TensorTypeAndShapeInfo::GetShape()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::TensorTypeAndShapeInfo::GetShape()") void GetDimensions(_In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values, size_t dim_values_length);
 
- OrtTensorTypeAndShapeInfo* GetTensorTypeAndShape(_In_ const OrtValue* value);
- size_t GetTensorShapeElementCount(_In_ const OrtTensorTypeAndShapeInfo* info);
- ONNXTensorElementDataType GetTensorElementType(const OrtTensorTypeAndShapeInfo* info);
- size_t GetDimensionsCount(_In_ const OrtTensorTypeAndShapeInfo* info);
- void GetDimensions(_In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values, size_t dim_values_length);
- void SetDimensions(OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
+ /** \deprecated
+ * deprecated
+ * This interface sets dimensions to TensorTypeAndShapeInfo, but has no effect on the OrtValue.
+ */
+ deprecated("Do not use") void SetDimensions(OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count);
 
+ /** \deprecated use Ort::Value::GetTensorMutableData()
+ * deprecated
+ * This interface is redundant.
+ */
 template <typename T>
- T* GetTensorMutableData(_Inout_ OrtValue* value);
+ deprecated("use Ort::Value::GetTensorMutableData()") T* GetTensorMutableData(_Inout_ OrtValue* value);
+
+ /** \deprecated use Ort::Value::GetTensorData()
+ * deprecated
+ * This interface is redundant.
+ */
 template <typename T>
- const T* GetTensorData(_Inout_ const OrtValue* value);
+ deprecated("use Ort::Value::GetTensorData()") const T* GetTensorData(_Inout_ const OrtValue* value);
+
+ /** \deprecated use Ort::Value::GetTensorMemoryInfo()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::Value::GetTensorMemoryInfo()") const OrtMemoryInfo* GetTensorMemoryInfo(_In_ const OrtValue* value);
+
+ /** \deprecated use Ort::TensorTypeAndShapeInfo::GetShape()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::TensorTypeAndShapeInfo::GetShape()") std::vector<int64_t> GetTensorShape(const OrtTensorTypeAndShapeInfo* info);
+
+ /** \deprecated use TensorTypeAndShapeInfo instances for automatic ownership.
+ * deprecated
+ * This interface is not exception safe.
+ */
+ deprecated("use TensorTypeAndShapeInfo") void ReleaseTensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* input);
+
+ /** \deprecated use Ort::KernelContext::GetInputCount
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::KernelContext::GetInputCount") size_t KernelContext_GetInputCount(const OrtKernelContext* context);
 
- const OrtMemoryInfo* GetTensorMemoryInfo(_In_ const OrtValue* value);
+ /** \deprecated use Ort::KernelContext::GetInput
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::KernelContext::GetInput") const OrtValue* KernelContext_GetInput(const OrtKernelContext* context, _In_ size_t index);
 
- std::vector<int64_t> GetTensorShape(const OrtTensorTypeAndShapeInfo* info);
- void ReleaseTensorTypeAndShapeInfo(OrtTensorTypeAndShapeInfo* input);
- size_t KernelContext_GetInputCount(const OrtKernelContext* context);
- const OrtValue* KernelContext_GetInput(const OrtKernelContext* context, _In_ size_t index);
- size_t KernelContext_GetOutputCount(const OrtKernelContext* context);
- OrtValue* KernelContext_GetOutput(OrtKernelContext* context, _In_ size_t index, _In_ const int64_t* dim_values, size_t dim_count);
- void* KernelContext_GetGPUComputeStream(const OrtKernelContext* context);
+ /** \deprecated use Ort::KernelContext::GetOutputCount
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::KernelContext::GetOutputCount") size_t KernelContext_GetOutputCount(const OrtKernelContext* context);
 
- void ThrowOnError(OrtStatus* result);
+ /** \deprecated use Ort::KernelContext::GetOutput
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::KernelContext::GetOutput") OrtValue* KernelContext_GetOutput(OrtKernelContext* context, _In_ size_t index, _In_ const int64_t* dim_values, size_t dim_count);
 
- OrtOpAttr* CreateOpAttr(_In_ const char* name,
- _In_ const void* data,
- _In_ int len,
- _In_ OrtOpAttrType type);
+ /** \deprecated use Ort::KernelContext::GetGPUComputeStream
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::KernelContext::GetGPUComputeStream") void* KernelContext_GetGPUComputeStream(const OrtKernelContext* context);
 
- void ReleaseOpAttr(_Frees_ptr_opt_ OrtOpAttr* op_attr);
+ /** \deprecated use Ort::ThrowOnError()
+ * deprecated
+ * This interface is redundant.
+ */
+ deprecated("use Ort::ThrowOnError()") void ThrowOnError(OrtStatus* result);
 
- OrtOp* CreateOp(_In_ const OrtKernelInfo* info,
- _In_ const char* op_name,
- _In_ const char* domain,
- _In_ int version,
- _In_opt_ const char** type_constraint_names,
- _In_opt_ const ONNXTensorElementDataType* type_constraint_values,
- _In_opt_ int type_constraint_count,
- _In_opt_ const OrtOpAttr* const* attr_values,
- _In_opt_ int attr_count,
- _In_ int input_count,
- _In_ int output_count);
+ /** \deprecated use Ort::OpAttr
+ * deprecated
+ * This interface is not exception safe.
+ */
+ deprecated("use Ort::OpAttr") OrtOpAttr* CreateOpAttr(_In_ const char* name,
+ _In_ const void* data,
+ _In_ int len,
+ _In_ OrtOpAttrType type);
+
+ /** \deprecated use Ort::OpAttr
+ * deprecated
+ * This interface is not exception safe.
+ */
+ deprecated("use Ort::OpAttr") void ReleaseOpAttr(_Frees_ptr_opt_ OrtOpAttr* op_attr);
 
- void InvokeOp(_In_ const OrtKernelContext* context,
- _In_ const OrtOp* ort_op,
- _In_ const OrtValue* const* input_values,
- _In_ int input_count,
- _Inout_ OrtValue* const* output_values,
- _In_ int output_count);
+ /** \deprecated use Ort::Op
+ * deprecated
+ * This interface is not exception safe.
+ */
+ deprecated("use Ort::Op") OrtOp* CreateOp(_In_ const OrtKernelInfo* info,
+ _In_ const char* op_name,
+ _In_ const char* domain,
+ _In_ int version,
+ _In_opt_ const char** type_constraint_names,
+ _In_opt_ const ONNXTensorElementDataType* type_constraint_values,
+ _In_opt_ int type_constraint_count,
+ _In_opt_ const OrtOpAttr* const* attr_values,
+ _In_opt_ int attr_count,
+ _In_ int input_count,
+ _In_ int output_count);
+
+ /** \deprecated use Ort::Op::Invoke
+ * deprecated
+ * This interface is redundant
+ */
+ deprecated("use Ort::Op::Invoke") void InvokeOp(_In_ const OrtKernelContext* context,
+ _In_ const OrtOp* ort_op,
+ _In_ const OrtValue* const* input_values,
+ _In_ int input_count,
+ _Inout_ OrtValue* const* output_values,
+ _In_ int output_count);
+
+ /** \deprecated use Ort::Op for automatic lifespan management.
+ * deprecated
+ * This interface is not exception safe.
+ */
+ deprecated("use Ort::Op") void ReleaseOp(_Frees_ptr_opt_ OrtOp* ort_op);
 
- void ReleaseOp(_Frees_ptr_opt_ OrtOp* ort_op);
+ /** \deprecated use Ort::KernelInfo for automatic lifespan management or for
+ * querying attributes
+ * deprecated
+ * This interface is redundant
+ */
+ template <typename T> // T is only implemented for std::vector<float>, std::vector<int64_t>, float, int64_t, and string
+ deprecated("use Ort::KernelInfo::GetAttribute") T KernelInfoGetAttribute(_In_ const OrtKernelInfo* info, _In_ const char* name);
 
- OrtKernelInfo* CopyKernelInfo(_In_ const OrtKernelInfo* info);
+ /** \deprecated use Ort::KernelInfo::Copy
+ * querying attributes
+ * deprecated
+ * This interface is not exception safe
+ */
+ deprecated("use Ort::KernelInfo::Copy") OrtKernelInfo* CopyKernelInfo(_In_ const OrtKernelInfo* info);
 
- void ReleaseKernelInfo(_Frees_ptr_opt_ OrtKernelInfo* info_copy);
+ /** \deprecated use Ort::KernelInfo for lifespan management
+ * querying attributes
+ * deprecated
+ * This interface is not exception safe
+ */
+ deprecated("use Ort::KernelInfo") void ReleaseKernelInfo(_Frees_ptr_opt_ OrtKernelInfo* info_copy);
 
 private:
 const OrtApi& api_;
@@ -1193,6 +1794,7 @@
 
 OrtCustomOp::GetInputTypeCount = (const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetInputTypeCount(); };
 OrtCustomOp::GetInputType = (const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputType(index); };
+ OrtCustomOp::GetInputMemoryType = (const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputMemoryType(index); };
 
 OrtCustomOp::GetOutputTypeCount = (const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetOutputTypeCount(); };
 OrtCustomOp::GetOutputType = (const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputType(index); };
@@ -1208,6 +1810,11 @@
 #endif
 OrtCustomOp::GetInputCharacteristic = (const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetInputCharacteristic(index); };
 OrtCustomOp::GetOutputCharacteristic = (const OrtCustomOp* this_, size_t index) { return static_cast<const TOp*>(this_)->GetOutputCharacteristic(index); };
+
+ OrtCustomOp::GetVariadicInputMinArity = (const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicInputMinArity(); };
+ OrtCustomOp::GetVariadicInputHomogeneity = (const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicInputHomogeneity()); };
+ OrtCustomOp::GetVariadicOutputMinArity = (const OrtCustomOp* this_) { return static_cast<const TOp*>(this_)->GetVariadicOutputMinArity(); };
+ OrtCustomOp::GetVariadicOutputHomogeneity = (const OrtCustomOp* this_) { return static_cast<int>(static_cast<const TOp*>(this_)->GetVariadicOutputHomogeneity()); };
 }
 
 // Default implementation of GetExecutionProviderType that returns nullptr to default to the CPU provider
@@ -1222,6 +1829,46 @@
 OrtCustomOpInputOutputCharacteristic GetOutputCharacteristic(size_t /*index*/) const {
 return OrtCustomOpInputOutputCharacteristic::INPUT_OUTPUT_REQUIRED;
 }
+
+ // Default implemention of GetInputMemoryType() that returns OrtMemTypeDefault
+ OrtMemType GetInputMemoryType(size_t /*index*/) const {
+ return OrtMemTypeDefault;
+ }
+
+ // Default implementation of GetVariadicInputMinArity() returns 1 to specify that a variadic input
+ // should expect at least 1 argument.
+ int GetVariadicInputMinArity() const {
+ return 1;
+ }
+
+ // Default implementation of GetVariadicInputHomegeneity() returns true to specify that all arguments
+ // to a variadic input should be of the same type.
+ bool GetVariadicInputHomogeneity() const {
+ return true;
+ }
+
+ // Default implementation of GetVariadicOutputMinArity() returns 1 to specify that a variadic output
+ // should produce at least 1 output value.
+ int GetVariadicOutputMinArity() const {
+ return 1;
+ }
+
+ // Default implementation of GetVariadicOutputHomegeneity() returns true to specify that all output values
+ // produced by a variadic output should be of the same type.
+ bool GetVariadicOutputHomogeneity() const {
+ return true;
+ }
+
+ // Declare list of session config entries used by this Custom Op.
+ // Implement this function in order to get configs from CustomOpBase::GetSessionConfigs().
+ // This default implementation returns an empty vector of config entries.
+ std::vector<std::string> GetSessionConfigKeys() const {
+ return std::vector<std::string>{};
+ }
+
+ protected:
+ // Helper function that returns a map of session config entries specified by CustomOpBase::GetSessionConfigKeys.
+ void GetSessionConfigs(std::unordered_map<std::string, std::string>& out, ConstSessionOptions options) const;
 };
 
 } // namespace Ort

onnxruntime-linux-x64-1.12.1.tgz/include/onnxruntime_cxx_inline.h -> onnxruntime-linux-x64-1.14.1.tgz/include/onnxruntime_cxx_inline.h Changed

@@ -9,48 +9,102 @@
 
 namespace Ort {
 
-inline void ThrowOnError(const OrtApi& ort, OrtStatus* status) {
- if (status) {
- std::string error_message = ort.GetErrorMessage(status);
- OrtErrorCode error_code = ort.GetErrorCode(status);
- ort.ReleaseStatus(status);
- ORT_CXX_API_THROW(std::move(error_message), error_code);
+namespace detail {
+inline void ThrowStatus(const Status& st) {
+ std::string error_message = st.GetErrorMessage();
+ OrtErrorCode error_code = st.GetErrorCode();
+ ORT_CXX_API_THROW(std::move(error_message), error_code);
+}
+} // namespace detail
+
+inline void ThrowOnError(OrtStatus* ort_status) {
+ if (ort_status) {
+ Ort::Status st(ort_status);
+ detail::ThrowStatus(st);
 }
 }
 
-inline void ThrowOnError(OrtStatus* status) {
- ThrowOnError(GetApi(), status);
+inline void ThrowOnError(const Status& st) {
+ if (st) {
+ detail::ThrowStatus(st);
+ }
+}
+
+inline Status::Status(OrtStatus* status) : Base<OrtStatus>{status} {
+}
+
+inline Status::Status(const std::exception& e) {
+ p_ = GetApi().CreateStatus(ORT_FAIL, e.what());
+}
+
+inline Status::Status(const Exception& e) {
+ p_ = GetApi().CreateStatus(e.GetOrtErrorCode(), e.what());
+}
+
+inline std::string Status::GetErrorMessage() const {
+ std::string message(GetApi().GetErrorMessage(p_));
+ return message;
+}
+
+inline OrtErrorCode Status::GetErrorCode() const {
+ return GetApi().GetErrorCode(p_);
 }
 
 // This template converts a C++ type into it's ONNXTensorElementDataType
 template <typename T>
 struct TypeToTensorType;
 template <>
-struct TypeToTensorType<float> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT; };
+struct TypeToTensorType<float> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT;
+};
 template <>
-struct TypeToTensorType<Float16_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16; };
+struct TypeToTensorType<Float16_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_FLOAT16;
+};
 template <>
-struct TypeToTensorType<BFloat16_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16; };
+struct TypeToTensorType<BFloat16_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_BFLOAT16;
+};
 template <>
-struct TypeToTensorType<double> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE; };
+struct TypeToTensorType<double> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_DOUBLE;
+};
 template <>
-struct TypeToTensorType<int8_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8; };
+struct TypeToTensorType<int8_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT8;
+};
 template <>
-struct TypeToTensorType<int16_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16; };
+struct TypeToTensorType<int16_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT16;
+};
 template <>
-struct TypeToTensorType<int32_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32; };
+struct TypeToTensorType<int32_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT32;
+};
 template <>
-struct TypeToTensorType<int64_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64; };
+struct TypeToTensorType<int64_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_INT64;
+};
 template <>
-struct TypeToTensorType<uint8_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8; };
+struct TypeToTensorType<uint8_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT8;
+};
 template <>
-struct TypeToTensorType<uint16_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16; };
+struct TypeToTensorType<uint16_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT16;
+};
 template <>
-struct TypeToTensorType<uint32_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32; };
+struct TypeToTensorType<uint32_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT32;
+};
 template <>
-struct TypeToTensorType<uint64_t> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64; };
+struct TypeToTensorType<uint64_t> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_UINT64;
+};
 template <>
-struct TypeToTensorType<bool> { static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL; };
+struct TypeToTensorType<bool> {
+ static constexpr ONNXTensorElementDataType type = ONNX_TENSOR_ELEMENT_DATA_TYPE_BOOL;
+};
 
 inline MemoryAllocation::MemoryAllocation(OrtAllocator* allocator, void* p, size_t size)
 : allocator_(allocator), p_(p), size_(size) {
@@ -88,63 +142,92 @@
 return *this;
 }
 
-inline AllocatorWithDefaultOptions::AllocatorWithDefaultOptions() {
- ThrowOnError(GetApi().GetAllocatorWithDefaultOptions(&p_));
-}
+namespace detail {
 
-inline void* AllocatorWithDefaultOptions::Alloc(size_t size) {
+template <typename T>
+inline void* AllocatorImpl<T>::Alloc(size_t size) {
 void* out;
- ThrowOnError(GetApi().AllocatorAlloc(p_, size, &out));
+ ThrowOnError(GetApi().AllocatorAlloc(this->p_, size, &out));
 return out;
 }
 
-inline MemoryAllocation Ort::AllocatorWithDefaultOptions::GetAllocation(size_t size) {
+template <typename T>
+inline MemoryAllocation AllocatorImpl<T>::GetAllocation(size_t size) {
 void* out;
- ThrowOnError(GetApi().AllocatorAlloc(p_, size, &out));
- MemoryAllocation result(p_, out, size);
+ ThrowOnError(GetApi().AllocatorAlloc(this->p_, size, &out));
+ MemoryAllocation result(this->p_, out, size);
 return result;
 }
 
-inline void AllocatorWithDefaultOptions::Free(void* p) {
- ThrowOnError(GetApi().AllocatorFree(p_, p));
+template <typename T>
+inline void AllocatorImpl<T>::Free(void* p) {
+ ThrowOnError(GetApi().AllocatorFree(this->p_, p));
 }
 
-inline const OrtMemoryInfo* AllocatorWithDefaultOptions::GetInfo() const {
+template <typename T>
+inline ConstMemoryInfo AllocatorImpl<T>::GetInfo() const {
 const OrtMemoryInfo* out;
- ThrowOnError(GetApi().AllocatorGetInfo(p_, &out));
- return out;
+ ThrowOnError(GetApi().AllocatorGetInfo(this->p_, &out));
+ return ConstMemoryInfo{out};
+}
+
+} // namespace detail
+
+inline AllocatorWithDefaultOptions::AllocatorWithDefaultOptions() {
+ ThrowOnError(GetApi().GetAllocatorWithDefaultOptions(&this->p_));
+}
+
+inline Allocator::Allocator(const Session& sess, const OrtMemoryInfo* mem_info) {
+ ThrowOnError(GetApi().CreateAllocator(sess, mem_info, &this->p_));
 }
 
-inline std::string MemoryInfo::GetAllocatorName() const {
+namespace detail {
+
+template <typename T>
+inline std::string MemoryInfoImpl<T>::GetAllocatorName() const {
 const char* name = nullptr;
- ThrowOnError(GetApi().MemoryInfoGetName(*this, &name));
+ ThrowOnError(GetApi().MemoryInfoGetName(this->p_, &name));
 return std::string(name);
 }
 
-inline OrtAllocatorType MemoryInfo::GetAllocatorType() const {
+template <typename T>
+inline OrtAllocatorType MemoryInfoImpl<T>::GetAllocatorType() const {
 OrtAllocatorType type;
- ThrowOnError(GetApi().MemoryInfoGetType(*this, &type));
+ ThrowOnError(GetApi().MemoryInfoGetType(this->p_, &type));
 return type;
 }
 
-inline int MemoryInfo::GetDeviceId() const {
+template <typename T>
+inline int MemoryInfoImpl<T>::GetDeviceId() const {
 int id = 0;
- ThrowOnError(GetApi().MemoryInfoGetId(*this, &id));
+ ThrowOnError(GetApi().MemoryInfoGetId(this->p_, &id));
 return id;
 }
 
-inline OrtMemType MemoryInfo::GetMemoryType() const {
+template <typename T>
+inline OrtMemoryInfoDeviceType MemoryInfoImpl<T>::GetDeviceType() const {
+ OrtMemoryInfoDeviceType type;
+ GetApi().MemoryInfoGetDeviceType(this->p_, &type);
+ return type;
+}
+
+template <typename T>
+inline OrtMemType MemoryInfoImpl<T>::GetMemoryType() const {
 OrtMemType type;
- ThrowOnError(GetApi().MemoryInfoGetMemType(*this, &type));
+ ThrowOnError(GetApi().MemoryInfoGetMemType(this->p_, &type));
 return type;
 }
 
-inline bool MemoryInfo::operator==(const MemoryInfo& o) const {
+template <typename T>
+template <typename U>
+inline bool MemoryInfoImpl<T>::operator==(const MemoryInfoImpl& o) const {
 int comp_result = 0;
- ThrowOnError(Ort::GetApi().CompareMemoryInfo(*this, o, &comp_result));
+ ThrowOnError(Ort::GetApi().CompareMemoryInfo(this->p_, o, &comp_result));
 return comp_result == 0;
 }
 
+} // namespace detail
+
 inline MemoryInfo MemoryInfo::CreateCpu(OrtAllocatorType type, OrtMemType mem_type) {
 OrtMemoryInfo* p;
 ThrowOnError(GetApi().CreateCpuMemoryInfo(type, mem_type, &p));
@@ -152,53 +235,69 @@
 }
 
 inline MemoryInfo::MemoryInfo(const char* name, OrtAllocatorType type, int id, OrtMemType mem_type) {
- ThrowOnError(GetApi().CreateMemoryInfo(name, type, id, mem_type, &p_));
+ ThrowOnError(GetApi().CreateMemoryInfo(name, type, id, mem_type, &this->p_));
 }
 
-inline Allocator::Allocator(const Session& sess, const MemoryInfo& mem_info) {
- ThrowOnError(GetApi().CreateAllocator(sess, mem_info, &p_));
+namespace detail {
+template <typename T>
+inline std::vector<std::string> ConstIoBindingImpl<T>::GetOutputNames() const {
+ AllocatorWithDefaultOptions allocator;
+ return binding_utils::GetOutputNamesHelper(this->p_, allocator);
 }
 
-inline void* Allocator::Alloc(size_t size) const {
- void* out = nullptr;
- ThrowOnError(GetApi().AllocatorAlloc(p_, size, &out));
- return out;
+template <typename T>
+inline std::vector<std::string> ConstIoBindingImpl<T>::GetOutputNames(OrtAllocator* allocator) const {
+ return binding_utils::GetOutputNamesHelper(this->p_, allocator);
 }
 
-inline MemoryAllocation Ort::Allocator::GetAllocation(size_t size) {
- void* out = nullptr;
- ThrowOnError(GetApi().AllocatorAlloc(p_, size, &out));
- MemoryAllocation result(p_, out, size);
- return result;
+template <typename T>
+inline std::vector<Value> ConstIoBindingImpl<T>::GetOutputValues() const {
+ AllocatorWithDefaultOptions allocator;
+ return binding_utils::GetOutputValuesHelper(this->p_, allocator);
 }
 
-inline void Allocator::Free(void* p) const {
- ThrowOnError(GetApi().AllocatorFree(p_, p));
+template <typename T>
+inline std::vector<Value> ConstIoBindingImpl<T>::GetOutputValues(OrtAllocator* allocator) const {
+ return binding_utils::GetOutputValuesHelper(this->p_, allocator);
 }
 
-inline Unowned<const MemoryInfo> Allocator::GetInfo() const {
- const OrtMemoryInfo* out = nullptr;
- ThrowOnError(GetApi().AllocatorGetInfo(p_, &out));
- return Unowned<const MemoryInfo>(const_cast<OrtMemoryInfo*>(out));
+template <typename T>
+inline void IoBindingImpl<T>::BindInput(const char* name, const Value& value) {
+ ThrowOnError(GetApi().BindInput(this->p_, name, value));
 }
 
-inline IoBinding::IoBinding(Session& session) {
- ThrowOnError(GetApi().CreateIoBinding(session, &p_));
+template <typename T>
+inline void IoBindingImpl<T>::BindOutput(const char* name, const Value& value) {
+ ThrowOnError(GetApi().BindOutput(this->p_, name, value));
 }
 
-inline void IoBinding::BindInput(const char* name, const Value& value) {
- ThrowOnError(GetApi().BindInput(p_, name, value));
+template <typename T>
+inline void IoBindingImpl<T>::BindOutput(const char* name, const OrtMemoryInfo* mem_info) {
+ ThrowOnError(GetApi().BindOutputToDevice(this->p_, name, mem_info));
+}
+
+template <typename T>
+inline void IoBindingImpl<T>::ClearBoundInputs() {
+ GetApi().ClearBoundInputs(this->p_);
 }
 
-inline void IoBinding::BindOutput(const char* name, const Value& value) {
- ThrowOnError(GetApi().BindOutput(p_, name, value));
+template <typename T>
+inline void IoBindingImpl<T>::ClearBoundOutputs() {
+ GetApi().ClearBoundOutputs(this->p_);
+}
+
+template <typename T>
+inline void IoBindingImpl<T>::SynchronizeInputs() {
+ ThrowOnError(GetApi().SynchronizeBoundInputs(this->p_));
 }
 
-inline void IoBinding::BindOutput(const char* name, const MemoryInfo& mem_info) {
- ThrowOnError(GetApi().BindOutputToDevice(p_, name, mem_info));
+template <typename T>
+inline void IoBindingImpl<T>::SynchronizeOutputs() {
+ ThrowOnError(GetApi().SynchronizeBoundOutputs(this->p_));
 }
 
-inline std::vector<std::string> IoBinding::GetOutputNamesHelper(OrtAllocator* allocator) const {
+namespace binding_utils {
+inline std::vector<std::string> GetOutputNamesHelper(const OrtIoBinding* binding, OrtAllocator* allocator) {
 std::vector<std::string> result;
 auto free_fn = detail::AllocatedFree(allocator);
 using Ptr = std::unique_ptr<void, decltype(free_fn)>;
@@ -206,7 +305,7 @@
 char* buffer = nullptr;
 size_t* lengths = nullptr;
 size_t count = 0;
- ThrowOnError(GetApi().GetBoundOutputNames(p_, allocator, &buffer, &lengths, &count));
+ ThrowOnError(GetApi().GetBoundOutputNames(binding, allocator, &buffer, &lengths, &count));
 
 if (count == 0) {
 return result;
@@ -225,16 +324,7 @@
 return result;
 }
 
-inline std::vector<std::string> IoBinding::GetOutputNames() const {
- AllocatorWithDefaultOptions allocator;
- return GetOutputNamesHelper(allocator);
-}
-
-inline std::vector<std::string> IoBinding::GetOutputNames(Allocator& allocator) const {
- return GetOutputNamesHelper(allocator);
-}
-
-inline std::vector<Value> Ort::IoBinding::GetOutputValuesHelper(OrtAllocator* allocator) const {
+inline std::vector<Value> GetOutputValuesHelper(const OrtIoBinding* binding, OrtAllocator* allocator) {
 std::vector<Value> result;
 size_t owned = 0;
 size_t output_count = 0;
@@ -252,7 +342,7 @@
 using Ptr = std::unique_ptr<OrtValue*, decltype(free_fn)>;
 
 OrtValue** output_buffer = nullptr;
- ThrowOnError(GetApi().GetBoundOutputValues(p_, allocator, &output_buffer, &output_count));
+ ThrowOnError(GetApi().GetBoundOutputValues(binding, allocator, &output_buffer, &output_count));
 if (output_count == 0) {
 return result;
 }
@@ -267,33 +357,54 @@
 return result;
 }
 
-inline std::vector<Value> Ort::IoBinding::GetOutputValues(Allocator& allocator) const {
- return GetOutputValuesHelper(allocator);
+} // namespace binding_utils
+} // namespace detail
+
+inline IoBinding::IoBinding(Session& session) {
+ ThrowOnError(GetApi().CreateIoBinding(session, &this->p_));
+}
+
+inline ArenaCfg::ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk) {
+ ThrowOnError(GetApi().CreateArenaCfg(max_mem, arena_extend_strategy, initial_chunk_size_bytes, max_dead_bytes_per_chunk, &p_));
+}
+
+inline ThreadingOptions::ThreadingOptions() {
+ ThrowOnError(GetApi().CreateThreadingOptions(&p_));
 }
 
-inline std::vector<Value> Ort::IoBinding::GetOutputValues() const {
- AllocatorWithDefaultOptions allocator;
- return GetOutputValuesHelper(allocator);
+inline ThreadingOptions& ThreadingOptions::SetGlobalIntraOpNumThreads(int intra_op_num_threads) {
+ ThrowOnError(GetApi().SetGlobalIntraOpNumThreads(p_, intra_op_num_threads));
+ return *this;
 }
 
-inline void IoBinding::ClearBoundInputs() {
- GetApi().ClearBoundInputs(p_);
+inline ThreadingOptions& ThreadingOptions::SetGlobalInterOpNumThreads(int inter_op_num_threads) {
+ ThrowOnError(GetApi().SetGlobalInterOpNumThreads(p_, inter_op_num_threads));
+ return *this;
 }
 
-inline void IoBinding::ClearBoundOutputs() {
- GetApi().ClearBoundOutputs(p_);
+inline ThreadingOptions& ThreadingOptions::SetGlobalSpinControl(int allow_spinning) {
+ ThrowOnError(GetApi().SetGlobalSpinControl(p_, allow_spinning));
+ return *this;
 }
 
-inline void IoBinding::SynchronizeInputs() {
- ThrowOnError(GetApi().SynchronizeBoundInputs(p_));
+inline ThreadingOptions& ThreadingOptions::SetGlobalDenormalAsZero() {
+ ThrowOnError(GetApi().SetGlobalDenormalAsZero(p_));
+ return *this;
 }
 
-inline void IoBinding::SynchronizeOutputs() {
- ThrowOnError(GetApi().SynchronizeBoundOutputs(p_));
+inline ThreadingOptions& ThreadingOptions::SetGlobalCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn) {
+ ThrowOnError(GetApi().SetGlobalCustomCreateThreadFn(p_, ort_custom_create_thread_fn));
+ return *this;
 }
 
-inline ArenaCfg::ArenaCfg(size_t max_mem, int arena_extend_strategy, int initial_chunk_size_bytes, int max_dead_bytes_per_chunk) {
- ThrowOnError(GetApi().CreateArenaCfg(max_mem, arena_extend_strategy, initial_chunk_size_bytes, max_dead_bytes_per_chunk, &p_));
+inline ThreadingOptions& ThreadingOptions::SetGlobalCustomThreadCreationOptions(void* ort_custom_thread_creation_options) {
+ ThrowOnError(GetApi().SetGlobalCustomThreadCreationOptions(p_, ort_custom_thread_creation_options));
+ return *this;
+}
+
+inline ThreadingOptions& ThreadingOptions::SetGlobalCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn) {
+ ThrowOnError(GetApi().SetGlobalCustomJoinThreadFn(p_, ort_custom_join_thread_fn));
+ return *this;
 }
 
 inline Env::Env(OrtLoggingLevel logging_level, _In_ const char* logid) {
@@ -343,6 +454,11 @@
 return *this;
 }
 
+inline Env& Env::UpdateEnvWithCustomLogLevel(OrtLoggingLevel log_severity_level) {
+ ThrowOnError(GetApi().UpdateEnvWithCustomLogLevel(p_, log_severity_level));
+ return *this;
+}
+
 inline Env& Env::CreateAndRegisterAllocator(const OrtMemoryInfo* mem_info, const OrtArenaCfg* arena_cfg) {
 ThrowOnError(GetApi().CreateAndRegisterAllocator(p_, mem_info, arena_cfg));
 return *this;
@@ -352,7 +468,7 @@
 ThrowOnError(GetApi().CreateCustomOpDomain(domain, &p_));
 }
 
-inline void CustomOpDomain::Add(OrtCustomOp* op) {
+inline void CustomOpDomain::Add(const OrtCustomOp* op) {
 ThrowOnError(GetApi().CustomOpDomain_Add(p_, op));
 }
 
@@ -408,103 +524,156 @@
 return *this;
 }
 
-inline SessionOptions::SessionOptions() {
- ThrowOnError(GetApi().CreateSessionOptions(&p_));
-}
+namespace detail {
 
-inline SessionOptions SessionOptions::Clone() const {
+template <typename T>
+inline Ort::SessionOptions ConstSessionOptionsImpl<T>::Clone() const {
 OrtSessionOptions* out;
- ThrowOnError(GetApi().CloneSessionOptions(p_, &out));
+ ThrowOnError(GetApi().CloneSessionOptions(this->p_, &out));
 return SessionOptions{out};
 }
 
-inline SessionOptions& SessionOptions::SetIntraOpNumThreads(int intra_op_num_threads) {
- ThrowOnError(GetApi().SetIntraOpNumThreads(p_, intra_op_num_threads));
+template <typename T>
+inline std::string ConstSessionOptionsImpl<T>::GetConfigEntry(const char* config_key) const {
+ size_t size = 0;
+ // Feed nullptr for the data buffer to query the true size of the string value
+ Ort::ThrowOnError(GetApi().GetSessionConfigEntry(this->p_, config_key, nullptr, &size));
+
+ std::string out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().GetSessionConfigEntry(this->p_, config_key, &out0, &size));
+ out.resize(size - 1); // remove the terminating character '\0'
+
+ return out;
+}
+
+template <typename T>
+inline bool ConstSessionOptionsImpl<T>::HasConfigEntry(const char* config_key) const {
+ int out = 0;
+ Ort::ThrowOnError(GetApi().HasSessionConfigEntry(this->p_, config_key, &out));
+ return static_cast<bool>(out);
+}
+
+template <typename T>
+inline std::string ConstSessionOptionsImpl<T>::GetConfigEntryOrDefault(const char* config_key, const std::string& def) {
+ if (!this->HasConfigEntry(config_key)) {
+ return def;
+ }
+
+ return this->GetConfigEntry(config_key);
+}
+
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetIntraOpNumThreads(int intra_op_num_threads) {
+ ThrowOnError(GetApi().SetIntraOpNumThreads(this->p_, intra_op_num_threads));
+ return *this;
+}
+
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetInterOpNumThreads(int inter_op_num_threads) {
+ ThrowOnError(GetApi().SetInterOpNumThreads(this->p_, inter_op_num_threads));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetInterOpNumThreads(int inter_op_num_threads) {
- ThrowOnError(GetApi().SetInterOpNumThreads(p_, inter_op_num_threads));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level) {
+ ThrowOnError(GetApi().SetSessionGraphOptimizationLevel(this->p_, graph_optimization_level));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetGraphOptimizationLevel(GraphOptimizationLevel graph_optimization_level) {
- ThrowOnError(GetApi().SetSessionGraphOptimizationLevel(p_, graph_optimization_level));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_filepath) {
+ ThrowOnError(GetApi().SetOptimizedModelFilePath(this->p_, optimized_model_filepath));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetOptimizedModelFilePath(const ORTCHAR_T* optimized_model_filepath) {
- ThrowOnError(GetApi().SetOptimizedModelFilePath(p_, optimized_model_filepath));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::EnableProfiling(const ORTCHAR_T* profile_file_prefix) {
+ ThrowOnError(GetApi().EnableProfiling(this->p_, profile_file_prefix));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::EnableProfiling(const ORTCHAR_T* profile_file_prefix) {
- ThrowOnError(GetApi().EnableProfiling(p_, profile_file_prefix));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::DisableProfiling() {
+ ThrowOnError(GetApi().DisableProfiling(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::DisableProfiling() {
- ThrowOnError(GetApi().DisableProfiling(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::EnableOrtCustomOps() {
+ ThrowOnError(GetApi().EnableOrtCustomOps(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::EnableOrtCustomOps() {
- ThrowOnError(GetApi().EnableOrtCustomOps(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::EnableMemPattern() {
+ ThrowOnError(GetApi().EnableMemPattern(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::EnableMemPattern() {
- ThrowOnError(GetApi().EnableMemPattern(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::DisableMemPattern() {
+ ThrowOnError(GetApi().DisableMemPattern(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::DisableMemPattern() {
- ThrowOnError(GetApi().DisableMemPattern(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::EnableCpuMemArena() {
+ ThrowOnError(GetApi().EnableCpuMemArena(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::EnableCpuMemArena() {
- ThrowOnError(GetApi().EnableCpuMemArena(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::DisableCpuMemArena() {
+ ThrowOnError(GetApi().DisableCpuMemArena(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::DisableCpuMemArena() {
- ThrowOnError(GetApi().DisableCpuMemArena(p_));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetExecutionMode(ExecutionMode execution_mode) {
+ ThrowOnError(GetApi().SetSessionExecutionMode(this->p_, execution_mode));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetExecutionMode(ExecutionMode execution_mode) {
- ThrowOnError(GetApi().SetSessionExecutionMode(p_, execution_mode));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetLogId(const char* logid) {
+ ThrowOnError(GetApi().SetSessionLogId(this->p_, logid));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetLogId(const char* logid) {
- ThrowOnError(GetApi().SetSessionLogId(p_, logid));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetLogSeverityLevel(int level) {
+ ThrowOnError(GetApi().SetSessionLogSeverityLevel(this->p_, level));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetLogSeverityLevel(int level) {
- ThrowOnError(GetApi().SetSessionLogSeverityLevel(p_, level));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::Add(OrtCustomOpDomain* custom_op_domain) {
+ ThrowOnError(GetApi().AddCustomOpDomain(this->p_, custom_op_domain));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::Add(OrtCustomOpDomain* custom_op_domain) {
- ThrowOnError(GetApi().AddCustomOpDomain(p_, custom_op_domain));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AddConfigEntry(const char* config_key, const char* config_value) {
+ ThrowOnError(GetApi().AddSessionConfigEntry(this->p_, config_key, config_value));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AddConfigEntry(const char* config_key, const char* config_value) {
- ThrowOnError(GetApi().AddSessionConfigEntry(p_, config_key, config_value));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AddInitializer(const char* name, const OrtValue* ort_val) {
+ ThrowOnError(GetApi().AddInitializer(this->p_, name, ort_val));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AddInitializer(const char* name, const OrtValue* ort_val) {
- ThrowOnError(GetApi().AddInitializer(p_, name, ort_val));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::DisablePerSessionThreads() {
+ ThrowOnError(GetApi().DisablePerSessionThreads(this->p_));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AddExternalInitializers(const std::vector<std::string>& names,
- const std::vector<Value>& ort_values) {
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AddExternalInitializers(const std::vector<std::string>& names,
+ const std::vector<Value>& ort_values) {
 const size_t inputs_num = names.size();
 if (inputs_num != ort_values.size()) {
 ORT_CXX_API_THROW("Expecting names and ort_values to have the same length", ORT_INVALID_ARGUMENT);
@@ -517,41 +686,54 @@
 names_ptr.push_back(namesi.c_str());
 ort_values_ptrs.push_back(ort_valuesi);
 }
- ThrowOnError(GetApi().AddExternalInitializers(p_, names_ptr.data(), ort_values_ptrs.data(), inputs_num));
+ ThrowOnError(GetApi().AddExternalInitializers(this->p_, names_ptr.data(), ort_values_ptrs.data(), inputs_num));
+ return *this;
+}
+
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_CUDA(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_CUDA(const OrtCUDAProviderOptions& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_CUDA(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_CUDA_V2(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_CUDA_V2(const OrtCUDAProviderOptionsV2& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_CUDA_V2(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_ROCM(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_ROCM(const OrtROCMProviderOptions& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_ROCM(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_TensorRT(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_TensorRT(const OrtTensorRTProviderOptions& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_TensorRT(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_TensorRT_V2(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_TensorRT_V2(const OrtTensorRTProviderOptionsV2& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_TensorRT_V2(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_MIGraphX(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_MIGraphX(const OrtMIGraphXProviderOptions& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_MIGraphX(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_CANN(const OrtCANNProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_CANN(this->p_, &provider_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider(
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider(
 const std::string& provider_name,
 const std::unordered_map<std::string, std::string>& provider_options) {
 auto num_entries = provider_options.size();
@@ -566,148 +748,209 @@
 }
 }
 
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider(p_, provider_name.c_str(),
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider(this->p_, provider_name.c_str(),
 keys.data(), values.data(), num_entries));
 
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn) {
- ThrowOnError(GetApi().SessionOptionsSetCustomCreateThreadFn(p_, ort_custom_create_thread_fn));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetCustomCreateThreadFn(OrtCustomCreateThreadFn ort_custom_create_thread_fn) {
+ ThrowOnError(GetApi().SessionOptionsSetCustomCreateThreadFn(this->p_, ort_custom_create_thread_fn));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options) {
- ThrowOnError(GetApi().SessionOptionsSetCustomThreadCreationOptions(p_, ort_custom_thread_creation_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetCustomThreadCreationOptions(void* ort_custom_thread_creation_options) {
+ ThrowOnError(GetApi().SessionOptionsSetCustomThreadCreationOptions(this->p_, ort_custom_thread_creation_options));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn) {
- ThrowOnError(GetApi().SessionOptionsSetCustomJoinThreadFn(p_, ort_custom_join_thread_fn));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::SetCustomJoinThreadFn(OrtCustomJoinThreadFn ort_custom_join_thread_fn) {
+ ThrowOnError(GetApi().SessionOptionsSetCustomJoinThreadFn(this->p_, ort_custom_join_thread_fn));
 return *this;
 }
 
-inline SessionOptions& SessionOptions::AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options) {
- ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_OpenVINO(p_, &provider_options));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::AppendExecutionProvider_OpenVINO(const OrtOpenVINOProviderOptions& provider_options) {
+ ThrowOnError(GetApi().SessionOptionsAppendExecutionProvider_OpenVINO(this->p_, &provider_options));
 return *this;
 }
 
-inline Session::Session(Env& env, const ORTCHAR_T* model_path, const SessionOptions& options) {
- ThrowOnError(GetApi().CreateSession(env, model_path, options, &p_));
-}
-
-inline Session::Session(Env& env, const ORTCHAR_T* model_path, const SessionOptions& options,
- OrtPrepackedWeightsContainer* prepacked_weights_container) {
- ThrowOnError(GetApi().CreateSessionWithPrepackedWeightsContainer(env, model_path, options, prepacked_weights_container, &p_));
-}
-
-inline Session::Session(Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options) {
- ThrowOnError(GetApi().CreateSessionFromArray(env, model_data, model_data_length, options, &p_));
-}
-
-inline std::vector<Value> Session::Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
- const char* const* output_names, size_t output_names_count) {
- std::vector<Ort::Value> output_values;
- for (size_t i = 0; i < output_names_count; i++)
- output_values.emplace_back(nullptr);
- Run(run_options, input_names, input_values, input_count, output_names, output_values.data(), output_names_count);
- return output_values;
-}
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::RegisterCustomOpsLibrary(const ORTCHAR_T* library_name,
+ const CustomOpConfigs& custom_op_configs) {
+ // Add custom op config entries before registering the custom op library. Otherwise, the config entries _may_ be ignored by
+ // the custom op library.
+ for (const auto& config_iter : custom_op_configs.GetFlattenedConfigs()) {
+ AddConfigEntry(config_iter.first.c_str(), config_iter.second.c_str());
+ }
 
-inline void Session::Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
- const char* const* output_names, Value* output_values, size_t output_count) {
- static_assert(sizeof(Value) == sizeof(OrtValue*), "Value is really just an array of OrtValue* in memory, so we can reinterpret_cast safely");
- auto ort_input_values = reinterpret_cast<const OrtValue**>(const_cast<Value*>(input_values));
- auto ort_output_values = reinterpret_cast<OrtValue**>(output_values);
- ThrowOnError(GetApi().Run(p_, run_options, input_names, ort_input_values, input_count, output_names, output_count, ort_output_values));
+ ThrowOnError(GetApi().RegisterCustomOpsLibrary_V2(this->p_, library_name));
+ return *this;
 }
 
-inline void Session::Run(const RunOptions& run_options, const IoBinding& io_binding) {
- ThrowOnError(GetApi().RunWithBinding(p_, run_options, io_binding));
+template <typename T>
+inline SessionOptionsImpl<T>& SessionOptionsImpl<T>::RegisterCustomOpsUsingFunction(const char* registration_function_name) {
+ ThrowOnError(GetApi().RegisterCustomOpsUsingFunction(this->p_, registration_function_name));
+ return *this;
 }
 
-inline size_t Session::GetInputCount() const {
+/// Session
+template <typename T>
+inline size_t ConstSessionImpl<T>::GetInputCount() const {
 size_t out;
- ThrowOnError(GetApi().SessionGetInputCount(p_, &out));
+ ThrowOnError(GetApi().SessionGetInputCount(this->p_, &out));
 return out;
 }
 
-inline size_t Session::GetOutputCount() const {
+template <typename T>
+inline size_t ConstSessionImpl<T>::GetOutputCount() const {
 size_t out;
- ThrowOnError(GetApi().SessionGetOutputCount(p_, &out));
+ ThrowOnError(GetApi().SessionGetOutputCount(this->p_, &out));
 return out;
 }
 
-inline size_t Session::GetOverridableInitializerCount() const {
+template <typename T>
+inline size_t ConstSessionImpl<T>::GetOverridableInitializerCount() const {
 size_t out;
- ThrowOnError(GetApi().SessionGetOverridableInitializerCount(p_, &out));
- return out;
-}
-
-inline char* Session::GetInputName(size_t index, OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().SessionGetInputName(p_, index, allocator, &out));
+ ThrowOnError(GetApi().SessionGetOverridableInitializerCount(this->p_, &out));
 return out;
 }
 
-inline char* Session::GetOutputName(size_t index, OrtAllocator* allocator) const {
+template <typename T>
+inline AllocatedStringPtr ConstSessionImpl<T>::GetInputNameAllocated(size_t index, OrtAllocator* allocator) const {
 char* out;
- ThrowOnError(GetApi().SessionGetOutputName(p_, index, allocator, &out));
- return out;
+ ThrowOnError(GetApi().SessionGetInputName(this->p_, index, allocator, &out));
+ return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline AllocatedStringPtr Session::GetInputNameAllocated(size_t index, OrtAllocator* allocator) const {
+template <typename T>
+inline AllocatedStringPtr ConstSessionImpl<T>::GetOutputNameAllocated(size_t index, OrtAllocator* allocator) const {
 char* out;
- ThrowOnError(GetApi().SessionGetInputName(p_, index, allocator, &out));
+ ThrowOnError(GetApi().SessionGetOutputName(this->p_, index, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline AllocatedStringPtr Session::GetOutputNameAllocated(size_t index, OrtAllocator* allocator) const {
+template <typename T>
+inline AllocatedStringPtr ConstSessionImpl<T>::GetOverridableInitializerNameAllocated(size_t index, OrtAllocator* allocator) const {
 char* out;
- ThrowOnError(GetApi().SessionGetOutputName(p_, index, allocator, &out));
+ ThrowOnError(GetApi().SessionGetOverridableInitializerName(this->p_, index, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* Session::GetOverridableInitializerName(size_t index, OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().SessionGetOverridableInitializerName(p_, index, allocator, &out));
+template <typename T>
+inline uint64_t ConstSessionImpl<T>::GetProfilingStartTimeNs() const {
+ uint64_t out;
+ ThrowOnError(GetApi().SessionGetProfilingStartTimeNs(this->p_, &out));
 return out;
 }
 
-inline AllocatedStringPtr Session::GetOverridableInitializerNameAllocated(size_t index, OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().SessionGetOverridableInitializerName(p_, index, allocator, &out));
- return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
+template <typename T>
+inline ModelMetadata ConstSessionImpl<T>::GetModelMetadata() const {
+ OrtModelMetadata* out;
+ ThrowOnError(GetApi().SessionGetModelMetadata(this->p_, &out));
+ return ModelMetadata{out};
 }
 
-inline char* Session::EndProfiling(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().SessionEndProfiling(p_, allocator, &out));
- return out;
+template <typename T>
+inline TypeInfo ConstSessionImpl<T>::GetInputTypeInfo(size_t index) const {
+ OrtTypeInfo* out;
+ ThrowOnError(GetApi().SessionGetInputTypeInfo(this->p_, index, &out));
+ return TypeInfo{out};
 }
 
-inline AllocatedStringPtr Session::EndProfilingAllocated(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().SessionEndProfiling(p_, allocator, &out));
+template <typename T>
+inline TypeInfo ConstSessionImpl<T>::GetOutputTypeInfo(size_t index) const {
+ OrtTypeInfo* out;
+ ThrowOnError(GetApi().SessionGetOutputTypeInfo(this->p_, index, &out));
+ return TypeInfo{out};
+}
+
+template <typename T>
+inline TypeInfo ConstSessionImpl<T>::GetOverridableInitializerTypeInfo(size_t index) const {
+ OrtTypeInfo* out;
+ ThrowOnError(GetApi().SessionGetOverridableInitializerTypeInfo(this->p_, index, &out));
+ return TypeInfo{out};
+}
+
+template <typename T>
+inline std::vector<Value> SessionImpl<T>::Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
+ const char* const* output_names, size_t output_count) {
+ std::vector<Value> output_values;
+ output_values.reserve(output_count);
+ for (size_t i = 0; i < output_count; i++)
+ output_values.emplace_back(nullptr);
+ Run(run_options, input_names, input_values, input_count, output_names, output_values.data(), output_count);
+ return output_values;
+}
+
+template <typename T>
+inline void SessionImpl<T>::Run(const RunOptions& run_options, const char* const* input_names, const Value* input_values, size_t input_count,
+ const char* const* output_names, Value* output_values, size_t output_count) {
+ static_assert(sizeof(Value) == sizeof(OrtValue*), "Value is really just an array of OrtValue* in memory, so we can reinterpret_cast safely");
+ auto ort_input_values = reinterpret_cast<const OrtValue* const*>(input_values);
+ auto ort_output_values = reinterpret_cast<OrtValue**>(output_values);
+ ThrowOnError(GetApi().Run(this->p_, run_options, input_names, ort_input_values, input_count, output_names, output_count, ort_output_values));
+}
+
+template <typename T>
+inline void SessionImpl<T>::Run(const RunOptions& run_options, const IoBinding& io_binding) {
+ ThrowOnError(GetApi().RunWithBinding(this->p_, run_options, io_binding));
+}
+
+template <typename T>
+inline AllocatedStringPtr SessionImpl<T>::EndProfilingAllocated(OrtAllocator* allocator) {
+ char* out = nullptr;
+ ThrowOnError(GetApi().SessionEndProfiling(this->p_, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline uint64_t Session::GetProfilingStartTimeNs() const {
- uint64_t out;
- ThrowOnError(GetApi().SessionGetProfilingStartTimeNs(p_, &out));
- return out;
+} // namespace detail
+
+inline SessionOptions::SessionOptions() {
+ ThrowOnError(GetApi().CreateSessionOptions(&this->p_));
 }
 
-inline ModelMetadata Session::GetModelMetadata() const {
- OrtModelMetadata* out;
- ThrowOnError(GetApi().SessionGetModelMetadata(p_, &out));
- return ModelMetadata{out};
+/// CustomOpConfigs
+inline std::string detail::MakeCustomOpConfigEntryKey(const char* custom_op_name, const char* config) {
+ std::string config_key = "custom_op.";
+
+ config_key += custom_op_name;
+ config_key += ".";
+ config_key += config;
+
+ return config_key;
 }
 
-inline char* ModelMetadata::GetProducerName(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataGetProducerName(p_, allocator, &out));
- return out;
+inline CustomOpConfigs& CustomOpConfigs::AddConfig(const char* custom_op_name, const char* config_key, const char* config_value) {
+ const std::string full_flat_key = detail::MakeCustomOpConfigEntryKey(custom_op_name, config_key);
+ flat_configs_full_flat_key = config_value;
+ return *this;
+}
+
+inline const std::unordered_map<std::string, std::string>& CustomOpConfigs::GetFlattenedConfigs() const {
+ return flat_configs_;
+}
+
+inline Session::Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options) {
+ ThrowOnError(GetApi().CreateSession(env, model_path, options, &this->p_));
+}
+
+inline Session::Session(const Env& env, const ORTCHAR_T* model_path, const SessionOptions& options,
+ OrtPrepackedWeightsContainer* prepacked_weights_container) {
+ ThrowOnError(GetApi().CreateSessionWithPrepackedWeightsContainer(env, model_path, options, prepacked_weights_container, &this->p_));
+}
+
+inline Session::Session(const Env& env, const void* model_data, size_t model_data_length, const SessionOptions& options) {
+ ThrowOnError(GetApi().CreateSessionFromArray(env, model_data, model_data_length, options, &this->p_));
+}
+
+inline Session::Session(const Env& env, const void* model_data, size_t model_data_length,
+ const SessionOptions& options, OrtPrepackedWeightsContainer* prepacked_weights_container) {
+ ThrowOnError(GetApi().CreateSessionFromArrayWithPrepackedWeightsContainer(env, model_data, model_data_length, options,
+ prepacked_weights_container, &this->p_));
 }
 
 inline AllocatedStringPtr ModelMetadata::GetProducerNameAllocated(OrtAllocator* allocator) const {
@@ -716,72 +959,36 @@
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* ModelMetadata::GetGraphName(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataGetGraphName(p_, allocator, &out));
- return out;
-}
-
 inline AllocatedStringPtr ModelMetadata::GetGraphNameAllocated(OrtAllocator* allocator) const {
 char* out;
 ThrowOnError(GetApi().ModelMetadataGetGraphName(p_, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* ModelMetadata::GetDomain(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataGetDomain(p_, allocator, &out));
- return out;
-}
-
 inline AllocatedStringPtr ModelMetadata::GetDomainAllocated(OrtAllocator* allocator) const {
 char* out;
 ThrowOnError(GetApi().ModelMetadataGetDomain(p_, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* ModelMetadata::GetDescription(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataGetDescription(p_, allocator, &out));
- return out;
-}
-
 inline AllocatedStringPtr Ort::ModelMetadata::GetDescriptionAllocated(OrtAllocator* allocator) const {
 char* out;
 ThrowOnError(GetApi().ModelMetadataGetDescription(p_, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* ModelMetadata::GetGraphDescription(OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataGetGraphDescription(p_, allocator, &out));
- return out;
-}
-
 inline AllocatedStringPtr ModelMetadata::GetGraphDescriptionAllocated(OrtAllocator* allocator) const {
 char* out;
 ThrowOnError(GetApi().ModelMetadataGetGraphDescription(p_, allocator, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char* ModelMetadata::LookupCustomMetadataMap(const char* key, OrtAllocator* allocator) const {
- char* out;
- ThrowOnError(GetApi().ModelMetadataLookupCustomMetadataMap(p_, allocator, key, &out));
- return out;
-}
-
 inline AllocatedStringPtr ModelMetadata::LookupCustomMetadataMapAllocated(const char* key, OrtAllocator* allocator) const {
 char* out;
 ThrowOnError(GetApi().ModelMetadataLookupCustomMetadataMap(p_, allocator, key, &out));
 return AllocatedStringPtr(out, detail::AllocatedFree(allocator));
 }
 
-inline char** ModelMetadata::GetCustomMetadataMapKeys(OrtAllocator* allocator, _Out_ int64_t& num_keys) const {
- char** out;
- ThrowOnError(GetApi().ModelMetadataGetCustomMetadataMapKeys(p_, allocator, &out, &num_keys));
- return out;
-}
-
 inline std::vector<AllocatedStringPtr> ModelMetadata::GetCustomMetadataMapKeysAllocated(OrtAllocator* allocator) const {
 auto deletor = detail::AllocatedFree(allocator);
 std::vector<AllocatedStringPtr> result;
@@ -813,188 +1020,342 @@
 return out;
 }
 
-inline TypeInfo Session::GetInputTypeInfo(size_t index) const {
- OrtTypeInfo* out;
- ThrowOnError(GetApi().SessionGetInputTypeInfo(p_, index, &out));
- return TypeInfo{out};
-}
-
-inline TypeInfo Session::GetOutputTypeInfo(size_t index) const {
- OrtTypeInfo* out;
- ThrowOnError(GetApi().SessionGetOutputTypeInfo(p_, index, &out));
- return TypeInfo{out};
-}
-
-inline TypeInfo Session::GetOverridableInitializerTypeInfo(size_t index) const {
- OrtTypeInfo* out;
- ThrowOnError(GetApi().SessionGetOverridableInitializerTypeInfo(p_, index, &out));
- return TypeInfo{out};
-}
+namespace detail {
 
-inline ONNXTensorElementDataType TensorTypeAndShapeInfo::GetElementType() const {
+template <typename T>
+inline ONNXTensorElementDataType TensorTypeAndShapeInfoImpl<T>::GetElementType() const {
 ONNXTensorElementDataType out;
- ThrowOnError(GetApi().GetTensorElementType(p_, &out));
+ ThrowOnError(GetApi().GetTensorElementType(this->p_, &out));
 return out;
 }
 
-inline size_t TensorTypeAndShapeInfo::GetElementCount() const {
+template <typename T>
+inline size_t TensorTypeAndShapeInfoImpl<T>::GetElementCount() const {
 size_t out;
- ThrowOnError(GetApi().GetTensorShapeElementCount(p_, &out));
+ ThrowOnError(GetApi().GetTensorShapeElementCount(this->p_, &out));
 return static_cast<size_t>(out);
 }
 
-inline size_t TensorTypeAndShapeInfo::GetDimensionsCount() const {
+template <typename T>
+inline size_t TensorTypeAndShapeInfoImpl<T>::GetDimensionsCount() const {
 size_t out;
- ThrowOnError(GetApi().GetDimensionsCount(p_, &out));
+ ThrowOnError(GetApi().GetDimensionsCount(this->p_, &out));
 return out;
 }
 
-inline void TensorTypeAndShapeInfo::GetDimensions(int64_t* values, size_t values_count) const {
- ThrowOnError(GetApi().GetDimensions(p_, values, values_count));
+template <typename T>
+inline void TensorTypeAndShapeInfoImpl<T>::GetDimensions(int64_t* values, size_t values_count) const {
+ ThrowOnError(GetApi().GetDimensions(this->p_, values, values_count));
 }
 
-inline void TensorTypeAndShapeInfo::GetSymbolicDimensions(const char** values, size_t values_count) const {
- ThrowOnError(GetApi().GetSymbolicDimensions(p_, values, values_count));
+template <typename T>
+inline void TensorTypeAndShapeInfoImpl<T>::GetSymbolicDimensions(const char** values, size_t values_count) const {
+ ThrowOnError(GetApi().GetSymbolicDimensions(this->p_, values, values_count));
 }
 
-inline std::vector<int64_t> TensorTypeAndShapeInfo::GetShape() const {
+template <typename T>
+inline std::vector<int64_t> TensorTypeAndShapeInfoImpl<T>::GetShape() const {
 std::vector<int64_t> out(GetDimensionsCount(), 0);
- GetDimensions(out.data(), out.size());
+ ThrowOnError(GetApi().GetDimensions(this->p_, out.data(), out.size()));
 return out;
 }
 
-inline Unowned<TensorTypeAndShapeInfo> TypeInfo::GetTensorTypeAndShapeInfo() const {
+} // namespace detail
+
+namespace detail {
+template <typename T>
+inline ConstTensorTypeAndShapeInfo TypeInfoImpl<T>::GetTensorTypeAndShapeInfo() const {
 const OrtTensorTypeAndShapeInfo* out;
- ThrowOnError(GetApi().CastTypeInfoToTensorInfo(p_, &out));
- return Unowned<TensorTypeAndShapeInfo>(const_cast<OrtTensorTypeAndShapeInfo*>(out));
+ ThrowOnError(GetApi().CastTypeInfoToTensorInfo(this->p_, &out));
+ return ConstTensorTypeAndShapeInfo{out};
 }
 
-inline Unowned<SequenceTypeInfo> TypeInfo::GetSequenceTypeInfo() const {
+template <typename T>
+inline ConstSequenceTypeInfo TypeInfoImpl<T>::GetSequenceTypeInfo() const {
 const OrtSequenceTypeInfo* out;
- ThrowOnError(GetApi().CastTypeInfoToSequenceTypeInfo(p_, &out));
- return Unowned<SequenceTypeInfo>{const_cast<OrtSequenceTypeInfo*>(out)};
+ ThrowOnError(GetApi().CastTypeInfoToSequenceTypeInfo(this->p_, &out));
+ return ConstSequenceTypeInfo{out};
+}
+
+template <typename T>
+inline ConstMapTypeInfo TypeInfoImpl<T>::GetMapTypeInfo() const {
+ const OrtMapTypeInfo* out;
+ ThrowOnError(GetApi().CastTypeInfoToMapTypeInfo(this->p_, &out));
+ return ConstMapTypeInfo{out};
 }
 
-inline TypeInfo SequenceTypeInfo::GetSequenceElementType() const {
+template <typename T>
+inline ONNXType TypeInfoImpl<T>::GetONNXType() const {
+ ONNXType out;
+ ThrowOnError(GetApi().GetOnnxTypeFromTypeInfo(this->p_, &out));
+ return out;
+}
+
+} // namespace detail
+
+namespace detail {
+template <typename T>
+inline TypeInfo SequenceTypeInfoImpl<T>::GetSequenceElementType() const {
 OrtTypeInfo* output;
- ThrowOnError(GetApi().GetSequenceElementType(p_, &output));
+ ThrowOnError(GetApi().GetSequenceElementType(this->p_, &output));
 return TypeInfo{output};
 }
 
-inline Unowned<MapTypeInfo> TypeInfo::GetMapTypeInfo() const {
- const OrtMapTypeInfo* out;
- ThrowOnError(GetApi().CastTypeInfoToMapTypeInfo(p_, &out));
- return Unowned<MapTypeInfo>{const_cast<OrtMapTypeInfo*>(out)};
-}
+} // namespace detail
 
-inline ONNXTensorElementDataType MapTypeInfo::GetMapKeyType() const {
+namespace detail {
+template <typename T>
+inline ONNXTensorElementDataType MapTypeInfoImpl<T>::GetMapKeyType() const {
 ONNXTensorElementDataType out;
- ThrowOnError(GetApi().GetMapKeyType(p_, &out));
+ ThrowOnError(GetApi().GetMapKeyType(this->p_, &out));
 return out;
 }
 
-inline TypeInfo MapTypeInfo::GetMapValueType() const {
+template <typename T>
+inline TypeInfo MapTypeInfoImpl<T>::GetMapValueType() const {
 OrtTypeInfo* output;
- ThrowOnError(GetApi().GetMapValueType(p_, &output));
+ ThrowOnError(GetApi().GetMapValueType(this->p_, &output));
 return TypeInfo{output};
 }
+} // namespace detail
 
-inline ONNXType TypeInfo::GetONNXType() const {
- ONNXType out;
- ThrowOnError(GetApi().GetOnnxTypeFromTypeInfo(p_, &out));
- return out;
+namespace detail {
+
+template <typename T>
+template <typename R>
+inline void ConstValueImpl<T>::GetOpaqueData(const char* domain, const char* type_name, R& out) const {
+ ThrowOnError(GetApi().GetOpaqueValue(domain, type_name, this->p_, &out, sizeof(R)));
 }
 
 template <typename T>
-inline Value Value::CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count, const int64_t* shape, size_t shape_len) {
- return CreateTensor(info, p_data, p_data_element_count * sizeof(T), shape, shape_len, TypeToTensorType<T>::type);
+inline bool ConstValueImpl<T>::IsTensor() const {
+ int out;
+ ThrowOnError(GetApi().IsTensor(this->p_, &out));
+ return out != 0;
 }
 
-inline Value Value::CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count, const int64_t* shape, size_t shape_len,
- ONNXTensorElementDataType type) {
- OrtValue* out;
- ThrowOnError(GetApi().CreateTensorWithDataAsOrtValue(info, p_data, p_data_byte_count, shape, shape_len, type, &out));
- return Value{out};
+template <typename T>
+inline bool ConstValueImpl<T>::HasValue() const {
+ int out;
+ ThrowOnError(GetApi().HasValue(this->p_, &out));
+ return out != 0;
 }
 
-#if !defined(DISABLE_SPARSE_TENSORS)
 template <typename T>
-inline Value Value::CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
- const Shape& values_shape) {
- return CreateSparseTensor(info, p_data, dense_shape, values_shape, TypeToTensorType<T>::type);
+inline size_t ConstValueImpl<T>::GetCount() const {
+ size_t out;
+ ThrowOnError(GetApi().GetValueCount(this->p_, &out));
+ return out;
 }
 
-inline Value Value::CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
- const Shape& values_shape, ONNXTensorElementDataType type) {
+template <typename T>
+inline Value ConstValueImpl<T>::GetValue(int index, OrtAllocator* allocator) const {
 OrtValue* out;
- ThrowOnError(GetApi().CreateSparseTensorWithValuesAsOrtValue(info, p_data, dense_shape.shape, dense_shape.shape_len,
- values_shape.shape, values_shape.shape_len, type, &out));
+ ThrowOnError(GetApi().GetValue(this->p_, index, allocator, &out));
 return Value{out};
 }
 
-inline void Value::FillSparseTensorCoo(const OrtMemoryInfo* mem_info, const OrtSparseValuesParam& values_param,
- const int64_t* indices_data, size_t indices_num) {
- ThrowOnError(GetApi().FillSparseTensorCoo(p_, mem_info, values_param.values_shape,
- values_param.values_shape_len, values_param.data.p_data,
- indices_data, indices_num));
+template <typename T>
+inline size_t ConstValueImpl<T>::GetStringTensorDataLength() const {
+ size_t out;
+ ThrowOnError(GetApi().GetStringTensorDataLength(this->p_, &out));
+ return out;
 }
 
-inline void Value::FillSparseTensorCsr(const OrtMemoryInfo* data_mem_info,
- const OrtSparseValuesParam& values,
- const int64_t* inner_indices_data, size_t inner_indices_num,
- const int64_t* outer_indices_data, size_t outer_indices_num) {
- ThrowOnError(GetApi().FillSparseTensorCsr(p_, data_mem_info, values.values_shape, values.values_shape_len, values.data.p_data,
- inner_indices_data, inner_indices_num,
- outer_indices_data, outer_indices_num));
+template <typename T>
+inline size_t ConstValueImpl<T>::GetStringTensorElementLength(size_t element_index) const {
+ size_t out;
+ ThrowOnError(GetApi().GetStringTensorElementLength(this->p_, element_index, &out));
+ return out;
 }
 
-inline void Value::FillSparseTensorBlockSparse(const OrtMemoryInfo* data_mem_info,
- const OrtSparseValuesParam& values,
- const Shape& indices_shape,
- const int32_t* indices_data) {
- ThrowOnError(GetApi().FillSparseTensorBlockSparse(p_, data_mem_info, values.values_shape, values.values_shape_len, values.data.p_data,
- indices_shape.shape, indices_shape.shape_len,
- indices_data));
+template <typename T>
+template <typename R>
+inline const R* ConstValueImpl<T>::GetTensorData() const {
+ R* out;
+ ThrowOnError(GetApi().GetTensorMutableData(const_cast<OrtValue*>(this->p_), (void**)&out));
+ return out;
+}
+
+template <typename T>
+inline const void* ConstValueImpl<T>::GetTensorRawData() const {
+ void* out;
+ ThrowOnError(GetApi().GetTensorMutableData(const_cast<OrtValue*>(this->p_), &out));
+ return out;
+}
+
+template <typename T>
+inline TypeInfo ConstValueImpl<T>::GetTypeInfo() const {
+ OrtTypeInfo* output;
+ ThrowOnError(GetApi().GetTypeInfo(this->p_, &output));
+ return TypeInfo{output};
+}
+
+template <typename T>
+inline TensorTypeAndShapeInfo ConstValueImpl<T>::GetTensorTypeAndShapeInfo() const {
+ OrtTensorTypeAndShapeInfo* output;
+ ThrowOnError(GetApi().GetTensorTypeAndShape(this->p_, &output));
+ return TensorTypeAndShapeInfo{output};
 }
 
-inline void Value::UseCooIndices(int64_t* indices_data, size_t indices_num) {
- ThrowOnError(GetApi().UseCooIndices(p_, indices_data, indices_num));
+template <typename T>
+inline ConstMemoryInfo ConstValueImpl<T>::GetTensorMemoryInfo() const {
+ const OrtMemoryInfo* mem_info;
+ ThrowOnError(GetApi().GetTensorMemoryInfo(this->p_, &mem_info));
+ return ConstMemoryInfo(mem_info);
 }
 
-inline void Value::UseCsrIndices(int64_t* inner_data, size_t inner_num, int64_t* outer_data, size_t outer_num) {
- ThrowOnError(GetApi().UseCsrIndices(p_, inner_data, inner_num, outer_data, outer_num));
+template <typename T>
+inline void ConstValueImpl<T>::GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const {
+ ThrowOnError(GetApi().GetStringTensorElement(this->p_, buffer_length, element_index, buffer));
 }
 
-inline void Value::UseBlockSparseIndices(const Shape& indices_shape, int32_t* indices_data) {
- ThrowOnError(GetApi().UseBlockSparseIndices(p_, indices_shape.shape, indices_shape.shape_len, indices_data));
+template <typename T>
+inline void ConstValueImpl<T>::GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const {
+ ThrowOnError(GetApi().GetStringTensorContent(this->p_, buffer, buffer_length, offsets, offsets_count));
 }
 
-inline OrtSparseFormat Value::GetSparseFormat() const {
+#if !defined(DISABLE_SPARSE_TENSORS)
+template <typename T>
+inline OrtSparseFormat ConstValueImpl<T>::GetSparseFormat() const {
 OrtSparseFormat format;
- ThrowOnError(GetApi().GetSparseTensorFormat(p_, &format));
+ ThrowOnError(GetApi().GetSparseTensorFormat(this->p_, &format));
 return format;
 }
 
-inline TensorTypeAndShapeInfo Value::GetSparseTensorValuesTypeAndShapeInfo() const {
+template <typename T>
+inline TensorTypeAndShapeInfo ConstValueImpl<T>::GetSparseTensorValuesTypeAndShapeInfo() const {
 OrtTensorTypeAndShapeInfo* output;
- ThrowOnError(GetApi().GetSparseTensorValuesTypeAndShape(p_, &output));
+ ThrowOnError(GetApi().GetSparseTensorValuesTypeAndShape(this->p_, &output));
 return TensorTypeAndShapeInfo{output};
 }
 
-inline TensorTypeAndShapeInfo Value::GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat indices_format) const {
+template <typename T>
+inline TensorTypeAndShapeInfo ConstValueImpl<T>::GetSparseTensorIndicesTypeShapeInfo(OrtSparseIndicesFormat indices_format) const {
 OrtTensorTypeAndShapeInfo* output;
- ThrowOnError(GetApi().GetSparseTensorIndicesTypeShape(p_, indices_format, &output));
+ ThrowOnError(GetApi().GetSparseTensorIndicesTypeShape(this->p_, indices_format, &output));
 return TensorTypeAndShapeInfo{output};
 }
 
 template <typename T>
-inline const T* Value::GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const {
+template <typename R>
+inline const R* ConstValueImpl<T>::GetSparseTensorIndicesData(OrtSparseIndicesFormat indices_format, size_t& num_indices) const {
+ const void* out;
+ ThrowOnError(GetApi().GetSparseTensorIndices(this->p_, indices_format, &num_indices, &out));
+ return reinterpret_cast<const R*>(out);
+}
+
+template <typename T>
+inline bool ConstValueImpl<T>::IsSparseTensor() const {
+ int out;
+ ThrowOnError(GetApi().IsSparseTensor(this->p_, &out));
+ return out != 0;
+}
+
+template <typename T>
+template <typename R>
+inline const R* ConstValueImpl<T>::GetSparseTensorValues() const {
 const void* out;
- ThrowOnError(GetApi().GetSparseTensorIndices(p_, indices_format, &num_indices, &out));
- return reinterpret_cast<const T*>(out);
+ ThrowOnError(GetApi().GetSparseTensorValues(this->p_, &out));
+ return reinterpret_cast<const R*>(out);
+}
+
+#endif
+
+template <typename T>
+void ValueImpl<T>::FillStringTensor(const char* const* s, size_t s_len) {
+ ThrowOnError(GetApi().FillStringTensor(this->p_, s, s_len));
+}
+
+template <typename T>
+void ValueImpl<T>::FillStringTensorElement(const char* s, size_t index) {
+ ThrowOnError(GetApi().FillStringTensorElement(this->p_, s, index));
+}
+
+template <typename T>
+void* ValueImpl<T>::GetTensorMutableRawData() {
+ void* out;
+ ThrowOnError(GetApi().GetTensorMutableData(this->p_, &out));
+ return out;
+}
+
+template <typename T>
+template <typename R>
+R* ValueImpl<T>::GetTensorMutableData() {
+ R* out;
+ ThrowOnError(GetApi().GetTensorMutableData(this->p_, (void**)&out));
+ return out;
 }
+
+template <typename T>
+template <typename R>
+R& ValueImpl<T>::At(const std::vector<int64_t>& location) {
+ static_assert(!std::is_same<T, std::string>::value, "this api does not support std::string");
+ R* out;
+ ThrowOnError(GetApi().TensorAt(this->p_, location.data(), location.size(), (void**)&out));
+ return *out;
+}
+
+#if !defined(DISABLE_SPARSE_TENSORS)
+template <typename T>
+void ValueImpl<T>::UseCooIndices(int64_t* indices_data, size_t indices_num) {
+ ThrowOnError(GetApi().UseCooIndices(this->p_, indices_data, indices_num));
+}
+
+template <typename T>
+void ValueImpl<T>::UseCsrIndices(int64_t* inner_data, size_t inner_num, int64_t* outer_data, size_t outer_num) {
+ ThrowOnError(GetApi().UseCsrIndices(this->p_, inner_data, inner_num, outer_data, outer_num));
+}
+
+template <typename T>
+void ValueImpl<T>::UseBlockSparseIndices(const Shape& indices_shape, int32_t* indices_data) {
+ ThrowOnError(GetApi().UseBlockSparseIndices(this->p_, indices_shape.shape, indices_shape.shape_len, indices_data));
+}
+
+template <typename T>
+void ValueImpl<T>::FillSparseTensorCoo(const OrtMemoryInfo* mem_info, const OrtSparseValuesParam& values_param,
+ const int64_t* indices_data, size_t indices_num) {
+ ThrowOnError(GetApi().FillSparseTensorCoo(this->p_, mem_info, values_param.values_shape,
+ values_param.values_shape_len, values_param.data.p_data,
+ indices_data, indices_num));
+}
+
+template <typename T>
+void ValueImpl<T>::FillSparseTensorCsr(const OrtMemoryInfo* data_mem_info,
+ const OrtSparseValuesParam& values,
+ const int64_t* inner_indices_data, size_t inner_indices_num,
+ const int64_t* outer_indices_data, size_t outer_indices_num) {
+ ThrowOnError(GetApi().FillSparseTensorCsr(this->p_, data_mem_info, values.values_shape, values.values_shape_len, values.data.p_data,
+ inner_indices_data, inner_indices_num,
+ outer_indices_data, outer_indices_num));
+}
+
+template <typename T>
+void ValueImpl<T>::FillSparseTensorBlockSparse(const OrtMemoryInfo* data_mem_info,
+ const OrtSparseValuesParam& values,
+ const Shape& indices_shape,
+ const int32_t* indices_data) {
+ ThrowOnError(GetApi().FillSparseTensorBlockSparse(this->p_, data_mem_info, values.values_shape, values.values_shape_len, values.data.p_data,
+ indices_shape.shape, indices_shape.shape_len,
+ indices_data));
+}
+
 #endif // !defined(DISABLE_SPARSE_TENSORS)
 
+} // namespace detail
+
+template <typename T>
+inline Value Value::CreateTensor(const OrtMemoryInfo* info, T* p_data, size_t p_data_element_count, const int64_t* shape, size_t shape_len) {
+ return CreateTensor(info, p_data, p_data_element_count * sizeof(T), shape, shape_len, TypeToTensorType<T>::type);
+}
+
+inline Value Value::CreateTensor(const OrtMemoryInfo* info, void* p_data, size_t p_data_byte_count, const int64_t* shape, size_t shape_len,
+ ONNXTensorElementDataType type) {
+ OrtValue* out;
+ ThrowOnError(GetApi().CreateTensorWithDataAsOrtValue(info, p_data, p_data_byte_count, shape, shape_len, type, &out));
+ return Value{out};
+}
+
 template <typename T>
 inline Value Value::CreateTensor(OrtAllocator* allocator, const int64_t* shape, size_t shape_len) {
 return CreateTensor(allocator, shape, shape_len, TypeToTensorType<T>::type);
@@ -1007,6 +1368,21 @@
 }
 
 #if !defined(DISABLE_SPARSE_TENSORS)
+
+template <typename T>
+inline Value Value::CreateSparseTensor(const OrtMemoryInfo* info, T* p_data, const Shape& dense_shape,
+ const Shape& values_shape) {
+ return CreateSparseTensor(info, p_data, dense_shape, values_shape, TypeToTensorType<T>::type);
+}
+
+inline Value Value::CreateSparseTensor(const OrtMemoryInfo* info, void* p_data, const Shape& dense_shape,
+ const Shape& values_shape, ONNXTensorElementDataType type) {
+ OrtValue* out;
+ ThrowOnError(GetApi().CreateSparseTensorWithValuesAsOrtValue(info, p_data, dense_shape.shape, dense_shape.shape_len,
+ values_shape.shape, values_shape.shape_len, type, &out));
+ return Value{out};
+}
+
 template <typename T>
 inline Value Value::CreateSparseTensor(OrtAllocator* allocator, const Shape& dense_shape) {
 return CreateSparseTensor(allocator, dense_shape, TypeToTensorType<T>::type);
@@ -1041,132 +1417,229 @@
 return Value{out};
 }
 
-template <typename T>
-inline void Value::GetOpaqueData(const char* domain, const char* type_name, T& out) const {
- ThrowOnError(GetApi().GetOpaqueValue(domain, type_name, p_, &out, sizeof(T)));
+//
+// Custom OP Inlines
+//
+inline KernelContext::KernelContext(OrtKernelContext* context) : ctx_(context) {
 }
 
-inline bool Value::IsTensor() const {
- int out;
- ThrowOnError(GetApi().IsTensor(p_, &out));
- return out != 0;
+inline size_t KernelContext::GetInputCount() const {
+ size_t out = 0;
+ Ort::ThrowOnError(GetApi().KernelContext_GetInputCount(ctx_, &out));
+ return out;
 }
 
-inline bool Value::HasValue() const {
- int out;
- ThrowOnError(GetApi().HasValue(p_, &out));
- return out != 0;
+inline size_t KernelContext::GetOutputCount() const {
+ size_t out = 0;
+ Ort::ThrowOnError(GetApi().KernelContext_GetOutputCount(ctx_, &out));
+ return out;
 }
 
-#if !defined(DISABLE_SPARSE_TENSORS)
-inline bool Value::IsSparseTensor() const {
- int out;
- ThrowOnError(GetApi().IsSparseTensor(p_, &out));
- return out != 0;
+inline ConstValue KernelContext::GetInput(size_t index) const {
+ const OrtValue* out = nullptr;
+ Ort::ThrowOnError(GetApi().KernelContext_GetInput(ctx_, index, &out));
+ return ConstValue{out};
 }
-#endif
 
-inline size_t Value::GetCount() const {
- size_t out;
- ThrowOnError(GetApi().GetValueCount(p_, &out));
- return out;
+inline UnownedValue KernelContext::GetOutput(size_t index, const int64_t* dim_values, size_t dim_count) const {
+ OrtValue* out = nullptr;
+ Ort::ThrowOnError(GetApi().KernelContext_GetOutput(ctx_, index, dim_values, dim_count, &out));
+ return UnownedValue(out);
 }
 
-inline Value Value::GetValue(int index, OrtAllocator* allocator) const {
- OrtValue* out;
- ThrowOnError(GetApi().GetValue(p_, index, allocator, &out));
- return Value{out};
+inline UnownedValue KernelContext::GetOutput(size_t index, const std::vector<int64_t>& dims) const {
+ OrtValue* out = nullptr;
+ Ort::ThrowOnError(GetApi().KernelContext_GetOutput(ctx_, index, dims.data(), dims.size(), &out));
+ return UnownedValue(out);
 }
 
-inline size_t Value::GetStringTensorDataLength() const {
- size_t out;
- ThrowOnError(GetApi().GetStringTensorDataLength(p_, &out));
+inline void* KernelContext::GetGPUComputeStream() const {
+ void* out = nullptr;
+ Ort::ThrowOnError(GetApi().KernelContext_GetGPUComputeStream(ctx_, &out));
 return out;
 }
 
-inline size_t Value::GetStringTensorElementLength(size_t element_index) const {
- size_t out;
- ThrowOnError(GetApi().GetStringTensorElementLength(p_, element_index, &out));
- return out;
+inline OpAttr::OpAttr(const char* name, const void* data, int len, OrtOpAttrType type) {
+ Ort::ThrowOnError(GetApi().CreateOpAttr(name, data, len, type, &p_));
 }
 
-inline void Value::GetStringTensorContent(void* buffer, size_t buffer_length, size_t* offsets, size_t offsets_count) const {
- ThrowOnError(GetApi().GetStringTensorContent(p_, buffer, buffer_length, offsets, offsets_count));
+namespace detail {
+template <typename T>
+inline KernelInfo KernelInfoImpl<T>::Copy() const {
+ OrtKernelInfo* info_copy = nullptr;
+ Ort::ThrowOnError(GetApi().CopyKernelInfo(this->p_, &info_copy));
+ return KernelInfo{info_copy};
 }
 
-inline void Value::GetStringTensorElement(size_t buffer_length, size_t element_index, void* buffer) const {
- ThrowOnError(GetApi().GetStringTensorElement(p_, buffer_length, element_index, buffer));
+template <typename T>
+inline size_t KernelInfoImpl<T>::GetInputCount() const {
+ size_t out = 0;
+ ThrowOnError(GetApi().KernelInfo_GetInputCount(this->p_, &out));
+ return out;
 }
 
-inline void Value::FillStringTensor(const char* const* s, size_t s_len) {
- ThrowOnError(GetApi().FillStringTensor(p_, s, s_len));
+template <typename T>
+inline size_t KernelInfoImpl<T>::GetOutputCount() const {
+ size_t out = 0;
+ ThrowOnError(GetApi().KernelInfo_GetOutputCount(this->p_, &out));
+ return out;
 }
 
-inline void Value::FillStringTensorElement(const char* s, size_t index) {
- ThrowOnError(GetApi().FillStringTensorElement(p_, s, index));
+template <typename T>
+inline std::string KernelInfoImpl<T>::GetInputName(size_t index) const {
+ size_t size = 0;
+
+ // Feed nullptr for the data buffer to query the true size of the string value
+ Ort::ThrowOnError(GetApi().KernelInfo_GetInputName(this->p_, index, nullptr, &size));
+
+ std::string out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().KernelInfo_GetInputName(this->p_, index, &out0, &size));
+ out.resize(size - 1); // remove the terminating character '\0'
+
+ return out;
 }
 
 template <typename T>
-T* Value::GetTensorMutableData() {
- T* out;
- ThrowOnError(GetApi().GetTensorMutableData(p_, (void**)&out));
+inline std::string KernelInfoImpl<T>::GetOutputName(size_t index) const {
+ size_t size = 0;
+
+ // Feed nullptr for the data buffer to query the true size of the string value
+ Ort::ThrowOnError(GetApi().KernelInfo_GetOutputName(this->p_, index, nullptr, &size));
+
+ std::string out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().KernelInfo_GetOutputName(this->p_, index, &out0, &size));
+ out.resize(size - 1); // remove the terminating character '\0'
+
 return out;
 }
 
 template <typename T>
-const T* Value::GetTensorData() const {
- T* out;
- ThrowOnError(GetApi().GetTensorMutableData(p_, (void**)&out));
- return out;
+inline TypeInfo KernelInfoImpl<T>::GetInputTypeInfo(size_t index) const {
+ OrtTypeInfo* out = nullptr;
+ ThrowOnError(GetApi().KernelInfo_GetInputTypeInfo(this->p_, index, &out));
+ return TypeInfo{out};
 }
 
-#if !defined(DISABLE_SPARSE_TENSORS)
 template <typename T>
-inline const T* Value::GetSparseTensorValues() const {
- const void* out;
- ThrowOnError(GetApi().GetSparseTensorValues(p_, &out));
- return reinterpret_cast<const T*>(out);
+inline TypeInfo KernelInfoImpl<T>::GetOutputTypeInfo(size_t index) const {
+ OrtTypeInfo* out = nullptr;
+ ThrowOnError(GetApi().KernelInfo_GetOutputTypeInfo(this->p_, index, &out));
+ return TypeInfo{out};
 }
-#endif // !defined(DISABLE_SPARSE_TENSORS)
 
 template <typename T>
-inline T& Value::At(const std::vector<int64_t>& location) {
- static_assert(!std::is_same<T, std::string>::value, "this api does not support std::string");
- T* out;
- ThrowOnError(GetApi().TensorAt(p_, location.data(), location.size(), (void**)&out));
- return *out;
+inline Value KernelInfoImpl<T>::GetTensorAttribute(const char* name, OrtAllocator* allocator) const {
+ OrtValue* out = nullptr;
+ ThrowOnError(GetApi().KernelInfoGetAttribute_tensor(this->p_, name, allocator, &out));
+ return Value{out};
 }
 
-inline TypeInfo Value::GetTypeInfo() const {
- OrtTypeInfo* output;
- ThrowOnError(GetApi().GetTypeInfo(p_, &output));
- return TypeInfo{output};
+inline void attr_utils::GetAttr(const OrtKernelInfo* p, const char* name, float& out) {
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttribute_float(p, name, &out));
 }
 
-inline TensorTypeAndShapeInfo Value::GetTensorTypeAndShapeInfo() const {
- OrtTensorTypeAndShapeInfo* output;
- ThrowOnError(GetApi().GetTensorTypeAndShape(p_, &output));
- return TensorTypeAndShapeInfo{output};
+inline void attr_utils::GetAttr(const OrtKernelInfo* p, const char* name, int64_t& out) {
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttribute_int64(p, name, &out));
+}
+
+inline void attr_utils::GetAttr(const OrtKernelInfo* p, const char* name, std::string& result) {
+ size_t size = 0;
+ // Feed nullptr for the data buffer to query the true size of the string attribute
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttribute_string(p, name, nullptr, &size));
+
+ std::string out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttribute_string(p, name, &out0, &size));
+ out.resize(size - 1); // remove the terminating character '\0'
+ out.swap(result);
+}
+
+inline void attr_utils::GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<float>& result) {
+ size_t size = 0;
+ // Feed nullptr for the data buffer to query the true size of the attribute
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttributeArray_float(p, name, nullptr, &size));
+
+ std::vector<float> out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttributeArray_float(p, name, out.data(), &size));
+ out.swap(result);
+}
+
+inline void attr_utils::GetAttrs(const OrtKernelInfo* p, const char* name, std::vector<int64_t>& result) {
+ size_t size = 0;
+
+ // Feed nullptr for the data buffer to query the true size of the attribute
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttributeArray_int64(p, name, nullptr, &size));
+
+ std::vector<int64_t> out;
+ out.resize(size);
+ Ort::ThrowOnError(GetApi().KernelInfoGetAttributeArray_int64(p, name, out.data(), &size));
+ out.swap(result);
+}
+} // namespace detail
+
+inline KernelInfo::KernelInfo(OrtKernelInfo* info) : detail::KernelInfoImpl<OrtKernelInfo>{info} {}
+
+inline Op::Op(OrtOp* p) : Base<OrtOp>(p) {}
+
+inline Op Op::Create(const OrtKernelInfo* info, const char* op_name, const char* domain, int version,
+ const char** type_constraint_names,
+ const ONNXTensorElementDataType* type_constraint_values,
+ size_t type_constraint_count,
+ const OpAttr* attr_values, size_t attr_count,
+ size_t input_count, size_t output_count) {
+ static_assert(sizeof(OpAttr) == sizeof(OrtOpAttr*),
+ "OpAttr's is expected to be just an array of OrtOpAttr in memory so we can reinterpret safely");
+ auto attr_input_values = reinterpret_cast<const OrtOpAttr* const*>(attr_values);
+ OrtOp* op;
+ Ort::ThrowOnError(GetApi().CreateOp(info, op_name, domain, version, type_constraint_names, type_constraint_values,
+ static_cast<int>(type_constraint_count),
+ attr_input_values,
+ static_cast<int>(attr_count),
+ static_cast<int>(input_count),
+ static_cast<int>(output_count), &op));
+ return Op{op};
+}
+
+inline void Op::Invoke(const OrtKernelContext* context,
+ const Value* input_values,
+ size_t input_count,
+ Value* output_values,
+ size_t output_count) {
+ static_assert(sizeof(Value) == sizeof(OrtValue*),
+ "Value is really just an array of OrtValue* in memory, so we can reinterpret_cast safely");
+ auto ort_input_values = reinterpret_cast<const OrtValue* const*>(input_values);
+ auto ort_output_values = reinterpret_cast<OrtValue**>(output_values);
+ Ort::ThrowOnError(GetApi().InvokeOp(context, p_, ort_input_values, static_cast<int>(input_count),
+ ort_output_values, static_cast<int>(output_count)));
+}
+
+inline void Op::Invoke(const OrtKernelContext* context,
+ const OrtValue* const* input_values,
+ size_t input_count,
+ OrtValue* const* output_values,
+ size_t output_count) {
+ Ort::ThrowOnError(GetApi().InvokeOp(context, p_, input_values, static_cast<int>(input_count),
+ output_values, static_cast<int>(output_count)));
 }
 
-//
-// Custom OP API Inlines
-//
 inline void CustomOpApi::ThrowOnError(OrtStatus* status) {
- Ort::ThrowOnError(api_, status);
+ Ort::ThrowOnError(status);
 }
 
 template <>
 inline float CustomOpApi::KernelInfoGetAttribute<float>(_In_ const OrtKernelInfo* info, _In_ const char* name) {
 float out;
- ThrowOnError(api_.KernelInfoGetAttribute_float(info, name, &out));
+ Ort::ThrowOnError(api_.KernelInfoGetAttribute_float(info, name, &out));
 return out;
 }
 
 template <>
 inline int64_t CustomOpApi::KernelInfoGetAttribute<int64_t>(_In_ const OrtKernelInfo* info, _In_ const char* name) {
 int64_t out;
- ThrowOnError(api_.KernelInfoGetAttribute_int64(info, name, &out));
+ Ort::ThrowOnError(api_.KernelInfoGetAttribute_int64(info, name, &out));
 return out;
 }
 
@@ -1180,10 +1653,10 @@
 
 if (status == nullptr) {
 out.resize(size);
- ThrowOnError(api_.KernelInfoGetAttribute_string(info, name, &out0, &size));
+ Ort::ThrowOnError(api_.KernelInfoGetAttribute_string(info, name, &out0, &size));
 out.resize(size - 1); // remove the terminating character '\0'
 } else {
- ThrowOnError(status);
+ Ort::ThrowOnError(status);
 }
 return out;
 }
@@ -1198,9 +1671,9 @@
 
 if (status == nullptr) {
 out.resize(size);
- ThrowOnError(api_.KernelInfoGetAttributeArray_float(info, name, out.data(), &size));
+ Ort::ThrowOnError(api_.KernelInfoGetAttributeArray_float(info, name, out.data(), &size));
 } else {
- ThrowOnError(status);
+ Ort::ThrowOnError(status);
 }
 return out;
 }
@@ -1215,65 +1688,69 @@
 
 if (status == nullptr) {
 out.resize(size);
- ThrowOnError(api_.KernelInfoGetAttributeArray_int64(info, name, out.data(), &size));
+ Ort::ThrowOnError(api_.KernelInfoGetAttributeArray_int64(info, name, out.data(), &size));
 } else {
- ThrowOnError(status);
+ Ort::ThrowOnError(status);
 }
 return out;
 }
 inline OrtTensorTypeAndShapeInfo* CustomOpApi::GetTensorTypeAndShape(_In_ const OrtValue* value) {
 OrtTensorTypeAndShapeInfo* out;
- ThrowOnError(api_.GetTensorTypeAndShape(value, &out));
+ Ort::ThrowOnError(api_.GetTensorTypeAndShape(value, &out));
 return out;
 }
 
 inline size_t CustomOpApi::GetTensorShapeElementCount(_In_ const OrtTensorTypeAndShapeInfo* info) {
 size_t out;
- ThrowOnError(api_.GetTensorShapeElementCount(info, &out));
+ Ort::ThrowOnError(api_.GetTensorShapeElementCount(info, &out));
 return out;
 }
 
 inline ONNXTensorElementDataType CustomOpApi::GetTensorElementType(const OrtTensorTypeAndShapeInfo* info) {
 ONNXTensorElementDataType out;
- ThrowOnError(api_.GetTensorElementType(info, &out));
+ Ort::ThrowOnError(api_.GetTensorElementType(info, &out));
 return out;
 }
 
 inline size_t CustomOpApi::GetDimensionsCount(_In_ const OrtTensorTypeAndShapeInfo* info) {
 size_t out;
- ThrowOnError(api_.GetDimensionsCount(info, &out));
+ Ort::ThrowOnError(api_.GetDimensionsCount(info, &out));
 return out;
 }
 
 inline void CustomOpApi::GetDimensions(_In_ const OrtTensorTypeAndShapeInfo* info, _Out_ int64_t* dim_values, size_t dim_values_length) {
- ThrowOnError(api_.GetDimensions(info, dim_values, dim_values_length));
+ Ort::ThrowOnError(api_.GetDimensions(info, dim_values, dim_values_length));
 }
 
 inline void CustomOpApi::SetDimensions(OrtTensorTypeAndShapeInfo* info, _In_ const int64_t* dim_values, size_t dim_count) {
- ThrowOnError(api_.SetDimensions(info, dim_values, dim_count));
+ Ort::ThrowOnError(api_.SetDimensions(info, dim_values, dim_count));
 }
 
 template <typename T>
 inline T* CustomOpApi::GetTensorMutableData(_Inout_ OrtValue* value) {
 T* data;
- ThrowOnError(api_.GetTensorMutableData(value, reinterpret_cast<void**>(&data)));
+ Ort::ThrowOnError(api_.GetTensorMutableData(value, reinterpret_cast<void**>(&data)));
 return data;
 }
 
 inline const OrtMemoryInfo* CustomOpApi::GetTensorMemoryInfo(_In_ const OrtValue* value) {
 const OrtMemoryInfo* mem_info;
- ThrowOnError(api_.GetTensorMemoryInfo(value, &mem_info));
+ Ort::ThrowOnError(api_.GetTensorMemoryInfo(value, &mem_info));
 return mem_info;
 }
 
 template <typename T>
 inline const T* CustomOpApi::GetTensorData(_Inout_ const OrtValue* value) {
- return GetTensorMutableData<T>(const_cast<OrtValue*>(value));
+ T* data = nullptr;
+ Ort::ThrowOnError(api_.GetTensorMutableData(const_cast<OrtValue*>(value), reinterpret_cast<void**>(&data)));
+ return data;
 }
 
 inline std::vector<int64_t> CustomOpApi::GetTensorShape(const OrtTensorTypeAndShapeInfo* info) {
- std::vector<int64_t> output(GetDimensionsCount(info));
- GetDimensions(info, output.data(), output.size());
+ size_t out;
+ Ort::ThrowOnError(api_.GetDimensionsCount(info, &out));
+ std::vector<int64_t> output(out);
+ Ort::ThrowOnError(api_.GetDimensions(info, output.data(), out));
 return output;
 }
 
@@ -1283,32 +1760,32 @@
 
 inline size_t CustomOpApi::KernelContext_GetInputCount(const OrtKernelContext* context) {
 size_t out;
- ThrowOnError(api_.KernelContext_GetInputCount(context, &out));
+ Ort::ThrowOnError(api_.KernelContext_GetInputCount(context, &out));
 return out;
 }
 
 inline const OrtValue* CustomOpApi::KernelContext_GetInput(const OrtKernelContext* context, _In_ size_t index) {
 const OrtValue* out;
- ThrowOnError(api_.KernelContext_GetInput(context, index, &out));
+ Ort::ThrowOnError(api_.KernelContext_GetInput(context, index, &out));
 return out;
 }
 
 inline size_t CustomOpApi::KernelContext_GetOutputCount(const OrtKernelContext* context) {
 size_t out;
- ThrowOnError(api_.KernelContext_GetOutputCount(context, &out));
+ Ort::ThrowOnError(api_.KernelContext_GetOutputCount(context, &out));
 return out;
 }
 
 inline OrtValue* CustomOpApi::KernelContext_GetOutput(OrtKernelContext* context, _In_ size_t index,
 _In_ const int64_t* dim_values, size_t dim_count) {
 OrtValue* out;
- ThrowOnError(api_.KernelContext_GetOutput(context, index, dim_values, dim_count, &out));
+ Ort::ThrowOnError(api_.KernelContext_GetOutput(context, index, dim_values, dim_count, &out));
 return out;
 }
 
 inline void* CustomOpApi::KernelContext_GetGPUComputeStream(const OrtKernelContext* context) {
 void* out;
- ThrowOnError(api_.KernelContext_GetGPUComputeStream(context, &out));
+ Ort::ThrowOnError(api_.KernelContext_GetGPUComputeStream(context, &out));
 return out;
 }
 
@@ -1317,7 +1794,7 @@
 _In_ int len,
 _In_ OrtOpAttrType type) {
 OrtOpAttr* op_attr{};
- ThrowOnError(api_.CreateOpAttr(name, data, len, type, &op_attr));
+ Ort::ThrowOnError(api_.CreateOpAttr(name, data, len, type, &op_attr));
 return op_attr;
 }
 
@@ -1337,8 +1814,8 @@
 _In_ int input_count,
 _In_ int output_count) {
 OrtOp* ort_op{};
- ThrowOnError(api_.CreateOp(info, op_name, domain, version, type_constraint_names, type_constraint_values,
- type_constraint_count, attr_values, attr_count, input_count, output_count, &ort_op));
+ Ort::ThrowOnError(api_.CreateOp(info, op_name, domain, version, type_constraint_names, type_constraint_values,
+ type_constraint_count, attr_values, attr_count, input_count, output_count, &ort_op));
 return ort_op;
 }
 
@@ -1348,7 +1825,7 @@
 _In_ int input_count,
 _Inout_ OrtValue* const* output_values,
 _In_ int output_count) {
- ThrowOnError(api_.InvokeOp(context, ort_op, input_values, input_count, output_values, output_count));
+ Ort::ThrowOnError(api_.InvokeOp(context, ort_op, input_values, input_count, output_values, output_count));
 }
 
 inline void CustomOpApi::ReleaseOp(_Frees_ptr_opt_ OrtOp* ort_op) {
@@ -1357,29 +1834,41 @@
 
 inline OrtKernelInfo* CustomOpApi::CopyKernelInfo(_In_ const OrtKernelInfo* info) {
 OrtKernelInfo* info_copy{};
- ThrowOnError(api_.CopyKernelInfo(info, &info_copy));
+ Ort::ThrowOnError(api_.CopyKernelInfo(info, &info_copy));
 return info_copy;
 }
 
 inline void CustomOpApi::ReleaseKernelInfo(_Frees_ptr_opt_ OrtKernelInfo* info_copy) {
 api_.ReleaseKernelInfo(info_copy);
-} 
-
-inline SessionOptions& SessionOptions::DisablePerSessionThreads() {
- ThrowOnError(GetApi().DisablePerSessionThreads(p_));
- return *this;
 }
 
 inline std::vector<std::string> GetAvailableProviders() {
 int len;
 char** providers;
- const OrtApi& api = GetApi();
- ThrowOnError(api.GetAvailableProviders(&providers, &len));
+ ThrowOnError(GetApi().GetAvailableProviders(&providers, &len));
 std::vector<std::string> available_providers(providers, providers + len);
- ThrowOnError(api.ReleaseAvailableProviders(providers, len));
+ ThrowOnError(GetApi().ReleaseAvailableProviders(providers, len));
 return available_providers;
 }
 
 SessionOptions& AddInitializer(const char* name, const OrtValue* ort_val);
 
+template <typename TOp, typename TKernel>
+void CustomOpBase<TOp, TKernel>::GetSessionConfigs(std::unordered_map<std::string, std::string>& out,
+ ConstSessionOptions options) const {
+ const TOp* derived = static_cast<const TOp*>(this);
+ std::vector<std::string> keys = derived->GetSessionConfigKeys();
+
+ out.reserve(keys.size());
+
+ std::string config_entry_key = detail::MakeCustomOpConfigEntryKey(derived->GetName(), "");
+ const size_t prefix_size = config_entry_key.length();
+
+ for (const auto& key : keys) {
+ config_entry_key.resize(prefix_size);
+ config_entry_key.append(key);
+ outkey = options.GetConfigEntryOrDefault(config_entry_key.c_str(), "");
+ }
+}
+
 } // namespace Ort

onnxruntime-linux-x64-1.12.1.tgz/include/onnxruntime_run_options_config_keys.h -> onnxruntime-linux-x64-1.14.1.tgz/include/onnxruntime_run_options_config_keys.h Changed

onnxruntime-linux-x64-1.12.1.tgz/include/onnxruntime_session_options_config_keys.h -> onnxruntime-linux-x64-1.14.1.tgz/include/onnxruntime_session_options_config_keys.h Changed

@@ -47,6 +47,12 @@
 // Its default value is "0"
 static const char* const kOrtSessionOptionsDisableQuantQDQ = "session.disable_quant_qdq";
 
+// It controls whether to enable Double QDQ remover and Identical Children Consolidation
+// "0": not to disable. ORT does remove the middle 2 Nodes from a Q->(QD->Q)->QD pairs
+// "1": disable. ORT doesn't remove the middle 2 Nodes from a Q->(QD->Q)->QD pairs
+// Its default value is "0"
+static const char* const kOrtSessionOptionsDisableDoubleQDQRemover = "session.disable_double_qdq_remover";
+
 // If set to "1", enables the removal of QuantizeLinear/DequantizeLinear node pairs once all QDQ handling has been
 // completed. e.g. If after all QDQ handling has completed and we have -> FloatOp -> Q -> DQ -> FloatOp -> the
 // Q -> DQ could potentially be removed. This will provide a performance benefit by avoiding going from float to
@@ -61,6 +67,22 @@
 // GeluApproximation has side effects which may change the inference results. It is disabled by default due to this.
 static const char* const kOrtSessionOptionsEnableGeluApproximation = "optimization.enable_gelu_approximation";
 
+#ifdef ENABLE_TRAINING
+// Specifies a list of op types for memory footprint reduction.
+// The value should be a ","-delimited list of pair of
+// <subgraph string : optimization strategy : number of subgraph to apply>.
+// For example, "Gelu+Cast+:1:0,Dropout+:1:1".
+// A valid "subgraph string" should be one subgraph representation output by ORT graph transformations.
+// "optimization strategy" currently has valid values: 0 - disabled, 1 - recompute.
+// "number of subgraph to apply" is used to control how many subgraphs to apply optimization, to avoid "oversaving"
+// the memory.
+static const char* const kOrtSessionOptionsMemoryOptimizerEnabler = "optimization.enable_memory_optimizer";
+
+// Specifies the level for detecting subgraphs for memory footprint reduction.
+// The value should be an integer. The default value is 0.
+static const char* const kOrtSessionOptionsMemoryOptimizerProbeLevel = "optimization.enable_memory_probe_recompute_level";
+#endif
+
 // Enable or disable using device allocator for allocating initialized tensor memory. "1": enable; "0": disable. The default is "0".
 // Using device allocators means the memory allocation is made using malloc/new.
 static const char* const kOrtSessionOptionsUseDeviceAllocatorForInitializers = "session.use_device_allocator_for_initializers";
@@ -79,11 +101,27 @@
 // has to guarantee that the model bytes are valid until the ORT session using the model bytes is destroyed.
 static const char* const kOrtSessionOptionsConfigUseORTModelBytesDirectly = "session.use_ort_model_bytes_directly";
 
+/// <summary>
+/// Key for using the ORT format model flatbuffer bytes directly for initializers.
+/// This avoids copying the bytes and reduces peak memory usage during model loading and initialization.
+/// Requires `session.use_ort_model_bytes_directly` to be true.
+/// If set, the flatbuffer bytes provided when creating the InferenceSession MUST remain valid for the entire
+/// duration of the InferenceSession.
+/// </summary>
+static const char* const kOrtSessionOptionsConfigUseORTModelBytesForInitializers =
+ "session.use_ort_model_bytes_for_initializers";
+
 // This should only be specified when exporting an ORT format model for use on a different platform.
 // If the ORT format model will be used on ARM platforms set to "1". For other platforms set to "0"
 // Available since version 1.11.
 static const char* const kOrtSessionOptionsQDQIsInt8Allowed = "session.qdqisint8allowed";
 
+// x64 SSE4.1/AVX2/AVX512(with no VNNI) has overflow problem with quantizied matrix multiplication with U8S8.
+// To avoid this we need to use slower U8U8 matrix multiplication instead. This option, if
+// turned on, use slower U8U8 matrix multiplications. Only effective with AVX2 or AVX512
+// platforms.
+static const char* const kOrtSessionOptionsAvx2PrecisionMode = "session.x64quantprecision";
+
 // Specifies how minimal build graph optimizations are handled in a full build.
 // These optimizations are at the extended level or higher.
 // Possible values and their effects are:
@@ -126,3 +164,23 @@
 // "0": in some cases warnings will be logged but processing will continue. The default.
 // May be useful to expose bugs in models.
 static const char* const kOrtSessionOptionsConfigStrictShapeTypeInference = "session.strict_shape_type_inference";
+
+// The file saves configuration for partitioning node among logic streams
+static const char* const kNodePartitionConfigFile = "session.node_partition_config_file";
+
+// This Option allows setting affinities for intra op threads.
+// Affinity string follows format:
+// logical_processor_id,logical_processor_id;logical_processor_id,logical_processor_id
+// Semicolon isolates configurations among threads, while comma split processors where ith thread expected to attach to.
+// e.g.1,2,3;4,5
+// specifies affinities for two threads, with the 1st thread attach to the 1st, 2nd, and 3rd processor, and 2nd thread to the 4th and 5th.
+// To ease the configuration, an "interval" is also allowed:
+// e.g. 1-8;8-16;17-24
+// orders that the 1st thread runs on first eight processors, 2nd thread runs on next eight processors, and so forth.
+// Note:
+// 1. Once set, the number of thread affinities must equal to intra_op_num_threads - 1, since ort does not set affinity on the main thread which
+// is started and managed by the calling app;
+// 2. For windows, ort will infer the group id from a logical processor id, for example, assuming there are two groups with each has 64 logical processors,
+// an id of 64 will be inferred as the last processor of the 1st group, while 65 will be interpreted as the 1st processor of the second group.
+// Hence 64-65 is an invalid configuration, because a windows thread cannot be attached to processors across group boundary.
+static const char* const kOrtSessionOptionsConfigIntraOpThreadAffinities = "session.intra_op_thread_affinities";

onnxruntime-linux-x64-1.12.1.tgz/lib/libonnxruntime.so -> onnxruntime-linux-x64-1.14.1.tgz/lib/libonnxruntime.so Changed

onnxruntime-linux-x64-1.14.1.tgz/lib/libonnxruntime.so.1.14.1 Added

onnxruntime-linux-x64-gpu-1.12.1.tgz Deleted