# wwmm/easyeffects architecture

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

- Interactive diagram: https://gitdiagram.com/wwmm/easyeffects
- Repository: https://github.com/wwmm/easyeffects

## Overview

##### Project type and purpose
- Easy Effects is an open-source, native desktop application (not a web or cloud service).
- It provides an audio-effects pipeline for PipeWire applications, letting the user insert, order, and configure effects (equalizer, compressor, reverb, etc.) between hardware and consumer apps.
- It uses a Qt/QML/Kirigami front end, a C++ backend “server” that manages audio graphs, and communicates with PipeWire and external plugin libraries (LADSPA, LV2, RNNoise, etc.).

##### File structure
- Top-level “src” holds the core code:
- src/main.cpp – entry point.
- src/local_client / src/local_server – IPC client/server pair.
- src/pw_* and src/pw_manager – classes that manage PipeWire core, nodes, streams, modules.
- src/stream_input_effects, stream_output_effects – audio‐processing pipelines.
- src/plugin_*, src/*_wrapper – abstraction layers around LADSPA, LV2, GStreamer-free filters.
- src/*_preset, src/presets_* – presets managers and models.
- src/db_manager – persistent storage of settings/presets.
- src/help_manager – ships built-in HTML help.
- src/contents/ui – QML files defining the UI.
- “po” holds translations.
- “util” includes build scripts, packaging helpers, Flatpak manifests, conversion scripts.

##### README for additional insights
- Confirms Qt/QML + KDE/Kirigami UI, native PipeWire filters, and multiple plugin dependencies.
- Describes features: full effect chain control, presets (local, community, autoload), and translation support.
- Mentions Flatpak packaging, CI workflows, packaging guidelines.

##### Detail without overthinking
- Break the engine into subcomponents (pw_manager, plugin layer, stream pipelines, presets).
- Every major data or control flow (UI→IPC→PipeWire→hardware).
- Essential players: UI, IPC, engine, PipeWire, plugins, presets DB, static assets.
- Keep it readable by using consistent layout: UI on left, engine in middle, external systems on right.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% UI Layer
    subgraph "UI Layer"
        UI["QML/Kirigami Front End"]:::ui
    end

    %% IPC Layer
    subgraph "IPC Layer"
        Client["IPC Client\n(local_client)"]:::core
        Server["IPC Server\n(local_server)"]:::core
    end

    %% Audio Engine Core
    subgraph "Audio Engine"
        subgraph "PipeWire Managers"
            PM["PW Manager"]:::core
            PCM["Client Manager"]:::core
            PLM["Link Manager"]:::core
            PMeta["Metadata Manager"]:::core
            PMod["Module Manager"]:::core
            PN["Node Manager"]:::core
        end
        subgraph "PW Models"
            PMC["Model Clients"]:::core
            PMO["Model Modules"]:::core
            PMN["Model Nodes"]:::core
        end
        subgraph "Stream Pipelines"
            SIP["Stream Input Effects"]:::core
            SOP["Stream Output Effects"]:::core
        end
        subgraph "Plugin Abstraction"
            PB["Plugin Base"]:::core
            LAD["LADSPA Wrapper"]:::core
            LV2["LV2 Wrapper & UI"]:::core
        end
        EB["Effects Base"]:::core
        subgraph "Presets Subsystem"
            PMgr["Presets Manager"]:::core
            PLMdl["Presets List Model"]:::core
            PAu["Autoload Manager"]:::core
            PCm["Community Presets Manager"]:::core
            PDm["Directory Presets Manager"]:::core
            PRn["RNNoise Presets Manager"]:::core
            PIr["IRS Presets Manager"]:::core
        end
        DB["DB Manager"]:::core
        Help["Help Manager"]:::core
    end

    %% External Systems
    subgraph "External Systems"
        PW["PipeWire Core"]:::external
        ExtLib["Plugin Libraries\n(LADSPA/LV2/etc)"]:::external
    end

    %% Data Stores & Assets
    subgraph "Static Assets & Data"
        PresetsData["Default Presets\n(data/presets/)"]:::data
        Icons["Icons\n(data/icons/)"]:::data
        Trans["Translations\n(po/)"]:::data
        HelpFiles["Help HTML/CSS\n(src/contents/help/)"]:::data
    end

    %% Entry Point
    Entry["main.cpp"]:::core

    %% Data Flows & Control
    User[/"User"/] --> UI
    UI -->|"Qt Signals/Slots"| Client
    Client -->|"IPC Messages"| Server
    Server -->|API Calls| PM
    Server -->|API Calls| PCM
    Server -->|API Calls| PLM
    Server -->|API Calls| PMeta
    Server -->|API Calls| PMod
    Server -->|API Calls| PN
    PM --> PW
    Server -->|Instantiate Models| PMC
    Server -->|Instantiate Models| PMO
    Server -->|Instantiate Models| PMN
    Server --> SIP
    Server --> SOP
    Server --> PB
    PB --> LAD
    PB --> LV2
    Server --> EB
    Server --> PMgr
    Server --> DB
    Server --> Help
    DB -.->|"Read/Write"| PresetsData
    Help --> HelpFiles
    PB --> ExtLib

    Entry --> UI
    Entry --> Server

    %% Click Events
    click UI "https://github.com/wwmm/easyeffects/tree/master/src/contents/ui/"
    click Client "https://github.com/wwmm/easyeffects/blob/master/src/local_client.cpp"
    click Client "https://github.com/wwmm/easyeffects/blob/master/src/local_client.hpp"
    click Server "https://github.com/wwmm/easyeffects/blob/master/src/local_server.cpp"
    click Server "https://github.com/wwmm/easyeffects/blob/master/src/local_server.hpp"
    click PM "https://github.com/wwmm/easyeffects/blob/master/src/pw_manager.cpp"
    click PM "https://github.com/wwmm/easyeffects/blob/master/src/pw_manager.hpp"
    click PCM "https://github.com/wwmm/easyeffects/blob/master/src/pw_client_manager.cpp"
    click PCM "https://github.com/wwmm/easyeffects/blob/master/src/pw_client_manager.hpp"
    click PLM "https://github.com/wwmm/easyeffects/blob/master/src/pw_link_manager.cpp"
    click PLM "https://github.com/wwmm/easyeffects/blob/master/src/pw_link_manager.hpp"
    click PMeta "https://github.com/wwmm/easyeffects/blob/master/src/pw_metadata_manager.cpp"
    click PMeta "https://github.com/wwmm/easyeffects/blob/master/src/pw_metadata_manager.hpp"
    click PMod "https://github.com/wwmm/easyeffects/blob/master/src/pw_module_manager.cpp"
    click PMod "https://github.com/wwmm/easyeffects/blob/master/src/pw_module_manager.hpp"
    click PN "https://github.com/wwmm/easyeffects/blob/master/src/pw_node_manager.cpp"
    click PN "https://github.com/wwmm/easyeffects/blob/master/src/pw_node_manager.hpp"
    click PMC "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_clients.cpp"
    click PMC "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_clients.hpp"
    click PMO "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_modules.cpp"
    click PMO "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_modules.hpp"
    click PMN "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_nodes.cpp"
    click PMN "https://github.com/wwmm/easyeffects/blob/master/src/pw_model_nodes.hpp"
    click SIP "https://github.com/wwmm/easyeffects/blob/master/src/stream_input_effects.cpp"
    click SIP "https://github.com/wwmm/easyeffects/blob/master/src/stream_input_effects.hpp"
    click SOP "https://github.com/wwmm/easyeffects/blob/master/src/stream_output_effects.cpp"
    click SOP "https://github.com/wwmm/easyeffects/blob/master/src/stream_output_effects.hpp"
    click PB "https://github.com/wwmm/easyeffects/blob/master/src/plugin_base.cpp"
    click PB "https://github.com/wwmm/easyeffects/blob/master/src/plugin_base.hpp"
    click LAD "https://github.com/wwmm/easyeffects/blob/master/src/ladspa_wrapper.cpp"
    click LAD "https://github.com/wwmm/easyeffects/blob/master/src/ladspa_wrapper.hpp"
    click LAD "https://github.com/wwmm/easyeffects/blob/master/src/ladspa_macros.hpp"
    click LV2 "https://github.com/wwmm/easyeffects/blob/master/src/lv2_wrapper.cpp"
    click LV2 "https://github.com/wwmm/easyeffects/blob/master/src/lv2_wrapper.hpp"
    click LV2 "https://github.com/wwmm/easyeffects/blob/master/src/lv2_ui.cpp"
    click LV2 "https://github.com/wwmm/easyeffects/blob/master/src/lv2_ui.hpp"
    click LV2 "https://github.com/wwmm/easyeffects/blob/master/src/lv2_macros.hpp"
    click EB "https://github.com/wwmm/easyeffects/blob/master/src/effects_base.cpp"
    click EB "https://github.com/wwmm/easyeffects/blob/master/src/effects_base.hpp"
    click PMgr "https://github.com/wwmm/easyeffects/blob/master/src/presets_manager.cpp"
    click PMgr "https://github.com/wwmm/easyeffects/blob/master/src/presets_manager.hpp"
    click PLMdl "https://github.com/wwmm/easyeffects/blob/master/src/presets_list_model.cpp"
    click PLMdl "https://github.com/wwmm/easyeffects/blob/master/src/presets_list_model.hpp"
    click PAu "https://github.com/wwmm/easyeffects/blob/master/src/presets_autoload_manager.cpp"
    click PAu "https://github.com/wwmm/easyeffects/blob/master/src/presets_autoload_manager.hpp"
    click PCm "https://github.com/wwmm/easyeffects/blob/master/src/presets_community_manager.cpp"
    click PCm "https://github.com/wwmm/easyeffects/blob/master/src/presets_community_manager.hpp"
    click PDm "https://github.com/wwmm/easyeffects/blob/master/src/presets_directory_manager.cpp"
    click PDm "https://github.com/wwmm/easyeffects/blob/master/src/presets_directory_manager.hpp"
    click PRn "https://github.com/wwmm/easyeffects/blob/master/src/presets_rnnoise_manager.cpp"
    click PRn "https://github.com/wwmm/easyeffects/blob/master/src/presets_rnnoise_manager.hpp"
    click PIr "https://github.com/wwmm/easyeffects/blob/master/src/presets_irs_manager.cpp"
    click PIr "https://github.com/wwmm/easyeffects/blob/master/src/presets_irs_manager.hpp"
    click DB "https://github.com/wwmm/easyeffects/blob/master/src/db_manager.cpp"
    click DB "https://github.com/wwmm/easyeffects/blob/master/src/db_manager.hpp"
    click Help "https://github.com/wwmm/easyeffects/blob/master/src/help_manager.cpp"
    click Help "https://github.com/wwmm/easyeffects/blob/master/src/help_manager.hpp"
    click HelpFiles "https://github.com/wwmm/easyeffects/tree/master/src/contents/help/"
    click PresetsData "https://github.com/wwmm/easyeffects/tree/master/data/presets/"
    click Icons "https://github.com/wwmm/easyeffects/tree/master/data/icons/"
    click Trans "https://github.com/wwmm/easyeffects/tree/master/po/"
    click util "https://github.com/wwmm/easyeffects/tree/master/util/"
    click Entry "https://github.com/wwmm/easyeffects/blob/master/src/main.cpp"

    %% Styles
    classDef ui fill:#d0e1ff,stroke:#333,stroke-width:1px
    classDef core fill:#d0ffd6,stroke:#333,stroke-width:1px
    classDef external fill:#eeeeee,stroke:#333,stroke-width:1px
    classDef data fill:#fff2ae,stroke:#333,stroke-width:1px
```
