Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
47 changes: 47 additions & 0 deletions .github/workflows/guitar-fx-assets.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Guitar FX assets — fast, path-scoped
# No Chromium, MSVC, audio device, installer, npm packages or external downloads.
# Only this feature's own asset and UX-study paths trigger the contract.
on:
pull_request:
paths:
- 'design-references/guitar-fx/**'
- 'docs/guitar-fx/**'
- 'scripts/build_guitar_fx_assets.mjs'
- 'engine/builtin_fx/guitar/**'
- 'tests/guitar_fx_program_model_test.cpp'
- 'tests/guitar_fx_core_pcm_test.cpp'
- 'tests/guitar_fx_assets_contract.test.mjs'
- '.github/workflows/guitar-fx-assets.yml'
push:
branches: [main]
paths:
- 'design-references/guitar-fx/**'
- 'docs/guitar-fx/**'
- 'scripts/build_guitar_fx_assets.mjs'
- 'engine/builtin_fx/guitar/**'
- 'tests/guitar_fx_program_model_test.cpp'
- 'tests/guitar_fx_core_pcm_test.cpp'
- 'tests/guitar_fx_assets_contract.test.mjs'
- '.github/workflows/guitar-fx-assets.yml'
permissions:
contents: read
concurrency:
group: guitar-fx-assets-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
jobs:
original-hardware-assets:
name: Validate reproducible PNGs and truthful editor study
runs-on: ubuntu-latest
timeout-minutes: 3
steps:
- uses: actions/checkout@v4
- name: Verify original PNG structure, bounds and deterministic output
run: node --test tests/guitar_fx_assets_contract.test.mjs
- name: Verify bounded C++ program model without JUCE or Windows
run: |
c++ -std=c++20 -O2 -Wall -Wextra -Werror -pedantic tests/guitar_fx_program_model_test.cpp -o /tmp/guitar-fx-program-model-test
/tmp/guitar-fx-program-model-test
- name: Verify wet PCM, 2x antialias and fixed 48-sample PDC without JUCE
run: |
c++ -std=c++20 -O2 -Wall -Wextra -Werror -pedantic tests/guitar_fx_core_pcm_test.cpp -o /tmp/guitar-fx-core-pcm-test
/tmp/guitar-fx-core-pcm-test
48 changes: 40 additions & 8 deletions .github/workflows/p1-windows.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ name: Windows Native VST3 Host
# Dispatcher uses the reviewed main workflow and checks out the exact PR SHA.
# The run name is a verifiable deduplication identity (not github.head_sha,
# which would refer to main for workflow_dispatch on main).
run-name: "ArSonMix ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat && 'FAT' || github.event_name == 'workflow_dispatch' && 'NATIVE' || 'AUTO' }} PR${{ inputs.request_pr_number || '0' }} ${{ inputs.expected_sha || github.sha }}"
run-name: "ArSonMix ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat && 'FAT' || github.event_name == 'workflow_dispatch' && inputs.field_preview && 'FIELD' || github.event_name == 'workflow_dispatch' && 'NATIVE' || 'AUTO' }} PR${{ inputs.request_pr_number || '0' }} ${{ inputs.expected_sha || github.sha }}"
on:
# Single canonical Windows release producer: main changes to shipped runtime,
# native C++ or distribution scripts. Historical feature branch pushes are PRs.
Expand Down Expand Up @@ -99,6 +99,11 @@ on:
type: boolean
required: false
default: false
field_preview:
description: "Build the portable app for real Windows testing without the full CTest or installer suite"
type: boolean
required: false
default: false
focused_harmony_fat:
description: "Focused Windows FAT for the built-in vocal harmony plugin: full app, plugin DSP, mixer PCM and ASIO checks"
type: boolean
Expand All @@ -120,7 +125,7 @@ concurrency:
# the same PR share one slot and supersede each other; different PRs never
# cancel one another. The owner dispatcher separately cancels an obsolete
# native compile when a FAT request arrives for that same verified PR.
group: windows-vst3-${{ github.event_name == 'workflow_dispatch' && inputs.package_fat && github.run_id || github.event_name == 'workflow_dispatch' && inputs.request_pr_number != '' && format('pr-{0}', inputs.request_pr_number) || github.event.pull_request.number || github.ref }}
group: windows-vst3-${{ github.event_name == 'workflow_dispatch' && inputs.package_fat && github.run_id || github.event_name == 'workflow_dispatch' && inputs.request_pr_number != '' && format('{0}-pr-{1}', inputs.field_preview && 'field' || 'native', inputs.request_pr_number) || github.event.pull_request.number || github.ref }}
cancel-in-progress: ${{ github.event_name != 'workflow_dispatch' || !inputs.package_fat }}

