// FlowContinuousCapture.swift // OSGKeyboard · Shared // // TypeWhisper-style continuous mic capture for Flow sessions: one // AVAudioEngine + input tap for the entire session. Utterances gate // whether buffers are forwarded to ASR; levels are always computed on // the audio thread and read from the main thread (never UserDefaults // from the realtime tap — that caused cross-process crashes). import Foundation import AVFoundation import os private enum FlowCaptureConstants { static let levelBarCount = 24 static let targetSampleRate: Double = 16_000 static let drainPollIntervalNs: UInt64 = 20_000_000 } private enum UtteranceGatePhase: Equatable { case idle case recording case draining } /// Thread-safe relay for utterance-scoped ASR snapshots. private final class FlowCaptureStreamRelay: @unchecked Sendable { private let lock = OSAllocatedUnfairLock() private var continuation: AsyncStream.Continuation? func bind(_ continuation: AsyncStream.Continuation) { lock.withLock { self.continuation = continuation } } func replay(_ snapshots: [AudioBufferSnapshot]) { lock.withLock { for snapshot in snapshots { continuation?.yield(snapshot) } } } func yield(_ snapshot: AudioBufferSnapshot) { _ = lock.withLock { continuation?.yield(snapshot) } } func finish() { lock.withLock { continuation?.finish() continuation = nil } } } /// Rolling pre-roll while utterance gate is closed (~400 ms at typical tap rates). private final class FlowPrerollStore: @unchecked Sendable { private let lock = OSAllocatedUnfairLock() private var snapshots: [AudioBufferSnapshot] = [] private let maxCount: Int init(maxCount: Int = 6) { self.maxCount = maxCount } func append(_ snapshot: AudioBufferSnapshot) { lock.withLock { snapshots.append(snapshot) if snapshots.count > maxCount { snapshots.removeFirst(snapshots.count - maxCount) } } } func drain() -> [AudioBufferSnapshot] { lock.withLock { let drained = snapshots snapshots.removeAll() return drained } } } /// Rolling bar levels updated from the audio tap; read on the main actor. private final class FlowLevelStore: @unchecked Sendable { private let lock = OSAllocatedUnfairLock() private var levels: [Float] init(barCount: Int) { levels = Array(repeating: 0, count: barCount) } func update(from buffer: AVAudioPCMBuffer, barCount: Int) { let computed = Self.calculateLevels(from: buffer, barCount: barCount) lock.withLock { levels = computed } } func snapshot() -> [Float] { lock.withLock { levels } } private static func calculateLevels(from buffer: AVAudioPCMBuffer, barCount: Int) -> [Float] { guard let channelData = buffer.floatChannelData else { return Array(repeating: 0, count: barCount) } let frameLength = Int(buffer.frameLength) guard frameLength > 0 else { return Array(repeating: 0, count: barCount) } let samplesPerBar = max(frameLength / barCount, 1) var result = [Float]() result.reserveCapacity(barCount) for barIndex in 0.. 0, hardwareFormat.channelCount > 0 else { throw StartError.invalidHardwareFormat( sampleRate: hardwareFormat.sampleRate, channels: Int(hardwareFormat.channelCount) ) } guard let resolvedTargetFormat = AVAudioFormat( commonFormat: .pcmFormatFloat32, sampleRate: FlowCaptureConstants.targetSampleRate, channels: 1, interleaved: false ) else { throw StartError.formatCreateFailed } guard let converter = AVAudioConverter(from: hardwareFormat, to: resolvedTargetFormat) else { throw StartError.converterCreateFailed } audioConverter = converter targetFormat = resolvedTargetFormat hwFormat = hardwareFormat // Rebuild the tap so its bound hardware format matches the new route. if didInstallTap { inputNode.removeTap(onBus: 0) didInstallTap = false } let gateLock = gate let relay = streamRelay let preroll = prerollStore let levels = levelStore let tracker = drainTracker let tailCounter = tailSampleCounter let policy = drainPolicy let tap = Self.makeAudioTapBlock( converter: converter, targetFormat: resolvedTargetFormat, hwFormat: hardwareFormat, gate: gateLock, levelStore: levels, prerollStore: preroll, streamRelay: relay, drainTracker: tracker, tailSampleCounter: tailCounter, drainPolicy: policy ) inputNode.installTap(onBus: 0, bufferSize: 4096, format: hardwareFormat, block: tap) didInstallTap = true audioEngine.prepare() do { try audioEngine.start() } catch { throw StartError.engineStartFailed(error.localizedDescription) } } /// Tear down the engine and release the audio session. public func stop() { removeSessionObservers() gate.withLock { $0 = .idle } drainTracker.reset() tailSampleCounter.withLock { $0 = 0 } streamRelay.finish() if didInstallTap { audioEngine.inputNode.removeTap(onBus: 0) didInstallTap = false } if audioEngine.isRunning { audioEngine.stop() } isRunning = false audioConverter = nil targetFormat = nil hwFormat = nil try? AVAudioSession.sharedInstance().setActive( false, options: .notifyOthersOnDeactivation ) } /// Re-activate capture after returning from background without /// reinstalling the tap (iOS may deactivate the audio session). public func reassertIfRunning() { guard isRunning else { return } let session = AVAudioSession.sharedInstance() try? session.setCategory( .playAndRecord, mode: .measurement, options: [.defaultToSpeaker, .allowBluetoothHFP, .mixWithOthers] ) try? session.setActive(true, options: .notifyOthersOnDeactivation) if !audioEngine.isRunning { try? audioEngine.start() } } // MARK: - Route / interruption recovery private func installSessionObservers() { let center = NotificationCenter.default if routeObserver == nil { routeObserver = center.addObserver( forName: AVAudioSession.routeChangeNotification, object: nil, queue: .main ) { [weak self] note in let reasonRaw = note.userInfo?[AVAudioSessionRouteChangeReasonKey] as? UInt MainActor.assumeIsolated { self?.handleRouteChange(reasonRaw: reasonRaw) } } } if interruptionObserver == nil { interruptionObserver = center.addObserver( forName: AVAudioSession.interruptionNotification, object: nil, queue: .main ) { [weak self] note in let typeRaw = note.userInfo?[AVAudioSessionInterruptionTypeKey] as? UInt let optionsRaw = note.userInfo?[AVAudioSessionInterruptionOptionKey] as? UInt MainActor.assumeIsolated { self?.handleInterruption(typeRaw: typeRaw, optionsRaw: optionsRaw) } } } } private func removeSessionObservers() { let center = NotificationCenter.default if let routeObserver { center.removeObserver(routeObserver) } if let interruptionObserver { center.removeObserver(interruptionObserver) } routeObserver = nil interruptionObserver = nil } private func handleRouteChange(reasonRaw: UInt?) { guard isRunning else { return } guard let reasonRaw, let reason = AVAudioSession.RouteChangeReason(rawValue: reasonRaw) else { return } switch reason { case .oldDeviceUnavailable, .newDeviceAvailable: log.info("Audio route changed (\(reasonRaw, privacy: .public)) — rebuilding engine") rebuildEngine() default: break } } private func handleInterruption(typeRaw: UInt?, optionsRaw: UInt?) { guard let typeRaw, let type = AVAudioSession.InterruptionType(rawValue: typeRaw) else { return } switch type { case .began: log.info("Audio interruption began") case .ended: guard isRunning else { return } let shouldResume: Bool if let optionsRaw { shouldResume = AVAudioSession.InterruptionOptions(rawValue: optionsRaw).contains(.shouldResume) } else { shouldResume = true } if shouldResume { log.info("Audio interruption ended — resuming capture") rebuildEngine() } @unknown default: break } } /// Stop and rebuild the engine against the current route, keeping /// `isRunning` intact so the session survives the swap transparently. private func rebuildEngine() { guard isRunning else { return } if audioEngine.isRunning { audioEngine.stop() } do { try activateEngine() } catch { log.error("Engine rebuild failed: \(error.localizedDescription, privacy: .public)") } } /// Begin forwarding downsampled buffers to ASR for one utterance. public func beginUtterance() -> AsyncStream { let (stream, continuation) = AsyncStream.makeStream() drainTracker.reset() tailSampleCounter.withLock { $0 = 0 } // Bind the consumer before opening the gate so early tap frames // are not dropped on the floor. streamRelay.bind(continuation) streamRelay.replay(prerollStore.drain()) gate.withLock { $0 = .recording } return stream } /// Drain trailing PCM after the user stops, then finish the ASR stream. public func endUtteranceAndDrain( policy: FlowCaptureTailDrainPolicy = .flowDefault ) async -> FlowCaptureDrainReport { let currentPhase = gate.withLock { $0 } guard currentPhase == .recording else { return .skipped } drainPolicy = policy gate.withLock { $0 = .draining } drainTracker.beginDrain() var endedBySilence = false while true { let decision = drainTracker.shouldFinish(policy: policy) if decision.finished { endedBySilence = decision.endedBySilence break } if Task.isCancelled { break } try? await Task.sleep(nanoseconds: FlowCaptureConstants.drainPollIntervalNs) } let flushSamples = flushConverterTailToStream() tailSampleCounter.withLock { $0 += flushSamples } streamRelay.finish() gate.withLock { $0 = .idle } let tailSamples = tailSampleCounter.withLock { $0 } let report = FlowCaptureDrainReport( drainDurationSeconds: drainTracker.elapsedSeconds(), endedBySilence: endedBySilence, tailSampleCount: tailSamples ) drainTracker.reset() tailSampleCounter.withLock { $0 = 0 } FlowPipelineDiagnostics.logDrain(report) return report } /// Immediate stop without tail drain (abort / session teardown). public func cancelUtterance() { gate.withLock { $0 = .idle } drainTracker.reset() tailSampleCounter.withLock { $0 = 0 } streamRelay.finish() } public func currentAudioLevels() -> [Float] { levelStore.snapshot() } // MARK: - Converter flush @discardableResult private func flushConverterTailToStream() -> Int { guard let converter = audioConverter, let targetFormat, let hwFormat else { return 0 } var flushedSamples = 0 let capacity = AVAudioFrameCount(max(512, hwFormat.sampleRate / 20)) guard let outBuffer = AVAudioPCMBuffer(pcmFormat: targetFormat, frameCapacity: capacity) else { return 0 } var endOfStreamSignaled = false while true { outBuffer.frameLength = 0 var error: NSError? let status = converter.convert(to: outBuffer, error: &error) { _, outStatus in if endOfStreamSignaled { outStatus.pointee = .noDataNow return nil } endOfStreamSignaled = true outStatus.pointee = .endOfStream return nil } if status == .error || error != nil { break } guard status == .haveData, outBuffer.frameLength > 0 else { break } let snapshot = AudioBufferSnapshot(buffer: outBuffer) guard !snapshot.samples.isEmpty else { break } streamRelay.yield(snapshot) flushedSamples += snapshot.samples.count } return flushedSamples } // MARK: - Audio tap (nonisolated — runs on realtime thread) private nonisolated static func makeAudioTapBlock( converter: AVAudioConverter, targetFormat: AVAudioFormat, hwFormat: AVAudioFormat, gate: OSAllocatedUnfairLock, levelStore: FlowLevelStore, prerollStore: FlowPrerollStore, streamRelay: FlowCaptureStreamRelay, drainTracker: FlowCaptureDrainTracker, tailSampleCounter: OSAllocatedUnfairLock, drainPolicy: FlowCaptureTailDrainPolicy ) -> @Sendable (AVAudioPCMBuffer, AVAudioTime) -> Void { return { buffer, _ in levelStore.update(from: buffer, barCount: FlowCaptureConstants.levelBarCount) let outFrames = AVAudioFrameCount( Double(buffer.frameLength) * targetFormat.sampleRate / hwFormat.sampleRate ) guard outFrames > 0, let outBuffer = AVAudioPCMBuffer(pcmFormat: targetFormat, frameCapacity: outFrames) else { return } var error: NSError? let status = converter.convert(to: outBuffer, error: &error) { _, outStatus in outStatus.pointee = .haveData return buffer } guard status == .haveData, error == nil, outBuffer.frameLength > 0 else { return } let snapshot = AudioBufferSnapshot(buffer: outBuffer) guard !snapshot.samples.isEmpty else { return } let phase = gate.withLock { $0 } switch phase { case .recording, .draining: streamRelay.yield(snapshot) if phase == .draining { drainTracker.noteAudio(samples: snapshot.samples, policy: drainPolicy) tailSampleCounter.withLock { $0 += snapshot.samples.count } } case .idle: prerollStore.append(snapshot) } } } }