# kagemomiji/airsonic-advanced architecture

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

- Interactive diagram: https://gitdiagram.com/kagemomiji/airsonic-advanced
- Repository: https://github.com/kagemomiji/airsonic-advanced

## Overview

##### Main Components Overview
The system should be divided into these primary components:

a. Core Application Layer:
- Spring Boot Application (Application.java)
- Configuration Management
- Security Framework
- Database Layer

b. Service Layer:
- Media Management Services
- Streaming Services
- User Management Services
- Playlist Management
- Podcast Services
- Transcoding Services

c. External Integrations:
- Last.fm Integration
- Sonos Integration
- Chromecast Support
- DLNA/UPnP Support

##### Detailed Component Breakdown

a. Web Interface:
- REST Controllers (SubsonicRESTController)
- WebSocket Controllers
- MVC Controllers
- Static Resources (CSS/JS/Images)

b. Media Processing:
- Scanner Service
- Transcoding Engine
- Cover Art Management
- Metadata Processing

c. Storage:
- File System Integration
- Database (Multiple DB Support)
- Cache Management

##### Data Flow Representation

Following interactions:
- Client requests → Web Layer → Service Layer → Storage Layer
- Media Scanning Flow
- Streaming Pipeline
- Authentication Flow
- WebSocket Communication

- Blue: Core Application Components
- Green: External Services
- Orange: Security Components
- Purple: Media Processing
- Gray: Storage Systems

- Rectangles: Services/Components
- Hexagons: External Systems
- Clouds: Third-party Services

##### Key Architectural Elements to Highlight

a. Modern Features:
- Websocket Communication
- Parallel Processing
- Caching Mechanism
- Security Implementation

b. Integration Points:
- External Authentication
- Media Players Support
- Scrobbling Services
- Streaming Protocols

##### Security Layer

Include:
- Authentication Flow
- Credential Management
- Session Handling
- REST API Security

This design should reflect Airsonic-Advanced's improvements over the original Airsonic, particularly in areas of performance, security, and modern web technologies.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Core Application"
        App["Application"]:::core
        Config["Configuration Management"]:::core
        Security["Security Framework"]:::core
        DB["Database Layer"]:::core
    end

    subgraph "Service Layer"
        MediaSvc["Media Management"]:::service
        StreamSvc["Streaming Service"]:::service
        UserSvc["User Management"]:::service
        PlaylistSvc["Playlist Management"]:::service
        PodcastSvc["Podcast Services"]:::service
        TranscodeSvc["Transcoding Service"]:::service
    end

    subgraph "External Integrations"
        LastFM["Last.fm Service"]:::external
        Sonos["Sonos Service"]:::external
        UPNP["DLNA/UPnP Service"]:::external
        Chromecast["Chromecast"]:::external
    end

    subgraph "Web Interface"
        REST["REST Controllers"]:::web
        WS["WebSocket Controllers"]:::web
        MVC["MVC Controllers"]:::web
        Static["Static Resources"]:::web
    end

    subgraph "Media Processing"
        Scanner["Scanner Service"]:::media
        TranscodeEngine["Transcoding Engine"]:::media
        CoverArt["Cover Art Management"]:::media
        Metadata["Metadata Processing"]:::media
    end

    subgraph "Storage"
        FileSystem["File System"]:::storage
        Database[(Database)]:::storage
        Cache["Cache Management"]:::storage
    end

    %% Core Application Connections
    App --> Config
    App --> Security
    App --> DB

    %% Web Layer Connections
    REST --> MediaSvc
    REST --> StreamSvc
    REST --> UserSvc
    WS --> MediaSvc
    MVC --> MediaSvc

    %% Service Layer Connections
    MediaSvc --> Scanner
    MediaSvc --> FileSystem
    StreamSvc --> TranscodeEngine
    UserSvc --> Database
    PlaylistSvc --> Database
    TranscodeSvc --> TranscodeEngine

    %% External Integration Connections
    LastFM --> MediaSvc
    Sonos --> StreamSvc
    UPNP --> StreamSvc

    %% Media Processing Connections
    Scanner --> Metadata
    Scanner --> CoverArt
    TranscodeEngine --> FileSystem

    %% Storage Layer Connections
    Cache --> Database
    Cache --> FileSystem

    %% Click Events
    click App "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/Application.java"
    click Config "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/config/"
    click Security "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/security/"
    click DB "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/dao/"
    click MediaSvc "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/MediaFileService.java"
    click StreamSvc "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/StreamController.java"
    click UserSvc "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/UserService.java"
    click PlaylistSvc "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/PlaylistService.java"
    click PodcastSvc "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/service/PodcastService/"
    click TranscodeSvc "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/TranscodingService.java"
    click LastFM "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/LastFmService.java"
    click Sonos "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/SonosService.java"
    click UPNP "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/service/UPnPService.java"
    click REST "https://github.com/kagemomiji/airsonic-advanced/blob/main/airsonic-main/src/main/java/org/airsonic/player/controller/SubsonicRESTController.java"
    click WS "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/ajax/"
    click MVC "https://github.com/kagemomiji/airsonic-advanced/tree/main/airsonic-main/src/main/java/org/airsonic/player/controller/"

    %% Styling
    classDef core fill:#2196F3,stroke:#1565C0,color:white
    classDef service fill:#4CAF50,stroke:#2E7D32,color:white
    classDef external fill:#FF9800,stroke:#EF6C00,color:white
    classDef web fill:#9C27B0,stroke:#6A1B9A,color:white
    classDef media fill:#E91E63,stroke:#C2185B,color:white
    classDef storage fill:#607D8B,stroke:#455A64,color:white
```