permissions:
Expand Down Expand Up @@ -247,6 +252,7 @@ jobs:
# Owner-dispatched FAT on an isolated Harmony-only PR can skip
# compiling unrelated CTest executables, never the actual JUCE GUI.
# Main/release builds and every generic native milestone remain full.
FIELD_PREVIEW: ${{ github.event_name == 'workflow_dispatch' && inputs.field_preview && !inputs.package_fat }}
FOCUSED_HARMONY_FAT: ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat == true && inputs.focused_harmony_fat == true }}
steps:
- uses: actions/checkout@v4
Expand Down Expand Up @@ -329,7 +335,7 @@ jobs:
run: >
cmake -S . -B build -G "Visual Studio 17 2022" -A x64
-DJUCE_ROOT="${{ github.workspace }}/third_party/JUCE"
-DBUILD_TESTING=ON
-DBUILD_TESTING=${{ env.FIELD_PREVIEW == 'true' && 'OFF' || 'ON' }}
-DJUCE_WEBVIEW2_PACKAGE_LOCATION="${{ github.workspace }}/.deps"
- name: Verify exact ONE approved /preview/ GUI CMake bundle
run: node scripts/check_approved_native_gui_release.mjs --source-only --bundle build/approved_gui
Expand Down Expand Up @@ -407,7 +413,7 @@ jobs:
Write-Host "HARMONY_FAT_NATIVE_TARGETS=$($targets.Count) SOURCE_SHA=$sourceSha"

