Open source Loom alternative. Beautiful, shareable screen recordings.
Rust appcapcossloommacnextjsnextjs15open-sourceossreactrecordrustscreen-capturescreen-recorderscreenshotsolidjstauritauri-apptypescriptvite
fix(sdk-recorder): bound audio startup and leave mixing headroom
Akshar Patelfa64a45f448c
diff --git a/packages/sdk-recorder/__tests__/audio-mixing.test.ts b/packages/sdk-recorder/__tests__/audio-mixing.test.tsindex cb582c48e..b9acd324b 100644--- a/packages/sdk-recorder/__tests__/audio-mixing.test.ts+++ b/packages/sdk-recorder/__tests__/audio-mixing.test.ts@@ -30,8 +30,13 @@ class Stream {class Mixer {static instances: Mixer[] = [];readonly inputs: Track[] = [];+ readonly connections: unknown[] = [];readonly output = new Track("audio");readonly destination = { stream: new Stream([this.output]) };+ readonly mix = {+ gain: { value: 1 },+ connect: mock(() => {}),+ };resume = mock(async () => {});close = mock(async () => {});@@ -43,16 +48,28 @@ class Mixer {return this.destination;}+ createGain() {+ return this.mix;+ }+createMediaStreamSource(stream: Stream) {return {- connect: () => {+ connect: (destination: unknown) => {this.inputs.push(...stream.getAudioTracks());+ this.connections.push(destination);},};}}-const globals = ["MediaStream", "AudioContext", "MediaRecorder", "navigator"];+const globals = [+ "MediaStream",+ "AudioContext",+ "MediaRecorder",+ "navigator",+ "setTimeout",+ "clearTimeout",+];const descriptors = globals.map((name) => [name, Object.getOwnPropertyDescriptor(globalThis, name)] as const,);@@ -129,6 +146,9 @@ test("records both audio sources through one track and releases the mixer", asynexpect(input?.getVideoTracks()).toEqual([video]);expect(input?.getAudioTracks()).toEqual([mixer?.output]);expect(mixer?.inputs).toEqual([system, mic]);+ expect(mixer?.connections).toEqual([mixer?.mix, mixer?.mix]);+ expect(mixer?.mix.gain.value).toBe(0.5);+ expect(mixer?.mix.connect).toHaveBeenCalledWith(mixer?.destination);} finally {recorder.destroy();}@@ -157,6 +177,48 @@ test.each([},);+test("times out pending audio startup and releases captured tracks", async () => {+ const { video, system, mic } = capture(true, true);+ setGlobal(+ "AudioContext",+ class extends Mixer {+ resume = mock(() => new Promise<void>(() => {}));+ },+ );+ let deadline: (() => void) | undefined;+ const timeout = mock((callback: () => void, delay: number) => {+ expect(delay).toBe(10_000);+ deadline = callback;+ return 7;+ });+ const clear = mock(() => {});+ setGlobal("setTimeout", timeout);+ setGlobal("clearTimeout", clear);+ const recorder = new CapRecorder({+ publicKey: "test-public-key",+ mode: "tab",+ camera: { enabled: false },+ systemAudio: true,+ });+ try {+ const starting = recorder.start();+ await new Promise<void>((resolve) => setImmediate(resolve));+ expect(deadline).toBeDefined();+ deadline?.();+ await expect(starting).rejects.toThrow("Recording audio startup timed out");+ expect(recorder.phase).toBe("error");+ expect(clear).toHaveBeenCalledWith(7);+ expect(video.stop).toHaveBeenCalled();+ expect(system.stop).toHaveBeenCalled();+ expect(mic.stop).toHaveBeenCalled();+ const mixer = Mixer.instances[0];+ expect(mixer?.output.stop).toHaveBeenCalled();+ expect(mixer?.close).toHaveBeenCalledTimes(1);+ } finally {+ recorder.destroy();+ }+});+test.each(["encoder", "audio"] as const)("cleans up both audio sources when %s initialization fails",async (failure) => {diff --git a/packages/sdk-recorder/src/core/stream-manager.ts b/packages/sdk-recorder/src/core/stream-manager.tsindex f6a0d1690..f93156d09 100644--- a/packages/sdk-recorder/src/core/stream-manager.ts+++ b/packages/sdk-recorder/src/core/stream-manager.ts@@ -123,12 +123,29 @@ export async function buildCompositeStream(const context = new AudioContext();const destination = context.createMediaStreamDestination();streams.audioMix = { context, stream: destination.stream };+ const mix = context.createGain();+ mix.gain.value = 1 / audioTracks.length;+ mix.connect(destination);for (const track of audioTracks) {- context- .createMediaStreamSource(new MediaStream([track]))- .connect(destination);+ context.createMediaStreamSource(new MediaStream([track])).connect(mix);+ }+ let startupTimeout: ReturnType<typeof setTimeout> | undefined;+ try {+ await Promise.race([+ context.resume(),+ new Promise<never>((_, reject) => {+ startupTimeout = setTimeout(() => {+ reject(+ new Error(+ "Recording audio startup timed out. Check your audio device and try again.",+ ),+ );+ }, 10_000);+ }),+ ]);+ } finally {+ clearTimeout(startupTimeout);}- await context.resume();return new MediaStream([...tracks.filter((track) => track.kind !== "audio"),