How ringbuffer-org/zerr works
Project type and purpose
• Zerr* is an open-source, multi-target audio spatialization library.
• Core algorithm (C++ static library) analyzes incoming audio features and redistributes signals across arbitrary speaker arrays.
• Provides front-ends for PureData externals, JACK client, and Max/MSP externals.
File structure
• Top-level build & CI: CMakeLists.txt, build.sh, .github/workflows, configs/
• core/: the algorithm engine
• / & src/ subdirectories with features/, modules/, utils/
• builds into a static library (zerr-core) via CMake and Conan
• puredata/: PD externals
• pd-lib-builder integration, headers in include/, sources in src/
• jack/: standalone JACK client (meson.build + main.cpp + scripts/)
• maxmsp/: externals built with CMake and min-devkit, organized under source/projects/
• configs/: YAML definitions for modules, presets, speaker arrays
README insights
• Describes algorithm (“Autogenous Spatialization…”), runtime parameter tuning, and supported host targets
• Lists external dependencies: yaml-cpp, fftw3, PureData API, min-devkit for Max/MSP
Components
a. Core Engine (C++)
• Feature Extractors (centroid, flux, RMS, etc.)
• Modules (envelope generator, feature bank, speaker manager)
• Utilities (config loader, FFT transformer, ringbuffer, logger)
b. Host Adapters
• PureData externals (pd-lib-builder wrapper)
• JACK client (main.cpp + zerr.cpp)
• Max/MSP externals (min-devkit projects)
c. Configuration subsystem
• YAML files (modules, presets, speakers)
• Configs loaded at runtime via utils/configs.h
d. Build & Packaging
• CMake/Conan orchestrates core + Max/MSP + PureData
• Meson for JACK
• build.sh script automates host-specific builds
e. External Dependencies & Targets
• yaml-cpp, fftw3, PureData API, Max/MSP min-devkit, JACK API
Relationships & data flow
• Audio input (PD/JACK/Max → plugin adapter)
• Plugin calls Core Engine API
• Core extracts audio features → computes spatialization → routes multi-channel output
• Engine consults speaker array configs (YAML) via utils
• Output streams back to host for playback
Architectural patterns & design principles
• Modular “core vs adapters” separation
• Plugin/host abstraction: one core engine reused across environments
• Config-driven runtime behavior
• Dependency injection via headers and build-time linking