# distrho/cardinal architecture

> Architecture diagram of the GitHub repository distrho/cardinal, 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/distrho/cardinal
- Repository: https://github.com/distrho/cardinal

## Overview

##### Main Components

a) Core Plugin Architecture:
- Host Interface Layer (AU/CLAP/LV2/VST2/VST3 support)
- Cardinal Plugin Core (handling audio, MIDI, and CV processing)
- Remote UI System (for DSP/UI separation in Mini variant)
- Module System (handling the virtual modular environment)

b) Module Categories:
- Cardinal Internal Modules (DAW automation, hosting, etc.)
- Third-party Modules (organized by vendor/category)
- Core Replacement Modules (Cardinal equivalents of Rack Core)

c) Audio Processing:
- Audio I/O Management
- MIDI Processing
- CV Processing
- DSP Engine

##### Relationships

- Data flow between host DAW and plugin
- Signal routing between modules
- UI interaction with the module system
- Communication between DSP and UI components
- Plugin variant differences (Main/Synth/FX/Mini)

##### Design Elements

Use the following visual elements:
- Rectangles: Major system components
- Rounded rectangles: Plugin variants
- Diamonds: Decision points for signal routing
- Host integration (blue)
- Audio processing (green)
- UI components (orange)
- Module system (purple)

##### Specific Implementation Details

a) Plugin Host Integration:
**[Host DAW] <-> [Plugin Format Layer (AU/VST/LV2/CLAP)] <-> [Cardinal Core]**

b) Core Architecture:
**[Cardinal Core]**

- [Audio Engine]
- [DSP Processing]
- [Module System]

- [UI System]
- [Module Browser]
- [Patch Management]
- [Parameter Control]

c) Module System:
**[Module System]**

- [Internal Modules]
- [DAW Automation]
- [Host Integration]

- [Third-party Modules]
- [Categories...]

##### Additional Details

Annotations for:
- Thread management
- Resource handling
- Platform-specific implementations
- Plugin variant differences
- Module compatibility

## Diagram (Mermaid)

```mermaid
flowchart TB
    subgraph Host
        DAW[DAW Host]
    end

    subgraph "Plugin Interface"
        HostLayer["Host Interface Layer"]:::host
        click HostLayer "https://github.com/DISTRHO/Cardinal/blob/main/src/Cardinal/CardinalPlugin.cpp"
    end

    subgraph "Cardinal Core"
        Core["Plugin Core"]:::core
        click Core "https://github.com/DISTRHO/Cardinal/blob/main/src/CardinalCommon.hpp"
        Context["Plugin Context"]:::core
        click Context "https://github.com/DISTRHO/Cardinal/blob/main/src/CardinalPluginContext.hpp"
    end

    subgraph "Plugin Variants"
        Main["Cardinal Main"]:::variant
        click Main "https://github.com/DISTRHO/Cardinal/tree/main/src/Cardinal/"
        FX["Cardinal FX"]:::variant
        click FX "https://github.com/DISTRHO/Cardinal/tree/main/src/CardinalFX/"
        Synth["Cardinal Synth"]:::variant
        click Synth "https://github.com/DISTRHO/Cardinal/tree/main/src/CardinalSynth/"
        Mini["Cardinal Mini"]:::variant
        click Mini "https://github.com/DISTRHO/Cardinal/tree/main/src/CardinalMini/"
    end

    subgraph "Audio Processing"
        DSP["DSP Engine"]:::audio
        click DSP "https://github.com/DISTRHO/Cardinal/tree/main/src/Rack/"
        AudioIO["Audio I/O"]:::audio
        click AudioIO "https://github.com/DISTRHO/Cardinal/blob/main/plugins/Cardinal/src/HostAudio.cpp"
        MIDI["MIDI Processing"]:::audio
        click MIDI "https://github.com/DISTRHO/Cardinal/blob/main/plugins/Cardinal/src/HostMIDI.cpp"
        CV["CV Processing"]:::audio
        click CV "https://github.com/DISTRHO/Cardinal/blob/main/plugins/Cardinal/src/HostCV.cpp"
    end

    subgraph "UI System"
        Window["Window Management"]:::ui
        click Window "https://github.com/DISTRHO/Cardinal/blob/main/src/Cardinal/Window.cpp"
        Menu["Menu System"]:::ui
        click Menu "https://github.com/DISTRHO/Cardinal/blob/main/src/Cardinal/MenuBar.cpp"
        RemoteUI["Remote UI System"]:::ui
        click RemoteUI "https://github.com/DISTRHO/Cardinal/tree/main/src/CardinalRemote/"
    end

    subgraph "Module System"
        ModuleWidget["Module Widget System"]:::module
        click ModuleWidget "https://github.com/DISTRHO/Cardinal/blob/main/src/CardinalModuleWidget.cpp"
        Internal["Internal Modules"]:::module
        click Internal "https://github.com/DISTRHO/Cardinal/tree/main/plugins/Cardinal/src/"
        ThirdParty["Third-party Modules"]:::module
        click ThirdParty "https://github.com/DISTRHO/Cardinal/tree/main/plugins/"
    end

    DAW <--> HostLayer
    HostLayer <--> Core
    Core <--> Context
    
    Core --> Main & FX & Synth & Mini
    
    Core <--> DSP
    DSP <--> AudioIO & MIDI & CV
    
    Core <--> Window
    Window <--> Menu
    Mini <--> RemoteUI
    
    Core <--> ModuleWidget
    ModuleWidget <--> Internal & ThirdParty

    classDef host fill:#a0c4ff,stroke:#4a90e2
    classDef core fill:#ffd700,stroke:#ffa500
    classDef variant fill:#98fb98,stroke:#228b22
    classDef audio fill:#ff9999,stroke:#ff0000
    classDef ui fill:#dda0dd,stroke:#9370db
    classDef module fill:#f0e68c,stroke:#bdb76b

    %% Legend
    subgraph Legend
        H1[Host Integration]:::host
        C1[Core Components]:::core
        V1[Plugin Variants]:::variant
        A1[Audio Processing]:::audio
        U1[UI Components]:::ui
        M1[Module System]:::module
    end
```
