# hemmer/audibleinstruments architecture

> Architecture diagram of the GitHub repository hemmer/audibleinstruments, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-17). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hemmer/audibleinstruments
- Repository: https://github.com/hemmer/audibleinstruments

## Overview

##### Project Type and Purpose
- This is a VCV Rack “Audible Instruments” plugin, re-implementing Mutable Instruments Eurorack modules in C++ as a dynamic library loaded by the VCV Rack host.
- README confirms it provides digital versions of modules like Braids, Clouds, Tides, etc., each implemented in its own .cpp file, plus shared DSP libraries and UI assets.

##### File Structure
Top-level:
- plugin.json – VCV Rack metadata/manifest
- Makefile – build rules (compiles C++ to a plugin .dll/.so)
- src/ – C++ source code
– plugin.cpp / plugin.hpp – plugin initialization & module registration
– XX.cpp (Blinds, Braids, …) – one source file per module
– subdirectories (Ripples, Shelves, Streams) – reusable DSP/filter algorithm headers and sources
- design/ – Adobe Illustrator files (.ai) for panel artwork templates
- res/ – runtime assets (fonts)
- .gitmodules – possibly pulls in external DSP or Rack SDK submodules

##### README for Insights
- Confirms module list and their origins
- Mentions which modules include “virtual analog models” (alrightdevices DSP code)

