Skip to content

fix: browser microphone connection to Csound with user warnings #428

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Nandos0804 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

fix: browser microphone connection to Csound with user warnings #428

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
211 changes: 206 additions & 5 deletions src/components/csound/actions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,157 @@ import { append, isEmpty, difference } from "ramda";

export let csoundInstance: CsoundObj;

// State management for Web Audio microphone nodes
let microphoneStream: MediaStream | undefined;
let microphoneSourceNode: MediaStreamAudioSourceNode | undefined;
let microphoneProcessingNodes: AudioNode[] = [];
let microphoneConnectInFlight: Promise<void> | undefined;

const cleanupMicrophoneBridge = (): void => {
microphoneProcessingNodes.forEach((node) => {
try {
node.disconnect();
} catch {}
});
microphoneProcessingNodes = [];

if (microphoneSourceNode) {
try {
microphoneSourceNode.disconnect();
} catch {}
microphoneSourceNode = undefined;
}

if (microphoneStream) {
microphoneStream.getTracks().forEach((track) => track.stop());
microphoneStream = undefined;
}
};

const waitForCsoundInputNode = async (
csound: CsoundObj,
retries: number = 10,
delay: number = 100
): Promise<AudioNode> => {
for (let i = 0; i < retries; i++) {
const node = await csound.getNode();
if (node instanceof AudioNode && node.numberOfInputs > 0) {
return node;
}
await new Promise((r) => setTimeout(r, delay));
}
throw new Error("Csound AudioNode timed out or has no input ports.");
};

const connectMicrophoneToCsoundNode = async (
csound: CsoundObj,
requestedInputChannels: number
): Promise<void> => {
const audioContext = await csound.getAudioContext();
if (!audioContext) throw new Error("No AudioContext found.");
if (!(audioContext instanceof AudioContext)) {
throw new Error(
"Microphone bridge requires a realtime AudioContext, not OfflineAudioContext."
);
}

if (audioContext.state === "suspended") {
await audioContext.resume();
}

const csoundNode = await waitForCsoundInputNode(csound);

// Tear down any previous bridge before acquiring the new stream
cleanupMicrophoneBridge();

const stream = await navigator.mediaDevices.getUserMedia({
audio: {
deviceId: "default",
echoCancellation: false,
noiseSuppression: false,
autoGainControl: false,
sampleRate: audioContext.sampleRate
}
});

microphoneStream = stream;
const sourceNode = audioContext.createMediaStreamSource(stream);
microphoneSourceNode = sourceNode;
const sourceChannels = sourceNode.channelCount;

if (requestedInputChannels <= 1) {
sourceNode.connect(csoundNode, 0, 0);
} else {
const merger = audioContext.createChannelMerger(requestedInputChannels);
const splitter = audioContext.createChannelSplitter(sourceChannels);
sourceNode.connect(splitter);

const channelsToRoute = Math.min(
requestedInputChannels,
sourceChannels
);
for (let i = 0; i < channelsToRoute; i++) {
splitter.connect(merger, i, i);
}

merger.connect(csoundNode, 0, 0);
microphoneProcessingNodes.push(splitter, merger);
}
};

const ensureMicrophoneConnected = async (
csound: CsoundObj,
channels: number
): Promise<void> => {
if (microphoneConnectInFlight) return microphoneConnectInFlight;
microphoneConnectInFlight = connectMicrophoneToCsoundNode(csound, channels);
try {
await microphoneConnectInFlight;
} finally {
microphoneConnectInFlight = undefined;
}
};

const installDeterministicMicrophoneBridge = (
csound: CsoundObj,
channels: number,
useWorker: boolean
): void => {
if (useWorker) return;
csound.enableAudioInput = async () => {
await ensureMicrophoneConnected(csound, channels);
};
};

const hasAdcInputFlagInCsOptions = (csd: string = ""): boolean => {
const match = csd.match(/<CsOptions>[\s\S]*?<\/CsOptions>/i);
if (!match) {
return false;
}
const options = match[0].replace(/;.*$/gm, "");
return (
/(^|\s)-i\s*(?:"adc"|'adc'|adc)(?=\s|$)/i.test(options) ||
/(^|\s)--input\s*(?:=\s*)?(?:"adc"|'adc'|adc)(?=\s|$)/i.test(options)
);
};
Comment on lines +146 to +156
Copy link
Copy Markdown
Member

@hlolli hlolli Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll try to help here, we can probably get this more reliably. There's a chance that the regex doesn't find the option in some cases, or some cases where the option isn't set in the file. For example project settings should be able to configure flags. Other parts look fine, I'll review better this weekend.

