# mkiol/dsnote architecture

> Architecture diagram of the GitHub repository mkiol/dsnote, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/mkiol/dsnote
- Repository: https://github.com/mkiol/dsnote

## Overview

##### Main Components Identification

The system should be divided into these major components:

a) User Interface Layer
- Desktop QML Interface (desktop/qml/)
- Sailfish OS Interface (sfos/qml/)
- System Tray Integration (src/tray_icon.*)

b) Core Services Layer
- Speech Service (src/speech_service.*)
- Application Server (src/app_server.*)
- DBus Integration (dbus/)

c) Engine Management Layer
- Models Manager (src/models_manager.*)
- Settings Manager (src/settings.*)
- Audio Device Manager (src/audio_device_manager.*)

d) Processing Engines
STT Engines:
- Coqui STT
- Vosk
- Whisper
- Faster Whisper
- April-ASR

TTS Engines:
- eSpeak
- MBROLA
- Piper
- RHVoice
- Coqui TTS
- Mimic3
- WhisperSpeech

Translation Engine:
- Bergamot Translator

e) Audio Processing Layer
- VAD (Voice Activity Detection)
- Denoising
- Audio Format Conversion

f) Storage Layer
- Model Storage
- Configuration Storage
- Cache Management

##### Relationships and Data Flow

a) User Interface → Core Services
- Command flow
- Status updates
- Configuration changes

b) Core Services → Engine Management
- Engine initialization
- Model loading/unloading
- Resource management

c) Engine Management → Processing Engines
- Task distribution
- Result collection
- Resource allocation

d) Audio Processing Layer interactions
- Input preprocessing
- Output post-processing
- Format conversions

##### Additional Elements

Supporting components:

a) System Integration
- DBus communication
- System tray integration
- File system access

b) External Dependencies
- GPU acceleration support
- Audio hardware integration
- System notifications

##### Important Notes

- Modular nature of the engine system
- Clear separation between offline and online components
- GPU acceleration paths
- Platform-specific components (Desktop vs Sailfish OS)
- Model download/update mechanisms

## Diagram (Mermaid)

```mermaid
graph TB
    %% Style Definitions
    classDef ui fill:#3498db,stroke:#2980b9,color:white
    classDef core fill:#2ecc71,stroke:#27ae60,color:white
    classDef engine fill:#e67e22,stroke:#d35400,color:white
    classDef audio fill:#9b59b6,stroke:#8e44ad,color:white
    classDef storage fill:#95a5a6,stroke:#7f8c8d,color:white
    classDef manager fill:#1abc9c,stroke:#16a085,color:white

    %% User Interface Layer
    subgraph UI
        Desktop["Desktop QML Interface"]
        SFOS["Sailfish OS Interface"]
        Tray["System Tray"]
    end

    %% Core Services Layer
    subgraph Core
        Speech["Speech Service"]
        AppServer["Application Server"]
        DBus["DBus Integration"]
    end

    %% Engine Management Layer
    subgraph Management
        ModelsManager["Models Manager"]
        Settings["Settings Manager"]
        AudioManager["Audio Device Manager"]
    end

    %% Processing Engines Layer
    subgraph STT_Engines
        Coqui["Coqui STT"]
        Vosk["Vosk"]
        Whisper["Whisper"]
        FasterWhisper["Faster Whisper"]
        AprilASR["April-ASR"]
    end

    subgraph TTS_Engines
        eSpeak["eSpeak"]
        Piper["Piper"]
        RHVoice["RHVoice"]
        Mimic3["Mimic3"]
        WhisperSpeech["WhisperSpeech"]
    end

    subgraph Translation
        Bergamot["Bergamot Translator"]
    end

    %% Audio Processing Layer
    subgraph AudioProcessing
        VAD["Voice Activity Detection"]
        Denoising["Denoising"]
        FormatConversion["Format Conversion"]
    end

    %% Storage Layer
    subgraph Storage
        ModelStorage[("Model Storage")]
        ConfigStorage[("Configuration Storage")]
        Cache[("Cache")]
    end

    %% Relationships
    Desktop & SFOS & Tray --> Speech
    Speech --> AppServer
    AppServer --> DBus
    AppServer --> ModelsManager
    AppServer --> Settings
    AppServer --> AudioManager

    ModelsManager --> STT_Engines
    ModelsManager --> TTS_Engines
    ModelsManager --> Translation
    
    AudioManager --> AudioProcessing
    AudioProcessing --> STT_Engines
    TTS_Engines --> AudioProcessing
    
    ModelsManager --> ModelStorage
    Settings --> ConfigStorage
    AppServer --> Cache

    %% Click Events
    click Desktop "https://github.com/mkiol/dsnote/tree/main/desktop/qml/"
    click SFOS "https://github.com/mkiol/dsnote/tree/main/sfos/qml/"
    click Tray "https://github.com/mkiol/dsnote/blob/main/src/tray_icon.hpp"
    click Speech "https://github.com/mkiol/dsnote/blob/main/src/speech_service.h"
    click AppServer "https://github.com/mkiol/dsnote/blob/main/src/app_server.hpp"
    click DBus "https://github.com/mkiol/dsnote/tree/main/dbus/"
    click ModelsManager "https://github.com/mkiol/dsnote/blob/main/src/models_manager.h"
    click Settings "https://github.com/mkiol/dsnote/blob/main/src/settings.h"
    click AudioManager "https://github.com/mkiol/dsnote/blob/main/src/audio_device_manager.hpp"
    click AprilASR "https://github.com/mkiol/dsnote/blob/main/src/april_engine.hpp"
    click Coqui "https://github.com/mkiol/dsnote/blob/main/src/coqui_engine.hpp"
    click Vosk "https://github.com/mkiol/dsnote/blob/main/src/vosk_engine.hpp"
    click Whisper "https://github.com/mkiol/dsnote/blob/main/src/whisper_engine.hpp"
    click FasterWhisper "https://github.com/mkiol/dsnote/blob/main/src/fasterwhisper_engine.hpp"
    click eSpeak "https://github.com/mkiol/dsnote/blob/main/src/espeak_engine.hpp"
    click Piper "https://github.com/mkiol/dsnote/blob/main/src/piper_engine.hpp"
    click RHVoice "https://github.com/mkiol/dsnote/blob/main/src/rhvoice_engine.hpp"
    click Mimic3 "https://github.com/mkiol/dsnote/blob/main/src/mimic3_engine.hpp"
    click WhisperSpeech "https://github.com/mkiol/dsnote/blob/main/src/whisperspeech_engine.hpp"
    click VAD "https://github.com/mkiol/dsnote/blob/main/src/vad.hpp"
    click Denoising "https://github.com/mkiol/dsnote/blob/main/src/denoiser.hpp"
    click ModelStorage "https://github.com/mkiol/dsnote/blob/main/config/models.json"

    %% Style Applications
    class Desktop,SFOS,Tray ui
    class Speech,AppServer,DBus core
    class ModelsManager,Settings,AudioManager manager
    class Coqui,Vosk,Whisper,FasterWhisper,AprilASR,eSpeak,Piper,RHVoice,Mimic3,WhisperSpeech,Bergamot engine
    class VAD,Denoising,FormatConversion audio
    class ModelStorage,ConfigStorage,Cache storage
```
