Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
fe941fe
Build zero-latency compressor core, VST3 host adapter and compact editor
masarray Oct 30, 2026
a2c45ce
Use product executable name and exercise live editor telemetry in smo…
masarray Oct 30, 2026
b6a4b86
Run editor smoke by CMake target and verify release timing
masarray Oct 30, 2026
c73e5f7
Correct Windows label encoding and parameter display precision
masarray Oct 30, 2026
97551d2
Harden live sidechain filter and detector transitions with sample-ram…
masarray Oct 30, 2026
7413442
Milestone: three causal compressor models and premium live dynamics UI
masarray Oct 30, 2026
c829ecb
Milestone: live DSP control coalescing, interactive threshold, vintag…
masarray Oct 30, 2026
f847fa6
Milestone: portable user presets, readable compact metering, install-…
masarray Oct 30, 2026
f63e8c6
Milestone: reference-layout compressor GUI, integrated reduction grap…
masarray Oct 30, 2026
6050baa
Milestone: compact premium compressor UI, no-collision controls and c…
masarray Oct 31, 2026
8e7432c
Milestone: two-sided graph dissolve, cached LED rails and raster fade…
masarray Oct 31, 2026
52c00f9
Fix platform-specific fade smoke rasterization and expose alpha diagn…
masarray Oct 31, 2026
80a41f5
Fix Windows JUCE raster smoke: finalize Graphics before sampling and …
masarray Oct 31, 2026
673c2ca
Milestone: cached brushed-metal compressor knobs and uncluttered FILE…
masarray Oct 31, 2026
4e4553e
Ship user-inspired black radial-brushed metal knob as bundled JUCE GU…
masarray Oct 31, 2026
805b7dd
Milestone: exercise real JUCE sidechain buses and clear stopped-trans…
masarray Oct 31, 2026
3b92be3
Milestone: external coral dial arcs, rim dots, popup values, premium …
masarray Oct 31, 2026
5b4573b
Fix JUCE BinaryData symbol for supplied slider thumb via alphanumeric…
masarray Oct 31, 2026
f1c99c7
Match JUCE Slider public API in no-textbox GUI smoke assertion
masarray Oct 31, 2026
d3ec9cd
Fix Windows JUCE smoke tooltip call constness without changing assert…
masarray Oct 31, 2026
4ef6ce7
Make Windows UI smoke widget-list type explicit for mixed const compo…
masarray Oct 31, 2026
358c46b
Fix mono unity smoke setup to respect intentional parameter smoothing
masarray Oct 31, 2026
bd73fe1
Milestone: brushed-steel chassis, jet-black glass scope and VU LCD, r…
masarray Oct 31, 2026
32bfd7d
Stabilize cross-backend black-glass visual smoke and report pixel dia…
masarray Oct 31, 2026
d4ceafc
Milestone: layered gunmetal hardware slider track, moving illuminated…
masarray Oct 31, 2026
7a8ef2d
Fix JUCE 8 drawImage API: preclip gunmetal 3-slice rail once during G…
masarray Oct 31, 2026
aa53699
Include production Editor.h in gunmetal hardware slider GUI smoke test
masarray Oct 31, 2026
d3a2faa
Add ON and OFF metal toggle artwork sources
masarray Oct 31, 2026
07f7434
Repair uploaded gunmetal thumb PNG with SHA-verified original; improv…
masarray Oct 31, 2026
3a522e7
Replace overlay tooltips with LCD footer value readout and compact re…
masarray Oct 31, 2026
2673efb
Update Windows test guide for compact GUI and LCD-only hover values
masarray Oct 31, 2026
c43f445
Bundle matched brushed metal toggle PNG assets into VST
masarray Oct 31, 2026
8c37c57
Render APVTS switch states with matched brushed metal sprites
masarray Oct 31, 2026
7b340eb
Smoke-test metal ON/OFF sprites and Bypass state inversion
masarray Oct 31, 2026
b0c8cba
docs: reconcile current ArSonComp baseline, verified CI, GUI dimensio…
masarray Oct 31, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Validate and build
on:
pull_request:
paths: ['engine/**', 'plugin/**', 'assets/**', 'tests/**', 'CMakeLists.txt', 'docs/WINDOWS-QUICKSTART.md', '.github/workflows/**']
workflow_dispatch:
permissions:
contents: read
concurrency:
group: arson-comp-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
engine-safety:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: cmake -S . -B build -DARSON_BUILD_PLUGIN=OFF -DARSON_SANITIZE=ON -DCMAKE_BUILD_TYPE=Debug
- run: cmake --build build --parallel 2
- run: ctest --test-dir build --output-on-failure
windows:
runs-on: windows-latest
steps:
- uses: actions/checkout@v4
- uses: actions/cache@v4
with:
path: build/_deps/juce-src
key: juce-8.0.12-29396c22-windows
- run: cmake -S . -B build -A x64 -DCMAKE_BUILD_TYPE=Release
- run: cmake --build build --config Release --parallel 4
- run: ctest --test-dir build -C Release --output-on-failure
- name: Measure engine throughput
shell: pwsh
run: |
New-Item -ItemType Directory -Force artifacts
& ./build/Release/engine_bench.exe | Tee-Object artifacts/benchmark.txt
- name: Package install-ready Windows test artifact
shell: pwsh
run: |
$ErrorActionPreference = 'Stop'
$dest = 'artifacts/ArSonComp-Windows-Test'
New-Item -ItemType Directory -Force "$dest/Plugin", "$dest/Standalone", "$dest/Screenshots" | Out-Null
Copy-Item -Recurse 'build/ArSonComp_artefacts/Release/VST3/ArSonComp.vst3' "$dest/Plugin/"
Copy-Item 'build/ArSonComp_artefacts/Release/Standalone/ArSonComp.exe' "$dest/Standalone/"
Copy-Item 'docs/WINDOWS-QUICKSTART.md' "$dest/START-HERE.md"
Copy-Item 'artifacts/benchmark.txt' "$dest/benchmark.txt"
Copy-Item 'build/ArSonComp-preview*.png' "$dest/Screenshots/"
$files = Get-ChildItem "$dest/Plugin", "$dest/Standalone" -File -Recurse
$files | ForEach-Object { "$((Get-FileHash $_.FullName -Algorithm SHA256).Hash) $($_.FullName.Substring((Resolve-Path $dest).Path.Length + 1))" } |
Set-Content "$dest/SHA256SUMS.txt" -Encoding ascii
"Commit: ${{ github.sha }}" | Set-Content "$dest/BUILD-INFO.txt" -Encoding ascii
"CI: https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}" |
Add-Content "$dest/BUILD-INFO.txt"
- uses: actions/upload-artifact@v4
with:
name: ArSonComp-Windows-x64-ReadyToTest
path: artifacts/ArSonComp-Windows-Test/
if-no-files-found: error
retention-days: 14
11 changes: 11 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ArSonComp engineering contract

