# aitum/obs-vertical-canvas architecture

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

- Interactive diagram: https://gitdiagram.com/aitum/obs-vertical-canvas
- Repository: https://github.com/aitum/obs-vertical-canvas

## Overview

##### Main Components

a. Core Plugin Components:
- Vertical Canvas Source
- Multi Canvas Source
- Audio Wrapper Source
- Configuration System
- UI Components (Qt-based)

b. Integration Points:
- OBS Studio Core
- Qt Framework Integration
- Websocket API Integration

**┌─ OBS Studio Integration Layer ─────────────────────┐**

- ┌─ Plugin Core ──────────────────────────┐       │

- ┌─ Sources ─────┐  ┌─ UI Layer ────┐ │       │

- Vertical    │  │ - Config     │ │       │
- Canvas      │──│   Dialog     │ │       │
- Multi       │  │ - Name       │ │       │
- Canvas      │  │   Dialog     │ │       │
- Audio       │  │ - Scenes     │ │       │
- Wrapper     │  │   Dock       │ │       │
- ┘  └──────────────┘ │       │

- ┘       │

- ┘

##### Important Elements to Highlight

a. Source Components:
- Relationship between vertical-canvas.cpp, multi-canvas-source.c, and audio-wrapper-source.c
- Their interaction with OBS Studio's source system

b. UI Components:
- Connection between Qt-based UI components (config-dialog, name-dialog, scenes-dock)
- How they integrate with the core functionality

c. Configuration Flow:
- How configuration data flows from UI to core components
- Persistence mechanism

##### Relationships

- Plugin-to-OBS Studio communication channels

##### Implementation Details

- The plugin's role as a frontend plugin for OBS Studio
- Qt framework integration for UI components
- Multi-platform support structure
- Resource and configuration management

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph OBS["OBS Studio Integration Layer"]
        OBSCore["OBS Core"]
        WebSocket["WebSocket API"]:::websocket
        click WebSocket "https://github.com/Aitum/obs-vertical-canvas/tree/main/obs-websocket-api"
        
        subgraph PluginCore["Plugin Core"]
            subgraph Sources["Source Components"]
                VertCanvas["Vertical Canvas Source"]:::source
                MultiCanvas["Multi Canvas Source"]:::source
                AudioWrapper["Audio Wrapper Source"]:::source
                click VertCanvas "https://github.com/Aitum/obs-vertical-canvas/blob/main/vertical-canvas.cpp"
                click MultiCanvas "https://github.com/Aitum/obs-vertical-canvas/blob/main/multi-canvas-source.c"
                click AudioWrapper "https://github.com/Aitum/obs-vertical-canvas/blob/main/audio-wrapper-source.c"
            end

            subgraph UI["UI Components"]
                ConfigDialog["Configuration Dialog"]:::ui
                NameDialog["Name Dialog"]:::ui
                ScenesDock["Scenes Dock"]:::ui
                QtDisplay["Qt Display Integration"]:::ui
                Projector["Projector"]:::ui
                click ConfigDialog "https://github.com/Aitum/obs-vertical-canvas/blob/main/config-dialog.cpp"
                click NameDialog "https://github.com/Aitum/obs-vertical-canvas/blob/main/name-dialog.cpp"
                click ScenesDock "https://github.com/Aitum/obs-vertical-canvas/blob/main/scenes-dock.cpp"
                click QtDisplay "https://github.com/Aitum/obs-vertical-canvas/blob/main/qt-display.cpp"
                click Projector "https://github.com/Aitum/obs-vertical-canvas/blob/main/projector.cpp"
            end

            subgraph Resources["Resource Management"]
                Locale["Internationalization"]:::resource
                Images["Image Resources"]:::resource
                click Locale "https://github.com/Aitum/obs-vertical-canvas/tree/main/data/locale"
                click Images "https://github.com/Aitum/obs-vertical-canvas/tree/main/data/images"
            end

            SourceTree["Source Tree Manager"]:::core
            DisplayHelpers["Display Helpers"]:::core
            click SourceTree "https://github.com/Aitum/obs-vertical-canvas/blob/main/source-tree.cpp"
            click DisplayHelpers "https://github.com/Aitum/obs-vertical-canvas/blob/main/display-helpers.hpp"
        end

        subgraph Platform["Platform-Specific Configs"]
            Windows["Windows Build"]:::platform
            MacOS["macOS Build"]:::platform
            Linux["Linux Build"]:::platform
            click Windows "https://github.com/Aitum/obs-vertical-canvas/tree/main/cmake/windows"
            click MacOS "https://github.com/Aitum/obs-vertical-canvas/tree/main/cmake/macos"
            click Linux "https://github.com/Aitum/obs-vertical-canvas/tree/main/cmake/linux"
        end
    end

    %% Relationships
    OBSCore --> PluginCore
    WebSocket --> PluginCore
    
    VertCanvas --> QtDisplay
    MultiCanvas --> QtDisplay
    AudioWrapper --> QtDisplay
    
    SourceTree --> Sources
    DisplayHelpers --> Sources
    
    ConfigDialog --> Sources
    NameDialog --> Sources
    ScenesDock --> Sources
    
    UI --> Resources
    Sources --> Resources
    
    Platform --> PluginCore

    %% Styles
    classDef source fill:#90EE90,stroke:#333,stroke-width:2px
    classDef ui fill:#FFB366,stroke:#333,stroke-width:2px
    classDef core fill:#B4D8E7,stroke:#333,stroke-width:2px
    classDef resource fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef platform fill:#F0E68C,stroke:#333,stroke-width:2px
    classDef websocket fill:#87CEEB,stroke:#333,stroke-width:2px

    %% Legend
    subgraph Legend
        S1["Source Component"]:::source
        U1["UI Component"]:::ui
        C1["Core Component"]:::core
        R1["Resource"]:::resource
        P1["Platform Config"]:::platform
        W1["WebSocket"]:::websocket
    end
```
