# bitwig/dawproject architecture

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

- Interactive diagram: https://gitdiagram.com/bitwig/dawproject
- Repository: https://github.com/bitwig/dawproject

## Overview

##### Main Components

a. Core Components:
- Project Container (ZIP)
- XML Processors (for project.xml and metadata.xml)
- Media File Handler
- Plugin State Manager

b. Data Model Components:
- Transport System (tempo, time signature)
- Track Management
- Channel Processing
- Device Management (plugins, built-in devices)
- Timeline Management
- Automation System

**┌─ Application Layer ─────────────────────┐**
- DAW Integration Points                │
- File Import/Export                    │
- ┬──┘
**┌─ Core Services Layer ─────────────────┴──┐**
- XML Processing                         │
- ZIP Container Management               │
- Plugin State Management               │
- ┬──┘
**┌─ Domain Model Layer ──────────────────┴──┐**
- Project Structure                      │
- Timeline Management                    │
- Track/Channel System                   │
- Device Framework                       │
- ┬──┘
**┌─ Storage Layer ────────────────────────┴─┐**
- File References                        │
- Media Management                       │
- XML Schemas                           │
- ┘

##### Key Relationships to Highlight

- Bidirectional relationships between the Project container and its components
- Flow from XML schemas to object models
- Demonstrate plugin integration points
- Timeline relationships with tracks and automation

##### Specific Implementation Details

**Core:**
- DawProject
- Project
- MetaData
- Application

**Timeline:**
- Timeline
- Clip
- Notes
- Points
- Markers

**Devices:**
- Device (abstract)
- BuiltinDevice
- Plugin (VST2/VST3/AU/CLAP)

**Channel:**
- Track
- Channel
- Send

##### Integration Points

Clear interfaces for:
- DAW import/export
- Plugin state serialization
- Media file handling
- Timeline synchronization

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef application fill:#A5D6A7,stroke:#1B5E20
    classDef core fill:#90CAF9,stroke:#0D47A1
    classDef domain fill:#FFB74D,stroke:#E65100
    classDef storage fill:#B39DDB,stroke:#4527A0
    classDef timeline fill:#81C784,stroke:#2E7D32
    classDef device fill:#FF8A65,stroke:#D84315
    classDef channel fill:#4FC3F7,stroke:#01579B
    classDef transport fill:#FFF176,stroke:#F57F17
    classDef media fill:#F48FB1,stroke:#880E4F
    classDef automation fill:#9575CD,stroke:#311B92

    subgraph Application["Application Layer"]
        DawProject["DAW Project Container"]:::application
        AppInterface["Application Interface"]:::application
    end

    subgraph Core["Core Services Layer"]
        XMLProcessor["XML Processing"]:::core
        ZipManager["ZIP Container Management"]:::core
        PluginState["Plugin State Management"]:::core
        MetaData["Metadata Handler"]:::core
    end

    subgraph Domain["Domain Model Layer"]
        Project["Project Management"]:::domain
        
        subgraph TimelineSystem["Timeline System"]
            Timeline["Timeline"]:::timeline
            Clips["Clip Management"]:::timeline
            Notes["Note Management"]:::timeline
            Markers["Marker System"]:::timeline
        end

        subgraph DeviceSystem["Device Framework"]
            Device["Base Device"]:::device
            Plugin["Plugin Management"]:::device
            Vst2["VST2 Plugin"]:::device
            Vst3["VST3 Plugin"]:::device
            Au["AU Plugin"]:::device
            Clap["CLAP Plugin"]:::device
        end

        subgraph ChannelSystem["Channel System"]
            Track["Track Management"]:::channel
            Channel["Channel Processing"]:::channel
            Send["Send Processing"]:::channel
        end

        subgraph TransportSystem["Transport System"]
            Transport["Transport Control"]:::transport
            TimeSignature["Time Signature"]:::transport
        end
    end

    subgraph Storage["Storage Layer"]
        FileRef["File References"]:::storage
        MediaFiles["Media Files"]:::storage
        Audio["Audio Handling"]:::storage
        Video["Video Handling"]:::storage
        XMLSchema["XML Schemas"]:::storage
        
        subgraph AutomationSystem["Automation System"]
            Points["Points Management"]:::automation
            AutoTarget["Automation Target"]:::automation
            RealPoint["Real Point"]:::automation
            BoolPoint["Bool Point"]:::automation
            EnumPoint["Enum Point"]:::automation
        end
    end

    %% Relationships
    DawProject --> Project
    DawProject --> MetaData
    AppInterface --> Project
    Project --> Timeline
    Timeline --> Clips
    Timeline --> Notes
    Timeline --> Markers
    Device --> Plugin
    Plugin --> Vst2
    Plugin --> Vst3
    Plugin --> Au
    Plugin --> Clap
    Track --> Channel
    Channel --> Send
    MediaFiles --> Audio
    MediaFiles --> Video
    Points --> RealPoint
    Points --> BoolPoint
    Points --> EnumPoint

    %% Click Events
    click DawProject "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/DawProject.java"
    click MetaData "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/MetaData.java"
    click AppInterface "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Application.java"
    click Project "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Project.java"
    click Timeline "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Timeline.java"
    click Clips "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Clips.java"
    click Notes "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Notes.java"
    click Markers "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Markers.java"
    click Device "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/Device.java"
    click Plugin "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/Plugin.java"
    click Vst2 "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/Vst2Plugin.java"
    click Vst3 "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/Vst3Plugin.java"
    click Au "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/AuPlugin.java"
    click Clap "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/device/ClapPlugin.java"
    click Track "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Track.java"
    click Channel "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Channel.java"
    click Send "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Send.java"
    click Transport "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/Transport.java"
    click TimeSignature "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/TimeSignatureParameter.java"
    click FileRef "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/FileReference.java"
    click MediaFiles "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/MediaFile.java"
    click Audio "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Audio.java"
    click Video "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Video.java"
    click Points "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/Points.java"
    click AutoTarget "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/AutomationTarget.java"
    click RealPoint "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/RealPoint.java"
    click BoolPoint "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/BoolPoint.java"
    click EnumPoint "https://github.com/bitwig/dawproject/blob/main/src/main/java/com/bitwig/dawproject/timeline/EnumPoint.java"
```
