Skip to content

Add OCR completion sound #201

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

Merged
yvette-carlisle merged 1 commit into from
May 8, 2026
Merged

Add OCR completion sound #201

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
73 changes: 57 additions & 16 deletions native/macos-host/Sources/RsnapNativeHostKit/NativeHostApp.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,44 +84,80 @@ private struct LiveChromeRefreshTelemetryKey: Equatable {

@MainActor private let frozenEffectCIContext = CIContext(options: nil)

private enum CaptureSuccessSound {
private static let candidatePaths = [
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/system/Screen Capture.aif",
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/system/Shutter.aif",
]

static func load() -> NSSound? {
private struct NativeHostFeedbackSound {
let sound: NSSound?
let playFailedEvent: String

static func load(
candidatePaths: [String],
loadedEvent: String,
loadFailedEvent: String,
playFailedEvent: String
) -> Self {
for path in candidatePaths {
if let sound = NSSound(contentsOfFile: path, byReference: true) {
NativeHostTelemetry.lifecycleEvent(
"native_host.capture_success_sound_loaded",
loadedEvent,
detail: "path=\(path)"
)
return sound
return Self(sound: sound, playFailedEvent: playFailedEvent)
}
}

let candidates = candidatePaths.joined(separator: ",")
NativeHostTelemetry.lifecycleWarning(
"native_host.capture_success_sound_load_failed",
loadFailedEvent,
detail: "candidates=\(candidates)"
)
return nil
return Self(sound: nil, playFailedEvent: playFailedEvent)
}

static func play(_ sound: NSSound?) {
func play() {
guard let sound else {
return
}
sound.stop()
sound.currentTime = 0
if !sound.play() {
NativeHostTelemetry.lifecycleWarning(
"native_host.capture_success_sound_play_failed")
NativeHostTelemetry.lifecycleWarning(playFailedEvent)
}
}
}

private enum CaptureSuccessSound {
private static let candidatePaths = [
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/system/Screen Capture.aif",
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/system/Shutter.aif",
]

static func load() -> NativeHostFeedbackSound {
NativeHostFeedbackSound.load(
candidatePaths: candidatePaths,
loadedEvent: "native_host.capture_success_sound_loaded",
loadFailedEvent: "native_host.capture_success_sound_load_failed",
playFailedEvent: "native_host.capture_success_sound_play_failed"
)
}
}

private enum OcrCompletionSound {
private static let candidatePaths = [
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/accessibility/Sticky Keys ON.aif",
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/siri/jbl_confirm.caf",
"/System/Library/Components/CoreAudio.component/Contents/SharedSupport/SystemSounds/system/Volume Mount.aif",
"/System/Library/Sounds/Glass.aiff",
]

static func load() -> NativeHostFeedbackSound {
NativeHostFeedbackSound.load(
candidatePaths: candidatePaths,
loadedEvent: "native_host.ocr_completion_sound_loaded",
loadFailedEvent: "native_host.ocr_completion_sound_load_failed",
playFailedEvent: "native_host.ocr_completion_sound_play_failed"
)
}
}

private let frozenMosaicBlockSizePixels: CGFloat = 10.0

package func frozenExportOverlayPoint(
Expand Down Expand Up @@ -690,6 +726,7 @@ final class CaptureSessionController: NSObject {
qos: .userInitiated
)
private let captureSuccessSound = CaptureSuccessSound.load()
private let ocrCompletionSound = OcrCompletionSound.load()
private var session: RsnapHostSession?
private var overlayController: CaptureOverlayController?
private var frozenFrameLatchToken: FrozenFrameLatchToken?
Expand Down Expand Up @@ -2369,7 +2406,7 @@ final class CaptureSessionController: NSObject {
height: cgImage.height
)

CaptureSuccessSound.play(captureSuccessSound)
captureSuccessSound.play()

try session.send(report: .hostEffectCompleted(.copyCapture))
try session.send(report: .statusMessage("Copied capture to clipboard."))
Expand All @@ -2393,7 +2430,7 @@ final class CaptureSessionController: NSObject {
let outputURL = try nextOutputURL()
try pngData.write(to: outputURL, options: .atomic)

CaptureSuccessSound.play(captureSuccessSound)
captureSuccessSound.play()

try session.send(report: .hostEffectCompleted(.saveCapture))
try session.send(report: .statusMessage("Saved capture to \(outputURL.lastPathComponent)."))
Expand Down Expand Up @@ -2549,6 +2586,10 @@ final class CaptureSessionController: NSObject {
automaticLanguageDetection: automaticallyDetectsLanguage
)

if !text.isEmpty {
ocrCompletionSound.play()
}

try session.send(report: .hostEffectCompleted(.recognizeText))
let message =
text.isEmpty
Expand Down