# frieve-a/effetune architecture

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

## Overview

##### Project type and purpose
- Frieve EffeTune is primarily a single‐page Web Audio application with an Electron‐based desktop wrapper. It provides real-time audio processing in the browser or desktop, an extensible plugin system, preset management, offline file processing, and a frequency‐response measurement tool (with a small Python server).

##### File structure
- Top-level directories:
- electron/ – Electron “main” and preload code, IPC handlers, window‐state, file‐utils
- js/ – Core frontend JS (app logic, audio pipeline, plugin/preset managers, UI manager)
- features/measurement/ – Measurement-tool UI, AudioWorklet processors, a Python server (server.py)
- plugins/ – Categorized audio-effect modules loaded dynamically at runtime
- presets/ – Static preset files plus a TXT index; saved/loaded in UI
- scripts/, build/, dev/ – Build and packaging scripts for web and desktop
- Key configuration/build files: package.json, manifest.json, scripts/build.py, .github/workflows/build.yml

##### README for additional insights
- Technology stack: Web Audio API, Audio Worklet, getUserMedia, AudioContext in JS; Electron main/renderer plus IPC; Python server for measurement; JSON5 for locales; drag-and-drop HTML UI.
- Extensibility: plugin‐base.js loads plugins/*.js; UI allows drag-drop to assemble pipeline; presets stored as effetune_preset files; shareable via URL or file.

a. User Interfaces
- Browser UI (effetune.html + CSS + js/ui)
- Electron UI (renderer process via preload.js → window)
b. Audio Engine
- AudioContext Manager (js/audio/audio-context-manager.js)
- AudioWorkletProcessors (pipeline processors, features/measurement/audioWorkletProcessors.js)
- Offline Processor (js/audio/offline-processor.js)
c. Plugin Subsystem
- Plugin Base (plugins/plugin-base.js)
- Effect Modules (plugins/{analyzer,basics,delay,…}/*.js)
- Plugin Manager (js/plugin-manager.js)
d. Pipeline Manager
- Pipeline Core (js/ui/pipeline/pipeline-core.js)
- Clipboard, History, Section & AB pipeline managers
e. Preset & State Management
- Preset Manager (js/preset-manager.js + presets/*.effetune_preset)
- State Manager (js/ui/state-manager.js)
f. Measurement Subsystem
- Measurement UI & Controller (features/measurement/ui & measurement-controller)
- Signal generation & analysis (features/measurement/audio-utils + peq-calculator)
- Python server (server.py) for data storage/serving
g. Electron Host
- Main process (electron/main.js)
- IPC handlers (electron/ipc-handlers.js)
- File I/O (electron/file-utils.js)
- Window state & menu integration
h. External Dependencies & Services
- OS Audio Input/Output (virtual devices, getUserMedia)
- File system for presets, settings
- GitHub Actions for builds

##### Relationships and data flows
- Input audio (physical or virtual device) → Web Audio API → AudioContext → Plugin chain → AudioContext output → speakers/amp
- User actions (drag, config, preset load/save) in UI → Pipeline Manager → Audio Engine & Plugin Manager
- Preset save/load → File system (web: URL or localStorage; desktop: local file via Electron IPC)
- Measurement UI ↔ Python server via HTTP/WebSocket (measurement data exchange)
- Electron main ↔ renderer via IPC for file dialogs, audio device config, preset export/import

##### Architectural patterns & design principles
- Modular plugin architecture: each effect isolated in its own directory, loaded dynamically
- MVC-style separation: UI managers (views/controllers) vs. audio managers (model)
- Single AudioContext, multiple AudioWorklet nodes for low-latency processing
- AB pipelines: two isolated pipeline states toggleable at runtime
- Build‐time asset bundling and Electron packaging via Node.js scripts

## Diagram (Mermaid)

```mermaid
graph TB

  subgraph "Layer 1 - User & Devices"
    Device["Input Device / getUserMedia"]:::external
    Output["Output Device / speakers"]:::external
  end

  subgraph "Layer 2 - UI & Controllers"
    BrowserHTML["effetune.html"]:::ui
    BrowserCSS["effetune.css"]:::ui
    UIManager["UI Manager (js/ui-manager.js)"]:::ui
    PipelineMgrUI["UI Pipeline Manager (js/ui/pipeline-manager.js)"]:::ui
    BrowserHTML --> UIManager
    BrowserCSS --> UIManager
    UIManager --> PipelineMgrUI
    Preload["preload.js"]:::ui
    ElectIntegration["Electron Integration (js/electron-integration.js)"]:::ui
    Preload --> PipelineMgrUI
    ElectIntegration --> PipelineMgrUI
  end

  subgraph "Electron Host"
    Main["Main Process"]:::ui
    IPC["IPC Handlers"]:::ui
    FileUtils["File Utils"]:::ui
    WindowState["Window State"]:::ui
    ElectIntegration --> Main
    Main --> IPC
    IPC --> FileUtils
    FileUtils --> WindowState
  end

  subgraph "Layer 3 - Core Engine"
    AudioContext["AudioContext Manager"]:::engine
    Worklet["AudioWorklet Processors"]:::engine
    OfflineProc["Offline Processor"]:::engine
    PipelineMgrUI -->|configure| AudioContext
    AudioContext -->|"create nodes"| Worklet
    AudioContext -->|"start offline"| OfflineProc
  end

  subgraph "Layer 4 - Plugins & Pipeline"
    PluginMgr["Plugin Manager"]:::plugin
    PluginBase["Plugin Base"]:::plugin
    PluginModules["Effect Modules"]:::plugin
    PipelineCore["Pipeline Core"]:::plugin
    Clipboard["Clipboard Manager"]:::plugin
    History["History Manager"]:::plugin
    Section["Section Handler"]:::plugin
    Selection["Selection Manager"]:::plugin
    WorkletSync["Pipeline-Worklet Sync"]:::plugin

    AudioContext -->|load plugins| PluginMgr
    PluginMgr --> PluginBase
    PluginBase --> PluginModules
    PipelineCore --> Clipboard
    PipelineCore --> History
    PipelineCore --> Section
    PipelineCore --> Selection
    PipelineCore --> WorkletSync
    PipelineMgrUI --> PipelineCore
    PipelineCore -->|control| PluginMgr
  end

  subgraph "Layer 5 - Persistence & Measurement"
    PresetMgr["Preset Manager"]:::storage
    StateMgr["State Manager"]:::storage
    FileSystem["File System"]:::external
    MeasurementUI["Measurement UI"]:::storage
    MeasurementCtrl["Measurement Controller"]:::storage
    PythonServer["Python Server"]:::external

    BrowserHTML -->|load/save preset| PresetMgr
    ElectIntegration -->|load/save preset| PresetMgr
    PresetMgr --> FileSystem
    StateMgr --> FileSystem

    MeasurementUI --> MeasurementCtrl
    MeasurementCtrl -->|HTTP/WebSocket| PythonServer
    PythonServer --> MeasurementCtrl
    MeasurementCtrl --> PipelineCore
    Worklet --> MeasurementUI
  end

  %% Click Events
  click BrowserHTML "https://github.com/frieve-a/effetune/blob/main/effetune.html"
  click BrowserCSS "https://github.com/frieve-a/effetune/blob/main/effetune.css"
  click UIManager "https://github.com/frieve-a/effetune/blob/main/js/ui-manager.js"
  click PipelineMgrUI "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline-manager.js"
  click Preload "https://github.com/frieve-a/effetune/blob/main/electron/preload.js"
  click ElectIntegration "https://github.com/frieve-a/effetune/blob/main/js/electron-integration.js"
  click Main "https://github.com/frieve-a/effetune/blob/main/electron/main.js"
  click IPC "https://github.com/frieve-a/effetune/blob/main/electron/ipc-handlers.js"
  click FileUtils "https://github.com/frieve-a/effetune/blob/main/electron/file-utils.js"
  click WindowState "https://github.com/frieve-a/effetune/blob/main/electron/window-state.js"
  click AudioContext "https://github.com/frieve-a/effetune/blob/main/js/audio/audio-context-manager.js"
  click Worklet "https://github.com/frieve-a/effetune/blob/main/features/measurement/audioWorkletProcessors.js"
  click OfflineProc "https://github.com/frieve-a/effetune/blob/main/js/audio/offline-processor.js"
  click PluginMgr "https://github.com/frieve-a/effetune/blob/main/js/plugin-manager.js"
  click PluginBase "https://github.com/frieve-a/effetune/blob/main/plugins/plugin-base.js"
  click PluginModules "https://github.com/frieve-a/effetune/tree/main/plugins/"
  click Clipboard "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline/clipboard-manager.js"
  click History "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline/history-manager.js"
  click Section "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline/pipeline-section-handler.js"
  click Selection "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline/pipeline-selection-manager.js"
  click WorkletSync "https://github.com/frieve-a/effetune/blob/main/js/ui/pipeline/pipeline-worklet-sync.js"
  click PresetMgr "https://github.com/frieve-a/effetune/blob/main/js/preset-manager.js"
  click StateMgr "https://github.com/frieve-a/effetune/blob/main/js/ui/state-manager.js"
  click MeasurementUI "https://github.com/frieve-a/effetune/blob/main/features/measurement/ui/ui-manager.js"
  click MeasurementCtrl "https://github.com/frieve-a/effetune/blob/main/features/measurement/measurement-controller/index.js"
  click PythonServer "https://github.com/frieve-a/effetune/blob/main/features/measurement/server.py"

  %% Styles
  classDef ui fill:#ADD8E6,stroke:#000,stroke-width:1px;
  classDef engine fill:#90EE90,stroke:#000,stroke-width:1px;
  classDef plugin fill:#FFA500,stroke:#000,stroke-width:1px;
  classDef storage fill:#D3D3D3,stroke:#000,stroke-width:1px;
  classDef external fill:#DDA0DD,stroke:#000,stroke-width:1px;
```
