# bloodbat/sanguinemutants architecture

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

- Interactive diagram: https://gitdiagram.com/bloodbat/sanguinemutants
- Repository: https://github.com/bloodbat/sanguinemutants

## Overview

##### Core Architecture Layer
- Core DSP utilities and algorithms
- Plugin infrastructure (plugin.cpp/hpp)

##### Module Implementation Layer
- Modules by their primary functions:
a. Oscillators (Funes, Nodi)
b. Modulators (Aestus, Incurvationes)
c. Processors (Nebulae, Anuli)
d. Utilities (Explorator, Velamina)
- Alternative firmware variants as branches from their base modules

##### Common Resources Layer
- Shared components (sanguinecomponents)
- Helper utilities (sanguinehelpers)
- DSP primitives (sanguinedsp)

**[VCV Rack Plugin Interface]**
- ↑
**[Sanguine Plugin Core]**
- ↑
- ______________|______________

**[Module  [Common  [DSP     [Resource**
- Layer]   Utils]  Layer]   Manager]

**[Individual Module Implementations with Variants]**

Specific Implementation Details:

##### Specialized subsystems
- DSP processing chains
- Audio buffer management
- Parameter handling
- Resource management

##### Cross-cutting concerns
- Polyphony handling
- Sample rate conversion
- Parameter interpolation

Key Relationships to Emphasize:

##### Module Inheritance
- How alternative firmwares (like Etesia, Fluctus) extend their base modules
- Shared resources between variants

##### Resource Management
- How modules access shared resources
- Resource initialization and cleanup paths

##### Signal Flow
- Audio and CV signal paths
- Control parameter routing

Implementation Guidelines:

##### Use standardized symbols
- Rectangles for modules
- Diamonds for decision points

- Top: User interface level
- Middle: Module implementation
- Bottom: Core infrastructure

##### Technical details
- Sample rates
- Buffer sizes
- Processing modes
- Polyphony capabilities

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style Definitions
    classDef core fill:#3498db,stroke:#2980b9,color:white
    classDef dsp fill:#2ecc71,stroke:#27ae60,color:white
    classDef module fill:#e67e22,stroke:#d35400,color:white
    classDef variant fill:#9b59b6,stroke:#8e44ad,color:white
    classDef resource fill:#95a5a6,stroke:#7f8c8d,color:white

    %% Core Layer
    VCV["VCV Rack Plugin Interface"]:::core
    Plugin["Plugin Core"]:::core
    click Plugin "https://github.com/Bloodbat/SanguineMutants/blob/main/src/plugin.cpp"

    %% Core Framework
    subgraph CoreFramework
        Stmlib["STMlib Framework"]:::core
        DSPUtils["DSP Utilities"]:::dsp
        Algorithms["Core Algorithms"]:::dsp
    end
    click Stmlib "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/stmlib/"
    click DSPUtils "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/stmlib/dsp/"
    click Algorithms "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/stmlib/algorithms/"

    %% Common Resources
    subgraph Resources
        SanguineComponents["Shared Components"]:::resource
        SanguineHelpers["Helper Utilities"]:::resource
        SanguineDSP["DSP Primitives"]:::resource
    end
    click SanguineComponents "https://github.com/Bloodbat/SanguineMutants/blob/main/src/sanguinecomponents.cpp"
    click SanguineHelpers "https://github.com/Bloodbat/SanguineMutants/blob/main/src/sanguinehelpers.cpp"
    click SanguineDSP "https://github.com/Bloodbat/SanguineMutants/blob/main/src/sanguinedsp.hpp"

    %% Module Layer
    subgraph Modules
        direction TB
        
        subgraph Oscillators
            Funes["Funes"]:::module
            Nodi["Nodi"]:::module
        end
        click Funes "https://github.com/Bloodbat/SanguineMutants/blob/main/src/Funes.cpp"
        click Nodi "https://github.com/Bloodbat/SanguineMutants/blob/main/src/nodi.cpp"

        subgraph Modulators
            Aestus["Aestus"]:::module
            Incurvationes["Incurvationes"]:::module
        end
        click Aestus "https://github.com/Bloodbat/SanguineMutants/blob/main/src/aestus.cpp"
        click Incurvationes "https://github.com/Bloodbat/SanguineMutants/blob/main/src/incurvationes.cpp"

        subgraph Processors
            Nebulae["Nebulae"]:::module
            Anuli["Anuli"]:::module
        end
        click Nebulae "https://github.com/Bloodbat/SanguineMutants/blob/main/src/nebulae.cpp"
        click Anuli "https://github.com/Bloodbat/SanguineMutants/blob/main/src/anuli.cpp"

        subgraph Utilities
            Explorator["Explorator"]:::module
            Velamina["Velamina"]:::module
        end
        click Explorator "https://github.com/Bloodbat/SanguineMutants/blob/main/src/explorator.cpp"
        click Velamina "https://github.com/Bloodbat/SanguineMutants/blob/main/src/velamina.cpp"
    end

    %% Alternative Firmware
    subgraph AltFirmware
        Fluctus["Fluctus"]:::variant
        Mutuus["Mutuus"]:::variant
        Renaissance["Renaissance"]:::variant
        Distortiones["Distortiones"]:::variant
    end
    click Fluctus "https://github.com/Bloodbat/SanguineMutants/tree/main/alt_firmware/fluctus/"
    click Mutuus "https://github.com/Bloodbat/SanguineMutants/tree/main/alt_firmware/mutuus/"
    click Renaissance "https://github.com/Bloodbat/SanguineMutants/tree/main/alt_firmware/renaissance/"
    click Distortiones "https://github.com/Bloodbat/SanguineMutants/tree/main/alt_firmware/distortiones/"

    %% DSP Processing
    subgraph DSPProcessing
        CloudsDSP["Clouds DSP"]:::dsp
        RingsDSP["Rings DSP"]:::dsp
        PlaitsDSP["Plaits DSP"]:::dsp
    end
    click CloudsDSP "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/clouds/dsp/"
    click RingsDSP "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/rings/dsp/"
    click PlaitsDSP "https://github.com/Bloodbat/SanguineMutants/tree/main/eurorack/plaits/dsp/"

    %% Relationships
    VCV --> Plugin
    Plugin --> CoreFramework
    Plugin --> Resources
    Plugin --> Modules
    CoreFramework --> Modules
    Resources --> Modules
    Modules --> AltFirmware
    DSPProcessing --> Modules
    Resources --> DSPProcessing
```