Copy link
Copy Markdown
Contributor Author

@Nandos0804 Nandos0804 Mar 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok thank you. It would be nice also to double check if orc + sco project without explicit csd option can now use input


const stripAdcInputFlagFromCsOptions = (csd: string = ""): string => {
if (!csd) {
return csd;
}

return csd.replace(/<CsOptions>[\s\S]*?<\/CsOptions>/i, (block) => {
return block
.replace(/(^|\s)-i\s*(?:"adc"|'adc'|adc)(?=\s|$)/gi, "$1")
.replace(
/(^|\s)--input\s*(?:=\s*)?(?:"adc"|'adc'|adc)(?=\s|$)/gi,
"$1"
)
.replace(/[ \t]+\n/g, "\n")
.replace(/[ \t]{2,}/g, " ");
});
};

const parseOutputNameFromCsOptions = (
csdContents: string | undefined
): string | undefined => {
Expand Down Expand Up @@ -71,6 +222,7 @@ export const setCsoundPlayState = (

export const setCsound = (csound: CsoundObj): void => {
csound.on("realtimePerformanceEnded", async () => {
cleanupMicrophoneBridge();
try {
await csound.cleanup();
} catch {}
Expand Down Expand Up @@ -141,8 +293,32 @@ export const playCsdFromFs = ({
csdPath: string;
}) => {
return async (dispatch: AppThunkDispatch, setConsole: any) => {
cleanupMicrophoneBridge();
const useWorker = localStorage.getItem("sab") === "true";

const state = store.getState();
const project = state.ProjectsReducer.projects?.[projectUid];
const targetDoc = Object.values(project?.documents || {}).find(
(doc) => doc.filename === csdPath
);
const csdContent = targetDoc?.currentValue || "";
const shouldMapAdcToBrowserInput =
!useWorker && hasAdcInputFlagInCsOptions(csdContent);
const csdToCompile = shouldMapAdcToBrowserInput
? stripAdcInputFlagFromCsOptions(csdContent)
: csdContent;

if (shouldMapAdcToBrowserInput) {
dispatch(
openSnackbar(
"Input note: -iadc mapped to browser microphone input.",
SnackbarType.Info
)
);
}

const csoundObj = await Csound({
useWorker: localStorage.getItem("sab") === "true"
useWorker
});

if (!csoundObj) {
Expand All @@ -151,6 +327,7 @@ export const playCsdFromFs = ({
csoundInstance = csoundObj;

setCsound(csoundInstance);
installDeterministicMicrophoneBridge(csoundObj, 1, useWorker);
await syncFs(csoundObj, projectUid, store.getState());

if (csoundObj && setConsole) {
Expand All @@ -170,13 +347,14 @@ export const playCsdFromFs = ({
const outputFromCsOptions = parseOutputNameFromCsOptions(
targetDoc?.currentValue
);

if (!outputFromCsOptions) {
await csoundObj.setOption("-odac");
} else {
await csoundObj.setOption(`-o${outputFromCsOptions}`);
}
const result = await compileCSD(csoundObj, csdPath);
const result = shouldMapAdcToBrowserInput
? await compileCSD(csoundObj, csdToCompile, true)
: await compileCSD(csoundObj, csdPath);

if (result === 0) {
const filesPre = await csoundObj.fs.readdir("/");
Expand Down Expand Up @@ -279,8 +457,30 @@ export const playCsdFromFs = ({
csoundObj.once("realtimePerformanceEnded", async () => {
await addOutputsToTree();
});
await csoundObj.start();
dispatch(setCsoundPlayState("playing"));
try {
await csoundObj.start();
if (!useWorker) {
await csoundObj.enableAudioInput();
}
dispatch(setCsoundPlayState("playing"));
} catch (error: unknown) {
cleanupMicrophoneBridge();
try {
await csoundObj.stop();
} catch {}
try {
await csoundObj.cleanup();
} catch {}

dispatch(setCsoundPlayState("error"));
dispatch(
openSnackbar(
"Audio input error: unable to start microphone input. Check permission settings and browser audio policy.",
SnackbarType.Error
)
);
console.error(error);
}
}
} else {
try {
Expand Down Expand Up @@ -349,6 +549,7 @@ export const playORCFromString = ({
};

export const stopCsound = () => {
cleanupMicrophoneBridge();
csoundInstance && csoundInstance.stop();
return setCsoundPlayState("stopped");
};
Expand Down
Loading