Reviewer Recommendation

The ideal group to review this material would be a Technical Steering Committee for Open-Source Audio Development or a Principal Engineering Review Board specializing in cross-platform C++ systems and DSP emulation.

Abstract

The provided documentation and source code describe Gearmulator, an advanced low-level emulation project developed by "The Usual Suspects." The system is designed to recreate the hardware environments of late-90s and early-2000s virtual analog (VA) synthesizers and effects units—specifically those utilizing the Motorola DSP56300 architecture. By emulating the original integrated circuits (ICs), Gearmulator allows users to run original factory firmware (ROMs) as modern audio plugins (VST3, AU, CLAP, LV2) on current Windows, macOS, and Linux systems. The codebase is architected in C++17 and utilizes a modular design comprising core DSP emulation, a networking bridge for distributed processing, and a robust CI/CD pipeline for multi-architecture deployment (x64 and ARM).

Technical Summary: Gearmulator System Architecture and Deployment

• Project Scope and Device Support:

  • Emulated Hardware: Targets iconic VA synths including the Access Virus (A, B, C, TI, TI2, Snow), Waldorf microQ, Microwave II/XT, Clavia Nord Lead 2x, and Roland JP-8000.
  • Methodology: Emulates the hardware ICs to execute original firmware ROMs, ensuring high-fidelity recreation of the original sound engines.

• Architecture and Engineering Standards:

  • Language & Build System: C++17 compliant; utilizes CMake (version 3.15+) for cross-platform configuration and building.
  • Modular Library Design:
    • baseLib: Core utilities for binary streaming, filesystem abstraction, thread management, and endian-independent data handling.
    • synthLib: Abstracted synthesizer logic and audio/MIDI type definitions.
    • bridgeLib: Facilitates a client-server architecture, allowing audio processing to be offloaded over TCP/UDP networks via a dedicated bridgeServer.
  • Audio Middleware: Integrates JUCE for plugin wrapping and RmlUi for hardware-accurate user interface rendering.

• Multi-Platform Support and CI/CD:

  • Supported Architectures: 64-bit x86 (x64) and ARM aarch64 (Apple Silicon, Raspberry Pi 4/5, Zynthian). Note that 32-bit architectures are explicitly unsupported.
  • Build Pipeline: Implements a sophisticated automation suite using GitHub Actions, Azure Pipelines, and Jenkins for nightly builds and integration testing.
  • Deployment: Uses CPack to generate platform-specific installers (.exe, .deb, .rpm, .zip) and NSIS for Windows-specific plugin installation management.

• Network and Bridge Protocols:

  • Discovery: Uses UdpClient/UdpServer (port 56303) for server discovery and protocol validation.
  • Streaming: Employs a TcpConnection (port 56362) for high-speed MIDI and audio data transfer between the plugin client and the emulation server.
  • Session Management: Includes session ID persistence to recover device states across connection interruptions.

• Optimizations and Performance:

  • Compiler Flags: Utilizes aggressive optimization (/O2, /fp:fast, -Ofast, -flto) and IPO (Interprocedural Optimization) where supported.
  • DSP Performance: Includes specific code paths for armv8.2-a atomics and SSE/SSE2 instruction sets to minimize latency during low-level emulation.

• Compliance and Licensing:

  • License: Governed by GNU GPLv3.
  • Proprietary SDK Handling: Includes logic to dynamically fetch or provide alternatives (FST) to proprietary VST2 SDKs via rclone to maintain legal compliance during build processes.

• Development and Lifecycle Management:

  • Changelog Automation: Employs a custom changelogGenerator tool to parse and split updates by product (e.g., Osirus, Vavra) and version for Discord and web publication.
  • Documentation: Maintains structured changelogs and build instructions within the repository to facilitate open-source contribution via Discord and GitHub.