- Build a live compressor, not an audio editor. Keep the GUI compact, legible and visually calm. Avoid bulky cards, giant fonts and decorative controls.
- Engine must remain framework independent. Audio thread owns DSP state; no allocation, mutex, file/network I/O or dependency on a worker finishing in process/setParameters.
- One canonical parameter table in engine/Parameters.h. Stable IDs must not be renamed after release. Sanitize outside the inner sample loop.
- Do not add a worker for synchronous audio. Add workers only for demonstrably expensive non-audio tasks, with bounded queues, cancellation and joined lifetime.
- Preserve zero additional latency in the live path. Do not silently introduce lookahead or oversampling.
- Telemetry must be bounded and may drop visual data; never stall audio. GUI changes must not alter DSP results.
- Use RAII and bounded containers. Avoid fast-math, speculative approximation or SIMD unless profiling and numerical tests support it.
- Run meaningful DSP/host tests, inspect GUI renders at minimum/default size, and document unverified hardware behavior. Never claim proprietary Pro-C parity without matched-input audio comparisons.
- Group meaningful changes before CI. Do not dispatch repetitive builds or commit generated binaries/build directories.
71 changes: 71 additions & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
cmake_minimum_required(VERSION 3.22)
project(ArSonComp VERSION 0.1.0 LANGUAGES CXX)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
option(ARSON_BUILD_PLUGIN "Build VST3 and standalone" ON)
option(ARSON_SANITIZE "Enable address/undefined sanitizers for engine tests" OFF)
add_library(arson_engine STATIC engine/Compressor.cpp)
set_target_properties(arson_engine PROPERTIES POSITION_INDEPENDENT_CODE ON)
target_include_directories(arson_engine PUBLIC ${CMAKE_CURRENT_SOURCE_DIR}/engine)
if(MSVC)
target_compile_options(arson_engine PRIVATE /W4)
else()
target_compile_options(arson_engine PRIVATE -Wall -Wextra -Wpedantic)
endif()
if(ARSON_SANITIZE AND NOT MSVC)
target_compile_options(arson_engine PUBLIC -fsanitize=address,undefined -fno-omit-frame-pointer)
target_link_options(arson_engine PUBLIC -fsanitize=address,undefined)
endif()
include(CTest)
if(BUILD_TESTING)
find_package(Threads REQUIRED)
add_executable(engine_tests tests/EngineTests.cpp)
target_link_libraries(engine_tests PRIVATE arson_engine Threads::Threads)
add_test(NAME engine_contract COMMAND engine_tests)
add_executable(engine_bench tests/Benchmark.cpp)
target_link_libraries(engine_bench PRIVATE arson_engine)
endif()
if(ARSON_BUILD_PLUGIN)
if(DEFINED JUCE_SOURCE_DIR)
add_subdirectory(${JUCE_SOURCE_DIR} ${CMAKE_BINARY_DIR}/JUCE)
else()
include(FetchContent)
FetchContent_Declare(JUCE GIT_REPOSITORY https://github.com/juce-framework/JUCE.git
GIT_TAG 8.0.12 GIT_SHALLOW TRUE)
FetchContent_MakeAvailable(JUCE)
execute_process(COMMAND git rev-parse HEAD WORKING_DIRECTORY "${juce_SOURCE_DIR}"
OUTPUT_VARIABLE JUCE_CHECKED_SHA OUTPUT_STRIP_TRAILING_WHITESPACE COMMAND_ERROR_IS_FATAL ANY)
if(NOT JUCE_CHECKED_SHA STREQUAL "29396c22c93392d6738e021b83196283d6e4d850")
message(FATAL_ERROR "JUCE tag does not match the audited commit")
endif()
endif()
juce_add_plugin(ArSonComp COMPANY_NAME "ArSon Audio" BUNDLE_ID "com.arsonaudio.comp"
PLUGIN_MANUFACTURER_CODE ArSn PLUGIN_CODE ArCp FORMATS VST3 Standalone
PRODUCT_NAME "ArSonComp" IS_SYNTH FALSE NEEDS_MIDI_INPUT FALSE NEEDS_MIDI_OUTPUT FALSE
IS_MIDI_EFFECT FALSE EDITOR_WANTS_KEYBOARD_FOCUS FALSE COPY_PLUGIN_AFTER_BUILD FALSE
VST3_CATEGORIES Fx Dynamics)
# Bundled reference-derived black brushed-metal image. Generated assets
# are compiled into the VST3/Standalone; no filesystem access at runtime.
juce_add_binary_data(ArSonCompKnobAssets
SOURCES assets/black_brushed_knob.jpg
assets/gunmetal_slider_track.png
assets/gunmetal_slider_thumb_red.png
assets/toggle/arson_toggle_on.png
assets/toggle/arson_toggle_off.png)
target_sources(ArSonComp PRIVATE plugin/Processor.cpp plugin/Editor.cpp)
if(MSVC)
target_compile_options(ArSonComp PRIVATE /utf-8)
endif()
target_compile_definitions(ArSonComp PUBLIC JUCE_WEB_BROWSER=0 JUCE_USE_CURL=0
JUCE_VST3_CAN_REPLACE_VST2=0)
target_link_libraries(ArSonComp PRIVATE arson_engine ArSonCompKnobAssets juce::juce_audio_utils
PUBLIC juce::juce_recommended_config_flags juce::juce_recommended_lto_flags)
if(BUILD_TESTING)
juce_add_console_app(plugin_smoke PRODUCT_NAME "ArSonCompSmoke")
target_sources(plugin_smoke PRIVATE tests/PluginSmoke.cpp)
target_link_libraries(plugin_smoke PRIVATE ArSonComp ArSonCompKnobAssets
arson_engine juce::juce_audio_utils)
add_test(NAME plugin_state_editor COMMAND plugin_smoke "${CMAKE_BINARY_DIR}/ArSonComp-preview.png")
set_tests_properties(plugin_state_editor PROPERTIES TIMEOUT 30)
endif()
endif()
71 changes: 70 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,70 @@
# arson-comp
# ArSonComp

