[ { "path": ".clang-format", "content": "---\nBasedOnStyle: LLVM\nIndentWidth: 4\n---\nLanguage: Cpp\nBasedOnStyle: LLVM\nIndentWidth: 4\nAlignAfterOpenBracket: Align\nBreakBeforeBraces: Allman\nColumnLimit: 100\nSortIncludes: false\n---\nLanguage: ObjC\nBasedOnStyle: LLVM\nIndentWidth: 4\nAlignAfterOpenBracket: Align\nBreakBeforeBraces: Allman\nColumnLimit: 100\nSortIncludes: false\n---\n\n" }, { "path": ".github/workflows/build-plugin.yml", "content": "name: Build Six Sines\non:\n push:\n branches:\n - main\n - rel_*\n - test/*\n tags:\n - 'v**'\n pull_request:\n\nenv:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n TARGET_NAME: six-sines\n PLUGIN_NAME: \"Six Sines\"\n\ndefaults:\n run:\n shell: bash\n\njobs:\n build_plugin:\n name: Build - ${{ matrix.name }}\n runs-on: ${{ matrix.os }}\n strategy:\n matrix:\n include:\n - os: windows-latest\n name: windows-x64\n cmake_args: -DCMAKE_CXX_COMPLIER=clang++ -DCMAKE_C_COMPILER=clang -GNinja\n\n - os: macos-latest\n name: macos\n cmake_args: -DCMAKE_OSX_ARCHITECTURES=\"arm64;x86_64\" -GNinja\n\n - os: ubuntu-latest\n name: linux-x64\n cmake_args: -GNinja\n\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n with:\n submodules: recursive\n\n - name: Prepare for JUCE\n uses: surge-synthesizer/sst-githubactions/prepare-for-juce@main\n with:\n os: ${{ runner.os }}\n\n - name: Install Inno Setup\n uses: surge-synthesizer/sst-githubactions/install-innosetup@main\n with:\n version: \"6.7.1\"\n\n - uses: apple-actions/import-codesign-certs@v3\n if: runner.os == 'macOS' && github.event_name != 'pull_request'\n with:\n p12-file-base64: ${{ secrets.MAC_CERTS_P12 }}\n p12-password: ${{ secrets.CERT_PWD }}\n\n\n - name: Build pull request version\n if: github.event_name == 'pull_request'\n run: |\n cmake -S . -B ./build ${{ matrix.cmake_args }} -DCMAKE_BUILD_TYPE=Debug -DCOPY_AFTER_BUILD=FALSE -DGITHUB_ACTIONS_BUILD=TRUE\n cmake --build ./build --config Debug --target ${TARGET_NAME}-installer --parallel 3\n\n - name: Build and run tests\n if: github.event_name == 'pull_request'\n run: |\n cmake --build ./build --config Debug --target six-sines-test --parallel 3\n ./build/tests/six-sines-test\n\n - name: Build release version\n if: github.event_name != 'pull_request'\n run: |\n export MAC_SIGNING_CERT=\"${{ secrets.MAC_SIGNING_CERT_NAME }}\"\n export MAC_INSTALLING_CERT=\"${{ secrets.MAC_INSTALLING_CERT_NAME }}\"\n \n export MAC_SIGNING_ID=\"${{ secrets.MAC_SIGNING_ID }}\"\n export MAC_SIGNING_1UPW=\"${{ secrets.MAC_SIGNING_1UPW }}\"\n export MAC_SIGNING_TEAM=\"${{ secrets.MAC_SIGNING_TEAM }}\"\n\n cmake -S . -B ./build ${{ matrix.cmake_args }} -DCMAKE_BUILD_TYPE=Release -DCOPY_AFTER_BUILD=FALSE -DGITHUB_ACTIONS_BUILD=TRUE\n cmake --build ./build --config Release --target ${TARGET_NAME}-installer --parallel 3\n\n - name: Show Installer Directory\n run: |\n ls -l build/installer\n\n - name: Upload artifact\n if: github.event_name != 'pull_request' && runner.os != 'Linux' # We get this through docker\n uses: actions/upload-artifact@v4\n with:\n path: build/installer\n name: dawplugin-${{ matrix.name }}\n\n\n build_plugin_docker:\n name: Build - Docker Ubuntu 22\n runs-on: ubuntu-latest\n\n steps:\n - name: Checkout code\n uses: actions/checkout@v6\n with:\n submodules: recursive\n\n - name: Build in Docker\n uses: surge-synthesizer/sst-githubactions/cmake-in-docker@main\n with:\n image: ghcr.io/surge-synthesizer/sst-dockerimages/ubuntu22_gcc12:main\n username: ${{ github.actor }}\n token: ${{ secrets.GITHUB_TOKEN }}\n cmakeArgs: -DCMAKE_BUILD_TYPE=Release -GNinja -DCOPY_AFTER_BUILD=FALSE -DGITHUB_ACTIONS_BUILD=TRUE\n target: six-sines-installer\n\n - name: Show Installer Directory\n run: |\n ls -l ./build/installer\n\n - name: Upload artifact\n if: github.event_name != 'pull_request'\n uses: actions/upload-artifact@v4\n with:\n path: build/installer\n name: build-docker-linux\n\n publish-plugin-nightly:\n name: Publish Nightly\n if: ${{ github.ref == 'refs/heads/main' && github.repository_owner == 'baconpaul' }}\n runs-on: ubuntu-latest\n needs: [build_plugin, build_plugin_docker]\n steps:\n - name: Upload to Nightly\n uses: surge-synthesizer/sst-githubactions/upload-to-release@main\n with:\n tag: Nightly\n reuse_tag: true\n create_tag: false\n token: ${{ secrets.GITHUB_TOKEN }}\n release_blurb_file: resources/NightlyBlurb.md\n\n - name: Post to Discord\n uses: surge-synthesizer/sst-githubactions/discord-release-notify@main\n with:\n webhook: ${{ secrets.DISCORD_WEBHOOK }}\n tag: Nightly\n title: \"A New Six Sines Nightly is Available\"\n subtitle: \"Have fun!\"\n\n publish-plugin-release:\n name: Publish Release\n if: startsWith(github.ref, 'refs/tags/v') && github.repository_owner == 'baconpaul'\n runs-on: ubuntu-latest\n needs: [build_plugin, build_plugin_docker]\n steps:\n - name: Upload to Release\n uses: surge-synthesizer/sst-githubactions/upload-to-release@main\n with:\n tag: ${{ github.ref_name }}\n reuse_tag: false\n create_tag: true\n token: ${{ secrets.GITHUB_TOKEN }}\n\n - name: Post to Discord\n uses: surge-synthesizer/sst-githubactions/discord-release-notify@main\n with:\n webhook: ${{ secrets.DISCORD_WEBHOOK }}\n tag: ${{ github.ref_name }}\n title: \"A New Six Sines Release is Available\"\n subtitle: \"But really, what does stable mean?\"\n" }, { "path": ".gitignore", "content": "build/\n.DS_Store\n.idea/\n.vs/\ncmake-*/\nignore/\nminst*.sh\nBUILD_VERSION\nCLAUDE.md\n" }, { "path": ".gitmodules", "content": "[submodule \"libs/sst/sst-basic-blocks\"]\n\tpath = libs/sst/sst-basic-blocks\n\turl = https://github.com/surge-synthesizer/sst-basic-blocks.git\n[submodule \"libs/simde\"]\n\tpath = libs/simde\n\turl = https://github.com/simd-everywhere/simde\n[submodule \"libs/clap-libs/clap\"]\n\tpath = libs/clap-libs/clap\n\turl = https://github.com/free-audio/clap.git\n[submodule \"libs/clap-libs/clap-helpers\"]\n\tpath = libs/clap-libs/clap-helpers\n\turl = https://github.com/free-audio/clap-helpers.git\n[submodule \"libs/clap-libs/clap-wrapper\"]\n\tpath = libs/clap-libs/clap-wrapper\n\turl = https://github.com/free-audio/clap-wrapper.git\n[submodule \"libs/sst/sst-clap-helpers\"]\n\tpath = libs/sst/sst-clap-helpers\n\turl = https://github.com/surge-synthesizer/sst-clap-helpers.git\n[submodule \"libs/JUCE\"]\n\tpath = libs/JUCE\n\turl = https://github.com/juce-framework/JUCE.git\n[submodule \"libs/sst/sst-jucegui\"]\n\tpath = libs/sst/sst-jucegui\n\turl = https://github.com/surge-synthesizer/sst-jucegui.git\n[submodule \"libs/sst/sst-voicemanager\"]\n\tpath = libs/sst/sst-voicemanager\n\turl = https://github.com/surge-synthesizer/sst-voicemanager.git\n[submodule \"libs/MTS-ESP\"]\n\tpath = libs/MTS-ESP\n\turl = https://github.com/ODDSound/MTS-ESP\n[submodule \"libs/fmt\"]\n\tpath = libs/fmt\n\turl = https://github.com/fmtlib/fmt.git\n[submodule \"libs/sst/sst-cpputils\"]\n\tpath = libs/sst/sst-cpputils\n\turl = https://github.com/surge-synthesizer/sst-cpputils\n[submodule \"libs/sst/sst-plugininfra\"]\n\tpath = libs/sst/sst-plugininfra\n\turl = https://github.com/surge-synthesizer/sst-plugininfra\n[submodule \"libs/libsamplerate\"]\n\tpath = libs/libsamplerate\n\turl = https://github.com/libsndfile/libsamplerate.git\n[submodule \"libs/sst/sst-cmake\"]\n\tpath = libs/sst/sst-cmake\n\turl = https://github.com/surge-synthesizer/sst-cmake\n" }, { "path": "CMakeLists.txt", "content": "cmake_minimum_required(VERSION 3.28)\n\nset(CMAKE_MSVC_RUNTIME_LIBRARY \"MultiThreaded$<$:Debug>\")\nset(CMAKE_OSX_DEPLOYMENT_TARGET 10.15 CACHE STRING \"Build for 10.14\")\nset(CMAKE_POSITION_INDEPENDENT_CODE ON)\n\n\nproject(six-sines VERSION 1.2.0 LANGUAGES C CXX)\nset(PRODUCT_NAME \"Six Sines\")\n\n\noption(USE_SANITIZER \"Build and link with ASAN\" FALSE)\noption(COPY_AFTER_BUILD \"Will copy after build\" TRUE)\noption(BUILD_SINGLE_ONLY \"Only build the one plugin - no seven sines out\" FALSE)\n\ninclude(cmake/compile-options.cmake)\n\n## New version\ninclude(libs/sst/sst-plugininfra/cmake/git-version-functions.cmake)\nversion_from_versionfile_or_git()\nmessage(STATUS \"DISPLAY_VERSION=${GIT_IMPLIED_DISPLAY_VERSION}; COMMIT_HASH=${GIT_COMMIT_HASH}; BRANCH=${GIT_BRANCH}\")\n\n\ninclude(cmake/CmakeRC.cmake)\nfile(GLOB_RECURSE PATCHES \"resources/factory_patches/*.sxsnp\")\ncmrc_add_resource_library(${PROJECT_NAME}-patches NAMESPACE sixsines_patches ${PATCHES})\n\nfile(GLOB THEMES \"resources/factory_themes/*.sixtheme\")\ncmrc_add_resource_library(${PROJECT_NAME}-themes NAMESPACE sixsines_themes ${THEMES})\n\nfile(GLOB FONTS\n \"resources/fonts/Manrope/static/*.ttf\"\n \"resources/fonts/Anonymous_Pro/*.ttf\")\ncmrc_add_resource_library(${PROJECT_NAME}-fonts NAMESPACE sixsines_fonts ${FONTS})\n\nset(JUCE_PATH \"${CMAKE_SOURCE_DIR}/libs/JUCE\")\nadd_subdirectory(libs)\n\nadd_library(${PROJECT_NAME}-impl STATIC\n src/clap/six-sines-clap.cpp\n src/clap/six-sines-clap-entry-impl.cpp\n src/clap/preset-discovery-impl.cpp\n\n src/ui/six-sines-editor.cpp\n src/ui/spectrum-analyzer.cpp\n\n src/ui/clipboard.cpp\n src/ui/main-panel.cpp\n src/ui/main-sub-panel.cpp\n src/ui/matrix-panel.cpp\n src/ui/matrix-sub-panel.cpp\n src/ui/self-sub-panel.cpp\n src/ui/mixer-panel.cpp\n src/ui/mixer-sub-panel.cpp\n src/ui/source-panel.cpp\n src/ui/source-sub-panel.cpp\n src/ui/segmented-ratio-editor.cpp\n src/ui/macro-panel.cpp\n src/ui/macro-sub-panel.cpp\n src/ui/finetune-sub-panel.cpp\n src/ui/mainpan-sub-panel.cpp\n src/ui/playmode-sub-panel.cpp\n src/ui/settings-panel.cpp\n\n src/presets/preset-manager.cpp\n src/presets/ui-theme-manager.cpp\n\n src/dsp/sintable.cpp\n\n src/synth/synth.cpp\n src/synth/voice.cpp\n src/synth/patch.cpp\n src/synth/mod_matrix.cpp\n src/synth/macro_usage.cpp\n\n)\ntarget_include_directories(${PROJECT_NAME}-impl PUBLIC src)\ntarget_compile_definitions(${PROJECT_NAME}-impl PRIVATE\n PRODUCT_NAME=\"${PRODUCT_NAME}\"\n)\n\nif (${BUILD_SINGLE_ONLY})\n message(STATUS \"Building single plugin version only\")\n target_compile_definitions(${PROJECT_NAME}-impl PRIVATE\n CLAP_PLUGIN_COUNT=1\n )\nendif()\n\nif (WIN32)\n message(STATUS \"Activating wchar presets\")\n target_compile_definitions(${PROJECT_NAME}-impl PUBLIC USE_WCHAR_PRESET=1)\nendif()\n\ntarget_link_libraries(${PROJECT_NAME}-impl PUBLIC\n clap\n)\ntarget_link_libraries(${PROJECT_NAME}-impl PUBLIC # PW change to public since we now have tests\n simde\n clap-helpers clap-wrapper-extensions\n mts-esp-client\n fmt-header-only\n sst-basic-blocks sst-voicemanager sst-jucegui sst-cpputils\n sst-plugininfra\n sst-plugininfra::filesystem\n sst-plugininfra::tinyxml\n sst-plugininfra::strnatcmp\n sst-plugininfra::patchbase\n sst-plugininfra::version_information\n sst::clap_juce_shim sst::clap_juce_shim_headers\n juce::juce_dsp\n ${PROJECT_NAME}-patches\n ${PROJECT_NAME}-themes\n ${PROJECT_NAME}-fonts\n samplerate\n)\n\ntarget_compile_definitions(clap-wrapper-compile-options-public INTERFACE CLAP_WRAPPER_LOGLEVEL=0)\n\nmake_clapfirst_plugins(\n TARGET_NAME ${PROJECT_NAME}\n IMPL_TARGET ${PROJECT_NAME}-impl\n\n OUTPUT_NAME \"${PRODUCT_NAME}\"\n\n ENTRY_SOURCE src/clap/six-sines-clap-entry.cpp\n\n BUNDLE_IDENTIFER \"org.baconpaul.six-sines\"\n BUNDLE_VERSION ${PROJECT_VERSION}\n\n COPY_AFTER_BUILD ${COPY_AFTER_BUILD}\n\n PLUGIN_FORMATS CLAP VST3 AUV2\n\n ASSET_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_assets\n\n WINDOWS_FOLDER_VST3 TRUE\n\n # You can add a target-per-standalone you want. Syntax here is\n # target-postfix output-name clap-id\n # This allows you to make multiple standalones from a multi-plugin clap\n STANDALONE_CONFIGURATIONS\n standalone \"${PRODUCT_NAME}\" \"org.baconpaul.six-sines\"\n\n STANDALONE_MACOS_ICON \"${CMAKE_SOURCE_DIR}/resources/installer_mac/Icon.icns\"\n)\n\n\ninclude(cmake/basic_installer_clapfirst.cmake)\nadd_clapfirst_installer(\n INSTALLER_TARGET ${PROJECT_NAME}-installer\n ASSET_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/${PROJECT_NAME}_assets\n INSTALLER_PREFIX \"six-sines\"\n PRODUCT_NAME \"${PRODUCT_NAME}\"\n TARGETS\n ${PROJECT_NAME}_clap\n ${PROJECT_NAME}_vst3\n ${PROJECT_NAME}_auv2\n ${PROJECT_NAME}_standalone\n)\n\nadd_subdirectory(tests EXCLUDE_FROM_ALL)\n\n\n\n\n\n" }, { "path": "LICENSE.md", "content": "Copyright 2019-2020, Paul Walker\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n\n\n" }, { "path": "LIN_STANDALONE.md", "content": "# Linux Standalone: Code Review & Bug Analysis\n\n**Reviewed:** `libs/clap-libs/clap-wrapper/src/detail/standalone/linux/` \n**Files:** `x11_gui.h`, `x11_gui.cpp`, plus shared `standalone_host_audio.cpp`, `standalone_host_midi.cpp`, `entry.cpp` \n**Last updated:** 2026-04-04 \n**Context:** Ongoing work on the Linux standalone host for CLAP plugins. GTK path has been removed; X11 is the only GUI path.\n\n---\n\n## What Has Been Fixed\n\n| # | Fix |\n|---|-----|\n| 1 | `XOpenDisplay()` return value checked; exits with a message on failure |\n| 2 | `XInitThreads()` called before any Xlib call |\n| 3 | `MapNotify` handler guards `plugin` and `_ext._gui` before dereferencing |\n| 4 | GTK path removed entirely; X11 is unconditional on Linux |\n| 5 | MIDI port open failure now caught per-port; loop continues on error |\n| 6 | `adjust_size()` adjusted values are used for window creation |\n| 7 | `epoll_fd` set to -1 after close in `shutdown()` so the guard in `unregister_timer` fires correctly |\n| 8 | `gui->destroy()` called in `X11Gui::shutdown()` before epoll/display teardown, fixing timer unregistration crash on exit |\n\n---\n\n## X11 GUI: Remaining Issues\n\n### Window Position Hard-Coded\n\n**File:** `x11_gui.cpp` — `XCreateSimpleWindow` call in `setPlugin()`\n\nAlways opens at `(10, 10)`. No centering, no saved position restore.\n\n---\n\n### Window Size Locked via Size Hints\n\n**File:** `x11_gui.cpp` — `resetSizeTo()`\n\n```cpp\nhints->min_width = hints->max_width = w;\nhints->min_height = hints->max_height = h;\n```\n\nMin and max hints are set to the same value on every resize. This prevents the window manager from allowing user-initiated resizing even for plugins that support `can_resize()`. To allow resizing, only `PSize` / `PAspect` hints should be set; min/max should be omitted or set to sensible bounds.\n\n---\n\n### `set_parent()` Only Called on `MapNotify`\n\n**File:** `x11_gui.cpp` — `runloop()`\n\nThe plugin's `set_parent()` and `show()` are deferred until the window receives a `MapNotify` event. This is fine for most plugins but means the plugin has no parent window during the window-creation phase. Plugins that use `set_parent` to initialize their renderer may produce a blank frame on first display.\n\n---\n\n### No Wayland Support\n\nNeither XWayland-fallback nor native Wayland. On a Wayland-only session `XOpenDisplay` will fail (caught and exited cleanly now), but the user gets no hint about setting `DISPLAY` or `GDK_BACKEND=x11`. A more helpful exit message could suggest `DISPLAY=:0` or the XWayland socket.\n\n---\n\n### Epoll Error Handling: Failures Logged but Not Propagated\n\n`epoll_ctl` failures in `register_fd`, `register_timer`, `setPlugin` are logged and return false, but callers generally ignore the return value. A failed epoll registration means the corresponding timer or fd will never fire, silently breaking plugin functionality.\n\n---\n\n### Magic Numbers\n\n`nextTimerId` starts at `2112`, epoll max events is `256`, epoll timeout is `50ms`. None are named constants.\n\n---\n\n### No RAII for X11 Resources\n\n`XCloseDisplay`, `XFree`, timerfd closes, and epoll fd close are all manual. An exception or early return will leak resources. The timer fds in `timerIdToFd` are not closed in `shutdown()` if any are still registered.\n\n---\n\n## Audio Backend: ALSA / JACK / PipeWire\n\n### The Core Problem\n\n**File:** `standalone_host_audio.cpp:60`\n\n```cpp\nsetAudioApi(RtAudio::Api::UNSPECIFIED);\n```\n\n`RtAudio::Api::UNSPECIFIED` lets RtAudio auto-select from whichever backends were compiled in. The selection priority in RtAudio is approximately JACK → ALSA → PulseAudio, but in practice **ALSA is almost always chosen** even when a JACK daemon is running, because RtAudio's auto-select logic does not reliably detect a running JACK server. This is the confirmed cause of the user-reported \"only binds to ALSA, doesn't show JACK\" symptom.\n\nThe compiled-in backends are controlled by CMake options in `wrap_standalone.cmake` (inherited from RtAudio's own CMakeLists):\n\n```cmake\noption(RTAUDIO_API_ALSA \"Build ALSA API\" ${LINUX})\noption(RTAUDIO_API_PULSE \"Build PulseAudio API\" ${pulse_FOUND})\noption(RTAUDIO_API_JACK \"Build JACK audio server API\" ${HAVE_JACK})\n```\n\nJACK support is only compiled in when `HAVE_JACK` is true at configure time (i.e., JACK headers are present on the build machine). On a build machine without JACK headers the JACK backend is silently absent from the binary.\n\n### PipeWire\n\nPipeWire is **not explicitly configured** — there is no `RTAUDIO_API_PIPEWIRE` option. PipeWire provides:\n\n- An **ALSA compatibility layer** (`pipewire-alsa`) — when active, ALSA device enumeration goes through PipeWire transparently. This usually works without any code changes.\n- A **JACK compatibility layer** (`pipewire-jack`) — replaces `libjack` with a PipeWire shim. If the build machine has `pipewire-jack` installed in place of real JACK, the JACK backend will talk to PipeWire's JACK server. This also generally works.\n- A **native PipeWire RtAudio backend** exists in newer RtAudio versions (`RtAudio::Api::LINUX_PIPEWIRE`). This is not enabled in the current build and would require adding `RTAUDIO_API_PIPEWIRE` to the CMake options.\n\nIn short: on a system running PipeWire with the ALSA and JACK compatibility layers active, the existing code works but the user gets ALSA latency characteristics rather than PipeWire's low-latency graph scheduling. For most users this is acceptable.\n\n### How to Address the JACK/API Selection Problem\n\nThe `StandaloneHost` already has all the infrastructure needed:\n\n- `getCompiledApi()` — returns `std::vector` of built-in backends\n- `setAudioApi(RtAudio::Api)` — switches the active backend\n- `audioApi`, `audioApiName`, `audioApiDisplayName` — current state\n\nWhat is missing is a way to surface this to the user. The two practical options are:\n\n**Option A — Command-line flag (minimal, recommended first step)**\n\nParse a `--audio-api ` argument in `wrapasstandalone.cpp` before calling `mainStartAudio()`. Map the name to an `RtAudio::Api` value and call `getStandaloneHost()->setAudioApi(...)`. Example mapping:\n\n| Flag value | `RtAudio::Api` |\n|------------|---------------|\n| `alsa` | `LINUX_ALSA` |\n| `jack` | `UNIX_JACK` |\n| `pulse` | `LINUX_PULSE` |\n| `pipewire` | `LINUX_PIPEWIRE` (if compiled) |\n\nAdd `--list-audio-apis` to print the compiled-in options and exit. Use `getCompiledApi()` for the list.\n\n**Option B — Prefer JACK automatically when the server is reachable**\n\nBefore defaulting to `UNSPECIFIED`, check whether JACK is compiled in and whether a JACK server is running:\n\n```cpp\n// Pseudo-code\nauto apis = getCompiledApi();\nif (std::find(apis.begin(), apis.end(), RtAudio::Api::UNIX_JACK) != apis.end())\n{\n // Try JACK first; fall back to UNSPECIFIED if stream open fails\n setAudioApi(RtAudio::Api::UNIX_JACK);\n}\n```\n\nRtAudio will return an error when opening the stream if no JACK server is running, so the fallback path is safe.\n\n### Device Enumeration and Selection\n\n- **No device selection UI or flag.** `getDefaultInputDevice()` / `getDefaultOutputDevice()` are used unconditionally. On systems where the default device is a USB headset or HDMI output this produces confusing behaviour. A `--audio-device ` flag (matched against `getDeviceNames()`) would address this.\n- **Default device IDs not validated.** If the default device ID returned is 0 and no device 0 exists for the selected API, `openStream` will fail with a potentially cryptic error.\n- **No input device selection.** `startAudioThread()` always passes the default input device. Plugins with audio inputs have no way to select their source.\n\n### Audio Backend: Remaining Code Issues\n\n---\n\n### Channel Count Hard-Coded to 2 (Stereo Only)\n\n**File:** `standalone_host_audio.cpp:96, 101`\n\n```cpp\nstartAudioThreadOn(in, 2, ..., out, 2, ...);\n```\n\nInput and output are always opened as stereo. Plugins with mono or multi-channel buses will get the wrong channel count. `clapProcess` also asserts `inputChannelByBus[inp] == 2` and `outputChannelByBus[oup] == 2`.\n\n---\n\n### Buffer Size Defaults to 256, Not Device-Queried\n\n**File:** `standalone_host_audio.cpp:246-248`\n\n```cpp\nif (currentBufferSize == 0)\n{\n currentBufferSize = 256;\n}\n```\n\n`currentBufferSize` can be set externally before `startAudioThread()` is called, but there is no UI or command-line path to do so. The default of 256 may be wrong for the selected device or API (JACK has its own period size; ALSA may not support 256 frames on all hardware).\n\n---\n\n### Xrun Detection Callback Is Empty\n\n**File:** `standalone_host_audio.cpp:24-26`\n\n```cpp\nif (status)\n{\n}\n```\n\nRtAudio passes a non-zero `status` on xrun (underflow/overflow). The callback body is empty — xruns are silently dropped. `rtaErrorCallback` does catch `RTAUDIO_OUTPUT_UNDERFLOW` and `RTAUDIO_INPUT_OVERFLOW` separately, but only logs the first occurrence.\n\n---\n\n### `stopAudioThread()` Busy-Waits Up to 10 Seconds\n\n**File:** `standalone_host_audio.cpp:306-310`\n\n```cpp\nfor (auto i = 0; i < 10000 && !finishedRunning; ++i)\n{\n std::this_thread::sleep_for(1ms);\n}\n```\n\nWaits for the audio callback to set `finishedRunning`. If the stream stalls or the callback never fires again after `running = false`, this silently times out after 10 seconds and then calls `stopStream()` anyway. No log or error is emitted on timeout.\n\n---\n\n### `getSampleRates()` Has a Dead-Code Bug\n\n**File:** `standalone_host_audio.cpp:150-157`\n\n```cpp\nauto samplesRates{rtaDac->getDeviceInfo(audioInputDeviceID).sampleRates}; // unused\n\nfor (auto &sampleRate : rtaDac->getDeviceInfo(audioInputDeviceID).sampleRates) // queried again\n```\n\nThe device info is fetched twice; the first result (`samplesRates`) is never read.\n\n---\n\n### `getBufferSizes()` Returns a Hard-Coded List\n\n**File:** `standalone_host_audio.cpp:164-166`\n\n```cpp\nstd::vector res{16, 32, 48, 64, 96, 128, 144, 160, 192, 224, 256, 480, 512, 1024, 2048, 4096};\n```\n\nNot queried from the device. RtAudio doesn't expose valid buffer sizes for a device, so this is largely unavoidable — but the list includes non-power-of-two sizes (48, 96, 144, 160, 192, 224, 480) that many ALSA and JACK drivers will reject.\n\n---\n\n## MIDI: Remaining Issues\n\n### Fatal Exit on MIDI Init Failure\n\n**File:** `standalone_host_midi.cpp:25-29`\n\n```cpp\ncatch (RtMidiError &error)\n{\n error.printMessage();\n exit(EXIT_FAILURE);\n}\n```\n\nIf creating the initial `RtMidiIn` (used only to count available ports) fails, the process exits hard. This kills the standalone even when MIDI is not needed. Should log a warning and continue with `numMidiPorts = 0`.\n\n---\n\n### `RtMidiIn` Created Twice Per Session\n\n**File:** `standalone_host_midi.cpp:22-23, 36`\n\nA temporary `RtMidiIn` is created just to call `getPortCount()`, then discarded. A separate instance is created for each port in the loop. The first instance is wasted. This can cause issues on some ALSA configurations where creating an `RtMidiIn` registers a client with the sequencer.\n\n---\n\n### All Ports Opened Unconditionally\n\nThere is no mechanism to select which MIDI inputs to use. Every available port is opened. On systems with many virtual/loopback ALSA ports this can produce unwanted MIDI loops.\n\n---\n\n### 3-Byte Message Cap; No SysEx\n\n**File:** `standalone_host_midi.cpp:53`\n\n```cpp\nif (nBytes <= 3)\n```\n\nMessages longer than 3 bytes are silently discarded. SysEx (which can be arbitrarily long) is never forwarded to the plugin.\n\n---\n\n### No Timestamp Preservation\n\nMIDI timestamps from the RtMidi callback (`deltatime`) are ignored. All events are queued with `header.time = 0`, meaning they are all presented to the plugin at the start of each audio block regardless of when they arrived.\n\n---\n\n## Summary Table\n\n| # | Item | Severity | Status |\n|---|------|----------|--------|\n| 1 | `XOpenDisplay()` not checked | Critical | Fixed |\n| 2 | No `XInitThreads()` | Critical | Fixed |\n| 3 | `MapNotify` null dereference | Critical | Fixed |\n| 4 | GTK `std::terminate()` on Wayland | High | Fixed (GTK removed) |\n| 5 | MIDI port open aborts loop | High | Fixed |\n| 6 | `adjust_size()` result discarded | Medium | Fixed |\n| 7 | `epoll_fd` not cleared to -1 after close | Medium | Fixed |\n| 8 | Timer unregistration crash on exit | Critical | Fixed |\n| — | `RtAudio::UNSPECIFIED` misses JACK; no API/device selection | High | Open |\n| — | Channel count hard-coded to stereo | High | Open |\n| — | Fatal exit if MIDI init fails | Medium | Open |\n| — | Buffer size defaults to 256, not configurable | Medium | Open |\n| — | Window size locked via min=max hints | Medium | Open |\n| — | `RtMidiIn` created twice | Low | Open |\n| — | All MIDI ports opened unconditionally | Low | Open |\n| — | No SysEx; 3-byte message cap | Low | Open |\n| — | No MIDI timestamp preservation | Low | Open |\n| — | Xrun callback body empty | Low | Open |\n| — | `stopAudioThread` 10s busy-wait, no timeout log | Low | Open |\n| — | `getSampleRates()` double-fetches device info | Low | Open |\n| — | Window position hard-coded to (10, 10) | Low | Open |\n| — | Leaks timer fds on shutdown if not unregistered | Low | Open |\n| — | No Wayland support or helpful error hint | Low | Open |\n" }, { "path": "MAC_STANDALONE.md", "content": "# macOS Standalone: Code Review & Bug Analysis\n\n**Reviewed:** `libs/clap-libs/clap-wrapper/src/detail/standalone/macos/` \n**Files:** `AppDelegate.h`, `AppDelegate.mm`, `StandaloneFunctions.mm`, `Info.plist.in`, `MainMenu.xib`, plus shared `standalone_host_audio.cpp`, `standalone_host_midi.cpp`, `entry.cpp` \n**Date:** 2026-04-03 \n**Context:** Critical code review of the macOS standalone host for CLAP plugins.\n\n---\n\n## Architecture Summary\n\nThe macOS standalone uses a conventional Cocoa application structure:\n\n1. **Entry point** — `wrapasstandalone.mm` calls `NSApplicationMain()`\n2. **XIB** — `MainMenu.xib` loads the window and wires `ClapWrapperAppDelegate` as the app delegate\n3. **App delegate** — `AppDelegate.mm` drives all plugin, GUI, and audio setup from `applicationDidFinishLaunching:` via a 0.001 s one-shot timer\n4. **Plugin/audio** — `entry.cpp` and shared `standalone_host_*.cpp` own the plugin instance and RtAudio/RtMidi streams\n\n---\n\n## Critical Bugs\n\n### ~~Bug 1 — Retina Scale Factor Hardcoded to 1.0~~ (RETRACTED)\n\n**File:** `AppDelegate.mm` (inside `doSetup`)\n\n```objc\nui->set_scale(p, 1); // harmless; ignored per CLAP spec for Cocoa\n```\n\nThis was originally flagged as critical, but the CLAP GUI spec explicitly states for `CLAP_WINDOW_API_COCOA`:\n\n> *uses logical size, don't call clap_plugin_gui->set_scale()*\n\nCocoa plugins work in logical pixels and handle their own Retina scaling internally (via NSView backing scale APIs). The `set_scale()` call is specified to be ignorable — a conforming plugin returns `false` and does nothing. The `1.0` passed here is a harmless defensive call in case a non-conforming plugin needs a nudge, but it is not the cause of any rendering problem.\n\n**Retina rendering quality is entirely the plugin's responsibility under Cocoa.** The host's only obligation is to add `NSHighResolutionCapable` to the Info.plist (Bug 2), which opts the process into high-resolution mode so the window system does not pre-scale the backing store away from the plugin.\n\n---\n\n### Bug 2 — `NSHighResolutionCapable` Missing from Info.plist (CRITICAL — compounds Bug 1)\n\n**File:** `Info.plist.in`\n\nWithout `NSHighResolutionCapable = true`, macOS opts the app into legacy low-resolution mode and will not pass a 2× backing scale through the window system at all. The plugin GUI renders in a blurry, scaled-up bitmap regardless of what `set_scale()` is told.\n\nRequired addition to `Info.plist.in`:\n\n```xml\nNSHighResolutionCapable\n\n```\n\n---\n\n### Bug 3 — Spinlock in the Audio Callback (HIGH — causes audio dropouts)\n\n**File:** `standalone_host.cpp`\n\n```cpp\nClapWrapper::detail::shared::SpinLockGuard processLockGuard(processLock);\n```\n\nThe RtAudio callback acquires a spinlock on every audio block. If the main thread holds this lock while doing any GUI work, the audio thread busy-waits — consuming a full CPU core and causing glitches, dropouts, and system unresponsiveness. This is a well-known anti-pattern in real-time audio code. Spinlocks are never safe in an audio callback path. The correct approach is to use lock-free atomic flags or message queues to communicate state changes without blocking the audio thread.\n\n---\n\n### Bug 4 — No Error Checking After `ui->create()` (HIGH — silent invisible window)\n\n**File:** `AppDelegate.mm` (`doSetup`)\n\n```objc\nif (!ui->is_api_supported(p, CLAP_WINDOW_API_COCOA, false))\n LOGINFO(\"[WARNING] GUI API not supported\");\n\nui->create(p, CLAP_WINDOW_API_COCOA, false); // return value ignored\nui->set_scale(p, 1); // return value ignored\nui->get_size(p, &w, &h); // if this returns 0,0 → invisible window\nui->set_parent(p, &win); // return value ignored\nui->show(p); // return value ignored\n```\n\nIf `create()` fails, every subsequent call operates on undefined state. If `get_size()` returns `(0, 0)`, `setContentSize:` produces a zero-size window — visible in the Dock but showing nothing. None of these return values are checked, and no error is surfaced to the user.\n\n---\n\n### Bug 5 — MIDI Queue Missing Memory Fence (HIGH — data races on Apple Silicon)\n\n**File:** `standalone_host_midi.cpp` / shared `fixedqueue`\n\nThe lock-free queue used to pass MIDI events from the RtMidi callback thread to the audio thread uses an atomic index but no explicit memory fence between the element write and the index update:\n\n```cpp\n_elements[_head] = *val; // array write\n_head = (_head + 1) & _wrapMask; // atomic index update — but no fence before this\n```\n\nOn Apple Silicon (ARM), the store-release guarantee on `_head` does not order the preceding array write without an explicit `std::atomic_thread_fence(std::memory_order_release)` between them. The audio thread can read a partially-written MIDI event. This can manifest as wrong note values, stuck notes, or silent corruption.\n\n---\n\n### Bug 6 — Memory Leak in AudioSettingsWindow (MEDIUM)\n\n**File:** `AppDelegate.mm` (Audio Settings handler)\n\n```objc\nauto *window = [[AudioSettingsWindow alloc]\n initWithContentRect:windowRect\n styleMask:...\n backing:NSBackingStoreBuffered\n defer:NO];\n```\n\nIf ARC is not enabled (the Objective-C++ mix in this project makes it easy to inadvertently compile without ARC), this `alloc/init` window is never released. Each time the user opens the Audio Settings panel, a new `AudioSettingsWindow` is allocated and leaked. The same pattern is used for the `NSAlert` instances at multiple sites (plugin load failure, audio error dialogs).\n\n---\n\n## Setup Timing Issues\n\n### The 0.001 s Deferred Setup\n\n**File:** `AppDelegate.mm` (`applicationDidFinishLaunching:`)\n\n```objc\n[NSTimer scheduledTimerWithTimeInterval:0.001\n target:self\n selector:@selector(doSetup)\n userInfo:nil\n repeats:NO];\n```\n\nAll plugin creation, GUI embedding, and audio initialization happen inside this 0.001 s timer callback. The intent is to let the run loop complete its first spin before doing work. In practice, 1 ms is not a meaningful guarantee — on a loaded system this fires at an arbitrary time. More significantly:\n\n- The window is shown (`orderFrontRegardless`) **before** the plugin GUI is embedded. If setup is slow the user briefly sees an empty window.\n- If setup fails partway through, the window remains visible with no content and no error.\n\n### Run Loop Mode for the Callback Timer\n\n**File:** `AppDelegate.mm`\n\n```objc\n[runLoop addTimer:self.requestCallbackTimer forMode:NSDefaultRunLoopMode];\n```\n\nThe timer that handles `on_main_thread` plugin callbacks is added to `NSDefaultRunLoopMode` only. During live window resizing or menu tracking, macOS switches the run loop to `NSEventTrackingRunLoopMode`. The callback timer does not fire in that mode, so plugin `on_main_thread` callbacks are silently delayed until the user stops interacting with the UI.\n\nFix: use `NSRunLoopCommonModes` instead.\n\n---\n\n## Window Sizing\n\n### Variable Shadowing in Resize Logic\n\n**File:** `AppDelegate.mm` (`windowWillResize:toSize:`)\n\n```objc\nNSWindow *w = sender; // ← outer 'w'\n// ...\nuint32_t w, h; // ← inner 'w' shadows NSWindow *w\nplugin->_ext._gui->get_size(plugin->_plugin, &w, &h);\n```\n\nThe `uint32_t w` shadows the `NSWindow *w` declared a few lines above. This does not cause a crash in the current code path because the outer `w` is not used after the shadow is introduced, but it is a maintenance hazard and suggests the resize logic was written hastily.\n\n### No Bounds Checking on Plugin-Reported Size\n\n`get_size()` is called without validating that the returned width and height are sensible (non-zero, not absurdly large). A misbehaving plugin could return `(0, 0)` or `(65535, 65535)`, with no guard.\n\n---\n\n## Error Handling\n\nMultiple critical operations have no user-visible error path:\n\n| Site | Failure Mode | Current Handling |\n|------|--------------|-----------------|\n| Plugin entry not found | No plugin loaded | `LOGINFO` only, window shown empty |\n| `plugin->create()` fails | Null plugin pointer used | `LOGINFO` only |\n| `ui->create()` fails | GUI in undefined state | Not checked at all |\n| `ui->get_size()` returns (0,0) | Zero-size window | Not checked |\n| `mainStartAudio()` fails | No audio | Not checked; user hears nothing |\n| RtAudio stream open fails | Logged, stream closed | No dialog; audio silently absent |\n\n---\n\n## MIDI Notes\n\n- **`startMIDIThread()`** is a misnomer — it runs on the main thread. RtMidi callbacks fire on an internal RtMidi thread, not a thread this code controls.\n- **MIDI output** is explicitly noted as unimplemented: `LOGINFO(\"[WARNING] Midi Output not supported yet\")`\n- **SysEx** is limited to 3 bytes across all platforms (shared code).\n- **No port selection**: all available MIDI input ports are opened unconditionally.\n\n---\n\n## Info.plist Issues\n\n| Key | Status | Impact |\n|-----|--------|--------|\n| `NSMicrophoneUsageDescription` | Present | Correct — needed for audio input permission |\n| `NSHighResolutionCapable` | **Missing** | Retina rendering broken (see Bug 2) |\n| `NSSupportsAutomaticGraphicsSwitching` | Missing | App may hold discrete GPU when not needed |\n\n---\n\n## Incomplete / TODO Items in Shared Code\n\n| Location | Note |\n|----------|------|\n| `standalone_host.cpp:160` | `// TODO cleaner` around main bus index logic |\n| `standalone_host.cpp:179` | Same TODO, duplicated |\n| `standalone_host_audio.cpp:244` | `\"[WARNING] Hardcoding frame size to 256 samples for now\"` — buffer size is not configurable |\n| `standalone_host_midi.cpp:103` | `\"[WARNING] Midi Output not supported yet\"` |\n| `AppDelegate.h:7` | Commented-out `AudioSettingsWindowDelegate` — unclear if still planned |\n\n---\n\n## Summary Table\n\n| # | Bug | Severity | Impact |\n|---|-----|----------|--------|\n| 1 | `set_scale()` call with Cocoa | ~~Critical~~ N/A | Retracted — Cocoa spec says don't call `set_scale()`; plugin ignores it per spec |\n| 2 | `NSHighResolutionCapable` missing from plist | Critical | macOS forces low-res mode; plugin has no chance to render at Retina resolution |\n| 3 | Spinlock in audio callback | High | Audio dropouts during any GUI interaction |\n| 4 | No error checking after `ui->create()` | High | Silent invisible window on any GUI failure — *(Done)* |\n| 5 | MIDI queue missing memory fence | High | Data races / corruption on Apple Silicon |\n| 6 | `AudioSettingsWindow` leaked each open | Medium | Growing memory use over session |\n| 7 | Callback timer on `NSDefaultRunLoopMode` only | Medium | `on_main_thread` callbacks drop during resize/menus — *(Done)* |\n| 8 | Zero-size window if `get_size()` returns (0,0) | Medium | Window exists but shows nothing — *(Done)* |\n| 9 | No user-visible audio init error | Medium | Silent audio failure |\n| 10 | Variable shadowing in resize handler | Low | Maintenance hazard, not a current crash |\n| 11 | 0.001 s deferred setup is fragile | Low | Window briefly blank; bad failure UX |\n| 12 | `NSSupportsAutomaticGraphicsSwitching` missing | Low | May keep discrete GPU alive |\n\n---\n\n## Recommended Fixes (Priority Order)\n\n1. **Add `NSHighResolutionCapable = true`** to `Info.plist.in` immediately. *(Done)*\n2. ~~**Fix `set_scale()`**~~ — retracted; `set_scale()` must not be called for `CLAP_WINDOW_API_COCOA` per the CLAP spec. The existing call at `1.0` is harmless but should not be changed to read `backingScaleFactor`.\n3. **Remove the spinlock from the audio callback** — use atomic flags or a lock-free ring buffer for plugin ↔ audio-thread state.\n4. **Add error checking** after `ui->create()`, `ui->set_parent()`, and `mainStartAudio()`, with user-facing `NSAlert` dialogs. *(Done)*\n5. **Add a memory fence** in the MIDI queue between the element write and the index update.\n6. **Switch the callback timer** to `NSRunLoopCommonModes`. *(Done)*\n7. **Audit ARC coverage** — ensure `NSAlert` and `AudioSettingsWindow` instances are properly released.\n8. **Validate sizes** returned by `ui->get_size()` before calling `setContentSize:`. *(Done)*\n9. **Rename `startMIDIThread()`** and document which thread MIDI callbacks fire on." }, { "path": "README.md", "content": "# Six Sines\n\nSix Sines is a small synthesizer which explores audio rate inter-modulation of signals.\nSome folks would call it \"an FM synth\" but it's really a bit more PM/AM, and anyway that's\nkinda not the point.\n\nIf you want to read a manual, [go here](doc/manual.md)\n\nIf you want to download a release or recent version, [go here](https://github.com/baconpaul/six-sines/releases). We have versioned\nreleases on that download page and additionally provide a [nightly](https://github.com/baconpaul/six-sines/releases/tag/Nightly) with the latest code at all times.\n\nIn March 2025, we released version 1.1. You can read the changelog [here](doc/changelog.md)\n\nAnd please read the [acknowldgements](doc/ack.md) for a list of thanks.\n\n## Hey are there any demos of this?\n\nKinsey Dulcet, who designed many of the factory patches, has a demo\ntrack showing the more-80s-inspired sounds you can make. She's also\nworking on a more 2020s inspired version, and that's pretty exciting!\n\n[Listen to Kinsey's track, 'Retrocade Nights'](https://soundcloud.com/kinseydulcet/retrocade-nights-six-sines-demo)\n\nThe [One Synth Challenge](https://www.kvraudio.com/forum/viewtopic.php?t=618178) community used Six Sines as we were developing\n1.1 to host OSC 192, and the results are amazing. You can hear all the entries\nhere, made entirely with Six Sines and built in DAW effects.\n\n[Listen to the One Synth Challenge Playlist](https://soundcloud.com/kvrosc/sets/one-synth-challenge-192-six)\n\n## Background\n\nThe project exists for a few reasons\n\n1. At the end of 2024, I was in a bit of a slump dev-wise for a variety of reasons and wanted a \n small project to sort of jump-start me for 2025. I had watched [Newfangled Dan ship obliterate](https://www.newfangledaudio.com/obliterate) from idea to loved plugin in November, and I thought hey can I do the same in December\n2. As I wrapped up 2024, I also wanted to take account of how well our project to factor code into libraries\nwent and make a sort of todo-list of why it was hard to build a synth. This includes some \ninsights into the sst- libraries and the clap-wrapper\n2. Another indie audio dev, who asked to not be named here in case this sucks, which it doesn't I dont think,\nsaid to a group of users in a discord in an offhand way something like \"the least commercially viable thing is\na 6 op full matrix pure FM synth\". So my response was 1. implement one, 2. give it away, 3 ???, 4. you know the meme.\n\n4. It seemed fun, and I thought some people would download it.\n5. It had been in my head for a while and I wanted to hear how it sounded\n\n## How to build this software\n\nyour system needs cmake and a c++20 compatible compiler.\n\nWe provide pre-build windows, linux, and macOS binaries at the [release page](https://github.com/baconpaul/six-sines/releases) but especially on \nLinux, you may want to build it yourself, since we use ubuntu 24 machines and linux doesn't really exist.\n\nSo to build it, do the standard\n\n```aiignore\ngit clone https://github.com/baconpaul/six-sines\ncd six-sines\ngit submodule update --init --recursive\ncmake -Bignore/build -DCMAKE_BUILD_TYPE=Release\ncmake --build ignore/build --config Release --target six-sines_all\n```\n\nvarious plugins and executables will now be scattered around ignore/build.\n\n## I found a bug or want a feature added\n\nSo this was really a one month sprint. And its pretty self contained thing. So feature requests\nare things I may say no to. But open an issue and chat. Or send a PR!\n\nBugs especially let me know.\n\nBut remember, \"Programming an FM/PM/RM synth is hard\" is not a bug in six-sines!\n\n## Why is this a `baconpaul` and not a `surge-synthesizer` project\n\nWell you know. It's not quite up to snuff for a surge project. And its pretty idiosyncratic.\nI may do a few more side quest projects in 2025. Lets see.\n\n## Some Credits\n\nMembers of the surge synth team helped with pre-release\ntesting. Large parts of the factory patch library\nat first release were authored by Jacky Ligon and Kinsey\nDulcet, and large parts of the workflow design\nimprovements came from Andreya and EvilDragon. \nThanks folks!\n\nWe use loads of open source software of course\nincluding all the sst libraries, clap and\nthe clap wrapper (which itself includes \nvst3, ausdk, rtaudio, rtmidi, and more).\nThe definitive list right now comes from \nthe source directory.\n" }, { "path": "WIN_STANDALONE.md", "content": "# Windows Standalone: Code Review & Bug Analysis\n\n**Reviewed:** `libs/clap-libs/clap-wrapper/src/detail/standalone/windows/` \n**Files:** `windows_standalone.cpp`, `windows_standalone.h`, `windows_standalone.manifest`, `wrapasstandalone_windows.cpp` \n**Date:** 2026-04-03 \n**Context:** Two user reports of the standalone not displaying its UI on Windows.\n\n---\n\n## Reported Symptoms\n\n> \"I start the .exe, it opens (with no visible UI) and lurks in the taskbar, even reacting to my MIDI keyboard. If I try and 'maximize it back' by clicking, after a couple of clicks, it crashes (I never see the UI anymore).\"\n\n> \"I'm randomly running into problems with the windows standalone version — it's not opening the window again, unless I switch to maximised Window and back to normal window again within the link properties.\"\n\nThe second workaround — setting the shortcut's \"Run:\" property to \"Maximized\" and then back to \"Normal\" — is a significant diagnostic clue (see Hypothesis B below).\n\n---\n\n## Architecture Summary\n\nThe implementation uses a classical Win32 approach:\n\n- **`Window`** — base class wrapping an `HWND` with a lambda-based message dispatch table\n- **`Plugin : Window`** — extends `Window` with CLAP plugin GUI embedding, audio/MIDI setup, and the system-menu settings UI\n- **`Settings : Window`** — a separate child window for audio/MIDI configuration\n- The message loop (`run()`) is a plain `GetMessage` / `TranslateMessage` / `DispatchMessage` loop\n- CLAP GUI embedding: `plugin.gui->set_parent()` is called with the main `HWND`; JUCE (or whatever the plugin uses internally) creates child windows inside it\n\n---\n\n## Confirmed Bugs\n\n### Bug 1 — `nCmdShow` Completely Discarded (HIGH — explains Symptom 2 workaround)\n\n**File:** `wrapasstandalone_windows.cpp:3`\n\n```cpp\nint WINAPI wWinMain(HINSTANCE, HINSTANCE, PWSTR, int /* nCmdShow */)\n```\n\n`nCmdShow` is received from Windows but deliberately commented out and never used. Later, `activate()` unconditionally calls:\n\n```cpp\n// windows_standalone.cpp:341\n::ShowWindow(hwnd.get(), SW_NORMAL);\n```\n\nOn Windows, the shell sets `STARTUPINFO.wShowWindow` (e.g., `SW_SHOWMAXIMIZED`) when a shortcut has a \"Run:\" override, and the OS uses this to override the parameter on **the very first `ShowWindow` call** for that process — but only if `nCmdShow` was originally respected and passed through. Since the code always passes `SW_NORMAL`, it bypasses the OS's ability to start the window in a different state.\n\nMore importantly: the correct first-show parameter (from `nCmdShow`) should be passed so that Windows can apply any saved placement the shell has established for the application. Ignoring it can cause the window to appear at unexpected sizes or positions.\n\nThe fix for Symptom 2's workaround is explained by this: setting the shortcut to \"Maximized\" causes `SW_SHOWMAXIMIZED` to be passed via `STARTUPINFO`, which the OS **does** honour on the first `ShowWindow` call regardless of the parameter (this is a Windows-documented behaviour). The maximized state overrides any bad saved position, and \"toggling back to Normal\" updates the stored shortcut state — after which the window opens correctly because maximizing has forced a new, valid saved position.\n\n---\n\n### Bug 2 — `adjustSize(0, 0)` if `get_size()` Returns Zero (HIGH — explains Symptom 1)\n\n**File:** `windows_standalone.cpp:1109–1113`\n\n```cpp\nPosition pluginSize;\nplugin.gui->get_size(plugin.plugin, &pluginSize.width, &pluginSize.height);\nlog(\"{}, {}\", pluginSize.width, pluginSize.height);\nadjustSize(pluginSize.width, pluginSize.height);\n```\n\n`get_size()` is called immediately after `create()` and `set_scale()`, before `set_parent()`. If the plugin has not yet computed its layout at this point (e.g., it requires a visible parent or defers layout until `set_parent()` is processed), it may return `(0, 0)`. `adjustSize(0, 0)` then sets the window to zero size:\n\n```cpp\n// windows_standalone.cpp:359–373\nvoid Window::adjustSize(uint32_t width, uint32_t height) {\n ::RECT rect{ 0, 0, width, height }; // → {0, 0, 0, 0}\n // AdjustWindowRectExForDpi adds border/chrome, but with 0 inner size\n // the result is just the chrome, possibly sub-pixel or clipped to zero\n ::SetWindowPos(hwnd.get(), nullptr, 0, 0,\n (rect.right - rect.left), (rect.bottom - rect.top),\n SWP_NOZORDER | SWP_NOACTIVATE | SWP_NOMOVE);\n}\n```\n\nThe window exists and has a taskbar entry, but is effectively invisible. Audio and MIDI run on their own threads and work fine. Forcing the window to maximized forces a new size to be negotiated via `onRequestResize`, which is why that workaround helps.\n\n---\n\n### Bug 3 — `set_parent()` Called on a Hidden Parent Window (MEDIUM — may cause rendering issues)\n\n**File:** `windows_standalone.cpp:1115–1116`\n\n```cpp\nclap_window clapWindow{CLAP_WINDOW_API_WIN32, static_cast(hwnd.get())};\nplugin.gui->set_parent(plugin.plugin, &clapWindow);\n```\n\n`set_parent()` is called before `activate()` (line 1162). The parent `HWND` has not yet been shown (`WS_VISIBLE` is not in the initial `CreateWindowExW` style). JUCE (or any Win32-based plugin) creates its child windows into a hidden parent. When the parent is later made visible, child window painting can be deferred or in a stale state depending on how the plugin handles this. Some runtimes may need `ShowWindow` + `UpdateWindow` on the child explicitly after reparenting.\n\n---\n\n### Bug 4 — `hwnd.reset()` in `WM_CLOSE` Causes Dangling References (HIGH — explains crash)\n\n**File:** `windows_standalone.cpp:328–333`\n\n```cpp\nif (msg == WM_CLOSE) {\n self->hwnd.reset(); // → DestroyWindow() called immediately\n return 0; // → suppresses DefWindowProc\n}\n```\n\n`hwnd` is a `wil::unique_hwnd`. Calling `.reset()` invokes `DestroyWindow()` synchronously from within the window procedure. This is unusual and dangerous:\n\n1. `DestroyWindow()` causes the OS to send `WM_DESTROY` and `WM_NCDESTROY` — while still inside the `WM_CLOSE` handler.\n2. The `WM_DESTROY` handler (line 994) calls `plugin.gui->destroy()`, `mainFinish()`, and `quit()`. The plugin GUI is being destroyed while the parent HWND is potentially mid-message.\n3. After `hwnd.reset()`, `hwnd.get()` returns `nullptr`. Any subsequent message handler, timer callback, or queued paint that calls `hwnd.get()` will crash via a null handle passed to Win32 APIs.\n4. The user's reported crash (\"after a couple of clicks\") is consistent with this: clicking the taskbar button of a window that is in this broken half-destroyed state generates messages (e.g., `WM_ACTIVATE`, `WM_SETFOCUS`, repaint requests) that arrive after the HWND is already invalid.\n\nThe standard Win32 pattern is to let `DefWindowProcW` handle `WM_CLOSE`, which calls `DestroyWindow()` safely after the message handler returns, and only null out the stored handle in `WM_NCDESTROY`.\n\n---\n\n### Bug 5 — `set_size(0, 0)` Called When Window Is Minimized (MEDIUM — crash risk)\n\n**File:** `windows_standalone.cpp:668–672`\n\n```cpp\nif (plugin.gui->can_resize(plugin.plugin)) {\n plugin.gui->adjust_size(plugin.plugin, &client.width, &client.height);\n plugin.gui->set_size(plugin.plugin, client.width, client.height);\n}\n```\n\nThis runs on **every** `WM_WINDOWPOSCHANGED`, including when the window is minimized. When minimized, `GetClientRect` returns `{0, 0, 0, 0}`, so `client.width = 0` and `client.height = 0`. Calling `set_size(0, 0)` on a CLAP plugin GUI is likely undefined behaviour and may crash.\n\nA guard like `if (placement.showCmd != SW_SHOWMINIMIZED)` (the pattern already used in `onRequestResize` at line 1132) should be applied here too.\n\n---\n\n### Bug 6 — DPI Width Calculation Is Backwards (LOW — currently dormant)\n\n**File:** `windows_standalone.cpp:316`\n\n```cpp\nself->suggested.width = rect->left - rect->right; // ← WRONG: produces negative value\nself->suggested.height = rect->bottom - rect->top; // ← correct\n```\n\nShould be `rect->right - rect->left`. The `suggested` field does not appear to be consumed anywhere in the current code, so this is latent. If it is ever used for `WM_DPICHANGED` repositioning, it will produce a window of negative/enormous width.\n\n---\n\n### Bug 7 — No Error Checking on Critical GUI Calls (MEDIUM — silent failures)\n\n**File:** `windows_standalone.cpp:1088–1116`\n\n```cpp\nplugin.gui->create(plugin.plugin, CLAP_WINDOW_API_WIN32, false); // return value ignored\nplugin.gui->set_scale(plugin.plugin, scale); // return value ignored\nplugin.gui->get_size(plugin.plugin, &pluginSize.width, &pluginSize.height); // ignored\nplugin.gui->set_parent(plugin.plugin, &clapWindow); // return value ignored\n```\n\nAll of these return `bool`. If any fails, the plugin GUI ends up in an undefined partial state. There is no log output or early exit, so the user sees a black/empty window with no diagnostic information.\n\n---\n\n## Hypotheses for Reported Symptoms\n\n### Symptom 1: \"No visible UI, lurks in taskbar, MIDI works\"\n\n**Primary hypothesis: `adjustSize(0, 0)` due to premature `get_size()` call (Bug 2)**\n\nIf the plugin's `get_size()` returns `(0, 0)` before `set_parent()` has been called, the window is set to zero client area. The frame exists (hence the taskbar entry), MIDI and audio threads are unaffected, but there is nothing to see. Forcing the window to maximize overrides the zero size, which triggers `onRequestResize` with valid dimensions, causing the plugin to properly initialize its layout.\n\n**Secondary hypothesis: Bad saved position from a disconnected monitor**\n\nThe code saves the full window position on every `WM_WINDOWPOSCHANGED` and restores it unconditionally at startup (lines 1098–1101) if `width != 0 || height != 0`. If a previous session was closed with the window on a monitor that is no longer connected, the saved position could place the window entirely off-screen. The window exists and processes events but is not visible on any display. Maximizing brings it to the current screen.\n\n---\n\n### Symptom 2: \"Doesn't open unless shortcut is set to Maximized and back\"\n\n**Hypothesis: Stale off-screen saved position, cleared by the maximize-and-restore cycle**\n\nWhen the shortcut is set to \"Maximized,\" `SW_SHOWMAXIMIZED` is injected via `STARTUPINFO`. Even though `activate()` calls `ShowWindow(hwnd, SW_NORMAL)`, the OS overrides the first `ShowWindow` call to use `SW_SHOWMAXIMIZED` (standard Windows behaviour for the first show). This forces the window onto the visible desktop at full-screen size. After returning the shortcut to \"Normal,\" the previous bad saved position has been overwritten with valid screen coordinates from the maximized session. The window now opens correctly.\n\n---\n\n### Symptom: Crash after clicking\n\n**Primary hypothesis: Null `hwnd` dereference from Bug 4 (`hwnd.reset()` in `WM_CLOSE`)**\n\n`WM_CLOSE` destroys the window immediately via `hwnd.reset()`. Any messages queued before or during destruction (activation messages, paint requests, taskbar interaction) are then dispatched with an `hwnd.get()` that returns `nullptr`. Passing `nullptr` to APIs like `GetSystemMenu`, `SetWindowPos`, `SendMessage`, or `SetWindowLongPtrW` causes an access violation. This is the most probable crash cause given the description of \"after a couple of clicks.\"\n\n---\n\n## Summary Table\n\n| # | Bug | Severity | Probable Impact |\n|---|-----|----------|-----------------|\n| 1 | `nCmdShow` ignored; `SW_NORMAL` hardcoded | High | Window ignores shell placement; Symptom 2 workaround |\n| 2 | `adjustSize(0,0)` if `get_size()` returns zero before `set_parent()` | High | Window is zero-size / invisible (Symptom 1) |\n| 3 | `set_parent()` called on hidden parent | Medium | Potential painting/embedding issues |\n| 4 | `hwnd.reset()` in `WM_CLOSE` → dangling HWND | High | Crash after window interaction |\n| 5 | `set_size(0,0)` called when minimized | Medium | Likely crash on minimize |\n| 6 | DPI width calc backwards (`left - right`) | Low | Currently dormant; breaks `WM_DPICHANGED` resize |\n| 7 | No error checking on GUI create/set_parent | Medium | Silent invisible-window failures |\n\n---\n\n## Recommended Fixes (Priority Order)\n\n1. **Fix `WM_CLOSE`:** Remove `hwnd.reset()` from there; set it to `nullptr` only in `WM_NCDESTROY` and let `DefWindowProcW` call `DestroyWindow()` naturally.\n\n2. **Fix `activate()`:** Pass `nCmdShow` through from `wWinMain` instead of hardcoding `SW_NORMAL`. Store it and use it in `activate()`.\n\n3. **Fix `get_size()` call ordering:** Call `get_size()` *after* `set_parent()`, not before. Or validate that width/height are non-zero before calling `adjustSize()`.\n\n4. **Guard `set_size()` on minimized:** Add `if (placement.showCmd != SW_SHOWMINIMIZED)` before the `adjust_size`/`set_size` calls in the `WM_WINDOWPOSCHANGED` handler.\n\n5. **Fix DPI width calculation:** Change `rect->left - rect->right` to `rect->right - rect->left` at line 316.\n\n6. **Add error checking:** Check return values of `gui->create()`, `gui->set_parent()`, and `gui->get_size()`, and log/abort gracefully on failure.\n\n7. **Add off-screen position guard:** Before calling `setPosition(position)` to restore a saved position, verify that the position intersects at least one current monitor. If not, center the window instead.\n" }, { "path": "cmake/CmakeRC.cmake", "content": "# This block is executed when generating an intermediate resource file, not when\n# running in CMake configure mode\nif(_CMRC_GENERATE_MODE)\n # Read in the digits\n file(READ \"${INPUT_FILE}\" bytes HEX)\n # Format each pair into a character literal. Heuristics seem to favor doing\n # the conversion in groups of five for fastest conversion\n string(REGEX REPLACE \"(..)(..)(..)(..)(..)\" \"'\\\\\\\\x\\\\1','\\\\\\\\x\\\\2','\\\\\\\\x\\\\3','\\\\\\\\x\\\\4','\\\\\\\\x\\\\5',\" chars \"${bytes}\")\n # Since we did this in groups, we have some leftovers to clean up\n string(LENGTH \"${bytes}\" n_bytes2)\n math(EXPR n_bytes \"${n_bytes2} / 2\")\n math(EXPR remainder \"${n_bytes} % 5\") # <-- '5' is the grouping count from above\n set(cleanup_re \"$\")\n set(cleanup_sub )\n while(remainder)\n set(cleanup_re \"(..)${cleanup_re}\")\n set(cleanup_sub \"'\\\\\\\\x\\\\${remainder}',${cleanup_sub}\")\n math(EXPR remainder \"${remainder} - 1\")\n endwhile()\n if(NOT cleanup_re STREQUAL \"$\")\n string(REGEX REPLACE \"${cleanup_re}\" \"${cleanup_sub}\" chars \"${chars}\")\n endif()\n string(CONFIGURE [[\n namespace { const char file_array[] = { @chars@ 0 }; }\n namespace cmrc { namespace @NAMESPACE@ { namespace res_chars {\n extern const char* const @SYMBOL@_begin = file_array;\n extern const char* const @SYMBOL@_end = file_array + @n_bytes@;\n }}}\n ]] code)\n file(WRITE \"${OUTPUT_FILE}\" \"${code}\")\n # Exit from the script. Nothing else needs to be processed\n return()\nendif()\n\nset(_version 2.0.0)\n\ncmake_minimum_required(VERSION 3.12)\ninclude(CMakeParseArguments)\n\nif(COMMAND cmrc_add_resource_library)\n if(NOT DEFINED _CMRC_VERSION OR NOT (_version STREQUAL _CMRC_VERSION))\n message(WARNING \"More than one CMakeRC version has been included in this project.\")\n endif()\n # CMakeRC has already been included! Don't do anything\n return()\nendif()\n\nset(_CMRC_VERSION \"${_version}\" CACHE INTERNAL \"CMakeRC version. Used for checking for conflicts\")\n\nset(_CMRC_SCRIPT \"${CMAKE_CURRENT_LIST_FILE}\" CACHE INTERNAL \"Path to CMakeRC script\")\n\nfunction(_cmrc_normalize_path var)\n set(path \"${${var}}\")\n file(TO_CMAKE_PATH \"${path}\" path)\n while(path MATCHES \"//\")\n string(REPLACE \"//\" \"/\" path \"${path}\")\n endwhile()\n string(REGEX REPLACE \"/+$\" \"\" path \"${path}\")\n set(\"${var}\" \"${path}\" PARENT_SCOPE)\nendfunction()\n\nget_filename_component(_inc_dir \"${CMAKE_BINARY_DIR}/_cmrc/include\" ABSOLUTE)\nset(CMRC_INCLUDE_DIR \"${_inc_dir}\" CACHE INTERNAL \"Directory for CMakeRC include files\")\n# Let's generate the primary include file\nfile(MAKE_DIRECTORY \"${CMRC_INCLUDE_DIR}/cmrc\")\nset(hpp_content [==[\n#ifndef CMRC_CMRC_HPP_INCLUDED\n#define CMRC_CMRC_HPP_INCLUDED\n\n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n#include \n\n#if !(defined(__EXCEPTIONS) || defined(__cpp_exceptions) || defined(_CPPUNWIND) || defined(CMRC_NO_EXCEPTIONS))\n#define CMRC_NO_EXCEPTIONS 1\n#endif\n\nnamespace cmrc { namespace detail { struct dummy; } }\n\n#define CMRC_DECLARE(libid) \\\n namespace cmrc { namespace detail { \\\n struct dummy; \\\n static_assert(std::is_same::value, \"CMRC_DECLARE() must only appear at the global namespace\"); \\\n } } \\\n namespace cmrc { namespace libid { \\\n cmrc::embedded_filesystem get_filesystem(); \\\n } } static_assert(true, \"\")\n\nnamespace cmrc {\n\nclass file {\n const char* _begin = nullptr;\n const char* _end = nullptr;\n\npublic:\n using iterator = const char*;\n using const_iterator = iterator;\n iterator begin() const noexcept { return _begin; }\n iterator cbegin() const noexcept { return _begin; }\n iterator end() const noexcept { return _end; }\n iterator cend() const noexcept { return _end; }\n std::size_t size() const { return static_cast(std::distance(begin(), end())); }\n\n file() = default;\n file(iterator beg, iterator end) noexcept : _begin(beg), _end(end) {}\n};\n\nclass directory_entry;\n\nnamespace detail {\n\nclass directory;\nclass file_data;\n\nclass file_or_directory {\n union _data_t {\n class file_data* file_data;\n class directory* directory;\n } _data;\n bool _is_file = true;\n\npublic:\n explicit file_or_directory(file_data& f) {\n _data.file_data = &f;\n }\n explicit file_or_directory(directory& d) {\n _data.directory = &d;\n _is_file = false;\n }\n bool is_file() const noexcept {\n return _is_file;\n }\n bool is_directory() const noexcept {\n return !is_file();\n }\n const directory& as_directory() const noexcept {\n assert(!is_file());\n return *_data.directory;\n }\n const file_data& as_file() const noexcept {\n assert(is_file());\n return *_data.file_data;\n }\n};\n\nclass file_data {\npublic:\n const char* begin_ptr;\n const char* end_ptr;\n file_data(const file_data&) = delete;\n file_data(const char* b, const char* e) : begin_ptr(b), end_ptr(e) {}\n};\n\ninline std::pair split_path(const std::string& path) {\n auto first_sep = path.find(\"/\");\n if (first_sep == path.npos) {\n return std::make_pair(path, \"\");\n } else {\n return std::make_pair(path.substr(0, first_sep), path.substr(first_sep + 1));\n }\n}\n\nstruct created_subdirectory {\n class directory& directory;\n class file_or_directory& index_entry;\n};\n\nclass directory {\n std::list _files;\n std::list _dirs;\n std::map _index;\n\n using base_iterator = std::map::const_iterator;\n\npublic:\n\n directory() = default;\n directory(const directory&) = delete;\n\n created_subdirectory add_subdir(std::string name) & {\n _dirs.emplace_back();\n auto& back = _dirs.back();\n auto& fod = _index.emplace(name, file_or_directory{back}).first->second;\n return created_subdirectory{back, fod};\n }\n\n file_or_directory* add_file(std::string name, const char* begin, const char* end) & {\n assert(_index.find(name) == _index.end());\n _files.emplace_back(begin, end);\n return &_index.emplace(name, file_or_directory{_files.back()}).first->second;\n }\n\n const file_or_directory* get(const std::string& path) const {\n auto pair = split_path(path);\n auto child = _index.find(pair.first);\n if (child == _index.end()) {\n return nullptr;\n }\n auto& entry = child->second;\n if (pair.second.empty()) {\n // We're at the end of the path\n return &entry;\n }\n\n if (entry.is_file()) {\n // We can't traverse into a file. Stop.\n return nullptr;\n }\n // Keep going down\n return entry.as_directory().get(pair.second);\n }\n\n class iterator {\n base_iterator _base_iter;\n base_iterator _end_iter;\n public:\n using value_type = directory_entry;\n using difference_type = std::ptrdiff_t;\n using pointer = const value_type*;\n using reference = const value_type&;\n using iterator_category = std::input_iterator_tag;\n\n iterator() = default;\n explicit iterator(base_iterator iter, base_iterator end) : _base_iter(iter), _end_iter(end) {}\n\n iterator begin() const noexcept {\n return *this;\n }\n\n iterator end() const noexcept {\n return iterator(_end_iter, _end_iter);\n }\n\n inline value_type operator*() const noexcept;\n\n bool operator==(const iterator& rhs) const noexcept {\n return _base_iter == rhs._base_iter;\n }\n\n bool operator!=(const iterator& rhs) const noexcept {\n return !(*this == rhs);\n }\n\n iterator& operator++() noexcept {\n ++_base_iter;\n return *this;\n }\n\n iterator operator++(int) noexcept {\n auto cp = *this;\n ++_base_iter;\n return cp;\n }\n };\n\n using const_iterator = iterator;\n\n iterator begin() const noexcept {\n return iterator(_index.begin(), _index.end());\n }\n\n iterator end() const noexcept {\n return iterator();\n }\n};\n\ninline std::string normalize_path(std::string path) {\n while (path.find(\"/\") == 0) {\n path.erase(path.begin());\n }\n while (!path.empty() && (path.rfind(\"/\") == path.size() - 1)) {\n path.pop_back();\n }\n auto off = path.npos;\n while ((off = path.find(\"//\")) != path.npos) {\n path.erase(path.begin() + static_cast(off));\n }\n return path;\n}\n\nusing index_type = std::map;\n\n} // detail\n\nclass directory_entry {\n std::string _fname;\n const detail::file_or_directory* _item;\n\npublic:\n directory_entry() = delete;\n explicit directory_entry(std::string filename, const detail::file_or_directory& item)\n : _fname(filename)\n , _item(&item)\n {}\n\n const std::string& filename() const & {\n return _fname;\n }\n std::string filename() const && {\n return std::move(_fname);\n }\n\n bool is_file() const {\n return _item->is_file();\n }\n\n bool is_directory() const {\n return _item->is_directory();\n }\n};\n\ndirectory_entry detail::directory::iterator::operator*() const noexcept {\n assert(begin() != end());\n return directory_entry(_base_iter->first, _base_iter->second);\n}\n\nusing directory_iterator = detail::directory::iterator;\n\nclass embedded_filesystem {\n // Never-null:\n const cmrc::detail::index_type* _index;\n const detail::file_or_directory* _get(std::string path) const {\n path = detail::normalize_path(path);\n auto found = _index->find(path);\n if (found == _index->end()) {\n return nullptr;\n } else {\n return found->second;\n }\n }\n\npublic:\n explicit embedded_filesystem(const detail::index_type& index)\n : _index(&index)\n {}\n\n file open(const std::string& path) const {\n auto entry_ptr = _get(path);\n if (!entry_ptr || !entry_ptr->is_file()) {\n#ifdef CMRC_NO_EXCEPTIONS\n fprintf(stderr, \"Error no such file or directory: %s\\n\", path.c_str());\n abort();\n#else\n throw std::system_error(make_error_code(std::errc::no_such_file_or_directory), path);\n#endif\n }\n auto& dat = entry_ptr->as_file();\n return file{dat.begin_ptr, dat.end_ptr};\n }\n\n bool is_file(const std::string& path) const noexcept {\n auto entry_ptr = _get(path);\n return entry_ptr && entry_ptr->is_file();\n }\n\n bool is_directory(const std::string& path) const noexcept {\n auto entry_ptr = _get(path);\n return entry_ptr && entry_ptr->is_directory();\n }\n\n bool exists(const std::string& path) const noexcept {\n return !!_get(path);\n }\n\n directory_iterator iterate_directory(const std::string& path) const {\n auto entry_ptr = _get(path);\n if (!entry_ptr) {\n#ifdef CMRC_NO_EXCEPTIONS\n fprintf(stderr, \"Error no such file or directory: %s\\n\", path.c_str());\n abort();\n#else\n throw std::system_error(make_error_code(std::errc::no_such_file_or_directory), path);\n#endif\n }\n if (!entry_ptr->is_directory()) {\n#ifdef CMRC_NO_EXCEPTIONS\n fprintf(stderr, \"Error not a directory: %s\\n\", path.c_str());\n abort();\n#else\n throw std::system_error(make_error_code(std::errc::not_a_directory), path);\n#endif\n }\n return entry_ptr->as_directory().begin();\n }\n};\n\n}\n\n#endif // CMRC_CMRC_HPP_INCLUDED\n]==])\n\nset(cmrc_hpp \"${CMRC_INCLUDE_DIR}/cmrc/cmrc.hpp\" CACHE INTERNAL \"\")\nset(_generate 1)\nif(EXISTS \"${cmrc_hpp}\")\n file(READ \"${cmrc_hpp}\" _current)\n if(_current STREQUAL hpp_content)\n set(_generate 0)\n endif()\nendif()\nfile(GENERATE OUTPUT \"${cmrc_hpp}\" CONTENT \"${hpp_content}\" CONDITION ${_generate})\n\nadd_library(cmrc-base INTERFACE)\ntarget_include_directories(cmrc-base INTERFACE $)\n# Signal a basic C++11 feature to require C++11.\ntarget_compile_features(cmrc-base INTERFACE cxx_nullptr)\nset_property(TARGET cmrc-base PROPERTY INTERFACE_CXX_EXTENSIONS OFF)\nadd_library(cmrc::base ALIAS cmrc-base)\n\nfunction(cmrc_add_resource_library name)\n set(args ALIAS NAMESPACE TYPE)\n cmake_parse_arguments(ARG \"\" \"${args}\" \"\" \"${ARGN}\")\n # Generate the identifier for the resource library's namespace\n set(ns_re \"[a-zA-Z_][a-zA-Z0-9_]*\")\n if(NOT DEFINED ARG_NAMESPACE)\n # Check that the library name is also a valid namespace\n if(NOT name MATCHES \"${ns_re}\")\n message(SEND_ERROR \"Library name is not a valid namespace. Specify the NAMESPACE argument\")\n endif()\n set(ARG_NAMESPACE \"${name}\")\n else()\n if(NOT ARG_NAMESPACE MATCHES \"${ns_re}\")\n message(SEND_ERROR \"NAMESPACE for ${name} is not a valid C++ namespace identifier (${ARG_NAMESPACE})\")\n endif()\n endif()\n set(libname \"${name}\")\n # Check that type is either \"STATIC\" or \"OBJECT\", or default to \"STATIC\" if\n # not set\n if(NOT DEFINED ARG_TYPE)\n set(ARG_TYPE STATIC)\n elseif(NOT \"${ARG_TYPE}\" MATCHES \"^(STATIC|OBJECT)$\")\n message(SEND_ERROR \"${ARG_TYPE} is not a valid TYPE (STATIC and OBJECT are acceptable)\")\n set(ARG_TYPE STATIC)\n endif()\n # Generate a library with the compiled in character arrays.\n string(CONFIGURE [=[\n #include \n #include \n #include \n\n namespace cmrc {\n namespace @ARG_NAMESPACE@ {\n\n namespace res_chars {\n // These are the files which are available in this resource library\n $,\n >\n }\n\n namespace {\n\n const cmrc::detail::index_type&\n get_root_index() {\n static cmrc::detail::directory root_directory_;\n static cmrc::detail::file_or_directory root_directory_fod{root_directory_};\n static cmrc::detail::index_type root_index;\n root_index.emplace(\"\", &root_directory_fod);\n struct dir_inl {\n class cmrc::detail::directory& directory;\n };\n dir_inl root_directory_dir{root_directory_};\n (void)root_directory_dir;\n $,\n >\n $,\n >\n return root_index;\n }\n\n }\n\n cmrc::embedded_filesystem get_filesystem() {\n static auto& index = get_root_index();\n return cmrc::embedded_filesystem{index};\n }\n\n } // @ARG_NAMESPACE@\n } // cmrc\n ]=] cpp_content @ONLY)\n get_filename_component(libdir \"${CMAKE_CURRENT_BINARY_DIR}/__cmrc_${name}\" ABSOLUTE)\n get_filename_component(lib_tmp_cpp \"${libdir}/lib_.cpp\" ABSOLUTE)\n string(REPLACE \"\\n \" \"\\n\" cpp_content \"${cpp_content}\")\n file(GENERATE OUTPUT \"${lib_tmp_cpp}\" CONTENT \"${cpp_content}\")\n get_filename_component(libcpp \"${libdir}/lib.cpp\" ABSOLUTE)\n add_custom_command(OUTPUT \"${libcpp}\"\n DEPENDS \"${lib_tmp_cpp}\" \"${cmrc_hpp}\"\n COMMAND ${CMAKE_COMMAND} -E copy_if_different \"${lib_tmp_cpp}\" \"${libcpp}\"\n COMMENT \"Generating ${name} resource loader\"\n )\n # Generate the actual static library. Each source file is just a single file\n # with a character array compiled in containing the contents of the\n # corresponding resource file.\n add_library(${name} ${ARG_TYPE} ${libcpp})\n set_property(TARGET ${name} PROPERTY CMRC_LIBDIR \"${libdir}\")\n set_property(TARGET ${name} PROPERTY CMRC_NAMESPACE \"${ARG_NAMESPACE}\")\n target_link_libraries(${name} PUBLIC cmrc::base)\n set_property(TARGET ${name} PROPERTY CMRC_IS_RESOURCE_LIBRARY TRUE)\n if(ARG_ALIAS)\n add_library(\"${ARG_ALIAS}\" ALIAS ${name})\n endif()\n cmrc_add_resources(${name} ${ARG_UNPARSED_ARGUMENTS})\nendfunction()\n\nfunction(_cmrc_register_dirs name dirpath)\n if(dirpath STREQUAL \"\")\n return()\n endif()\n # Skip this dir if we have already registered it\n get_target_property(registered \"${name}\" _CMRC_REGISTERED_DIRS)\n if(dirpath IN_LIST registered)\n return()\n endif()\n # Register the parent directory first\n get_filename_component(parent \"${dirpath}\" DIRECTORY)\n if(NOT parent STREQUAL \"\")\n _cmrc_register_dirs(\"${name}\" \"${parent}\")\n endif()\n # Now generate the registration\n set_property(TARGET \"${name}\" APPEND PROPERTY _CMRC_REGISTERED_DIRS \"${dirpath}\")\n _cm_encode_fpath(sym \"${dirpath}\")\n if(parent STREQUAL \"\")\n set(parent_sym root_directory)\n else()\n _cm_encode_fpath(parent_sym \"${parent}\")\n endif()\n get_filename_component(leaf \"${dirpath}\" NAME)\n set_property(\n TARGET \"${name}\"\n APPEND PROPERTY CMRC_MAKE_DIRS\n \"static auto ${sym}_dir = ${parent_sym}_dir.directory.add_subdir(\\\"${leaf}\\\")\\;\"\n \"root_index.emplace(\\\"${dirpath}\\\", &${sym}_dir.index_entry)\\;\"\n )\nendfunction()\n\nfunction(cmrc_add_resources name)\n get_target_property(is_reslib ${name} CMRC_IS_RESOURCE_LIBRARY)\n if(NOT TARGET ${name} OR NOT is_reslib)\n message(SEND_ERROR \"cmrc_add_resources called on target '${name}' which is not an existing resource library\")\n return()\n endif()\n\n set(options)\n set(args WHENCE PREFIX)\n set(list_args)\n cmake_parse_arguments(ARG \"${options}\" \"${args}\" \"${list_args}\" \"${ARGN}\")\n\n if(NOT ARG_WHENCE)\n set(ARG_WHENCE ${CMAKE_CURRENT_SOURCE_DIR})\n endif()\n _cmrc_normalize_path(ARG_WHENCE)\n get_filename_component(ARG_WHENCE \"${ARG_WHENCE}\" ABSOLUTE)\n\n # Generate the identifier for the resource library's namespace\n get_target_property(lib_ns \"${name}\" CMRC_NAMESPACE)\n\n get_target_property(libdir ${name} CMRC_LIBDIR)\n get_target_property(target_dir ${name} SOURCE_DIR)\n file(RELATIVE_PATH reldir \"${target_dir}\" \"${CMAKE_CURRENT_SOURCE_DIR}\")\n if(reldir MATCHES \"^\\\\.\\\\.\")\n message(SEND_ERROR \"Cannot call cmrc_add_resources in a parent directory from the resource library target\")\n return()\n endif()\n\n foreach(input IN LISTS ARG_UNPARSED_ARGUMENTS)\n _cmrc_normalize_path(input)\n get_filename_component(abs_in \"${input}\" ABSOLUTE)\n # Generate a filename based on the input filename that we can put in\n # the intermediate directory.\n file(RELATIVE_PATH relpath \"${ARG_WHENCE}\" \"${abs_in}\")\n if(relpath MATCHES \"^\\\\.\\\\.\")\n # For now we just error on files that exist outside of the soure dir.\n message(SEND_ERROR \"Cannot add file '${input}': File must be in a subdirectory of ${ARG_WHENCE}\")\n continue()\n endif()\n if(DEFINED ARG_PREFIX)\n _cmrc_normalize_path(ARG_PREFIX)\n endif()\n if(ARG_PREFIX AND NOT ARG_PREFIX MATCHES \"/$\")\n set(ARG_PREFIX \"${ARG_PREFIX}/\")\n endif()\n get_filename_component(dirpath \"${ARG_PREFIX}${relpath}\" DIRECTORY)\n _cmrc_register_dirs(\"${name}\" \"${dirpath}\")\n get_filename_component(abs_out \"${libdir}/intermediate/${ARG_PREFIX}${relpath}.cpp\" ABSOLUTE)\n # Generate a symbol name relpath the file's character array\n _cm_encode_fpath(sym \"${relpath}\")\n # Get the symbol name for the parent directory\n if(dirpath STREQUAL \"\")\n set(parent_sym root_directory)\n else()\n _cm_encode_fpath(parent_sym \"${dirpath}\")\n endif()\n # Generate the rule for the intermediate source file\n _cmrc_generate_intermediate_cpp(${lib_ns} ${sym} \"${abs_out}\" \"${abs_in}\")\n target_sources(${name} PRIVATE \"${abs_out}\")\n set_property(TARGET ${name} APPEND PROPERTY CMRC_EXTERN_DECLS\n \"// Pointers to ${input}\"\n \"extern const char* const ${sym}_begin\\;\"\n \"extern const char* const ${sym}_end\\;\"\n )\n get_filename_component(leaf \"${relpath}\" NAME)\n set_property(\n TARGET ${name}\n APPEND PROPERTY CMRC_MAKE_FILES\n \"root_index.emplace(\"\n \" \\\"${ARG_PREFIX}${relpath}\\\",\"\n \" ${parent_sym}_dir.directory.add_file(\"\n \" \\\"${leaf}\\\",\"\n \" res_chars::${sym}_begin,\"\n \" res_chars::${sym}_end\"\n \" )\"\n \")\\;\"\n )\n endforeach()\nendfunction()\n\nfunction(_cmrc_generate_intermediate_cpp lib_ns symbol outfile infile)\n add_custom_command(\n # This is the file we will generate\n OUTPUT \"${outfile}\"\n # These are the primary files that affect the output\n DEPENDS \"${infile}\" \"${_CMRC_SCRIPT}\"\n COMMAND\n \"${CMAKE_COMMAND}\"\n -D_CMRC_GENERATE_MODE=TRUE\n -DNAMESPACE=${lib_ns}\n -DSYMBOL=${symbol}\n \"-DINPUT_FILE=${infile}\"\n \"-DOUTPUT_FILE=${outfile}\"\n -P \"${_CMRC_SCRIPT}\"\n COMMENT \"Generating intermediate file for ${infile}\"\n )\nendfunction()\n\nfunction(_cm_encode_fpath var fpath)\n string(MAKE_C_IDENTIFIER \"${fpath}\" ident)\n string(MD5 hash \"${fpath}\")\n string(SUBSTRING \"${hash}\" 0 4 hash)\n set(${var} f_${hash}_${ident} PARENT_SCOPE)\nendfunction()\n" }, { "path": "cmake/basic_installer_clapfirst.cmake", "content": "# A basic installer setup.\n#\n# Modified for products building clap first\n\nfunction(add_clapfirst_installer)\n set(oneValueArgs\n INSTALLER_TARGET\n ASSET_OUTPUT_DIRECTORY\n PRODUCT_NAME\n INSTALLER_PREFIX\n )\n set(multiValueArgs\n TARGETS # A list of plugin formats, \"CLAP\" \"VST3\" \"AUV2\"\n )\n cmake_parse_arguments(CIN \"\" \"${oneValueArgs}\" \"${multiValueArgs}\" ${ARGN} )\n\n if (\"${CIN_INSTALLER_PREFIX}\" STREQUAL \"\")\n message(FATAL_ERROR \"You must set INSTALLER_PREFIX in add_clapfirst_installer\")\n endif()\n\n if (\"${CIN_PRODUCT_NAME}\" STREQUAL \"\")\n message(FATAL_ERROR \"You must set PRODUCT_NAME in add_clapfirst_installer\")\n endif()\n\n if (\"${CIN_ASSET_OUTPUT_DIRECTORY}\" STREQUAL \"\")\n message(FATAL_ERROR \"You must set ASSET_OUTPUT_DIRECTORY in add_clapfirst_installer\")\n endif()\n\n set(TGT ${CIN_INSTALLER_TARGET})\n add_custom_target(${TGT})\n foreach (INST ${CIN_TARGETS})\n if (TARGET ${INST})\n message(STATUS \"Adding ${INST} to ${TGT} target deps\")\n add_dependencies(${TGT} ${INST})\n endif()\n endforeach()\n\n\n string(TIMESTAMP INST_DATE \"%Y-%m-%d\")\n set(INST_ZIP ${CIN_INSTALLER_PREFIX}-${CMAKE_SYSTEM_NAME}${INST_EXTRA_ZIP_NAME}-${INST_DATE}-${GIT_COMMIT_HASH}.zip)\n message(STATUS \"Zip File Name is ${INST_ZIP}\")\n\n message(STATUS \"PRODUCT NAME is ${CIN_PRODUCT_NAME}\")\n\n if (APPLE)\n message(STATUS \"Configuring for mac installer\")\n add_custom_command(\n TARGET ${TGT}\n POST_BUILD\n USES_TERMINAL\n VERBATIM\n WORKING_DIRECTORY ${CMAKE_BINARY_DIR}\n COMMAND ${CMAKE_COMMAND} -E make_directory installer\n COMMAND echo ${CMAKE_SOURCE_DIR}/libs/sst/sst-plugininfra/scripts/installer_mac/make_installer.sh ${CIN_PRODUCT_NAME} ${CIN_ASSET_OUTPUT_DIR} ${CMAKE_SOURCE_DIR}/resources/installer_mac ${CMAKE_BINARY_DIR}/installer \"${INST_DATE}-${GIT_COMMIT_HASH}\"\n COMMAND ${CMAKE_SOURCE_DIR}/libs/sst/sst-plugininfra/scripts/installer_mac/make_installer.sh ${CIN_PRODUCT_NAME} ${CIN_ASSET_OUTPUT_DIRECTORY} ${CMAKE_SOURCE_DIR}/resources/installer_mac ${CMAKE_BINARY_DIR}/installer \"${INST_DATE}-${GIT_COMMIT_HASH}\"\n )\n elseif (WIN32)\n message(STATUS \"Configuring for win installer\")\n cmake_path(REMOVE_EXTENSION INST_ZIP OUTPUT_VARIABLE WIN_INSTALLER)\n set(WINCOL ${CIN_ASSET_OUTPUT_DIRECTORY}/installer_copy)\n file(MAKE_DIRECTORY ${WINCOL})\n\n add_custom_target(${TGT}_wincollect)\n foreach (INST ${CIN_TARGETS})\n if (TARGET ${INST})\n message(STATUS \"Copying ${INST} installer copy\")\n add_dependencies(${TGT}_wincollect ${INST})\n add_custom_command(TARGET ${TGT}_wincollect\n POST_BUILD\n USES_TERMINAL\n COMMAND cmake -E echo \"Staging \" $ \" to \" ${WINCOL}\n COMMAND cmake -E copy \"$\" \"${WINCOL}\"\n )\n endif()\n endforeach()\n\n add_dependencies(${TGT} ${TGT}_wincollect)\n\n add_custom_command(\n TARGET ${TGT}\n POST_BUILD\n USES_TERMINAL\n WORKING_DIRECTORY ${CMAKE_BINARY_DIR}\n COMMAND ${CMAKE_COMMAND} -E echo Building zip for windoes\n COMMAND ${CMAKE_COMMAND} -E make_directory installer\n COMMAND 7z a -r installer/${INST_ZIP} ${WINCOL}\n )\n\n if (TARGET innosetup::compiler)\n message(STATUS \"Ejecting innosetup installer rules\")\n add_dependencies(${TGT} innosetup::compiler)\n\n add_custom_command(\n TARGET ${TGT}\n POST_BUILD\n USES_TERMINAL\n WORKING_DIRECTORY ${CMAKE_BINARY_DIR}\n COMMAND ${CMAKE_COMMAND} -E echo Building exe installer for windows with $ compiler\n COMMAND ${CMAKE_COMMAND} -E make_directory installer\n COMMAND innosetup::compiler\n /O\"${CMAKE_BINARY_DIR}/installer\"\n /F\"${WIN_INSTALLER}\"\n /DName=\"${PRODUCT_NAME}\"\n /DNameCondensed=\"${PRODUCT_NAME}\"\n /DVersion=\"${GIT_COMMIT_HASH}\"\n /DID=\"2cfbe819-3947-4c10-93cc-03a2896fdfec\"\n /DPublisher=\"BaconPaul\"\n /DCLAP /DVST3 /DVST3_IS_SINGLE_FILE /DSA\n /DIcon=\"${CMAKE_SOURCE_DIR}/resources/SideQuestIcon.ico\"\n /DBanner=\"${CMAKE_SOURCE_DIR}/resources/SideQuestBanner.png\"\n /DArch=\"x64compatible\"\n /DLicense=\"${CMAKE_SOURCE_DIR}/resources/LICENSE_GPL3\"\n /DStagedAssets=\"${WINCOL}\"\n \"$\"\n )\n endif()\n\n else ()\n message(STATUS \"Basic Installer: Target is installer/${OBXF_ZIP}\")\n add_custom_command(\n TARGET ${TGT}\n POST_BUILD\n WORKING_DIRECTORY ${CMAKE_BINARY_DIR}\n COMMAND ${CMAKE_COMMAND} -E make_directory installer\n COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_SOURCE_DIR}/resources/LICENSE_GPL3 ${CIN_ASSET_OUTPUT_DIRECTORY}\n COMMAND ${CMAKE_COMMAND} -E tar cvf installer/${INST_ZIP} --format=zip ${CIN_ASSET_OUTPUT_DIRECTORY}/\n COMMAND ${CMAKE_COMMAND} -E echo \"Installer in: installer/${INST_ZIP}\")\n\n #add_custom_command(\n # TARGET obxf-installer\n # POST_BUILD\n # WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}\n # USES_TERMINAL\n # COMMAND scripts/installer_linux/make_deb.sh ${OBXF_PRODUCT_DIR} ${CMAKE_SOURCE_DIR} ${CMAKE_BINARY_DIR}/installer \"${OBXF_DATE}-${GIT_COMMIT_HASH}\"\n #)\n\n endif ()\nendfunction()\n" }, { "path": "cmake/compile-options.cmake", "content": "\nif (APPLE)\n enable_language(OBJC)\n enable_language(OBJCXX)\n set(CMAKE_OBJC_VISIBILITY_PRESET hidden)\n set(CMAKE_OBJCXX_VISIBILITY_PRESET hidden)\nendif()\n\nset(BUILD_SHARED_LIBS OFF CACHE BOOL \"Never want shared if not specified\")\nif (${BUILD_SHARED_LIBS})\n message(WARNING \"You have set BUILD_SHARED_LIBS to ON. This is an untested and unlikedly to work config\")\nendif()\n\nset(CMAKE_CXX_EXTENSIONS OFF)\nset(CMAKE_CXX_STANDARD 20)\nset(CMAKE_CXX_VISIBILITY_PRESET hidden)\nset(CMAKE_C_VISIBILITY_PRESET hidden)\nset(CMAKE_VISIBILITY_INLINES_HIDDEN ON)\n\n# Compiler specific choices\nif(CMAKE_CXX_COMPILER_ID MATCHES \"Clang|GNU\")\n add_compile_options(\n $<$:-fsanitize=address>\n $<$:-fsanitize=undefined>\n $<$:-fno-sanitize-recover=undefined>\n $<$:-fsanitize-address-use-after-scope>\n # Fill stack/heap uninitialized locals with a repeating pattern so\n # uninit reads surface deterministically on macOS/Linux rather than\n # happening to read as zero\n $<$:-ftrivial-auto-var-init=pattern>\n\n $<$,$,$>:-fno-char8_t>\n )\n\n add_link_options(\n $<$:-fsanitize=address>\n $<$:-fsanitize=undefined>\n $<$:-fno-sanitize-recover=undefined>\n )\n if (NOT APPLE)\n add_compile_options($,-march=armv8-a,-march=nehalem>)\n endif()\nendif()\n\n\nif (WIN32)\n add_compile_definitions(_CRT_SECURE_NO_WARNINGS=1)\nendif()\n\nif (MSVC)\n add_compile_options(\n # Set source and executable charsets to UTF-8\n $<$:/utf-8>\n # Do *not* use the new, breaking char8_t UTF-8 bits in C++20.\n $<$:/Zc:char8_t->\n # make msvc define __cplulsplus properly\n $<$:/Zc:__cplusplus>\n )\nendif()\n" }, { "path": "doc/12_prompts/audio_in_prompt.md", "content": "# Audio In Feature — Prompts and Plan\n\n**Date:** 2026-04-12\n\n---\n\n## User Prompts (verbatim)\n\n### Prompt 1\n\nOK so today we are adding audio in to six sines. I want to start with a plan-only exercise for you to present me how you would solve it, and then if i like the plan we can generate code. Go laod up the six sines skills and memories you have first.\n\nAudio in works as follows\n\n1. The clap gets changed so that the audioPorts api responds with 1 input which is not main and is stereo. Fine.\n2. The processor should have a lanczos interpolation operator from basic-blocks which interpolates from clap sample rate up to internal sample rate. If the internal sample rate changes, clear the buffer. On construction, clear the buffer. Make the Lanczos nice and big. Give it like 1024 * 10 samples worth of storage or something. On each sample the audio in wrotes to the lanczos buffer.\n3. At the top of each internal block the synth engine reads the upsampled version of that lanczos buffer into an internal block siuzed resampled buffer.\n4. Operator 1 - and only operator 1 - can have audio in as a wavetable. It uses the upsampled buffer from step 3 when selected. Add the new type \"AUDIO_IN\" as a wavetable.\n5. Once operator 1 is set to audio in the rest of the engine will work fine with a couple of constraints. Op1 feedback wont work, and op1 ratio does nothing. So AUDIO_IN is special in that we dont have to run the op1 lfo, envelope, etc... on the node or the feedback node just the mix node.\n6. The UI side operator 1 audio in appears last in the list after a spearator. When it appears the ratio knob deactivates (but still allows skip to select) as do all the modulation and envelope parameters and the feedback knob. \n\nSo that's basically the design idea. Can you give me a plan which restates this design and how you intend to do it.\n\n### Prompt 2\n\nOK so a few modifications to the plan, which I'd like you to make and then restate the plan. Mostly AUDIO_IN being 21 as special. In this iteration of six sines I'm going to add several new waveforms. AUDIO_IN is this but later on I'll add a bunch of phase distortion ones. So I dont want AUDIO_IN being last to be special (but your analysis that it is streaming compatible to add is fine). So what I want to do is add a ui-side feature to sort and segment the waveform menu. We can cluster with separators and reorder. So basically a separator before TX2, before SPIKY TX and before the windows, then a separator and audio in last. We can just have a little data structure for separators and order and check that all values are in the menu. Then condition for operator 1.\n\nAs to the nodes, if a node is set to AUDIO_IN other than 1, lets for now silence it but have that code there in case later we decide to let audio in be in other nodes.\n\nSo restate the plan with those changes for my review please.\n\n### Prompt 3\n\nGreat. I'd like to save my prompts and your plans. I'm going to do this often. So please save exactly verbatim the prompts I entered here along with the final version of your plan along with the date to @doc/12_prompts/audio_in_prompt.md. Like I said verbatim what I prompted in the top of the document (including this) then the output of the last version of the plan.\n\n---\n\n## Final Plan (Revised)\n\n### Overview\n\nStereo audio input is added to the plugin. Op1 (and only Op1) can be set to `AUDIO_IN` waveform mode, which replaces its synthesized waveform with the live upsampled audio input. The audio arrives at host rate, is upsampled to engine rate via a Lanczos resampler in Synth, and the upsampled block is written into `MonoValues` where `OpSource` can read it. If AUDIO_IN is selected on ops 2–5, the op silences — the code path is there for potential future expansion.\n\n`AUDIO_IN` is assigned value 21 (the current `NUM_WAVEFORMS`). Future phase-distortion waveforms will be added as 22, 23, etc. A new UI data structure governs menu display order and separators independently of the integer enum order, so `AUDIO_IN` always appears last in the menu regardless of what integer values future waveforms get.\n\n---\n\n### Step 1: CLAP Audio Ports (`src/clap/six-sines-clap.cpp`)\n\n**`audioPortsCount`**: Change `isInput ? 0` → `isInput ? 1`. Both single and multi-out variants report one input.\n\n**`audioPortsInfo`**: Remove the `assert(!isInput)`. Add a branch for `isInput && index == 0`:\n- Unique `id` (e.g. `82649`)\n- `name = \"Audio In\"`\n- `flags = 0` — explicitly **not** `CLAP_AUDIO_PORT_IS_MAIN`\n- `channel_count = 2`, `port_type = CLAP_PORT_STEREO`\n- `in_place_pair = CLAP_INVALID_ID`\n\n**`process()`**: Before the per-sample loop, capture input data pointers:\n```cpp\nfloat *audioInL{nullptr}, *audioInR{nullptr};\nif (process->audio_inputs_count > 0 && process->audio_inputs[0].data32) {\n audioInL = process->audio_inputs[0].data32[0];\n audioInR = process->audio_inputs[0].data32[1];\n}\n```\nInside the per-sample loop at every `s`, push one host-rate sample into the engine's resampler:\n```cpp\nengine->pushAudioIn(audioInL ? audioInL[s] : 0.f,\n audioInR ? audioInR[s] : 0.f);\n```\nThis is unconditional on `blockPos` — every host-rate input sample is pushed as it arrives.\n\n---\n\n### Step 2: Engine Audio-In Resampler (`src/synth/synth.h` / `synth.cpp`)\n\n**`synth.h`** — Add members:\n```cpp\nusing audioInResampler_t = sst::basic_blocks::dsp::LanczosResampler;\nstd::unique_ptr audioInResampler;\nvoid pushAudioIn(float L, float R);\n```\n\n`LanczosResampler` has `BUFFER_SZ = 4096` host-rate samples of internal ring storage, which is far more than the 2–8 samples of lookahead the Lanczos kernel requires. This is the \"nice and big\" buffer; no changes to the SST library are needed.\n\n**`synth.cpp`** — In `setSampleRate()`, after computing `hostSampleRate` and `engineSampleRate`, (re)construct the resampler — this clears it implicitly since the constructor `memset`s its buffers:\n```cpp\naudioInResampler = std::make_unique(\n (float)hostSampleRate, (float)engineSampleRate);\n```\n\n**`pushAudioIn()`**: Delegates to `audioInResampler->push(L, R)`.\n\n---\n\n### Step 3: MonoValues Audio-In Block (`src/synth/mono_values.h`)\n\nAdd to `MonoValues`:\n```cpp\nfloat audioInBlock alignas(16)[blockSize]{}; // engine-rate audio in, mono mix\n```\n\nThis shared buffer is updated once per engine block by `processInternal`, before any voice rendering runs.\n\n---\n\n### Step 4: `processInternal` — Populate Audio-In Block (`src/synth/synth.cpp`)\n\nAt the top of the inner `while (generated < blockSize)` loop, before rendering voices, pull one engine-rate block:\n```cpp\n{\n float aiL[blockSize], aiR[blockSize];\n auto got = (int)audioInResampler->populateNext(aiL, aiR, blockSize);\n for (int i = 0; i < blockSize; ++i)\n monoValues.audioInBlock[i] = (i < got) ? (aiL[i] + aiR[i]) * 0.5f : 0.f;\n}\n```\nMono-mixes L+R since Op1 is a mono signal source in the FM graph. Zero-fills if the resampler doesn't have enough input yet (startup transient).\n\n---\n\n### Step 5: Waveform Enum Extension (`src/dsp/sintable.h`)\n\nAdd `AUDIO_IN` immediately before `NUM_WAVEFORMS`:\n```cpp\nTUKEY_WINDOW = 20,\nAUDIO_IN = 21, // no table entry; handled as special case in OpSource\nNUM_WAVEFORMS = 22\n```\n\n`AUDIO_IN = 21` is a stable streaming value. Future phase-distortion waveforms will be inserted as 22, 23, … in the enum. The UI menu (Step 7) places `AUDIO_IN` last regardless of integer order. The `SinTable::at()` function is **never called** for `AUDIO_IN` — `OpSource` early-exits before reaching table lookup.\n\n---\n\n### Step 6: Patch Parameter Range Update (`src/synth/patch.h`)\n\nExtend the `waveForm` parameter range by one (to include index 21). All 6 ops share the same parameter template so technically all ops can hold value 21 in state, but ops 2–5 will silence if that happens (Step 8). No `patchVersion` bump needed — this is a range expansion with no backwards-incompatible changes.\n\nThe display-name for value 21 in `ParamMetaData` should be `\"Audio In\"`.\n\n---\n\n### Step 7: New `src/ui/waveform-display.h`\n\nThis is a new header in `src/ui/` containing a data structure that governs the waveform menu's display order and grouping. It is the authoritative ordering source — completely independent of enum integer values.\n\n```cpp\nstruct WaveformMenuEntry {\n bool isSeparator{false};\n const char *label{nullptr}; // group name for separators, display name for waveforms\n int waveformValue{-1}; // -1 for separators\n};\n\n// Base menu — all operators\ninline constexpr WaveformMenuEntry waveformMenuBase[] = {\n {false, \"Sin\", SinTable::SIN},\n {false, \"Sin Fifth\", SinTable::SIN_FIFTH},\n {false, \"Squarish\", SinTable::SQUARISH},\n {false, \"Sawish\", SinTable::SAWISH},\n {false, \"Triangle\", SinTable::TRIANGLE},\n {false, \"Sin of Cubed\", SinTable::SIN_OF_CUBED},\n {true, \"TX\"},\n {false, \"TX 2\", SinTable::TX2},\n {false, \"TX 3\", SinTable::TX3},\n {false, \"TX 4\", SinTable::TX4},\n {false, \"TX 5\", SinTable::TX5},\n {false, \"TX 6\", SinTable::TX6},\n {false, \"TX 7\", SinTable::TX7},\n {false, \"TX 8\", SinTable::TX8},\n {true, \"Spiky TX\"},\n {false, \"Spiky TX 2\", SinTable::SPIKY_TX2},\n {false, \"Spiky TX 4\", SinTable::SPIKY_TX4},\n {false, \"Spiky TX 6\", SinTable::SPIKY_TX6},\n {false, \"Spiky TX 8\", SinTable::SPIKY_TX8},\n {true, \"Windows\"},\n {false, \"Hann\", SinTable::HANN_WINDOW},\n {false, \"Blackman-Harris\", SinTable::BLACKMAN_HARRIS_WINDOW},\n {false, \"Half BH\", SinTable::HALF_BLACKMAN_HARRIS_WINDOW},\n {false, \"Tukey\", SinTable::TUKEY_WINDOW},\n // Future phase-distortion waveforms (22+) inserted here, before Audio In\n};\n\n// Op1-only extension — appended to base\ninline constexpr WaveformMenuEntry waveformMenuAudioIn[] = {\n {true, \"\"}, // separator before Audio In\n {false, \"Audio In\", SinTable::AUDIO_IN},\n};\n```\n\n**Helper functions** (also in this header or an associated `.cpp`):\n- `waveformDisplayName(int value) -> const char*` — looks up label from base + audioIn tables\n- `nextWaveformValue(int current, bool includeAudioIn) -> int` — finds next non-separator entry in menu order\n- `prevWaveformValue(int current, bool includeAudioIn) -> int` — same, backwards\n\n**Validation**: A `static_assert` or debug-build `assert` that iterates all `SinTable::WaveForm` values 0..20 and verifies each appears exactly once in `waveformMenuBase`. Similarly verify `AUDIO_IN` appears exactly once in `waveformMenuAudioIn`. This catches any future waveform being added to the enum without being added to the menu.\n\n---\n\n### Step 8: `OpSource` — `opIndex` Member and AUDIO_IN Mode (`src/dsp/op_source.h`)\n\nAdd `int opIndex{0}` as a member of `OpSource`. It is set from `Voice` after array construction (see Step 9).\n\nAt the top of `renderBlock()`, after the `!active` early-out, add:\n\n```cpp\nbool isAudioIn = ((int)std::round(waveForm) == SinTable::AUDIO_IN);\nif (isAudioIn) {\n if (opIndex == 0) {\n for (int i = 0; i < blockSize; ++i)\n output[i] = monoValues.audioInBlock[i] * rmLevel[i];\n } else {\n // AUDIO_IN only wired for Op1 currently; silence other ops\n memset(output, 0, sizeof(output));\n }\n fbVal[0] = fbVal[1] = 0.f;\n return;\n}\n```\n\nRing-mod (`rmLevel`) is still applied for Op1 — matrix connections to Op1 can still ring-modulate the audio input, which is a useful FM technique. Feedback state is zeroed to prevent stale values if the mode is toggled. All ratio/phase/envelope/LFO code is bypassed.\n\n---\n\n### Step 9: Voice — Set `opIndex` and Skip Feedback for Op0 Audio-In (`src/synth/voice.cpp`)\n\nIn `Voice::Voice()`, after constructing `src`, set indices:\n```cpp\nfor (int i = 0; i < numOps; ++i)\n src[i].opIndex = i;\n```\n\nIn `Voice::renderBlock()`, for operator index 0, skip `selfNode[0]` when in AUDIO_IN mode:\n```cpp\nbool op0IsAudioIn = ((int)std::round(src[0].waveForm) == SinTable::AUDIO_IN);\nif (!op0IsAudioIn) {\n selfNode[0].renderBlock(src[0].feedbackLevel, src[0].output);\n}\nsrc[0].renderBlock();\n```\n\n`matrixNode` connections FROM op0 TO ops 1–5 still run unmodified — the audio signal in `src[0].output` can modulate higher operators. `mixerNode[0]` still runs — output level/envelope/LFO for Op1 continue to work.\n\n---\n\n### Step 10: WavPainter Fix (`src/ui/source-sub-panel.cpp`)\n\n`WavPainter::paint()` currently calls `st.at(phase)` without checking for `AUDIO_IN`. When `waveForm == AUDIO_IN`, skip the waveform drawing and instead render a representative placeholder (e.g., a flat line or a noise-like squiggle label \"Audio In\"). The simplest approach: check at the top of `paint()` and early-return with a text label if `AUDIO_IN`.\n\n---\n\n### Step 11: UI — Waveform Selector for Op1 (`src/ui/source-sub-panel.cpp`)\n\n**Custom JogUpDownButton navigation**: After `createComponent(...)` creates `wavButton`/`wavButtonD`, override the data binding's navigation. The JogUpDownButton calls `setValueFromGUI(getValue() ± 1)` for up/down. To intercept this, either:\n- Set custom up/down callbacks on `wavButton` that call `nextWaveformValue`/`prevWaveformValue` from `waveform-display.h` and then call `wavButtonD->setValueFromGUI(newValue)`\n- Or subclass `PatchDiscrete` into a `PatchDiscreteWaveform` that overrides `setValueFromGUI` to remap through menu order\n\nEither way, the navigation skips separator entries cleanly. The display string comes from `waveformDisplayName()`.\n\n**Op1 gate for AUDIO_IN**: The `includeAudioIn` flag passed to `nextWaveformValue`/`prevWaveformValue` is `(index == 0)`. For ops 2–5, navigation never reaches value 21.\n\n**`setEnabledState()`**: Extend to check for AUDIO_IN on Op1. When `index == 0 && waveForm == AUDIO_IN`, disable:\n- `envToRatio`, `envToRatioFine`\n- `lfoToRatio`, `lfoToRatioFine`\n- All DAHDSR sliders and shape knobs\n- All LFO controls\n- All modulation slots\n- `startingPhase` (no phase in audio-in mode)\n- `keyTrack`, `keyTrackValue`, `keyTrackLow`, `keyTrackLowValue` (irrelevant)\n- `tsposeButton` (ratio is meaningless)\n\n`wavButtonD->onGuiSetValue` already calls `wavPainter->repaint()` and `wavButton->repaint()` — extend it to also call `setEnabledState()` so the greying updates immediately when AUDIO_IN is selected.\n\nAlso add a notification back to `SourcePanel` so the ratio knob in the top panel greys out. The `onGuiSetValue` callback can call into the editor or panel to trigger an `updateEnabledState()` on `SourcePanel`'s knobs[0].\n\n---\n\n### Step 12: Self Sub Panel — Feedback Deactivation (`src/ui/self-sub-panel.cpp`)\n\nIn `SelfSubPanel::populate()` (or equivalent), add a check: when the selected operator index is 0 and `waveForm == AUDIO_IN`, call `setEnabled(false)` on the feedback slider and its label. Feedback mode is a no-op for AUDIO_IN since `selfNode[0]` is skipped entirely.\n\n---\n\n### Summary of Files Changed\n\n| File | Change |\n|------|--------|\n| `src/clap/six-sines-clap.cpp` | Add input port; push audio samples to engine per host sample |\n| `src/synth/synth.h` | Add `audioInResampler`, `pushAudioIn()` |\n| `src/synth/synth.cpp` | Construct resampler in `setSampleRate()`; populate `monoValues.audioInBlock` in `processInternal()` |\n| `src/synth/mono_values.h` | Add `audioInBlock[blockSize]` |\n| `src/dsp/sintable.h` | Add `AUDIO_IN = 21` before `NUM_WAVEFORMS` |\n| `src/synth/patch.h` | Extend waveform param range to include 21; add display name |\n| `src/dsp/op_source.h` | Add `opIndex`; AUDIO_IN early-exit in `renderBlock()` |\n| `src/synth/voice.cpp` | Set `src[i].opIndex = i`; skip `selfNode[0]` for AUDIO_IN |\n| `src/ui/waveform-display.h` | **New file**: menu entries, separators, nav helpers, completeness validation |\n| `src/ui/source-sub-panel.cpp` | Custom wavButton navigation via menu order; extend `setEnabledState()` for AUDIO_IN; fix `WavPainter` for AUDIO_IN |\n| `src/ui/self-sub-panel.cpp` | Disable feedback when Op1 is AUDIO_IN |\n| `src/ui/source-panel.h/cpp` | Add `updateOpEnabledState(int idx)` to grey out ratio knob + up/down buttons |\n| `src/ui/matrix-panel.h/cpp` | Add `updateSelfKnobState(int idx)` to grey out feedback level knob + power toggle |\n\n---\n\n## Follow-up Prompt 4\n\nOK I reviewed it and made two small changes. There's a couple of things I want to add also\n\n1. There's no reason to do the lanczoes resample of audio in *unless* op 1 is set to AUDIO_IN so can we check that before buildign the audio in modval and just zero it otherwise\n2. If op1 is set to AUDIO_IN the op1 feedback node knob in the UI can also be disabled.\n\nSo please make these changes (and add this ot the explicit prompts in the doc).\n\nThen once that is done please spin up a fresh agent, ask it to review the diffs here, and provide feedback vs plan\n\n### Changes made for Follow-up 4\n\n1. **`src/synth/synth.cpp` `processInternal()`**: Guard the Lanczos resampler population behind `op1IsAudioIn = ((int)std::round(patch.sourceNodes[0].waveForm.value) == SinTable::AUDIO_IN)`. When not in AUDIO_IN mode, `monoValues.audioInBlock` is zeroed instead (no resampler work done).\n\n2. **`src/ui/matrix-panel.h/cpp`**: Added `updateSelfKnobState(int idx)` which disables `Sknobs[idx]` (the `fbLevel` knob) and `Spower[idx]` (the active toggle) when that op is AUDIO_IN. Called from `SourceSubPanel::setEnabledState()` alongside `updateOpEnabledState()`.\n\n---\n\n## Follow-up Prompt 5\n\nyes please address all three of those\n\n*(Context: responding to a fresh review agent's report that flagged three gaps: DAHDSR/LFO/modulation slots not disabled in SourceSubPanel, missing menu completeness static_assert in waveform-display.h, and modulation slots not greyed.)*\n\n### Changes made for Follow-up 5\n\n1. **`src/ui/source-sub-panel.cpp` `setEnabledState()`**: Added `setEnabled(!isAudioIn)` for all 6 DAHDSR sliders, 3 shape knobs, trigger button, all 7 LFO controls (rate, deform, phase, shape, tempoSync, bipolar, isEnv), and all 3 modulation slots (sourceMenu, targetMenu, depthSlider).\n\n2. **`src/ui/waveform-display.h`**: Added two compile-time `static_assert`s — one verifying every waveform value 0..`TUKEY_WINDOW` appears exactly once in `waveformMenuBase`, one verifying `AUDIO_IN` appears exactly once in `waveformMenuAudioIn`.\n\n---\n\n## Follow-up Prompt 6\n\nAlright close. That disable of the knobs doesn't repaint the parent so add a call to editor->repaint. Also when the op1 feedback is knocked out we also want to knock out the envelope and envelope for that node.\n\n### Changes made for Follow-up 6\n\n1. **`src/ui/source-sub-panel.cpp` `setEnabledState()`**: Added `editor.repaint()` after the existing `repaint()` so the operator grid and matrix panel redraw when controls are greyed.\n\n2. **`src/ui/self-sub-panel.cpp` `setEnabledState()`**: Extended to disable all DAHDSR sliders, shape knobs, trigger button, and all LFO controls when op1 is AUDIO_IN. Also added `editor.repaint()`.\n\n---\n\n## Follow-up Prompt 7\n\nGreat. Please add my other verbatim prompts to @doc/12_prompts/audio_in_prompt.md and also spin up another fresh review agent and let me know what it thinks\n\n---\n\n## Follow-up Prompt 8\n\nyeah fix the clap audio push bug and then let me look by hand again. And add this to the audio_in_prompt.md also\n\n### Changes made for Follow-up 8\n\n1. **`src/clap/six-sines-clap.cpp` `process()`**: Changed audio input push from gated `if (audioInL && audioInR)` to unconditional `engine->pushAudioIn(audioInL ? audioInL[s] : 0.f, audioInR ? audioInR[s] : 0.f)`. This ensures the resampler always receives one sample per host frame, preventing startup transients or dropouts if a host provides null channel pointers.\n\n---\n\n## Follow-up Prompt 9\n\nOK couple of things on hand review\n\n1. When you set op1 to the source why do you multiply by rm[i]? We know that will be 1 so we can skip it\n2. The static assert in waveform_display hard codes TUKEY_WINDOW. Instead what I'd like to do is make sure the result covers all of them up to NUM_WAVEFORMS - 1 *except* for AUDIO_IN, again because I plan to add more waveforms which will come after AUDIO_IN in the future.\n\n### Changes made for Follow-up 9\n\n1. **`src/dsp/op_source.h`**: Removed `* rmLevel[i]` from the AUDIO_IN copy loop — `output[i] = monoValues.audioInBlock[i]`. Ring-mod level is always 1.0 for op1 in AUDIO_IN mode since no matrix node assigns RM to it.\n\n2. **`src/ui/waveform-display.h`**: Changed the base-menu `static_assert` to iterate `0..NUM_WAVEFORMS-1`, skip `AUDIO_IN`, and require every other value appears exactly once. This is forward-compatible: new waveforms added at 22, 23, etc. will automatically cause a build failure until added to the menu.\n\n---\n\n## Follow-up Prompt 10\n\nOK great and one last review, and update the doc with these prompts\n\n---\n\n## Follow-up Prompt 11\n\nYeah lets fix 1 and 2. And with 2 lets add a comment in sin table that things will be easier if we keep audio in last and just update streaming version when adding table types so when I do add them you know to up streaming to n+1 and do a handler to push audio in always to the end. Make that change, add this prompt to doc, spin up a final review agent (including checking comments) and report back\n\n### Changes made for Follow-up 11\n\n1. **`src/ui/source-sub-panel.cpp` `setEnabledState()`**: Added `editor.selfSubPanel->setEnabledState()` call when `index == 0` and SelfSubPanel is visible, so feedback controls grey immediately if the user changes Op1's waveform while the feedback panel is open. Added `#include \"self-sub-panel.h\"` for the complete type.\n\n2. **`src/ui/waveform-display.h` `WaveformPatchDiscrete::getMax()`**: For ops 2–5 (non-AUDIO_IN), now returns `NUM_WAVEFORMS - 2` instead of hardcoded `TUKEY_WINDOW`. This automatically includes any future synthesized waveforms added before AUDIO_IN without any change here.\n\n3. **`src/dsp/sintable.h`**: Added comment block before `AUDIO_IN` explaining the streaming convention: new waveforms must be inserted before AUDIO_IN, AUDIO_IN's integer value will shift, so when adding them bump the SourceNode streaming version in `patch.h` and write a migration handler to remap the old AUDIO_IN value to the new one.\n" }, { "path": "doc/12_prompts/color_picker.md", "content": "# Color Editor Feature — Prompts and Plan\n\n**Date:** 2026-04-15\n\n---\n\n## User Prompts (verbatim)\n\n### Prompt 1\n\nOK I'm looking to add a feature to sst-jucegui to allow a color editor. I want this to be in three parts.\n\nFIRST there's a color editor in sst/jucegui/screens called ColorEditor. It takes a data structure which looks like a list of color tag strings and colors, and also takes a function of string,color. It uses that to present a panel which contains a scrollable list of those colors with a button - colored in the colour - and a text next to them. When you press the button it pops up a colour picker. The text field has the 32 bit hex code (so like #ff00ff00 for green) or 24 bit hex code (#ff0000 for red) depending on whether the 'includeAlpha' flag is set. This should be in a NamedPanel. When a color is edited it calls the callback. Fine.\n\nSECOND is a simple idiom to show that panel in a standalone window. That can be a static method in the same header probably with a return type like std::unique_ptr and with the constructor args for the picker screen. And also a version of the scren component which implements Modalbase so we can use it as an in app modal overlay.\n\nTHIRD is an adapter atain in the same header which takes a style sheet and (ine one mode) a list of style keys and (in another mode) a list of color maps to style keys and updates the style sheet object.\n\nThis is quite a big prompt so lets start with you laying out a plan. And also I want to keep the prompt history in @doc/12_prompts/ with the explicit prompt and either plan or summary of action just like i did. Call the file 12_prompts/color_picker.md.\n\n### Prompt 2\n\nI think thats right. On 4 the component can implement hover to draw a white line around the color to make it clear it is active. And yes on 1 2 and 3. For the picker though we want to use a viewport / scroll window if the color set is larger than 15 or so. So include that viewport code also.\n\nTheres one more part of the plan i want. That's to have six sines be able to open one of these from the main menu under UI and get all the editors for value bearing, base label, outlined, etc... which are the base styles we use for the knob, slider, dislplya, etc.... and do that directly on the style sheet. We will then want to soon enough serailize those using (probably) the style id, which we can do by introducint an sst/jucegui/style/Seralizer.h which goes to and from some text file for a style shet. Lets add that to the plan as steps.\n\n### Prompt 3\n\nGreat. Actually in jucegui drop the toFile/fromFile and just have toString/fromString method. We cna handle the file io externally since we'll want to use std::filesystem and the likes in the client app. Do the file save in six sines. Modify the plan for me again with that in mind, restate the plan, and then lets look at it\n\n---\n\n## Plan\n\n### Overview\n\nA single new header `include/sst/jucegui/screens/ColorEditor.h` provides:\n\n1. **`ColorEditor`** — a `NamedPanel` subclass showing a scrollable list of named colors, each with a color swatch button and an editable hex text field.\n2. **`ColorEditorModal`** — a `ModalBase` subclass that wraps a `ColorEditor` for use as an in-app overlay.\n3. **`ColorEditor::asStandaloneWindow()`** — static factory for a `juce::DocumentWindow` hosting a `ColorEditor`.\n4. **`ColorEditor::forStyleKeys()`** and **`ColorEditor::forColorMap()`** — static adapters that wire a `StyleSheet` to a `ColorEditor`.\n\nEverything lives in one header (matching the pattern of `AlertOrPrompt.h` and `ModalBase.h`). No new `.cpp` file is needed.\n\n---\n\n### Part 1: `ColorEditor`\n\n#### Data types\n\n```cpp\nstruct ColorEntry {\n std::string tag; // human-readable name shown as the row label\n juce::Colour color;\n};\nusing ColorChangedFn = std::function;\n```\n\n#### Class declaration\n\n```cpp\nstruct ColorEditor : components::NamedPanel,\n private juce::ChangeListener\n{\n ColorEditor(std::vector entries,\n ColorChangedFn callback,\n bool includeAlpha = false);\n\n void resized() override;\n\n // ... (private row component, listView, picker management)\n};\n```\n\n`ColorEditor` inherits `NamedPanel` so it gets the styled header bar, outline, and `getContentArea()`. The title string passed to `NamedPanel(\"Color Editor\")` is fixed but callers can call `setName()` after construction.\n\n#### Internal `RowComponent`\n\n`ListView` is used with `BRUTE_FORCE_NO_REUSE` strategy. Each row is a `RowComponent` (private inner struct):\n\n```\n[ color swatch button (32px wide) ][ hex text field (fills remainder) ]\n```\n\n- **Swatch button**: plain `juce::Component` that `paint()`s itself solid with `entry.color` and a 1px outline. `mouseDown` calls back into `ColorEditor::openPickerFor(idx, screenBounds)`.\n- **Hex text field**: `juce::TextEditor`, single-line. Initialized with `toHexString(entry.color)`. `onReturnKey` and `focusLost` parse the typed string with `fromHexString()`, update `entries[idx].color`, and fire `onColorChanged`.\n\nRow height: 28px. The `ListView` `getRowHeight` lambda returns 28.\n\n#### Hex string format\n\n```cpp\nstd::string toHexString(juce::Colour c) const;\n// includeAlpha=true → \"#AARRGGBB\" (8 hex digits, uppercase)\n// includeAlpha=false → \"#RRGGBB\" (6 hex digits, uppercase)\n\njuce::Colour fromHexString(const std::string& s) const;\n// Strips leading '#', prepends \"FF\" if !includeAlpha,\n// then calls juce::Colour::fromString(). Returns juce::Colours::transparentBlack on parse failure.\n```\n\n#### Color picker\n\n`ColorEditor` implements `juce::ChangeListener`. `openPickerFor(idx, screenBounds)`:\n\n1. Creates a `juce::ColourSelector` with flags:\n ```\n showColourAtTop | showSliders | showColourspace\n ```\n plus `showAlphaChannel` if `includeAlpha`.\n2. Sets the current colour to `entries[idx].color`.\n3. Adds `*this` as a `ChangeListener`.\n4. Launches via `juce::CallOutBox::launchAsynchronously(...)`.\n5. Stores `activePickerIdx = idx` and a raw (unowned) pointer to the selector.\n\n`changeListenerCallback()`:\n- Reads `selector->getCurrentColour()`.\n- Calls `updateEntry(activePickerIdx, newColor)`.\n\n`updateEntry(idx, color)`:\n- Updates `entries[idx].color`.\n- Updates the row's hex text field text via the `ListView`'s assigned component.\n- Calls `onColorChanged(entries[idx].tag, color)`.\n- Calls `listView->refresh()`.\n\n---\n\n### Part 2: Standalone Window + Modal Overlay\n\n#### Static factory: `asStandaloneWindow`\n\n```cpp\nstatic std::unique_ptr asStandaloneWindow(\n const std::string& title,\n std::vector entries,\n ColorChangedFn callback,\n bool includeAlpha = false,\n style::StyleSheet::ptr_t stylesheet = nullptr);\n```\n\nImplementation sketch:\n- Creates a `ColorEditor` (heap-allocated, owned by the window).\n- If `stylesheet` is non-null, calls `editor->setStyle(stylesheet)`.\n- Creates a `juce::DocumentWindow` with title, resizable, with close button.\n- Sets `window->setContentOwned(editor.release(), true)`.\n- Sets initial size to e.g. `400 × std::min(600, rowHeight * entries.size() + headerHeight + margins)`.\n- `window->setVisible(true)`.\n\nThe returned `unique_ptr` is owned by the caller; destroying it closes the window.\n\n#### `ColorEditorModal`\n\n```cpp\nstruct ColorEditorModal : ModalBase\n{\n ColorEditorModal(std::vector entries,\n ColorEditor::ColorChangedFn callback,\n bool includeAlpha = false);\n\n juce::Point innerContentSize() override; // returns {500, 480} or similar\n void resized() override;\n\nprivate:\n std::unique_ptr editor;\n};\n```\n\n`resized()` positions `editor` to fill `getContentArea()`.\n`innerContentSize()` returns a fixed default of `{500, 480}`; callers can subclass to override.\n\n`ColorEditorModal` is used with `ScreenHolder::displayModalOverlay()`, exactly as `AlertOrPrompt` is — the caller calls `setVisible(false)` from within the callback or a close button to dismiss.\n\n---\n\n### Part 3: Stylesheet Adapters\n\nBoth are static factories on `ColorEditor`. The `StyleKey` type captures pointers to the long-lived constexpr statics:\n\n```cpp\nstruct StyleKey {\n const style::StyleSheet::Class& cls;\n const style::StyleSheet::Property& prop;\n std::string label; // display name; defaults to \"ClassName::propName\"\n};\n```\n\n#### Mode 1: flat key list\n\n```cpp\nstatic std::unique_ptr forStyleKeys(\n style::StyleSheet::ptr_t stylesheet,\n std::vector keys,\n bool includeAlpha = false);\n```\n\nBuilds `ColorEntry` per key: `tag = key.label`, `color = stylesheet->getColour(key.cls, key.prop)`.\n\n`onColorChanged` callback: finds the matching key by tag, calls `stylesheet->setColour(key.cls, key.prop, newColor)`.\n\n#### Mode 2: named color map\n\n```cpp\nstruct ColorMapEntry {\n std::string name; // display name for this color group\n std::vector keys; // all style properties sharing this color\n};\n\nstatic std::unique_ptr forColorMap(\n style::StyleSheet::ptr_t stylesheet,\n std::vector colorMap,\n bool includeAlpha = false);\n```\n\nBuilds one `ColorEntry` per `ColorMapEntry`: `tag = entry.name`, `color = stylesheet->getColour(entry.keys[0].cls, entry.keys[0].prop)` (first key is representative).\n\n`onColorChanged` callback: finds the matching group by name, calls `stylesheet->setColour(k.cls, k.prop, newColor)` for **every** key in that group.\n\n---\n\n### File Summary\n\n| File | Action |\n|------|--------|\n| `include/sst/jucegui/screens/ColorEditor.h` | **New** — all three parts in one header |\n\nNo `.cpp` needed; no changes to existing files beyond adding `#include` where callers use it. The header includes:\n- `\"ModalBase.h\"` (Part 2 modal)\n- ``\n- `\"../components/NamedPanel.h\"`\n- `\"../components/ListView.h\"`\n- `\"../style/StyleSheet.h\"`\n- `\"../style/StyleAndSettingsConsumer.h\"`\n\n---\n\n### Clarifications / decisions from follow-up\n\n1. Text field: **editable** (type a hex to set). ✓\n2. Standalone default size: **400×480**. ✓\n3. `ColorEditorModal` size: **`{500, 480}`** (constructor arg not needed for now). ✓\n4. Swatch hover: bare `juce::Component`, paints solid color fill + 1px outline; on hover draws a **white border inset** to signal interactivity. No theme-style involvement.\n5. **Viewport/scroll**: If the entry count exceeds ~15 rows the list must scroll. `ListView` already wraps a `Viewport` internally; the `ColorEditor` simply fills the content area of the `NamedPanel` with the `ListView` and the `ListView`'s internal `Viewport` handles scrolling automatically. No extra viewport layer needed.\n\n---\n\n### Part 4: Six Sines — Open Color Editor from UI Menu\n\n#### Where\n\n`SixSinesEditor::showMainMenu()` (`src/ui/six-sines-editor.cpp`) already has a \"User Interface\" submenu (`uim`). A new item \"Color Editor…\" is added there, after the Dark/Light mode separator.\n\n#### State\n\n```cpp\n// in SixSinesEditor (six-sines-editor.h)\nstd::unique_ptr colorEditorWindow;\n```\n\nOpening the window:\n```cpp\nuim.addItem(\"Color Editor...\", [w = juce::Component::SafePointer(this)]() {\n if (!w) return;\n if (w->colorEditorWindow && w->colorEditorWindow->isVisible()) {\n w->colorEditorWindow->toFront(true);\n return;\n }\n auto ce = sst::jucegui::screens::ColorEditor::forColorMap(\n w->style(), sixSinesBaseColorMap(), false);\n w->colorEditorWindow = sst::jucegui::screens::ColorEditor::asStandaloneWindow(\n \"Six Sines Color Editor\", std::move(ce));\n w->colorEditorWindow->setVisible(true);\n});\n```\n\n`sixSinesBaseColorMap()` is a free function (or static helper) in `six-sines-editor.cpp` that returns a `std::vector` covering the base styles:\n\n| Entry name | Style keys covered |\n|---|---|\n| `\"Background\"` | `Base::background` |\n| `\"Background (hover)\"` | `Base::background_hover` |\n| `\"Outline\"` | `Outlined::outline` |\n| `\"Bright Outline\"` | `Outlined::brightoutline` |\n| `\"Value\"` | `ValueBearing::value` |\n| `\"Value (hover)\"` | `ValueBearing::value_hover` |\n| `\"Value Label\"` | `ValueBearing::valuelabel` |\n| `\"Value Label (hover)\"` | `ValueBearing::valuelabel_hover` |\n| `\"Value Background\"` | `ValueBearing::valuebg` |\n| `\"Gutter\"` | `ValueGutter::gutter` |\n| `\"Gutter (hover)\"` | `ValueGutter::gutter_hover` |\n| `\"Handle\"` | `GraphicalHandle::handle` |\n| `\"Handle (hover)\"` | `GraphicalHandle::handle_hover` |\n| `\"Handle Outline\"` | `GraphicalHandle::handle_outline` |\n| `\"Modulation Handle\"` | `GraphicalHandle::modulation_handle` |\n| `\"Label Color\"` | `BaseLabel::labelcolor` |\n| `\"Label Color (hover)\"` | `BaseLabel::labelcolor_hover` |\n| `\"Push Button Fill\"` | `PushButton::fill` |\n| `\"Push Button Fill (hover)\"` | `PushButton::fill_hover` |\n| `\"Push Button Fill (pressed)\"` | `PushButton::fill_pressed` |\n\nWhen a color is changed the callback fires `style()->setColour(cls, prop, newColor)` then calls `w->repaint()` so all widgets update in real-time.\n\nThe window is closed by the user (DocumentWindow close button). `SixSinesEditor` destructor naturally destroys the window via the `unique_ptr`.\n\nNote: `forColorMap` takes a `StyleSheet::ptr_t` so changes go directly into the live sheet. This is intentional — the color editor is a live preview tool.\n\n---\n\n### Part 5: Stylesheet Serializer (`sst/jucegui/style/Serializer.h`)\n\n#### Motivation\n\nAfter customizing colors with the color editor, users want to save/load their theme. The serializer writes all colour properties of a `StyleSheet` to a text file and reads them back.\n\n#### File\n\nNew header: `include/sst/jucegui/style/Serializer.h` (header-only).\n\n#### Text format\n\nSimple key=value, one per line, comments with `#`:\n\n```\n# sst-jucegui color theme\n# format: className::propertyName=AARRGGBB\nbase::background=FF1A1A2E\nbase::background_hover=FF2A2A3E\noutlined::outline=FF444466\n...\n```\n\nKeys are `Class::cname + \"::\" + Property::pname`. Values are `juce::Colour::toDisplayString(true)` (always 8-char AARRGGBB, no `#` prefix in the file).\n\n#### API\n\n```cpp\nnamespace sst::jucegui::style\n{\nstruct Serializer\n{\n // Serialize all colour properties in the sheet to text.\n // Font properties are skipped (not serializable this way).\n static std::string toString(const StyleSheet::ptr_t& sheet);\n\n // Parse text produced by toString() and apply colours to sheet.\n // Unknown keys are silently ignored (forward compatibility).\n // Returns false if the string is unparseable.\n static bool fromString(const StyleSheet::ptr_t& sheet, const std::string& content);\n};\n}\n```\n\nFile I/O is the responsibility of the calling application. `toString`/`fromString` deal in `std::string` only; the caller reads/writes the file using whatever mechanism fits (JUCE `File`, `std::filesystem`, etc.).\n\n#### Implementation sketch\n\n**`toString`**: Iterates `StyleSheet::allClasses` → for each class, iterates `StyleSheet::allProperties[cls]` → skips `Property::FONT` type → calls `sheet->getColour(cls, prop)` → formats line as `cname::pname=AARRGGBB`.\n\n**`fromString`**: Splits on newlines, skips `#` comment lines. For each `key=value` line: splits on `::` to get class name and remainder, splits remainder on `=` to get property name and colour hex. Searches `StyleSheet::allClasses` by `strcmp(cls->cname, classNameStr)`, then searches `StyleSheet::allProperties[cls]` by `strcmp(prop->pname, propNameStr)`. If found and `prop->type == Property::COLOUR`, calls `sheet->setColour(*cls, *prop, juce::Colour::fromString(valueStr))`.\n\n#### Six Sines integration\n\nThe `ColorEditor`'s hamburger menu gets two items via `addAdditionalHamburgerComponent` — or, more simply, the `ColorEditor`'s `NamedPanel` hamburger callback is set by the caller in `six-sines-editor.cpp` to show a small popup with:\n\n- **\"Save Color Theme…\"** — `juce::FileChooser` for `.ssttheme` files; on success reads `Serializer::toString(style())` and writes it to the chosen file using `juce::File::replaceWithText`.\n- **\"Load Color Theme…\"** — `juce::FileChooser` to open `.ssttheme`; on success reads file text with `juce::File::loadFileAsString`, calls `Serializer::fromString(style(), text)`, then calls `repaint()` on the main editor and refreshes the color editor's list.\n\nAll `juce::File` usage stays in `six-sines-editor.cpp`; `Serializer.h` never sees a file path.\n\n---\n\n### Updated File Summary\n\n| File | Action |\n|---|---|\n| `include/sst/jucegui/screens/ColorEditor.h` | **New** — Parts 1–3 in one header |\n| `include/sst/jucegui/style/Serializer.h` | **New** — Part 5 (stylesheet text serialization) |\n| `src/ui/six-sines-editor.h` | Add `colorEditorWindow` member |\n| `src/ui/six-sines-editor.cpp` | Add Color Editor menu item + `sixSinesBaseColorMap()` helper; Save/Load theme items |\n" }, { "path": "doc/12_roadmap.md", "content": "# Six Sines 1.2 Roadmap\n\nI have a lot of ideas for a '1.2' version of six sines. Not 2.0. Still compatible. But expanded. Here's my rough list\n\n## CZ-style PD features **UNDERWAY**\n\n- Implement phase remap **done**\n- Implement phase formant sweep + window style\n\n## Upgrades to the Resampler, Final path, and Reconstruction\n\n- Make the upsample / downsample path have more control and better viz\n- Specifically have the pipeline be\n - Run at internal sample rate to make high bit rate clean signal\n - Soft drive saturator (use the cubic clamp form) with optional small drive\n - Add a cytomic SVF at 16khz / root 2 resonance\n - ZOH decimate the signal to 32khz at upper rate\n - Do a bitheight redicution (round(f * (1<op5, etc...) have a 10x depth control\n - Allow the last point of the enelope of lfo to participate in the node mod matrix\n - Add an 'Envelope Retrigger from Zero' mode\n - Ratio (Fine) as well as Ration available as target in operator matrix\n - Smooth the velocity source in the mod matrix to avoid jumps when using velocity\n as a modulator in legato modes\n - Add 'Linear' and 'ZOH' resampler options\n - Fix the TX tables to match the TX81Z more accurately; rename the prior incorrect tables\n to 'spiky' variants\n - Add a 'coarse' tune knob in addition to a 'fine' tune\n - Portamento Continuation allows porta to restart on release, on new voice, and so on\n - Fix several temposync bugs in the LFO\n - Add TZLinear FM and Exponential FM as modulation modes for the mod matrix, in addition\n to PM and RM; add scaling (abs, unipolar, normal) modes to the RM\n - Add 'Solo' feature to the mixer\n - Update the voice manager, allowing full note id support in VST3 and CLAP in legato modes\n - Add a collection of 'Window' style waveforms, useful for AM/RM modelling\n - Add an LFO Start Phase control\n - Fix a problem where the center voice was mis-identified in unison in some cases\n\n- User Interface\n - Add a suite of accesibility fixes to various controls\n - Add UI scaling from 75-150%\n - Add a light-mode skin\n - Allow fractional typeins on ratios\n - You can copy and paste nodes or node regions between nodes.\n - Consistent dirty flag displays in UI when patch is modified and unsaved to disk or DAW\n - Temposync string values reflect properly in clap parameter displays\n - Temposync controlls allow typein like '1/4' or '1/16.' or '1/8T'\n - Ratio buttons have a jog control\n - Add an option to reposition sources and matrices\n - Fix a problem with mouse wheel on macos when using an actual mouse (as opposed to trackpad)\n - Fix a problem with tooltip hover sticking\n - Fix a problem where the jog buttons on patch selector would mis-jump after saving a patch\n - Obey upper bound correctly on DAHDR typeins\n\n- Plugin related improvements\n - Add parameter smoothing to clap params\n - Add support for CLAP and VST3 pan, tune, and volume note expressions\n - Wrap all parameter changes in begin/end consistently\n - Call `gui::set_size` consistently on scale changes, fixing a windows reaper sizing issue\n \n- Code Improvements\n - Remove some troublesome uses of thread_local storage in envelopes and elsewhere\n - Place visual indication of a debug build in the UI\n - Move to a list/grid based layout; port the code back to sst-jucegui and adjust screens\n - Consolidate target locations when building both in pipeline and locally\n - Move juce LookandFeel management to the shared sst-jucegui pacakge\n - Substantial improvements to the performance of the LFO and Envelope classes under\n constant rate.\n - Clean up the patch load / sync mechanism to be more thread-aware\n - Set modsource param max to allow all mod sources. (the 'UNK2048' problem)\n - Implement (but leave off) the clap preset-factory mechanism.\n\n- Infrastructure\n - Move the macOS minimum to 10.14\n - Build with docker ubuntu 20 image for linux\n - Add an option to disable the juce Software renderer on Windows\n - Fix a problem with UTF16 paths and patch loading on Windows.\n - Fix a problem with keyboard input in the VST3 in Studio1 and Live on Windows.\n\n- Documentation and Content\n - Upgrade the manual to include the wonderful videos from Taron\n - New patches from Videco\n - New patches from SiL3NC3\n - Fix a few patches which were tuned off by 7 semitones\n\n## v1.0.5, .4, .3, .2, and .1\n\nv1.0.0-v1.0.5 contains a set of changes we found in the days after 1.0.0\n\n- Make the minimum macos version 10.14\n- Build the linux distribution with a ubuntu 20 docker image\n- Adjust the clap wrapper to work correctly in Logic/AUv2 at non 44.1 sample rates\n- Inform the clap host of param changes on reload\n\n## v1.0.0\n\nv1.0.0 is the first release of the synth, with core features intact" }, { "path": "doc/manual.md", "content": "# Six Sines Manual\n\nSix Sines is a small synth based on audio rate modulation (techniques\noften called \"Phase Modulation\" and \"Digitial Ring Modulation\").\nIt has an architecture which allows lots of modulation and a synth\nengine with a couple of tricks which make it sound pretty good.\n\nYou can download the latest release or Nightly version of\nSix Sines [here](https://github.com/baconpaul/six-sines/releases).\nSix Sines is free and open source software. You can get, study,\nmodify, and re-use the source for it [here](https://github.com/baconpaul/six-sines).\nAnd please read the [acknowldgements](ack.md) for a list of thanks.\n\nAnd following in the legacy of other PM and FM synths, it is not\nexactly easy to program. The sort of 'symmetric/maximal' signal\npath design approach exacerbates this problem, as does the relatively\nthin manual you are reading right now. But don't fear! You can have\nfun with the synth anyway.\n\n## I don't want to read a manual. Are there any good YT vids?\n\nYes! As part of the [one synth challenge](https://www.kvraudio.com/forum/viewtopic.php?t=618178&start=45) in Feb 2025, \nKVR users [Taron](http://www.taron.de) made a series of videos showing how to\ndo sound design in six sines.\n\n- [Video One - Six Sines First Steps](https://youtu.be/fP4wNFigUt4?si=uKoq_MVoYYqzQkN3)\n- [Video Two - Exploring AM](https://youtu.be/JU1Yzfb5U_c?si=lyaKbKRye48EvmSz)\n- [Video Three - FM and AM](https://www.youtube.com/watch?v=X7RTZz2G2ig)\n- [Video Four - Making a simple drumpset](https://www.youtube.com/watch?v=HnpFRSw-QBc)\n\nThanks so much for these, Taron! They are great!\n\n## How the synthesis works, basically\n\nIts a 6 operator FM synth, more or less. \n\nEach of the 6 operators can output to audio or can modulate\nthemselves (feedback) or subsequent operators. So operator 3\ncan feedback its own signal or modulate operators 4, 5, and 6.\n\nModulation of subsequent operators can be phase modulation\n(the 'phi' symbol) or digital ring/audio-rate-amplitude modulation\n(the 'A' symbol).\n\nBut the real trick of sound design with the thing is the\nmodulation architecture. Each knob on the screen represents\na node with an independent envelope and LFO per voice.\nSo each operator, operator modulation application,\noperator feedback, and operator level can be independently\nand individually modulated.\n\nWoof. That's work. But its fun!\n\n## The Main Interface\n\n![Six Sines Main Screen](sxsn_main.png) \n\nThe Six Sines interface has a patch selector and main menu\nwith a VU meter at the top, then presents sections for each\nof the core functions. The operators span the top with the\nknob for each being their ratio, the modulation matrix is below,\nthe mixer to the side, and then the main output above. The \nmacro section participates in modulation.\n\nEach knob has a 'power' button which means the node doesnt\nrun in a voice in any capacity, and subsequently uses no CPU.\n\n## The Visual Signal Path\n\n![Six Sines Main Screen](sxsn_sigpath.png) \n\nHere we show the signal path for operator 3. Yellow lines\nshow audio signals presented for auido output, and green\nlines show audio signals which are used for modulation.\n\nIt starts at the \"Ratio\" node which sets the frequency\nof the operator. Then the audio signal travels to the matrix\nwhere it first intersects the op3 feedback node and self modulates.\nThe resulting audio travels to the mixer where it is leveled\nby an independent op3 audio node, and then is mixed into the main\noutput.\n\nThe same signal travels further into the modulation matrix\nproviding modulation for ops 4, 5, and 6.\n\n## Inside a node\n\n![Six Sines Main Screen Node](sxsn_sub.png)\n\nOnce you click a knob to select it or edit it the bottom\npart of the user interface shows the modulation screen for\nthat node. Node 'classes' (ratio, cross matrix, feedback, mixer, main)\nhave subtly different modulation screens but the core idea is an \nenvelope, an LFO, application depth controls, and then performance\nmodulation areas.\n\nThe performance modulation area allows you to map MIDI and\nMacros to the modulation and level beyond the internal modulators.\n\n## Envelopes, Triggering, and Voice Modes\n\nThe synth has two voicing modes, a Polyphonic and a Monophonic \nmode. In the polyhonic mode, it additionally has a per-key piano mode.\nThese modes control how and when voices are created.\n\nIn polyphonic mode with piano mode off, a voice is created on\nevery key press.\n\nIn polyphonic mode with piano mode on, a voice is created\non a key press unless there is already a voice sounding on\nthat key, in which case that voice is retriggered.\n\nIn monophonic mode, a voice is created only when no voice is \nplaying. If a subsequent key press happens, the voice is moved\nand retriggered.\n\nRetriggering retriggers envelopes and each enveope can trigger\non one of four ways.\n\n- On voice start only. If you use this it can sound like a stuck\nnote if you aren't careful. Its not. \n- On voice start or on a voice being re-keyed when not keyed (or\n\"on gate changed\" in modular speak)\n- On any key press\n- On release. In on-release mode, the envelope is gated if the \nvoice is ungated, so resuming a gate gesture on a note will\nrelease the OnRelease envelope.\n\nThe default for an envelope is 'Patch Default' which is set in the\nsettings screen, but you can override.\n\n## The Settings Screen\n\nPress the COG icon at the top of the UI to get the settings\nscreen, where you can control MPE, Mono mode, pitch bend depth,\nand more.\n\n## Oversampling\n\nThe setting screen contains an oversampling control. The Six Sines oversampling\nstrategy has the engine run at a fixed rate mostly independent of\nthe host sample rate which is stored in the patch and you control.\n\nMostly, because our resampler (a short FIR interpolator) works\nway better at round multiple downsampling. 2.5x is a lot better than\n2.61x or such. So our oversample levels are fixed offsets from\neither 44.1 or 48khz. If you choose, say, \"132.3/144khz\" as your engine \nsample rate, if your host sample rate is a multiple of 44.1 we will\nchoose the lower, and of 48 the higher.\n\nYou may need to adjust oversampling in some high feedback cases.\nIt of course burns cpu as it goes up and for most patches\nthe default 2.5x is just fine.\n\n## Screen Reader and Accessible Support\n\nSix Sines supports screen readers and accessible gestures, making\nthe UI and programming model as inscrutable to these assistive technologies\nas it is to users with a visual display. Since the UI is quite big there's\na few extra features for screen reader navigation.\n\nFirst, standard edit gestures should work on all controls, and I tried\nreally hard to make sure tab order makes sense and labels are reasonable. If\nyou find one which is wrong, please just drop a note on discord or github.\n\nThe structure of the UI is that knobs (like \"Op3 feedback level\") a panel\nin the bottom 1/4 of the screen to edit the modulators and stuff. This panel\narrives when you mouse click or edit the knob. A few features make this\neasier to navigate for a screen reader.\n\nIf on a knob in the top third, `Command-A` will arm that knob (namely select the\nknob modulation panel in the area below)\n\nIf on a knob in the top third, `Command-J` will jump to the control panel in the\nbottom\n\nAnd finally from anywhere in the UI, `Command-N` will expose a menu allowing\nyou to focus any of the focusable top-section knobs or preset manager.\n\n## Good Luck, and..\n\nGood luck! Its fun. But tricky. If you want to add to this manual\nplease do send a PR over.\n" }, { "path": "libs/CMakeLists.txt", "content": "add_subdirectory(sst/sst-cmake)\n\nadd_library(catch2 INTERFACE)\ntarget_include_directories(catch2 INTERFACE catch2/include)\n\nadd_subdirectory(clap-libs/clap EXCLUDE_FROM_ALL)\nadd_subdirectory(clap-libs/clap-helpers EXCLUDE_FROM_ALL)\nadd_subdirectory(fmt EXCLUDE_FROM_ALL)\n\nadd_subdirectory(sst/sst-clap-helpers)\nadd_clap_juce_shim(JUCE_PATH \"${JUCE_PATH}\")\n\nadd_library(simde INTERFACE)\ntarget_include_directories(simde INTERFACE simde)\nadd_subdirectory(sst/sst-cpputils)\nadd_subdirectory(sst/sst-basic-blocks)\nadd_subdirectory(sst/sst-jucegui)\nadd_subdirectory(sst/sst-voicemanager)\n\nset(SST_PLUGININFRA_PROVIDE_TINYXML ON CACHE BOOL \"yesxml\")\nset(SST_PLUGININFRA_PROVIDE_PATCHBASE ON CACHE BOOL \"patchbase pls\")\nadd_subdirectory(sst/sst-plugininfra)\n\nadd_library(mts-esp-client STATIC MTS-ESP/Client/libMTSClient.cpp)\ntarget_include_directories(mts-esp-client PUBLIC MTS-ESP/Client)\n\nset(CLAP_WRAPPER_DOWNLOAD_DEPENDENCIES TRUE CACHE BOOL \"Get em\")\nset(CLAP_WRAPPER_DONT_ADD_TARGETS TRUE CACHE BOOL \"I'll targetize\")\nset(CLAP_WRAPPER_BUILD_AUV2 TRUE CACHE BOOL \"It's only logical\")\nif (APPLE)\n # BaconPaul has jack kinda installed\n set(RTAUDIO_API_JACK FALSE CACHE BOOL \"Not on apple\")\nendif()\n\nadd_subdirectory(clap-libs/clap-wrapper)\n\nadd_subdirectory(libsamplerate)" }, { "path": "libs/catch2/include/catch2/catch2.hpp", "content": "/*\n * Catch v2.13.9\n * Generated: 2022-04-12 22:37:23.260201\n * ----------------------------------------------------------\n * This file has been merged from multiple headers. Please don't edit it directly\n * Copyright (c) 2022 Two Blue Cubes Ltd. All rights reserved.\n *\n * Distributed under the Boost Software License, Version 1.0. (See accompanying\n * file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)\n */\n#ifndef TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED\n#define TWOBLUECUBES_SINGLE_INCLUDE_CATCH_HPP_INCLUDED\n// start catch.hpp\n\n#define CATCH_VERSION_MAJOR 2\n#define CATCH_VERSION_MINOR 13\n#define CATCH_VERSION_PATCH 9\n\n#ifdef __clang__\n#pragma clang system_header\n#elif defined __GNUC__\n#pragma GCC system_header\n#endif\n\n// start catch_suppress_warnings.h\n\n#ifdef __clang__\n#ifdef __ICC // icpc defines the __clang__ macro\n#pragma warning(push)\n#pragma warning(disable : 161 1682)\n#else // __ICC\n#pragma clang diagnostic push\n#pragma clang diagnostic ignored \"-Wpadded\"\n#pragma clang diagnostic ignored \"-Wswitch-enum\"\n#pragma clang diagnostic ignored \"-Wcovered-switch-default\"\n#endif\n#elif defined __GNUC__\n// Because REQUIREs trigger GCC's -Wparentheses, and because still\n// supported version of g++ have only buggy support for _Pragmas,\n// Wparentheses have to be suppressed globally.\n#pragma GCC diagnostic ignored \"-Wparentheses\" // See #674 for details\n\n#pragma GCC diagnostic push\n#pragma GCC diagnostic ignored \"-Wunused-variable\"\n#pragma GCC diagnostic ignored \"-Wpadded\"\n#endif\n// end catch_suppress_warnings.h\n#if defined(CATCH_CONFIG_MAIN) || defined(CATCH_CONFIG_RUNNER)\n#define CATCH_IMPL\n#define CATCH_CONFIG_ALL_PARTS\n#endif\n\n// In the impl file, we want to have access to all parts of the headers\n// Can also be used to sanely support PCHs\n#if defined(CATCH_CONFIG_ALL_PARTS)\n#define CATCH_CONFIG_EXTERNAL_INTERFACES\n#if defined(CATCH_CONFIG_DISABLE_MATCHERS)\n#undef CATCH_CONFIG_DISABLE_MATCHERS\n#endif\n#if !defined(CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER)\n#define CATCH_CONFIG_ENABLE_CHRONO_STRINGMAKER\n#endif\n#endif\n\n#if !defined(CATCH_CONFIG_IMPL_ONLY)\n// start catch_platform.h\n\n// See e.g.:\n// https://opensource.apple.com/source/CarbonHeaders/CarbonHeaders-18.1/TargetConditionals.h.auto.html\n#ifdef __APPLE__\n#include \n#if (defined(TARGET_OS_OSX) && TARGET_OS_OSX == 1) || (defined(TARGET_OS_MAC) && TARGET_OS_MAC == 1)\n#define CATCH_PLATFORM_MAC\n#elif (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE == 1)\n#define CATCH_PLATFORM_IPHONE\n#endif\n\n#elif defined(linux) || defined(__linux) || defined(__linux__)\n#define CATCH_PLATFORM_LINUX\n\n#elif defined(WIN32) || defined(__WIN32__) || defined(_WIN32) || defined(_MSC_VER) || \\\n defined(__MINGW32__)\n#define CATCH_PLATFORM_WINDOWS\n#endif\n\n// end catch_platform.h\n\n#ifdef CATCH_IMPL\n#ifndef CLARA_CONFIG_MAIN\n#define CLARA_CONFIG_MAIN_NOT_DEFINED\n#define CLARA_CONFIG_MAIN\n#endif\n#endif\n\n// start catch_user_interfaces.h\n\nnamespace Catch\n{\nunsigned int rngSeed();\n}\n\n// end catch_user_interfaces.h\n// start catch_tag_alias_autoregistrar.h\n\n// start catch_common.h\n\n// start catch_compiler_capabilities.h\n\n// Detect a number of compiler features - by compiler\n// The following features are defined:\n//\n// CATCH_CONFIG_COUNTER : is the __COUNTER__ macro supported?\n// CATCH_CONFIG_WINDOWS_SEH : is Windows SEH supported?\n// CATCH_CONFIG_POSIX_SIGNALS : are POSIX signals supported?\n// CATCH_CONFIG_DISABLE_EXCEPTIONS : Are exceptions enabled?\n// ****************\n// Note to maintainers: if new toggles are added please document them\n// in configuration.md, too\n// ****************\n\n// In general each macro has a _NO_ form\n// (e.g. CATCH_CONFIG_NO_POSIX_SIGNALS) which disables the feature.\n// Many features, at point of detection, define an _INTERNAL_ macro, so they\n// can be combined, en-mass, with the _NO_ forms later.\n\n#ifdef __cplusplus\n\n#if (__cplusplus >= 201402L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201402L)\n#define CATCH_CPP14_OR_GREATER\n#endif\n\n#if (__cplusplus >= 201703L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 201703L)\n#define CATCH_CPP17_OR_GREATER\n#endif\n\n#endif\n\n// Only GCC compiler should be used in this block, so other compilers trying to\n// mask themselves as GCC should be ignored.\n#if defined(__GNUC__) && !defined(__clang__) && !defined(__ICC) && !defined(__CUDACC__) && \\\n !defined(__LCC__)\n#define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma(\"GCC diagnostic push\")\n#define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma(\"GCC diagnostic pop\")\n\n#define CATCH_INTERNAL_IGNORE_BUT_WARN(...) (void)__builtin_constant_p(__VA_ARGS__)\n\n#endif\n\n#if defined(__clang__)\n\n#define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION _Pragma(\"clang diagnostic push\")\n#define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION _Pragma(\"clang diagnostic pop\")\n\n// As of this writing, IBM XL's implementation of __builtin_constant_p has a bug\n// which results in calls to destructors being emitted for each temporary,\n// without a matching initialization. In practice, this can result in something\n// like `std::string::~string` being called on an uninitialized value.\n//\n// For example, this code will likely segfault under IBM XL:\n// ```\n// REQUIRE(std::string(\"12\") + \"34\" == \"1234\")\n// ```\n//\n// Therefore, `CATCH_INTERNAL_IGNORE_BUT_WARN` is not implemented.\n#if !defined(__ibmxl__) && !defined(__CUDACC__)\n#define CATCH_INTERNAL_IGNORE_BUT_WARN(...) \\\n (void)__builtin_constant_p( \\\n __VA_ARGS__) /* NOLINT(cppcoreguidelines-pro-type-vararg, hicpp-vararg) */\n#endif\n\n#define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \\\n _Pragma(\"clang diagnostic ignored \\\"-Wexit-time-destructors\\\"\") \\\n _Pragma(\"clang diagnostic ignored \\\"-Wglobal-constructors\\\"\")\n\n#define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS \\\n _Pragma(\"clang diagnostic ignored \\\"-Wparentheses\\\"\")\n\n#define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS \\\n _Pragma(\"clang diagnostic ignored \\\"-Wunused-variable\\\"\")\n\n#define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS \\\n _Pragma(\"clang diagnostic ignored \\\"-Wgnu-zero-variadic-macro-arguments\\\"\")\n\n#define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS \\\n _Pragma(\"clang diagnostic ignored \\\"-Wunused-template\\\"\")\n\n#endif // __clang__\n\n////////////////////////////////////////////////////////////////////////////////\n// Assume that non-Windows platforms support posix signals by default\n#if !defined(CATCH_PLATFORM_WINDOWS)\n#define CATCH_INTERNAL_CONFIG_POSIX_SIGNALS\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// We know some environments not to support full POSIX signals\n#if defined(__CYGWIN__) || defined(__QNX__) || defined(__EMSCRIPTEN__) || defined(__DJGPP__)\n#define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS\n#endif\n\n#ifdef __OS400__\n#define CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS\n#define CATCH_CONFIG_COLOUR_NONE\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// Android somehow still does not support std::to_string\n#if defined(__ANDROID__)\n#define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING\n#define CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// Not all Windows environments support SEH properly\n#if defined(__MINGW32__)\n#define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// PS4\n#if defined(__ORBIS__)\n#define CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// Cygwin\n#ifdef __CYGWIN__\n\n// Required for some versions of Cygwin to declare gettimeofday\n// see: http://stackoverflow.com/questions/36901803/gettimeofday-not-declared-in-this-scope-cygwin\n#define _BSD_SOURCE\n// some versions of cygwin (most) do not support std::to_string. Use the libstd check.\n// https://gcc.gnu.org/onlinedocs/gcc-4.8.2/libstdc++/api/a01053_source.html line 2812-2813\n#if !((__cplusplus >= 201103L) && defined(_GLIBCXX_USE_C99) && \\\n !defined(_GLIBCXX_HAVE_BROKEN_VSWPRINTF))\n\n#define CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING\n\n#endif\n#endif // __CYGWIN__\n\n////////////////////////////////////////////////////////////////////////////////\n// Visual C++\n#if defined(_MSC_VER)\n\n// Universal Windows platform does not support SEH\n// Or console colours (or console at all...)\n#if defined(WINAPI_FAMILY) && (WINAPI_FAMILY == WINAPI_FAMILY_APP)\n#define CATCH_CONFIG_COLOUR_NONE\n#else\n#define CATCH_INTERNAL_CONFIG_WINDOWS_SEH\n#endif\n\n#if !defined(__clang__) // Handle Clang masquerading for msvc\n\n// MSVC traditional preprocessor needs some workaround for __VA_ARGS__\n// _MSVC_TRADITIONAL == 0 means new conformant preprocessor\n// _MSVC_TRADITIONAL == 1 means old traditional non-conformant preprocessor\n#if !defined(_MSVC_TRADITIONAL) || (defined(_MSVC_TRADITIONAL) && _MSVC_TRADITIONAL)\n#define CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR\n#endif // MSVC_TRADITIONAL\n\n// Only do this if we're not using clang on Windows, which uses `diagnostic push` & `diagnostic pop`\n#define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION __pragma(warning(push))\n#define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION __pragma(warning(pop))\n#endif // __clang__\n\n#endif // _MSC_VER\n\n#if defined(_REENTRANT) || defined(_MSC_VER)\n// Enable async processing, as -pthread is specified or no additional linking is required\n#define CATCH_INTERNAL_CONFIG_USE_ASYNC\n#endif // _MSC_VER\n\n////////////////////////////////////////////////////////////////////////////////\n// Check if we are compiled with -fno-exceptions or equivalent\n#if defined(__EXCEPTIONS) || defined(__cpp_exceptions) || defined(_CPPUNWIND)\n#define CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n// DJGPP\n#ifdef __DJGPP__\n#define CATCH_INTERNAL_CONFIG_NO_WCHAR\n#endif // __DJGPP__\n\n////////////////////////////////////////////////////////////////////////////////\n// Embarcadero C++Build\n#if defined(__BORLANDC__)\n#define CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n\n// Use of __COUNTER__ is suppressed during code analysis in\n// CLion/AppCode 2017.2.x and former, because __COUNTER__ is not properly\n// handled by it.\n// Otherwise all supported compilers support COUNTER macro,\n// but user still might want to turn it off\n#if (!defined(__JETBRAINS_IDE__) || __JETBRAINS_IDE__ >= 20170300L)\n#define CATCH_INTERNAL_CONFIG_COUNTER\n#endif\n\n////////////////////////////////////////////////////////////////////////////////\n\n// RTX is a special version of Windows that is real time.\n// This means that it is detected as Windows, but does not provide\n// the same set of capabilities as real Windows does.\n#if defined(UNDER_RTSS) || defined(RTX64_BUILD)\n#define CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH\n#define CATCH_INTERNAL_CONFIG_NO_ASYNC\n#define CATCH_CONFIG_COLOUR_NONE\n#endif\n\n#if !defined(_GLIBCXX_USE_C99_MATH_TR1)\n#define CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER\n#endif\n\n// Various stdlib support checks that require __has_include\n#if defined(__has_include)\n// Check if string_view is available and usable\n#if __has_include() && defined(CATCH_CPP17_OR_GREATER)\n#define CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW\n#endif\n\n// Check if optional is available and usable\n#if __has_include() && defined(CATCH_CPP17_OR_GREATER)\n#define CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL\n#endif // __has_include() && defined(CATCH_CPP17_OR_GREATER)\n\n// Check if byte is available and usable\n#if __has_include() && defined(CATCH_CPP17_OR_GREATER)\n#include \n#if defined(__cpp_lib_byte) && (__cpp_lib_byte > 0)\n#define CATCH_INTERNAL_CONFIG_CPP17_BYTE\n#endif\n#endif // __has_include() && defined(CATCH_CPP17_OR_GREATER)\n\n// Check if variant is available and usable\n#if __has_include() && defined(CATCH_CPP17_OR_GREATER)\n#if defined(__clang__) && (__clang_major__ < 8)\n// work around clang bug with libstdc++ https://bugs.llvm.org/show_bug.cgi?id=31852\n// fix should be in clang 8, workaround in libstdc++ 8.2\n#include \n#if defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9)\n#define CATCH_CONFIG_NO_CPP17_VARIANT\n#else\n#define CATCH_INTERNAL_CONFIG_CPP17_VARIANT\n#endif // defined(__GLIBCXX__) && defined(_GLIBCXX_RELEASE) && (_GLIBCXX_RELEASE < 9)\n#else\n#define CATCH_INTERNAL_CONFIG_CPP17_VARIANT\n#endif // defined(__clang__) && (__clang_major__ < 8)\n#endif // __has_include() && defined(CATCH_CPP17_OR_GREATER)\n#endif // defined(__has_include)\n\n#if defined(CATCH_INTERNAL_CONFIG_COUNTER) && !defined(CATCH_CONFIG_NO_COUNTER) && \\\n !defined(CATCH_CONFIG_COUNTER)\n#define CATCH_CONFIG_COUNTER\n#endif\n#if defined(CATCH_INTERNAL_CONFIG_WINDOWS_SEH) && !defined(CATCH_CONFIG_NO_WINDOWS_SEH) && \\\n !defined(CATCH_CONFIG_WINDOWS_SEH) && !defined(CATCH_INTERNAL_CONFIG_NO_WINDOWS_SEH)\n#define CATCH_CONFIG_WINDOWS_SEH\n#endif\n// This is set by default, because we assume that unix compilers are posix-signal-compatible by\n// default.\n#if defined(CATCH_INTERNAL_CONFIG_POSIX_SIGNALS) && \\\n !defined(CATCH_INTERNAL_CONFIG_NO_POSIX_SIGNALS) && !defined(CATCH_CONFIG_NO_POSIX_SIGNALS) && \\\n !defined(CATCH_CONFIG_POSIX_SIGNALS)\n#define CATCH_CONFIG_POSIX_SIGNALS\n#endif\n// This is set by default, because we assume that compilers with no wchar_t support are just rare\n// exceptions.\n#if !defined(CATCH_INTERNAL_CONFIG_NO_WCHAR) && !defined(CATCH_CONFIG_NO_WCHAR) && \\\n !defined(CATCH_CONFIG_WCHAR)\n#define CATCH_CONFIG_WCHAR\n#endif\n\n#if !defined(CATCH_INTERNAL_CONFIG_NO_CPP11_TO_STRING) && \\\n !defined(CATCH_CONFIG_NO_CPP11_TO_STRING) && !defined(CATCH_CONFIG_CPP11_TO_STRING)\n#define CATCH_CONFIG_CPP11_TO_STRING\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_CPP17_OPTIONAL) && !defined(CATCH_CONFIG_NO_CPP17_OPTIONAL) && \\\n !defined(CATCH_CONFIG_CPP17_OPTIONAL)\n#define CATCH_CONFIG_CPP17_OPTIONAL\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_CPP17_STRING_VIEW) && \\\n !defined(CATCH_CONFIG_NO_CPP17_STRING_VIEW) && !defined(CATCH_CONFIG_CPP17_STRING_VIEW)\n#define CATCH_CONFIG_CPP17_STRING_VIEW\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_CPP17_VARIANT) && !defined(CATCH_CONFIG_NO_CPP17_VARIANT) && \\\n !defined(CATCH_CONFIG_CPP17_VARIANT)\n#define CATCH_CONFIG_CPP17_VARIANT\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_CPP17_BYTE) && !defined(CATCH_CONFIG_NO_CPP17_BYTE) && \\\n !defined(CATCH_CONFIG_CPP17_BYTE)\n#define CATCH_CONFIG_CPP17_BYTE\n#endif\n\n#if defined(CATCH_CONFIG_EXPERIMENTAL_REDIRECT)\n#define CATCH_INTERNAL_CONFIG_NEW_CAPTURE\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_NEW_CAPTURE) && \\\n !defined(CATCH_INTERNAL_CONFIG_NO_NEW_CAPTURE) && !defined(CATCH_CONFIG_NO_NEW_CAPTURE) && \\\n !defined(CATCH_CONFIG_NEW_CAPTURE)\n#define CATCH_CONFIG_NEW_CAPTURE\n#endif\n\n#if !defined(CATCH_INTERNAL_CONFIG_EXCEPTIONS_ENABLED) && !defined(CATCH_CONFIG_DISABLE_EXCEPTIONS)\n#define CATCH_CONFIG_DISABLE_EXCEPTIONS\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_POLYFILL_ISNAN) && !defined(CATCH_CONFIG_NO_POLYFILL_ISNAN) && \\\n !defined(CATCH_CONFIG_POLYFILL_ISNAN)\n#define CATCH_CONFIG_POLYFILL_ISNAN\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_USE_ASYNC) && !defined(CATCH_INTERNAL_CONFIG_NO_ASYNC) && \\\n !defined(CATCH_CONFIG_NO_USE_ASYNC) && !defined(CATCH_CONFIG_USE_ASYNC)\n#define CATCH_CONFIG_USE_ASYNC\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_ANDROID_LOGWRITE) && \\\n !defined(CATCH_CONFIG_NO_ANDROID_LOGWRITE) && !defined(CATCH_CONFIG_ANDROID_LOGWRITE)\n#define CATCH_CONFIG_ANDROID_LOGWRITE\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_GLOBAL_NEXTAFTER) && \\\n !defined(CATCH_CONFIG_NO_GLOBAL_NEXTAFTER) && !defined(CATCH_CONFIG_GLOBAL_NEXTAFTER)\n#define CATCH_CONFIG_GLOBAL_NEXTAFTER\n#endif\n\n// Even if we do not think the compiler has that warning, we still have\n// to provide a macro that can be used by the code.\n#if !defined(CATCH_INTERNAL_START_WARNINGS_SUPPRESSION)\n#define CATCH_INTERNAL_START_WARNINGS_SUPPRESSION\n#endif\n#if !defined(CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION)\n#define CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION\n#endif\n#if !defined(CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS)\n#define CATCH_INTERNAL_SUPPRESS_PARENTHESES_WARNINGS\n#endif\n#if !defined(CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS)\n#define CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS\n#endif\n#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS)\n#define CATCH_INTERNAL_SUPPRESS_UNUSED_WARNINGS\n#endif\n#if !defined(CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS)\n#define CATCH_INTERNAL_SUPPRESS_ZERO_VARIADIC_WARNINGS\n#endif\n\n// The goal of this macro is to avoid evaluation of the arguments, but\n// still have the compiler warn on problems inside...\n#if !defined(CATCH_INTERNAL_IGNORE_BUT_WARN)\n#define CATCH_INTERNAL_IGNORE_BUT_WARN(...)\n#endif\n\n#if defined(__APPLE__) && defined(__apple_build_version__) && (__clang_major__ < 10)\n#undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS\n#elif defined(__clang__) && (__clang_major__ < 5)\n#undef CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS\n#endif\n\n#if !defined(CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS)\n#define CATCH_INTERNAL_SUPPRESS_UNUSED_TEMPLATE_WARNINGS\n#endif\n\n#if defined(CATCH_CONFIG_DISABLE_EXCEPTIONS)\n#define CATCH_TRY if ((true))\n#define CATCH_CATCH_ALL if ((false))\n#define CATCH_CATCH_ANON(type) if ((false))\n#else\n#define CATCH_TRY try\n#define CATCH_CATCH_ALL catch (...)\n#define CATCH_CATCH_ANON(type) catch (type)\n#endif\n\n#if defined(CATCH_INTERNAL_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR) && \\\n !defined(CATCH_CONFIG_NO_TRADITIONAL_MSVC_PREPROCESSOR) && \\\n !defined(CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR)\n#define CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR\n#endif\n\n// end catch_compiler_capabilities.h\n#define INTERNAL_CATCH_UNIQUE_NAME_LINE2(name, line) name##line\n#define INTERNAL_CATCH_UNIQUE_NAME_LINE(name, line) INTERNAL_CATCH_UNIQUE_NAME_LINE2(name, line)\n#ifdef CATCH_CONFIG_COUNTER\n#define INTERNAL_CATCH_UNIQUE_NAME(name) INTERNAL_CATCH_UNIQUE_NAME_LINE(name, __COUNTER__)\n#else\n#define INTERNAL_CATCH_UNIQUE_NAME(name) INTERNAL_CATCH_UNIQUE_NAME_LINE(name, __LINE__)\n#endif\n\n#include \n#include \n#include \n\n// We need a dummy global operator<< so we can bring it into Catch namespace later\nstruct Catch_global_namespace_dummy\n{\n};\nstd::ostream &operator<<(std::ostream &, Catch_global_namespace_dummy);\n\nnamespace Catch\n{\n\nstruct CaseSensitive\n{\n enum Choice\n {\n Yes,\n No\n };\n};\n\nclass NonCopyable\n{\n NonCopyable(NonCopyable const &) = delete;\n NonCopyable(NonCopyable &&) = delete;\n NonCopyable &operator=(NonCopyable const &) = delete;\n NonCopyable &operator=(NonCopyable &&) = delete;\n\n protected:\n NonCopyable();\n virtual ~NonCopyable();\n};\n\nstruct SourceLineInfo\n{\n\n SourceLineInfo() = delete;\n SourceLineInfo(char const *_file, std::size_t _line) noexcept : file(_file), line(_line) {}\n\n SourceLineInfo(SourceLineInfo const &other) = default;\n SourceLineInfo &operator=(SourceLineInfo const &) = default;\n SourceLineInfo(SourceLineInfo &&) noexcept = default;\n SourceLineInfo &operator=(SourceLineInfo &&) noexcept = default;\n\n bool empty() const noexcept { return file[0] == '\\0'; }\n bool operator==(SourceLineInfo const &other) const noexcept;\n bool operator<(SourceLineInfo const &other) const noexcept;\n\n char const *file;\n std::size_t line;\n};\n\nstd::ostream &operator<<(std::ostream &os, SourceLineInfo const &info);\n\n// Bring in operator<< from global namespace into Catch namespace\n// This is necessary because the overload of operator<< above makes\n// lookup stop at namespace Catch\nusing ::operator<<;\n\n// Use this in variadic streaming macros to allow\n// >> +StreamEndStop\n// as well as\n// >> stuff +StreamEndStop\nstruct StreamEndStop\n{\n std::string operator+() const;\n};\ntemplate T const &operator+(T const &value, StreamEndStop) { return value; }\n} // namespace Catch\n\n#define CATCH_INTERNAL_LINEINFO \\\n ::Catch::SourceLineInfo(__FILE__, static_cast(__LINE__))\n\n// end catch_common.h\nnamespace Catch\n{\n\nstruct RegistrarForTagAliases\n{\n RegistrarForTagAliases(char const *alias, char const *tag, SourceLineInfo const &lineInfo);\n};\n\n} // end namespace Catch\n\n#define CATCH_REGISTER_TAG_ALIAS(alias, spec) \\\n CATCH_INTERNAL_START_WARNINGS_SUPPRESSION \\\n CATCH_INTERNAL_SUPPRESS_GLOBALS_WARNINGS \\\n namespace \\\n { \\\n Catch::RegistrarForTagAliases \\\n INTERNAL_CATCH_UNIQUE_NAME(AutoRegisterTagAlias)(alias, spec, CATCH_INTERNAL_LINEINFO); \\\n } \\\n CATCH_INTERNAL_STOP_WARNINGS_SUPPRESSION\n\n// end catch_tag_alias_autoregistrar.h\n// start catch_test_registry.h\n\n// start catch_interfaces_testcase.h\n\n#include \n\nnamespace Catch\n{\n\nclass TestSpec;\n\nstruct ITestInvoker\n{\n virtual void invoke() const = 0;\n virtual ~ITestInvoker();\n};\n\nclass TestCase;\nstruct IConfig;\n\nstruct ITestCaseRegistry\n{\n virtual ~ITestCaseRegistry();\n virtual std::vector const &getAllTests() const = 0;\n virtual std::vector const &getAllTestsSorted(IConfig const &config) const = 0;\n};\n\nbool isThrowSafe(TestCase const &testCase, IConfig const &config);\nbool matchTest(TestCase const &testCase, TestSpec const &testSpec, IConfig const &config);\nstd::vector filterTests(std::vector const &testCases, TestSpec const &testSpec,\n IConfig const &config);\nstd::vector const &getAllTestCasesSorted(IConfig const &config);\n\n} // namespace Catch\n\n// end catch_interfaces_testcase.h\n// start catch_stringref.h\n\n#include \n#include \n#include \n#include \n\nnamespace Catch\n{\n\n/// A non-owning string class (similar to the forthcoming std::string_view)\n/// Note that, because a StringRef may be a substring of another string,\n/// it may not be null terminated.\nclass StringRef\n{\n public:\n using size_type = std::size_t;\n using const_iterator = const char *;\n\n private:\n static constexpr char const *const s_empty = \"\";\n\n char const *m_start = s_empty;\n size_type m_size = 0;\n\n public: // construction\n constexpr StringRef() noexcept = default;\n\n StringRef(char const *rawChars) noexcept;\n\n constexpr StringRef(char const *rawChars, size_type size) noexcept\n : m_start(rawChars), m_size(size)\n {\n }\n\n StringRef(std::string const &stdString) noexcept\n : m_start(stdString.c_str()), m_size(stdString.size())\n {\n }\n\n explicit operator std::string() const { return std::string(m_start, m_size); }\n\n public: // operators\n auto operator==(StringRef const &other) const noexcept -> bool;\n auto operator!=(StringRef const &other) const noexcept -> bool { return !(*this == other); }\n\n auto operator[](size_type index) const noexcept -> char\n {\n assert(index < m_size);\n return m_start[index];\n }\n\n public: // named queries\n constexpr auto empty() const noexcept -> bool { return m_size == 0; }\n constexpr auto size() const noexcept -> size_type { return m_size; }\n\n // Returns the current start pointer. If the StringRef is not\n // null-terminated, throws std::domain_exception\n auto c_str() const -> char const *;\n\n public: // substrings and searches\n // Returns a substring of [start, start + length).\n // If start + length > size(), then the substring is [start, size()).\n // If start > size(), then the substring is empty.\n auto substr(size_type start, size_type length) const noexcept -> StringRef;\n\n // Returns the current start pointer. May not be null-terminated.\n auto data() const noexcept -> char const *;\n\n constexpr auto isNullTerminated() const noexcept -> bool { return m_start[m_size] == '\\0'; }\n\n public: // iterators\n constexpr const_iterator begin() const { return m_start; }\n constexpr const_iterator end() const { return m_start + m_size; }\n};\n\nauto operator+=(std::string &lhs, StringRef const &sr) -> std::string &;\nauto operator<<(std::ostream &os, StringRef const &sr) -> std::ostream &;\n\nconstexpr auto operator\"\" _sr(char const *rawChars, std::size_t size) noexcept -> StringRef\n{\n return StringRef(rawChars, size);\n}\n} // namespace Catch\n\nconstexpr auto operator\"\" _catch_sr(char const *rawChars, std::size_t size) noexcept\n -> Catch::StringRef\n{\n return Catch::StringRef(rawChars, size);\n}\n\n// end catch_stringref.h\n// start catch_preprocessor.hpp\n\n#define CATCH_RECURSION_LEVEL0(...) __VA_ARGS__\n#define CATCH_RECURSION_LEVEL1(...) \\\n CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(CATCH_RECURSION_LEVEL0(__VA_ARGS__)))\n#define CATCH_RECURSION_LEVEL2(...) \\\n CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(CATCH_RECURSION_LEVEL1(__VA_ARGS__)))\n#define CATCH_RECURSION_LEVEL3(...) \\\n CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(CATCH_RECURSION_LEVEL2(__VA_ARGS__)))\n#define CATCH_RECURSION_LEVEL4(...) \\\n CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(CATCH_RECURSION_LEVEL3(__VA_ARGS__)))\n#define CATCH_RECURSION_LEVEL5(...) \\\n CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(CATCH_RECURSION_LEVEL4(__VA_ARGS__)))\n\n#ifdef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR\n#define INTERNAL_CATCH_EXPAND_VARGS(...) __VA_ARGS__\n// MSVC needs more evaluations\n#define CATCH_RECURSION_LEVEL6(...) \\\n CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(CATCH_RECURSION_LEVEL5(__VA_ARGS__)))\n#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL6(CATCH_RECURSION_LEVEL6(__VA_ARGS__))\n#else\n#define CATCH_RECURSE(...) CATCH_RECURSION_LEVEL5(__VA_ARGS__)\n#endif\n\n#define CATCH_REC_END(...)\n#define CATCH_REC_OUT\n\n#define CATCH_EMPTY()\n#define CATCH_DEFER(id) id CATCH_EMPTY()\n\n#define CATCH_REC_GET_END2() 0, CATCH_REC_END\n#define CATCH_REC_GET_END1(...) CATCH_REC_GET_END2\n#define CATCH_REC_GET_END(...) CATCH_REC_GET_END1\n#define CATCH_REC_NEXT0(test, next, ...) next CATCH_REC_OUT\n#define CATCH_REC_NEXT1(test, next) CATCH_DEFER(CATCH_REC_NEXT0)(test, next, 0)\n#define CATCH_REC_NEXT(test, next) CATCH_REC_NEXT1(CATCH_REC_GET_END test, next)\n\n#define CATCH_REC_LIST0(f, x, peek, ...) \\\n , f(x) CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST1))(f, peek, __VA_ARGS__)\n#define CATCH_REC_LIST1(f, x, peek, ...) \\\n , f(x) CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST0))(f, peek, __VA_ARGS__)\n#define CATCH_REC_LIST2(f, x, peek, ...) \\\n f(x) CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST1))(f, peek, __VA_ARGS__)\n\n#define CATCH_REC_LIST0_UD(f, userdata, x, peek, ...) \\\n , f(userdata, x) \\\n CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD))(f, userdata, peek, __VA_ARGS__)\n#define CATCH_REC_LIST1_UD(f, userdata, x, peek, ...) \\\n , f(userdata, x) \\\n CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST0_UD))(f, userdata, peek, __VA_ARGS__)\n#define CATCH_REC_LIST2_UD(f, userdata, x, peek, ...) \\\n f(userdata, x) \\\n CATCH_DEFER(CATCH_REC_NEXT(peek, CATCH_REC_LIST1_UD))(f, userdata, peek, __VA_ARGS__)\n\n// Applies the function macro `f` to each of the remaining parameters, inserts commas between the\n// results, and passes userdata as the first parameter to each invocation, e.g. CATCH_REC_LIST_UD(f,\n// x, a, b, c) evaluates to f(x, a), f(x, b), f(x, c)\n#define CATCH_REC_LIST_UD(f, userdata, ...) \\\n CATCH_RECURSE(CATCH_REC_LIST2_UD(f, userdata, __VA_ARGS__, ()()(), ()()(), ()()(), 0))\n\n#define CATCH_REC_LIST(f, ...) \\\n CATCH_RECURSE(CATCH_REC_LIST2(f, __VA_ARGS__, ()()(), ()()(), ()()(), 0))\n\n#define INTERNAL_CATCH_EXPAND1(param) INTERNAL_CATCH_EXPAND2(param)\n#define INTERNAL_CATCH_EXPAND2(...) INTERNAL_CATCH_NO##__VA_ARGS__\n#define INTERNAL_CATCH_DEF(...) INTERNAL_CATCH_DEF __VA_ARGS__\n#define INTERNAL_CATCH_NOINTERNAL_CATCH_DEF\n#define INTERNAL_CATCH_STRINGIZE(...) INTERNAL_CATCH_STRINGIZE2(__VA_ARGS__)\n#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR\n#define INTERNAL_CATCH_STRINGIZE2(...) #__VA_ARGS__\n#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) \\\n INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param))\n#else\n// MSVC is adding extra space and needs another indirection to expand\n// INTERNAL_CATCH_NOINTERNAL_CATCH_DEF\n#define INTERNAL_CATCH_STRINGIZE2(...) INTERNAL_CATCH_STRINGIZE3(__VA_ARGS__)\n#define INTERNAL_CATCH_STRINGIZE3(...) #__VA_ARGS__\n#define INTERNAL_CATCH_STRINGIZE_WITHOUT_PARENS(param) \\\n (INTERNAL_CATCH_STRINGIZE(INTERNAL_CATCH_REMOVE_PARENS(param)) + 1)\n#endif\n\n#define INTERNAL_CATCH_MAKE_NAMESPACE2(...) ns_##__VA_ARGS__\n#define INTERNAL_CATCH_MAKE_NAMESPACE(name) INTERNAL_CATCH_MAKE_NAMESPACE2(name)\n\n#define INTERNAL_CATCH_REMOVE_PARENS(...) INTERNAL_CATCH_EXPAND1(INTERNAL_CATCH_DEF __VA_ARGS__)\n\n#ifndef CATCH_CONFIG_TRADITIONAL_MSVC_PREPROCESSOR\n#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) \\\n decltype(get_wrapper())\n#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) \\\n INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__))\n#else\n#define INTERNAL_CATCH_MAKE_TYPE_LIST2(...) \\\n INTERNAL_CATCH_EXPAND_VARGS( \\\n decltype(get_wrapper()))\n#define INTERNAL_CATCH_MAKE_TYPE_LIST(...) \\\n INTERNAL_CATCH_EXPAND_VARGS( \\\n INTERNAL_CATCH_MAKE_TYPE_LIST2(INTERNAL_CATCH_REMOVE_PARENS(__VA_ARGS__)))\n#endif\n\n#define INTERNAL_CATCH_MAKE_TYPE_LISTS_FROM_TYPES(...) \\\n CATCH_REC_LIST(INTERNAL_CATCH_MAKE_TYPE_LIST, __VA_ARGS__)\n\n#define INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_0) INTERNAL_CATCH_REMOVE_PARENS(_0)\n#define INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_0, _1) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_1_ARG(_1)\n#define INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_0, _1, _2) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_2_ARG(_1, _2)\n#define INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_0, _1, _2, _3) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_3_ARG(_1, _2, _3)\n#define INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_0, _1, _2, _3, _4) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_4_ARG(_1, _2, _3, _4)\n#define INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_0, _1, _2, _3, _4, _5) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_5_ARG(_1, _2, _3, _4, _5)\n#define INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_0, _1, _2, _3, _4, _5, _6) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_6_ARG(_1, _2, _3, _4, _5, _6)\n#define INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_0, _1, _2, _3, _4, _5, _6, _7) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), INTERNAL_CATCH_REMOVE_PARENS_7_ARG(_1, _2, _3, _4, _5, _6, _7)\n#define INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), \\\n INTERNAL_CATCH_REMOVE_PARENS_8_ARG(_1, _2, _3, _4, _5, _6, _7, _8)\n#define INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), \\\n INTERNAL_CATCH_REMOVE_PARENS_9_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9)\n#define INTERNAL_CATCH_REMOVE_PARENS_11_ARG(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10) \\\n INTERNAL_CATCH_REMOVE_PARENS(_0), \\\n INTERNAL_CATCH_REMOVE_PARENS_10_ARG(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10)\n\n#define INTERNAL_CATCH_VA_NARGS_IMPL(_0, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, N, ...) N\n\n#define INTERNAL_CATCH_TYPE_GEN \\\n template struct TypeList \\\n { \\\n }; \\\n template constexpr auto get_wrapper() noexcept->TypeList \\\n { \\\n return {}; \\\n } \\\n template