[
{
"path": ".cargo/config.toml",
"content": "[alias]\nxtask = \"run -p alvr_xtask --\"\n\n[target.x86_64-pc-windows-msvc]\nrustflags = [\"-C\", \"target-feature=+crt-static\"]\n"
},
{
"path": ".clang-format",
"content": "BasedOnStyle: WebKit\nIndentWidth: 4\nColumnLimit: 100\nBinPackArguments: false\nBinPackParameters: false\nAlignAfterOpenBracket: BlockIndent\nBreakBeforeBraces: Attach\nInsertNewlineAtEOF: true\n"
},
{
"path": ".editorconfig",
"content": "# Editor configuration, see https://editorconfig.org\n\n[*.{c,cpp,h,hpp}]\nindent_style = space\nindent_size = 4\ntab_width = 4\nmax_line_length = 100\nend_of_line = lf\ninsert_final_newline = true\n\n[.editorconfig]\nindent_style = space\nindent_size = 4\ntab_width = 4\nend_of_line = lf\ninsert_final_newline = true\n"
},
{
"path": ".gitattributes",
"content": "* text=auto eol=lf\n\nalvr/server_openvr/cpp/alvr_server/include/** linguist-vendored\nalvr/server_openvr/cpp/alvr_server/nvEncodeAPI.h linguist-vendored\nalvr/server_openvr/cpp/platform/win32/NvCodecUtils.h linguist-vendored\nalvr/server_openvr/cpp/platform/win32/NvEncoder.cpp linguist-vendored\nalvr/server_openvr/cpp/platform/win32/NvEncoder.h linguist-vendored\nalvr/server_openvr/cpp/shared/** linguist-vendored\n# note: some of these folders contain ALVR code, but only a minor amount\nalvr/vulkan_layer/layer/** linguist-vendored\nalvr/vulkan_layer/util/** linguist-vendored\nalvr/vulkan_layer/wsi/** linguist-vendored\n"
},
{
"path": ".github/FUNDING.yml",
"content": "# These are supported funding model platforms\n\ngithub: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]\npatreon: # Replace with a single Patreon username\nopen_collective: alvr\nko_fi: # Replace with a single Ko-fi username\ntidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel\ncommunity_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry\nliberapay: # Replace with a single Liberapay username\nissuehunt: # Replace with a single IssueHunt username\notechie: # Replace with a single Otechie username\ncustom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']\n"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"content": "---\nname: Bug Report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n\n\n\n## Description\n\n\n\n\n## General Troubleshooting\n- [ ] I carefully followed the instructions in the [README](https://github.com/alvr-org/ALVR/blob/master/README.md) and successfully completed the setup wizard\n- [ ] I read the [ALVR GitHub Wiki](https://github.com/alvr-org/ALVR/wiki)\n\n## Environment\n\n### Hardware\n**Note**: for Linux, an upload to the [`hw-probe`](https://linux-hardware.org/) database is preferred: `hw-probe -all -upload`\n\n**CPU**:\n\n**GPU**:\n\n**GPU Driver Version**:\n\n**Audio**:\n\n### Installation\n**ALVR Version**:\n\n**ALVR Settings File**:\n\n**SteamVR Version**:\n\n**Install Type**:\n- [ ] Packaged (`exe`, `deb`, `rpm`, etc)\n- [ ] Portable (`zip`)\n- [ ] Source\n\n**OS Name and Version** (`winver` on Windows or `grep PRETTY_NAME /etc/os-release` on most Linux distributions):\n\n\n"
},
{
"path": ".github/dependabot.yml",
"content": "# To get started with Dependabot version updates, you'll need to specify which\n# package ecosystems to update and where the package manifests are located.\n# Please see the documentation for all configuration options:\n# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates\n\nversion: 2\nupdates:\n - package-ecosystem: \"cargo\" # See documentation for possible values\n directory: \"/\" # Location of package manifests\n schedule:\n interval: \"monthly\"\n ignore:\n - dependency-name: \"*\"\n update-types: [ \"version-update:semver-minor\",\"version-update:semver-patch\" ]\n"
},
{
"path": ".github/workflows/prepare-release.yml",
"content": "name: Create release\n\nenv:\n CARGO_TERM_COLOR: always\n\non:\n workflow_dispatch:\n inputs:\n version:\n description: \"Version\"\n required: false\n default: \"\"\n\njobs:\n prepare_release:\n runs-on: windows-2022\n outputs:\n release_ref: ${{ steps.output_ref.outputs.release_ref }}\n upload_url: ${{ steps.create_release.outputs.upload_url }}\n release_id: ${{ steps.create_release.outputs.id }}\n steps:\n - name: Configure git\n run: git config --global core.autocrlf false\n\n - uses: actions/checkout@v2\n\n - uses: actions-rs/toolchain@v1\n with:\n toolchain: stable\n\n - name: Bump version\n id: bump_version\n env:\n RUST_BACKTRACE: 1\n run: |\n $versionarg = \"${{ github.event.inputs.version }}\"\n $versionarg = If ($versionarg.Length -gt 0) { \"--version $versionarg\" } else { \"\" }\n $out = cargo xtask bump $versionarg.split()\n echo $out\n cargo update -p alvr_common\n echo \"::set-output name=version_tag::$(echo $out | sls -CaseSensitive -Pattern '^v.*$')\"\n\n - name: Push changes\n uses: stefanzweifel/git-auto-commit-action@v4\n with:\n commit_message: \"[Auto] Bump version\"\n\n - name: Output ref for later checkouts\n id: output_ref\n run: echo \"::set-output name=release_ref::$(git rev-parse HEAD)\"\n\n - name: Create Release\n id: create_release\n uses: actions/create-release@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n tag_name: ${{ steps.bump_version.outputs.version_tag }}\n release_name: ALVR ${{ steps.bump_version.outputs.version_tag }}\n draft: true\n prerelease: false\n commitish: ${{ steps.output_ref.outputs.release_ref }}\n\n build_windows_streamer:\n runs-on: windows-2022\n needs: [prepare_release]\n steps:\n - uses: actions/checkout@v2\n with:\n ref: ${{ needs.prepare_release.outputs.release_ref }}\n submodules: true\n\n - uses: actions-rs/toolchain@v1\n with:\n toolchain: stable\n override: true\n\n - uses: crazy-max/ghaction-chocolatey@v1\n with:\n args: install zip unzip pkgconfiglite wixtoolset\n\n - name: Build and package ALVR\n id: build\n env:\n RUST_BACKTRACE: 1\n run: |\n cargo xtask package-streamer --gpl --ci\n cargo xtask package-launcher --ci\n\n - name: Upload streamer\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: ./build/alvr_streamer_windows.zip\n asset_name: alvr_streamer_windows.zip\n asset_content_type: application/zip\n - name: Upload launcher\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: ./build/alvr_launcher_windows.zip\n asset_name: alvr_launcher_windows.zip\n asset_content_type: application/zip\n\n build_linux_streamer:\n runs-on: ubuntu-22.04\n needs: [prepare_release]\n steps:\n - uses: actions/checkout@v2\n with:\n ref: ${{ needs.prepare_release.outputs.release_ref }}\n submodules: true\n\n - uses: actions-rs/toolchain@v1\n with:\n toolchain: stable\n override: true\n\n - name: Build and install dependencies\n env:\n RUST_BACKTRACE: 1\n run: |\n sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 25088A0359807596\n echo \"deb http://ppa.launchpad.net/pipewire-debian/pipewire-upstream/ubuntu $(lsb_release -cs) main\" | sudo tee -a /etc/apt/sources.list.d/pipewire-upstream.list\n sudo apt-get update\n sudo apt-get install libfuse2 build-essential pkg-config nasm libva-dev libdrm-dev libvulkan-dev libx264-dev libx265-dev cmake libasound2-dev libjack-jackd2-dev libxrandr-dev libunwind-dev libgtk-3-dev libpipewire-0.3-dev libspa-0.2-dev\n\n - name: Build and package ALVR (.tar.gz)\n id: build\n env:\n RUST_BACKTRACE: 1\n run: |\n cargo xtask package-streamer --gpl --ci\n cargo xtask package-launcher --ci\n\n - name: Upload streamer (tar.gz)\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: ./build/alvr_streamer_linux.tar.gz\n asset_name: alvr_streamer_linux.tar.gz\n asset_content_type: application/gzip\n - name: Upload launcher\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: ./build/alvr_launcher_linux.tar.gz\n asset_name: alvr_launcher_linux.tar.gz\n asset_content_type: application/gzip\n\n build_flatpak_bundle:\n runs-on: ubuntu-latest\n needs: [prepare_release]\n steps:\n - uses: actions/checkout@v2\n with:\n ref: ${{ needs.prepare_release.outputs.release_ref }}\n submodules: true\n\n - name: Build and install dependencies\n env:\n RUST_BACKTRACE: 1\n run: |\n sudo apt-get update\n sudo apt-get install flatpak flatpak-builder\n sudo flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo\n\n - name: Build and package ALVR flatpak (.flatpak)\n id: build_flatpak\n run: |\n sudo flatpak-builder --repo=.flatpak-repo --install-deps-from=flathub --force-clean --default-branch=stable --arch=x86_64 .flatpak-build-dir alvr/xtask/flatpak/com.valvesoftware.Steam.Utility.alvr.json\n flatpak build-bundle .flatpak-repo com.valvesoftware.Steam.Utility.alvr.flatpak com.valvesoftware.Steam.Utility.alvr stable --runtime\n\n - name: Upload flatpak streamer for Linux\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: com.valvesoftware.Steam.Utility.alvr.flatpak\n asset_name: com.valvesoftware.Steam.Utility.alvr.flatpak\n asset_content_type: application/octet-stream\n\n build_android_client:\n runs-on: ubuntu-latest\n needs: [prepare_release]\n steps:\n - uses: actions/checkout@v2\n with:\n ref: ${{ needs.prepare_release.outputs.release_ref }}\n submodules: true\n \n - uses: actions-rs/toolchain@v1\n with:\n toolchain: stable\n target: aarch64-linux-android\n override: true\n - uses: actions/setup-java@v2\n with:\n distribution: \"temurin\"\n java-version: \"17\"\n - uses: android-actions/setup-android@v3\n with:\n packages: \"platforms;android-32\"\n - uses: nttld/setup-ndk@v1\n id: setup-ndk\n with:\n ndk-version: r26b\n\n - name: Build and package ALVR\n id: build\n env:\n RUST_BACKTRACE: 1\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n run: cargo xtask package-client --ci\n\n - name: Sign APK\n uses: ilharp/sign-android-release@v1\n id: sign_apk\n with:\n releaseDir: build/alvr_client_android\n signingKey: ${{ secrets.SIGNING_KEY }}\n keyAlias: ${{ secrets.KEY_ALIAS }}\n keyStorePassword: ${{ secrets.KEY_STORE_PASSWORD }}\n keyPassword: ${{ secrets.KEY_PASSWORD }}\n buildToolsVersion: 34.0.0\n\n - name: Upload APK\n uses: actions/upload-release-asset@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n upload_url: ${{ needs.prepare_release.outputs.upload_url }}\n asset_path: ${{ steps.sign_apk.outputs.signedFile }}\n asset_name: alvr_client_android.apk\n asset_content_type: application/vnd.android.package-archive\n"
},
{
"path": ".github/workflows/queue.yml",
"content": "name: Merge queue only checks\n\n# Merge queue checks need to be selected as required for prs to actually run, so simply skip them on prs\non:\n pull_request:\n merge_group:\n\nenv:\n CARGO_TERM_COLOR: always\n\njobs:\n check-linux-old:\n if: github.event_name == 'merge_group'\n runs-on: ubuntu-22.04\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n with:\n components: clippy\n - uses: Swatinem/rust-cache@v2\n\n - name: Install dependencies\n run: |\n sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 25088A0359807596\n echo \"deb http://ppa.launchpad.net/pipewire-debian/pipewire-upstream/ubuntu $(lsb_release -cs) main\" | sudo tee -a /etc/apt/sources.list.d/pipewire-upstream.list\n sudo add-apt-repository universe\n sudo apt-get update\n sudo apt-get install libfuse2 build-essential pkg-config nasm libva-dev libdrm-dev libvulkan-dev libx264-dev libx265-dev cmake libasound2-dev libjack-jackd2-dev libxrandr-dev libunwind-dev libgtk-3-dev libpipewire-0.3-dev libspa-0.2-dev\n\n - name: Prepare deps\n env:\n RUST_BACKTRACE: 1\n run: cargo xtask prepare-deps --platform linux --no-nvidia\n\n - run: cargo clippy\n\n check-msrv-windows:\n if: github.event_name == 'merge_group'\n runs-on: windows-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n - uses: Swatinem/rust-cache@v2\n\n # Fix actions rust install and msrv both being stupid\n - run: rustup update\n\n - name: Prepare deps\n env:\n RUST_BACKTRACE: 1\n run: cargo xtask prepare-deps --platform windows\n\n - run: cargo xtask check-msrv\n\n check-msrv-linux:\n if: github.event_name == 'merge_group'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n - uses: Swatinem/rust-cache@v2\n\n - name: Install dependencies\n run: |\n sudo apt update\n sudo apt install build-essential pkg-config nasm libva-dev libdrm-dev libvulkan-dev libx264-dev libasound2-dev libxrandr-dev libunwind-dev libgtk-3-dev libpipewire-0.3-dev libspa-0.2-dev\n\n - name: Prepare deps\n env:\n RUST_BACKTRACE: 1\n run: cargo xtask prepare-deps --platform linux --no-nvidia\n\n - run: cargo xtask check-msrv\n\n check-licenses:\n if: github.event_name == 'merge_group'\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n - uses: Swatinem/rust-cache@v2\n\n - run: cargo xtask check-licenses\n"
},
{
"path": ".github/workflows/rust.yml",
"content": "name: Rust\n\non:\n pull_request:\n branches: [master]\n merge_group:\n\nenv:\n CARGO_TERM_COLOR: always\n\njobs:\n check-windows:\n runs-on: windows-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n with:\n components: clippy\n - uses: Swatinem/rust-cache@v2\n\n - name: Prepare deps\n env:\n RUST_BACKTRACE: 1\n run: cargo xtask prepare-deps --platform windows\n\n - run: cargo xtask clippy --ci\n\n check-linux:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n with:\n components: clippy\n - uses: Swatinem/rust-cache@v2\n\n - name: Install dependencies\n run: |\n sudo apt update\n sudo apt install build-essential pkg-config nasm libva-dev libdrm-dev libvulkan-dev libx264-dev libasound2-dev libxrandr-dev libunwind-dev libgtk-3-dev libpipewire-0.3-dev libspa-0.2-dev\n\n - name: Prepare deps\n env:\n RUST_BACKTRACE: 1\n run: cargo xtask prepare-deps --platform linux --no-nvidia\n\n - run: cargo xtask clippy --ci\n\n check-macos:\n runs-on: macos-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n with:\n components: clippy\n - uses: Swatinem/rust-cache@v2\n\n # This step currently does nothing on macos, but might in the future\n # - run: cargo xtask prepare-deps --platform macos\n\n - run: cargo clippy\n\n build-android:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n with:\n targets: aarch64-linux-android\n - uses: Swatinem/rust-cache@v2\n - uses: actions/setup-java@v2\n with:\n distribution: 'temurin'\n java-version: '17'\n - uses: android-actions/setup-android@v3\n with:\n packages: 'platforms;android-32'\n - uses: nttld/setup-ndk@v1\n id: setup-ndk\n with:\n ndk-version: r26b\n\n - name: Install deps\n run: cargo install cargo-apk\n\n # Create folder without content to make the build succeed\n - run: mkdir -p deps/android_openxr/arm64-v8a\n\n - name: Build client\n env:\n ANDROID_NDK_HOME: ${{ steps.setup-ndk.outputs.ndk-path }}\n working-directory: ./alvr/client_openxr\n run: cargo xtask build-client\n\n tests:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n with:\n submodules: true\n - uses: dtolnay/rust-toolchain@stable\n - uses: Swatinem/rust-cache@v2\n\n - name: Run tests\n run: cargo test -p alvr_session\n\n check-format:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: dtolnay/rust-toolchain@stable\n with:\n components: rustfmt\n\n - run: cargo xtask check-format\n"
},
{
"path": ".github/workflows/stale.yml",
"content": "name: 'Close stale issues'\non:\n schedule:\n - cron: '0 0 * * *'\n\njobs:\n stale:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/stale@v9\n with:\n stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'\n exempt-issue-labels: 'bug,documentation,enhancement,good-first-issue,hep-wanted,needs-testing,release'\n exempt-draft-pr: true\n"
},
{
"path": ".github/workflows/wiki.yml",
"content": "name: Publish to GitHub Wiki\n\non:\n push:\n branches: [master]\n workflow_dispatch:\n\njobs:\n wiki:\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v2\n - name: Publish to wiki\n uses: cmbrose/github-docs-to-wiki@v0.24\n with:\n githubToken: ${{ secrets.GH_PAT }}\n rootDocsFolder: \"wiki\"\n"
},
{
"path": ".gitignore",
"content": "Debug\nRelease\n*.opensdf\n*.sdf\n*.suo\n*.filters\n*.user\n*.dll\n*.exe\n*.mexw64\n*.aps\n\n# editor\n.vs/\n.idea/\n\n# NuGet Packages\n*.nupkg\n# The packages folder can be ignored because of Package Restore\n**/[Pp]ackages/*\n# except build/, which is used as an MSBuild target.\n!**/[Pp]ackages/build/\n# Uncomment if necessary however generally it will be regenerated when needed\n#!**/[Pp]ackages/repositories.config\n# NuGet v3's project.json files produces more ignorable files\n*.nuget.props\n*.nuget.targets\n\nrelease-files/\n\n# Ignore generated file with harvested file paths for WiX\nwix/harvested.wxs\n\n# Other WiX files\n*.wixobj\n*.wixpdb\n*.msi\n\n# Generated by Cargo\n# will have compiled files and executables\n/target/\n\n# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries\n# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html\n#Cargo.lock\n\n# These are backup files generated by rustfmt\n**/*.rs.bk\n\n# build result\n/build/\ndist\n\n.vscode/\n.DS_Store\n.ccls-cache\n\n# dependencies installed by xtask\ndeps\n\n# dependencies installed by node\nnode_modules\n\n# The .gitignore for android is project folder.\n\n# flatpak\n.flatpak*\n\nALVR-Launcher\n\n#allows adding CMake files for some IDEs to parse C++ files correctly\nCMakeLists.txt\ncmake-build-debug/\n\n*.jks"
},
{
"path": ".gitmodules",
"content": "[submodule \"openvr\"]\n\tpath = openvr\n\turl = https://github.com/ValveSoftware/openvr.git\n\tshallow = true\n"
},
{
"path": "CHANGELOG.md",
"content": "# Changelog\n\n## v20.11.0\n\n* Add flatpak launcher (by @failboat78 #2207)\n* Fix Linux/Nvenc error popups (by @failboat78 #2338)\n* Add debug groups (by @zarik5 #2332)\n* Fix black screen on Focus 3 (by @zarik5 #2346)\n* Fix launcher installation popup (by @zarik5 #2356)\n* Fix crash on invalid haptics (by @zarik5 #2355)\n* Rework logging (by @zarik5 #2351)\n* Disable \"Adapt to framerate\" by default (by @zarik5)\n* Show body skeleton in lobby (by @zarik5 #2366)\n* Add multimodal input (by @zarik5 #2367)\n* Fix high CPU usage on Linux (by @The-personified-devil #2372 #2375)\n* Fix stream being half width resolution (by @zarik5 #2378)\n\n## v20.10.0\n\n* Internal refactors of the client graphics (wgpu) and server code architecture (by @zarik5)\n* Fix Quest 3 not supporting 120Hz (by @The-personified-devil)\n* Tracking timing jitter (by @zarik5 #2285)\n* Support VRChat hand tracking (by @ReinaS-64892 @AdalynBlack @zarik5 #2295, @zarik5 #2313 #2323)\n* Fix crash with some games (by @szneqz #2309)\n* Fix crash when shutting down launcher (by @zarik5 #2320)\n* Fix crash with vibration on Focus 3 (by @zarik5 #2324)\n\n### v20.9.1 (2024-07-06)\n\n* Fix performance issues on lobby room.\n\n## v20.9.0 (2024-07-06)\n\n* Display license inside the dashboard (by @zarik5 #2117)\n* Add GPU checks for Linux (by @Meister1593 #2110)\n* Reorder settings (by @zarik5 #2119)\n* Shallow rename \"client\" -> \"device\" (by @zarik5 #2120)\n* Update manifest for AppLab (by @zarik5 #2146)\n* Allow recentering in the lobby (by @zarik5 #2155)\n* Tweak graph labels and colors (by @zarik5 #2176)\n* Fix controller detection on Pico Neo 3 Link (by @HoLo85 #2192)\n* Loosen restrictions on device selection with VoiceMeeter (by @xuan25 #2209)\n* Fix HEVC black screen on Linux/VAAPI (by @Nibor62 #2203)\n* Show hands and controllers in the lobby (by @zarik5 #2218)\n* Add PipeWire support on Linux (by @Meister1593 #1973)\n\n### v20.8.1 (2024-05-08)\n\n* Fix crash on Linux (by @SniperJoe #2108)\n\n## v20.8.0 (2024-05-04)\n\n* Bring back settings tabs (by @Meister1593 #2076)\n* Make FFE shader much lighter (by @yoyobuae #2083)\n* Improve firewall rules on Linux (by @Meister1593 #2078)\n* Fix error message not displaying correctly on Linux sometimes (by @SniperJoe #2088)\n* Fix Nvidia encoder on some Linux systems (by @Xaphiosis @nowrep #2074)\n* Fix client warmstart crash (by @ShootingKing-AM #2084)\n* Fix segfault on Linux (by @SniperJoe #2090)\n* Fix protocol break in v20.7.0 (by @zarik5 2098)\n\n### v20.7.1 (2024-04-11)\n\n* Fix colors on Pico (by @shinyquagsire23 and @zarik5)\n* Fix joystick gesture offset on right hand (by @jarettmillard #2065)\n\n## v20.7.0 (2024-04-06)\n\n* Add AV1 support on Windows/AMD (by @barnabwhy #1967)\n* Add AV1 support on Linux/Nvidia (by @wsippel #1975, @Vixea #1994)\n* Add HDR support on Windows (by @shinyquagsire23 #2030)\n* Add full range encoding support (by @shinyquagsire23 #2011, @Vixea #1971)\n* Fix VAAPI encoder on Intel GPUs (by @nowrep #1981)\n* Add Pre-Analysis support on Windows/AMD (by @barnabwhy #1985)\n* Add linux hardware encoding checks (by @Meister1593 #2042 #2055)\n* Add full body tracking support on Quest (by @barnabwhy #1979, @galister #1984)\n* Fix aux-bones in SteamVR (by @shinyquagsire23 #2009)\n* Make USB connection work when WiFi is disabled (by @Meister1593 #1962)\n* Add mDNS discovery on the server (by @zarik5 #1978)\n* Fix audio when disconnecting headphones in headset (by @Okabintaro #2025 #2040)\n* Add compatibility layer for surround audio devices (by @barnabwhy #2026)\n* Fix black screen on Vive Focus 3, XR Elite (by @zarik5)\n* Fix stuttering on Linux after recentering (by @galister #2017)\n* Fixes for Flatpak (by @jkcdarunday #1980, @Meister1593 #2039 #2044)\n* Change colors of lobby room (by @barnabwhy #1968)\n* Remove WIX installer (by @zarik5)\n* Remove AppImage (by @Meister1593 #2056)\n\n### v20.6.1 (2024-01-26)\n\n* Add AV1 support, only for Linux/VAAPI, with 10bits support (by @wsippel #1955 #1964)\n* Fix image corruption on h264/VAAPI (by @galister / @nowrep #1956)\n\n## v20.6.0 (2024-01-10)\n\n* Add tongue tracking for Quest Pro (by @zarik5)\n * This is a breaking change in the protocol, but only affects Quest Pro users.\n * Only VRCFT ALVR module v1.2.0 and up is supported\n* Add Quest 3 emulation mode + icons for SteamVR HUD (by @Goodguy140 #1926)\n* Add Type of Service (ToS) socket settings, tested only on Linux (by @Vixea #1946)\n* Add software decoding option and fallback (by @20kdc #1933)\n* Add Baseline encoding option for h264 (by @20kdc #1932)\n* Fix ADB connection (by @The-personified-devil #1942)\n* Fix rare bug preventing reconnections on wifi (by @zarik5)\n\n## v20.5.0 (2023-12-05)\n\n* Fix Vulkan layer GPU loading (by @nairaner #1847)\n* Fix dynamic bitrate for VAAPI (by @nowrep #1863)\n* Add notification tips (by @zarik5 #1865)\n* Fix hand tracking for Lynx R1 (by @technobaboo #1874)\n* Various wiki updates\n* Fix battery update during streming (by @zarik5)\n* Fix playspace recentering delay (by @zarik5)\n* Support eye tracking for Pico 4 Pro (by @zarik5 @Meister1593 #1897)\n* Add desktop file for Flatpak (by @Vixea #1906)\n* Install audio dependencies from the setup wizard (by @Meister1593 #1893, @zarik5)\n* Significantly reduce latency with NVENC on Linux (by @nowrep @Xaphiosis #1911)\n* Fix SteamVR hanging when restarting on Linux (by @Vixea @zarik5)\n* Other dashboard updates\n\n### v20.4.3 (2023-10-06)\n\n* Fix dashboard crash on Windows\n* Fix settings reset bug when upgrading (session extrapolation failed)\n\n### v20.4.2 (2023-09-22)\n\n* Fix YVR crash because of invalid controller bindings\n\n### v20.4.1 (2023-09-19)\n\n* Fix inverted `Enable skeleton` switch\n* Add `Only touch` gestures option\n\n## v20.4.0 (2023-09-15)\n\n* Full hand tracking gestures support, with joystick (by @barnabwhy #1794)\n* Fully remappable controller buttons (by @zarik5 #1817)\n* Custom controller profile (by @zarik5)\n* Fix Nvidia support on Linux (by @Killrmemz #1830)\n\n### v20.3.1 (2023-09-11)\n\n* Fix some controller buttons not working\n* Fix changing controller emulation profile not triggering a SteamVR restart\n* Add back Rift S controller emulation profile\n\n## v20.3.0 (2023-09-08)\n\n* Add Lynx R1 headset support (by @zarik5 #1823)\n * Currently there is an issue with hand tracking which is being investigated\n* Make settings sections collapsible (by @zarik5)\n* Other UI tweaks (by @zarik5)\n* *Actually* fix controller freeze (by @zarik5)\n* Fix Pico controller buttons (by @zarik5 @galister @Meister1593 #1820)\n* Fix bitrate hikes when \"Adapt to framerate\" is enabled (by @zarik5)\n* Fix Nvenc encoder on Linux (by @Killrmemz #1824)\n* Timeout connection if lingering (by @zarik5)\n* Fix warmstart crash on client (by @ShootingKing-AM #1813)\n\n### v20.2.1 (2023-08-27)\n\n* Fix VRCFaceTracking mode panicing.\n* (Potential) Fix for dashboard crash on Wayland.\n\n## v20.2.0 (2023-08-26)\n\n* Add Flatpak build (by @CharlieQLe #1683 #1724 #1735 #1742, @Meister1593 #1769)\n* Finish VRCFaceTracking support (by @zarik5)\n * You can download the ALVR Module from the VRCFaceTracking app itself.\n * Only supports the Quest Pro at the moment.\n* New more performant sockets implementation (by @zarik5)\n * Zero copy + zero allocations, and provides better packet prioritization.\n* Avoid controller freezing during high latency (by @zarik5)\n* Add message popups on Linux (disabled on the appimage build) (by @zarik5 #1711)\n* Show backtrace on unhandled exceptions (Windows only) (by @zarik5)\n * Previously these would make SteamVR hard crash without any useful log\n* Optionally show full backtraces for logs (by @zarik5)\n* Add option to select client log level (by zarik5)\n* Make Log tab stick to bottom (by @zarik5)\n* Encoder fixes on Linux (by @nowrep #1751 #1753 #1767 #1768 #1796, @Vixea #1805)\n* Use Constant bitrate mode by default\n* Support rolling video recording (by @zarik5)\n* Fix OpenGL crash on the client (by @ShootingKing-AM #1801)\n* Fix white dashboard bug on Linux (by @zarik5)\n\n## v20.1.0 (2023-06-20)\n\n* Fix firewall rules on Windows (by @zarik5)\n* Fix firewall rules on linux for the tar.gz (by @Vixea #1675)\n* Add bitrate graph (by @zarik5 #1689)\n* Add encoder latency limiter (by @zarik5 #1678)\n* Fix network latency limiter (by @zarik5)\n* Fix image corruption on AMD (by @zarik5 #1681)\n* Fix dashboard audio dropdowns on Linux (by @zarik5)\n* Add connection status for clients (by @zarik5 #1688)\n* Fix HMD plugged status (by @zarik5)\n* Fix crash on some Unreal Engine 5 games (by @deiteris #1685)\n* Add option to disable game render optimization (by @zarik5)\n* Add separate history size for bitrate (by @zarik5)\n\n# v20.0.0 (2023-06-02)\n\n* New OpenXR-based client, add support for Vive Focus 3/XR Elite, Pico 4/Neo 3 and YVR 1/2. Worked on by:\n * @zarik5 #1321\n * @galister #1321, #1442\n * @deiteris #1434, #1439, #1445\n* New egui (OpenGL) dashboard\n * The launcher is replaced by the new dashboard executable.\n * by @Kirottu #1247 #1274, @zarik5, @m00nwtchr #1292, @TheComputerNerd88 #1574 #1575 #1576 1582\n* Add position and rotation recentering modes (by @zarik5 #1321)\n * Defaults to local floor and local yaw.\n* Add support for eye and face tracking (by @zarik5 #1577)\n * Currently supporting VRChat Eye OSC, VRCFaceTracking support coming soon\n* Reduce game rendering latency (by @zarik5)\n* Apply some settings in real-time (by @zarik5 #1635)\n* New more consistent controller prediction algorithm (by @zarik5 #1561)\n* Controller input fixes (by @zarik5 #1560)\n* Soft-toggle controllers at runtime (by @galister #1600)\n* New wiki hosted in the main git tree (by @m00nwtchr #1309)\n* Send client log to streamer (by @zarik5)\n* Encoder improvements (by @nowrep #1562 #1565 #1568, @deiteris #1403 #1422 #1400 #1402, @zarik5 #1564)\n* Remove Forward Error Correction (by @zarik5: #1384, #1389; @deiteris: #1386, #1387, #1390)\n* Unified code for NAL parsing (by @deiteris #1403, #1422, #1400, #1402)\n* Some tweaks for alvr_client_core compatibility (by @ShootingKing-AM #1580 #1578 #1586 #1624 #1621)\n* Fix server build with clang (by @nowrep)\n\n### v19.1.1 (2023-03-03)\n\n* Relax discovery protocol for future ALVR versions\n\n## v19.1.0 (2023-02-14)\n\n* Encoder improvements and new Linux server compositor:\n * @deiteris #1227, #1252, #1281, #1287, #1302, #1304, #1318, #1331, #1336, #1368, #1393, #1367, #1397\n * @Vixea #1227, #1254, #1412\n * @nowrep #1251, #1261, #1253, #1267, #1264, #1266, #1273, #1272, #1277, #1280, #1279, #1278, #1282, #1265, #1294, #1295, #1312, #1314, #1316, #1325, #1328, #1326, #1330, #1334, #1338, #1329, #1346, #1350, #1357, #1352, #1348, #1365, #1349, #1361, #1370, #1372, #1393\n * @m00nwtchr #1347\n * @galister #1428, #1429\n* Controller fixes (by @Timocop #1236 #1241)\n* Vulkan layer fixes (by @nowrep #1291, #1293, #1324, #1339, #1376)\n* Show client IP in the headset and dashboard (by @zarik5)\n* Disable Wi-Fi scans (by @zarik5)\n* Reduce lag after loading screens (by @zarik5)\n* Fix server debug builds (by @nowrep #1288)\n* Add trigger/grip threshold (by @sctanf)\n* Don't spam stdout on Linux (by @nowrep #1317)\n* Fix recentering on Linux (by @nowrep #1353)\n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Style\n\nChecklist for code style. This is on top of common Rust styling rules. These rules are not mandatory but I might point them out if not respected in PRs :) -zarik\n\n## Naming\n\n- Respect Rust naming conventions (not respecting this will cause a warning).\n- Add useful information in the name, with the exception of indices for iterating.\n- Do not put type or scope information in the name.\n- Avoid abbreviations.\n- Avoid prefixes and suffixes.\n- if necessary prefer suffixes rather than prefixes.\n- `_ref` or `_mut` suffixes are accepted when you want to put emphasis on that the variable is a mutable reference, and so assigning values has side effects, even if not consumed later. Suffixes are not needed if the variable is only mutable or instead a immutable reference.\n- Use `maybe_` prefix if the variable is an `Option` or `Result`. Omit if it's clear from the context. Never use it for parameter or field definitions.\n- Shadowing is encouraged.\n- If shadowing cannot be used and two variables have similar meaning but different types, suffix the variable with the least useful or least specialized type with its type. Example:\n\n ```rust\n let myfile_string = \"./file.txt\";\n let myfile = Path::new(my_file_string);\n ```\n\n- If both directory and file paths are used in the same context, suffix directories with `_dir` and files with `_path`. Suffix file names with `_fname`.\n\n## Top level definitions\n\n- For each file, define in order: private imports, public imports, ffi bindings import, private constants, public constants, private structs, public structs, private top level functions, public top level functions.\n\n### Imports\n\n- Do not leave spaces between imports, only between the private and public import blocks.\n- Define imports in alphabetical order (use cargo fmt).\n- Group imports using braces when there are common parts of the path.\n\n### Structs\n\n- Prefer adding trait bounds to the impl type parameters instead of struct type parameters\n- Define in order: struct, Default impl, custom impl, Drop impl, all in the same module. Do not split the custom impl.\n\n## Spacing\n\nSmartly use empty newlines between blocks of code to improve legibility\n\n- Rust recommends not to specify the return keyword when returning at the end of a function. To put emphasis on the return expression, isolate it with a empty new line just before.\n- Inside each block (function, if/else/while/for etc or just braces) make so that there are roughly 2 to 6 blocks of code separated by empty lines for the amount of code that fits in a single screen (long functions that span multiple screens can have way more than 6 block). Check existing codebase for an example.\n- Spaces between groups of statements should be done so the groups are similar is size and that each achieves a specific purpose. You should be able to easily describe what the group does in few words, even if you don't comment it (because the meaning should be self evident).\n- Do not define variables at the start of the function/block, but do define them at the start of the functional group delimited by spaces.\n\n## Comments\n\n- It's important to use comments when the meaning or inner workings of a piece of code is not clear from the context. Well-named symbols (variables and functions) are often enough. In doubt do use comments.\n- Do not add comments about how certain parts of the language/std library work, unless it's about quirks of features.\n\n## Panicking and error handling\n\n- Use of `panic!()` is discouraged\n- When matching exhaustively, prefer `unreachable!()` over `panic!()` for certain branches.\n- `unwrap()` is discouraged, but prefer `unwrap()` over `expect()` (bubble up the error instead).\n- Prefer `.get()` to index a collection rather than `[]`, unless extremely certain it will never index out of bounds.\n- Add a `// # Safety` comment before a statement that contains a `unwrap()` or raw indexing, explaining why it should never crash.\n- Use `todo!()` to mark unfinished code (it returns `!` and so it helps with the missing return statement).\n\n## Code repetition and maintainability\n\n- Lean towards the DRY rule, without overdoing it.\n- Extract a piece of code (in a function or lambda) only when it is used two or more times and it doesn't depend on many parameters.\n- Always extract constants for \"arbitrary\" values (literals) which are chosen with no absolute rule and makes sense to change in the future. Example: time interval between resending discovery packet. Opposite example: number of eyes on a human head (it's always going to be 2, no need to use a constant to change its value in the future :) ).\n- Prefer defining constants at the start of the file, even if used locally in a single function.\n- Prefer using \"complex\" types for constants, if the std library allows it. Example: prefer using `Duration` instead of an integer type if the constant represents a time duration. Same with `Path` vs string.\n\n## Structural soundness\n\n- Try to avoid invalid states in the data, using Rust enums. Example: do not use `resumed` + `streaming` boolean variables if the state `resumed == false` + `streaming == true` is invalid. Instead use `enum State { Paused, Resumed, Streaming }`.\n- Make full use of pattern matching with `if let` and `while let`, this reduces the use of `unwrap()`.\n"
},
{
"path": "Cargo.toml",
"content": "[workspace]\nresolver = \"2\"\nmembers = [\"alvr/*\"]\n\n[workspace.package]\nversion = \"21.0.0-dev12\"\nedition = \"2024\"\nrust-version = \"1.88\"\nauthors = [\"alvr-org\"]\nlicense = \"MIT\"\n\n[workspace.dependencies]\nalvr_adb = { path = \"alvr/adb\" }\nalvr_audio = { path = \"alvr/audio\" }\nalvr_client_core = { path = \"alvr/client_core\" }\nalvr_common = { path = \"alvr/common\" }\nalvr_events = { path = \"alvr/events\" }\nalvr_filesystem = { path = \"alvr/filesystem\" }\nalvr_graphics = { path = \"alvr/graphics\" }\nalvr_gui_common = { path = \"alvr/gui_common\" }\nalvr_packets = { path = \"alvr/packets\" }\nalvr_server_core = { path = \"alvr/server_core\"}\nalvr_server_io = { path = \"alvr/server_io\" }\nalvr_session = { path = \"alvr/session\" }\nalvr_sockets = { path = \"alvr/sockets\" }\nalvr_system_info = { path = \"alvr/system_info\" }\n\n[profile.release]\ndebug = \"limited\"\nstrip = false\n\n[profile.distribution]\ninherits = \"release\"\nlto = true\n"
},
{
"path": "LICENSE",
"content": "Copyright (c) 2018-2019 polygraphene\nCopyright (c) 2020-2024 alvr-org\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE."
},
{
"path": "README.md",
"content": " ![](\"resources/ALVR-Grey.svg\"/)
\n\n# ALVR - Air Light VR\n\n[![badge-discord][]][link-discord] [![badge-matrix][]][link-matrix] [![badge-opencollective][]][link-opencollective]\n\nStream VR games from your PC to your headset over Wi-Fi. \nThis is a fork of [ALVR](https://github.com/polygraphene/ALVR).\n\n### Direct download (latest version):\n### [Windows Launcher](https://github.com/alvr-org/ALVR/releases/latest/download/alvr_launcher_windows.zip) | [Linux Launcher](https://github.com/alvr-org/ALVR/releases/latest/download/alvr_launcher_linux.tar.gz)\n\n## Compatibility\n\n| VR Headset | Support |\n| :--------------------------: | :------------------------------------------------------------------------------------: |\n| Apple Vision Pro | :heavy_check_mark: ([store link](https://apps.apple.com/app/alvr/id6479728026)) |\n| Quest 1/2/3/3S/Pro | :heavy_check_mark: ([store link](https://www.meta.com/experiences/7674846229245715) *) |\n| Pico Neo 3/4/4 Ultra | :heavy_check_mark: |\n| Play For Dream YVR 1/2/MR | :heavy_check_mark: |\n| Vive Focus 3/Vision/XR Elite | :heavy_check_mark: |\n| Lynx R1 | :heavy_check_mark: |\n| PhoneVR (smartphone) | :heavy_check_mark: ** ([repo](https://github.com/PhoneVR-Developers/PhoneVR)) |\n| Android/Monado | :warning: ** |\n| Oculus Go | :x: ([old repo](https://github.com/polygraphene/ALVR)) |\n\n\\* ALVR for Quest 1 is not available through the Meta store. \n\\** Works on some smartphones, but has not been extensively tested. \n\n| PC OS | Support |\n| :------------: | :---------------------------------------------------------------------------: |\n| Windows 10/11 | :heavy_check_mark: ([store link](https://store.steampowered.com/app/3312710)) |\n| Windows XP/7/8 | :x: |\n| Linux | :heavy_check_mark:*** |\n| macOS | :x: |\n\n\\*** Please check the wiki for detailed compatibility information.\n\n### Requirements\n\n- A supported standalone VR headset (see compatibility table above).\n- SteamVR.\n- A high-end gaming PC:\n - See the OS compatibility table above.\n - NVIDIA GPU with NVENC support (GTX 1000 series or newer), an AMD GPU with AMF VCE support, or an INTEL GPU with VPL support (Arc, Tiger Lake or newer), with the latest drivers.\n - On laptops with both an integrated GPU (Intel HD, AMD iGPU) and a dedicated GPU (NVIDIA GTX/RTX, AMD HD/R5/R7), make sure to assign the dedicated GPU (or \"high performance graphics adapter\") to ALVR and SteamVR for the best performance and compatibility. \n (NVIDIA: Nvidia Control Panel → 3D Settings → Application Settings; AMD: similar method)\n\n- Network:\n - 802.11ac 5 GHz Wi-Fi for the headset, and wired Ethernet for the PC is recommended.\n - The PC and the headset must be connected to the same router (or use a routed connection as described [here](https://github.com/alvr-org/ALVR/wiki/ALVR-v14-and-Above)).\n\n## Installation\n\nFollow the [installation guide](https://github.com/alvr-org/ALVR/wiki/Installation-guide).\n\n## Troubleshooting\n\n- See the [Troubleshooting](https://github.com/alvr-org/ALVR/wiki/Troubleshooting) page, and [Linux Troubleshooting](https://github.com/alvr-org/ALVR/wiki/Linux-Troubleshooting) if applicable.\n- Configuration recommendations and additional information can be found [here](https://github.com/alvr-org/ALVR/wiki/Information-and-Recommendations).\n\n## Uninstallation\n\nOpen `ALVR Dashboard.exe`, go to the `Installation` tab, then press `Remove firewall rules`. \nClose the ALVR window and delete the ALVR folder.\n\n## Build from Source\n\nFollow the [build guide](https://github.com/alvr-org/ALVR/wiki/Building-From-Source).\n\n## License\n\nALVR is licensed under the [MIT License](LICENSE).\n\n## Privacy Policy\n\nALVR apps do not directly collect any personal data.\n\n## Donate\n\nIf you would like to support this project, you can donate through our [Open Source Collective account](https://opencollective.com/alvr).\n\n[badge-discord]: https://img.shields.io/discord/720612397580025886?style=for-the-badge&logo=discord&color=5865F2 \"Join us on Discord\"\n[link-discord]: https://discord.gg/ALVR\n[badge-matrix]: https://img.shields.io/static/v1?label=chat&message=%23alvr&style=for-the-badge&logo=matrix&color=blueviolet \"Join us on Matrix\"\n[link-matrix]: https://matrix.to/#/#alvr:ckie.dev?via=ckie.dev\n[badge-opencollective]: https://img.shields.io/opencollective/all/alvr?style=for-the-badge&logo=opencollective&color=79a3e6 \"Donate\"\n[link-opencollective]: https://opencollective.com/alvr\n"
},
{
"path": "about.toml",
"content": "accepted = [\n \"MIT\",\n \"Apache-2.0\",\n \"Apache-2.0 WITH LLVM-exception\",\n \"BSD-2-Clause\",\n \"BSD-3-Clause\",\n \"BSL-1.0\",\n \"bzip2-1.0.6\",\n \"CC0-1.0\",\n \"CDLA-Permissive-2.0\",\n \"ISC\",\n \"LicenseRef-UFL-1.0\",\n \"MPL-2.0\",\n \"OFL-1.1\",\n \"OpenSSL\",\n \"Ubuntu-font-1.0\",\n \"Unicode-DFS-2016\",\n \"Unicode-3.0\",\n \"Unlicense\",\n \"Zlib\",\n \"zlib-acknowledgement\",\n]\ntargets = [\n \"x86_64-pc-windows-msvc\",\n \"x86_64-unknown-linux-gnu\",\n \"aarch64-linux-android\",\n \"wasm32-unknown-unknown\",\n]\nworkarounds = [\"ring\"]\nfilter-noassertion = true\n"
},
{
"path": "alvr/adb/Cargo.toml",
"content": "[package]\nname = \"alvr_adb\"\nversion.workspace = true\nedition.workspace = true\nrust-version.workspace = true\nauthors.workspace = true\nlicense.workspace = true\n\n[dependencies]\nalvr_common.workspace = true\nalvr_filesystem.workspace = true\nalvr_system_info.workspace = true\nalvr_session.workspace = true\n\nanyhow = \"1\"\nureq = \"3\"\nzip = \"4\"\n"
},
{
"path": "alvr/adb/src/commands.rs",
"content": "// https://android.googlesource.com/platform/packages/modules/adb/+/refs/heads/main/docs/user/adb.1.md\n\nuse crate::parse::{self, Device, ForwardedPorts};\nuse alvr_filesystem as afs;\nuse anyhow::{Context, Result, anyhow};\nuse std::{\n collections::HashSet,\n io::{Cursor, Read},\n process::Command,\n str::FromStr,\n time::Duration,\n};\nuse zip::ZipArchive;\n\n#[cfg(windows)]\nuse std::os::windows::process::CommandExt;\n\n// https://developer.android.com/tools/releases/platform-tools#revisions\n// NOTE: At the time of writing this comment, the revisions section above\n// shows the latest version as 35.0.2, but the latest that can be downloaded\n// by specifying a version is 35.0.0\nconst PLATFORM_TOOLS_VERSION: &str = \"-latest\"; // E.g. \"_r35.0.0\"\n\n#[cfg(target_os = \"linux\")]\nconst PLATFORM_TOOLS_OS: &str = \"linux\";\n#[cfg(target_os = \"macos\")]\nconst PLATFORM_TOOLS_OS: &str = \"darwin\";\n#[cfg(windows)]\nconst PLATFORM_TOOLS_OS: &str = \"windows\";\n\nconst REQUEST_TIMEOUT: Duration = Duration::from_secs(5);\n\nfn get_command(adb_path: &str, args: &[&str]) -> Command {\n let mut command = Command::new(adb_path);\n command.args(args);\n\n #[cfg(windows)]\n command.creation_flags(0x08000000); // CREATE_NO_WINDOW\n\n command\n}\n\npub fn download(url: &str, progress_callback: impl Fn(usize, Option)) -> Result> {\n let agent: ureq::Agent = ureq::Agent::config_builder()\n .timeout_global(Some(REQUEST_TIMEOUT))\n .build()\n .into();\n let response = agent.get(url).call()?;\n let maybe_expected_size = response\n .headers()\n .get(\"Content-Length\")\n .and_then(|v| v.to_str().ok()?.parse::().ok());\n let mut result = maybe_expected_size\n .map(Vec::with_capacity)\n .unwrap_or_default();\n let mut reader = response.into_body().into_reader();\n let mut buffer = vec![0; 65535];\n loop {\n let read_count: usize = reader.read(&mut buffer)?;\n if read_count == 0 {\n break;\n }\n result.extend_from_slice(&buffer[..read_count]);\n let current_size = result.len();\n (progress_callback)(current_size, maybe_expected_size);\n }\n\n Ok(result)\n}\n\n///////////\n// Activity\n\npub fn get_process_id(\n adb_path: &str,\n device_serial: &str,\n process_name: &str,\n) -> Result> {\n let output = get_command(\n adb_path,\n &[\"-s\", device_serial, \"shell\", \"pidof\", process_name],\n )\n .output()\n .context(format!(\"Failed to get ID of process {process_name}\"))?;\n let text = String::from_utf8_lossy(&output.stdout).trim().to_owned();\n if text.is_empty() {\n return Ok(None);\n }\n let process_id = text\n .parse::()\n .context(\"Failed to parse process ID\")?;\n\n Ok(Some(process_id))\n}\n\npub fn is_activity_resumed(\n adb_path: &str,\n device_serial: &str,\n activity_name: &str,\n) -> Result {\n let output = get_command(\n adb_path,\n &[\n \"-s\",\n device_serial,\n \"shell\",\n \"dumpsys\",\n \"activity\",\n activity_name,\n ],\n )\n .output()\n .context(format!(\"Failed to get state of activity {activity_name}\"))?;\n let text = String::from_utf8_lossy(&output.stdout);\n if let Some(line) = text\n .lines()\n .map(|l| l.trim())\n .find(|l| l.contains(\"mResumed\"))\n {\n let (entry, _) = line\n .split_once(' ')\n .ok_or(anyhow!(\"Failed to split resumed state line\"))?;\n let (_, value) = entry\n .split_once('=')\n .ok_or(anyhow!(\"Failed to split resumed state entry\"))?;\n match value {\n \"true\" => Ok(true),\n \"false\" => Ok(false),\n _ => Err(anyhow!(\"Failed to parse resumed state value\"))?,\n }\n } else {\n Err(anyhow!(\"Failed to find resumed state line\"))\n }\n}\n\n///////////////////\n// ADB Installation\n\npub fn require_adb(\n layout: &afs::Layout,\n progress_callback: impl Fn(usize, Option),\n) -> Result {\n if let Some(path) = get_adb_path(layout) {\n Ok(path)\n } else {\n install_adb(layout, progress_callback).context(\"Failed to install ADB\")?;\n Ok(get_adb_path(layout).context(\"Failed to get ADB path after installation\")?)\n }\n}\n\nfn install_adb(\n layout: &afs::Layout,\n progress_callback: impl Fn(usize, Option),\n) -> Result<()> {\n let mut reader = Cursor::new(download_adb(progress_callback)?);\n ZipArchive::new(&mut reader)?.extract(layout.executables_dir.clone())?;\n\n Ok(())\n}\n\nfn download_adb(progress_callback: impl Fn(usize, Option)) -> Result> {\n let url = get_platform_tools_url();\n\n download(&url, progress_callback).context(format!(\"Failed to download ADB from {url}\"))\n}\n\nfn get_platform_tools_url() -> String {\n format!(\n \"https://dl.google.com/android/repository/platform-tools{PLATFORM_TOOLS_VERSION}-{PLATFORM_TOOLS_OS}.zip\"\n )\n}\n\n///////////////\n// Applications\n\npub fn start_application(adb_path: &str, device_serial: &str, application_id: &str) -> Result<()> {\n get_command(\n adb_path,\n &[\n \"-s\",\n device_serial,\n \"shell\",\n \"monkey\",\n \"-p\",\n application_id,\n \"1\",\n ],\n )\n .output()\n .context(format!(\"Failed to start {application_id}\"))?;\n\n Ok(())\n}\n\n//////////\n// Devices\n\npub fn list_devices(adb_path: &str) -> Result> {\n let output = get_command(adb_path, &[\"devices\", \"-l\"])\n .output()\n .context(\"Failed to list ADB devices\")?;\n let text = String::from_utf8_lossy(&output.stdout);\n let devices = text\n .lines()\n .skip(1)\n .filter_map(parse::parse_device)\n .collect();\n\n Ok(devices)\n}\n\n///////////\n// Packages\n\npub fn install_package(adb_path: &str, device_serial: &str, apk_path: &str) -> Result<()> {\n get_command(adb_path, &[\"-s\", device_serial, \"install\", \"-r\", apk_path])\n .output()\n .context(format!(\"Failed to install {apk_path}\"))?;\n\n Ok(())\n}\n\npub fn is_package_installed(\n adb_path: &str,\n device_serial: &str,\n application_id: &str,\n) -> Result {\n let found = list_installed_packages(adb_path, device_serial)\n .context(format!(\n \"Failed to check if package {application_id} is installed\"\n ))?\n .contains(application_id);\n\n Ok(found)\n}\n\npub fn uninstall_package(adb_path: &str, device_serial: &str, application_id: &str) -> Result<()> {\n get_command(\n adb_path,\n &[\"-s\", device_serial, \"uninstall\", application_id],\n )\n .output()\n .context(format!(\"Failed to uninstall {application_id}\"))?;\n\n Ok(())\n}\n\npub fn list_installed_packages(adb_path: &str, device_serial: &str) -> Result> {\n let output = get_command(\n adb_path,\n &[\"-s\", device_serial, \"shell\", \"pm\", \"list\", \"package\"],\n )\n .output()\n .context(\"Failed to list installed packages\")?;\n let text = String::from_utf8_lossy(&output.stdout);\n let packages = text.lines().map(|l| l.replace(\"package:\", \"\")).collect();\n\n Ok(packages)\n}\n\n////////\n// Paths\n\n/// Returns the path of a local (i.e. installed by ALVR) or OS version of `adb` if found, `None` otherwise.\npub fn get_adb_path(layout: &afs::Layout) -> Option {\n let exe_name = afs::exec_fname(\"adb\").to_owned();\n let adb_path = get_command(&exe_name, &[])\n .output()\n .is_ok()\n .then_some(exe_name);\n\n adb_path.or_else(|| {\n let path = layout.local_adb_exe();\n\n path.try_exists()\n .unwrap_or(false)\n .then(|| path.to_string_lossy().to_string())\n })\n}\n\n////////\n// Utility\npub fn get_uptime(adb_path: &str, device_serial: &str) -> Result {\n let output = get_command(\n adb_path,\n &[\"-s\", device_serial, \"shell\", \"cat\", \"/proc/uptime\"],\n )\n .output()\n .context(\"Failed to get system uptime\")?;\n\n let output_str = String::from_utf8_lossy(&output.stdout);\n\n let uptime_string = output_str\n .split_ascii_whitespace()\n .next()\n .context(\"Empty result from /proc/uptime\")?;\n\n let uptime = f64::from_str(uptime_string).context(\"Cannot parse uptime into an f64\")?;\n\n Duration::try_from_secs_f64(uptime).context(\"Invalid f64 value for a duration \")\n}\n\n//////////////////\n// Port forwarding\n\npub fn list_forwarded_ports(adb_path: &str, device_serial: &str) -> Result> {\n let output = get_command(adb_path, &[\"-s\", device_serial, \"forward\", \"--list\"])\n .output()\n .context(format!(\n \"Failed to list forwarded ports of device {device_serial:?}\"\n ))?;\n let text = String::from_utf8_lossy(&output.stdout);\n let forwarded_ports = text\n .lines()\n .filter_map(parse::parse_forwarded_ports)\n .collect();\n\n Ok(forwarded_ports)\n}\n\npub fn forward_port(adb_path: &str, device_serial: &str, port: u16) -> Result<()> {\n get_command(\n adb_path,\n &[\n \"-s\",\n device_serial,\n \"forward\",\n &format!(\"tcp:{port}\"),\n &format!(\"tcp:{port}\"),\n ],\n )\n .output()\n .context(format!(\n \"Failed to forward port {port:?} of device {device_serial:?}\"\n ))?;\n\n Ok(())\n}\n\n/////////\n// Server\n\npub fn kill_server(adb_path: &str) -> Result<()> {\n get_command(adb_path, &[\"kill-server\"])\n .output()\n .context(\"Failed to kill ADB server\")?;\n\n Ok(())\n}\n"
},
{
"path": "alvr/adb/src/lib.rs",
"content": "pub mod commands;\nmod parse;\n\nuse alvr_common::anyhow::Result;\nuse alvr_common::{dbg_connection, error, warn};\nuse alvr_session::WiredClientAutoLaunchConfig;\nuse alvr_system_info::{\n ClientFlavor, PACKAGE_NAME_GITHUB_DEV, PACKAGE_NAME_GITHUB_STABLE, PACKAGE_NAME_STORE,\n};\nuse std::collections::HashSet;\nuse std::time::Duration;\n\npub enum WiredConnectionStatus {\n Ready,\n NotReady(String),\n}\n\npub struct WiredConnection {\n adb_path: String,\n}\n\nimpl WiredConnection {\n pub fn new(\n layout: &alvr_filesystem::Layout,\n download_progress_callback: impl Fn(usize, Option),\n ) -> Result {\n let adb_path = commands::require_adb(layout, download_progress_callback)?;\n\n Ok(Self { adb_path })\n }\n\n pub fn setup(\n &self,\n control_port: u16,\n stream_port: u16,\n client_type: &ClientFlavor,\n client_autolaunch: Option,\n ) -> Result {\n let Some(device_serial) = commands::list_devices(&self.adb_path)?\n .into_iter()\n .filter_map(|d| d.serial)\n .find(|s| !s.starts_with(\"127.0.0.1\"))\n else {\n return Ok(WiredConnectionStatus::NotReady(\n \"No wired devices found\".to_owned(),\n ));\n };\n\n let ports = HashSet::from([control_port, stream_port]);\n let forwarded_ports: HashSet =\n commands::list_forwarded_ports(&self.adb_path, &device_serial)?\n .into_iter()\n .map(|f| f.local)\n .collect();\n let missing_ports = ports.difference(&forwarded_ports);\n for port in missing_ports {\n commands::forward_port(&self.adb_path, &device_serial, *port)?;\n dbg_connection!(\n \"setup_wired_connection: Forwarded port {port} of device {device_serial}\"\n );\n }\n\n let Some(process_name) = get_process_name(&self.adb_path, &device_serial, client_type)\n else {\n return Ok(WiredConnectionStatus::NotReady(\n \"No suitable ALVR client is installed\".to_owned(),\n ));\n };\n\n if commands::get_process_id(&self.adb_path, &device_serial, &process_name)?.is_none() {\n if let Some(client_autolaunch) = client_autolaunch {\n if client_autolaunch.boot_delay > 0 {\n match commands::get_uptime(&self.adb_path, &device_serial) {\n Ok(uptime) => {\n if uptime < Duration::from_secs(client_autolaunch.boot_delay.into()) {\n return Ok(WiredConnectionStatus::NotReady(\n \"Waiting for device boot\".to_owned(),\n ));\n }\n }\n Err(failure) => {\n warn!(\"wired_connection: get_uptime failed with {}\", failure);\n }\n }\n }\n\n commands::start_application(&self.adb_path, &device_serial, &process_name)?;\n Ok(WiredConnectionStatus::NotReady(\n \"Starting ALVR client\".to_owned(),\n ))\n } else {\n Ok(WiredConnectionStatus::NotReady(\n \"ALVR client is not running\".to_owned(),\n ))\n }\n } else if !commands::is_activity_resumed(&self.adb_path, &device_serial, &process_name)? {\n Ok(WiredConnectionStatus::NotReady(\n \"ALVR client is paused\".to_owned(),\n ))\n } else {\n Ok(WiredConnectionStatus::Ready)\n }\n }\n}\n\nimpl Drop for WiredConnection {\n fn drop(&mut self) {\n dbg_connection!(\"wired_connection: Killing ADB server\");\n if let Err(e) = commands::kill_server(&self.adb_path) {\n error!(\"{e:?}\");\n }\n }\n}\n\npub fn get_process_name(\n adb_path: &str,\n device_serial: &str,\n flavor: &ClientFlavor,\n) -> Option {\n let fallbacks = match flavor {\n ClientFlavor::Store => {\n if alvr_common::is_stable() {\n vec![PACKAGE_NAME_STORE, PACKAGE_NAME_GITHUB_STABLE]\n } else {\n vec![PACKAGE_NAME_GITHUB_DEV]\n }\n }\n ClientFlavor::Github => {\n if alvr_common::is_stable() {\n vec![PACKAGE_NAME_GITHUB_STABLE, PACKAGE_NAME_STORE]\n } else {\n vec![PACKAGE_NAME_GITHUB_DEV]\n }\n }\n ClientFlavor::Custom(name) => {\n if alvr_common::is_stable() {\n vec![name, PACKAGE_NAME_STORE, PACKAGE_NAME_GITHUB_STABLE]\n } else {\n vec![name, PACKAGE_NAME_GITHUB_DEV]\n }\n }\n };\n\n fallbacks\n .iter()\n .find(|name| {\n commands::is_package_installed(adb_path, device_serial, name)\n .is_ok_and(|installed| installed)\n })\n .map(|name| (*name).to_string())\n}\n"
},
{
"path": "alvr/adb/src/parse.rs",
"content": "// https://cs.android.com/android/platform/superproject/main/+/7dbe542b9a93fb3cee6c528e16e2d02a26da7cc0:packages/modules/adb/transport.cpp;l=1409\n// The serial number is printed with a \"%-22s\" format, meaning that it's a left-aligned space-padded string of 22 characters.\nconst SERIAL_NUMBER_COLUMN_LENGTH: usize = 22;\n\n// https://cs.android.com/android/platform/superproject/main/+/7dbe542b9a93fb3cee6c528e16e2d02a26da7cc0:packages/modules/adb/adb.h;l=104-122\n#[derive(Debug)]\npub enum ConnectionState {\n Authorizing,\n Bootloader,\n Connecting,\n Detached,\n Device,\n Host,\n NoPermissions, // https://cs.android.com/android/platform/superproject/main/+/main:system/core/diagnose_usb/diagnose_usb.cpp;l=83-90\n Offline,\n Recovery,\n Rescue,\n Sideload,\n Unauthorized,\n}\n\npub fn parse_connection_state(value: &str) -> Option {\n match value {\n \"authorizing\" => Some(ConnectionState::Authorizing),\n \"bootloader\" => Some(ConnectionState::Bootloader),\n \"connecting\" => Some(ConnectionState::Connecting),\n \"detached\" => Some(ConnectionState::Detached),\n \"device\" => Some(ConnectionState::Device),\n \"host\" => Some(ConnectionState::Host),\n \"offline\" => Some(ConnectionState::Offline),\n \"recovery\" => Some(ConnectionState::Recovery),\n \"rescue\" => Some(ConnectionState::Rescue),\n \"sideload\" => Some(ConnectionState::Sideload),\n \"unauthorized\" => Some(ConnectionState::Unauthorized),\n _ => None,\n }\n}\n\nfn parse_pair(pair: &str) -> Option {\n let mut slice = pair.split(':');\n let _key = slice.next();\n\n slice.next().map(|value| value.to_string())\n}\n\n// https://cs.android.com/android/platform/superproject/main/+/7dbe542b9a93fb3cee6c528e16e2d02a26da7cc0:packages/modules/adb/adb.h;l=95-100\n#[derive(Debug)]\npub enum TransportType {\n Usb,\n Local,\n Any,\n Host,\n}\n\npub fn parse_transport_type(pair: &str) -> Option {\n let mut slice = pair.split(':');\n let _key = slice.next();\n\n if let Ok(value) = slice.next()?.parse::() {\n match value {\n 0 => Some(TransportType::Usb),\n 1 => Some(TransportType::Local),\n 2 => Some(TransportType::Any),\n 3 => Some(TransportType::Host),\n _ => None,\n }\n } else {\n None\n }\n}\n\n// https://cs.android.com/android/platform/superproject/main/+/7dbe542b9a93fb3cee6c528e16e2d02a26da7cc0:packages/modules/adb/transport.cpp;l=1398\n#[derive(Debug)]\npub struct Device {\n pub connection_state: Option,\n pub device: Option,\n pub model: Option,\n pub product: Option,\n pub serial: Option,\n pub transport_type: Option,\n}\n\npub fn parse_device(line: &str) -> Option {\n if line.len() < SERIAL_NUMBER_COLUMN_LENGTH {\n return None;\n }\n let (left, right) = line.split_at(SERIAL_NUMBER_COLUMN_LENGTH);\n let serial = (!left.contains(\"(no serial number)\")).then(|| left.trim().to_owned());\n let mut remaining = right.trim();\n\n let connection_state = if remaining.starts_with(\"no permissions\") {\n // Since the current user's name can be printed in the error message,\n // we are gambling that there's not a \"]\" in it.\n if let Some((_, right)) = remaining.split_once(']') {\n remaining = right;\n Some(ConnectionState::NoPermissions)\n } else {\n None\n }\n } else if let Some((left, right)) = remaining.split_once(' ') {\n remaining = right;\n parse_connection_state(left)\n } else {\n None\n };\n\n let mut slices = remaining.split_whitespace();\n let product = slices.next().and_then(parse_pair);\n let model = slices.next().and_then(parse_pair);\n let device = slices.next().and_then(parse_pair);\n let transport_type = slices.next().and_then(parse_transport_type);\n\n Some(Device {\n connection_state,\n device,\n model,\n product,\n serial,\n transport_type,\n })\n}\n\n#[derive(Debug)]\npub struct ForwardedPorts {\n pub local: u16,\n pub remote: u16,\n pub serial: String,\n}\n\npub fn parse_forwarded_ports(line: &str) -> Option {\n let mut slices = line.split_whitespace();\n let serial = slices.next();\n let local = parse_port(slices.next()?);\n let remote = parse_port(slices.next()?);\n\n if let Some(serial) = serial\n && let Some(local) = local\n && let Some(remote) = remote\n {\n Some(ForwardedPorts {\n local,\n remote,\n serial: serial.to_owned(),\n })\n } else {\n None\n }\n}\n\nfn parse_port(value: &str) -> Option {\n let mut slices = value.split(':');\n let _protocol = slices.next();\n let maybe_port = slices.next();\n\n maybe_port.and_then(|p| p.parse::().ok())\n}\n"
},
{
"path": "alvr/audio/Cargo.toml",
"content": "[package]\nname = \"alvr_audio\"\nversion.workspace = true\nedition.workspace = true\nrust-version.workspace = true\nauthors.workspace = true\nlicense.workspace = true\n\n[dependencies]\nalvr_common.workspace = true\nalvr_session.workspace = true\nalvr_sockets.workspace = true\n\ncpal = \"0.16\"\nrodio = \"0.21\"\nserde = \"1\"\n\n[target.'cfg(windows)'.dependencies]\nwidestring = \"1\"\nwindows = { version = \"0.61\", features = [\n \"Win32_Devices_FunctionDiscovery\",\n \"Win32_Foundation\",\n \"Win32_Media_Audio_Endpoints\",\n \"Win32_System_Com_StructuredStorage\",\n \"Win32_System_Variant\",\n \"Win32_UI_Shell_PropertiesSystem\",\n] }\n\n[target.'cfg(target_os = \"linux\")'.dependencies]\npipewire = { version = \"0.8.0\", features = [\"v0_3_49\"] }\nlibspa-sys = \"0.8.0\"\n"
},
{
"path": "alvr/audio/src/lib.rs",
"content": "#[cfg(windows)]\nmod windows;\n\n#[cfg(target_os = \"linux\")]\npub mod linux;\n\n#[cfg(windows)]\npub use crate::windows::*;\n\nuse alvr_common::{\n ConnectionError, ToAny,\n anyhow::{self, Context, Result, bail},\n info,\n parking_lot::Mutex,\n};\nuse alvr_session::{AudioBufferingConfig, CustomAudioDeviceConfig, MicrophoneDevicesConfig};\nuse alvr_sockets::{StreamReceiver, StreamSender};\nuse cpal::{\n BufferSize, Host, Sample, SampleFormat, StreamConfig,\n traits::{DeviceTrait, HostTrait, StreamTrait},\n};\nuse rodio::{OutputStreamBuilder, Source};\nuse std::{collections::VecDeque, sync::Arc, thread, time::Duration};\n\npub use cpal::Device;\n\nfn device_from_custom_config(\n host: &Host,\n config: &CustomAudioDeviceConfig,\n is_output: bool,\n) -> Result {\n let mut devices = if is_output {\n host.output_devices()?\n } else {\n host.input_devices()?\n };\n\n Ok(match config {\n CustomAudioDeviceConfig::NameSubstring(name_substring) => devices\n .find(|d| {\n d.name()\n .map(|name| name.to_lowercase().contains(&name_substring.to_lowercase()))\n .unwrap_or(false)\n })\n .with_context(|| {\n format!(\"Cannot find audio device which name contains \\\"{name_substring}\\\"\")\n })?,\n CustomAudioDeviceConfig::Index(index) => devices\n .nth(*index)\n .with_context(|| format!(\"Cannot find audio device at index {index}\"))?,\n })\n}\n\npub fn new_output(config: Option<&CustomAudioDeviceConfig>) -> Result {\n let host = cpal::default_host();\n\n let device = match config {\n None => host\n .default_output_device()\n .context(\"No output audio device found\")?,\n Some(config) => device_from_custom_config(&host, config, true)?,\n };\n\n Ok(device)\n}\n\npub fn new_input(config: Option) -> Result {\n let host = cpal::default_host();\n\n let device = match config {\n None => host\n .default_input_device()\n .context(\"No input audio device found\")?,\n Some(config) => device_from_custom_config(&host, &config, false)?,\n };\n\n Ok(device)\n}\n\n// returns (sink, source)\npub fn new_virtual_microphone_pair(config: MicrophoneDevicesConfig) -> Result<(Device, Device)> {\n // No-op on Windows (this is windows specific code)\n let host = cpal::default_host();\n\n let (sink_name, source_name) = match config {\n MicrophoneDevicesConfig::Automatic => {\n // NOTE: This will iterate over all devices for every option it tries, if the audio\n // code is slow, change that first\n return [\n MicrophoneDevicesConfig::VAC,\n MicrophoneDevicesConfig::VBCable,\n MicrophoneDevicesConfig::VoiceMeeter,\n MicrophoneDevicesConfig::VoiceMeeterAux,\n MicrophoneDevicesConfig::VoiceMeeterVaio3,\n ]\n .into_iter()\n .find_map(|cable_type| new_virtual_microphone_pair(cable_type).ok())\n .context(\"No microphones found\");\n }\n\n MicrophoneDevicesConfig::VAC => (\"Line 1\", \"Line 1\"),\n MicrophoneDevicesConfig::VBCable => (\"CABLE Input\", \"CABLE Output\"),\n MicrophoneDevicesConfig::VoiceMeeter => (\"VoiceMeeter Input\", \"VoiceMeeter Output\"),\n MicrophoneDevicesConfig::VoiceMeeterAux => {\n (\"VoiceMeeter Aux Input\", \"VoiceMeeter Aux Output\")\n }\n MicrophoneDevicesConfig::VoiceMeeterVaio3 => {\n (\"VoiceMeeter VAIO3 Input\", \"VoiceMeeter VAIO3 Output\")\n }\n\n MicrophoneDevicesConfig::Custom { sink, source } => {\n return Ok((\n device_from_custom_config(&host, &sink, true)?,\n device_from_custom_config(&host, &source, false)?,\n ));\n }\n };\n\n let sink = host\n .output_devices()?\n .find(|d| d.name().unwrap_or_default().contains(sink_name))\n .context(\"Virtual Audio Cable, VB-CABLE or VoiceMeeter not found. Please install or reinstall one\")?;\n\n let source = host\n .input_devices()?\n .find(|d| d.name().unwrap_or_default().contains(source_name))\n .context(\"Matching output microphone not found. Did you rename it?\")?;\n\n Ok((sink, source))\n}\n\npub fn input_sample_rate(dev: &Device) -> Result {\n let config = dev\n .default_input_config()\n // On Windows, loopback devices are not recognized as input devices. Use output config.\n .or_else(|_| dev.default_output_config())?;\n\n Ok(config.sample_rate().0)\n}\n\npub enum AudioRecordState {\n Recording,\n ShouldStop,\n Err(Option),\n}\n\npub enum AudioChannel {\n FrontLeft,\n FrontRight,\n Center,\n SurroundLeft,\n SurroundRight,\n BackLeft,\n BackRight,\n Top,\n HighFrontLeft,\n HighFrontRight,\n HighFrontCenter,\n HighBackLeft,\n HighBackRight,\n LowFrequency,\n}\n\nfn downmix_channels(channels: &[AudioChannel], data: &[u8], out_channels: u16) -> Vec {\n let mut left = 0.0;\n let mut right = 0.0;\n\n for i in 0..channels.len() {\n let [l, r] = match &channels[i] {\n AudioChannel::FrontLeft => [1.0, 0.0],\n AudioChannel::FrontRight => [0.0, 1.0],\n AudioChannel::Center => [0.707, 0.707],\n AudioChannel::SurroundLeft => [0.707, 0.0],\n AudioChannel::SurroundRight => [0.0, 0.707],\n AudioChannel::BackLeft => [0.707, 0.0],\n AudioChannel::BackRight => [0.0, 0.707],\n AudioChannel::Top => [0.577, 0.577],\n AudioChannel::HighFrontLeft => [0.707, 0.0],\n AudioChannel::HighFrontRight => [0.0, 0.707],\n AudioChannel::HighFrontCenter => [0.5, 0.5],\n AudioChannel::HighBackLeft => [0.5, 0.0],\n AudioChannel::HighBackRight => [0.0, 0.5],\n _ => [0.0, 0.0],\n };\n let val = i16::from_ne_bytes([data[i * 2], data[i * 2 + 1]]).to_sample::();\n left += val * l;\n right += val * r;\n }\n\n if out_channels == 1 {\n let bytes = ((left + right) / 2.0).to_sample::().to_ne_bytes();\n vec![bytes[0], bytes[1]]\n } else {\n let left_bytes = left.to_sample::().to_ne_bytes();\n let right_bytes = right.to_sample::().to_ne_bytes();\n vec![left_bytes[0], left_bytes[1], right_bytes[0], right_bytes[1]]\n }\n}\n\nfn downmix_audio(data: Vec, in_channels: u16, out_channels: u16) -> Vec {\n if in_channels == out_channels {\n data\n } else if in_channels == 1 && out_channels == 2 {\n data.chunks_exact(2)\n .flat_map(|c| vec![c[0], c[1], c[0], c[1]])\n .collect()\n } else {\n let channels = match in_channels {\n 2 => vec![AudioChannel::FrontLeft, AudioChannel::FrontRight],\n 3 => vec![\n AudioChannel::FrontLeft,\n AudioChannel::FrontRight,\n AudioChannel::LowFrequency,\n ],\n 4 => vec![\n AudioChannel::FrontLeft,\n AudioChannel::FrontRight,\n AudioChannel::BackLeft,\n AudioChannel::BackRight,\n ],\n 6 => vec![\n AudioChannel::FrontRight,\n AudioChannel::Center,\n AudioChannel::LowFrequency,\n AudioChannel::SurroundLeft, // Sometimes actually BackLeft, has same level so it's okay\n AudioChannel::SurroundRight, // Sometimes actually BackRight, has same level so it's okay\n ],\n 8 => vec![\n AudioChannel::FrontLeft,\n AudioChannel::FrontRight,\n AudioChannel::Center,\n AudioChannel::LowFrequency,\n AudioChannel::BackLeft,\n AudioChannel::BackRight,\n AudioChannel::SurroundLeft,\n AudioChannel::SurroundRight,\n ],\n _ => unreachable!(\"Invalid input channel count\"),\n };\n\n data.chunks_exact(in_channels as usize * 2)\n .flat_map(|c| downmix_channels(&channels, c, out_channels))\n .collect()\n }\n}\n\n#[allow(unused_variables)]\npub fn record_audio_blocking(\n is_running: Arc bool + Send + Sync>,\n mut sender: StreamSender<()>,\n device: &Device,\n channels_count: u16,\n mute: bool,\n) -> Result<()> {\n let config = device\n .default_input_config()\n // On Windows, loopback devices are not recognized as input devices. Use output config.\n .or_else(|_| device.default_output_config())?;\n\n if config.channels() > 8 {\n bail!(\n \"Audio devices with more than 8 channels are not supported. {}\",\n \"Please turn off surround audio.\"\n );\n } else if config.channels() == 5 || config.channels() == 7 {\n bail!(\n \"Audio devices with {} channels are not supported.\",\n config.channels()\n );\n }\n\n let stream_config = StreamConfig {\n channels: config.channels(),\n sample_rate: config.sample_rate(),\n buffer_size: BufferSize::Default,\n };\n\n let state = Arc::new(Mutex::new(AudioRecordState::Recording));\n\n let stream = device.build_input_stream_raw(\n &stream_config,\n config.sample_format(),\n {\n let state = Arc::clone(&state);\n let is_running = Arc::clone(&is_running);\n move |data, _| {\n let data = if config.sample_format() == SampleFormat::F32 {\n data.bytes()\n .chunks_exact(4)\n .flat_map(|b| {\n f32::from_ne_bytes([b[0], b[1], b[2], b[3]])\n .to_sample::()\n .to_ne_bytes()\n .to_vec()\n })\n .collect()\n } else {\n data.bytes().to_vec()\n };\n\n let data = downmix_audio(data, config.channels(), channels_count);\n\n if is_running() {\n sender.send_header_with_payload(&(), &data).ok();\n } else {\n *state.lock() = AudioRecordState::ShouldStop;\n }\n }\n },\n {\n let state = Arc::clone(&state);\n move |e| *state.lock() = AudioRecordState::Err(Some(e.into()))\n },\n None,\n )?;\n\n #[cfg(windows)]\n if mute && device.supports_output() {\n crate::windows::set_mute_windows_device(device, true).ok();\n }\n\n let mut res = stream.play().to_any();\n\n if res.is_ok() {\n while matches!(*state.lock(), AudioRecordState::Recording) && is_running() {\n thread::sleep(Duration::from_millis(500))\n }\n\n if let AudioRecordState::Err(e) = &mut *state.lock() {\n res = Err(e.take().unwrap());\n }\n }\n\n #[cfg(windows)]\n if mute && device.supports_output() {\n set_mute_windows_device(device, false).ok();\n }\n\n res\n}\n\n// Audio callback. This is designed to be as less complex as possible. Still, when needed, this\n// callback can render a fade-out autonomously.\n#[inline]\npub fn get_next_frame_batch(\n sample_buffer: &mut VecDeque,\n channels_count: usize,\n batch_frames_count: usize,\n) -> Vec {\n if sample_buffer.len() / channels_count >= batch_frames_count {\n let mut batch = sample_buffer\n .drain(0..batch_frames_count * channels_count)\n .collect::>();\n\n if sample_buffer.len() / channels_count < batch_frames_count {\n // Render fade-out. It is completely contained in the current batch\n for f in 0..batch_frames_count {\n let volume = 1. - f as f32 / batch_frames_count as f32;\n for c in 0..channels_count {\n batch[f * channels_count + c] *= volume;\n }\n }\n }\n // fade-ins and cross-fades are rendered in the receive loop directly inside sample_buffer.\n\n batch\n } else {\n vec![0.; batch_frames_count * channels_count]\n }\n}\n\n// The receive loop is resposible for ensuring smooth transitions in case of disruptions (buffer\n// underflow, overflow, packet loss). In case the computation takes too much time, the audio\n// callback will gracefully handle an interruption, and the callback timing and sound wave\n// continuity will not be affected.\npub fn receive_samples_loop(\n is_running: impl Fn() -> bool,\n receiver: &mut StreamReceiver<()>,\n sample_buffer: Arc>>,\n channels_count: usize,\n batch_frames_count: usize,\n average_buffer_frames_count: usize,\n) -> Result<()> {\n let mut recovery_sample_buffer = vec![];\n while is_running() {\n let data = match receiver.recv(Duration::from_millis(500)) {\n Ok(data) => data,\n Err(ConnectionError::TryAgain(_)) => continue,\n Err(ConnectionError::Other(e)) => return Err(e),\n };\n let (_, packet) = data.get()?;\n\n let new_samples = packet\n .chunks_exact(2)\n .map(|c| i16::from_ne_bytes([c[0], c[1]]).to_sample::())\n .collect::>();\n\n let mut sample_buffer_ref = sample_buffer.lock();\n\n if data.had_packet_loss() {\n info!(\"Audio packet loss!\");\n\n if sample_buffer_ref.len() / channels_count < batch_frames_count {\n sample_buffer_ref.clear();\n } else {\n // clear remaining samples\n sample_buffer_ref.drain(batch_frames_count * channels_count..);\n }\n\n recovery_sample_buffer.clear();\n }\n\n if sample_buffer_ref.len() / channels_count < batch_frames_count {\n recovery_sample_buffer.extend(sample_buffer_ref.drain(..));\n }\n\n if sample_buffer_ref.is_empty() || data.had_packet_loss() {\n recovery_sample_buffer.extend(&new_samples);\n\n if recovery_sample_buffer.len() / channels_count\n > average_buffer_frames_count + batch_frames_count\n {\n // Fade-in\n for f in 0..batch_frames_count {\n let volume = f as f32 / batch_frames_count as f32;\n for c in 0..channels_count {\n recovery_sample_buffer[f * channels_count + c] *= volume;\n }\n }\n\n if data.had_packet_loss()\n && sample_buffer_ref.len() / channels_count == batch_frames_count\n {\n // Add a fade-out to make a cross-fade.\n for f in 0..batch_frames_count {\n let volume = 1. - f as f32 / batch_frames_count as f32;\n for c in 0..channels_count {\n recovery_sample_buffer[f * channels_count + c] +=\n sample_buffer_ref[f * channels_count + c] * volume;\n }\n }\n\n sample_buffer_ref.clear();\n }\n\n sample_buffer_ref.extend(recovery_sample_buffer.drain(..));\n info!(\"Audio recovered\");\n }\n } else {\n sample_buffer_ref.extend(&new_samples);\n }\n\n // todo: use smarter policy with EventTiming\n let buffer_frames_size = sample_buffer_ref.len() / channels_count;\n if buffer_frames_size > 2 * average_buffer_frames_count + batch_frames_count {\n info!(\"Audio buffer overflow! size: {buffer_frames_size}\");\n\n let drained_samples = sample_buffer_ref\n .drain(0..(buffer_frames_size - average_buffer_frames_count) * channels_count)\n .collect::>();\n\n // Render a cross-fade.\n for f in 0..batch_frames_count {\n let volume = f as f32 / batch_frames_count as f32;\n for c in 0..channels_count {\n let index = f * channels_count + c;\n sample_buffer_ref[index] = sample_buffer_ref[index]\n .mul_add(volume, drained_samples[index] * (1. - volume));\n }\n }\n }\n }\n\n Ok(())\n}\n\nstruct StreamingSource {\n sample_buffer: Arc>>,\n current_batch: Vec,\n current_batch_cursor: usize,\n channels_count: usize,\n sample_rate: u32,\n batch_frames_count: usize,\n}\n\nimpl Source for StreamingSource {\n fn current_span_len(&self) -> Option {\n None\n }\n\n fn channels(&self) -> u16 {\n self.channels_count as _\n }\n\n fn sample_rate(&self) -> u32 {\n self.sample_rate\n }\n\n fn total_duration(&self) -> Option {\n None\n }\n}\n\nimpl Iterator for StreamingSource {\n type Item = f32;\n\n #[inline]\n fn next(&mut self) -> Option {\n if self.current_batch_cursor == 0 {\n self.current_batch = get_next_frame_batch(\n &mut self.sample_buffer.lock(),\n self.channels_count,\n self.batch_frames_count,\n );\n }\n\n let sample = self.current_batch[self.current_batch_cursor];\n\n self.current_batch_cursor =\n (self.current_batch_cursor + 1) % (self.batch_frames_count * self.channels_count);\n\n Some(sample)\n }\n}\n\npub fn play_audio_loop(\n is_running: impl Fn() -> bool,\n device: &Device,\n channels_count: u16,\n sample_rate: u32,\n config: AudioBufferingConfig,\n receiver: &mut StreamReceiver<()>,\n) -> Result<()> {\n // Size of a chunk of frames. It corresponds to the duration if a fade-in/out in frames.\n let batch_frames_count = sample_rate as usize * config.batch_ms as usize / 1000;\n\n // Average buffer size in frames\n let average_buffer_frames_count =\n sample_rate as usize * config.average_buffering_ms as usize / 1000;\n\n let sample_buffer = Arc::new(Mutex::new(VecDeque::new()));\n\n let stream = OutputStreamBuilder::from_device(device.clone())?.open_stream()?;\n\n stream.mixer().add(StreamingSource {\n sample_buffer: Arc::clone(&sample_buffer),\n current_batch: vec![],\n current_batch_cursor: 0,\n channels_count: channels_count as _,\n sample_rate,\n batch_frames_count,\n });\n\n receive_samples_loop(\n is_running,\n receiver,\n sample_buffer,\n channels_count as _,\n batch_frames_count,\n average_buffer_frames_count,\n )\n .ok();\n\n Ok(())\n}\n"
},
{
"path": "alvr/audio/src/linux.rs",
"content": "use alvr_common::{ConnectionError, anyhow::Result, debug, error, parking_lot::Mutex};\nuse alvr_session::AudioBufferingConfig;\nuse alvr_sockets::{StreamReceiver, StreamSender};\n\nuse std::os::unix::fs::FileTypeExt;\nuse std::{\n collections::VecDeque,\n fs, io,\n path::Path,\n sync::{\n Arc,\n atomic::{AtomicBool, Ordering},\n },\n thread::{self, sleep},\n time::Duration,\n};\n\nuse pipewire::{\n channel::Receiver,\n context::Context,\n core::Core,\n keys,\n main_loop::MainLoop,\n properties,\n spa::{\n param::audio::{AudioFormat, AudioInfoRaw},\n pod::{self, Pod, Value, serialize::PodSerializer},\n utils::Direction,\n },\n stream::{Stream, StreamFlags, StreamListener, StreamState},\n};\n\npub fn try_load_pipewire() -> Result<()> {\n if let Err(e) = probe_pipewire() {\n if !matches!(e, pipewire::Error::CreationFailed) {\n return Err(e.into());\n }\n error!(\"Could not initialize PipeWire.\");\n\n let is_under_flatpak = std::env::var(\"FLATPAK_ID\").is_ok();\n let is_pw_socket_available =\n std::env::var(\"XDG_RUNTIME_DIR\").is_ok_and(|xdg_runtime_dir| {\n let pw_socket_path = Path::new(&xdg_runtime_dir).join(\"pipewire-0\");\n fs::metadata(&pw_socket_path).is_ok_and(|m| m.file_type().is_socket())\n });\n\n if is_under_flatpak && !is_pw_socket_available {\n error!(\n \"Please visit the following page to find help on how to fix broken audio on flatpak.\"\n );\n error!(\n \"https://github.com/alvr-org/ALVR/wiki/Installing-ALVR-and-using-SteamVR-on-Linux-through-Flatpak#failed-to-create-pipewire-errors\"\n );\n }\n error!(\"Make sure PipeWire is installed on your system, running and it's version is at least 0.3.49.\n To retry, please restart SteamVR with ALVR.\");\n }\n Ok(())\n}\n\nfn probe_pipewire() -> Result<(), pipewire::Error> {\n let mainloop = MainLoop::new(None)?;\n let context = Context::new(&mainloop)?;\n context.connect(None)?;\n Ok(())\n}\n\n#[derive(Clone, Copy)]\npub struct AudioInfo {\n pub sample_rate: u32,\n pub channel_count: u32,\n}\n\nstruct Terminate;\n\n// fixme: Opening pavucontrol while audio is actively streaming\n// will cause audio cut out for short time,\n// possibly related to fast state changes caused by pavucontrol\nstatic MIC_STREAMING: AtomicBool = AtomicBool::new(false);\n\npub fn audio_loop(\n is_running: impl Fn() -> bool,\n sender: StreamSender<()>,\n speaker_info: Option,\n receiver: &mut StreamReceiver<()>,\n mic_info: Option<(AudioInfo, AudioBufferingConfig)>,\n) {\n let sample_queue = Arc::new(Mutex::new(VecDeque::new()));\n MIC_STREAMING.store(false, Ordering::Relaxed);\n\n let (pw_sender, pw_receiver) = pipewire::channel::channel();\n\n // Stall pipewire startup until we're actually streaming to not cause latency by packet buildup\n if !is_running() {\n return;\n }\n\n let pw_thread = thread::spawn({\n let sample_queue = sample_queue.clone();\n let mic_info = mic_info.as_ref().map(|(info, _)| *info);\n\n move || {\n if let Err(e) = pw_main_loop(pw_receiver, sender, speaker_info, sample_queue, mic_info)\n {\n error!(\"Unhandled pipewire audio device error, please report it on GitHub: {e}\");\n }\n debug!(\"Pipewire audio loop exiting\");\n }\n });\n\n while is_running() {\n if let Some((mic_info, buffering)) = &mic_info {\n let rate = mic_info.sample_rate as usize;\n\n let batch_frames_count = rate * buffering.batch_ms as usize / 1000;\n let average_buffer_frames_count = rate * buffering.average_buffering_ms as usize / 1000;\n\n if let Err(e) = crate::receive_samples_loop(\n || is_running() && MIC_STREAMING.load(Ordering::Relaxed),\n receiver,\n sample_queue.clone(),\n mic_info.channel_count as usize,\n batch_frames_count,\n average_buffer_frames_count,\n ) {\n error!(\"Receive samples loop encountered error {e:?}\");\n }\n\n // if we end up here then no consumer is currently connected to the output\n // so discard audio packets to not cause a buildup\n if matches!(\n receiver.recv(Duration::from_millis(500)),\n Err(ConnectionError::Other(_))\n ) {\n break;\n }\n } else {\n sleep(Duration::from_millis(500));\n }\n }\n\n if pw_sender.send(Terminate).is_err() {\n error!(\n \"Couldn't send pipewire termination signal, deinitializing forcefully.\n Restart the VR app to reinitialize the audio device.\"\n );\n\n unsafe { pipewire::deinit() };\n }\n\n pw_thread.join().ok();\n}\n\nfn pw_main_loop(\n pw_receiver: Receiver,\n audio_sender: StreamSender<()>,\n speaker_info: Option,\n sample_queue: Arc>>,\n mic_info: Option,\n) -> Result<(), pipewire::Error> {\n debug!(\"Starting pipewire thread\");\n let mainloop = MainLoop::new(None)?;\n\n let _receiver = pw_receiver.attach(mainloop.as_ref(), {\n let mainloop = mainloop.clone();\n move |_| mainloop.quit()\n });\n\n let context = Context::new(&mainloop)?;\n let pw_core = context.connect(None)?;\n\n let _speaker = if let Some(info) = speaker_info {\n debug!(\"Creating pw output audio stream\");\n Some(create_speaker_stream(\n &pw_core,\n audio_sender,\n info.sample_rate,\n info.channel_count,\n )?)\n } else {\n None\n };\n\n let _mic = if let Some(info) = mic_info {\n debug!(\"Creating pw microphone stream\");\n Some(create_mic_stream(\n &pw_core,\n sample_queue,\n info.sample_rate,\n info.channel_count,\n )?)\n } else {\n None\n };\n\n debug!(\"Running pipewire thread\");\n mainloop.run();\n\n Ok(())\n}\n\nfn audio_info_to_vec(audio_info: AudioInfoRaw) -> Vec {\n PodSerializer::serialize(\n io::Cursor::new(Vec::new()),\n &Value::Object(pod::Object {\n type_: libspa_sys::SPA_TYPE_OBJECT_Format,\n id: libspa_sys::SPA_PARAM_EnumFormat,\n properties: audio_info.into(),\n }),\n )\n .unwrap()\n .0\n .into_inner()\n}\n\nfn create_speaker_stream(\n pw_core: &Core,\n mut sender: StreamSender<()>,\n sample_rate: u32,\n channel_count: u32,\n) -> Result<(Stream, StreamListener), pipewire::Error> {\n let stream = Stream::new(\n pw_core,\n \"alvr-audio\",\n properties::properties! {\n *keys::NODE_NAME => \"ALVR Audio\",\n *keys::MEDIA_NAME => \"alvr-audio\",\n *keys::MEDIA_TYPE => \"Audio\",\n *keys::MEDIA_CATEGORY => \"Capture\",\n *keys::MEDIA_CLASS => \"Audio/Sink\",\n *keys::MEDIA_ROLE => \"Game\",\n },\n )?;\n\n let listener: StreamListener = stream\n .add_local_listener()\n .process(move |stream, _| {\n if let Some(mut pw_buf) = stream.dequeue_buffer()\n && let Some(pw_buf) = pw_buf.datas_mut().first_mut()\n {\n let size = pw_buf.chunk_mut().size() as usize;\n\n if let Some(data) = pw_buf.data() {\n // Data is given as s16le in the correct layout by pipewire already,\n // no need to do conversions\n sender.send_header_with_payload(&(), &data[0..size]).ok();\n }\n }\n })\n .register()?;\n\n let mut audio_info = AudioInfoRaw::new();\n audio_info.set_format(AudioFormat::S16LE);\n audio_info.set_rate(sample_rate);\n audio_info.set_channels(channel_count);\n\n stream.connect(\n Direction::Input,\n None,\n StreamFlags::AUTOCONNECT | StreamFlags::MAP_BUFFERS,\n &mut [Pod::from_bytes(&audio_info_to_vec(audio_info)).unwrap()],\n )?;\n\n Ok((stream, listener))\n}\n\nfn create_mic_stream(\n pw_core: &Core,\n sample_queue: Arc>>,\n sample_rate: u32,\n channel_count: u32,\n) -> Result<(Stream, StreamListener), pipewire::Error> {\n let stream = Stream::new(\n pw_core,\n \"alvr-mic\",\n properties::properties! {\n *keys::NODE_NAME => \"ALVR Microphone\",\n *keys::MEDIA_NAME => \"alvr-mic\",\n *keys::MEDIA_TYPE => \"Audio\",\n *keys::MEDIA_CATEGORY => \"Playback\",\n *keys::MEDIA_CLASS => \"Audio/Source\",\n *keys::MEDIA_ROLE => \"Communication\",\n },\n )?;\n\n let chan_size = std::mem::size_of::();\n let listener: StreamListener = stream\n .add_local_listener()\n .state_changed(move |_, _, _, new_state| {\n MIC_STREAMING.store(new_state == StreamState::Streaming, Ordering::Relaxed);\n })\n .process(move |stream, _| {\n fill_pw_buf(\n sample_queue.clone(),\n chan_size,\n channel_count as usize,\n stream,\n );\n })\n .register()?;\n\n let mut audio_info = AudioInfoRaw::new();\n audio_info.set_format(AudioFormat::F32LE);\n audio_info.set_rate(sample_rate);\n audio_info.set_channels(channel_count);\n\n stream.connect(\n Direction::Output,\n None,\n StreamFlags::AUTOCONNECT | StreamFlags::MAP_BUFFERS,\n &mut [Pod::from_bytes(&audio_info_to_vec(audio_info)).unwrap()],\n )?;\n\n Ok((stream, listener))\n}\n\nfn fill_pw_buf(\n sample_queue: Arc>>,\n chan_size: usize,\n chan_count: usize,\n stream: &pipewire::stream::StreamRef,\n) {\n if let Some(mut pw_buf) = stream.dequeue_buffer() {\n let requested = pw_buf.requested() as usize;\n\n if let Some(pw_data) = pw_buf.datas_mut().first_mut()\n && let Some(slice) = pw_data.data()\n && let Some(mut samples) = sample_queue.try_lock()\n {\n // TODO: Would it be more correct to try to split it up over multiple datas?\n // Or is the requested size already right for the first data chunk?\n\n let mut it = slice\n .chunks_exact_mut(chan_size)\n .take(requested * chan_count);\n let pw_sample_count = it.len();\n\n let (front, back) = samples.as_slices();\n let copy_sample =\n |(chunk, sample): (&mut [u8], &f32)| chunk.copy_from_slice(&sample.to_le_bytes());\n\n // Split up so the compiler actually optimizes this properly\n it.by_ref().zip(front).for_each(copy_sample);\n it.zip(back).for_each(copy_sample);\n\n let sample_count = pw_sample_count.min(samples.len());\n drop(samples.drain(..sample_count));\n\n let chunk = pw_data.chunk_mut();\n *chunk.offset_mut() = 0;\n *chunk.stride_mut() = (chan_size * chan_count) as _;\n *chunk.size_mut() = (sample_count * chan_size) as _;\n }\n }\n}\n"
},
{
"path": "alvr/audio/src/windows.rs",
"content": "use alvr_common::anyhow::{Result, bail};\nuse cpal::{Device, platform::DeviceInner};\nuse rodio::DeviceTrait;\nuse windows::{\n Win32::{\n Devices::FunctionDiscovery::PKEY_Device_FriendlyName,\n Media::Audio::{\n DEVICE_STATE_ACTIVE, Endpoints::IAudioEndpointVolume, IMMDevice, IMMDeviceEnumerator,\n MMDeviceEnumerator, eCapture, eRender,\n },\n System::Com::{self, CLSCTX_ALL, COINIT_MULTITHREADED, STGM_READ},\n },\n core::GUID,\n};\n\nfn get_windows_device(device: &Device) -> Result {\n let device_name = device.name()?;\n\n unsafe {\n // This will fail the second time is called, ignore the error\n Com::CoInitializeEx(None, COINIT_MULTITHREADED).ok().ok();\n\n let imm_device_enumerator: IMMDeviceEnumerator =\n Com::CoCreateInstance(&MMDeviceEnumerator, None, CLSCTX_ALL)?;\n\n let direction = if device.supports_output() {\n eRender\n } else {\n eCapture\n };\n let imm_device_collection =\n imm_device_enumerator.EnumAudioEndpoints(direction, DEVICE_STATE_ACTIVE)?;\n\n for i in 0..imm_device_collection.GetCount()? {\n let imm_device = imm_device_collection.Item(i)?;\n\n let imm_device_name = imm_device\n .OpenPropertyStore(STGM_READ)?\n .GetValue(&PKEY_Device_FriendlyName)?\n .to_string();\n\n if imm_device_name == device_name {\n return Ok(imm_device);\n }\n }\n\n bail!(\"No device found with specified name\")\n }\n}\n\npub fn get_windows_device_id(device: &Device) -> Result {\n unsafe {\n let imm_device = get_windows_device(device)?;\n\n let id_str_ptr = imm_device.GetId()?;\n let id_str = id_str_ptr.to_string()?;\n Com::CoTaskMemFree(Some(id_str_ptr.0 as _));\n\n Ok(id_str)\n }\n}\n\n// device must be an output device\npub fn set_mute_windows_device(device: &Device, mute: bool) -> Result<()> {\n unsafe {\n let imm_device = get_windows_device(device)?;\n\n let endpoint_volume = imm_device.Activate::(CLSCTX_ALL, None)?;\n\n endpoint_volume.SetMute(mute, &GUID::zeroed())?;\n }\n\n Ok(())\n}\n\npub fn is_same_device(device1: &Device, device2: &Device) -> bool {\n let DeviceInner::Wasapi(dev1) = device1.as_inner();\n let DeviceInner::Wasapi(dev2) = device2.as_inner();\n\n dev1 == dev2\n}\n"
},
{
"path": "alvr/client_core/Cargo.toml",
"content": "[package]\nname = \"alvr_client_core\"\nversion.workspace = true\nedition.workspace = true\nrust-version.workspace = true\nauthors.workspace = true\nlicense.workspace = true\n\n[lib]\ncrate-type = [\"rlib\", \"staticlib\", \"cdylib\"]\n\n[features]\nlink-stdcpp-shared = []\ndefault = [\"link-stdcpp-shared\"]\n\n[dependencies]\nalvr_audio.workspace = true\nalvr_common.workspace = true\nalvr_graphics.workspace = true\nalvr_packets.workspace = true\nalvr_session.workspace = true\nalvr_sockets.workspace = true\nalvr_system_info.workspace = true\n\napp_dirs2 = \"2\"\nmdns-sd = \"0.14\"\nrand = \"0.9\"\nserde = \"1\"\nserde_json = \"1\"\n\n[target.'cfg(target_os = \"android\")'.dependencies]\nandroid_logger = \"0.15\"\nndk = { version = \"0.9\", features = [\"api-level-28\", \"audio\", \"media\"] }\nndk-context = \"0.1\"\n\n[target.'cfg(not(target_os = \"android\"))'.dependencies]\nenv_logger = \"0.11\"\n"
},
{
"path": "alvr/client_core/LICENSE",
"content": "Copyright (c) 2020-2024 alvr-org\n\nPermission is hereby granted, free of charge, to any person\nobtaining a copy of this software and associated documentation\nfiles (the \"Software\"), to deal in the Software without\nrestriction, including without limitation the rights to use,\ncopy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the\nSoftware is furnished to do so, subject to the following\nconditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES\nOF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT\nHOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,\nWHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\nFROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE."
},
{
"path": "alvr/client_core/README.md",
"content": "# alvr_client_core\n\nRust crate containing all major components for an ALVR client except the XR-API-related code.\n"
},
{
"path": "alvr/client_core/build.rs",
"content": "fn main() {\n let platform_name = std::env::var(\"CARGO_CFG_TARGET_OS\").unwrap();\n\n if platform_name == \"android\" {\n println!(\"cargo:rustc-link-lib=log\");\n println!(\"cargo:rustc-link-lib=EGL\");\n println!(\"cargo:rustc-link-lib=GLESv3\");\n println!(\"cargo:rustc-link-lib=android\");\n\n #[cfg(feature = \"link-stdcpp-shared\")]\n println!(\"cargo:rustc-link-lib=c++_shared\");\n }\n}\n"
},
{
"path": "alvr/client_core/cbindgen.toml",
"content": "language = \"C\"\nheader = \"/* ALVR is licensed under the MIT license. https://github.com/alvr-org/ALVR/blob/master/LICENSE */\"\npragma_once = true\nautogen_warning = \"/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */\"\ncpp_compat = true\ntab_width = 4\ndocumentation_style = \"c99\"\n\n[enum]\nrename_variants = \"QualifiedScreamingSnakeCase\"\n\n[parse]\nparse_deps = true\ninclude = [\"alvr_common\"]\n\n"
},
{
"path": "alvr/client_core/src/audio.rs",
"content": "use alvr_audio::Device;\nuse alvr_common::{\n anyhow::{Result, bail},\n parking_lot::Mutex,\n};\nuse alvr_session::AudioBufferingConfig;\nuse alvr_sockets::{StreamReceiver, StreamSender};\nuse ndk::audio::{\n AudioCallbackResult, AudioDirection, AudioError, AudioFormat, AudioInputPreset,\n AudioPerformanceMode, AudioSharingMode, AudioStreamBuilder,\n};\nuse std::{\n collections::VecDeque,\n mem, slice,\n sync::{Arc, mpsc},\n time::Duration,\n};\n\nconst INPUT_SAMPLES_MAX_BUFFER_COUNT: usize = 20;\nconst INPUT_RECV_TIMEOUT: Duration = Duration::from_millis(20);\n\n#[allow(unused_variables)]\npub fn record_audio_blocking(\n is_running: Arc bool + Send + Sync>,\n mut sender: StreamSender<()>,\n device: &Device,\n channels_count: u16,\n mute: bool,\n) -> Result<()> {\n assert_eq!(\n channels_count, 1,\n \"This code only supports mono microphone input\"\n );\n\n let sample_rate = alvr_audio::input_sample_rate(device)?;\n\n let error = Arc::new(Mutex::new(None::));\n\n let (samples_sender, samples_receiver) =\n mpsc::sync_channel::>(INPUT_SAMPLES_MAX_BUFFER_COUNT);\n\n let stream = AudioStreamBuilder::new()?\n .direction(AudioDirection::Input)\n .channel_count(1)\n .sample_rate(sample_rate as _)\n .format(AudioFormat::PCM_I16)\n .input_preset(AudioInputPreset::VoiceCommunication)\n .performance_mode(AudioPerformanceMode::LowLatency)\n .sharing_mode(AudioSharingMode::Shared)\n .data_callback(Box::new(move |_, data_ptr, frames_count| {\n let buffer_size = frames_count as usize * mem::size_of::();\n\n let sample_buffer =\n unsafe { slice::from_raw_parts(data_ptr as *mut u8, buffer_size) }.to_vec();\n\n // it will block only when the channel is full\n samples_sender.send(sample_buffer).ok();\n\n AudioCallbackResult::Continue\n }))\n .error_callback({\n let error = Arc::clone(&error);\n Box::new(move |_, e| *error.lock() = Some(e.into()))\n })\n .open_stream()?;\n\n // If configuration changed, the stream must be restarted\n if stream.channel_count() != 1\n || stream.sample_rate() != sample_rate as i32\n || stream.format() != AudioFormat::PCM_I16\n {\n bail!(\"Invalid audio configuration\");\n }\n\n stream.request_start()?;\n\n while is_running() && error.lock().is_none() {\n while let Ok(sample_buffer) = samples_receiver.recv_timeout(INPUT_RECV_TIMEOUT) {\n sender.send_header_with_payload(&(), &sample_buffer).ok();\n }\n }\n\n // Note: request_stop() is asynchronous, and must be called always, even on error\n stream.request_stop()?;\n\n if let Some(e) = *error.lock() {\n return Err(e.into());\n }\n\n Ok(())\n}\n\n#[allow(unused_variables)]\npub fn play_audio_loop(\n is_running: impl Fn() -> bool,\n device: &Device,\n channels_count: u16,\n sample_rate: u32,\n config: AudioBufferingConfig,\n receiver: &mut StreamReceiver<()>,\n) -> Result<()> {\n assert_eq!(channels_count, 2, \"This code only supports stereo output\");\n\n // the client sends invalid sample rates sometimes, and we crash if we try and use one\n // (batch_frames_count ends up zero and the audio callback gets confused)\n if sample_rate < 8000 {\n bail!(\"Invalid audio sample rate\");\n }\n\n let batch_frames_count = sample_rate as usize * config.batch_ms as usize / 1000;\n let average_buffer_frames_count =\n sample_rate as usize * config.average_buffering_ms as usize / 1000;\n\n let sample_buffer = Arc::new(Mutex::new(VecDeque::new()));\n let error = Arc::new(Mutex::new(None));\n\n let stream = AudioStreamBuilder::new()?\n .direction(AudioDirection::Output)\n .channel_count(2)\n .sample_rate(sample_rate as _)\n .format(AudioFormat::PCM_Float)\n .frames_per_data_callback(batch_frames_count as _)\n .performance_mode(AudioPerformanceMode::LowLatency)\n .sharing_mode(AudioSharingMode::Shared)\n .data_callback({\n let sample_buffer = Arc::clone(&sample_buffer);\n Box::new(move |_, data_ptr, frames_count| {\n assert!(frames_count == batch_frames_count as i32);\n\n let samples = alvr_audio::get_next_frame_batch(\n &mut *sample_buffer.lock(),\n 2,\n batch_frames_count as _,\n );\n\n let out_frames = unsafe {\n // 2 channels\n slice::from_raw_parts_mut(data_ptr as *mut f32, frames_count as usize * 2)\n };\n out_frames.copy_from_slice(&samples);\n\n AudioCallbackResult::Continue\n })\n })\n .error_callback({\n let error = Arc::clone(&error);\n Box::new(move |_, e| *error.lock() = Some(e))\n })\n .open_stream()?;\n\n // If configuration changed, the stream must be restarted\n if stream.channel_count() != 2\n || stream.sample_rate() != sample_rate as i32\n || stream.format() != AudioFormat::PCM_Float\n || stream.frames_per_data_callback() != Some(batch_frames_count as _)\n {\n bail!(\"Invalid audio configuration\");\n }\n\n stream.request_start()?;\n\n alvr_audio::receive_samples_loop(\n || is_running() && error.lock().is_none(),\n receiver,\n sample_buffer,\n 2,\n batch_frames_count,\n average_buffer_frames_count,\n )\n .ok();\n\n // Note: request_stop() is asynchronous, and must be called always, even on error\n stream.request_stop()?;\n\n if let Some(e) = *error.lock() {\n return Err(e.into());\n }\n\n Ok(())\n}\n"
},
{
"path": "alvr/client_core/src/c_api.rs",
"content": "#![expect(dead_code)]\n\nuse crate::{\n ClientCapabilities, ClientCoreContext, ClientCoreEvent, storage,\n video_decoder::{self, VideoDecoderConfig, VideoDecoderSource},\n};\nuse alvr_common::{\n AlvrCodecType, AlvrFov, AlvrPose, AlvrQuat, AlvrViewParams, DeviceMotion, Pose, ViewParams,\n anyhow::Result,\n debug, error,\n glam::{UVec2, Vec2, Vec3},\n info,\n parking_lot::Mutex,\n warn,\n};\nuse alvr_graphics::{\n GraphicsContext, HandData, LobbyRenderer, LobbyViewParams, SDR_FORMAT_GL, StreamRenderer,\n StreamViewParams,\n};\nuse alvr_packets::{ButtonEntry, ButtonValue, FaceData, TrackingData};\nuse alvr_session::{\n CodecType, FoveatedEncodingConfig, MediacodecPropType, MediacodecProperty, UpscalingConfig,\n};\nuse std::{\n cell::RefCell,\n ffi::{CStr, CString, c_char, c_void},\n ptr,\n rc::Rc,\n slice,\n time::{Duration, Instant},\n};\n\nstatic CLIENT_CORE_CONTEXT: Mutex> = Mutex::new(None);\nstatic HUD_MESSAGE: Mutex = Mutex::new(String::new());\nstatic SETTINGS: Mutex = Mutex::new(String::new());\nstatic SERVER_VERSION: Mutex = Mutex::new(String::new());\nstatic DECODER_CONFIG_BUFFER: Mutex> = Mutex::new(vec![]);\n\n// Core interface:\n\n#[repr(C)]\npub struct AlvrClientCapabilities {\n default_view_width: u32,\n default_view_height: u32,\n max_view_width: u32,\n max_view_height: u32,\n refresh_rates: *const f32,\n refresh_rates_count: u64,\n foveated_encoding: bool,\n encoder_high_profile: bool,\n encoder_10_bits: bool,\n encoder_av1: bool,\n prefer_10bit: bool,\n preferred_encoding_gamma: f32,\n prefer_hdr: bool,\n}\n\n#[repr(u8)]\npub enum AlvrEvent {\n HudMessageUpdated,\n StreamingStarted {\n view_width: u32,\n view_height: u32,\n refresh_rate_hint: f32,\n encoding_gamma: f32,\n enable_foveated_encoding: bool,\n enable_hdr: bool,\n },\n StreamingStopped,\n Haptics {\n device_id: u64,\n duration_s: f32,\n frequency: f32,\n amplitude: f32,\n },\n /// Note: All subsequent DecoderConfig events should be ignored until reconnection\n DecoderConfig {\n codec: AlvrCodecType,\n },\n // Unimplemented\n RealTimeConfig {},\n}\n\n#[repr(C)]\npub struct AlvrVideoFrameData {\n callback_context: *mut c_void,\n timestamp_ns: u64,\n buffer_ptr: *const u8,\n buffer_size: u64,\n}\n\n#[repr(C)]\n#[derive(Clone, Default)]\npub struct AlvrDeviceMotion {\n device_id: u64,\n pose: AlvrPose,\n linear_velocity: [f32; 3],\n angular_velocity: [f32; 3],\n}\n\n#[allow(dead_code)]\n#[repr(C)]\npub enum AlvrButtonValue {\n Binary(bool),\n Scalar(f32),\n}\n\n#[allow(dead_code)]\n#[repr(u8)]\npub enum AlvrLogLevel {\n Error,\n Warn,\n Info,\n Debug,\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_initialize_logging() {\n crate::init_logging();\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_path_string_to_id(path: *const c_char) -> u64 {\n alvr_common::hash_string(unsafe { CStr::from_ptr(path) }.to_str().unwrap())\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_log(level: AlvrLogLevel, message: *const c_char) {\n let message = unsafe { CStr::from_ptr(message) }.to_str().unwrap();\n match level {\n AlvrLogLevel::Error => error!(\"[ALVR NATIVE] {message}\"),\n AlvrLogLevel::Warn => warn!(\"[ALVR NATIVE] {message}\"),\n AlvrLogLevel::Info => info!(\"[ALVR NATIVE] {message}\"),\n AlvrLogLevel::Debug => debug!(\"[ALVR NATIVE] {message}\"),\n }\n}\n\n#[unsafe(no_mangle)]\n#[cfg_attr(not(debug_assertions), expect(unused_variables))]\npub extern \"C\" fn alvr_dbg_client_impl(message: *const c_char) {\n alvr_common::dbg_client_impl!(\"{}\", unsafe { CStr::from_ptr(message) }.to_str().unwrap())\n}\n\n#[unsafe(no_mangle)]\n#[cfg_attr(not(debug_assertions), expect(unused_variables))]\npub extern \"C\" fn alvr_dbg_decoder(message: *const c_char) {\n alvr_common::dbg_decoder!(\"{}\", unsafe { CStr::from_ptr(message) }.to_str().unwrap())\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_log_time(tag: *const c_char) {\n let tag = unsafe { CStr::from_ptr(tag) }.to_str().unwrap();\n error!(\"[ALVR NATIVE] {tag}: {:?}\", Instant::now());\n}\n\nfn string_to_c_str(buffer: *mut c_char, value: &str) -> u64 {\n let cstring = CString::new(value).unwrap();\n if !buffer.is_null() {\n unsafe {\n ptr::copy_nonoverlapping(cstring.as_ptr(), buffer, cstring.as_bytes_with_nul().len());\n }\n }\n\n cstring.as_bytes_with_nul().len() as u64\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_mdns_service(service_buffer: *mut c_char) -> u64 {\n string_to_c_str(service_buffer, alvr_sockets::MDNS_SERVICE_TYPE)\n}\n\n/// To make sure the value is correct, call after alvr_initialize()\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_hostname(hostname_buffer: *mut c_char) -> u64 {\n string_to_c_str(hostname_buffer, &storage::Config::load().hostname)\n}\n\n/// To make sure the value is correct, call after alvr_initialize()\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_protocol_id(protocol_buffer: *mut c_char) -> u64 {\n string_to_c_str(protocol_buffer, &storage::Config::load().protocol_id)\n}\n\n#[cfg(target_os = \"android\")]\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_try_get_permission(permission: *const c_char) {\n alvr_system_info::try_get_permission(unsafe { CStr::from_ptr(permission) }.to_str().unwrap());\n}\n\n/// NB: for android, `context` must be thread safe.\n#[cfg(target_os = \"android\")]\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_initialize_android_context(java_vm: *mut c_void, context: *mut c_void) {\n unsafe { ndk_context::initialize_android_context(java_vm, context) };\n}\n\n/// On android, alvr_initialize_android_context() must be called first, then alvr_initialize().\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_initialize(capabilities: AlvrClientCapabilities) {\n let default_view_resolution = UVec2::new(\n capabilities.default_view_width,\n capabilities.default_view_height,\n );\n\n let max_view_resolution = UVec2::new(capabilities.max_view_width, capabilities.max_view_height);\n\n let refresh_rates = unsafe {\n slice::from_raw_parts(\n capabilities.refresh_rates,\n capabilities.refresh_rates_count as usize,\n )\n }\n .to_vec();\n\n let capabilities = ClientCapabilities {\n platform: alvr_system_info::platform(None, None),\n default_view_resolution,\n max_view_resolution,\n refresh_rates,\n foveated_encoding: capabilities.foveated_encoding,\n encoder_high_profile: capabilities.encoder_high_profile,\n encoder_10_bits: capabilities.encoder_10_bits,\n encoder_av1: capabilities.encoder_av1,\n prefer_10bit: capabilities.prefer_10bit,\n preferred_encoding_gamma: capabilities.preferred_encoding_gamma,\n prefer_hdr: capabilities.prefer_hdr,\n };\n *CLIENT_CORE_CONTEXT.lock() = Some(ClientCoreContext::new(capabilities));\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_destroy() {\n *CLIENT_CORE_CONTEXT.lock() = None;\n\n #[cfg(target_os = \"android\")]\n unsafe {\n ndk_context::release_android_context()\n };\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_resume() {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.resume();\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_pause() {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.pause();\n }\n}\n\n/// Returns true if there was a new event\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_poll_event(out_event: *mut AlvrEvent) -> bool {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock()\n && let Some(event) = context.poll_event()\n {\n let event = match event {\n ClientCoreEvent::UpdateHudMessage(message) => {\n *HUD_MESSAGE.lock() = message;\n\n AlvrEvent::HudMessageUpdated\n }\n ClientCoreEvent::StreamingStarted(stream_config) => {\n *SETTINGS.lock() = serde_json::to_string(&stream_config.settings).unwrap();\n *SERVER_VERSION.lock() = stream_config.server_version.to_string();\n\n AlvrEvent::StreamingStarted {\n view_width: stream_config.negotiated_config.view_resolution.x,\n view_height: stream_config.negotiated_config.view_resolution.y,\n refresh_rate_hint: stream_config.negotiated_config.refresh_rate_hint,\n encoding_gamma: stream_config.negotiated_config.encoding_gamma,\n enable_foveated_encoding: stream_config\n .negotiated_config\n .enable_foveated_encoding,\n enable_hdr: stream_config.negotiated_config.enable_hdr,\n }\n }\n ClientCoreEvent::StreamingStopped => AlvrEvent::StreamingStopped,\n ClientCoreEvent::Haptics {\n device_id,\n duration,\n frequency,\n amplitude,\n } => AlvrEvent::Haptics {\n device_id,\n duration_s: duration.as_secs_f32(),\n frequency,\n amplitude,\n },\n ClientCoreEvent::DecoderConfig { codec, config_nal } => {\n *DECODER_CONFIG_BUFFER.lock() = config_nal;\n\n AlvrEvent::DecoderConfig {\n codec: match codec {\n CodecType::H264 => AlvrCodecType::H264,\n CodecType::Hevc => AlvrCodecType::Hevc,\n CodecType::AV1 => AlvrCodecType::AV1,\n },\n }\n }\n ClientCoreEvent::RealTimeConfig(_) => AlvrEvent::RealTimeConfig {},\n };\n\n unsafe { *out_event = event };\n\n true\n } else {\n false\n }\n}\n\n// Returns the length of the message. message_buffer can be null.\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_hud_message(message_buffer: *mut c_char) -> u64 {\n let cstring = CString::new(HUD_MESSAGE.lock().clone()).unwrap();\n if !message_buffer.is_null() {\n unsafe {\n ptr::copy_nonoverlapping(\n cstring.as_ptr(),\n message_buffer,\n cstring.as_bytes_with_nul().len(),\n );\n }\n }\n\n cstring.as_bytes_with_nul().len() as u64\n}\n\n/// Settings will be updated after receiving StreamingStarted event\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_get_settings_json(out_buffer: *mut c_char) -> u64 {\n string_to_c_str(out_buffer, &SETTINGS.lock())\n}\n\n/// Will be updated after receiving StreamingStarted event\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_get_server_version(out_buffer: *mut c_char) -> u64 {\n string_to_c_str(out_buffer, &SERVER_VERSION.lock())\n}\n\n/// Returns the number of bytes of the decoder_buffer\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_get_decoder_config(out_buffer: *mut c_char) -> u64 {\n let buffer = DECODER_CONFIG_BUFFER.lock();\n\n let size = buffer.len();\n\n if !out_buffer.is_null() {\n unsafe { ptr::copy_nonoverlapping(buffer.as_ptr(), out_buffer.cast(), size) }\n }\n\n size as u64\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_battery(device_id: u64, gauge_value: f32, is_plugged: bool) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_battery(device_id, gauge_value, is_plugged);\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_playspace(width: f32, height: f32) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_playspace(Some(Vec2::new(width, height)));\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_active_interaction_profile(\n device_id: u64,\n profile_id: u64,\n input_ids_ptr: *const u64,\n input_ids_count: u64,\n) {\n let input_ids = if !input_ids_ptr.is_null() {\n unsafe { slice::from_raw_parts(input_ids_ptr, input_ids_count as usize) }\n } else {\n &[]\n };\n\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_active_interaction_profile(\n device_id,\n profile_id,\n input_ids.iter().cloned().collect(),\n );\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_button(path_id: u64, value: AlvrButtonValue) {\n let value = match value {\n AlvrButtonValue::Binary(value) => ButtonValue::Binary(value),\n AlvrButtonValue::Scalar(value) => ButtonValue::Scalar(value),\n };\n\n // crate::send_buttons(vec![ButtonEntry { path_id, value }]);\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_buttons(vec![ButtonEntry { path_id, value }]);\n }\n}\n\n/// The view poses need to be in local space, as if the head is at the origin.\n/// view_params: array of 2\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_view_params(view_params: *const AlvrViewParams) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_view_params(unsafe {\n [\n alvr_common::from_capi_view_params(&(*view_params)),\n alvr_common::from_capi_view_params(&(*view_params.offset(1))),\n ]\n });\n }\n}\n\n/// hand_skeleton:\n/// * outer ptr: array of 2 (can be null);\n/// * inner ptr: array of 26 (can be null if hand is absent)\n///\n/// combined_eye_gaze: can be null if eye gaze is absent\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_send_tracking(\n poll_timestamp_ns: u64,\n device_motions: *const AlvrDeviceMotion,\n device_motions_count: u64,\n hand_skeletons: *const *const AlvrPose,\n combined_eye_gaze: *const AlvrQuat,\n) {\n let mut raw_motions = vec![AlvrDeviceMotion::default(); device_motions_count as _];\n unsafe {\n ptr::copy_nonoverlapping(\n device_motions,\n raw_motions.as_mut_ptr(),\n device_motions_count as usize,\n );\n }\n\n let device_motions = raw_motions\n .into_iter()\n .map(|motion| {\n (\n motion.device_id,\n DeviceMotion {\n pose: alvr_common::from_capi_pose(&motion.pose),\n linear_velocity: Vec3::from_slice(&motion.linear_velocity),\n angular_velocity: Vec3::from_slice(&motion.angular_velocity),\n },\n )\n })\n .collect::>();\n\n let hand_skeletons = if !hand_skeletons.is_null() {\n let hand_skeletons = unsafe { slice::from_raw_parts(hand_skeletons, 2) };\n let hand_skeletons = hand_skeletons\n .iter()\n .map(|&hand_skeleton| {\n (!hand_skeleton.is_null()).then(|| {\n let hand_skeleton = unsafe { slice::from_raw_parts(hand_skeleton, 26) };\n\n let mut array = [Pose::IDENTITY; 26];\n\n for (pose, capi_pose) in array.iter_mut().zip(hand_skeleton.iter()) {\n *pose = Pose {\n orientation: alvr_common::from_capi_quat(&capi_pose.orientation),\n position: Vec3::from_slice(&capi_pose.position),\n };\n }\n\n array\n })\n })\n .collect::>();\n\n [hand_skeletons[0], hand_skeletons[1]]\n } else {\n [None, None]\n };\n\n let eyes_combined = if !combined_eye_gaze.is_null() {\n Some(alvr_common::from_capi_quat(unsafe { &*combined_eye_gaze }))\n } else {\n None\n };\n\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.send_tracking(TrackingData {\n poll_timestamp: Duration::from_nanos(poll_timestamp_ns),\n device_motions,\n hand_skeletons,\n face: FaceData {\n eyes_combined,\n ..Default::default()\n },\n body: None,\n });\n }\n}\n\n/// Safety: `context` must be thread safe and valid until the StreamingStopped event.\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_set_decoder_input_callback(\n callback_context: *mut c_void,\n callback: extern \"C\" fn(AlvrVideoFrameData) -> bool,\n) {\n struct CallbackContext(*mut c_void);\n unsafe impl Send for CallbackContext {}\n\n let callback_context = CallbackContext(callback_context);\n\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.set_decoder_input_callback(Box::new(move |timestamp, buffer| {\n // Make sure to capture the struct itself instead of just the pointer to make the\n // borrow checker happy\n let callback_context = &callback_context;\n\n callback(AlvrVideoFrameData {\n callback_context: callback_context.0,\n timestamp_ns: timestamp.as_nanos() as u64,\n buffer_ptr: buffer.as_ptr(),\n buffer_size: buffer.len() as u64,\n })\n }));\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_report_frame_decoded(target_timestamp_ns: u64) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.report_frame_decoded(Duration::from_nanos(target_timestamp_ns));\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_report_fatal_decoder_error(message: *const c_char) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.report_fatal_decoder_error(unsafe { CStr::from_ptr(message).to_str().unwrap() });\n }\n}\n\n/// out_view_params must be a vector of 2 elements\n/// out_view_params is populated only if the core context is valid\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_report_compositor_start(\n target_timestamp_ns: u64,\n out_view_params: *mut AlvrViewParams,\n) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n let view_params =\n context.report_compositor_start(Duration::from_nanos(target_timestamp_ns));\n\n unsafe {\n *out_view_params = alvr_common::to_capi_view_params(&view_params[0]);\n *out_view_params.offset(1) = alvr_common::to_capi_view_params(&view_params[1]);\n }\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_report_submit(target_timestamp_ns: u64, vsync_queue_ns: u64) {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.report_submit(\n Duration::from_nanos(target_timestamp_ns),\n Duration::from_nanos(vsync_queue_ns),\n );\n }\n}\n\n// OpenGL-related interface\n\nthread_local! {\n static GRAPHICS_CONTEXT: RefCell>> = const { RefCell::new(None) };\n static LOBBY_RENDERER: RefCell> = const { RefCell::new(None) };\n static STREAM_RENDERER: RefCell> = const { RefCell::new(None) };\n}\n\n#[repr(C)]\npub struct AlvrLobbyViewParams {\n swapchain_index: u32,\n view_params: AlvrViewParams,\n}\n\n#[repr(C)]\npub struct AlvrStreamViewParams {\n swapchain_index: u32,\n reprojection_rotation: AlvrQuat,\n fov: AlvrFov,\n}\n\n#[repr(C)]\npub struct AlvrStreamConfig {\n view_resolution_width: u32,\n view_resolution_height: u32,\n swapchain_textures: *mut *const u32,\n swapchain_length: u32,\n enable_foveation: bool,\n foveation_center_size_x: f32,\n foveation_center_size_y: f32,\n foveation_center_shift_x: f32,\n foveation_center_shift_y: f32,\n foveation_edge_ratio_x: f32,\n foveation_edge_ratio_y: f32,\n enable_upscaling: bool,\n upscaling_edge_direction: bool,\n upscaling_edge_threshold: f32,\n upscaling_edge_sharpness: f32,\n upscale_factor: f32,\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_initialize_opengl() {\n GRAPHICS_CONTEXT.set(Some(Rc::new(GraphicsContext::new_gl())));\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_destroy_opengl() {\n GRAPHICS_CONTEXT.set(None);\n}\n\nfn convert_swapchain_array(\n swapchain_textures: *mut *const u32,\n swapchain_length: u32,\n) -> [Vec; 2] {\n let swapchain_length = swapchain_length as usize;\n let mut left_swapchain = vec![0; swapchain_length];\n unsafe {\n ptr::copy_nonoverlapping(\n *swapchain_textures,\n left_swapchain.as_mut_ptr(),\n swapchain_length,\n )\n };\n let mut right_swapchain = vec![0; swapchain_length];\n unsafe {\n ptr::copy_nonoverlapping(\n *swapchain_textures.offset(1),\n right_swapchain.as_mut_ptr(),\n swapchain_length,\n )\n };\n\n [left_swapchain, right_swapchain]\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_resume_opengl(\n preferred_view_width: u32,\n preferred_view_height: u32,\n swapchain_textures: *mut *const u32,\n swapchain_length: u32,\n) {\n LOBBY_RENDERER.set(Some(LobbyRenderer::new(\n GRAPHICS_CONTEXT.with_borrow(|c| c.as_ref().unwrap().clone()),\n UVec2::new(preferred_view_width, preferred_view_height),\n convert_swapchain_array(swapchain_textures, swapchain_length),\n \"\",\n )));\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_pause_opengl() {\n STREAM_RENDERER.set(None);\n LOBBY_RENDERER.set(None)\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_update_hud_message_opengl(message: *const c_char) {\n LOBBY_RENDERER.with_borrow(|renderer| {\n if let Some(renderer) = renderer {\n renderer.update_hud_message(unsafe { CStr::from_ptr(message) }.to_str().unwrap());\n }\n });\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_start_stream_opengl(config: AlvrStreamConfig) {\n let view_resolution = UVec2::new(config.view_resolution_width, config.view_resolution_height);\n let swapchain_textures =\n convert_swapchain_array(config.swapchain_textures, config.swapchain_length);\n let foveated_encoding = config.enable_foveation.then_some(FoveatedEncodingConfig {\n force_enable: true,\n center_size_x: config.foveation_center_size_x,\n center_size_y: config.foveation_center_size_y,\n center_shift_x: config.foveation_center_shift_x,\n center_shift_y: config.foveation_center_shift_y,\n edge_ratio_x: config.foveation_edge_ratio_x,\n edge_ratio_y: config.foveation_edge_ratio_y,\n });\n let upscaling = config.enable_upscaling.then_some(UpscalingConfig {\n edge_direction: config.upscaling_edge_direction,\n edge_sharpness: config.upscaling_edge_sharpness,\n edge_threshold: config.upscaling_edge_threshold,\n upscale_factor: config.upscale_factor,\n });\n\n STREAM_RENDERER.set(Some(StreamRenderer::new(\n GRAPHICS_CONTEXT.with_borrow(|c| c.as_ref().unwrap().clone()),\n view_resolution,\n alvr_graphics::compute_target_view_resolution(view_resolution, &upscaling),\n swapchain_textures,\n SDR_FORMAT_GL,\n foveated_encoding,\n true,\n false, // TODO: limited range fix config\n 1.0, // TODO: encoding gamma config\n upscaling,\n )));\n}\n\n// todo: support hands\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_render_lobby_opengl(\n view_inputs: *const AlvrLobbyViewParams,\n render_background: bool,\n) {\n let view_inputs = unsafe {\n [\n LobbyViewParams {\n swapchain_index: (*view_inputs).swapchain_index,\n view_params: alvr_common::from_capi_view_params(&(*view_inputs).view_params),\n },\n LobbyViewParams {\n swapchain_index: (*view_inputs.offset(1)).swapchain_index,\n view_params: alvr_common::from_capi_view_params(\n &(*view_inputs.offset(1)).view_params,\n ),\n },\n ]\n };\n\n LOBBY_RENDERER.with_borrow(|renderer| {\n if let Some(renderer) = renderer {\n renderer.render(\n view_inputs,\n [\n HandData {\n grip_motion: None,\n detached_grip_motion: None,\n skeleton_joints: None,\n },\n HandData {\n grip_motion: None,\n detached_grip_motion: None,\n skeleton_joints: None,\n },\n ],\n None,\n None,\n render_background,\n false,\n );\n }\n });\n}\n\n/// view_params: array of 2\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_render_stream_opengl(\n hardware_buffer: *mut c_void,\n view_params: *const AlvrStreamViewParams,\n) {\n STREAM_RENDERER.with_borrow(|renderer| {\n if let Some(renderer) = renderer {\n let left_params = unsafe { &*view_params };\n let right_params = unsafe { &*view_params.offset(1) };\n renderer.render(\n hardware_buffer,\n [\n StreamViewParams {\n swapchain_index: left_params.swapchain_index,\n input_view_params: ViewParams {\n pose: Pose::IDENTITY,\n fov: alvr_common::from_capi_fov(&left_params.fov),\n },\n output_view_params: ViewParams {\n pose: Pose {\n orientation: alvr_common::from_capi_quat(\n &left_params.reprojection_rotation,\n ),\n position: Vec3::ZERO,\n },\n fov: alvr_common::from_capi_fov(&left_params.fov),\n },\n },\n StreamViewParams {\n swapchain_index: right_params.swapchain_index,\n input_view_params: ViewParams {\n pose: Pose::IDENTITY,\n fov: alvr_common::from_capi_fov(&right_params.fov),\n },\n output_view_params: ViewParams {\n pose: Pose {\n orientation: alvr_common::from_capi_quat(\n &right_params.reprojection_rotation,\n ),\n position: Vec3::ZERO,\n },\n fov: alvr_common::from_capi_fov(&right_params.fov),\n },\n },\n ],\n None,\n );\n }\n });\n}\n\n// Decoder-related interface\n\nstatic DECODER_SOURCE: Mutex> = Mutex::new(None);\n\n#[repr(u8)]\npub enum AlvrMediacodecPropType {\n Float,\n Int32,\n Int64,\n String,\n}\n\n#[repr(C)]\npub union AlvrMediacodecPropValue {\n float_: f32,\n int32: i32,\n int64: i64,\n string: *const c_char,\n}\n\n#[repr(C)]\npub struct AlvrMediacodecOption {\n key: *const c_char,\n ty: AlvrMediacodecPropType,\n value: AlvrMediacodecPropValue,\n}\n\n#[repr(C)]\npub struct AlvrDecoderConfig {\n codec: AlvrCodecType,\n force_software_decoder: bool,\n max_buffering_frames: f32,\n buffering_history_weight: f32,\n options: *const AlvrMediacodecOption,\n options_count: u64,\n config_buffer: *const u8,\n config_buffer_size: u64,\n}\n\n/// alvr_initialize() must be called before alvr_create_decoder\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_create_decoder(config: AlvrDecoderConfig) {\n let config = VideoDecoderConfig {\n codec: match config.codec {\n AlvrCodecType::H264 => CodecType::H264,\n AlvrCodecType::Hevc => CodecType::Hevc,\n AlvrCodecType::AV1 => CodecType::AV1,\n },\n force_software_decoder: config.force_software_decoder,\n max_buffering_frames: config.max_buffering_frames,\n buffering_history_weight: config.buffering_history_weight,\n options: if !config.options.is_null() {\n let options =\n unsafe { slice::from_raw_parts(config.options, config.options_count as usize) };\n options\n .iter()\n .map(|option| unsafe {\n let key = CStr::from_ptr(option.key).to_str().unwrap();\n let prop = match option.ty {\n AlvrMediacodecPropType::Float => MediacodecProperty {\n ty: MediacodecPropType::Float,\n value: option.value.float_.to_string(),\n },\n AlvrMediacodecPropType::Int32 => MediacodecProperty {\n ty: MediacodecPropType::Int32,\n value: option.value.int32.to_string(),\n },\n AlvrMediacodecPropType::Int64 => MediacodecProperty {\n ty: MediacodecPropType::Int64,\n value: option.value.int64.to_string(),\n },\n AlvrMediacodecPropType::String => MediacodecProperty {\n ty: MediacodecPropType::String,\n value: CStr::from_ptr(option.value.string)\n .to_str()\n .unwrap()\n .to_owned(),\n },\n };\n\n (key.to_owned(), prop)\n })\n .collect()\n } else {\n vec![]\n },\n config_buffer: unsafe {\n slice::from_raw_parts(config.config_buffer, config.config_buffer_size as usize).to_vec()\n },\n };\n\n let (mut sink, source) =\n video_decoder::create_decoder(config, |maybe_timestamp: Result| {\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n match maybe_timestamp {\n Ok(timestamp) => context.report_frame_decoded(timestamp),\n Err(e) => context.report_fatal_decoder_error(&e.to_string()),\n }\n }\n });\n\n *DECODER_SOURCE.lock() = Some(source);\n\n if let Some(context) = &*CLIENT_CORE_CONTEXT.lock() {\n context.set_decoder_input_callback(Box::new(move |timestamp, buffer| {\n sink.push_nal(timestamp, buffer)\n }));\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_destroy_decoder() {\n *DECODER_SOURCE.lock() = None;\n}\n\n// Returns true if the timestamp and buffer has been written to\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_get_frame(\n out_timestamp_ns: *mut u64,\n out_buffer_ptr: *mut *mut c_void,\n) -> bool {\n if let Some(source) = &mut *DECODER_SOURCE.lock()\n && let Some((timestamp, buffer_ptr)) = source.get_frame()\n {\n unsafe {\n *out_timestamp_ns = timestamp.as_nanos() as u64;\n *out_buffer_ptr = buffer_ptr;\n }\n\n true\n } else {\n false\n }\n}\n\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_rotation_delta(source: AlvrQuat, destination: AlvrQuat) -> AlvrQuat {\n alvr_common::to_capi_quat(\n &(alvr_common::from_capi_quat(&source).inverse()\n * alvr_common::from_capi_quat(&destination)),\n )\n}\n"
},
{
"path": "alvr/client_core/src/connection.rs",
"content": "#![allow(clippy::if_same_then_else)]\n\nuse crate::{\n ClientCapabilities, ClientCoreEvent,\n logging_backend::{LOG_CHANNEL_SENDER, LogMirrorData},\n sockets::AnnouncerSocket,\n statistics::StatisticsManager,\n storage::Config,\n};\nuse alvr_common::{\n ALVR_VERSION, AnyhowToCon, ConResult, ConnectionError, ConnectionState, LifecycleState,\n ViewParams, dbg_connection, debug, error, info,\n parking_lot::{Condvar, Mutex, RwLock},\n wait_rwlock, warn,\n};\nuse alvr_packets::{\n AUDIO, ClientConnectionResult, ClientControlPacket, ClientStatistics, ConnectionAcceptedInfo,\n HAPTICS, Haptics, STATISTICS, ServerControlPacket, StreamConfigPacket, TRACKING, TrackingData,\n VIDEO, VideoPacketHeader, VideoStreamingCapabilities, VideoStreamingCapabilitiesExt,\n};\nuse alvr_session::{SocketProtocol, settings_schema::Switch};\nuse alvr_sockets::{\n ControlSocketSender, KEEPALIVE_INTERVAL, KEEPALIVE_TIMEOUT, PeerType, ProtoControlSocket,\n StreamSender, StreamSocketBuilder,\n};\nuse std::{\n collections::VecDeque,\n sync::{Arc, mpsc},\n thread,\n time::{Duration, Instant},\n};\n\n#[cfg(target_os = \"android\")]\nuse crate::audio;\n#[cfg(not(target_os = \"android\"))]\nuse alvr_audio as audio;\n\nconst INITIAL_MESSAGE: &str = concat!(\n \"Searching for streamer...\\n\",\n \"Open ALVR on your PC then click \\\"Trust\\\"\\n\",\n \"next to the device entry\",\n);\nconst SUCCESS_CONNECT_MESSAGE: &str = \"Successful connection!\\nPlease wait...\";\nconst STREAM_STARTING_MESSAGE: &str = \"The stream will begin soon\\nPlease wait...\";\nconst SERVER_RESTART_MESSAGE: &str = \"The streamer is restarting\\nPlease wait...\";\nconst SERVER_DISCONNECTED_MESSAGE: &str = \"The streamer has disconnected.\";\nconst CONNECTION_TIMEOUT_MESSAGE: &str = \"Connection timeout.\";\n\nconst SOCKET_INIT_RETRY_INTERVAL: Duration = Duration::from_millis(500);\nconst CONNECTION_RETRY_INTERVAL: Duration = Duration::from_secs(1);\nconst HANDSHAKE_ACTION_TIMEOUT: Duration = Duration::from_secs(2);\nconst STREAMING_RECV_TIMEOUT: Duration = Duration::from_millis(500);\n\nconst MAX_UNREAD_PACKETS: usize = 10; // Applies per stream\n\npub type DecoderCallback = dyn FnMut(Duration, &[u8]) -> bool + Send;\n\n#[derive(Default)]\npub struct ConnectionContext {\n pub state: RwLock,\n pub disconnected_notif: Condvar,\n pub control_sender: Mutex>>,\n pub tracking_sender: Mutex>>,\n pub statistics_sender: Mutex>>,\n pub statistics_manager: Mutex>,\n pub decoder_callback: Mutex>>,\n pub global_view_params_queue: Mutex>,\n pub max_prediction: RwLock,\n}\n\nfn set_hud_message(event_queue: &Mutex>, message: &str) {\n let message = format!(\n \"ALVR v{}\\nhostname: {}\\nIP: {}\\n\\n{message}\",\n *ALVR_VERSION,\n Config::load().hostname,\n alvr_system_info::local_ip(),\n );\n\n event_queue\n .lock()\n .push_back(ClientCoreEvent::UpdateHudMessage(message));\n}\n\nfn is_streaming(ctx: &ConnectionContext) -> bool {\n *ctx.state.read() == ConnectionState::Streaming\n}\n\npub fn connection_lifecycle_loop(\n capabilities: ClientCapabilities,\n ctx: Arc,\n lifecycle_state: Arc>,\n event_queue: Arc>>,\n) {\n dbg_connection!(\"connection_lifecycle_loop: Begin\");\n\n set_hud_message(&event_queue, INITIAL_MESSAGE);\n\n while *lifecycle_state.read() != LifecycleState::ShuttingDown {\n if *lifecycle_state.read() == LifecycleState::Resumed {\n if let Err(e) = connection_pipeline(\n capabilities.clone(),\n Arc::clone(&ctx),\n Arc::clone(&lifecycle_state),\n Arc::clone(&event_queue),\n ) {\n let message = format!(\"Connection error:\\n{e}\\nCheck the PC for more details\");\n set_hud_message(&event_queue, &message);\n error!(\"Connection error: {e}\");\n }\n } else {\n debug!(\"Skip try connection because the device is sleeping\");\n }\n\n *ctx.state.write() = ConnectionState::Disconnected;\n ctx.disconnected_notif.notify_all();\n\n thread::sleep(CONNECTION_RETRY_INTERVAL);\n }\n\n dbg_connection!(\"connection_lifecycle_loop: End\");\n}\n\nfn connection_pipeline(\n capabilities: ClientCapabilities,\n ctx: Arc,\n lifecycle_state: Arc>,\n event_queue: Arc>>,\n) -> ConResult {\n dbg_connection!(\"connection_pipeline: Begin\");\n\n let (mut proto_control_socket, server_ip) = {\n let config = Config::load();\n let announcer_socket = AnnouncerSocket::new(&config.hostname).to_con()?;\n let listener_socket =\n alvr_sockets::get_server_listener(HANDSHAKE_ACTION_TIMEOUT).to_con()?;\n\n loop {\n if *lifecycle_state.write() != LifecycleState::Resumed {\n return Ok(());\n }\n\n announcer_socket.announce().ok();\n\n if let Ok(pair) = ProtoControlSocket::connect_to(\n SOCKET_INIT_RETRY_INTERVAL,\n PeerType::Server(&listener_socket),\n ) {\n set_hud_message(&event_queue, SUCCESS_CONNECT_MESSAGE);\n break pair;\n }\n }\n };\n\n let mut connection_state_lock = ctx.state.write();\n let disconnect_notif = Arc::new(Condvar::new());\n\n *connection_state_lock = ConnectionState::Connecting;\n\n // TODO: Don't fetch cpal sample rate, get directly from AAudio\n let microphone_sample_rate =\n alvr_audio::input_sample_rate(&alvr_audio::new_input(None).to_con()?).to_con()?;\n\n dbg_connection!(\"connection_pipeline: Send stream capabilities\");\n proto_control_socket\n .send(&ClientConnectionResult::ConnectionAccepted(Box::new(\n ConnectionAcceptedInfo {\n client_protocol_id: alvr_common::protocol_id_u64(),\n platform_string: capabilities.platform.to_string(),\n server_ip,\n streaming_capabilities: Some(\n VideoStreamingCapabilities {\n default_view_resolution: capabilities.default_view_resolution,\n max_view_resolution: capabilities.max_view_resolution,\n refresh_rates: capabilities.refresh_rates,\n microphone_sample_rate,\n foveated_encoding: capabilities.foveated_encoding,\n encoder_high_profile: capabilities.encoder_high_profile,\n encoder_10_bits: capabilities.encoder_10_bits,\n encoder_av1: capabilities.encoder_av1,\n prefer_10bit: capabilities.prefer_10bit,\n preferred_encoding_gamma: capabilities.preferred_encoding_gamma,\n prefer_hdr: capabilities.prefer_hdr,\n ext_str: String::new(),\n }\n .with_ext(VideoStreamingCapabilitiesExt {}),\n ),\n },\n )))\n .to_con()?;\n let config_packet =\n proto_control_socket.recv::(HANDSHAKE_ACTION_TIMEOUT)?;\n dbg_connection!(\"connection_pipeline: stream config received\");\n\n let stream_config = config_packet.to_stream_config().to_con()?;\n\n let streaming_start_event = ClientCoreEvent::StreamingStarted(Box::new(stream_config.clone()));\n\n let settings = stream_config.settings;\n let negotiated_config = stream_config.negotiated_config;\n\n *ctx.max_prediction.write() = Duration::from_millis(settings.headset.max_prediction_ms);\n\n *ctx.statistics_manager.lock() = Some(StatisticsManager::new(\n settings.connection.statistics_history_size,\n ));\n\n let (mut control_sender, mut control_receiver) = proto_control_socket\n .split(STREAMING_RECV_TIMEOUT)\n .to_con()?;\n\n match control_receiver.recv(HANDSHAKE_ACTION_TIMEOUT) {\n Ok(ServerControlPacket::StartStream) => {\n info!(\"Stream starting\");\n set_hud_message(&event_queue, STREAM_STARTING_MESSAGE);\n }\n Ok(ServerControlPacket::Restarting) => {\n info!(\"Server restarting\");\n set_hud_message(&event_queue, SERVER_RESTART_MESSAGE);\n return Ok(());\n }\n Err(e) => {\n info!(\"Server disconnected. Cause: {e}\");\n set_hud_message(&event_queue, SERVER_DISCONNECTED_MESSAGE);\n return Ok(());\n }\n _ => {\n info!(\"Unexpected packet\");\n set_hud_message(&event_queue, \"Unexpected packet\");\n return Ok(());\n }\n }\n\n let stream_protocol = if negotiated_config.wired {\n SocketProtocol::Tcp\n } else {\n settings.connection.stream_protocol\n };\n\n dbg_connection!(\"connection_pipeline: create StreamSocket\");\n let stream_socket_builder = StreamSocketBuilder::listen_for_server(\n Duration::from_secs(1),\n settings.connection.stream_port,\n stream_protocol,\n settings.connection.dscp,\n settings.connection.client_buffer_config,\n )\n .to_con()?;\n\n dbg_connection!(\"connection_pipeline: Send StreamReady\");\n if let Err(e) = control_sender.send(&ClientControlPacket::StreamReady) {\n info!(\"Server disconnected. Cause: {e:?}\");\n set_hud_message(&event_queue, SERVER_DISCONNECTED_MESSAGE);\n return Ok(());\n }\n\n dbg_connection!(\"connection_pipeline: accept connection\");\n let mut stream_socket = stream_socket_builder.accept_from_server(\n server_ip,\n settings.connection.stream_port,\n settings.connection.packet_size as _,\n HANDSHAKE_ACTION_TIMEOUT,\n )?;\n\n info!(\"Connected to server\");\n\n let mut video_receiver =\n stream_socket.subscribe_to_stream::(VIDEO, MAX_UNREAD_PACKETS);\n let mut game_audio_receiver = stream_socket.subscribe_to_stream(AUDIO, MAX_UNREAD_PACKETS);\n let tracking_sender = stream_socket.request_stream(TRACKING);\n let mut haptics_receiver =\n stream_socket.subscribe_to_stream::(HAPTICS, MAX_UNREAD_PACKETS);\n let statistics_sender = stream_socket.request_stream(STATISTICS);\n\n let video_receive_thread = thread::spawn({\n let ctx = Arc::clone(&ctx);\n move || {\n let mut stream_corrupted = true;\n while is_streaming(&ctx) {\n let data = match video_receiver.recv(STREAMING_RECV_TIMEOUT) {\n Ok(data) => data,\n Err(ConnectionError::TryAgain(_)) => continue,\n Err(ConnectionError::Other(_)) => return,\n };\n let Ok((header, nal)) = data.get() else {\n return;\n };\n\n if let Some(stats) = &mut *ctx.statistics_manager.lock() {\n stats.report_video_packet_received(header.timestamp);\n }\n\n if header.is_idr {\n stream_corrupted = false;\n } else if data.had_packet_loss() {\n stream_corrupted = true;\n if let Some(sender) = &mut *ctx.control_sender.lock() {\n sender.send(&ClientControlPacket::RequestIdr).ok();\n }\n warn!(\"Network dropped video packet\");\n }\n\n if !stream_corrupted || !settings.connection.avoid_video_glitching {\n // The view params must be enqueued before calling the decoder callback, there\n // is no problem if the callback fails\n {\n let global_view_params_queue_lock =\n &mut ctx.global_view_params_queue.lock();\n\n global_view_params_queue_lock\n .push_back((header.timestamp, header.global_view_params));\n\n while global_view_params_queue_lock.len() > 128 {\n global_view_params_queue_lock.pop_front();\n }\n }\n\n let submitted = ctx\n .decoder_callback\n .lock()\n .as_mut()\n .is_some_and(|callback| callback(header.timestamp, nal));\n\n if !submitted {\n stream_corrupted = true;\n if let Some(sender) = &mut *ctx.control_sender.lock() {\n sender.send(&ClientControlPacket::RequestIdr).ok();\n }\n warn!(\"Dropped video packet. Reason: Decoder saturation\")\n }\n } else {\n if let Some(sender) = &mut *ctx.control_sender.lock() {\n sender.send(&ClientControlPacket::RequestIdr).ok();\n }\n warn!(\"Dropped video packet. Reason: Waiting for IDR frame\")\n }\n }\n }\n });\n\n let game_audio_thread = if let Switch::Enabled(config) = settings.audio.game_audio {\n let device = alvr_audio::new_output(None).to_con()?;\n thread::spawn({\n let ctx = Arc::clone(&ctx);\n move || {\n while is_streaming(&ctx) {\n alvr_common::show_err(audio::play_audio_loop(\n || is_streaming(&ctx),\n &device,\n 2,\n negotiated_config.game_audio_sample_rate,\n config.buffering.clone(),\n &mut game_audio_receiver,\n ));\n }\n }\n })\n } else {\n thread::spawn(|| ())\n };\n\n let microphone_thread = if matches!(settings.audio.microphone, Switch::Enabled(_)) {\n let device = alvr_audio::new_input(None).to_con()?;\n\n let microphone_sender = stream_socket.request_stream(AUDIO);\n\n thread::spawn({\n let ctx = Arc::clone(&ctx);\n move || {\n while is_streaming(&ctx) {\n let ctx = Arc::clone(&ctx);\n match audio::record_audio_blocking(\n Arc::new(move || is_streaming(&ctx)),\n microphone_sender.clone(),\n &device,\n 1,\n false,\n ) {\n Ok(()) => break,\n Err(e) => {\n error!(\"Audio record error: {e}\");\n\n continue;\n }\n }\n }\n }\n })\n } else {\n thread::spawn(|| ())\n };\n\n let haptics_receive_thread = thread::spawn({\n let ctx = Arc::clone(&ctx);\n let event_queue = Arc::clone(&event_queue);\n move || {\n while is_streaming(&ctx) {\n let data = match haptics_receiver.recv(STREAMING_RECV_TIMEOUT) {\n Ok(packet) => packet,\n Err(ConnectionError::TryAgain(_)) => continue,\n Err(ConnectionError::Other(_)) => return,\n };\n let Ok(haptics) = data.get_header() else {\n return;\n };\n\n event_queue.lock().push_back(ClientCoreEvent::Haptics {\n device_id: haptics.device_id,\n duration: haptics.duration,\n frequency: haptics.frequency,\n amplitude: haptics.amplitude,\n });\n }\n }\n });\n\n let (log_channel_sender, log_channel_receiver) = mpsc::channel();\n\n let control_send_thread = thread::spawn({\n let ctx = Arc::clone(&ctx);\n let event_queue = Arc::clone(&event_queue);\n let disconnect_notif = Arc::clone(&disconnect_notif);\n move || {\n let mut keepalive_deadline = Instant::now();\n\n #[cfg(target_os = \"android\")]\n let mut battery_deadline = Instant::now();\n\n while is_streaming(&ctx) && *lifecycle_state.read() == LifecycleState::Resumed {\n if let Ok(packet) = log_channel_receiver.recv_timeout(STREAMING_RECV_TIMEOUT)\n && let Some(sender) = &mut *ctx.control_sender.lock()\n && let Err(e) = sender.send(&packet)\n {\n info!(\"Server disconnected. Cause: {e:?}\");\n set_hud_message(&event_queue, SERVER_DISCONNECTED_MESSAGE);\n\n break;\n }\n\n if Instant::now() > keepalive_deadline\n && let Some(sender) = &mut *ctx.control_sender.lock()\n {\n sender.send(&ClientControlPacket::KeepAlive).ok();\n\n keepalive_deadline = Instant::now() + KEEPALIVE_INTERVAL;\n }\n\n #[cfg(target_os = \"android\")]\n if Instant::now() > battery_deadline {\n let (gauge_value, is_plugged) = alvr_system_info::get_battery_status();\n if let Some(sender) = &mut *ctx.control_sender.lock() {\n sender\n .send(&ClientControlPacket::Battery(crate::BatteryInfo {\n device_id: *alvr_common::HEAD_ID,\n gauge_value,\n is_plugged,\n }))\n .ok();\n }\n\n battery_deadline = Instant::now() + Duration::from_secs(5);\n }\n }\n\n disconnect_notif.notify_one();\n }\n });\n\n let control_receive_thread = thread::spawn({\n let ctx = Arc::clone(&ctx);\n let event_queue = Arc::clone(&event_queue);\n let disconnect_notif = Arc::clone(&disconnect_notif);\n move || {\n let mut disconnection_deadline = Instant::now() + KEEPALIVE_TIMEOUT;\n while is_streaming(&ctx) {\n let maybe_packet = control_receiver.recv(STREAMING_RECV_TIMEOUT);\n\n match maybe_packet {\n Ok(ServerControlPacket::DecoderConfig(config)) => {\n event_queue\n .lock()\n .push_back(ClientCoreEvent::DecoderConfig {\n codec: config.codec,\n config_nal: config.config_buffer,\n });\n }\n Ok(ServerControlPacket::Restarting) => {\n info!(\"{SERVER_RESTART_MESSAGE}\");\n set_hud_message(&event_queue, SERVER_RESTART_MESSAGE);\n disconnect_notif.notify_one();\n }\n Ok(ServerControlPacket::RealTimeConfig(config)) => {\n event_queue\n .lock()\n .push_back(ClientCoreEvent::RealTimeConfig(config));\n }\n Ok(ServerControlPacket::StartStream) => {\n error!(\"Unexpected StartStream paceket\");\n }\n Ok(ServerControlPacket::KeepAlive) => (),\n Ok(\n ServerControlPacket::Reserved(_) | ServerControlPacket::ReservedBuffer(_),\n ) => {}\n Err(ConnectionError::TryAgain(_)) => {\n if Instant::now() > disconnection_deadline {\n info!(\"{CONNECTION_TIMEOUT_MESSAGE}\");\n set_hud_message(&event_queue, CONNECTION_TIMEOUT_MESSAGE);\n disconnect_notif.notify_one();\n } else {\n continue;\n }\n }\n Err(e) => {\n info!(\"{SERVER_DISCONNECTED_MESSAGE} Cause: {e}\");\n set_hud_message(&event_queue, SERVER_DISCONNECTED_MESSAGE);\n disconnect_notif.notify_one();\n }\n }\n\n disconnection_deadline = Instant::now() + KEEPALIVE_TIMEOUT;\n }\n }\n });\n\n let stream_receive_thread = thread::spawn({\n let ctx = Arc::clone(&ctx);\n let event_queue = Arc::clone(&event_queue);\n let disconnect_notif = Arc::clone(&disconnect_notif);\n move || {\n while is_streaming(&ctx) {\n match stream_socket.recv() {\n Ok(()) => (),\n Err(ConnectionError::TryAgain(_)) => continue,\n Err(e) => {\n info!(\"Client disconnected. Cause: {e}\");\n set_hud_message(&event_queue, SERVER_DISCONNECTED_MESSAGE);\n disconnect_notif.notify_one();\n }\n }\n }\n }\n });\n\n *ctx.control_sender.lock() = Some(control_sender);\n *ctx.tracking_sender.lock() = Some(tracking_sender);\n *ctx.statistics_sender.lock() = Some(statistics_sender);\n if let Switch::Enabled(filter_level) = settings.extra.logging.client_log_report_level {\n *LOG_CHANNEL_SENDER.lock() = Some(LogMirrorData {\n sender: log_channel_sender,\n filter_level,\n debug_groups_config: settings.extra.logging.debug_groups,\n });\n }\n event_queue.lock().push_back(streaming_start_event);\n\n *connection_state_lock = ConnectionState::Streaming;\n\n dbg_connection!(\"connection_pipeline: Unlock streams\");\n\n // Unlock CONNECTION_STATE and block thread\n wait_rwlock(&disconnect_notif, &mut connection_state_lock);\n\n *connection_state_lock = ConnectionState::Disconnecting;\n\n *ctx.control_sender.lock() = None;\n *ctx.tracking_sender.lock() = None;\n *ctx.statistics_sender.lock() = None;\n *LOG_CHANNEL_SENDER.lock() = None;\n\n event_queue\n .lock()\n .push_back(ClientCoreEvent::StreamingStopped);\n\n // Remove lock to allow threads to properly exit:\n drop(connection_state_lock);\n\n dbg_connection!(\"connection_pipeline: Destroying streams\");\n\n video_receive_thread.join().ok();\n game_audio_thread.join().ok();\n microphone_thread.join().ok();\n haptics_receive_thread.join().ok();\n control_send_thread.join().ok();\n control_receive_thread.join().ok();\n stream_receive_thread.join().ok();\n\n dbg_connection!(\"connection_pipeline: End\");\n\n Ok(())\n}\n"
},
{
"path": "alvr/client_core/src/lib.rs",
"content": "#![allow(\n non_upper_case_globals,\n non_snake_case,\n clippy::missing_safety_doc,\n clippy::unseparated_literal_suffix\n)]\n\nmod c_api;\nmod connection;\nmod logging_backend;\nmod sockets;\nmod statistics;\nmod storage;\n\n#[cfg(target_os = \"android\")]\nmod audio;\n\npub mod video_decoder;\n\nuse alvr_common::{\n ConnectionState, LifecycleState, ViewParams, dbg_client_core, error,\n glam::{UVec2, Vec2},\n parking_lot::{Mutex, RwLock},\n warn,\n};\nuse alvr_packets::{\n BatteryInfo, ButtonEntry, ClientControlPacket, RealTimeConfig, StreamConfig, TrackingData,\n};\nuse alvr_session::CodecType;\nuse alvr_system_info::Platform;\nuse connection::{ConnectionContext, DecoderCallback};\nuse std::{\n collections::{HashSet, VecDeque},\n sync::Arc,\n thread::{self, JoinHandle},\n time::Duration,\n};\nuse storage::Config;\n\npub use logging_backend::init_logging;\n\npub enum ClientCoreEvent {\n UpdateHudMessage(String),\n StreamingStarted(Box),\n StreamingStopped,\n Haptics {\n device_id: u64,\n duration: Duration,\n frequency: f32,\n amplitude: f32,\n },\n // Note: All subsequent DecoderConfig events should be ignored until reconnection\n DecoderConfig {\n codec: CodecType,\n config_nal: Vec,\n },\n RealTimeConfig(RealTimeConfig),\n}\n\n// Note: this struct may change without breaking network protocol changes\n#[derive(Clone)]\npub struct ClientCapabilities {\n pub platform: Platform,\n pub default_view_resolution: UVec2,\n pub max_view_resolution: UVec2,\n pub refresh_rates: Vec,\n pub foveated_encoding: bool,\n pub encoder_high_profile: bool,\n pub encoder_10_bits: bool,\n pub encoder_av1: bool,\n pub prefer_10bit: bool,\n pub preferred_encoding_gamma: f32,\n pub prefer_hdr: bool,\n}\n\npub struct ClientCoreContext {\n platform: Platform,\n lifecycle_state: Arc>,\n event_queue: Arc>>,\n connection_context: Arc,\n connection_thread: Arc>>>,\n last_good_global_view_params: Mutex<[ViewParams; 2]>,\n}\n\nimpl ClientCoreContext {\n pub fn new(capabilities: ClientCapabilities) -> Self {\n dbg_client_core!(\"Create\");\n\n // Make sure to reset config in case of version compat mismatch.\n if Config::load().protocol_id != alvr_common::protocol_id() {\n // NB: Config::default() sets the current protocol ID\n Config::default().store();\n }\n\n #[cfg(target_os = \"android\")]\n {\n dbg_client_core!(\"Getting permissions\");\n alvr_system_info::try_get_permission(alvr_system_info::MICROPHONE_PERMISSION);\n alvr_system_info::set_wifi_lock(true);\n }\n\n let platform = capabilities.platform;\n\n let lifecycle_state = Arc::new(RwLock::new(LifecycleState::Idle));\n let event_queue = Arc::new(Mutex::new(VecDeque::new()));\n let connection_context = Arc::new(ConnectionContext::default());\n let connection_thread = thread::spawn({\n let lifecycle_state = Arc::clone(&lifecycle_state);\n let connection_context = Arc::clone(&connection_context);\n let event_queue = Arc::clone(&event_queue);\n move || {\n connection::connection_lifecycle_loop(\n capabilities,\n connection_context,\n lifecycle_state,\n event_queue,\n )\n }\n });\n\n Self {\n platform,\n lifecycle_state,\n event_queue,\n connection_context,\n connection_thread: Arc::new(Mutex::new(Some(connection_thread))),\n last_good_global_view_params: Mutex::new([ViewParams::DUMMY; 2]),\n }\n }\n\n pub fn resume(&self) {\n dbg_client_core!(\"resume\");\n\n *self.lifecycle_state.write() = LifecycleState::Resumed;\n }\n\n pub fn pause(&self) {\n dbg_client_core!(\"pause\");\n\n let mut connection_state_lock = self.connection_context.state.write();\n\n *self.lifecycle_state.write() = LifecycleState::Idle;\n\n // We want to shutdown streaming when pausing.\n if *connection_state_lock != ConnectionState::Disconnected {\n alvr_common::wait_rwlock(\n &self.connection_context.disconnected_notif,\n &mut connection_state_lock,\n );\n }\n }\n\n pub fn poll_event(&self) -> Option {\n dbg_client_core!(\"poll_event\");\n\n self.event_queue.lock().pop_front()\n }\n\n pub fn send_battery(&self, device_id: u64, gauge_value: f32, is_plugged: bool) {\n dbg_client_core!(\"send_battery\");\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender\n .send(&ClientControlPacket::Battery(BatteryInfo {\n device_id,\n gauge_value,\n is_plugged,\n }))\n .ok();\n }\n }\n\n pub fn send_playspace(&self, area: Option) {\n dbg_client_core!(\"send_playspace\");\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender.send(&ClientControlPacket::PlayspaceSync(area)).ok();\n }\n }\n\n pub fn send_active_interaction_profile(\n &self,\n device_id: u64,\n profile_id: u64,\n input_ids: HashSet,\n ) {\n dbg_client_core!(\"send_active_interaction_profile\");\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender\n .send(&ClientControlPacket::ActiveInteractionProfile {\n device_id,\n profile_id,\n input_ids,\n })\n .ok();\n }\n }\n\n pub fn send_buttons(&self, entries: Vec) {\n dbg_client_core!(\"send_buttons\");\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender.send(&ClientControlPacket::Buttons(entries)).ok();\n }\n }\n\n // These must be in its local space, as if the head pose is in the origin.\n pub fn send_view_params(&self, views: [ViewParams; 2]) {\n dbg_client_core!(\"send_view_params\");\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender\n .send(&ClientControlPacket::LocalViewParams(views))\n .ok();\n }\n }\n\n pub fn send_tracking(&self, data: TrackingData) {\n dbg_client_core!(\"send_tracking\");\n\n if let Some(sender) = &mut *self.connection_context.tracking_sender.lock() {\n sender.send_header(&data).ok();\n\n if let Some(stats) = &mut *self.connection_context.statistics_manager.lock() {\n stats.report_input_acquired(data.poll_timestamp);\n }\n }\n }\n\n pub fn send_proximity_state(&self, headset_is_worn: bool) {\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender\n .send(&ClientControlPacket::ProximityState(headset_is_worn))\n .ok();\n }\n }\n\n pub fn get_total_prediction_offset(&self) -> Duration {\n dbg_client_core!(\"get_total_prediction_offset\");\n\n if let Some(stats) = &*self.connection_context.statistics_manager.lock() {\n Duration::min(\n stats.average_total_pipeline_latency(),\n *self.connection_context.max_prediction.read(),\n )\n } else {\n Duration::ZERO\n }\n }\n\n /// The callback should return true if the frame was successfully submitted to the decoder\n pub fn set_decoder_input_callback(&self, callback: Box) {\n dbg_client_core!(\"set_decoder_input_callback\");\n\n *self.connection_context.decoder_callback.lock() = Some(callback);\n\n if let Some(sender) = &mut *self.connection_context.control_sender.lock() {\n sender.send(&ClientControlPacket::RequestIdr).ok();\n }\n }\n\n pub fn report_frame_decoded(&self, timestamp: Duration) {\n dbg_client_core!(\"report_frame_decoded\");\n\n if let Some(stats) = &mut *self.connection_context.statistics_manager.lock() {\n stats.report_frame_decoded(timestamp);\n }\n }\n\n pub fn report_fatal_decoder_error(&self, error: &str) {\n error!(\"Fatal decoder error, restarting connection: {error}\");\n\n // The connection loop observes changes on this value\n *self.connection_context.state.write() = ConnectionState::Disconnecting;\n }\n\n pub fn report_compositor_start(&self, timestamp: Duration) -> [ViewParams; 2] {\n dbg_client_core!(\"report_compositor_start\");\n\n if let Some(stats) = &mut *self.connection_context.statistics_manager.lock() {\n stats.report_compositor_start(timestamp);\n }\n\n let global_view_params_lock = &mut *self.last_good_global_view_params.lock();\n for (ts, params) in &*self.connection_context.global_view_params_queue.lock() {\n if *ts == timestamp {\n *global_view_params_lock = *params;\n break;\n }\n }\n\n *global_view_params_lock\n }\n\n pub fn report_submit(&self, timestamp: Duration, vsync_queue: Duration) {\n dbg_client_core!(\"report_submit\");\n\n if let Some(stats) = &mut *self.connection_context.statistics_manager.lock() {\n stats.report_submit(timestamp, vsync_queue);\n\n if let Some(sender) = &mut *self.connection_context.statistics_sender.lock() {\n if let Some(stats) = stats.summary(timestamp) {\n sender.send_header(&stats).ok();\n } else {\n warn!(\"Statistics summary not ready!\");\n }\n }\n }\n }\n\n pub fn platform(&self) -> Platform {\n self.platform\n }\n}\n\nimpl Drop for ClientCoreContext {\n fn drop(&mut self) {\n dbg_client_core!(\"Drop\");\n\n *self.lifecycle_state.write() = LifecycleState::ShuttingDown;\n\n if let Some(thread) = self.connection_thread.lock().take() {\n thread.join().ok();\n }\n\n #[cfg(target_os = \"android\")]\n alvr_system_info::set_wifi_lock(false);\n }\n}\n"
},
{
"path": "alvr/client_core/src/logging_backend.rs",
"content": "use alvr_common::{\n DebugGroupsConfig, LogSeverity,\n log::{Level, Record},\n parking_lot::Mutex,\n};\nuse alvr_packets::ClientControlPacket;\nuse std::{\n sync::{LazyLock, mpsc},\n time::{Duration, Instant},\n};\n\nconst LOG_REPEAT_TIMEOUT: Duration = Duration::from_secs(1);\n\npub struct LogMirrorData {\n pub sender: mpsc::Sender,\n pub filter_level: LogSeverity,\n pub debug_groups_config: DebugGroupsConfig,\n}\n\npub static LOG_CHANNEL_SENDER: Mutex> = Mutex::new(None);\n\nstruct RepeatedLogEvent {\n message: String,\n repetition_times: usize,\n initial_timestamp: Instant,\n}\n\nstatic LAST_LOG_EVENT: LazyLock> = LazyLock::new(|| {\n Mutex::new(RepeatedLogEvent {\n message: \"\".into(),\n repetition_times: 0,\n initial_timestamp: Instant::now(),\n })\n});\n\npub fn init_logging() {\n fn send_log(record: &Record) -> bool {\n let Some(data) = &*LOG_CHANNEL_SENDER.lock() else {\n // if channel has not been setup, always print everything to stdout\n // todo: the client debug groups settings should be moved client side when feasible\n return true;\n };\n\n let level = match record.level() {\n Level::Error => LogSeverity::Error,\n Level::Warn => LogSeverity::Warning,\n Level::Info => LogSeverity::Info,\n Level::Debug | Level::Trace => LogSeverity::Debug,\n };\n if level < data.filter_level {\n return false;\n }\n\n let message = format!(\"{}\", record.args());\n\n if !alvr_common::filter_debug_groups(&message, &data.debug_groups_config) {\n return false;\n }\n\n let mut last_log_event_lock = LAST_LOG_EVENT.lock();\n\n if last_log_event_lock.message == message\n && last_log_event_lock.initial_timestamp + LOG_REPEAT_TIMEOUT > Instant::now()\n {\n last_log_event_lock.repetition_times += 1;\n } else {\n if last_log_event_lock.repetition_times > 1 {\n data.sender\n .send(ClientControlPacket::Log {\n level: LogSeverity::Info,\n message: format!(\n \"Last log line repeated {} times\",\n last_log_event_lock.repetition_times\n ),\n })\n .ok();\n }\n\n *last_log_event_lock = RepeatedLogEvent {\n message: message.clone(),\n repetition_times: 1,\n initial_timestamp: Instant::now(),\n };\n\n data.sender\n .send(ClientControlPacket::Log { level, message })\n .ok();\n }\n\n true\n }\n\n #[cfg(target_os = \"android\")]\n {\n android_logger::init_once(\n android_logger::Config::default()\n .with_tag(\"[ALVR NATIVE-RUST]\")\n .format(|f, record| {\n if send_log(record) {\n writeln!(f, \"{}\", record.args())\n } else {\n Ok(())\n }\n })\n .with_max_level(alvr_common::log::LevelFilter::Info),\n );\n }\n #[cfg(not(target_os = \"android\"))]\n {\n use std::io::Write;\n env_logger::builder()\n .format(|f, record| {\n if send_log(record) {\n writeln!(f, \"{}\", record.args())\n } else {\n Ok(())\n }\n })\n .try_init()\n .ok();\n }\n\n alvr_common::set_panic_hook();\n}\n"
},
{
"path": "alvr/client_core/src/sockets.rs",
"content": "use alvr_common::anyhow::{Result, bail};\nuse mdns_sd::{ServiceDaemon, ServiceInfo};\n\npub struct AnnouncerSocket {\n hostname: String,\n daemon: ServiceDaemon,\n}\n\nimpl AnnouncerSocket {\n pub fn new(hostname: &str) -> Result {\n let daemon = ServiceDaemon::new()?;\n\n Ok(Self {\n daemon,\n hostname: hostname.to_owned(),\n })\n }\n\n pub fn announce(&self) -> Result<()> {\n let local_ip = alvr_system_info::local_ip();\n if local_ip.is_unspecified() {\n bail!(\"IP is unspecified\");\n }\n\n self.daemon.register(ServiceInfo::new(\n alvr_sockets::MDNS_SERVICE_TYPE,\n &format!(\"alvr{}\", rand::random::()),\n &self.hostname,\n local_ip,\n 5353,\n &[(\n alvr_sockets::MDNS_PROTOCOL_KEY,\n alvr_common::protocol_id().as_str(),\n )][..],\n )?)?;\n\n Ok(())\n }\n}\n"
},
{
"path": "alvr/client_core/src/statistics.rs",
"content": "use alvr_common::SlidingWindowAverage;\nuse alvr_packets::ClientStatistics;\nuse std::{\n collections::VecDeque,\n time::{Duration, Instant},\n};\n\nstruct HistoryFrame {\n input_acquired: Instant,\n video_packet_received: Instant,\n client_stats: ClientStatistics,\n}\n\npub struct StatisticsManager {\n history_buffer: VecDeque,\n max_history_size: usize,\n prev_vsync: Instant,\n total_pipeline_latency_average: SlidingWindowAverage,\n}\n\nimpl StatisticsManager {\n pub fn new(max_history_size: usize) -> Self {\n Self {\n max_history_size,\n history_buffer: VecDeque::new(),\n prev_vsync: Instant::now(),\n total_pipeline_latency_average: SlidingWindowAverage::new(\n Duration::ZERO,\n max_history_size,\n ),\n }\n }\n\n pub fn report_input_acquired(&mut self, target_timestamp: Duration) {\n if !self\n .history_buffer\n .iter()\n .any(|frame| frame.client_stats.target_timestamp == target_timestamp)\n {\n self.history_buffer.push_front(HistoryFrame {\n input_acquired: Instant::now(),\n // this is just a placeholder because Instant does not have a default value\n video_packet_received: Instant::now(),\n client_stats: ClientStatistics {\n target_timestamp,\n ..Default::default()\n },\n });\n }\n\n if self.history_buffer.len() > self.max_history_size {\n self.history_buffer.pop_back();\n }\n }\n\n pub fn report_video_packet_received(&mut self, target_timestamp: Duration) {\n if let Some(frame) = self\n .history_buffer\n .iter_mut()\n .find(|frame| frame.client_stats.target_timestamp == target_timestamp)\n {\n frame.video_packet_received = Instant::now();\n }\n }\n\n pub fn report_frame_decoded(&mut self, target_timestamp: Duration) {\n if let Some(frame) = self\n .history_buffer\n .iter_mut()\n .find(|frame| frame.client_stats.target_timestamp == target_timestamp)\n {\n frame.client_stats.video_decode =\n Instant::now().saturating_duration_since(frame.video_packet_received);\n }\n }\n\n pub fn report_compositor_start(&mut self, target_timestamp: Duration) {\n if let Some(frame) = self\n .history_buffer\n .iter_mut()\n .find(|frame| frame.client_stats.target_timestamp == target_timestamp)\n {\n frame.client_stats.video_decoder_queue = Instant::now().saturating_duration_since(\n frame.video_packet_received + frame.client_stats.video_decode,\n );\n }\n }\n\n // vsync_queue is the latency between this call and the vsync. it cannot be measured by ALVR and\n // should be reported by the VR runtime\n pub fn report_submit(&mut self, target_timestamp: Duration, vsync_queue: Duration) {\n let now = Instant::now();\n\n if let Some(frame) = self\n .history_buffer\n .iter_mut()\n .find(|frame| frame.client_stats.target_timestamp == target_timestamp)\n {\n frame.client_stats.rendering = now.saturating_duration_since(\n frame.video_packet_received\n + frame.client_stats.video_decode\n + frame.client_stats.video_decoder_queue,\n );\n frame.client_stats.vsync_queue = vsync_queue;\n frame.client_stats.total_pipeline_latency =\n now.saturating_duration_since(frame.input_acquired) + vsync_queue;\n self.total_pipeline_latency_average\n .submit_sample(frame.client_stats.total_pipeline_latency);\n\n let vsync = now + vsync_queue;\n frame.client_stats.frame_interval = vsync.saturating_duration_since(self.prev_vsync);\n self.prev_vsync = vsync;\n }\n }\n\n pub fn summary(&self, target_timestamp: Duration) -> Option {\n self.history_buffer\n .iter()\n .find(|frame| frame.client_stats.target_timestamp == target_timestamp)\n .map(|frame| frame.client_stats.clone())\n }\n\n // latency used for head prediction\n pub fn average_total_pipeline_latency(&self) -> Duration {\n self.total_pipeline_latency_average.get_average()\n }\n}\n"
},
{
"path": "alvr/client_core/src/storage.rs",
"content": "use alvr_common::{error, info};\nuse app_dirs2::{AppDataType, AppInfo};\nuse rand::Rng;\nuse serde::{Deserialize, Serialize};\nuse std::{fs, path::PathBuf};\n\nfn config_path() -> PathBuf {\n app_dirs2::app_root(\n AppDataType::UserConfig,\n &AppInfo {\n name: \"ALVR Client\",\n author: \"ALVR\",\n },\n )\n .unwrap()\n .join(\"session.json\")\n}\n\n#[derive(Serialize, Deserialize)]\npub struct Config {\n pub hostname: String,\n pub protocol_id: String,\n}\n\nimpl Default for Config {\n fn default() -> Self {\n let mut rng = rand::rng();\n\n Self {\n hostname: format!(\n \"{}{}{}{}.client.local.\",\n rng.random_range(0..10),\n rng.random_range(0..10),\n rng.random_range(0..10),\n rng.random_range(0..10),\n ),\n protocol_id: alvr_common::protocol_id(),\n }\n }\n}\n\nimpl Config {\n pub fn load() -> Self {\n if let Ok(config_string) = fs::read_to_string(config_path()) {\n // Failure happens if the Config signature changed between versions.\n // todo: recover data from mismatched Config signature. low priority\n if let Ok(config) = serde_json::from_str(&config_string) {\n return config;\n } else {\n info!(\"Error parsing ALVR config. Using default\");\n }\n } else {\n info!(\"Error reading ALVR config. Using default\");\n }\n\n let config = Config::default();\n config.store();\n\n config\n }\n\n pub fn store(&self) {\n let config_string = serde_json::to_string(self).unwrap();\n if let Err(e) = fs::write(config_path(), config_string) {\n error!(\"Error writing ALVR config: {e}\")\n }\n }\n}\n"
},
{
"path": "alvr/client_core/src/video_decoder/android.rs",
"content": "use super::VideoDecoderConfig;\nuse alvr_common::{\n RelaxedAtomic, ToAny,\n anyhow::{Context, Result, anyhow, bail},\n error, info,\n parking_lot::{Condvar, Mutex},\n warn,\n};\nuse alvr_session::{CodecType, MediacodecPropType};\nuse ndk::{\n hardware_buffer::HardwareBufferUsage,\n media::{\n image_reader::{AcquireResult, Image, ImageFormat, ImageReader},\n media_codec::{\n DequeuedInputBufferResult, DequeuedOutputBufferInfoResult, MediaCodec,\n MediaCodecDirection, MediaFormat,\n },\n },\n};\nuse std::{\n collections::VecDeque,\n ffi::c_void,\n ops::Deref,\n ptr,\n sync::{Arc, Weak},\n thread::{self, JoinHandle},\n time::Duration,\n};\n\nstruct FakeThreadSafe(T);\nunsafe impl Send for FakeThreadSafe {}\nunsafe impl Sync for FakeThreadSafe {}\n\nimpl Deref for FakeThreadSafe {\n type Target = T;\n\n fn deref(&self) -> &T {\n &self.0\n }\n}\n\ntype SharedMediaCodec = Arc>;\n\npub struct VideoDecoderSink {\n inner: Arc>>,\n}\n\nunsafe impl Send for VideoDecoderSink {}\n\nimpl VideoDecoderSink {\n // Block until the buffer has been written or timeout is reached. Returns false if timeout.\n pub fn push_frame_nal(&mut self, timestamp: Duration, data: &[u8]) -> Result {\n let Some(decoder) = &*self.inner.lock() else {\n // This might happen only during destruction\n return Ok(false);\n };\n\n match decoder.dequeue_input_buffer(Duration::ZERO) {\n Ok(DequeuedInputBufferResult::Buffer(mut buffer)) => {\n unsafe {\n ptr::copy_nonoverlapping(\n data.as_ptr(),\n buffer.buffer_mut().as_mut_ptr().cast(),\n data.len(),\n )\n };\n\n // NB: the function expects the timestamp in micros, but nanos is used to have\n // complete precision, so when converted back to Duration it can compare correctly\n // to other Durations\n decoder.queue_input_buffer(buffer, 0, data.len(), timestamp.as_nanos() as _, 0)?;\n\n Ok(true)\n }\n Ok(DequeuedInputBufferResult::TryAgainLater) => Ok(false),\n Err(e) => bail!(\"{e}\"),\n }\n }\n}\n\nstruct QueuedImage {\n timestamp: Duration,\n image: Image,\n in_use: bool,\n}\nunsafe impl Send for QueuedImage {}\n\n// Access the image queue synchronously.\npub struct VideoDecoderSource {\n running: Arc,\n dequeue_thread: Option>,\n image_queue: Arc>>,\n config: VideoDecoderConfig,\n buffering_running_average: f32,\n}\n\nunsafe impl Send for VideoDecoderSource {}\n\nimpl VideoDecoderSource {\n // The application MUST finish using the returned buffer before calling this function again\n pub fn dequeue_frame(&mut self) -> Option<(Duration, *mut c_void)> {\n let mut image_queue_lock = self.image_queue.lock();\n\n if let Some(queued_image) = image_queue_lock.front()\n && queued_image.in_use\n {\n // image is released and ready to be reused by the decoder\n image_queue_lock.pop_front();\n }\n\n // use running average to give more weight to recent samples\n self.buffering_running_average = self.buffering_running_average\n * self.config.buffering_history_weight\n + image_queue_lock.len() as f32 * (1. - self.config.buffering_history_weight);\n if self.buffering_running_average > self.config.max_buffering_frames as f32 {\n image_queue_lock.pop_front();\n }\n\n if let Some(queued_image) = image_queue_lock.front_mut() {\n queued_image.in_use = true;\n\n Some((\n queued_image.timestamp,\n queued_image\n .image\n .hardware_buffer()\n .unwrap()\n .as_ptr()\n .cast(),\n ))\n } else {\n // TODO: add back when implementing proper phase sync\n //warn!(\"Video frame queue underflow!\");\n None\n }\n }\n}\n\nimpl Drop for VideoDecoderSource {\n fn drop(&mut self) {\n self.running.set(false);\n\n // Destruction of decoder, buffered images and ImageReader\n self.dequeue_thread.take().map(|t| t.join());\n }\n}\n\nfn mime_for_codec(codec: CodecType) -> &'static str {\n match codec {\n CodecType::H264 => \"video/avc\",\n CodecType::Hevc => \"video/hevc\",\n CodecType::AV1 => \"video/av01\",\n }\n}\n\n// Attempts to create a MediaCodec, and then configure and start it.\nfn decoder_attempt_setup(\n codec_type: CodecType,\n is_software: bool,\n format: &MediaFormat,\n image_reader: &ImageReader,\n) -> Result {\n let decoder = if is_software {\n let sw_codec_name = match codec_type {\n CodecType::H264 => \"OMX.google.h264.decoder\",\n CodecType::Hevc => \"OMX.google.hevc.decoder\",\n CodecType::AV1 => bail!(\"AV1 is not supported for software decoding\"),\n };\n MediaCodec::from_codec_name(&sw_codec_name)\n .ok_or(anyhow!(\"no such codec: {}\", &sw_codec_name))?\n } else {\n let mime = mime_for_codec(codec_type);\n MediaCodec::from_decoder_type(&mime)\n .ok_or(anyhow!(\"unable to find decoder for mime type: {}\", &mime))?\n };\n decoder\n .configure(\n &format,\n Some(&image_reader.window()?),\n MediaCodecDirection::Decoder,\n )\n .with_context(|| format!(\"failed to configure decoder\"))?;\n\n decoder\n .start()\n .with_context(|| format!(\"failed to start decoder\"))?;\n\n Ok(decoder)\n}\n\n// Since we leak the ImageReader, and we pass frame_result_callback to it which contains a reference\n// to ClientCoreContext, to avoid circular references we need to use a Weak reference.\nfn decoder_lifecycle(\n config: VideoDecoderConfig,\n csd_0: Vec,\n frame_result_callback: Weak) + Send + Sync + 'static>,\n running: Arc,\n decoder_sink: Arc>>,\n decoder_ready_notifier: Arc,\n image_queue: Arc>>,\n image_reader: &mut ImageReader,\n) -> Result<()> {\n // 2x: keep the target buffering in the middle of the max amount of queuable frames\n let available_buffering_frames = (2. * config.max_buffering_frames).ceil() as usize;\n\n image_reader.set_image_listener(Box::new({\n let image_queue = Arc::clone(&image_queue);\n move |image_reader| {\n let mut image_queue_lock = image_queue.lock();\n\n if image_queue_lock.len() > available_buffering_frames {\n warn!(\"Video frame queue overflow!\");\n image_queue_lock.pop_front();\n }\n\n match image_reader.acquire_next_image() {\n Ok(AcquireResult::Image(image)) => {\n let timestamp = Duration::from_nanos(image.timestamp().unwrap() as u64);\n\n if let Some(callback) = frame_result_callback.upgrade() {\n callback(Ok(timestamp));\n }\n\n image_queue_lock.push_back(QueuedImage {\n timestamp,\n image,\n in_use: false,\n });\n }\n Ok(e) => {\n error!(\"ImageReader error: {e:?}\");\n\n image_queue_lock.pop_front();\n }\n Err(e) => {\n error!(\"ImageReader error: {e}\");\n\n image_queue_lock.clear();\n }\n }\n }\n }))?;\n\n // Documentation says that this call is necessary to properly dispose acquired buffers.\n // todo: find out how to use it and avoid leaking the ImageReader\n image_reader.set_buffer_removed_listener(Box::new(|_, _| ()))?;\n\n let mime = mime_for_codec(config.codec);\n\n let mut format = MediaFormat::new();\n format.set_str(\"mime\", mime);\n // Given https://github.com/alvr-org/ALVR/pull/1933#discussion_r1431902906 - change at own risk.\n // It might be harmless, it might not be, but it's definitely a risk.\n format.set_i32(\"width\", 512);\n format.set_i32(\"height\", 1024);\n format.set_buffer(\"csd-0\", &csd_0);\n\n for (key, prop) in &config.options {\n let maybe_error = match prop.ty {\n MediacodecPropType::Float => prop\n .value\n .parse()\n .map(|value| format.set_f32(key, value))\n .to_any(),\n MediacodecPropType::Int32 => prop\n .value\n .parse()\n .map(|value| format.set_i32(key, value))\n .to_any(),\n MediacodecPropType::Int64 => prop\n .value\n .parse()\n .map(|value| format.set_i64(key, value))\n .to_any(),\n MediacodecPropType::String => Ok(format.set_str(key, &prop.value)),\n };\n\n if let Err(e) = maybe_error {\n error!(\"Failed to set property {key} to {}: {e}\", prop.value);\n }\n }\n\n info!(\"Using AMediaCodec format:{} \", format);\n\n let decoder = if config.force_software_decoder {\n decoder_attempt_setup(config.codec, true, &format, &image_reader)?\n } else {\n // Hardware decoders sometimes fail at the CSD-0.\n // May as well fall back if this occurs.\n match decoder_attempt_setup(config.codec, false, &format, &image_reader) {\n Ok(d) => d,\n Err(e) => {\n // would be \"warn!\" but this is a severe caveat and a pretty major error.\n error!(\"Attempting software fallback due to error in default decoder: {e:#}\");\n\n decoder_attempt_setup(config.codec, true, &format, &image_reader)?\n }\n }\n };\n\n let decoder = Arc::new(FakeThreadSafe(decoder));\n\n {\n let mut decoder_lock = decoder_sink.lock();\n\n *decoder_lock = Some(Arc::clone(&decoder));\n\n decoder_ready_notifier.notify_one();\n }\n\n let mut error_counter = 0;\n while running.value() {\n match decoder.dequeue_output_buffer(Duration::from_millis(1)) {\n Ok(DequeuedOutputBufferInfoResult::Buffer(buffer)) => {\n // The buffer timestamp is actually nanoseconds\n let presentation_time_ns = buffer.info().presentation_time_us();\n\n if let Err(e) = decoder.release_output_buffer_at_time(buffer, presentation_time_ns)\n {\n error!(\"Decoder dequeue error: {e}\");\n }\n }\n Ok(DequeuedOutputBufferInfoResult::TryAgainLater) => continue,\n Ok(i) => info!(\"Decoder dequeue event: {i:?}\"),\n Err(e) => {\n error!(\"Decoder dequeue error: {e}\");\n\n error_counter += 1;\n if error_counter > 10 {\n bail!(\"Too many decoder errors: {e}\");\n }\n\n // lessen logcat flood (just in case)\n thread::sleep(Duration::from_millis(50));\n\n continue;\n }\n }\n\n error_counter = 0;\n }\n\n // Destroy all resources\n decoder_sink.lock().take(); // Make sure the shared ref is deleted first\n decoder.stop()?;\n drop(decoder);\n\n Ok(())\n}\n\n// Create a sink/source pair\npub fn video_decoder_split(\n config: VideoDecoderConfig,\n csd_0: Vec,\n frame_result_callback: impl Fn(Result) + Send + Sync + 'static,\n) -> Result<(VideoDecoderSink, VideoDecoderSource)> {\n let running = Arc::new(RelaxedAtomic::new(true));\n let decoder_sink = Arc::new(Mutex::new(None::));\n let decoder_ready_notifier = Arc::new(Condvar::new());\n let image_queue = Arc::new(Mutex::new(VecDeque::::new()));\n\n let dequeue_thread = thread::spawn({\n let config = config.clone();\n let running = Arc::clone(&running);\n let decoder_sink = Arc::clone(&decoder_sink);\n let decoder_ready_notifier = Arc::clone(&decoder_ready_notifier);\n let image_queue = Arc::clone(&image_queue);\n move || {\n const MAX_BUFFERING_FRAMES: usize = 10;\n let mut image_reader = match ImageReader::new_with_usage(\n 1,\n 1,\n ImageFormat::PRIVATE,\n HardwareBufferUsage::GPU_SAMPLED_IMAGE,\n MAX_BUFFERING_FRAMES as i32,\n ) {\n Ok(reader) => reader,\n Err(e) => {\n frame_result_callback(Err(anyhow!(\"{e}\")));\n return;\n }\n };\n\n let frame_result_callback = Arc::new(frame_result_callback);\n\n if let Err(e) = decoder_lifecycle(\n config,\n csd_0,\n Arc::downgrade(&frame_result_callback),\n running,\n decoder_sink,\n decoder_ready_notifier,\n Arc::clone(&image_queue),\n &mut image_reader,\n ) {\n frame_result_callback(Err(e));\n }\n\n image_queue.lock().clear();\n error!(\"FIXME: Leaking Imagereader!\");\n Box::leak(Box::new(image_reader));\n }\n });\n\n // Make sure the decoder is ready: we don't want to try to enqueue frame and lose them, to avoid\n // image corruption.\n {\n let mut decoder_lock = decoder_sink.lock();\n\n if decoder_lock.is_none() {\n // No spurious wakeups\n decoder_ready_notifier.wait(&mut decoder_lock);\n }\n }\n\n let sink = VideoDecoderSink {\n inner: decoder_sink,\n };\n let source = VideoDecoderSource {\n running,\n dequeue_thread: Some(dequeue_thread),\n image_queue,\n config,\n buffering_running_average: 0.0,\n };\n\n Ok((sink, source))\n}\n"
},
{
"path": "alvr/client_core/src/video_decoder/mod.rs",
"content": "#[cfg(target_os = \"android\")]\nmod android;\n\nuse alvr_common::anyhow::Result;\nuse alvr_session::{CodecType, MediacodecProperty};\nuse std::time::Duration;\n\n#[derive(Clone, Default, PartialEq)]\npub struct VideoDecoderConfig {\n pub codec: CodecType,\n pub force_software_decoder: bool,\n pub max_buffering_frames: f32,\n pub buffering_history_weight: f32,\n pub options: Vec<(String, MediacodecProperty)>,\n pub config_buffer: Vec,\n}\n\npub struct VideoDecoderSink {\n #[cfg(target_os = \"android\")]\n inner: android::VideoDecoderSink,\n}\n\nimpl VideoDecoderSink {\n // returns true if frame has been successfully enqueued\n #[allow(unused_variables)]\n pub fn push_nal(&mut self, timestamp: Duration, nal: &[u8]) -> bool {\n #[cfg(target_os = \"android\")]\n {\n alvr_common::show_err(self.inner.push_frame_nal(timestamp, nal)).unwrap_or(false)\n }\n #[cfg(not(target_os = \"android\"))]\n false\n }\n}\n\npub struct VideoDecoderSource {\n #[cfg(target_os = \"android\")]\n inner: android::VideoDecoderSource,\n}\n\nimpl VideoDecoderSource {\n /// If a frame is available, return the timestamp and the AHardwareBuffer.\n pub fn get_frame(&mut self) -> Option<(Duration, *mut std::ffi::c_void)> {\n #[cfg(target_os = \"android\")]\n {\n self.inner.dequeue_frame()\n }\n #[cfg(not(target_os = \"android\"))]\n None\n }\n}\n\n// report_frame_decoded: (target_timestamp: Duration) -> ()\n#[allow(unused_variables)]\npub fn create_decoder(\n config: VideoDecoderConfig,\n report_frame_decoded: impl Fn(Result) + Send + Sync + 'static,\n) -> (VideoDecoderSink, VideoDecoderSource) {\n #[cfg(target_os = \"android\")]\n {\n let (sink, source) = android::video_decoder_split(\n config.clone(),\n config.config_buffer,\n report_frame_decoded,\n )\n .unwrap();\n\n (\n VideoDecoderSink { inner: sink },\n VideoDecoderSource { inner: source },\n )\n }\n #[cfg(not(target_os = \"android\"))]\n (VideoDecoderSink {}, VideoDecoderSource {})\n}\n"
},
{
"path": "alvr/client_mock/Cargo.toml",
"content": "[package]\nname = \"alvr_client_mock\"\nversion.workspace = true\nedition.workspace = true\nrust-version.workspace = true\nauthors.workspace = true\nlicense.workspace = true\n\n[dependencies]\nalvr_common.workspace = true\nalvr_client_core.workspace = true\nalvr_packets.workspace = true\nalvr_session.workspace = true\nalvr_system_info.workspace = true\n\neframe = \"0.32\"\nenv_logger = \"0.11\"\nrand = \"0.9\"\n"
},
{
"path": "alvr/client_mock/src/main.rs",
"content": "use alvr_client_core::{ClientCapabilities, ClientCoreContext, ClientCoreEvent};\nuse alvr_common::{\n DeviceMotion, HEAD_ID, Pose, RelaxedAtomic, ViewParams,\n glam::{Quat, UVec2, Vec3},\n parking_lot::RwLock,\n};\nuse alvr_packets::{FaceData, TrackingData};\nuse alvr_session::CodecType;\nuse eframe::{\n Frame, NativeOptions,\n egui::{CentralPanel, Context, RichText, Slider, ViewportBuilder},\n};\nuse std::{\n f32::consts::{FRAC_PI_2, PI},\n sync::{\n Arc,\n mpsc::{self, TryRecvError},\n },\n thread,\n time::{Duration, Instant},\n};\n\n#[derive(Clone, PartialEq)]\nstruct WindowInput {\n height: f32,\n yaw: f32,\n pitch: f32,\n use_random_orientation: bool,\n emulated_decode_ms: u64,\n emulated_compositor_ms: u64,\n emulated_vsync_ms: u64,\n}\n\nimpl Default for WindowInput {\n fn default() -> Self {\n Self {\n height: 1.5,\n yaw: 0.0,\n pitch: 0.0,\n use_random_orientation: true,\n emulated_decode_ms: 5,\n emulated_compositor_ms: 1,\n emulated_vsync_ms: 25,\n }\n }\n}\n\n#[derive(Clone)]\nstruct WindowOutput {\n hud_message: String,\n connected: bool,\n fps: f32,\n resolution: UVec2,\n decoder_codec: Option,\n current_frame_timestamp: Duration,\n}\n\nimpl Default for WindowOutput {\n fn default() -> Self {\n Self {\n hud_message: \"\".into(),\n connected: false,\n fps: 1.0,\n resolution: UVec2::ZERO,\n decoder_codec: None,\n current_frame_timestamp: Duration::ZERO,\n }\n }\n}\n\npub struct Window {\n input: WindowInput,\n input_sender: mpsc::Sender,\n output: WindowOutput,\n output_receiver: mpsc::Receiver,\n}\n\nimpl Window {\n fn new(\n input_sender: mpsc::Sender,\n output_receiver: mpsc::Receiver,\n ) -> Self {\n Self {\n input: WindowInput::default(),\n input_sender,\n output: WindowOutput::default(),\n output_receiver,\n }\n }\n}\n\nimpl eframe::App for Window {\n fn update(&mut self, context: &Context, _: &mut Frame) {\n while let Ok(output) = self.output_receiver.try_recv() {\n self.output = output;\n }\n\n let mut input = self.input.clone();\n\n CentralPanel::default().show(context, |ui| {\n ui.vertical_centered(|ui| {\n ui.heading(RichText::new(&self.output.hud_message));\n });\n ui.label(format!(\"Connected: {}\", self.output.connected));\n ui.label(format!(\"FPS: {}\", self.output.fps));\n ui.label(format!(\"View resolution: {}\", self.output.resolution));\n ui.label(format!(\"Codec: {:?}\", self.output.decoder_codec));\n ui.label(format!(\n \"Current frame: {:?}\",\n self.output.current_frame_timestamp\n ));\n ui.add_space(10.0);\n ui.horizontal(|ui| {\n ui.label(\"Height:\");\n ui.add(Slider::new(&mut input.height, 0.0..=2.0));\n });\n ui.horizontal(|ui| {\n ui.label(\"Yaw:\");\n ui.add(Slider::new(&mut input.yaw, -PI..=PI));\n });\n ui.horizontal(|ui| {\n ui.label(\"Pitch:\");\n ui.add(Slider::new(&mut input.pitch, -FRAC_PI_2..=FRAC_PI_2));\n });\n ui.checkbox(\n &mut input.use_random_orientation,\n \"Use randomized orientation offset\",\n );\n });\n\n if input != self.input {\n self.input = input;\n\n self.input_sender.send(self.input.clone()).ok();\n }\n\n context.request_repaint();\n }\n}\n\nfn tracking_thread(\n context: Arc,\n streaming: Arc,\n fps: f32,\n input: Arc>,\n) {\n let timestamp_origin = Instant::now();\n context.send_view_params([ViewParams::DUMMY; 2]);\n\n let mut loop_deadline = Instant::now();\n while streaming.value() {\n let input_lock = input.read();\n\n let mut orientation =\n Quat::from_rotation_y(input_lock.yaw) * Quat::from_rotation_x(input_lock.pitch);\n\n if input_lock.use_random_orientation {\n orientation *= Quat::from_rotation_z(rand::random::() * 0.001);\n }\n\n let position = Vec3::new(0.0, input_lock.height, 0.0);\n\n context.send_tracking(TrackingData {\n poll_timestamp: timestamp_origin.elapsed(),\n device_motions: vec![(\n *HEAD_ID,\n DeviceMotion {\n pose: Pose {\n orientation,\n position,\n },\n linear_velocity: Vec3::ZERO,\n angular_velocity: Vec3::ZERO,\n },\n )],\n hand_skeletons: [None, None],\n face: FaceData::default(),\n body: None,\n });\n\n drop(input_lock);\n\n loop_deadline += Duration::from_secs_f32(1.0 / fps / 3.0);\n thread::sleep(loop_deadline.saturating_duration_since(Instant::now()))\n }\n}\n\nfn client_thread(\n output_sender: mpsc::Sender,\n input_receiver: mpsc::Receiver,\n) {\n let capabilities = ClientCapabilities {\n platform: alvr_system_info::platform(None, None),\n default_view_resolution: UVec2::new(1920, 1832),\n max_view_resolution: UVec2::new(1920, 1832),\n refresh_rates: vec![60.0, 72.0, 80.0, 90.0, 120.0],\n foveated_encoding: false,\n encoder_high_profile: false,\n encoder_10_bits: false,\n encoder_av1: false,\n prefer_10bit: false,\n preferred_encoding_gamma: 1.0,\n prefer_hdr: false,\n };\n let client_core_context = Arc::new(ClientCoreContext::new(capabilities));\n\n client_core_context.resume();\n\n let streaming = Arc::new(RelaxedAtomic::new(false));\n let got_decoder_config = Arc::new(RelaxedAtomic::new(false));\n let mut maybe_tracking_thread = None;\n\n let mut window_output = WindowOutput::default();\n let window_input = Arc::new(RwLock::new(WindowInput::default()));\n\n let mut deadline = Instant::now();\n 'main_loop: loop {\n let input_lock = window_input.read();\n\n while let Some(event) = client_core_context.poll_event() {\n match event {\n ClientCoreEvent::UpdateHudMessage(message) => {\n window_output.hud_message = message;\n }\n ClientCoreEvent::StreamingStarted(config) => {\n window_output.fps = config.negotiated_config.refresh_rate_hint;\n window_output.connected = true;\n window_output.resolution = config.negotiated_config.view_resolution;\n\n streaming.set(true);\n\n let context = Arc::clone(&client_core_context);\n let streaming = Arc::clone(&streaming);\n let input = Arc::clone(&window_input);\n maybe_tracking_thread = Some(thread::spawn(move || {\n tracking_thread(\n context,\n streaming,\n config.negotiated_config.refresh_rate_hint,\n input,\n )\n }));\n }\n ClientCoreEvent::StreamingStopped => {\n streaming.set(false);\n got_decoder_config.set(false);\n\n if let Some(thread) = maybe_tracking_thread.take() {\n thread.join().ok();\n }\n\n window_output.fps = 1.0;\n window_output.connected = false;\n window_output.resolution = UVec2::ZERO;\n window_output.decoder_codec = None;\n }\n ClientCoreEvent::DecoderConfig { codec, .. } => {\n got_decoder_config.set(true);\n\n window_output.decoder_codec = Some(codec);\n }\n ClientCoreEvent::Haptics { .. } | ClientCoreEvent::RealTimeConfig(_) => (),\n }\n\n output_sender.send(window_output.clone()).ok();\n }\n\n thread::sleep(Duration::from_millis(3));\n\n client_core_context.report_compositor_start(window_output.current_frame_timestamp);\n\n thread::sleep(Duration::from_millis(input_lock.emulated_compositor_ms));\n\n client_core_context.report_submit(\n window_output.current_frame_timestamp,\n Duration::from_millis(input_lock.emulated_vsync_ms),\n );\n\n drop(input_lock);\n\n match input_receiver.try_recv() {\n Ok(input) => *window_input.write() = input,\n Err(TryRecvError::Disconnected) => break 'main_loop,\n Err(TryRecvError::Empty) => (),\n }\n\n deadline += Duration::from_secs_f32(1.0 / window_output.fps);\n thread::sleep(deadline.saturating_duration_since(Instant::now()));\n }\n\n streaming.set(false);\n if let Some(thread) = maybe_tracking_thread {\n thread.join().unwrap();\n }\n\n client_core_context.pause()\n\n // client_core_context destroy is called here on drop\n}\n\nfn main() {\n env_logger::init();\n\n let (input_sender, input_receiver) = mpsc::channel::();\n let (output_sender, output_receiver) = mpsc::channel::();\n\n let client_thread = thread::spawn(|| {\n client_thread(output_sender, input_receiver);\n });\n\n eframe::run_native(\n \"Mock client\",\n NativeOptions {\n viewport: ViewportBuilder::default().with_inner_size((400.0, 400.0)),\n ..Default::default()\n },\n Box::new(|_| Ok(Box::new(Window::new(input_sender, output_receiver)))),\n )\n .ok();\n\n client_thread.join().unwrap();\n}\n"
},
{
"path": "alvr/client_openxr/Cargo.toml",
"content": "[package]\nname = \"alvr_client_openxr\"\nversion.workspace = true\nedition.workspace = true\nrust-version.workspace = true\nauthors.workspace = true\nlicense.workspace = true\n\n[lib]\ncrate-type = [\"cdylib\"]\n\n[dependencies]\nalvr_common.workspace = true\nalvr_client_core.workspace = true\nalvr_graphics.workspace = true\nalvr_packets.workspace = true\nalvr_session.workspace = true\nalvr_system_info.workspace = true\n\nopenxr = { git = \"https://github.com/zmerp/openxrs\", rev = \"e7c1b155e79ff8b58c2f6558d28e1398ebe08d2d\" }\n\n[target.'cfg(target_os = \"android\")'.dependencies]\nandroid-activity = { version = \"0.6\", features = [\"native-activity\"] }\njni = \"0.21\"\nlibc = \"0.2\"\nndk-context = \"0.1\"\n\n[package.metadata.android]\npackage = \"alvr.client.dev\" # Changed for Meta Store\ninstall_location = \"auto\"\nbuild_targets = [\"aarch64-linux-android\"]\nruntime_libs = \"../../deps/android_openxr\"\nresources = \"resources\"\n\n[package.metadata.android.signing.release]\npath = \"../../build/alvr_client_android/debug.keystore\"\nkeystore_password = \"alvrclient\"\n\n[package.metadata.android.signing.distribution]\npath = \"../../build/alvr_client_android/debug.keystore\"\nkeystore_password = \"alvrclient\"\n\n[package.metadata.android.sdk]\nmin_sdk_version = 28\ntarget_sdk_version = 32\n\n[[package.metadata.android.uses_feature]]\nname = \"android.hardware.microphone\"\nrequired = true\n[[package.metadata.android.uses_feature]]\nname = \"android.hardware.vr.headtracking\"\nrequired = true\nversion = 1\n[[package.metadata.android.uses_feature]]\nopengles_version = [3, 2]\nrequired = true\n\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.ACCESS_WIFI_STATE\"\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.ACCESS_NETWORK_STATE\"\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.CHANGE_WIFI_MULTICAST_STATE\"\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.INTERNET\"\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.RECORD_AUDIO\"\n# WAKE_LOCK is needed for proper wifi locking\n# https://developer.android.com/reference/android/net/wifi/WifiManager.WifiLock\n[[package.metadata.android.uses_permission]]\nname = \"android.permission.WAKE_LOCK\"\n[[package.metadata.android.uses_permission]]\nname = \"org.khronos.openxr.permission.OPENXR\"\n[[package.metadata.android.uses_permission]]\nname = \"org.khronos.openxr.permission.OPENXR_SYSTEM\"\n\n[[package.metadata.android.queries.intent]]\nactions = [\"org.khronos.openxr.OpenXRRuntimeService\"]\n[[package.metadata.android.queries.provider]]\nname = \"org.khronos.openxr\"\nauthorities = \"org.khronos.openxr.runtime_broker;org.khronos.openxr.system_runtime_broker\"\n\n[package.metadata.android.application]\ndebuggable = false\ntheme = \"@android:style/Theme.Black.NoTitleBar.Fullscreen\"\nicon = \"@mipmap/ic_launcher\"\nlabel = \"ALVR\"\n\n[package.metadata.android.application.activity]\nconfig_changes = \"density|keyboard|keyboardHidden|navigation|orientation|screenLayout|screenSize|uiMode\"\nlaunch_mode = \"singleTask\"\norientation = \"landscape\"\n\n[[package.metadata.android.application.activity.intent_filter]]\nactions = [\"android.intent.action.MAIN\"]\ncategories = [\n \"android.intent.category.LAUNCHER\",\n \"com.oculus.intent.category.VR\",\n \"com.yvr.intent.category.VR\",\n \"org.khronos.openxr.intent.category.IMMERSIVE_HMD\",\n]\n\n# Quest entries\n[[package.metadata.android.uses_feature]]\nname = \"oculus.software.eye_tracking\"\nrequired = false\n[[package.metadata.android.uses_feature]]\nname = \"oculus.software.face_tracking\"\nrequired = false\n[[package.metadata.android.uses_feature]]\nname = \"oculus.software.handtracking\"\nrequired = false\n[[package.metadata.android.uses_feature]]\nname = \"com.oculus.feature.PASSTHROUGH\"\nrequired = false\n[[package.metadata.android.uses_feature]]\nname = \"com.oculus.software.body_tracking\"\nrequired = false\n[[package.metadata.android.uses_permission]]\nname = \"com.oculus.permission.BODY_TRACKING\"\n[[package.metadata.android.uses_permission]]\nname = \"com.oculus.permission.EYE_TRACKING\"\n[[package.metadata.android.uses_permission]]\nname = \"com.oculus.permission.FACE_TRACKING\"\n[[package.metadata.android.uses_permission]]\nname = \"com.oculus.permission.HAND_TRACKING\"\n[[package.metadata.android.uses_permission]]\nname = \"com.oculus.permission.WIFI_LOCK\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.oculus.intent.category.VR\"\nvalue = \"vr_only\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.oculus.supportedDevices\"\n# Note: value is changed for the Meta store, which requires an explicit list of platforms.\n# \"all\" is required to support Quest 1 which doesn't have newer platform names registered.\nvalue = \"all\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.oculus.vr.focusaware\"\nvalue = \"true\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.oculus.handtracking.frequency\"\nvalue = \"HIGH\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.oculus.handtracking.version\"\nvalue = \"V2.0\"\n\n# Vive entries\n[[package.metadata.android.uses_feature]]\nname = \"wave.feature.eyetracking\"\nrequired = false\n[[package.metadata.android.uses_feature]]\nname = \"wave.feature.handtracking\"\nrequired = true\n[[package.metadata.android.uses_feature]]\nname = \"wave.feature.lipexpression\"\nrequired = false\n[[package.metadata.android.application.meta_data]]\nname = \"minWaveSDKVersion\"\nvalue = \"1\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.htc.vr.content.NumController\"\nvalue = \"1,2\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.htc.vr.content.NumDoFController\"\nvalue = \"3,6DoF\"\n[[package.metadata.android.application.meta_data]]\nname = \"com.htc.vr.content.NumDoFHmd\"\nvalue = \"3,6DoF\"\n\n# Pico entries\n[[package.metadata.android.uses_permission]]\nname = \"com.picovr.permission.EYE_TRACKING\"\n[[package.metadata.android.uses_permission]]\nname = \"com.picovr.permission.FACE_TRACKING\"\n[[package.metadata.android.application.meta_data]]\nname = \"eyetracking_calibration\"\nvalue = \"true\"\n[[package.metadata.android.application.meta_data]]\nname = \"handtracking\"\nvalue = \"1\"\n[[package.metadata.android.application.meta_data]]\nname = \"picovr.software.eye_tracking\"\nvalue = \"1\"\n[[package.metadata.android.application.meta_data]]\nname = \"picovr.software.face_tracking\"\nvalue = \"true\"\n[[package.metadata.android.application.meta_data]]\nname = \"pvr.app.type\"\nvalue = \"vr\"\n[[package.metadata.android.application.meta_data]]\nname = \"pvr.display.orientation\"\nvalue = \"180\"\n[[package.metadata.android.application.meta_data]]\nname = \"pvr.sdk.version\"\nvalue = \"OpenXR\"\n[[package.metadata.android.application.meta_data]]\nname = \"pxr.sdk.version_code\"\nvalue = \"5900\"\n\n# Yvr entries\n[[package.metadata.android.application.meta_data]]\nname = \"com.yvr.intent.category.VR\"\nvalue = \"vr_only\"\n\n# Lynx entries\n[[package.metadata.android.queries.package]]\nname = \"com.ultraleap.tracking.service\"\n[[package.metadata.android.queries.package]]\nname = \"com.ultraleap.openxr.api_layer\"\n\n# Android XR\n[[package.metadata.android.uses_feature]]\nname = \"android.software.xr.api.spatial\"\nrequired = true\n\n[[package.metadata.android.uses_feature]]\nname = \"android.software.xr.api.openxr\"\nrequired = true\n\n[[package.metadata.android.uses_feature]]\nname = \"android.software.xr.input.controller\"\nrequired = false\n\n[[package.metadata.android.uses_feature]]\nname = \"android.software.xr.input.hand_tracking\"\nrequired = false\n\n[[package.metadata.android.uses_feature]]\nname = \"android.software.xr.input.eye_tracking\"\nrequired = false\n\n[[package.metadata.android.application.uses_native_library]]\nname = \"libopenxr.google.so\"\nrequired = false\n\n[[package.metadata.android.application.property]]\nname = \"android.window.PROPERTY_XR_ACTIVITY_START_MODE\"\nvalue = \"XR_ACTIVITY_START_MODE_FULL_SPACE_UNMANAGED\"\n\n[[package.metadata.android.application.property]]\nname = \"android.window.PROPERTY_XR_BOUNDARY_TYPE_RECOMMENDED\"\nvalue = \"XR_BOUNDARY_TYPE_LARGE\"\n"
},
{
"path": "alvr/client_openxr/cbindgen.toml",
"content": "language = \"C\"\nheader = \"/* ALVR is licensed under the MIT license. https://github.com/alvr-org/ALVR/blob/master/LICENSE */\"\npragma_once = true\nautogen_warning = \"/* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */\"\ncpp_compat = true\ntab_width = 4\ndocumentation_style = \"c99\"\n\n[enum]\nrename_variants = \"QualifiedScreamingSnakeCase\"\n"
},
{
"path": "alvr/client_openxr/resources/drawable/ic_launcher_foreground.xml",
"content": "\n \n \n \n \n \n \n - \n
- \n
\n \n \n \n \n \n - \n
- \n
\n \n \n \n \n \n - \n
- \n
\n \n \n \n \n\n"
},
{
"path": "alvr/client_openxr/resources/mipmap-anydpi-v26/ic_launcher.xml",
"content": "\n\n \n \n \n"
},
{
"path": "alvr/client_openxr/resources/values/ic_launcher_background.xml",
"content": "\n\n #FFFFFF\n"
},
{
"path": "alvr/client_openxr/src/c_api.rs",
"content": "#[cfg(target_os = \"android\")]\n#[unsafe(no_mangle)]\npub extern \"C\" fn alvr_entry_point(java_vm: *mut std::ffi::c_void, context: *mut std::ffi::c_void) {\n unsafe { ndk_context::initialize_android_context(java_vm, context) };\n\n crate::entry_point();\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/body_tracking_bd.rs",
"content": "use crate::extra_extensions::get_instance_proc;\nuse openxr::{self as xr, AnyGraphics, sys};\nuse std::{\n ffi::{CString, c_char, c_void},\n ptr,\n sync::LazyLock,\n};\n\npub const BD_BODY_TRACKING_EXTENSION_NAME: &str = \"XR_BD_body_tracking\";\n\nstatic TYPE_BODY_TRACKER_CREATE_INFO_BD: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000385001));\nstatic TYPE_BODY_JOINTS_LOCATE_INFO_BD: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000385002));\nstatic TYPE_BODY_JOINT_LOCATIONS_BD: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000385003));\nstatic TYPE_SYSTEM_BODY_TRACKING_PROPERTIES_BD: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000385004));\n\npub const BODY_JOINT_COUNT_BD: usize = 24;\n\n#[repr(transparent)]\n#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]\npub struct XrBodyTrackerBD(u64);\n\n#[repr(transparent)]\n#[derive(Copy, Clone, Eq, PartialEq)]\npub struct BodyJointSetBD(i32);\nimpl BodyJointSetBD {\n pub const BODY_WITHOUT_ARM: BodyJointSetBD = Self(1i32);\n pub const FULL_BODY_JOINTS: BodyJointSetBD = Self(2i32);\n}\n\n#[repr(transparent)]\n#[derive(Copy, Clone, Eq, PartialEq)]\npub struct BodyTrackingStatusCodeBD(i32);\nimpl BodyTrackingStatusCodeBD {\n pub const INVALID: BodyTrackingStatusCodeBD = Self(0i32);\n}\n\n#[repr(transparent)]\n#[derive(Copy, Clone, Eq, PartialEq)]\npub struct BodyTrackingErrorCodeBD(i32);\nimpl BodyTrackingErrorCodeBD {\n pub const INNER_EXCEPTION: BodyTrackingErrorCodeBD = Self(0i32);\n pub const TRACKER_NOT_CALIBRATED: BodyTrackingErrorCodeBD = Self(1i32);\n}\n\n#[repr(transparent)]\n#[derive(Copy, Clone, Eq, PartialEq)]\npub struct CalibAppFlagBD(i32);\nimpl CalibAppFlagBD {\n pub const MOTION_TRACKER_2: CalibAppFlagBD = Self(1i32);\n}\n\n#[repr(C)]\nstruct BodyTrackerCreateInfoBD {\n ty: xr::StructureType,\n next: *const c_void,\n joint_set: BodyJointSetBD,\n}\n\n#[repr(C)]\nstruct BodyJointsLocateInfoBD {\n ty: xr::StructureType,\n next: *const c_void,\n base_space: sys::Space,\n time: sys::Time,\n}\n\n#[repr(C)]\npub struct BodyJointLocationBD {\n pub location_flags: sys::SpaceLocationFlags,\n pub pose: sys::Posef,\n pub radius: f32,\n}\n\n#[repr(C)]\nstruct BodyJointLocationsBD {\n ty: xr::StructureType,\n next: *const c_void,\n all_joint_poses_tracked: sys::Bool32,\n joint_count: u32,\n joint_locations: *mut BodyJointLocationBD,\n}\n\n#[repr(C)]\nstruct SystemBodyTrackingPropertiesBD {\n ty: xr::StructureType,\n next: *const c_void,\n supports_body_tracking: sys::Bool32,\n}\n\ntype CreateBodyTrackerBD = unsafe extern \"system\" fn(\n sys::Session,\n *const BodyTrackerCreateInfoBD,\n *mut XrBodyTrackerBD,\n) -> sys::Result;\n\ntype DestroyBodyTrackerBD = unsafe extern \"system\" fn(XrBodyTrackerBD) -> sys::Result;\n\ntype LocateBodyJointsBD = unsafe extern \"system\" fn(\n XrBodyTrackerBD,\n *const BodyJointsLocateInfoBD,\n *mut BodyJointLocationsBD,\n) -> sys::Result;\n\ntype StartBodyTrackingCalibAppBD =\n unsafe extern \"system\" fn(sys::Instance, *const c_char, CalibAppFlagBD) -> sys::Result;\n\ntype GetBodyTrackingStateBD = unsafe extern \"system\" fn(\n sys::Instance,\n *mut BodyTrackingStatusCodeBD,\n *mut BodyTrackingErrorCodeBD,\n) -> sys::Result;\n\npub struct BodyTrackerBD {\n handle: XrBodyTrackerBD,\n session: xr::Session,\n destroy_body_tracker: DestroyBodyTrackerBD,\n locate_body_joints: LocateBodyJointsBD,\n get_body_tracking_state: GetBodyTrackingStateBD,\n}\n\nimpl BodyTrackerBD {\n pub fn new(\n session: xr::Session,\n joint_set: BodyJointSetBD,\n extra_extensions: &[String],\n system: xr::SystemId,\n prompt_calibration: bool,\n ) -> xr::Result {\n if !extra_extensions.contains(&BD_BODY_TRACKING_EXTENSION_NAME.to_owned()) {\n return Err(sys::Result::ERROR_EXTENSION_NOT_PRESENT);\n }\n\n let create_body_tracker: CreateBodyTrackerBD =\n get_instance_proc(&session, \"xrCreateBodyTrackerBD\")?;\n let start_body_tracking_calib_app: StartBodyTrackingCalibAppBD =\n get_instance_proc(&session, \"xrStartBodyTrackingCalibAppBD\")?;\n let get_body_tracking_state: GetBodyTrackingStateBD =\n get_instance_proc(&session, \"xrGetBodyTrackingStateBD\")?;\n let destroy_body_tracker = get_instance_proc(&session, \"xrDestroyBodyTrackerBD\")?;\n let locate_body_joints = get_instance_proc(&session, \"xrLocateBodyJointsBD\")?;\n\n let props = super::get_props(\n &session,\n system,\n SystemBodyTrackingPropertiesBD {\n ty: *TYPE_SYSTEM_BODY_TRACKING_PROPERTIES_BD,\n next: ptr::null(),\n supports_body_tracking: sys::FALSE,\n },\n )?;\n\n if props.supports_body_tracking == sys::FALSE {\n return Err(sys::Result::ERROR_FEATURE_UNSUPPORTED);\n }\n\n let mut handle = XrBodyTrackerBD(0);\n let info = BodyTrackerCreateInfoBD {\n ty: *TYPE_BODY_TRACKER_CREATE_INFO_BD,\n next: ptr::null(),\n joint_set,\n };\n\n unsafe {\n super::xr_res(create_body_tracker(session.as_raw(), &info, &mut handle))?;\n };\n\n let mut status_code = BodyTrackingStatusCodeBD::INVALID;\n let mut error_code = BodyTrackingErrorCodeBD::INNER_EXCEPTION;\n\n if prompt_calibration {\n unsafe {\n super::xr_res(get_body_tracking_state(\n session.instance().as_raw(),\n &mut status_code,\n &mut error_code,\n ))?;\n\n // todo: include actual Android package name\n let package_name = CString::new(\"\").unwrap();\n\n if status_code == BodyTrackingStatusCodeBD::INVALID\n || error_code == BodyTrackingErrorCodeBD::TRACKER_NOT_CALIBRATED\n {\n super::xr_res(start_body_tracking_calib_app(\n session.instance().as_raw(),\n package_name.as_ptr(),\n CalibAppFlagBD::MOTION_TRACKER_2,\n ))?;\n }\n }\n }\n\n Ok(Self {\n handle,\n session: session.into_any_graphics(),\n destroy_body_tracker,\n locate_body_joints,\n get_body_tracking_state,\n })\n }\n\n pub fn locate_body_joints(\n &self,\n time: xr::Time,\n reference_space: &xr::Space,\n ) -> xr::Result>> {\n let mut status_code = BodyTrackingStatusCodeBD::INVALID;\n let mut error_code = BodyTrackingErrorCodeBD::INNER_EXCEPTION;\n\n unsafe {\n super::xr_res((self.get_body_tracking_state)(\n self.session.instance().as_raw(),\n &mut status_code,\n &mut error_code,\n ))?;\n }\n\n if status_code == BodyTrackingStatusCodeBD::INVALID {\n return Ok(None);\n }\n\n let locate_info = BodyJointsLocateInfoBD {\n ty: *TYPE_BODY_JOINTS_LOCATE_INFO_BD,\n next: ptr::null(),\n base_space: reference_space.as_raw(),\n time,\n };\n\n let joint_count = BODY_JOINT_COUNT_BD;\n let mut locations: Vec = Vec::with_capacity(joint_count);\n\n let mut location_info = BodyJointLocationsBD {\n ty: *TYPE_BODY_JOINT_LOCATIONS_BD,\n next: ptr::null(),\n all_joint_poses_tracked: sys::FALSE,\n joint_count: joint_count as u32,\n joint_locations: locations.as_mut_ptr(),\n };\n\n unsafe {\n super::xr_res((self.locate_body_joints)(\n self.handle,\n &locate_info,\n &mut location_info,\n ))?;\n\n Ok(if location_info.all_joint_poses_tracked.into() {\n locations.set_len(joint_count);\n\n Some(locations)\n } else {\n None\n })\n }\n }\n}\n\nimpl Drop for BodyTrackerBD {\n fn drop(&mut self) {\n unsafe {\n (self.destroy_body_tracker)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/body_tracking_fb.rs",
"content": "#![allow(dead_code)]\n\nuse crate::extra_extensions::get_instance_proc;\nuse openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::{ptr, sync::LazyLock};\n\npub const META_BODY_TRACKING_FULL_BODY_EXTENSION_NAME: &str = \"XR_META_body_tracking_full_body\";\npub static BODY_JOINT_SET_FULL_BODY_META: LazyLock =\n LazyLock::new(|| xr::BodyJointSetFB::from_raw(1000274000));\npub const META_BODY_TRACKING_FIDELITY_EXTENSION_NAME: &str = \"XR_META_body_tracking_fidelity\";\npub static SYSTEM_PROPERTIES_BODY_TRACKING_FIDELITY_META: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000284001));\npub const FULL_BODY_JOINT_COUNT_META: usize = 84;\n\n#[repr(C)]\nstruct SystemPropertiesBodyTrackingFullBodyMETA {\n ty: xr::StructureType,\n next: *mut std::ffi::c_void,\n supports_full_body_tracking: sys::Bool32,\n}\n\npub struct BodyTrackerFB {\n handle: sys::BodyTrackerFB,\n ext_fns: raw::BodyTrackingFB,\n}\n\n#[repr(C)]\nstruct SystemPropertiesBodyTrackingFidelityMETA {\n ty: xr::StructureType,\n next: *mut std::ffi::c_void,\n supports_body_tracking_fidelity: sys::Bool32,\n}\n\n#[repr(C)]\nenum BodyTrackingFidelityMode {\n Low = 1,\n High = 2,\n}\n\ntype RequestBodyTrackingFidelityMETA =\n unsafe extern \"system\" fn(sys::BodyTrackerFB, BodyTrackingFidelityMode) -> sys::Result;\n\nimpl BodyTrackerFB {\n pub fn new(\n session: &xr::Session,\n system: xr::SystemId,\n body_joint_set: xr::BodyJointSetFB,\n prefer_high_fidelity: bool,\n ) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .fb_body_tracking\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let mut handle = sys::BodyTrackerFB::NULL;\n let info = sys::BodyTrackerCreateInfoFB {\n ty: sys::BodyTrackerCreateInfoFB::TYPE,\n next: ptr::null(),\n body_joint_set,\n };\n let body_tracking_fidelity_props = super::get_props(\n session,\n system,\n SystemPropertiesBodyTrackingFidelityMETA {\n ty: *SYSTEM_PROPERTIES_BODY_TRACKING_FIDELITY_META,\n next: ptr::null_mut(),\n supports_body_tracking_fidelity: sys::FALSE,\n },\n )?;\n let preferred_fidelity_mode: BodyTrackingFidelityMode = if prefer_high_fidelity {\n BodyTrackingFidelityMode::High\n } else {\n BodyTrackingFidelityMode::Low\n };\n unsafe {\n super::xr_res((ext_fns.create_body_tracker)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?;\n\n if body_tracking_fidelity_props.supports_body_tracking_fidelity == sys::TRUE {\n let request_body_tracking_fidelity: RequestBodyTrackingFidelityMETA =\n get_instance_proc(session, \"xrRequestBodyTrackingFidelityMETA\")?;\n super::xr_res(request_body_tracking_fidelity(\n handle,\n preferred_fidelity_mode,\n ))\n .ok(); // This is very unlikely to fail as the void falls back to Low on an invalid call.\n }\n };\n\n Ok(Self { handle, ext_fns })\n }\n\n pub fn locate_body_joints(\n &self,\n time: xr::Time,\n reference_space: &xr::Space,\n joint_count: usize,\n ) -> xr::Result>> {\n let locate_info = sys::BodyJointsLocateInfoFB {\n ty: sys::BodyJointsLocateInfoFB::TYPE,\n next: ptr::null(),\n base_space: reference_space.as_raw(),\n time,\n };\n let mut locations: Vec = Vec::with_capacity(joint_count);\n let mut location_info = sys::BodyJointLocationsFB {\n ty: sys::BodyJointLocationsFB::TYPE,\n next: ptr::null_mut(),\n is_active: sys::FALSE,\n confidence: 0.0,\n joint_count: joint_count as u32,\n joint_locations: locations.as_mut_ptr(),\n skeleton_changed_count: 0,\n time: xr::Time::from_nanos(0),\n };\n unsafe {\n super::xr_res((self.ext_fns.locate_body_joints)(\n self.handle,\n &locate_info,\n &mut location_info,\n ))?;\n\n Ok(if location_info.is_active.into() {\n locations.set_len(joint_count);\n\n Some(locations)\n } else {\n None\n })\n }\n }\n}\n\nimpl Drop for BodyTrackerFB {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_body_tracker)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/eye_gaze_interaction.rs",
"content": "use openxr::{self as xr, sys};\nuse std::ptr;\n\npub fn supports_eye_gaze_interaction(session: &xr::Session, system: xr::SystemId) -> bool {\n if session.instance().exts().ext_eye_gaze_interaction.is_none() {\n return false;\n }\n\n super::get_props(\n session,\n system,\n sys::SystemEyeGazeInteractionPropertiesEXT {\n ty: sys::SystemEyeGazeInteractionPropertiesEXT::TYPE,\n next: ptr::null_mut(),\n supports_eye_gaze_interaction: sys::FALSE,\n },\n )\n .map(|props| props.supports_eye_gaze_interaction.into())\n .unwrap_or(false)\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/eye_tracking_social.rs",
"content": "use openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::ptr;\n\npub struct EyeTrackerSocial {\n handle: sys::EyeTrackerFB,\n ext_fns: raw::EyeTrackingSocialFB,\n}\n\nimpl EyeTrackerSocial {\n pub fn new(session: &xr::Session) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .fb_eye_tracking_social\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let mut handle = sys::EyeTrackerFB::NULL;\n let info = sys::EyeTrackerCreateInfoFB {\n ty: sys::EyeTrackerCreateInfoFB::TYPE,\n next: ptr::null(),\n };\n unsafe {\n super::xr_res((ext_fns.create_eye_tracker)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?\n };\n\n Ok(Self { handle, ext_fns })\n }\n\n pub fn get_eye_gazes(\n &self,\n base: &xr::Space,\n time: xr::Time,\n ) -> xr::Result<[Option; 2]> {\n let gaze_info = sys::EyeGazesInfoFB {\n ty: sys::EyeGazesInfoFB::TYPE,\n next: ptr::null(),\n base_space: base.as_raw(),\n time,\n };\n\n let mut eye_gazes = sys::EyeGazesFB::out(ptr::null_mut());\n\n let eye_gazes = unsafe {\n super::xr_res((self.ext_fns.get_eye_gazes)(\n self.handle,\n &gaze_info,\n eye_gazes.as_mut_ptr(),\n ))?;\n\n eye_gazes.assume_init()\n };\n\n let left_valid: bool = eye_gazes.gaze[0].is_valid.into();\n let right_valid: bool = eye_gazes.gaze[1].is_valid.into();\n\n Ok([\n left_valid.then(|| eye_gazes.gaze[0].gaze_pose),\n right_valid.then(|| eye_gazes.gaze[1].gaze_pose),\n ])\n }\n}\n\nimpl Drop for EyeTrackerSocial {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_eye_tracker)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/face_tracking2_fb.rs",
"content": "use openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::ptr;\n\npub struct FaceTracker2FB {\n // Keeping a reference to the session to ensure that the tracker handle remains valid\n _session: xr::Session,\n handle: sys::FaceTracker2FB,\n ext_fns: raw::FaceTracking2FB,\n}\n\nimpl FaceTracker2FB {\n pub fn new(session: xr::Session, visual: bool, audio: bool) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .fb_face_tracking2\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let mut requested_data_sources = vec![];\n if visual {\n requested_data_sources.push(sys::FaceTrackingDataSource2FB::VISUAL);\n }\n if audio {\n requested_data_sources.push(sys::FaceTrackingDataSource2FB::AUDIO);\n }\n\n let mut handle = sys::FaceTracker2FB::NULL;\n let info = sys::FaceTrackerCreateInfo2FB {\n ty: sys::FaceTrackerCreateInfo2FB::TYPE,\n next: ptr::null(),\n face_expression_set: xr::FaceExpressionSet2FB::DEFAULT,\n requested_data_source_count: requested_data_sources.len() as u32,\n requested_data_sources: requested_data_sources.as_mut_ptr(),\n };\n unsafe {\n super::xr_res((ext_fns.create_face_tracker2)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?\n };\n\n Ok(Self {\n _session: session.into_any_graphics(),\n handle,\n ext_fns,\n })\n }\n\n pub fn get_face_expression_weights(&self, time: xr::Time) -> xr::Result>> {\n let expression_info = sys::FaceExpressionInfo2FB {\n ty: sys::FaceExpressionInfo2FB::TYPE,\n next: ptr::null(),\n time,\n };\n\n let weights_count = xr::FaceExpression2FB::COUNT.into_raw() as usize;\n let confidence_count = xr::FaceConfidence2FB::COUNT.into_raw() as usize;\n\n let mut weights: Vec = Vec::with_capacity(weights_count);\n let mut confidences: Vec = vec![0.0; confidence_count];\n\n let mut expression_weights = sys::FaceExpressionWeights2FB {\n ty: sys::FaceExpressionWeights2FB::TYPE,\n next: ptr::null_mut(),\n weight_count: weights_count as u32,\n weights: weights.as_mut_ptr(),\n confidence_count: confidence_count as u32,\n confidences: confidences.as_mut_ptr(),\n is_valid: sys::FALSE,\n is_eye_following_blendshapes_valid: sys::FALSE,\n data_source: sys::FaceTrackingDataSource2FB::from_raw(0),\n time: xr::Time::from_nanos(0),\n };\n\n unsafe {\n super::xr_res((self.ext_fns.get_face_expression_weights2)(\n self.handle,\n &expression_info,\n &mut expression_weights,\n ))?;\n\n if expression_weights.is_valid.into() {\n weights.set_len(weights_count);\n\n Ok(Some(weights))\n } else {\n Ok(None)\n }\n }\n }\n}\n\nimpl Drop for FaceTracker2FB {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_face_tracker2)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/face_tracking_pico.rs",
"content": "use crate::extra_extensions::get_instance_proc;\nuse openxr::{self as xr, sys};\n\nconst TRACKING_MODE_FACE_BIT: u64 = 0x00000008;\nconst PICO_FACE_EXPRESSION_COUNT: usize = 52;\n\n#[repr(C)]\nstruct FaceTrackingDataPICO {\n time: sys::Time,\n blend_shape_weight: [f32; 72],\n is_video_input_valid: [f32; 10],\n laughing_probability: f32,\n emotion_probability: [f32; 10],\n reserved: [f32; 128],\n}\n\ntype StartEyeTrackingPICO = unsafe extern \"system\" fn(sys::Session) -> sys::Result;\n\ntype StopEyeTrackingPICO = unsafe extern \"system\" fn(sys::Session, u64) -> sys::Result;\n\ntype SetTrackingModePICO = unsafe extern \"system\" fn(sys::Session, u64) -> sys::Result;\n\ntype GetFaceTrackingDataPICO = unsafe extern \"system\" fn(\n sys::Session,\n sys::Time,\n i32,\n *mut FaceTrackingDataPICO,\n) -> sys::Result;\n\npub struct FaceTrackerPico {\n session: xr::Session,\n start_eye_tracking: StartEyeTrackingPICO,\n stop_eye_tracking: StopEyeTrackingPICO,\n set_tracking_mode: SetTrackingModePICO,\n get_face_tracking_data: GetFaceTrackingDataPICO,\n}\n\nimpl FaceTrackerPico {\n pub fn new(session: xr::Session) -> xr::Result {\n session\n .instance()\n .exts()\n .ext_eye_gaze_interaction\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let start_eye_tracking = get_instance_proc(&session, \"xrStartEyeTrackingPICO\")?;\n let stop_eye_tracking = get_instance_proc(&session, \"xrStopEyeTrackingPICO\")?;\n let set_tracking_mode = get_instance_proc(&session, \"xrSetTrackingModePICO\")?;\n let get_face_tracking_data = get_instance_proc(&session, \"xrGetFaceTrackingDataPICO\")?;\n\n Ok(Self {\n session: session.into_any_graphics(),\n start_eye_tracking,\n stop_eye_tracking,\n set_tracking_mode,\n get_face_tracking_data,\n })\n }\n\n pub fn get_face_tracking_data(&self, time: xr::Time) -> xr::Result>> {\n let mut face_tracking_data = FaceTrackingDataPICO {\n time: xr::Time::from_nanos(0),\n blend_shape_weight: [0.0; 72],\n is_video_input_valid: [0.0; 10],\n laughing_probability: 0.0,\n emotion_probability: [0.0; 10],\n reserved: [0.0; 128],\n };\n\n unsafe {\n super::xr_res((self.get_face_tracking_data)(\n self.session.as_raw(),\n time,\n 0,\n &mut face_tracking_data,\n ))?;\n\n if face_tracking_data.time.as_nanos() != 0 {\n let blend_shape_slice =\n face_tracking_data.blend_shape_weight[..PICO_FACE_EXPRESSION_COUNT].to_vec();\n\n Ok(Some(blend_shape_slice))\n } else {\n Ok(None)\n }\n }\n }\n\n pub fn start_face_tracking(&self) -> xr::Result<()> {\n unsafe {\n super::xr_res((self.start_eye_tracking)(self.session.as_raw()))?;\n super::xr_res((self.set_tracking_mode)(\n self.session.as_raw(),\n TRACKING_MODE_FACE_BIT,\n ))\n }\n }\n\n pub fn stop_face_tracking(&self) -> xr::Result<()> {\n unsafe {\n super::xr_res((self.stop_eye_tracking)(\n self.session.as_raw(),\n TRACKING_MODE_FACE_BIT,\n ))\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/facial_tracking_htc.rs",
"content": "use openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::ptr;\n\npub struct FacialTrackerHTC {\n // Keeping a reference to the session to ensure that the tracker handle remains valid\n _session: xr::Session,\n handle: sys::FacialTrackerHTC,\n ext_fns: raw::FacialTrackingHTC,\n expression_count: usize,\n}\n\nimpl FacialTrackerHTC {\n pub fn new(\n session: xr::Session,\n system: xr::SystemId,\n facial_tracking_type: xr::FacialTrackingTypeHTC,\n ) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .htc_facial_tracking\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let props = super::get_props(\n &session,\n system,\n sys::SystemFacialTrackingPropertiesHTC {\n ty: sys::SystemFacialTrackingPropertiesHTC::TYPE,\n next: ptr::null_mut(),\n support_eye_facial_tracking: sys::FALSE,\n support_lip_facial_tracking: sys::FALSE,\n },\n )?;\n\n let expression_count = if facial_tracking_type == sys::FacialTrackingTypeHTC::EYE_DEFAULT\n && props.support_eye_facial_tracking.into()\n {\n sys::FACIAL_EXPRESSION_EYE_COUNT_HTC\n } else if facial_tracking_type == sys::FacialTrackingTypeHTC::LIP_DEFAULT\n && props.support_lip_facial_tracking.into()\n {\n sys::FACIAL_EXPRESSION_LIP_COUNT_HTC\n } else {\n return Err(sys::Result::ERROR_FEATURE_UNSUPPORTED);\n };\n\n let mut handle = sys::FacialTrackerHTC::NULL;\n let info = sys::FacialTrackerCreateInfoHTC {\n ty: sys::FacialTrackerCreateInfoHTC::TYPE,\n next: ptr::null(),\n facial_tracking_type,\n };\n unsafe {\n super::xr_res((ext_fns.create_facial_tracker)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?\n };\n\n Ok(Self {\n _session: session.into_any_graphics(),\n handle,\n ext_fns,\n expression_count,\n })\n }\n\n pub fn get_facial_expressions(&self, time: xr::Time) -> xr::Result>> {\n let mut weights = Vec::with_capacity(self.expression_count);\n\n let mut facial_expressions = sys::FacialExpressionsHTC {\n ty: sys::FacialExpressionsHTC::TYPE,\n next: ptr::null_mut(),\n is_active: sys::FALSE,\n sample_time: time,\n expression_count: self.expression_count as u32,\n expression_weightings: weights.as_mut_ptr(),\n };\n\n unsafe {\n super::xr_res((self.ext_fns.get_facial_expressions)(\n self.handle,\n &mut facial_expressions,\n ))?;\n\n if facial_expressions.is_active.into() {\n weights.set_len(self.expression_count);\n\n Ok(Some(weights))\n } else {\n Ok(None)\n }\n }\n }\n}\n\nimpl Drop for FacialTrackerHTC {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_facial_tracker)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/mod.rs",
"content": "mod body_tracking_bd;\nmod body_tracking_fb;\nmod eye_gaze_interaction;\nmod eye_tracking_social;\nmod face_tracking2_fb;\nmod face_tracking_pico;\nmod facial_tracking_htc;\nmod motion_tracking_bd;\nmod multimodal_input;\nmod passthrough_fb;\nmod passthrough_htc;\n\npub use body_tracking_bd::*;\npub use body_tracking_fb::*;\npub use eye_gaze_interaction::*;\npub use eye_tracking_social::*;\npub use face_tracking_pico::*;\npub use face_tracking2_fb::*;\npub use facial_tracking_htc::*;\npub use motion_tracking_bd::*;\npub use multimodal_input::*;\npub use passthrough_fb::*;\npub use passthrough_htc::*;\nuse std::ffi::CString;\nuse std::mem;\n\nuse openxr::{self as xr, sys};\n\nfn xr_res(result: sys::Result) -> xr::Result<()> {\n if result.into_raw() >= 0 {\n Ok(())\n } else {\n Err(result)\n }\n}\n\nfn get_props(\n session: &xr::Session,\n system: xr::SystemId,\n default_struct: T,\n) -> xr::Result {\n let instance = session.instance();\n\n let mut props = default_struct;\n let mut system_properties = sys::SystemProperties::out((&raw mut props).cast());\n let result = unsafe {\n (instance.fp().get_system_properties)(\n instance.as_raw(),\n system,\n system_properties.as_mut_ptr(),\n )\n };\n\n xr_res(result).map(|_| props)\n}\n\nfn get_instance_proc(session: &xr::Session, method_name: &str) -> xr::Result {\n unsafe {\n let method_name = CString::new(method_name).unwrap();\n let mut function_handle = None;\n\n xr_res((session.instance().fp().get_instance_proc_addr)(\n session.instance().as_raw(),\n method_name.as_ptr(),\n &mut function_handle,\n ))?;\n\n function_handle\n .map(|pfn| mem::transmute_copy(&pfn))\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/motion_tracking_bd.rs",
"content": "use crate::extra_extensions::get_instance_proc;\nuse openxr::{self as xr, AnyGraphics, sys};\nuse std::ffi::{CString, c_char};\n\npub const BD_MOTION_TRACKING_EXTENSION_NAME: &str = \"XR_BD_motion_tracking\";\npub const PICO_CONFIGURATION_EXTENSION_NAME: &str = \"XR_PICO_configuration\";\n\n#[repr(C)]\n#[derive(Default)]\nstruct MotionTrackerConnectStateBD {\n tracker_count: i32,\n serials: [MotionTrackerSerialBD; 6],\n}\n\n#[repr(C)]\n#[derive(Ord, Eq, PartialEq, PartialOrd, Default)]\npub struct MotionTrackerSerialBD {\n pub serial: [u8; 24],\n}\n\n#[repr(transparent)]\n#[derive(Copy, Clone, Eq, PartialEq)]\npub struct MotionTrackerConfidenceBD(i32);\n\n#[repr(C)]\npub struct MotionTrackerLocationBD {\n pub pose: sys::Posef,\n pub angular_velocity: sys::Vector3f,\n pub linear_velocity: sys::Vector3f,\n pub angular_acceleration: sys::Vector3f,\n pub linear_acceleration: sys::Vector3f,\n}\n\n#[repr(C)]\npub struct MotionTrackerLocationsBD {\n pub serial: MotionTrackerSerialBD,\n pub local_pose: MotionTrackerLocationBD,\n pub confidence: MotionTrackerConfidenceBD,\n pub global_pose: MotionTrackerLocationBD,\n}\n\ntype GetMotionTrackerConnectStateBD =\n unsafe extern \"system\" fn(sys::Instance, *mut MotionTrackerConnectStateBD) -> sys::Result;\n\ntype GetMotionTrackerLocationsBD = unsafe extern \"system\" fn(\n sys::Instance,\n sys::Time,\n *const MotionTrackerSerialBD,\n *mut MotionTrackerLocationsBD,\n) -> sys::Result;\n\ntype SetConfigPICO = unsafe extern \"system\" fn(sys::Session, i32, *const c_char) -> sys::Result;\n\npub struct MotionTrackerBD {\n session: xr::Session,\n get_motion_tracker_connect_state: GetMotionTrackerConnectStateBD,\n get_motion_tracker_locations: GetMotionTrackerLocationsBD,\n}\n\nimpl MotionTrackerBD {\n pub fn new(session: xr::Session, extra_extensions: &[String]) -> xr::Result {\n if !extra_extensions.contains(&BD_MOTION_TRACKING_EXTENSION_NAME.to_owned())\n || !extra_extensions.contains(&PICO_CONFIGURATION_EXTENSION_NAME.to_owned())\n {\n return Err(sys::Result::ERROR_EXTENSION_NOT_PRESENT);\n }\n\n let get_motion_tracker_connect_state =\n get_instance_proc(&session, \"xrGetMotionTrackerConnectStateBD\")?;\n let get_motion_tracker_locations =\n get_instance_proc(&session, \"xrGetMotionTrackerLocationsBD\")?;\n let set_config: SetConfigPICO = get_instance_proc(&session, \"xrSetConfigPICO\")?;\n\n unsafe {\n //Floor height tracking origin\n let str = CString::new(\"1\").unwrap();\n //Set config property for tracking origin\n super::xr_res(set_config(session.as_raw(), 1, str.as_ptr()))?;\n };\n\n Ok(Self {\n session: session.into_any_graphics(),\n get_motion_tracker_connect_state,\n get_motion_tracker_locations,\n })\n }\n\n pub fn locate_motion_trackers(\n &self,\n time: xr::Time,\n ) -> xr::Result>> {\n let mut locations = Vec::with_capacity(3);\n let mut connect_state = MotionTrackerConnectStateBD::default();\n\n unsafe {\n super::xr_res((self.get_motion_tracker_connect_state)(\n self.session.instance().as_raw(),\n &mut connect_state,\n ))?;\n\n // Pico doesn't provide a way to connect more than three trackers now\n if connect_state.tracker_count > 3 {\n connect_state.tracker_count = 3\n }\n\n for i in 0..connect_state.tracker_count as usize {\n let mut location = MotionTrackerLocationsBD {\n serial: MotionTrackerSerialBD { serial: [0; 24] },\n local_pose: MotionTrackerLocationBD {\n pose: xr::Posef::IDENTITY,\n angular_velocity: Default::default(),\n linear_velocity: Default::default(),\n angular_acceleration: Default::default(),\n linear_acceleration: Default::default(),\n },\n confidence: MotionTrackerConfidenceBD(0),\n global_pose: MotionTrackerLocationBD {\n pose: xr::Posef::IDENTITY,\n angular_velocity: Default::default(),\n linear_velocity: Default::default(),\n angular_acceleration: Default::default(),\n linear_acceleration: Default::default(),\n },\n };\n\n super::xr_res((self.get_motion_tracker_locations)(\n self.session.instance().as_raw(),\n time,\n &connect_state.serials[i],\n &mut location,\n ))?;\n\n locations.push(location);\n }\n }\n\n Ok(Some(locations))\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/multimodal_input.rs",
"content": "// Code taken from:\n// https://github.com/meta-quest/Meta-OpenXR-SDK/blob/main/OpenXR/meta_openxr_preview/meta_simultaneous_hands_and_controllers.h\n\nuse crate::extra_extensions::get_instance_proc;\nuse openxr::{\n self as xr,\n sys::{self},\n};\nuse std::{ffi::c_void, ptr, sync::LazyLock};\n\npub const META_SIMULTANEOUS_HANDS_AND_CONTROLLERS_EXTENSION_NAME: &str =\n \"XR_META_simultaneous_hands_and_controllers\";\npub const META_DETACHED_CONTROLLERS_EXTENSION_NAME: &str = \"XR_META_detached_controllers\";\n\nstatic TYPE_SYSTEM_SIMULTANEOUS_HANDS_AND_CONTROLLERS_PROPERTIES_META: LazyLock =\n LazyLock::new(|| xr::StructureType::from_raw(1000532001));\nstatic TYPE_SIMULTANEOUS_HANDS_AND_CONTROLLERS_TRACKING_RESUME_INFO_META: LazyLock<\n xr::StructureType,\n> = LazyLock::new(|| xr::StructureType::from_raw(1000532002));\nstatic TYPE_SIMULTANEOUS_HANDS_AND_CONTROLLERS_TRACKING_PAUSE_INFO_META: LazyLock<\n xr::StructureType,\n> = LazyLock::new(|| xr::StructureType::from_raw(1000532003));\n\n#[repr(C)]\nstruct SystemSymultaneousHandsAndControllersPropertiesMETA {\n ty: xr::StructureType,\n next: *const c_void,\n supports_simultaneous_hands_and_controllers: sys::Bool32,\n}\n\n#[repr(C)]\nstruct SimultaneousHandsAndControllersTrackingResumeInfoMETA {\n ty: xr::StructureType,\n next: *const c_void,\n}\n#[repr(C)]\nstruct SimultaneousHandsAndControllersTrackingPauseInfoMETA {\n ty: xr::StructureType,\n next: *const c_void,\n}\n\ntype ResumeSimultaneousHandsAndControllersTrackingMETA = unsafe extern \"system\" fn(\n sys::Session,\n *const SimultaneousHandsAndControllersTrackingResumeInfoMETA,\n) -> sys::Result;\ntype PauseSimultaneousHandsAndControllersTrackingMETA = unsafe extern \"system\" fn(\n sys::Session,\n *const SimultaneousHandsAndControllersTrackingPauseInfoMETA,\n) -> sys::Result;\n\npub struct MultimodalMeta {\n session: xr::Session,\n resume_simultaneous_hands_and_controllers_tracking_meta:\n ResumeSimultaneousHandsAndControllersTrackingMETA,\n pause_simultaneous_hands_and_controllers_tracking_meta:\n PauseSimultaneousHandsAndControllersTrackingMETA,\n}\n\nimpl MultimodalMeta {\n pub fn new(\n session: xr::Session,\n extra_extensions: &[String],\n system: xr::SystemId,\n ) -> xr::Result {\n if !extra_extensions\n .contains(&META_SIMULTANEOUS_HANDS_AND_CONTROLLERS_EXTENSION_NAME.to_owned())\n || !extra_extensions.contains(&META_DETACHED_CONTROLLERS_EXTENSION_NAME.to_owned())\n {\n return Err(sys::Result::ERROR_EXTENSION_NOT_PRESENT);\n }\n\n let resume_simultaneous_hands_and_controllers_tracking_meta = get_instance_proc(\n &session,\n \"xrResumeSimultaneousHandsAndControllersTrackingMETA\",\n )?;\n let pause_simultaneous_hands_and_controllers_tracking_meta = get_instance_proc(\n &session,\n \"xrPauseSimultaneousHandsAndControllersTrackingMETA\",\n )?;\n\n let props = super::get_props(\n &session,\n system,\n SystemSymultaneousHandsAndControllersPropertiesMETA {\n ty: *TYPE_SYSTEM_SIMULTANEOUS_HANDS_AND_CONTROLLERS_PROPERTIES_META,\n next: ptr::null(),\n supports_simultaneous_hands_and_controllers: xr::sys::FALSE,\n },\n )?;\n\n if props.supports_simultaneous_hands_and_controllers.into() {\n Ok(Self {\n session: session.into_any_graphics(),\n resume_simultaneous_hands_and_controllers_tracking_meta,\n pause_simultaneous_hands_and_controllers_tracking_meta,\n })\n } else {\n Err(sys::Result::ERROR_FEATURE_UNSUPPORTED)\n }\n }\n\n pub fn resume(&self) -> xr::Result<()> {\n let resume_info = SimultaneousHandsAndControllersTrackingResumeInfoMETA {\n ty: *TYPE_SIMULTANEOUS_HANDS_AND_CONTROLLERS_TRACKING_RESUME_INFO_META,\n next: ptr::null(),\n };\n unsafe {\n super::xr_res((self\n .resume_simultaneous_hands_and_controllers_tracking_meta)(\n self.session.as_raw(),\n &resume_info,\n ))\n }\n }\n\n pub fn pause(&self) -> xr::Result<()> {\n let pause_info = SimultaneousHandsAndControllersTrackingPauseInfoMETA {\n ty: *TYPE_SIMULTANEOUS_HANDS_AND_CONTROLLERS_TRACKING_PAUSE_INFO_META,\n next: ptr::null(),\n };\n unsafe {\n super::xr_res((self\n .pause_simultaneous_hands_and_controllers_tracking_meta)(\n self.session.as_raw(),\n &pause_info,\n ))\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/passthrough_fb.rs",
"content": "use alvr_system_info::Platform;\nuse openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::ptr;\n\npub struct PassthroughFB {\n handle: sys::PassthroughFB,\n layer_handle: sys::PassthroughLayerFB,\n layer: sys::CompositionLayerPassthroughFB,\n ext_fns: raw::PassthroughFB,\n}\n\nimpl PassthroughFB {\n pub fn new(session: &xr::Session, platform: Platform) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .fb_passthrough\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let mut handle = sys::PassthroughFB::NULL;\n let info = sys::PassthroughCreateInfoFB {\n ty: sys::PassthroughCreateInfoFB::TYPE,\n next: ptr::null(),\n flags: sys::PassthroughFlagsFB::IS_RUNNING_AT_CREATION,\n };\n unsafe {\n super::xr_res((ext_fns.create_passthrough)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?\n };\n\n let mut layer_handle = sys::PassthroughLayerFB::NULL;\n let info = sys::PassthroughLayerCreateInfoFB {\n ty: sys::PassthroughLayerCreateInfoFB::TYPE,\n next: ptr::null(),\n passthrough: handle,\n flags: sys::PassthroughFlagsFB::IS_RUNNING_AT_CREATION,\n purpose: sys::PassthroughLayerPurposeFB::RECONSTRUCTION,\n };\n unsafe {\n super::xr_res((ext_fns.create_passthrough_layer)(\n session.as_raw(),\n &info,\n &mut layer_handle,\n ))?\n };\n\n let layer = sys::CompositionLayerPassthroughFB {\n ty: sys::CompositionLayerPassthroughFB::TYPE,\n next: ptr::null(),\n flags: xr::CompositionLayerFlags::BLEND_TEXTURE_SOURCE_ALPHA,\n space: sys::Space::NULL,\n layer_handle,\n };\n\n // HACK: YVR runtime seems to ignore IS_RUNNING_AT_CREATION on versions <= 3.0.1\n if platform.is_yvr() {\n unsafe { super::xr_res((ext_fns.passthrough_start)(handle))? };\n }\n\n Ok(Self {\n handle,\n layer_handle,\n layer,\n ext_fns,\n })\n }\n\n // return reference to make sure the passthrough handle is not dropped while the layer is in use\n pub fn layer(&self) -> &sys::CompositionLayerPassthroughFB {\n &self.layer\n }\n}\n\nimpl Drop for PassthroughFB {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_passthrough_layer)(self.layer_handle);\n (self.ext_fns.destroy_passthrough)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/extra_extensions/passthrough_htc.rs",
"content": "use openxr::{\n self as xr, raw,\n sys::{self, Handle},\n};\nuse std::ptr;\n\npub struct PassthroughHTC {\n handle: sys::PassthroughHTC,\n layer: sys::CompositionLayerPassthroughHTC,\n ext_fns: raw::PassthroughHTC,\n}\n\nimpl PassthroughHTC {\n pub fn new(session: &xr::Session) -> xr::Result {\n let ext_fns = session\n .instance()\n .exts()\n .htc_passthrough\n .ok_or(sys::Result::ERROR_EXTENSION_NOT_PRESENT)?;\n\n let mut handle = sys::PassthroughHTC::NULL;\n let info = sys::PassthroughCreateInfoHTC {\n ty: sys::PassthroughCreateInfoHTC::TYPE,\n next: ptr::null(),\n form: sys::PassthroughFormHTC::PLANAR,\n };\n unsafe {\n super::xr_res((ext_fns.create_passthrough)(\n session.as_raw(),\n &info,\n &mut handle,\n ))?\n };\n\n let layer = sys::CompositionLayerPassthroughHTC {\n ty: sys::CompositionLayerPassthroughHTC::TYPE,\n next: ptr::null(),\n layer_flags: xr::CompositionLayerFlags::EMPTY,\n space: sys::Space::NULL,\n passthrough: handle,\n color: sys::PassthroughColorHTC {\n ty: sys::PassthroughColorHTC::TYPE,\n next: ptr::null(),\n alpha: 1.0,\n },\n };\n\n Ok(Self {\n handle,\n layer,\n ext_fns,\n })\n }\n\n // return reference to make sure the passthrough handle is not dropped while the layer is in use\n pub fn layer(&self) -> &sys::CompositionLayerPassthroughHTC {\n &self.layer\n }\n}\n\nimpl Drop for PassthroughHTC {\n fn drop(&mut self) {\n unsafe {\n (self.ext_fns.destroy_passthrough)(self.handle);\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/graphics.rs",
"content": "use alvr_common::glam::UVec2;\nuse alvr_graphics::GraphicsContext;\nuse alvr_session::ClientsidePostProcessingConfig;\nuse openxr as xr;\nuse std::ptr;\n\n#[allow(unused)]\npub fn session_create_info(ctx: &GraphicsContext) -> xr::opengles::SessionCreateInfo {\n #[cfg(target_os = \"android\")]\n {\n xr::opengles::SessionCreateInfo::Android {\n display: ctx.egl_display.as_ptr(),\n config: ctx.egl_config.as_ptr(),\n context: ctx.egl_context.as_ptr(),\n }\n }\n #[cfg(not(target_os = \"android\"))]\n unimplemented!()\n}\n\npub fn swapchain_format(\n gfx_ctx: &GraphicsContext,\n session: &xr::Session,\n enable_hdr: bool,\n) -> u32 {\n gfx_ctx.make_current();\n\n let formats = session.enumerate_swapchain_formats().unwrap();\n alvr_graphics::choose_swapchain_format(&formats, enable_hdr)\n}\n\n#[allow(unused_variables)]\npub fn create_swapchain(\n session: &xr::Session,\n gfx_ctx: &GraphicsContext,\n resolution: UVec2,\n format: u32,\n foveation: Option<&xr::FoveationProfileFB>,\n) -> xr::Swapchain {\n gfx_ctx.make_current();\n\n let swapchain_info = xr::SwapchainCreateInfo {\n create_flags: xr::SwapchainCreateFlags::EMPTY,\n usage_flags: xr::SwapchainUsageFlags::COLOR_ATTACHMENT | xr::SwapchainUsageFlags::SAMPLED,\n format,\n sample_count: 1,\n width: resolution.x,\n height: resolution.y,\n face_count: 1,\n array_size: 1,\n mip_count: 1,\n };\n\n session.create_swapchain(&swapchain_info).unwrap()\n}\n\npub struct ProjectionLayerAlphaConfig {\n pub premultiplied: bool,\n}\n\n// This is needed to work around lifetime limitations. Deref cannot be implemented because there are\n// nested references, and in a way or the other I would get `cannot return reference to temporary\n// value`\npub struct ProjectionLayerBuilder<'a> {\n reference_space: &'a xr::Space,\n layers: [xr::CompositionLayerProjectionView<'a, xr::OpenGlEs>; 2],\n alpha: Option,\n composition_layer_settings: Option,\n}\n\nimpl<'a> ProjectionLayerBuilder<'a> {\n pub fn new(\n reference_space: &'a xr::Space,\n layers: [xr::CompositionLayerProjectionView<'a, xr::OpenGlEs>; 2],\n alpha: Option,\n clientside_post_processing_config: Option,\n ) -> Self {\n let composition_layer_settings = clientside_post_processing_config\n .map(|post_processing| {\n xr::CompositionLayerSettingsFlagsFB::from_raw(\n (post_processing.sharpening as u64) | (post_processing.super_sampling as u64),\n )\n })\n .filter(|&flags| flags != xr::CompositionLayerSettingsFlagsFB::EMPTY)\n .map(|flags| xr::sys::CompositionLayerSettingsFB {\n ty: xr::StructureType::COMPOSITION_LAYER_SETTINGS_FB,\n next: std::ptr::null(),\n layer_flags: flags,\n });\n Self {\n reference_space,\n layers,\n alpha,\n composition_layer_settings,\n }\n }\n\n pub fn build(&self) -> xr::CompositionLayerProjection<'_, xr::OpenGlEs> {\n let mut flags = xr::CompositionLayerFlags::EMPTY;\n\n if let Some(alpha) = &self.alpha {\n flags |= xr::CompositionLayerFlags::BLEND_TEXTURE_SOURCE_ALPHA;\n\n if !alpha.premultiplied {\n flags |= xr::CompositionLayerFlags::UNPREMULTIPLIED_ALPHA;\n }\n }\n\n let layer = xr::CompositionLayerProjection::new()\n .layer_flags(flags)\n .space(self.reference_space)\n .views(&self.layers);\n\n if let Some(composition_layer_settings) = self.composition_layer_settings.as_ref() {\n unsafe {\n xr::CompositionLayerProjection::from_raw(xr::sys::CompositionLayerProjection {\n next: ptr::from_ref(composition_layer_settings).cast(),\n ..layer.into_raw()\n })\n }\n } else {\n layer\n }\n }\n}\n"
},
{
"path": "alvr/client_openxr/src/interaction.rs",
"content": "use crate::{\n Platform,\n extra_extensions::{\n self, BODY_JOINT_SET_FULL_BODY_META, BodyJointSetBD, BodyTrackerBD, BodyTrackerFB,\n EyeTrackerSocial, FULL_BODY_JOINT_COUNT_META, FaceTracker2FB, FaceTrackerPico,\n FacialTrackerHTC, MotionTrackerBD, MultimodalMeta,\n },\n};\nuse alvr_common::{\n glam::{Quat, Vec3},\n *,\n};\nuse alvr_graphics::HandData;\nuse alvr_packets::{ButtonEntry, ButtonValue, FaceData, FaceExpressions, StreamConfig};\nuse alvr_session::{BodyTrackingBDConfig, BodyTrackingSourcesConfig, FaceTrackingSourcesConfig};\nuse openxr as xr;\nuse std::{\n collections::{HashMap, HashSet},\n time::Duration,\n};\nuse xr::SpaceLocationFlags;\n\nconst IPD_CHANGE_EPS: f32 = 0.001;\n\n// Most OpenXR runtime, including Meta's one, do not follow perfectly the specification regarding\n// controller pose. The Z axis should point down through the center of the controller grip, the X\n// axis should go out perpendicular from the palm, and the position should be aligned roughtly with\n// the center of the palm.\n// https://registry.khronos.org/OpenXR/specs/1.1/html/xrspec.html\n// Note: right controller offsets are calculated from left controller offsets by mirroring along the\n// Y-Z plane.\nfn get_controller_offset(platform: Platform, is_right_hand: bool) -> Pose {\n const DEG_TO_RAD: f32 = std::f32::consts::PI / 180.0;\n\n let left_offset = match platform {\n Platform::Quest1 => Pose {\n position: Vec3::new(-0.013, -0.005, 0.0),\n orientation: Quat::from_rotation_x(-20.0 * DEG_TO_RAD),\n },\n // todo: check Quest 2\n p if p.is_quest() => Pose {\n position: Vec3::new(-0.005, -0.005, 0.00),\n orientation: Quat::from_rotation_x(-15.0 * DEG_TO_RAD),\n },\n Platform::PicoNeo3 => Pose {\n position: Vec3::new(-0.013, -0.035, 0.0),\n orientation: Quat::IDENTITY,\n },\n // todo: check (base) Pico 4\n p if p.is_pico() => Pose {\n position: Vec3::new(-0.01, -0.035, 0.0),\n orientation: Quat::from_rotation_y(6.0 * DEG_TO_RAD)\n * Quat::from_rotation_x(-6.0 * DEG_TO_RAD),\n },\n p if p.is_vive() => Pose {\n position: Vec3::new(0.0, 0.0, -0.02),\n orientation: Quat::IDENTITY,\n },\n Platform::SamsungGalaxyXR => Pose {\n position: Vec3::new(0.0, 0.0, 0.055),\n orientation: Quat::IDENTITY,\n },\n _ => Pose::IDENTITY,\n };\n\n if is_right_hand {\n let p = left_offset.position;\n let q = left_offset.orientation;\n\n Pose {\n position: Vec3::new(-p[0], p[1], p[2]),\n orientation: Quat::from_xyzw(-q.x, q.y, q.z, -q.w),\n }\n } else {\n left_offset\n }\n}\n\nfn check_ext_object(name: &str, result: xr::Result) -> Option {\n match result {\n Ok(obj) => Some(obj),\n Err(xr::sys::Result::ERROR_FEATURE_UNSUPPORTED) => {\n warn!(\"Cannot create unsupported {name}\");\n None\n }\n Err(xr::sys::Result::ERROR_EXTENSION_NOT_PRESENT) => None,\n Err(e) => {\n warn!(\"Failed to create {name}: {e}\");\n None\n }\n }\n}\n\npub enum ButtonAction {\n Binary(xr::Action),\n Scalar(xr::Action),\n}\n\npub struct HandInteraction {\n pub controllers_profile_id: u64,\n pub input_ids: HashSet,\n pub pose_offset: Pose,\n\n pub grip_action: xr::Action,\n pub grip_space: xr::Space,\n\n #[expect(dead_code)]\n pub aim_action: xr::Action,\n #[expect(dead_code)]\n pub aim_space: xr::Space,\n\n pub detached_grip_action: Option>,\n pub detached_grip_space: Option,\n\n pub vibration_action: xr::Action,\n pub skeleton_tracker: Option,\n}\n\npub enum FaceExpressionsTracker {\n Fb(FaceTracker2FB),\n Pico(FaceTrackerPico),\n Htc {\n eye: Option