##### Main Components & Their Interactions
a. VCV Rack Host
- Loads plugin.json, locates plugin binary, calls initialization
- Manages audio & CV signal routing between modules
b. Plugin Initialization (plugin.cpp)
- Reads plugin.json metadata
- Registers each Module class (Braids, Clouds, Tides, etc.) with the host
c. Module Factories
- C++ classes derived from rack::Module
- Each owns parameters, inputs, outputs, and DSP processing method
d. DSP Libraries
- Shared code under src/Ripples, Shelves, Streams implements filters, resamplers, engines
- Called by individual modules during process()
e. UI / Panel Artwork
- design/*.ai source templates  SVG/PNG assets at build time
- res/ fonts loaded by rack::Widget code in each panel’s .cpp
f. Build & Deployment
- Makefile invokes Rack SDK and compiler to produce plugin library
- plugin.json & res/ packaged alongside binary

##### Architectural Patterns & Design Principles
- Modular design: one C++ class per synth module
- Shared DSP component libraries for code reuse (Ripples, Shelves, Streams)
- Separation of concerns: plugin init vs. module DSP vs. UI layout
- Declarative registration via plugin.json + plugin.cpp

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Host Layer
    subgraph "VCV Rack Host"
        direction TB
        Host["VCV Rack Host"]:::host
        PL["Plugin Loader"]:::host
    end

    %% Plugin Core
    subgraph "Plugin Core"
        direction TB
        JSON["plugin.json"]:::core
        Lib["Plugin Library (.so/.dll)"]:::core
        PluginCPP["plugin.cpp"]:::core
        PluginH["plugin.hpp"]:::core
    end

    %% Module Factories
    subgraph "Module Factories"
        direction TB
        Blinds["Blinds Module"]:::module
        Braids["Braids Module"]:::module
        Branches["Branches Module"]:::module
        Clouds["Clouds Module"]:::module
        Elements["Elements Module"]:::module
        Frames["Frames Module"]:::module
        Kinks["Kinks Module"]:::module
        Links["Links Module"]:::module
        Marbles["Marbles Module"]:::module
        Peaks["Peaks Module"]:::module
        Plaits["Plaits Module"]:::module
        Rings["Rings Module"]:::module
        Shades["Shades Module"]:::module
        Stages["Stages Module"]:::module
        StreamsMod["Streams Module"]:::module
        Tides["Tides Module"]:::module
        Tides2["Tides2 Module"]:::module
        Veils["Veils Module"]:::module
        Warps["Warps Module"]:::module
    end

    %% DSP Libraries
    subgraph "DSP Libraries"
        direction TB
        RipplesDir["Ripples"]:::dsp
        ShelvesDir["Shelves"]:::dsp
        StreamsDir["Streams"]:::dsp
    end

    %% UI Assets
    subgraph "UI Assets"
        direction TB
        DesignDir["design/*.ai"]:::ui
        ResDir["res/fonts"]:::ui
    end

    %% Build System
    Makefile["Makefile"]:::build

    %% Connections
    Host --> PL
    PL --> JSON
    PL --> Lib
    PL --> PluginCPP
    PluginCPP --> PluginH
    PluginCPP -->|register modules| Blinds
    PluginCPP -->|register modules| Braids
    PluginCPP -->|register modules| Branches
    PluginCPP -->|register modules| Clouds
    PluginCPP -->|register modules| Elements
    PluginCPP -->|register modules| Frames
    PluginCPP -->|register modules| Kinks
    PluginCPP -->|register modules| Links
    PluginCPP -->|register modules| Marbles
    PluginCPP -->|register modules| Peaks
    PluginCPP -->|register modules| Plaits
    PluginCPP -->|register modules| Rings
    PluginCPP -->|register modules| Shades
    PluginCPP -->|register modules| Stages
    PluginCPP -->|register modules| StreamsMod
    PluginCPP -->|register modules| Tides
    PluginCPP -->|register modules| Tides2
    PluginCPP -->|register modules| Veils
    PluginCPP -->|register modules| Warps

    %% Modules to DSP and UI
    Blinds -->|uses DSP| RipplesDir
    Braids -->|uses DSP| StreamsDir
    Branches -->|uses DSP| ShelvesDir
    Clouds -->|uses DSP| StreamsDir
    Elements -->|uses DSP| RipplesDir
    Frames -->|uses DSP| ShelvesDir
    Kinks -->|uses DSP| RipplesDir
    Links -->|uses DSP| StreamsDir
    Marbles -->|uses DSP| StreamsDir
    Peaks -->|uses DSP| ShelvesDir
    Plaits -->|uses DSP| StreamsDir
    Rings -->|uses DSP| ShelvesDir
    Shades -->|uses DSP| RipplesDir
    Stages -->|uses DSP| StreamsDir
    StreamsMod -->|uses DSP| StreamsDir
    Tides -->|uses DSP| StreamsDir
    Tides2 -->|uses DSP| StreamsDir
    Veils -->|uses DSP| RipplesDir
    Warps -->|uses DSP| StreamsDir

    Blinds -->|loads UI| DesignDir
    Braids -->|loads UI| DesignDir
    Clouds -->|loads UI| DesignDir
    Elements -->|loads UI| DesignDir
    Frames -->|loads UI| DesignDir
    Kinks -->|loads UI| DesignDir
    Links -->|loads UI| DesignDir
    Peaks -->|loads UI| DesignDir
    Rings -->|loads UI| DesignDir
    Shades -->|loads UI| DesignDir
    Tides -->|loads UI| DesignDir
    Veils -->|loads UI| DesignDir
    Warps -->|loads UI| DesignDir

    Makefile -->|builds| Lib
    Makefile -->|packages assets| JSON
    Makefile -->|packages assets| ResDir

    %% Click Events
    click JSON "https://github.com/hemmer/audibleinstruments/blob/v2/plugin.json"
    click Makefile "https://github.com/hemmer/audibleinstruments/tree/v2/Makefile"
    click PluginCPP "https://github.com/hemmer/audibleinstruments/blob/v2/src/plugin.cpp"
    click PluginH "https://github.com/hemmer/audibleinstruments/blob/v2/src/plugin.hpp"
    click Blinds "https://github.com/hemmer/audibleinstruments/blob/v2/src/Blinds.cpp"
    click Braids "https://github.com/hemmer/audibleinstruments/blob/v2/src/Braids.cpp"
    click Branches "https://github.com/hemmer/audibleinstruments/blob/v2/src/Branches.cpp"
    click Clouds "https://github.com/hemmer/audibleinstruments/blob/v2/src/Clouds.cpp"
    click Elements "https://github.com/hemmer/audibleinstruments/blob/v2/src/Elements.cpp"
    click Frames "https://github.com/hemmer/audibleinstruments/blob/v2/src/Frames.cpp"
    click Kinks "https://github.com/hemmer/audibleinstruments/blob/v2/src/Kinks.cpp"
    click Links "https://github.com/hemmer/audibleinstruments/blob/v2/src/Links.cpp"
    click Marbles "https://github.com/hemmer/audibleinstruments/blob/v2/src/Marbles.cpp"
    click Peaks "https://github.com/hemmer/audibleinstruments/blob/v2/src/Peaks.cpp"
    click Plaits "https://github.com/hemmer/audibleinstruments/blob/v2/src/Plaits.cpp"
    click Rings "https://github.com/hemmer/audibleinstruments/blob/v2/src/Rings.cpp"
    click Shades "https://github.com/hemmer/audibleinstruments/blob/v2/src/Shades.cpp"
    click Stages "https://github.com/hemmer/audibleinstruments/blob/v2/src/Stages.cpp"
    click StreamsMod "https://github.com/hemmer/audibleinstruments/blob/v2/src/Streams.cpp"
    click Tides "https://github.com/hemmer/audibleinstruments/blob/v2/src/Tides.cpp"
    click Tides2 "https://github.com/hemmer/audibleinstruments/blob/v2/src/Tides2.cpp"
    click Veils "https://github.com/hemmer/audibleinstruments/blob/v2/src/Veils.cpp"
    click Warps "https://github.com/hemmer/audibleinstruments/blob/v2/src/Warps.cpp"
    click RipplesDir "https://github.com/hemmer/audibleinstruments/tree/v2/src/Ripples"
    click ShelvesDir "https://github.com/hemmer/audibleinstruments/tree/v2/src/Shelves"
    click StreamsDir "https://github.com/hemmer/audibleinstruments/tree/v2/src/Streams"
    click DesignDir "https://github.com/hemmer/audibleinstruments/tree/v2/design"
    click ResDir "https://github.com/hemmer/audibleinstruments/blob/v2/res/hdad-segment14-1.002"

    %% Styles
    classDef host fill:#d0e7ff,stroke:#0366d6,color:#0366d6;
    classDef core fill:#d6f5d6,stroke:#28a745,color:#22863a;
    classDef module fill:#fff5b1,stroke:#dcae00,color:#98620f;
    classDef dsp fill:#ffe8d6,stroke:#e36209,color:#e36209;
    classDef ui fill:#f3e1ff,stroke:#6f42c1,color:#6f42c1;
    classDef build fill:#e1e4e8,stroke:#586069,color:#586069;
```