A lightweight **real-time compressor** with a framework-independent C++17 DSP core, JUCE VST3 and Windows Standalone application. Designed for live vocal, karaoke, podcast, music and mix-bus use. This is an **engineering test baseline**, not a certified production release or a claimed FabFilter Pro-C clone.

## Current verified milestone — 31 October 2026

| Area | Implemented and checked |
| --- | --- |
| DSP | Clean feed-forward, causal Feedback and Smooth dual-envelope models; Peak and 10 ms RMS detection; Attack, Release, Hold, Threshold, Ratio, Knee, Range and Auto Release |
| Signal path | Input/Makeup gain, wet/dry Mix, stereo Link, mono/stereo main buses, optional external sidechain, detector HP/LP, SC Listen, smoothed Bypass |
| Latency | **0 additional algorithmic samples** reported by the plugin; host buffer, driver and audio interface latency are separate |
| Host interoperability | Stable APVTS parameter IDs, project state restore, six factory starting presets, user `.arsoncomp` save/open through **FILE**, A/B snapshots, automation attachments |
| GUI | Grey brushed-metal chassis, recessed black LCD graph and IN/GR/OUT meters, photographic black rotary knobs, matched metal toggle PNGs, fixed gunmetal slider rails with moving PNG thumbs and red value fill |
| Value workflow | **No floating value popup/tooltip.** Hover/drag the knobs and sliders to read their value in the LCD's bottom-center footer; MINI uses a small right-side footer |
| Dimensions | Full **780×640** default, **740×585** minimum; MINI **330 px** tall. Resizable full layout and responsive SIDECHAIN row |
| Automated verification | Windows Release VST3 + Standalone, `engine_contract`, `plugin_state_editor`, Linux engine safety/sanitizers, renderer/asset/layout checks, benchmark and install-ready Windows artifact |

