# englishm/moq-js architecture

> Architecture diagram of the GitHub repository englishm/moq-js, 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/englishm/moq-js
- Repository: https://github.com/englishm/moq-js

## Overview

##### Component Relationships

- [Browser APIs]
- ↑↓
- [Playback Layer (Web Workers & Worklets)]
- ↑↓
- [Media Processing Layer]
- ↑↓
- [Transport Layer]
- ↑↓
- [QUIC Server]

##### Detailed Component Breakdown

a) Transport Layer (from lib/transport/):
- Publisher and Subscriber components
- Control Flow handling
- Stream Management

b) Media Processing (from lib/media/):
- MP4 Parser component
- Catalog Management
- Media Container handling

c) Playback System (from lib/playback/):
- Audio/Video pipeline separation
- Timeline management

##### Technical Details
- WebTransport connection handling
- QUIC stream multiplexing
- WebCodecs integration points
- Audio/Video synchronization
- Buffer management (Ring buffer from common/)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles
    classDef browser fill:#d3d3d3
    classDef transport fill:#a8d1f0
    classDef media fill:#90EE90
    classDef playback fill:#FFB347
    classDef common fill:#E6E6FA
    classDef message fill:#FFE4E1

    %% Transport Layer with Detailed Messages
    subgraph TransportLayer
        ConnManager["Connection Manager"]:::transport
        Publisher["Publisher"]:::transport
        Subscriber["Subscriber"]:::transport
        ControlFlow["Control Flow"]:::transport
        StreamMgmt["Stream Management"]:::transport

        %% Message Types
        AnnounceMsg["ANNOUNCE Message<br/>- Track information<br/>- Media parameters"]:::message
        SubscribeMsg["SUBSCRIBE Message<br/>- Track selection<br/>- Quality preferences"]:::message
        GoAwayMsg["GOAWAY Message<br/>- Graceful shutdown<br/>- Error conditions"]:::message
        DataMsg["DATA Message<br/>- Media segments<br/>- Timing info"]:::message
        SetupMsg["SETUP Message<br/>- Connection params<br/>- Stream config"]:::message
        
        %% Control Messages
        KeepAliveMsg["KEEPALIVE Message<br/>- Connection health<br/>- Latency measurement"]:::message
        ErrorMsg["ERROR Message<br/>- Error codes<br/>- Debug info"]:::message
        AckMsg["ACK Message<br/>- Segment receipt<br/>- Flow control"]:::message
    end

    %% Message Flows
    Publisher --> AnnounceMsg
    Publisher --> DataMsg
    Publisher --> GoAwayMsg
    
    Subscriber --> SubscribeMsg
    Subscriber --> AckMsg
    
    ControlFlow --> KeepAliveMsg
    ControlFlow --> ErrorMsg
    
    ConnManager --> SetupMsg

    StreamMgmt --> DataMsg
    StreamMgmt --> AckMsg

    %% Click Events
    click ConnManager "https://github.com/englishm/moq-js/blob/main/lib/transport/connection.ts"
    click Publisher "https://github.com/englishm/moq-js/blob/main/lib/transport/publisher.ts"
    click Subscriber "https://github.com/englishm/moq-js/blob/main/lib/transport/subscriber.ts"
    click ControlFlow "https://github.com/englishm/moq-js/blob/main/lib/transport/control.ts"
    click StreamMgmt "https://github.com/englishm/moq-js/blob/main/lib/transport/stream.ts"

    %% Legend
    subgraph Legend
        TransportComp["Transport Component"]:::transport
        MessageType["Message Type"]:::message
    end
```
