Repository navigation
Add browser-side audio response timing diagnostics #728
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.
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
ChenYingHan1121
wants to merge
4
commits into
sysprog21:main
Choose a base branch
from
ChenYingHan1121:feat/browser-audio-timing-712
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,570
−11
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
daa74a5
Add browser audio response timing diagnostics
ChenYingHan1121 b93c715
Address audio response timing review feedback
ChenYingHan1121 3094341
Test audio timing error recovery
ChenYingHan1121 054cb1f
Test interviewer disconnect recovery
ChenYingHan1121 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
514 changes: 514 additions & 0 deletions
514
tests/browser/audio-response-timing-integration.test.js
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| import { startMediaMeter } from "./mic-meter.js"; | ||
| /// Browser-observed gap between Jim entering "speaking" and the first | ||
| /// detectable remote audio activity. This is not end-to-end latency. | ||
| export function createAudioResponseTiming({ | ||
| now = () => performance.now(), | ||
| report = () => {}, | ||
| diagnose = () => {}, | ||
| } = {}) { | ||
| let speaking = false; | ||
| let startedAt = null; | ||
| let active = false; | ||
| let armed = false; | ||
|
|
||
| function speakingChanged(nextSpeaking, unavailableReason = null) { | ||
| if (nextSpeaking === speaking) return; | ||
|
|
||
| speaking = nextSpeaking; | ||
|
|
||
| if (speaking) { | ||
| if (unavailableReason || active) { | ||
| diagnose(unavailableReason || "audio already active"); | ||
| } else { | ||
| startedAt = now(); | ||
| armed = false; | ||
| } | ||
| } else { | ||
| cancelPending("speaking stopped before audio"); | ||
| } | ||
| } | ||
|
|
||
| function audioActivity() { | ||
| active = true; | ||
| if (!speaking || startedAt === null) return; | ||
| if (!armed) { | ||
| cancelPending("audio already active before a quiet frame"); | ||
| return; | ||
| } | ||
|
|
||
| const elapsedMs = now() - startedAt; | ||
| startedAt = null; | ||
|
|
||
| report(elapsedMs); | ||
| } | ||
|
|
||
| function audioQuiet() { | ||
| active = false; | ||
| // A pre-transition quiet frame cannot rule out audio arriving first. | ||
| if (startedAt !== null) armed = true; | ||
| } | ||
|
|
||
| function cancelPending(reason = "measurement canceled") { | ||
| if (startedAt !== null) diagnose(reason); | ||
| startedAt = null; | ||
| armed = false; | ||
| } | ||
|
|
||
| function reset(reason = "timing reset") { | ||
| speaking = false; | ||
| active = false; | ||
| cancelPending(reason); | ||
| } | ||
|
|
||
| return { | ||
| speakingChanged, | ||
| audioActivity, | ||
| audioQuiet, | ||
| cancelPending, | ||
| reset, | ||
| }; | ||
| } | ||
| /// Observe remote audio activity without routing it to another output. | ||
| /// The returned function releases the analyser and its AudioContext. | ||
| export function startAudioActivityMonitor( | ||
| track, | ||
| onActivity, | ||
| { | ||
| threshold = 0.05, | ||
| onAvailable = () => {}, | ||
| onUnavailable = () => {}, | ||
| onQuiet = () => {}, | ||
| createContext = () => new AudioContext(), | ||
| createStream = (mediaTrack) => new MediaStream([mediaTrack]), | ||
| schedule = requestAnimationFrame, | ||
| cancel = cancelAnimationFrame, | ||
| gestureTarget = globalThis.document, | ||
| visibilityTarget = globalThis.document, | ||
| } = {}, | ||
| ) { | ||
| const stream = createStream(track); | ||
| const context = createContext(); | ||
| let stopped = false; | ||
| let unavailable; | ||
|
|
||
| function notifyAvailability(reason) { | ||
| if (unavailable === reason) return; | ||
| unavailable = reason; | ||
| if (reason === null) onAvailable(); | ||
| else onUnavailable(reason); | ||
| } | ||
|
|
||
| function visibilityChanged() { | ||
| if (stopped) return; | ||
|
|
||
| if (visibilityTarget?.hidden) { | ||
| notifyAvailability("page hidden"); | ||
| } | ||
| } | ||
|
|
||
| function resumeOnGesture() { | ||
| if (stopped || context.state !== "suspended") return; | ||
| void context.resume?.().catch(() => {}); | ||
| } | ||
|
|
||
| const stopMeter = startMediaMeter( | ||
| stream, | ||
| (peak) => { | ||
| if (peak > threshold) onActivity(); | ||
| else onQuiet(); | ||
| }, | ||
| (message) => { | ||
| throw new Error(message); | ||
| }, | ||
| () => stopped, | ||
| { | ||
| createContext: () => context, | ||
| schedule, | ||
| cancel, | ||
| sampleSize: 1024, | ||
| deferFirstFrame: true, | ||
| shouldSample: () => { | ||
| const reason = visibilityTarget?.hidden | ||
| ? "page hidden" | ||
| : context.state !== "running" | ||
| ? `audio context ${context.state}` | ||
| : track.readyState !== "live" | ||
| ? "track ended" | ||
| : track.muted | ||
| ? "track muted" | ||
| : track.enabled === false | ||
| ? "track disabled" | ||
| : null; | ||
|
|
||
| notifyAvailability(reason); | ||
| return reason === null; | ||
| }, | ||
| }, | ||
| ); | ||
| try { | ||
| resumeOnGesture(); | ||
| } catch (error) { | ||
| stopMeter(); | ||
| throw error; | ||
| } | ||
| visibilityTarget?.addEventListener("visibilitychange", visibilityChanged); | ||
| gestureTarget?.addEventListener("pointerdown", resumeOnGesture); | ||
| gestureTarget?.addEventListener("keydown", resumeOnGesture); | ||
|
|
||
| return () => { | ||
| if (stopped) return; | ||
|
|
||
| stopped = true; | ||
|
|
||
| gestureTarget?.removeEventListener("pointerdown", resumeOnGesture); | ||
| gestureTarget?.removeEventListener("keydown", resumeOnGesture); | ||
|
|
||
| visibilityTarget?.removeEventListener( | ||
| "visibilitychange", | ||
| visibilityChanged, | ||
| ); | ||
|
|
||
| stopMeter(); | ||
| }; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.