SoundScape Renderer User Manual

The SoundScape Renderer (SSR) is a tool for real-time spatial audio reproduction providing a variety of rendering algorithms, e.g. Wave Field Synthesis, Higher-Order Ambisonics and binaural techniques.

website

http://spatialaudio.net/ssr/

downloads

http://spatialaudio.net/ssr/download/

user manual

https://ssr.readthedocs.io/

mailing list

https://groups.google.com/forum/#!forum/SoundScapeRenderer

source code and issue tracker

https://github.com/SoundScapeRenderer/ssr

---

• General
  • Introduction
  • Quick Start
  • Audio Scenes
    • Format
    • Coordinate System
  • Audio Scene Description Format (ASDF)
    • Syntax
    • Examples
  • IP Interface
  • Bug Reports, Feature Requests and Comments
  • Contributors
  • Your Own Contributions
• Installation
  • Arch Linux
    • Building and installing with makepkg
  • Debian/Ubuntu
  • macOS Application Bundle
    • JACK on macOS
  • MS Windows
  • Others
• Building the SSR from Source
  • Tarball
  • Git Repository
  • Dependencies
  • Configuring
  • Building
  • Installing
  • Uninstalling
• Running the SSR
  • Starting the JACK Audio Server
  • SSR binaries
  • Loading a Single Audio File
  • Loading an Audio Scene File
  • Command Line Options
  • Configuration Files
  • Keyboard Actions in Non-GUI Mode
  • Recording the SSR Output
  • Head Tracking
    • Preparing InterSense InertiaCube3
    • Preparing Polhemus Fastrak/Patriot
    • Preparing VRPN
  • Using the SSR with DAWs
  • Using the SSR with different audio clients
    • VLC Media Player
  • Using the macOS App Bundle
    • Running via the Command Line (Terminal)
    • Using a Head-Tracker
      • Running with InterSense tracker support
      • Running with Razor AHRS tracker support
• The Renderers
  • General
    • Reproduction Setups
    • A Note on the Timing of the Audio Signals
    • Subwoofers
    • Distance Attenuation
    • Doppler Effect
    • Signal Processing
  • Binaural Renderer
    • The HRIR sets shipped with SSR
    • Preparing HRIR sets
  • Binaural Room Synthesis Renderer
  • Vector Base Amplitude Panning Renderer
  • Wave Field Synthesis Renderer
    • Prefiltering
    • Tapering
  • Ambisonics Amplitude Panning Renderer
    • Conventional driving function
    • In-phase driving function
  • Distance-coded Ambisonics Renderer
  • Generic Renderer
  • Summary
• Graphical User Interface
  • General Layout
  • Mouse Actions
    • Source Properties Dialog
    • Drag & Drop of Scenes
  • Keyboard Actions
• Browser-based GUI
• Network Interfaces
• SSR as a Library
• Known Issues
  • Open Issues
    • make dmg on macOS chokes on symbolic links
    • Only WAVE_FORMAT_PCM and WAVE_FORMAT_IEEE_FLOAT are supported.
    • SSR crashes with a segmentation fault on Max OS X
    • A file that can’t be loaded results in a connection to a live input
    • Conflicting JACK and Ecasound versions
    • Annoying Ecasound message
    • Ecasound cannot open a JACK port
    • Long paths to audio files on macOS
    • Segmentation Fault when Opening a Scene
    • Choppy Sound on Cheap (On-Board) Sound Cards
    • dylibbundler doesn’t grok Qt Frameworks
    • Second instance of SSR crashes
    • Error ValueError: unknown locale: UTF-8 when building the manual
  • Resolved Issues
    • SSR for macOS: qt_menu.nib not found
    • Compilation Error on Ubuntu and Archlinux
    • Polhemus tracker does not work with SSR
    • Missing GUI Buttons and Timeline
    • OpenGL Linker Error
    • IP interface isn’t selected although boost libraries are installed
    • Audio files with spaces