Pull cross-platform plugin into develop

Pulling cross-platform spatializer feature into develop.

Author: ashtat

.gitignore

@@ -1,8 +1,10 @@
 [Ll]ibrary/
+[Ll]ogs/
 [Tt]emp/
 [Oo]bj/
 [Bb]uild/
 [Bb]uilds/
+[Uu]serSettings/
 Assets/AssetStoreTools*
 
 # Visual Studio cache directory
@@ -24,6 +26,7 @@ ExportedObj/
 *.pdb
 *.opendb
 *.log
+.vsconfig
 
 # Unity3D generated meta files
 *.pidb.meta
@@ -37,6 +40,7 @@ sysinfo.txt
 
 # No binaries
 *.dll
+*.so
 
 # Ignore VS Code settings
-.vscode/launch.json
+.vscode/*

Documentation/Images/Android_symbol_green_RGB.png

@@ -0,0 +1,52 @@
+# How to add the plugin to Unity projects
+
+## 1. Add the spatializer package reference to manifest.json
+This is the recommended way to add the plugin package to a project. 
+- Open the `manifest.json` file from the project in a text editor
+- Add Microsoft's scoped registry and the package reference  
+    <pre>
+    {
+        "scopedRegistries": [
+        {
+            "name": "Microsoft Spatializer",
+            "url": "https://microsoft.pkgs.visualstudio.com/Analog/_packaging/MixedReality-UPM-Internal/npm/registry/",
+            "scopes": [
+            "com.microsoft.spatialaudio"
+            ]
+        },
+        ...
+        ],
+        "dependencies": {
+            ...
+            "com.microsoft.spatialaudio.spatializer.unity": "2.0.5-prerelease",
+            ...
+        }
+    }
+    </pre>
+
+For an example, see the [sample project manifest.](../samples/MicrosoftSpatializerSample/Packages/manifest.json)
+
+The plugin package can also be downloaded from GitHub releases and imported into the project using `Assets > Import Package > Custom Package` menu.  
+
+## 2. Configure the project to use Microsoft Spatializer
+- Open the project settings using `Edit > Project Settings`
+- In the `Audio` tab, select `Microsoft Spatializer` in the `Spatializer Settings` dropdown. No other changes are necessary.
+
+    ![Project Settings](./Images/ProjectSettings.png)
+
+## 3. Add the Microsoft Spatializer Mixer to the project
+`Microsoft Spatializer Mixer` effect is necessary to process all the spatialized audio objects in a scene.
+- Add an audio mixer to the project
+  - In the `Project` pane, right-click on the `Assets` folder, then `Create > Audio Mixer`
+  - Give the mixer a name, e.g. `Master` 
+  - Open the mixer and right-click, then select `Add effect at bottom > Microsoft Spatializer Mixer`
+
+    ![Microsoft Spatializer Mixer](./Images/SpatializerMixerSetup.png)
+
+## 4. Spatialize audio objects
+- Setup spatialized audio objects as usual, making sure to route the `Output` to the `Master` audio mixer setup above.
+
+    ![Audio Object Settings](./Images/AudioObjectSettings.png)
+
+
+

Documentation/Images/AudioObjectSettings.png

@@ -2,195 +2,53 @@
 # Licensed under the MIT License.
 
 jobs:
-- job: Windows_x64_Desktop
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-    - msbuild
-    - visualstudio
 
-  steps:
-  - script: echo Building Windows x64 Desktop
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windows --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\windows\x64\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\windows\x64\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+# Windows Flavors
+- template: BuildWindows.yaml
+  parameters:
+    platform: windows
+    architecture: Win32
+    configuration: RelWithDebInfo
 
-- job: Windows_x86_Desktop
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-      - msbuild
-      - visualstudio
-  steps:
-  - script: echo Building Windows x86 Desktop
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windows --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\windows\x86\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\windows\x86\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+- template: BuildWindows.yaml
+  parameters:
+    platform: windows
+    architecture: x64
+    configuration: RelWithDebInfo
 
-- job: Windows_x64_UWP
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-      - msbuild
-      - visualstudio
-  steps:
-  - script: echo Building Windows x64 UWP
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windowsstore --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\WindowsStore\x64\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\WindowsStore\x64\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+- template: BuildWindows.yaml
+  parameters:
+    platform: windowsstore
+    architecture: Win32
+    configuration: RelWithDebInfo
 
-- job: Windows_x86_UWP
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-      - msbuild
-      - visualstudio
-  steps:
-  - script: echo Building Windows x86 UWP
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windowsstore --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\WindowsStore\x86\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\WindowsStore\x86\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+- template: BuildWindows.yaml
+  parameters:
+    platform: windowsstore
+    architecture: x64
+    configuration: RelWithDebInfo
 
-- job: Windows_ARM_UWP
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-      - msbuild
-      - visualstudio
-  steps:
-  - script: echo Building Windows ARM UWP
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windowsstore --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\WindowsStore\ARM\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\WindowsStore\ARM\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+- template: BuildWindows.yaml
+  parameters:
+    platform: windowsstore
+    architecture: ARM
+    configuration: RelWithDebInfo
 
-- job: Windows_ARM64_UWP
-  continueOnError: false
-  pool:
-    vmImage: 'windows-2019'
-    Demands:
-      - msbuild
-      - visualstudio
-  steps:
-  - script: echo Building Windows ARM64 UWP
-  - checkout: self
-    submodules: true
-  - script: 'echo git submodule update --init --recursive'
-    displayName: 'Update Submodules'
-  - script: python tools\runcmake.py --windowsstore --version $(ProductVersion)
-    displayName: 'Run CMake'
-  - task: MSBuild@1
-    inputs:
-      solution: 'build\WindowsStore\ARM64\Microsoft.SpatialAudio.Unity.sln'
-      msbuildArchitecture: 'x64'
-      configuration: 'RelWithDebInfo'
-      clean: true
-  - task: CopyFiles@2
-    inputs:
-      SourceFolder: 'build\WindowsStore\ARM64\bin\RelWithDebInfo'
-      Contents: '**'
-      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
-  - task: PublishBuildArtifacts@1
-    inputs:
-      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
-      ArtifactName: $(Agent.JobName)
-      publishLocation: 'Container'
+- template: BuildWindows.yaml
+  parameters:
+    platform: windowsstore
+    architecture: ARM64
+    configuration: RelWithDebInfo
+
+# Android Flavors
+- template: BuildAndroid.yaml
+  parameters:
+    configuration: RelWithDebInfo
+    architecture: armeabi-v7a
+    jobName: arm
+
+- template: BuildAndroid.yaml
+  parameters:
+    configuration: RelWithDebInfo
+    architecture: arm64-v8a
+    jobName: arm64

Documentation/Images/ProjectSettings.png

@@ -0,0 +1,52 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+parameters:
+- name: jobName
+  type: string
+  default: arm
+- name: architecture
+  type: string
+  default: armeabi-v7a
+- name: configuration
+  type: string
+  default: RelWithDebInfo
+  values:
+  - Debug
+  - RelWithDebInfo
+
+jobs:
+- job: Android_${{ parameters.jobName }}_${{ parameters.configuration }}
+  pool:
+    name: Analog-1ES-WindowsLatest
+    vmImage: 'windows-2019'
+  dependsOn: []
+  steps:
+  - checkout: self
+    submodules: true
+    fetchDepth: 1
+  - template: DownloadPackage.yaml
+  - task: PythonScript@0
+    displayName: 'Run CMake'
+    inputs:
+      scriptSource: 'filePath'
+      scriptPath: tools/runcmake.py
+      arguments: --android --version $(ProductVersion)
+      abortOnFail: true
+  - task: PythonScript@0
+    displayName: Build
+    inputs:
+      scriptSource: 'filePath'
+      scriptPath: tools/build.py
+      arguments: --platform android --arch ${{ parameters.architecture }} --config ${{ parameters.configuration }}
+      abortOnFail: true
+  - task: CopyFiles@2
+    inputs:
+      SourceFolder: 'build\android\${{ parameters.architecture }}\lib\${{ parameters.configuration }}'
+      Contents: '**'
+      TargetFolder: '$(Build.ArtifactStagingDirectory)\$(Agent.JobName)'
+  - task: PublishBuildArtifacts@1
+    inputs:
+      PathtoPublish: '$(Build.ArtifactStagingDirectory)'
+      ArtifactName: $(Agent.JobName)
+      publishLocation: 'Container'