Repository navigation
clap-wrapper 0.18.0
AUv2
- ARA 2 support through the ARA Audio Unit properties:
kAudioUnitProperty_ARAFactoryreturns the CLAP's ARA factory,kAudioUnitProperty_ARAPlugInExtensionBindingWithRolesbinds to the host's document controller, and the deprecated ARA 1 binding binds with the playback renderer, edit renderer and editor view roles. The properties are only advertised when the CLAP has the ARA extension, and the build helper adds theARAtag to the AudioComponents entry (#617). kAudioUnitProperty_OfflineRenderreaches the plugin throughclap.render, so a CLAP learns it is bouncing faster than real time. A plugin with a hard realtime requirement stays in realtime (#640).Resetis forwarded: the process and flush adapters drop their pending non-parameter events and active notes, and the plugin is reset. Gesture boundaries are kept so a reset cannot leave a gesture open, and leaving bypass resets the processor's audio history (#614).- The saved state names the present preset, and a restored state becomes the present preset, so the host no longer shows the factory preset chosen before the restore. Fixes a leak of the name string on every restore (#631).
- State can be saved and restored before
Initialize. Hosts that setkAudioUnitProperty_ClassInfobeforeAudioUnitInitialize(Logic Pro when reloading a project, JUCE-based hosts) had the state dropped and the plugin came up with its defaults. A restore now runs on the main thread, and a CLAP without a state extension falls back to the AU base implementation instead of dereferencing a null extension (#490, #642). - A values-only
param_rescansends a parameter value change per parameter instead of announcing a new parameter list, which cost Logic Pro seconds of UI lag when a plugin rescanned values per preset (#624). - An editor still open is destroyed on the main thread. A host disposing of an instance off the main thread made AppKit throw and ended the host process (#628).
mark_dirtyis held back while a parameter gesture is open, for at most five seconds, so Logic Pro records the gesture's changes in Latch and Write (#612).- The loop start is written to
loop_start_beatsrather than over the loop end, and both cycle points are converted toclap_beattime(#615). - Beat time 0 is a valid song position (#613).
- The ARA property handlers return
OSStatusinstead of mixing two anonymous enums, which broke the C++20 build under-Werror(#618).
AUv3
- Channel layouts: a bus wider than two channels now carries an
AVAudioChannelLayoutinstead of being dropped. Layouts come fromclap.surround/clap.ambisonic, otherwise they are guessed from the channel count as the VST3 wrapper does, with a newauv3_channellayout.{h,mm}translating CoreAudio layout tags and labels to and from CLAP channel maps and ambisonic configs.clap.configurable-audio-portsis probed at init as in the AUv2 wrapper, andallocateRenderResourceshands the host's bus formats to the plugin (#611, #620). renderingOfflineis forwarded toclap.render, respecting a hard realtime requirement, and re-applied before activation (#611).- A main-bus format change is refused when it would leave the unit on a channel pair
channelCapabilitiesdoes not report, which auval caught asInitialised Unit incorrectly set to InputChans:3 OutputChans:1(#620). - Port names the plugin changes in
apply_configurationare passed on to the busses (#620). - Build:
INFO_PLIST_ADDITIONSdeep-merges a plist into the generated appexInfo.plist(newcmake/merge_plist.cmake),CODE_SIGN_IDENTITY/DEVELOPMENT_TEAMlet Xcode team-sign the appex, andtarget_embed_auv3_appex()embeds the appex into an app of your own (#611).
VST3
- Raw MIDI output is translated:
CLAP_EVENT_MIDIbecomes note on/off andkLegacyMIDICCOutEventfor CC, program change, aftertouch, pitch bend and poly pressure, andCLAP_EVENT_MIDI_SYSEXbecomes aDataEventwithkMidiSysEx. A CLAP emitting raw MIDI sent nothing to the host before (#414, #630). IMidiMappingparameters, note expressions and the preset program list are set up for a CLAP without a params extension, which the SDK validator rejected withUnknown ParamID [0] returned for MIDI Mapping(#634).- A plugin with a hard realtime requirement answers
IPrefetchableSupportwithkIsNeverPrefetchable, so Cubase's ASIO-Guard no longer processes it ahead of playback (#627). - No crash when a host provides fewer audio busses than the plugin declared; the block falls back to the params-flush path (#621).
- No crash when a host passes a null
initializecontext, as the ARA SDK's TestHost does for renderer-only instances (#618). - ARA fixes:
queryInterfaceno longer dereferences the plugin beforeinitialize()or afterterminate(), the deprecatedbindToDocumentControllerforwards to the role-based binding so ARA 1 hosts can bind, and the factory logging reports the real factory count and mismatched plugin ids (#616). - CMake:
target_add_vst3_wrapperreads its arguments under theirV3_names, soASSET_OUTPUT_DIRECTORYis honoured,BUNDLE_VERSIONdefaults to 1.0 again and the resource-directory warnings fire. On Windows a build withoutRESOURCE_DIRECTORYis now a single file, asCLAP_WRAPPER_WINDOWS_SINGLE_FILEdescribes (#633).
AAX
GetParameterNumberOfSteps()no longer reports 0, which the AAX SDK treats as an error, and defers to the base class for continuous parameters and for parameters the wrapper does not own. Stepped parameter values are rounded and clamped on both sides of the conversion, so a round trip settles instead of drifting, and a degenerate zero-width range no longer divides by zero (#641).
Standalone
- The window comes up at once, at the size the gui is going to ask for, in the gui's background colour and with a splash image (and optionally a few lines of text) in its middle; the gui's view then takes its place without the window moving or changing colour. The hints come from the build (
STANDALONE_WINDOW_SIZE,_BACKGROUND_COLOR,_SPLASH_IMAGE,_SPLASH_IMAGE_SCALE) and from the plugin's entry through the newclap_wrapper_plugin_factory_standalone_windowfactory (draft/1), which can also set the appearance the window is drawn in (#638). - Opening the standalone from a link:
URL_SCHEMES(STANDALONE_URL_SCHEMESinmake_clapfirst_plugins) registers the schemes, and standalone features draft/6 addsopen_urlon the plugin side, called once the plugin exists and its gui is shown. draft/5 is no longer answered. A launch with urls hands them to a running instance on Windows; macOS holds a launch url until the plugin is there (#623). - Windows: the window keeps to the gui's size when an edge is dragged, snapping to half or a quarter of the screen respects the gui's minimum, a window resized by the gui is moved as little as it takes to stay on its monitor's work area, and the splash is repainted when the window changes size (#639).
- macOS: the standalone and the AUv3 host app are filed under
public.app-category.music, settable withMACOS_APP_CATEGORY; the AUv3 host app'sInfo.plistis generated per target (#639). - Linux: the window resizes with a plugin that can, and tells the plugin its size. The window's minimum width is the strip's own, so a narrower plugin is no longer stretched, and the window size is only recorded when the window manager confirms it (#609).
- Windows, WASAPI: shared mode has less latency. The output is filled to one engine period plus one block instead of to the brim, which cuts what waits ahead of a block from 12-15 ms to 5.3 ms. The input cushion is trimmed back to 64 frames when it goes unused, which saves 2-4 ms at 128 and 256 frames (#647).
- Windows: "WASAPI (Exclusive)" (
wasapi-exclusive) is a new api in the Audio API menu. It uses the device's own format at the stream's rate, a period of the device's minimum or one block (whichever is longer), and gives a 3 ms period each way on a typical USB interface. Its audio thread runs at high MMCSS priority within the "Pro Audio" task. A device in use by another application, or one that does not allow exclusive use, gets a message of its own (#647, #648). - MIDI ports plugged in after launch are opened: every input when the settings bind all, and the chosen inputs and outputs once they are present. CoreMIDI keeps a source that is still wanted connected while other ports come and go. WinMM is polled once a second, since it does not report device changes.
request_midi_bindings(draft) changes meaning to match:bind_allalso takes inputs plugged in later, and an id that is missing is opened once it is plugged in (#646). - The latency readout in the Audio/MIDI settings is the whole latency, input device plus two blocks plus output device ("Latency: 27.4 ms round trip", or "… output" without an input). A device that does not report its latency shows a lower bound instead of hiding the readout. The rate menu follows the rate the device actually opened at. On macOS the readout has a row of its own. The
audio-midi-configurationlatencies are unchanged (#644). - The buffer size menu shows samples only ("256" instead of "256 (5.8 ms)") (#645).
- Build fixes: the PipeWire backend builds against pre-1.0 headers (Debian bookworm, Ubuntu 22.04), the standalone library builds outside unity builds, and the Linux backends build with GCC 12 in release (#606).
Across formats
- Wrapping fails when CLAP plugin initialization fails: the result is propagated through both instance factories, AudioComponent open fails before the SDK queries an unavailable instance, and VST3 reports its normal initialization error (#625).
- SysEx pool slots reserve their payload storage up front (256 bytes by default), so the first
acquire()on the audio thread does not allocate. Used by the AUv2, AUv3 and VST3 wrappers (#637). - macOS: an empty
CMAKE_OSX_DEPLOYMENT_TARGETselectsstd::filesysteminstead of downloading gulrak/filesystem at configure time, which broke offline and vendored builds (#632). - CI: the jobs that pin gcc 12 or 13 run on ubuntu-24.04, since ubuntu-latest has moved to 26.04 and has no gcc-12 (#636).
New Contributors
- @dingari made their first contribution in #627
- @shakfu made their first contribution in #630
- @Verdiger made their first contribution in #642
Full Changelog: v0.17.0...v0.18.0