# iosr-surrey/roomacousticpp architecture

> Architecture diagram of the GitHub repository iosr-surrey/roomacousticpp, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/iosr-surrey/roomacousticpp
- Repository: https://github.com/iosr-surrey/roomacousticpp

## Overview

RoomAcoustiC++ is a real-time room-acoustics library exposed through a C API for host applications. A host configures the room, sources, listener, and acoustic options through the API; the Context coordinates the simulation, and audio processing combines direct/early sound with optional late reverberation before spatialized output. The README documents diffraction variants, two late-reverb models, custom HRTFs, and dynamic geometry. Several internal links below are limited to imports or explicit excerpts; unsampled implementation details are not inferred.

Main entry points: [`RoomAcoustiCpp/source/Spatialiser/Context.cpp`](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Context.cpp) (Simulation context), [`RoomAcoustiCpp/include/Spatialiser/SourceManager.h`](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/include/Spatialiser/SourceManager.h) (Audio processing), [`RoomAcoustiCpp/source/Spatialiser/ImageSource.cpp`](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/ImageSource.cpp) (Image sources), [`RoomAcoustiCpp/source/Spatialiser/SourceManager.cpp`](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/SourceManager.cpp) (Source manager)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Host API"]
  node_api["C API<br/>[Main.cpp]"]
  node_context["Simulation context<br/>[Context.cpp]"]
  node_unity["Unity interface<br/>[UnityInterface.cpp]"]
end

subgraph group_scene["Acoustic Scene"]
  node_room["Room geometry<br/>[Room.cpp]"]
  node_walls["Walls and edges<br/>[Wall.cpp]"]
  node_sources["Source manager<br/>[SourceManager.cpp]"]
  node_source["Audio source<br/>[Source.cpp]"]
  node_tracing["Path tracing<br/>[TracingThread.cpp]"]
end

subgraph group_audio["Audio Processing"]
  node_audioflow["Audio processing<br/>[SourceManager.h]"]
  node_dsp["DSP filters<br/>[IIRFilter.cpp]"]
  node_spatial["Binaural spatializer<br/>[Context.cpp]"]
end

subgraph group_models["Acoustic Models"]
  node_image["Image sources<br/>[ImageSource.cpp]"]
  node_diffraction["Diffraction models<br/>[Models.cpp]"]
  node_nn["NN-IIR prediction<br/>[predict.cpp]"]
  node_fdn["FDN reverberation<br/>[FDN.cpp]"]
  node_raves["RAVES reverberation<br/>[RAVESResidue.h]"]
  node_reverb["Reverb control<br/>[Reverb.cpp]"]
end

node_host(("Host application"))

node_host -->|"configures and processes"| node_api
node_api -.->|"controls simulation"| node_context
node_context -->|"manages geometry"| node_room
node_context -->|"initializes sources"| node_sources
node_context -->|"controls reverberation"| node_reverb
node_sources -->|"manages sources"| node_source
node_sources -->|"processes image sources"| node_image
node_audioflow -->|"processes audio"| node_image
node_audioflow -->|"sends reverb input"| node_fdn
node_audioflow -->|"sends reverb input"| node_raves
node_image -.->|"models diffraction"| node_diffraction
node_diffraction -.->|"uses NN-IIR option"| node_nn
node_reverb -.->|"selects late model"| node_fdn
node_reverb -.->|"selects late model"| node_raves
node_audioflow -.->|"filters audio"| node_dsp
node_context -->|"uses binaural processing"| node_spatial
node_host -->|"integrates through"| node_unity
node_room -.->|"supports room geometry"| node_walls
node_tracing -.->|"generates reflection paths"| node_image

