How frieve-a/effetune works
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