- name: Build executable and native RT tests
if: ${{ env.FOCUSED_HARMONY_FAT != 'true' }}
if: ${{ env.FOCUSED_HARMONY_FAT != 'true' && env.FIELD_PREVIEW != 'true' }}
# Full build remains mandatory for main, release and native/full requests.
run: cmake --build build --config Release --parallel 2
- name: Run focused vocal harmony DSP, mixer PCM and ASIO checks
Expand Down Expand Up @@ -444,27 +450,53 @@ jobs:
Write-Host "FOCUSED_HARMONY_FAT_CTEST_COUNT=$($requiredTests.Count) FULL_SUITE_NOT_CLAIMED"
& ctest --test-dir build -C Release --output-on-failure -R $pattern
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
- name: Build portable Windows field preview
if: ${{ env.FIELD_PREVIEW == 'true' }}
run: cmake --build build --config Release --parallel 2 --target ARMixConsole
- name: Test realtime control primitives
if: ${{ env.FOCUSED_HARMONY_FAT != 'true' }}
if: ${{ env.FOCUSED_HARMONY_FAT != 'true' && env.FIELD_PREVIEW != 'true' }}
run: ctest --test-dir build -C Release --output-on-failure
- name: Package verified JUCE GUI for hardware FAT
if: ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat == true }}
if: ${{ env.FIELD_PREVIEW == 'true' || (github.event_name == 'workflow_dispatch' && inputs.package_fat == true) }}
shell: pwsh
run: |
& ./scripts/package_native_windows.ps1 -BuildDir build -OutputDir dist
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
- name: Stage ONLY legally approved and host-qualified Factory VST3 bundles
if: ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat == true }}
if: ${{ env.FIELD_PREVIEW == 'true' || (github.event_name == 'workflow_dispatch' && inputs.package_fat == true) }}
shell: pwsh
run: |
python scripts/factoryfx_release_bundle.py stage --lock config/factoryfx-approved-releases.json --output dist --best-effort
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
- name: Mark unqualified field preview BEFORE independent distribution verification
if: ${{ env.FIELD_PREVIEW == 'true' }}
shell: pwsh
run: |
# Tag the final allowlisted package rather than modifying files
# AFTER verification. Users receive exactly the bytes we validate.
$path = 'dist/BUILD_PROVENANCE.json'
$provenance = Get-Content -LiteralPath $path -Raw -Encoding UTF8 | ConvertFrom-Json
if ($provenance.sourceCommit -ne '${{ inputs.expected_sha }}') {
throw 'FIELD_PREVIEW_SOURCE_SHA_MISMATCH'
}
$provenance.fatStatus = 'FIELD_PREVIEW_FULL_CTEST_NOT_RUN'
$provenance | ConvertTo-Json -Depth 20 |
Set-Content -LiteralPath $path -Encoding utf8
- name: Independently verify release ZIP and embedded GUI/engine before upload
if: ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat == true }}
if: ${{ env.FIELD_PREVIEW == 'true' || (github.event_name == 'workflow_dispatch' && inputs.package_fat == true) }}
shell: pwsh
run: |
& ./scripts/verify_native_windows_artifact.ps1 -OutputDir dist
if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }
- name: Upload portable Windows field preview
if: ${{ env.FIELD_PREVIEW == 'true' }}
uses: actions/upload-artifact@v4
with:
name: ArSonMix-Windows-Field-Preview-${{ inputs.expected_sha }}
path: dist/
if-no-files-found: error
retention-days: 14
compression-level: 0
- name: Install Inno Setup 6 compiler if missing
if: ${{ github.event_name == 'workflow_dispatch' && inputs.package_fat == true }}
shell: pwsh
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ui-smoke.yml
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,7 @@ jobs:
needs: quick
# Both 8D-SonKu and SOF native-owner PRs share ONE actual Chromium runner.
# Preserve fast-only checks for unrelated GUI and engine branches.
if: ${{ (github.event_name == 'pull_request' && (startsWith(github.head_ref, 'feat/8d-sonku-') || startsWith(github.head_ref, 'test/sof-native-') || startsWith(github.head_ref, 'integration/sof-sonku-main-') || startsWith(github.head_ref, 'fix/native-wire-inspector-') || startsWith(github.head_ref, 'integration/sonku-m4-wire-'))) || (github.event_name == 'workflow_dispatch' && startsWith(github.ref, 'refs/heads/feat/8d-sonku-') && inputs.expected_sha != '') }}
if: ${{ (github.event_name == 'pull_request' && (startsWith(github.head_ref, 'feat/8d-sonku-') || startsWith(github.head_ref, 'test/sof-native-') || startsWith(github.head_ref, 'integration/sof-sonku-main-') || startsWith(github.head_ref, 'fix/native-wire-inspector-') || startsWith(github.head_ref, 'integration/sonku-m4-wire-') || startsWith(github.head_ref, 'integration/sonku-m4-guitar-'))) || (github.event_name == 'workflow_dispatch' && startsWith(github.ref, 'refs/heads/feat/8d-sonku-') && inputs.expected_sha != '') }}
runs-on: ubuntu-latest
timeout-minutes: 12
steps:
Expand Down
9 changes: 8 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,14 @@ message(STATUS "${ARMIX_GUI_BUNDLE_LOG}")
file(GLOB_RECURSE ARMIX_APPROVED_GUI_BINARIES CONFIGURE_DEPENDS
"${ARMIX_APPROVED_GUI_DIR}/assets/*")
list(SORT ARMIX_APPROVED_GUI_BINARIES)
# Original Guitar FX artwork is embedded ONLY for the installed JUCE
# plugin editor; it never becomes a second /preview/ or runtime file path.
file(GLOB ARMIX_GUITAR_SKIN_PNGS CONFIGURE_DEPENDS
"${CMAKE_CURRENT_SOURCE_DIR}/design-references/guitar-fx/assets/*.png")
list(SORT ARMIX_GUITAR_SKIN_PNGS)
juce_add_binary_data(ARMixAssets SOURCES
"${ARMIX_APPROVED_GUI_DIR}/index.html" ${ARMIX_APPROVED_GUI_BINARIES}
${ARMIX_GUITAR_SKIN_PNGS}
"${ARMIX_BRAND_DIR}/arsonmix-256.png")
target_include_directories(ARMixConsole PRIVATE "${ARMIX_APPROVED_GUI_DIR}")