click node_api "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Main.cpp"
click node_context "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Context.cpp"
click node_room "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Room.cpp"
click node_walls "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Wall.cpp"
click node_sources "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/SourceManager.cpp"
click node_source "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Source.cpp"
click node_tracing "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/TracingThread.cpp"
click node_image "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/ImageSource.cpp"
click node_diffraction "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Diffraction/Models.cpp"
click node_nn "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/codegen/dll/myNN/predict.cpp"
click node_fdn "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/FDN.cpp"
click node_raves "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/include/Spatialiser/RAVESResidue.h"
click node_reverb "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Reverb.cpp"
click node_audioflow "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/include/Spatialiser/SourceManager.h"
click node_dsp "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/DSP/IIRFilter.cpp"
click node_spatial "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Context.cpp"
click node_unity "https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Unity/UnityInterface.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_api,node_context,node_unity toneBlue
class node_room,node_walls,node_sources,node_source,node_tracing toneAmber
class node_audioflow,node_dsp,node_spatial toneMint
class node_image,node_diffraction,node_nn,node_fdn,node_raves,node_reverb toneRose
class node_host toneIndigo
```

## Components

### Host API

- [C API](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Main.cpp): `RoomAcoustiCpp/source/Spatialiser/Main.cpp`
- [Simulation context](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Context.cpp): `RoomAcoustiCpp/source/Spatialiser/Context.cpp`
- [Unity interface](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Unity/UnityInterface.cpp): `RoomAcoustiCpp/source/Unity/UnityInterface.cpp`

### Acoustic Scene

- [Room geometry](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Room.cpp): `RoomAcoustiCpp/source/Spatialiser/Room.cpp`
- [Walls and edges](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Wall.cpp): `RoomAcoustiCpp/source/Spatialiser/Wall.cpp`
- [Source manager](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/SourceManager.cpp): `RoomAcoustiCpp/source/Spatialiser/SourceManager.cpp`
- [Audio source](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Source.cpp): `RoomAcoustiCpp/source/Spatialiser/Source.cpp`
- [Path tracing](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/TracingThread.cpp): `RoomAcoustiCpp/source/Spatialiser/TracingThread.cpp`

### Audio Processing

- [Audio processing](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/include/Spatialiser/SourceManager.h): `RoomAcoustiCpp/include/Spatialiser/SourceManager.h`
- [DSP filters](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/DSP/IIRFilter.cpp): `RoomAcoustiCpp/source/DSP/IIRFilter.cpp`
- [Binaural spatializer](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Context.cpp): `RoomAcoustiCpp/source/Spatialiser/Context.cpp`

### Acoustic Models

- [Image sources](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/ImageSource.cpp): `RoomAcoustiCpp/source/Spatialiser/ImageSource.cpp`
- [Diffraction models](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Diffraction/Models.cpp): `RoomAcoustiCpp/source/Spatialiser/Diffraction/Models.cpp`
- [NN-IIR prediction](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/codegen/dll/myNN/predict.cpp): `RoomAcoustiCpp/codegen/dll/myNN/predict.cpp`
- [FDN reverberation](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/FDN.cpp): `RoomAcoustiCpp/source/Spatialiser/FDN.cpp`
- [RAVES reverberation](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/include/Spatialiser/RAVESResidue.h): `RoomAcoustiCpp/include/Spatialiser/RAVESResidue.h`
- [Reverb control](https://github.com/iosr-surrey/roomacousticpp/blob/main/RoomAcoustiCpp/source/Spatialiser/Reverb.cpp): `RoomAcoustiCpp/source/Spatialiser/Reverb.cpp`

### Other components

- **Host application**

## Connections

- Host application → C API: configures and processes (evidence: `README.md`)
- C API → Simulation context: controls simulation
- Simulation context → Room geometry: manages geometry (evidence: `RoomAcoustiCpp/source/Spatialiser/Context.cpp`)
- Simulation context → Source manager: initializes sources (evidence: `RoomAcoustiCpp/source/Spatialiser/Context.cpp`)
- Simulation context → Reverb control: controls reverberation (evidence: `RoomAcoustiCpp/source/Spatialiser/Context.cpp`)
- Source manager → Audio source: manages sources
- Source manager → Image sources: processes image sources
- Audio processing → Image sources: processes audio (evidence: `RoomAcoustiCpp/include/Spatialiser/SourceManager.h`)
- Audio processing → FDN reverberation: sends reverb input (evidence: `RoomAcoustiCpp/include/Spatialiser/SourceManager.h`)
- Audio processing → RAVES reverberation: sends reverb input (evidence: `RoomAcoustiCpp/include/Spatialiser/SourceManager.h`)
- Image sources → Diffraction models: models diffraction
- Diffraction models → NN-IIR prediction: uses NN-IIR option
- Reverb control → FDN reverberation: selects late model
- Reverb control → RAVES reverberation: selects late model
- Audio processing → DSP filters: filters audio
- Simulation context → Binaural spatializer: uses binaural processing (evidence: `README.md`)
- Host application → Unity interface: integrates through (evidence: `README.md`)
- Room geometry → Walls and edges: supports room geometry
- Path tracing → Image sources: generates reflection paths
