fix(audio): never feed chain processors blocks larger than prepared size (#85)
Addon CI / addon (arm64, macos-14, mac) (push) Waiting to run
Addon CI / addon (x64, ubuntu-22.04, linux) (push) Waiting to run
Addon CI / addon (x64, windows-latest, win) (push) Waiting to run
Ship CI / CI (push) Waiting to run

* fix(audio): never feed chain processors blocks larger than prepared size

WASAPI shared mode can deliver oversized blocks right after a device
start. The NAM core pre-allocates its conv ring/output buffers to the
Reset() maxBufferSize and only asserts (release no-op) on larger blocks;
one oversized block corrupts the conv ring state and garbles all
subsequent audio until the next Reset() — the 'first start heavily
distorted until tone reset / engine restart' bug.

- NAMProcessor::processBlock: process in slices of at most the prepared
  block size.
- SignalChain::process: slice oversized device blocks into prepared-size
  chunks before any slot (VST/NAM/IR) sees them.

See docs/audio-distortion-first-start-investigation.md.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

* fix(audio): prefer same-backend duplex routing

* fix(audio): centre mono input; limit duplex to same-endpoint devices

Two issues found while testing the USB-guitar-cable path on Windows:

1. Centre a mono input. SourceChain::processBlock fell into the
   pass-through branch for a 1-channel input, filling only
   min(inputChannels, outputChannels) = 1 output channel and zeroing the
   rest, so a mono USB guitar cable played out of the left speaker only.
   A single-channel input is now broadcast across every output channel.

2. Only attempt the combined (duplex) device when input and output are
   the SAME physical endpoint. Two different endpoints of the same
   backend (USB cable in + separate speakers out) are independent
   hardware clocks; routing them through one duplex device was unstable
   across the app lifecycle (no audio until an explicit Apply, then
   distortion / dropouts / silent-in-song on navigation). Different
   endpoints now use the split path, whose ring bridges the two clocks.
   Same-endpoint duplex (one interface for in and out) keeps the
   low-latency win. Low latency for the two-device case is a follow-up
   that needs the device-lifecycle work (startup restore + reconfigure
   on navigation).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JEoFeTPSnz4NpwwCG52hnu

* fix(audio): probe same-endpoint duplex the same way apply routes it

Startup auto-apply (renderer init) fail-closes on probeDeviceOptionsDual's
`compatible` verdict, but the probe still measured a COMBINED duplex device
for any same-backend pair while setAudioDevices now opens split for
different endpoints. That mismatch made the startup probe describe a config
that isn't the one applied — surfacing as "no audio until I press Apply" for
a USB cable + separate speakers. Gate the probe's duplex path on the same
sameEndpointIntent (same type AND same device) the apply path uses, so a
two-device pair is probed via the split path it will actually run on.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01JEoFeTPSnz4NpwwCG52hnu

* fix(audio): close stale-format race when processors are added mid-reconfigure

addProcessor/replaceProcessor prepare the incoming processor off the
audio lock on N-API worker threads. A concurrent device reconfigure's
SignalChain::prepare() can't see that processor (not slotted yet), so a
slot could go live prepared at a stale sample rate / block size and stay
wrong until the next device restart — heard as pitch-shifted/garbled
monitoring when a chain loads while the device is being (re)opened
(widest window: WASAPI exclusive mode's slower open).

Re-check the chain's current format under the lock at insert/swap time
and re-prepare if it moved; log the transition to stderr so tester logs
show when the race fired. prepare() now publishes the format under the
lock so the check can't tear.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: ChrisBeWithYou <chris@rifflarr.local>
This commit is contained in:
OmikronApex
2026-07-08 22:44:26 +02:00
committed by GitHub
co-authored by Claude Fable 5 ChrisBeWithYou
parent 56e929da4e
commit 3e3f1f868c
6 changed files with 279 additions and 66 deletions
+89 -6
View File
@@ -216,9 +216,6 @@ SignalChain::~SignalChain()
void SignalChain::prepare(double sampleRate, int blockSize)
{
currentSampleRate = sampleRate;
currentBlockSize = blockSize;
// Size the parallel-branch scratch once, off the audio thread. Stereo, the
// chain's fixed channel layout. avoidReallocating=true keeps the storage
// stable so the RT path never allocates.
@@ -227,6 +224,10 @@ void SignalChain::prepare(double sampleRate, int blockSize)
accumScratch.setSize(2, blockSize, false, false, true);
const juce::ScopedLock sl(lock);
// Published under the lock so addProcessor/replaceProcessor's under-lock
// stale-format check can't tear against a concurrent prepare.
currentSampleRate = sampleRate;
currentBlockSize = blockSize;
for (auto* slot : slots)
{
invokePlugin(*slot, [&](juce::AudioProcessor& p)
@@ -259,6 +260,46 @@ void SignalChain::process(juce::AudioBuffer<float>& buffer, juce::MidiBuffer& mi
const juce::ScopedTryLock sl(lock);
if (!sl.isLocked()) return;
// Never hand a slot a block larger than the one it was prepared for.
// prepareToPlay's samplesPerBlock is a hard contract for VST3s, and the NAM
// core sizes its conv ring/output buffers to it with only a release-no-op
// assert guarding overruns — one oversized block (WASAPI shared mode
// delivers them right after a device start) permanently garbles its state.
// Slice the block into prepared-size chunks instead; each slot processes
// each chunk in sequence, preserving slot ordering per sample.
const int totalSamples = buffer.getNumSamples();
const int maxChunk = currentBlockSize > 0 ? currentBlockSize : totalSamples;
if (totalSamples <= maxChunk)
{
processLocked(buffer, midi);
return;
}
constexpr int kMaxSliceChannels = 8;
const int numChannels = buffer.getNumChannels();
if (numChannels > kMaxSliceChannels)
{
// Shouldn't happen (the chain runs stereo) — keep the legacy whole-block
// behaviour rather than dropping channels.
processLocked(buffer, midi);
return;
}
juce::MidiBuffer emptyMidi;
float* slicePtrs[kMaxSliceChannels];
for (int offset = 0; offset < totalSamples; offset += maxChunk)
{
const int chunk = juce::jmin(maxChunk, totalSamples - offset);
for (int ch = 0; ch < numChannels; ++ch)
slicePtrs[ch] = buffer.getWritePointer(ch) + offset;
juce::AudioBuffer<float> slice(slicePtrs, numChannels, chunk);
// MIDI (all stamped at sample 0) goes to the first slice only.
processLocked(slice, offset == 0 ? midi : emptyMidi);
}
}
void SignalChain::processLocked(juce::AudioBuffer<float>& buffer, juce::MidiBuffer& midi)
{
// Drain pending MIDI messages from the lock-free queue
struct DrainedMsg { int slotId; juce::MidiMessage msg; };
DrainedMsg drained[kMidiQueueSize];
@@ -412,15 +453,37 @@ int SignalChain::addProcessor(std::unique_ptr<juce::AudioProcessor> processor,
// Prepare under the SEH-catching helper so a plugin that faults during
// prepareToPlay is blocklisted (next load routes to the sandbox) and the
// slot is dropped, rather than taking the app down.
// slot is dropped, rather than taking the app down. Snapshot the playback
// format we prepare against: this runs OFF the audio lock on an N-API
// worker thread, and a device reconfigure can run prepare() concurrently —
// its slot loop won't see this slot (not added yet), so if the format
// moved we must re-prepare under the lock below or the slot stays at a
// stale sample rate / block size until the next device restart (heard as
// pitch-shifted/garbled monitoring after first-open races).
const double prepSr = currentSampleRate;
const int prepBs = currentBlockSize;
invokePlugin(*slot, [&](juce::AudioProcessor& p)
{
prepareForPlayback(p, currentSampleRate, currentBlockSize);
prepareForPlayback(p, prepSr, prepBs);
});
if (! slot->processor) return -1;
int id = slot->id;
const juce::ScopedLock sl(lock);
if (currentSampleRate != prepSr || currentBlockSize != prepBs)
{
fprintf(stderr,
"[SignalChain] addProcessor: device format changed during prepare "
"(%.0f/%d -> %.0f/%d) — re-preparing '%s'\n",
prepSr, prepBs, currentSampleRate, currentBlockSize,
slot->name.toRawUTF8());
invokePlugin(*slot, [&](juce::AudioProcessor& p)
{
p.releaseResources();
prepareForPlayback(p, currentSampleRate, currentBlockSize);
});
if (! slot->processor) return -1;
}
slots.add(slot.release());
return id;
}
@@ -456,9 +519,11 @@ bool SignalChain::replaceProcessor(int slotId, std::unique_ptr<juce::AudioProces
// does — under invokePlugin's SEH/signal guard so a fault in prepareToPlay is
// contained (the processor is dropped) rather than taking the app down.
staging.processor = std::move(processor);
const double prepSr = currentSampleRate;
const int prepBs = currentBlockSize;
invokePlugin(staging, [&](juce::AudioProcessor& p)
{
prepareForPlayback(p, currentSampleRate, currentBlockSize);
prepareForPlayback(p, prepSr, prepBs);
});
if (! staging.processor) return false; // faulted during prepare → leave the slot as-is
@@ -467,6 +532,24 @@ bool SignalChain::replaceProcessor(int slotId, std::unique_ptr<juce::AudioProces
const juce::ScopedLock sl(lock);
const int idx = findSlotIndex(slotId);
if (idx < 0) return false; // slot was removed underneath us
// Same off-lock prepare race as addProcessor: a concurrent device
// reconfigure's prepare() couldn't have re-prepared the staging
// processor (it isn't in a slot yet). Re-prepare at the current format
// before it goes live.
if (currentSampleRate != prepSr || currentBlockSize != prepBs)
{
fprintf(stderr,
"[SignalChain] replaceProcessor: device format changed during prepare "
"(%.0f/%d -> %.0f/%d) — re-preparing '%s'\n",
prepSr, prepBs, currentSampleRate, currentBlockSize,
staging.name.toRawUTF8());
invokePlugin(staging, [&](juce::AudioProcessor& p)
{
p.releaseResources();
prepareForPlayback(p, currentSampleRate, currentBlockSize);
});
if (! staging.processor) return false;
}
auto* slot = slots[idx];
old = std::move(slot->processor);
slot->processor = std::move(staging.processor);