Expand Down Expand Up @@ -133,7 +139,8 @@ target_compile_definitions(ARMixConsole PRIVATE
JUCE_PLUGINHOST_VST3=1
JUCE_APPLICATION_NAME_STRING="AR MIX Studio"
JUCE_APPLICATION_VERSION_STRING="${ARMIX_APP_VERSION}"
ARMIX_BUILD_SOURCE_SHA="${ARMIX_BUILD_SOURCE_SHA}")
ARMIX_BUILD_SOURCE_SHA="${ARMIX_BUILD_SOURCE_SHA}"
ARMIX_GFX_EMBED_PNG_SKINS=1)
if(WIN32)
# Windows retains its proven ASIO-first / WASAPI / static WebView2 distribution.
# Never link Windows loader or sound APIs into macOS/Linux builds.
Expand Down
31 changes: 31 additions & 0 deletions design-references/guitar-fx/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Guitar FX editor design study and original hardware assets

**Not the ArSonMix published mixer. Not an audio processor. No native hardware or PCM claims.**

This folder is an internal visual/interaction study for a future **single native Guitar FX insert** hosted by the already-approved ArSonMix /preview/ mixer. Its hardware-looking PNGs are original procedural drawings, not photos, and must undergo visual review before product promotion. Core contract: [Guitar FX Foundation](../../docs/guitar-fx/GUITAR_FX_FOUNDATION_20261113.md).

## Try the workflow locally

1. Clone this branch, then open `design-references/guitar-fx/editor-prototype.html` in Chrome/Edge.
2. Select Clean/Blues/Crunch/Rock/Metal/Ambient in the preset library; browser can collapse.
3. Choose a chain block to focus its *only* hardware editor; use its power dot to bypass independently; drag movable pedals to reorder while AMP/CAB remain paired.
4. Move knobs vertically or use the accessible range controls; switch A/B; download *design-state* JSON; open Tuner to see the explicit no-audio placeholder.
5. No controls send native commands or generate audio. The CAB mic position is a placeholder only; no fake acoustic claim or live metering.

## Rebuild PNGs and verify

```sh
node scripts/build_guitar_fx_assets.mjs
node --test tests/guitar_fx_assets_contract.test.mjs
```

Requires Node 18+; uses only built-in JavaScript, no image download, UI screenshot, paid fonts, external brands or pipeline dependencies. The renderer generates all PNG bitmaps byte-identically. The original indexed transparent assets are deliberately compact; CSS/HTML owns legends, values, focus, hit targets and state, not pixels. This preserves accessibility and translation potential.

## Design integration constraints

- Exactly one authoritative /preview/ console and one JUCE native graph; this file is not deployed as a competing mixer GUI.
- Integration must use the existing FX editor owner, NativeBuiltInFx registry and accepted snapshot path; coordinate with active #605 FX editor and #604 toolbar PR.
- PNG artwork is decorative and never grounds live meters, model tone, impulse responses or physical signal routes.
- Do not ship NAM models, amplifier capture files or third-party IRs without separately confirmed terms and exact approved binaries.

See original image files under [assets](assets/) and source generator at [scripts/build_guitar_fx_assets.mjs](../../scripts/build_guitar_fx_assets.mjs).
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 design-references/guitar-fx/assets/led-active.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 design-references/guitar-fx/assets/pedal-gate.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading