# nattsu628878/music-visualizer architecture

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

- Interactive diagram: https://gitdiagram.com/nattsu628878/music-visualizer
- Repository: https://github.com/nattsu628878/music-visualizer

## Overview

##### Project type and purpose
- This is a desktop application built with Tauri (Rust-based backend) and SvelteKit/TypeScript (frontend) using Vite as a bundler.
- It provides audio and MIDI visualization (spectrogram, spectrum, waveform, 3D, piano roll, score, multi-view composer).

##### File structure
- Top-level:
- `.github/workflows/build.yml` – CI/CD pipeline for building and packaging
- `src/` – SvelteKit frontend (TypeScript) with `routes/`, `lib/components`, `lib/styles`, `app.html`
- `static/`, config files (`svelte.config.js`, `vite.config.js`, `tsconfig.json`)
- The structure clearly separates:
- Frontend (SvelteKit pages/components)
- Backend (Tauri/Rust native commands)
- Build & config (Vite, Cargo, tauri.conf.json)
- The pattern is a modular full-stack desktop app: Web UI ↔ native backend

##### README
- Confirms stack: Tauri + SvelteKit + TypeScript + Vite

a. Main components
1. User Interface (SvelteKit in a WebView)
2. Tauri Runtime & Bridge
3. Rust Backend (Tauri commands, business logic)
4. External Tools/Services (e.g., FFMPEG for audio processing)
5. Local File System & OS APIs (read/write files, MIDI devices)
6. CI/CD Pipeline (GitHub Actions)
b. Relationships & interactions
- UI issues frontend API calls → Tauri Bridge
- Bridge invokes Rust commands → performs processing (audio/MIDI)
- Rust may shell out to FFMPEG or invoke native libraries
- Results return via Bridge → UI updates visual components
- Build step: Vite bundles frontend assets → Rust build packs assets into executable
- CI job runs `tauri build` → produces installers for supported platforms
c. Architectural patterns & principles
- Separation of concerns: UI vs. native logic
- Command pattern via Tauri’s invoke/async callbacks
- Modular routing in SvelteKit for each visualization view
- Configuration-as-code: `tauri.conf.json`, `vite.config.js`, TypeScript typings
d. Key technologies/frameworks
- Tauri (Rust, `tauri.conf.json`, `build.rs`)
- SvelteKit (pages under `src/routes`)
- Vite (bundler, `vite.config.js`)
- TypeScript, CSS modules
- Cargo/Rust toolchain, FFMPEG (external CLI)
- GitHub Actions for CI