**Latest code-tested revision:** `7b340eb2ee5740df13b52b5bfcf984a3b66d0dd3`. Both jobs passed in [GitHub Actions #41202549812](https://github.com/masarray/arson-comp/actions/runs/41202549812). The [Windows x64 artifact](https://github.com/masarray/arson-comp/actions/runs/41202549812/artifacts/13043510391) contains VST3, Standalone, four actual Windows screenshot captures, a benchmark, and SHA-256 manifests. Subsequent documentation-only reconciliation does not modify the compiled source.

### What is *not* verified yet

Real-device ASIO/WASAPI audio latency and stability; two independent DAW/VST3 hosts, external hardware/host sidechain, pluginval, multi-instance long sessions, 125–150% DPI scaling, and loudness-matched listening comparisons. No full Pro-C sonic, feature or production-readiness claim. The initial standalone uses standard JUCE audio device backends; **ASIO support is not claimed**.

## Quick start — Windows

1. Download the Windows artifact linked above and extract its contents.
2. Run `Standalone/ArSonComp.exe`, then choose audio input/output devices in its settings; **or** copy the entire `Plugin/ArSonComp.vst3` folder to `C:\Program Files\Common Files\VST3\`, then rescan your VST3 host.
3. Start with Clean and a moderate preset. Lower Threshold until the GR meter indicates the desired compression. Use Makeup to match audible loudness before A/B or model comparisons.
4. Open **SIDECHAIN** to configure Peak/RMS, HP/LP and optional EXT SC and LISTEN; use **DYNAMICS** for Range, Hold, Mix, Link, Auto Release. FILE provides Save/Open user presets.
5. Hover or move any knob/slider to see name, numerical value and unit in the graph LCD footer. Double-click to restore the parameter's default. Use MINI/FULL to switch form factor.

A disconnected external sidechain may produce silence at the detector. Use LISTEN only to audit the detector and turn it off for normal use. This is a compressor—not a limiter; with no lookahead, transients may pass.

## Build from source

CMake 3.22+, C++17, JUCE 8.0.12 pinned to commit `29396c22c93392d6738e021b83196283d6e4d850`. On Windows, install Visual Studio 2022 or newer with C++ desktop tools.

```sh
cmake -S . -B build -A x64 -DCMAKE_BUILD_TYPE=Release
cmake --build build --config Release --parallel 4
ctest --test-dir build -C Release --output-on-failure
```

For engine-only verification on Linux/macOS, omit the Windows `-A x64` argument and use:

```sh
cmake -S . -B build-core -DARSON_BUILD_PLUGIN=OFF -DCMAKE_BUILD_TYPE=Release
cmake --build build-core --parallel 2
ctest --test-dir build-core --output-on-failure
./build-core/engine_bench
```

Linux plugin build dependencies depend on the desktop stack, commonly `pkg-config libasound2-dev libx11-dev libxext-dev libxinerama-dev libxrandr-dev libxcursor-dev libfreetype6-dev libfontconfig1-dev libgl1-mesa-dev`. Use `-DJUCE_SOURCE_DIR=/path/to/JUCE` to reuse a local checkout. ASan/UBSan engine testing: `-DARSON_SANITIZE=ON -DCMAKE_BUILD_TYPE=Debug` under GCC/Clang. **Do not enable fast-math**, because non-finite handling relies on IEEE floating-point semantics.

## Engineering boundaries

The independent DSP core is free of JUCE. The audio callback does not require a worker, mutex, heap allocation or file/network I/O; it has bounded telemetry. GUI paint is message-thread-only, with cached materials, gradient/grid geometry and 30 Hz display updates. The plugin adds no intentional lookahead, oversampling, linear-phase stage or audio delay line. A reported zero algorithmic samples does **not** mean the full monitoring system has zero latency.

Presets and parameter updates are smoothed where appropriate, but are not promised sample-accurate atomic transactions. Host automation behavior, sidechain audibility, distortion and CPU load must be verified with actual devices.

## Documentation and release gates

- [PRD: scope and acceptance](docs/PRD.md)
- [ARD: DSP, scheduling and GUI ownership](docs/ARD.md)
- [VALIDATION: evidence and outstanding tests](docs/VALIDATION.md)
- [HANDOFF: current next steps and historical milestones](docs/HANDOFF.md)
- [WINDOWS-QUICKSTART: physical test checklist](docs/WINDOWS-QUICKSTART.md)
- [AGENTS: engineering guardrails](AGENTS.md)

Repository license remains AGPL-3.0; JUCE has its own AGPL/commercial terms. FabFilter Pro-C is a third-party workflow and sound-quality reference; no FabFilter asset, code or proprietary algorithm is included.
Binary file added assets/black_brushed_knob.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gunmetal_slider_thumb_red.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/gunmetal_slider_track.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/sliderthumb.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions assets/toggle/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ArSonComp ON/OFF toggle assets

Two state images are authored as transparent SVG source files. Corresponding
high-resolution RGBA PNG exports are supplied with the design deliverables.

- ON: green case, metal actuator on the left
- OFF: red case, metal actuator on the right
- Source canvas: 640 × 246; recommended PNG export: 768 × 295
- Use images at the same view rectangle for a no-layout-shift state change.

Export for JUCE using: `cairosvg arson_toggle_on.svg -o arson_toggle_on.png -W 768 -H 295`
(and analogously for OFF). No changes to DSP or plugin UI wiring are included.
Binary file added assets/toggle/arson_toggle_off.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading