SpeakerView

3D view of the speaker setup for SpatGris.

Prior to version 3.3.0, SpatGRIS used OpenGL for 3D rendering. OpenGL is now deprecated on MacOS and JUCE does not facilitate the transition to Vulkan. The GRIS team has chosen to separate the 3D speaker setup view from SpatGRIS. Using Godot Engine, it is possible to support the main platforms (Windows, MacOS and Linux) and the hardware disparities of video graphics cards.

There are 3 SpeakerView versions.

• SpeakerView Forward uses Vulkan and support modern hardware
• SpeakerView Mobile uses Vulkan, but also supports older hardware
• SpeakerView Compatibilty uses OpenGL

SpatGRIS installer comes with SpeakerView Forward. If SpeakView does not render things correctly, replacing it (and the SpeakerView.pck file under Windows and Linux) with another version may help.

Building

Download Godot Engine

Download and install Godot 4.1.3

Note for MacOS users Godot for MacOS does not (yet) support "click-though" (mouse activity captured by an unfocused window). To give this functionality to SpeakerView, Godot must be patched and compiled using the following steps:

curl -L https://github.com/godotengine/godot/releases/download/4.1.3-stable/godot-4.1.3-stable.tar.xz -o godot.tar.xz
tar xJvf godot.tar.xz
patch godot-4.1.3-stable/platform/macos/godot_content_view.mm <path-to-macos_click_through.patch-provided-in-this-repo>
cd godot-4.1.3-stable

Install Vulkan SDK 1.3.250.1.

Then follow the instructions to compile Godot on MacOS (https://docs.godotengine.org/en/stable/contributing/development/compiling/compiling_for_macos.html). Note that the export template for MacOS (macos.zip) must be built and placed in ~/Library/Application Support/Godot/export_templates/4.1.3.stable/.

Clone SpeakerView sources

git clone git@github.com:GRIS-UdeM/SpeakerView.git

Compiling

1. From the Godot project list, import project.godot of the SpeakerView folder.
2. Select Edit the SpeakerView project.
3. Export the project to the platform of your choice.

Running

It is best to launch SpeakerView from SpatGris View menu : Show Speaker View.

To function correctly, the SpeakerView executable (and the SpeakerView.pck file under Windows and Linux) must be placed in the same folder as SpatGris. SpeakerView is independent of SpatGris, but designed to be controlled by SpatGris using the UDP protocol.

On Linux, the name of the executable must be SpeakerView.x86_64.