##### Elements
- UI → Bridge → Backend → External tool → Backend → Bridge → UI
- Build flow: Code → Vite → Tauri build → Installer
- UI components (light blue),
- Native components (green),
- External services (orange),
- CI/CD (gray)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% SvelteKit UI
    subgraph "SvelteKit UI (WebView)" 
        direction TB
        UI_Shell["app.html"]:::frontend
        Layout["VisualizerLayout.svelte"]:::frontend
        Styles["common.css"]:::frontend
        Spectrogram["+page.svelte (spectrogram)"]:::frontend
        Spectrum["+page.svelte (spectrum)"]:::frontend
        Visualizer3D["+page.svelte (3D)"]:::frontend
        Waveform["+page.svelte (waveform)"]:::frontend
        PianoRoll["+page.svelte (pianoroll)"]:::frontend
        Score["+page.svelte (score)"]:::frontend
        Composer["+page.svelte (multi-view-composer)"]:::frontend
        UI_Shell --> Layout
        Layout --> Styles
        Layout --> Spectrogram
        Layout --> Spectrum
        Layout --> Visualizer3D
        Layout --> Waveform
        Layout --> PianoRoll
        Layout --> Score
        Layout --> Composer
    end

    %% Tauri Bridge
    subgraph "Tauri Bridge" 
        direction TB
        ConfigBridge["tauri.conf.json"]:::native
        MainRust["main.rs"]:::native
    end

    %% Rust Backend
    subgraph "Rust Backend" 
        direction TB
        Lib["lib.rs"]:::native
        Capabilities["default.json"]:::native
        BuildHelper["build.rs"]:::native
        CargoToml["Cargo.toml"]:::native
        CargoLock["Cargo.lock"]:::native
        ConfigBridge --> MainRust
        MainRust --> Lib
        Lib --> Capabilities
        Lib --> BuildHelper
        Lib --> CargoToml
        Lib --> CargoLock
    end

    %% External Tools
    subgraph "External Tools/Services" 
        direction TB
        FFMPEG["FFMPEG CLI"]:::external
    end

    %% File System & OS APIs
    subgraph "File System & OS APIs" 
        direction TB
        TauriAllow["tauri.conf.json (Allowlist)"]:::native
    end

    %% Data Flows
    UI -->|"invoke commands"| MainRust
    MainRust -->|"calls business logic"| Lib
    Lib -->|"shell out"| FFMPEG
    FFMPEG -->|"returns audio data"| Lib
    Lib -->|"response via IPC"| UI

    UI -->|"read/write files"| TauriAllow
    MainRust -->|"access OS APIs"| TauriAllow

    %% Build & Bundler Configuration
    subgraph "Build & Bundler" 
        direction TB
        ViteConfig["vite.config.js"]:::config
        SvelteConfig["svelte.config.js"]:::config
        TSConfig["tsconfig.json"]:::config
        PackageJSON["package.json"]:::config
        PackageLock["package-lock.json"]:::config
        ViteConfig --> SvelteConfig
        SvelteConfig --> TSConfig
        TSConfig --> PackageJSON
        PackageJSON --> PackageLock
    end

    %% CI/CD Pipeline
    subgraph "CI/CD Pipeline (GitHub Actions)"
        direction TB
        BuildYML["build.yml"]:::ci
    end
    BuildYML -->|"runs tauri build"| Lib
    BuildYML -->|"packages assets"| UI

    %% Click Events
    click UI_Shell "https://github.com/nattsu628878/music-visualizer/blob/main/src/app.html"
    click Layout "https://github.com/nattsu628878/music-visualizer/blob/main/src/lib/components/VisualizerLayout.svelte"
    click Styles "https://github.com/nattsu628878/music-visualizer/blob/main/src/lib/styles/common.css"
    click Spectrogram "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/audio/spectrogram/+page.svelte"
    click Spectrum "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/audio/spectrum/+page.svelte"
    click Visualizer3D "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/audio/visualizer3d/+page.svelte"
    click Waveform "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/audio/waveform/+page.svelte"
    click PianoRoll "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/midi/pianoroll/+page.svelte"
    click Score "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/midi/score/+page.svelte"
    click Composer "https://github.com/nattsu628878/music-visualizer/blob/main/src/routes/multi-view-composer/+page.svelte"
    click ConfigBridge "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/tauri.conf.json"
    click MainRust "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/src/main.rs"
    click Lib "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/src/lib.rs"
    click Capabilities "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/capabilities/default.json"
    click BuildHelper "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/build.rs"
    click CargoToml "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/Cargo.toml"
    click CargoLock "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/Cargo.lock"
    click FFMPEG "https://github.com/nattsu628878/music-visualizer/blob/main/FFMPEG_SETUP.md"
    click TauriAllow "https://github.com/nattsu628878/music-visualizer/blob/main/src-tauri/tauri.conf.json"
    click BuildYML "https://github.com/nattsu628878/music-visualizer/blob/main/.github/workflows/build.yml"
    click ViteConfig "https://github.com/nattsu628878/music-visualizer/blob/main/vite.config.js"
    click SvelteConfig "https://github.com/nattsu628878/music-visualizer/blob/main/svelte.config.js"
    click TSConfig "https://github.com/nattsu628878/music-visualizer/blob/main/tsconfig.json"
    click PackageJSON "https://github.com/nattsu628878/music-visualizer/blob/main/package.json"
    click PackageLock "https://github.com/nattsu628878/music-visualizer/blob/main/package-lock.json"

    %% Styles
    classDef frontend fill:#d0e8ff,stroke:#0366d6,stroke-width:2px
    classDef native fill:#d4edda,stroke:#155724,stroke-width:2px
    classDef external fill:#ffe5b4,stroke:#cc8400,stroke-width:2px
    classDef config fill:#f0f0f0,stroke:#888888,stroke-width:2px
    classDef ci fill:#f2f2f2,stroke:#666666,stroke-width:2px
```
