forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathFloatingBarVoicePlaybackService.swift
More file actions
1433 lines (1316 loc) · 51.6 KB
/
Copy pathFloatingBarVoicePlaybackService.swift
File metadata and controls
1433 lines (1316 loc) · 51.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
@preconcurrency import AVFoundation
import CryptoKit
import Foundation
import OmiSupport
import VoiceTurnDomain
/// Boxes an `AVSpeechUtterance` (non-Sendable) so it can cross the
/// `@MainActor` task boundary from a nonisolated delegate callback.
private final class UtteranceBox: @unchecked Sendable {
let value: AVSpeechUtterance
init(_ value: AVSpeechUtterance) { self.value = value }
}
/// User-facing acknowledgement is selected from the admitted slow tool, never
/// from transcript text. This keeps the kernel as the only routing authority
/// while ensuring the user hears something immediately after admission.
enum RealtimeSlowToolAcknowledgementKind: String, CaseIterable, Sendable {
case deeperThinking = "deeper-thinking"
case publicWebSearch = "public-web-search"
init?(toolName: String) {
switch HubTool(rawValue: toolName) {
case .thinkDeeper: self = .deeperThinking
case .webSearch: self = .publicWebSearch
default: return nil
}
}
var phrases: [String] {
switch self {
case .deeperThinking:
return [
"Let me think that through.",
"Give me a moment to think that through.",
"Let me dig into that.",
"I'll take a closer look.",
]
case .publicWebSearch:
return [
"Let me look that up.",
"I'll check the latest on that.",
"Let me verify that.",
"Checking the latest now.",
]
}
}
}
@MainActor
final class FloatingBarVoicePlaybackService: NSObject, AVAudioPlayerDelegate, AVSpeechSynthesizerDelegate {
static let shared = FloatingBarVoicePlaybackService()
// First chunk stays small so playback starts fast.
nonisolated private static let firstChunkMinimumLength = 40
nonisolated private static let firstChunkPreferredLength = 120
nonisolated private static let firstChunkEmergencyLength = 200
// Follow-up chunks are much larger so the response is stitched from fewer
// generated audio clips. Each chunk boundary carries leading/trailing silence,
// so fewer chunks means far less perceived pausing between sentences and
// paragraphs of a long answer.
nonisolated private static let followupChunkMinimumLength = 320
nonisolated private static let followupChunkPreferredLength = 520
nonisolated private static let followupChunkEmergencyLength = 800
private var playbackRate: Float { ShortcutSettings.shared.voicePlaybackSpeed }
nonisolated private static let voiceSampleText = "Hey, how is it going?"
nonisolated static let backgroundAgentKickoffPhrases: [String] = [
"I'll get an agent on that.",
"Starting an agent for that now.",
"Got it. I'm handing this to an agent.",
"I'll have an agent work on that.",
"I'm getting an agent started.",
"I'll have an agent take it from here.",
"Got it. I'm starting an agent now.",
"I'll put an agent on that.",
"An agent is getting started on that.",
"I'm kicking off an agent now.",
]
nonisolated private static let fillerPhrases: [String] = [
"Let me check.",
"One moment.",
"Looking into it.",
"Let me see.",
"Checking now.",
"Hold on.",
"One sec.",
"Working on it.",
]
private var playbackTask: Task<Void, Never>?
private var fillerTask: Task<Void, Never>?
private var currentMode: PlaybackMode?
private var currentResponseID: String?
private var interruptedResponseID: String?
private var shouldInterruptNextResponse = false
private var streamedText = ""
private var bufferedText = ""
private var synthesisQueue: [String] = []
// Carries each chunk's source text alongside its synthesized audio so playback can fall
// back to the system voice (speaking the text) if AVAudioPlayer can't play the audio.
private var audioQueue: [(audio: Data, text: String)] = []
private var isFillerSynthesizing = false
private var isOneShotSynthesizing = false
private var isSynthesizing = false
private var hasStartedRealPlayback = false
private var hasEmittedFirstChunk = false
private var audioPlayer: AVAudioPlayer?
private var activePlayerFallbackText = ""
private var playbackGeneration: UInt64 = 0
// AVSpeechSynthesizer delegates arrive asynchronously, including after a
// stop. The current token is the sole owner of both the physical utterance
// and its PTT lease; a callback for an older utterance must not drain a
// replacement turn.
private var activeSystemSpeechToken: SystemSpeechToken?
private var activePTTLease: VoiceOutputLease?
private var activeRealtimeSlowToolAcknowledgement: RealtimeSlowToolAcknowledgementKind?
private var activeRealtimeSlowToolAcknowledgementTransport: String?
/// QueryTracer for the in-flight query, handed in by the floating-bar window.
/// Used to bracket the `tts_start` span (first real chunk → first audio out).
var tracer: QueryTracer?
private let speechSynthesizer = AVSpeechSynthesizer()
private override init() {
super.init()
speechSynthesizer.delegate = self
}
var isSpeaking: Bool {
if audioPlayer?.isPlaying == true { return true }
if activeSystemSpeechToken != nil { return true }
if isFillerSynthesizing { return true }
if isOneShotSynthesizing { return true }
if isSynthesizing { return true }
return !audioQueue.isEmpty || !synthesisQueue.isEmpty
}
func playFillerIfEnabled() {
guard ShortcutSettings.shared.hasAnyFloatingBarVoiceAnswersEnabled else { return }
if VoiceTurnCoordinator.shared.activeTurnID != nil,
acquirePTTLeaseIfNeeded(.filler) == nil
{
return
}
setFloatingPillResponseGlow(true)
if currentMode == nil {
currentMode = resolvePlaybackMode()
}
hasStartedRealPlayback = false
let phrase = Self.fillerPhrases.randomElement()!
guard let mode = currentMode else { return }
switch mode {
case .systemVoice:
enqueueSystemSpeech(phrase)
case .openAI(let voiceID, let instructions):
isFillerSynthesizing = true
let generation = playbackGeneration
fillerTask = Task { [weak self] in
do {
let audioData = try await Self.synthesizeOpenAISpeech(
text: phrase, voiceID: voiceID, instructions: instructions)
try Task.checkCancellation()
await MainActor.run {
guard let self else { return }
guard self.playbackGeneration == generation else { return }
self.isFillerSynthesizing = false
self.fillerTask = nil
guard !self.hasStartedRealPlayback else {
self.clearFloatingPillResponseGlowIfIdle()
return
}
self.startPlayback(audioData, fallbackText: phrase)
self.clearFloatingPillResponseGlowIfIdle()
}
} catch {
await MainActor.run {
guard let self else { return }
guard self.playbackGeneration == generation else { return }
self.isFillerSynthesizing = false
self.fillerTask = nil
self.clearFloatingPillResponseGlowIfIdle()
}
}
}
}
}
func playResponseIfEnabled(_ message: ChatMessage?) {
guard ShortcutSettings.shared.hasAnyFloatingBarVoiceAnswersEnabled else { return }
updateStreamingResponseIfEnabled(message, isFinal: true)
}
func updateStreamingResponseIfEnabled(_ message: ChatMessage?, isFinal: Bool) {
guard ShortcutSettings.shared.hasAnyFloatingBarVoiceAnswersEnabled else { return }
guard let message else { return }
if currentResponseID != message.id {
resetPlaybackPipeline(clearMode: false, notifyPTTDrain: true)
currentResponseID = message.id
interruptedResponseID = shouldInterruptNextResponse ? message.id : nil
shouldInterruptNextResponse = false
}
let text = Self.cleanedPlaybackText(from: message)
guard !text.isEmpty, Self.shouldSpeak(text) else { return }
if interruptedResponseID == message.id {
streamedText = text
bufferedText = ""
clearFloatingPillResponseGlowIfIdle()
return
}
if VoiceTurnCoordinator.shared.activeTurnID != nil,
acquirePTTLeaseIfNeeded(.selectedVoiceFallback) == nil
{
return
}
setFloatingPillResponseGlow(true)
if currentMode == nil {
currentMode = resolvePlaybackMode()
}
guard let mode = currentMode else {
return
}
if !text.hasPrefix(streamedText) {
streamedText = ""
bufferedText = ""
synthesisQueue.removeAll()
audioQueue.removeAll()
}
// Cancel filler and stop filler audio when first real chunk is ready
if !hasStartedRealPlayback && text.count > 0 {
hasStartedRealPlayback = true
tracer?.begin("tts_start")
fillerTask?.cancel()
fillerTask = nil
audioPlayer?.stop()
audioPlayer = nil
speechSynthesizer.stopSpeaking(at: .immediate)
}
if text.count > streamedText.count {
let newText = String(text.dropFirst(streamedText.count))
streamedText = text
bufferedText += newText
drainBufferedText(isFinal: isFinal, mode: mode)
} else if isFinal {
drainBufferedText(isFinal: true, mode: mode)
}
}
private func resolvePlaybackMode() -> PlaybackMode {
let selectedVoice = ShortcutSettings.voiceOption(for: ShortcutSettings.shared.selectedVoiceID)
if selectedVoice.isOpenAI, let openAIVoice = selectedVoice.openAIVoice {
return .openAI(
voiceID: openAIVoice,
instructions: selectedVoice.openAIInstructions ?? ""
)
}
return .systemVoice(selectedVoice)
}
private func drainBufferedText(isFinal: Bool, mode: PlaybackMode) {
while let boundary = Self.nextChunkBoundary(
in: bufferedText, isFinal: isFinal, isFirstChunk: !hasEmittedFirstChunk)
{
let chunk = String(bufferedText[..<boundary]).trimmingCharacters(in: .whitespacesAndNewlines)
bufferedText = String(bufferedText[boundary...]).trimmingCharacters(
in: .whitespacesAndNewlines)
guard !chunk.isEmpty, Self.shouldSpeak(chunk) else { continue }
hasEmittedFirstChunk = true
enqueueChunk(chunk, mode: mode)
}
}
private func enqueueChunk(_ text: String, mode: PlaybackMode) {
switch mode {
case .systemVoice:
enqueueSystemSpeech(text)
case .openAI:
synthesisQueue.append(text)
startSynthesisIfNeeded(mode: mode)
}
}
private func startSynthesisIfNeeded(mode: PlaybackMode) {
guard !isSynthesizing else { return }
guard !synthesisQueue.isEmpty else { return }
let text = synthesisQueue.removeFirst()
isSynthesizing = true
let token = currentSynthesisToken()
playbackTask?.cancel()
playbackTask = Task { [weak self] in
do {
let audioData: Data
switch mode {
case .openAI(let voiceID, let instructions):
audioData = try await Self.synthesizeOpenAISpeech(
text: text, voiceID: voiceID, instructions: instructions)
case .systemVoice:
return
}
try Task.checkCancellation()
await MainActor.run {
guard let self else { return }
guard self.ownsCurrentSynthesisToken(token) else { return }
self.isSynthesizing = false
self.playbackTask = nil
self.audioQueue.append((audio: audioData, text: text))
self.startPlaybackIfNeeded()
self.startSynthesisIfNeeded(mode: mode)
self.clearFloatingPillResponseGlowIfIdle()
}
} catch is CancellationError {
await MainActor.run {
guard let self else { return }
guard self.ownsCurrentSynthesisToken(token) else { return }
self.isSynthesizing = false
self.playbackTask = nil
self.startSynthesisIfNeeded(mode: mode)
self.clearFloatingPillResponseGlowIfIdle()
}
} catch {
if Self.isCancellation(error) {
await MainActor.run {
guard let self else { return }
guard self.ownsCurrentSynthesisToken(token) else { return }
self.isSynthesizing = false
self.playbackTask = nil
self.startSynthesisIfNeeded(mode: mode)
self.clearFloatingPillResponseGlowIfIdle()
}
return
}
await MainActor.run {
guard let self else { return }
guard self.ownsCurrentSynthesisToken(token) else { return }
self.isSynthesizing = false
self.playbackTask = nil
guard self.canUseCloudTTSFallback(after: error, token: token, operation: "chunk") else {
self.startSynthesisIfNeeded(mode: mode)
self.clearFloatingPillResponseGlowIfIdle()
return
}
log(
"FloatingBarVoicePlaybackService: cloud TTS chunk synthesis failed, falling back to system voice: \(error.localizedDescription)"
)
self.recordSelectedVoiceFallback(
to: "system_voice_fallback", reason: Self.ttsFallbackReason(for: error), outcome: .degraded)
self.enqueueSystemSpeech(text)
self.startSynthesisIfNeeded(mode: mode)
self.clearFloatingPillResponseGlowIfIdle()
}
}
}
}
func stop() {
resetPlaybackPipeline(clearMode: true)
currentResponseID = nil
interruptedResponseID = nil
shouldInterruptNextResponse = false
}
/// Play a short preview of the given voice so the user can hear it
/// when switching voices in settings.
func playVoiceSample(voiceID: String) {
guard VoiceTurnCoordinator.shared.activeTurnID == nil else {
log("FloatingBarVoicePlaybackService: voice sample denied while PTT owns audible output")
return
}
resetPlaybackPipeline(clearMode: true)
currentResponseID = nil
interruptedResponseID = nil
shouldInterruptNextResponse = false
let phrase = Self.voiceSampleText
let voice = ShortcutSettings.voiceOption(for: voiceID)
if voice.isLocalSystem {
enqueueSystemSpeech(phrase)
return
}
if voice.isOpenAI, let openAIVoice = voice.openAIVoice {
let generation = playbackGeneration
playbackTask = Task { [weak self] in
do {
let audioData = try await Self.synthesizeOpenAISpeech(
text: phrase, voiceID: openAIVoice, instructions: voice.openAIInstructions ?? "")
try Task.checkCancellation()
await MainActor.run {
guard let self else { return }
guard self.playbackGeneration == generation else { return }
self.startPlayback(audioData)
}
} catch is CancellationError {
return
} catch {
if Self.isCancellation(error) { return }
log(
"FloatingBarVoicePlaybackService: OpenAI voice sample failed: \(error.localizedDescription)"
)
}
}
return
}
enqueueSystemSpeech(phrase)
}
/// Synthesize and play a single short phrase via the selected voice. Used by
/// agent pills to speak a short acknowledgement like "On it" before the agent kicks off.
func speakOneShot(_ text: String, lease: VoiceOutputLease? = nil) {
let trimmed = InterjectVoiceFeedbackRouting.spokenText(from: text)
.trimmingCharacters(in: .whitespacesAndNewlines)
guard !trimmed.isEmpty else { return }
if let lease {
guard VoiceTurnCoordinator.shared.outputSnapshot.activeLease == lease else {
log("FloatingBarVoicePlaybackService: dropping one-shot with stale PTT lease")
return
}
activePTTLease = lease
} else if VoiceTurnCoordinator.shared.activeTurnID != nil,
acquirePTTLeaseIfNeeded(.deterministicAgentAck) == nil
{
return
}
setFloatingPillResponseGlow(true)
let mode = currentMode ?? resolvePlaybackMode()
currentMode = mode
switch mode {
case .openAI(let voiceID, let instructions):
let token = currentSynthesisToken()
isOneShotSynthesizing = true
Task { [weak self] in
do {
let audio = try await Self.synthesizeOpenAISpeech(
text: trimmed, voiceID: voiceID, instructions: instructions)
await MainActor.run {
guard let self, self.ownsCurrentSynthesisToken(token) else { return }
self.isOneShotSynthesizing = false
self.startPlayback(audio, fallbackText: trimmed)
}
} catch {
await MainActor.run {
guard let self, self.ownsCurrentSynthesisToken(token) else { return }
self.isOneShotSynthesizing = false
guard self.canUseCloudTTSFallback(after: error, token: token, operation: "one_shot") else { return }
log(
"FloatingBarVoicePlaybackService: one-shot synthesis failed; rendering the same response with system voice "
+ "reason=\(Self.ttsFallbackReason(for: error))")
self.recordSelectedVoiceFallback(
to: "system_voice_fallback", reason: Self.ttsFallbackReason(for: error), outcome: .degraded)
self.enqueueSystemSpeech(trimmed)
}
}
}
case .systemVoice:
enqueueSystemSpeech(trimmed)
}
}
func speakBackgroundAgentKickoff() {
if VoiceTurnCoordinator.shared.activeTurnID != nil,
acquirePTTLeaseIfNeeded(.deterministicAgentAck) == nil
{
return
}
let phrase = Self.randomBackgroundAgentKickoffPhrase()
setFloatingPillResponseGlow(true)
let mode = currentMode ?? resolvePlaybackMode()
currentMode = mode
switch mode {
case .openAI(let voiceID, let instructions):
let token = currentSynthesisToken()
isOneShotSynthesizing = true
Task { [weak self] in
do {
let audio = try await Self.cachedOrSynthesizedBackgroundAgentKickoffAudio(
text: phrase, voiceID: voiceID, instructions: instructions)
await MainActor.run {
guard let self, self.ownsCurrentSynthesisToken(token) else { return }
self.isOneShotSynthesizing = false
self.startPlayback(audio, fallbackText: phrase)
}
} catch {
await MainActor.run {
guard let self, self.ownsCurrentSynthesisToken(token) else { return }
self.isOneShotSynthesizing = false
guard self.canUseCloudTTSFallback(after: error, token: token, operation: "background_kickoff")
else { return }
let cachedFallback = Self.cachedBackgroundAgentKickoffAudio(
voiceID: voiceID, instructions: instructions)
if let cachedFallback {
self.recordSelectedVoiceFallback(
to: "cached_openai_tts", reason: Self.ttsFallbackReason(for: error), outcome: .recovered)
self.startPlayback(cachedFallback, fallbackText: phrase)
} else {
self.recordSelectedVoiceFallback(
to: "system_voice_fallback", reason: Self.ttsFallbackReason(for: error), outcome: .degraded)
self.enqueueSystemSpeech(phrase)
}
}
}
}
case .systemVoice:
enqueueSystemSpeech(phrase)
}
}
/// Speak the accepted slow-tool acknowledgement without waiting on realtime
/// provider audio. A shipped clip for the session's exact provider voice is
/// preferred; the selected batch-TTS cache and system voice remain fallbacks.
///
/// The provider is required so a Gemini/Charon turn cannot accidentally play
/// an OpenAI/cedar clip (or the unrelated selected voice-picker profile).
func speakRealtimeSlowToolAcknowledgement(
_ kind: RealtimeSlowToolAcknowledgementKind,
provider: RealtimeHubProvider
) {
if VoiceTurnCoordinator.shared.activeTurnID != nil,
acquirePTTLeaseIfNeeded(.deterministicAgentAck) == nil
{
return
}
guard let phrase = kind.phrases.randomElement() else { return }
activeRealtimeSlowToolAcknowledgement = kind
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement queued kind=\(kind.rawValue)"
)
setFloatingPillResponseGlow(true)
let mode = currentMode ?? resolvePlaybackMode()
currentMode = mode
// Bundled clips are the only acknowledgement path that is both immediate
// and independent of auth/network/cache state. The locator tolerates the
// flattened and nested forms emitted by SwiftPM processed resources.
if case .bundled(let data) = RealtimeVoicePhraseAudioSelection.select(
provider: provider, kind: kind, phrase: phrase)
{
activeRealtimeSlowToolAcknowledgementTransport = "pre_recorded"
startPlayback(data, fallbackText: phrase)
return
}
switch mode {
case .openAI(let voiceID, let instructions):
if let cached = Self.cachedRealtimeSlowToolAcknowledgementAudio(
kind: kind,
text: phrase,
voiceID: voiceID,
instructions: instructions)
{
activeRealtimeSlowToolAcknowledgementTransport = "selected_voice"
startPlayback(cached, fallbackText: phrase)
} else {
activeRealtimeSlowToolAcknowledgementTransport = "system_voice"
enqueueSystemSpeech(phrase)
Task {
_ = try? await Self.cachedOrSynthesizedRealtimeSlowToolAcknowledgementAudio(
kind: kind,
text: phrase,
voiceID: voiceID,
instructions: instructions)
}
}
case .systemVoice:
activeRealtimeSlowToolAcknowledgementTransport = "system_voice"
enqueueSystemSpeech(phrase)
}
}
func prewarmBackgroundAgentKickoffPhrases() {
// Synthesis needs an authenticated backend call; signed out it can only fail — and at launch
// it walked the main thread into the auth fence while a restore held it (#11374).
guard AuthService.shared.isSignedIn else { return }
let mode = currentMode ?? resolvePlaybackMode()
currentMode = mode
guard case .openAI(let voiceID, let instructions) = mode else { return }
Task {
for phrase in Self.backgroundAgentKickoffPhrases {
do {
_ = try await Self.cachedOrSynthesizedBackgroundAgentKickoffAudio(
text: phrase, voiceID: voiceID, instructions: instructions)
} catch {
log(
"FloatingBarVoicePlaybackService: background agent kickoff cache prewarm failed: \(error.localizedDescription)"
)
return
}
}
}
}
func prewarmRealtimeSlowToolAcknowledgementPhrases() {
guard AuthService.shared.isSignedIn else { return }
let mode = currentMode ?? resolvePlaybackMode()
currentMode = mode
guard case .openAI(let voiceID, let instructions) = mode else { return }
Task {
for kind in RealtimeSlowToolAcknowledgementKind.allCases {
for phrase in kind.phrases {
do {
_ = try await Self.cachedOrSynthesizedRealtimeSlowToolAcknowledgementAudio(
kind: kind,
text: phrase,
voiceID: voiceID,
instructions: instructions)
} catch {
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement cache prewarm failed: \(error.localizedDescription)"
)
return
}
}
}
}
}
@discardableResult
func interruptCurrentResponse(
leaseID expectedLeaseID: VoiceLeaseID? = nil,
armNextResponse: Bool = false
) -> Bool {
switch VoiceOutputHandoffPolicy.playbackStopAdmission(
activeLease: activePTTLease,
requestedLeaseID: expectedLeaseID,
activeTurnID: VoiceTurnCoordinator.shared.activeTurnID
) {
case .stale:
log("FloatingBarVoicePlaybackService: ignored stale playback stop lease=\(expectedLeaseID?.description ?? "nil")")
return false
case .alreadyComplete:
return true
case .apply:
break
}
if let currentResponseID {
interruptedResponseID = currentResponseID
shouldInterruptNextResponse = false
} else {
shouldInterruptNextResponse = armNextResponse
}
resetPlaybackPipeline(clearMode: false)
clearFloatingPillResponseGlowIfIdle()
return true
}
private func startPlaybackIfNeeded() {
guard audioPlayer == nil else { return }
guard !audioQueue.isEmpty else { return }
let next = audioQueue.removeFirst()
startPlayback(next.audio, fallbackText: next.text)
}
private func startPlayback(_ data: Data, fallbackText: String = "") {
do {
if UserDefaults.standard.bool(forKey: "forceTTSPlaybackFail") {
throw NSError(domain: "TTSPlayback", code: -1, userInfo: [NSLocalizedDescriptionKey: "forced playback failure"])
}
let player = try AVAudioPlayer(data: data)
player.delegate = self
player.enableRate = true
player.rate = playbackRate
player.prepareToPlay()
let started =
!UserDefaults.standard.bool(forKey: .forceTTSPlaybackStartFalse)
&& player.play()
guard VoicePlaybackStartPolicy.accepts(started: started) else {
throw NSError(
domain: "TTSPlayback",
code: -2,
userInfo: [NSLocalizedDescriptionKey: "audio player refused to start"])
}
audioPlayer = player
activePlayerFallbackText = fallbackText
if let lease = activePTTLease {
_ = VoiceTurnCoordinator.shared.noteOutputProgress(lease)
}
if let acknowledgement = activeRealtimeSlowToolAcknowledgement,
activePTTLease?.lane == .deterministicAgentAck
{
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement started kind=\(acknowledgement.rawValue) transport=\(activeRealtimeSlowToolAcknowledgementTransport ?? "unknown")"
)
}
tracer?.end("tts_start")
} catch {
// Don't drop the reply silently — speak this chunk with the system voice instead.
log(
"FloatingBarVoicePlaybackService: audio playback failed, falling back to system voice: \(error.localizedDescription)"
)
recordSelectedVoiceFallback(
to: fallbackText.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty
? "none" : "system_voice_fallback",
reason: "enqueue_failed",
outcome: fallbackText.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty
? .exhausted : .degraded)
if activeRealtimeSlowToolAcknowledgement != nil {
activeRealtimeSlowToolAcknowledgementTransport = "system_voice"
}
enqueueSystemSpeech(fallbackText)
}
}
private func recordSelectedVoiceFallback(
to: String,
reason: String,
outcome: DesktopFallbackOutcome
) {
DesktopDiagnosticsManager.shared.recordFallback(
area: activePTTLease == nil ? "tts_fallback" : "ptt_cascade",
from: "openai_tts",
to: to,
reason: reason,
outcome: outcome,
extra: ["user_visible": outcome != .recovered])
}
private func currentSynthesisToken() -> VoiceSynthesisToken {
VoiceSynthesisToken(generation: playbackGeneration, leaseID: activePTTLease?.id)
}
private func ownsCurrentSynthesisToken(_ token: VoiceSynthesisToken) -> Bool {
VoiceSynthesisFallbackPolicy.ownsCurrentOutput(
token: token,
playbackGeneration: playbackGeneration,
activeLeaseID: activePTTLease?.id)
}
/// A cancelled or superseded cloud request belongs to an old output owner.
/// Never turn it into cached or system speech after that owner has gone away.
private func canUseCloudTTSFallback(
after error: Error,
token: VoiceSynthesisToken,
operation: String
) -> Bool {
let allowed = VoiceSynthesisFallbackPolicy.shouldUseFallback(
afterCancellation: Self.isCancellation(error),
token: token,
playbackGeneration: playbackGeneration,
activeLeaseID: activePTTLease?.id)
guard !allowed else { return true }
log("FloatingBarVoicePlaybackService: dropping \(operation) fallback for cancelled or stale output")
return false
}
/// The delegate callback is not a global "speech stopped" signal: AVFoundation
/// may deliver it after `stopSpeaking` or after another utterance began.
private func completeSystemSpeechIfCurrent(_ utterance: AVSpeechUtterance) -> Bool {
guard
SystemSpeechCallbackPolicy.matchesCurrentUtterance(
callbackUtterance: utterance,
currentToken: activeSystemSpeechToken,
playbackGeneration: playbackGeneration)
else { return false }
guard
SystemSpeechCallbackPolicy.accepts(
callbackUtterance: utterance,
currentToken: activeSystemSpeechToken,
playbackGeneration: playbackGeneration,
activeLeaseID: activePTTLease?.id)
else {
// This exact utterance finished after its lease was superseded. Clear
// only its physical marker; never let it drain the replacement lease.
activeSystemSpeechToken = nil
return false
}
activeSystemSpeechToken = nil
return true
}
/// The system voice must honor the same Voice Speed setting the OpenAI audio path
/// applies via `AVAudioPlayer.rate`. It used to hardcode `0.47`, so with the default
/// speed of 1.4× every system-voice utterance (spoken notifications, TTS fallbacks)
/// crawled at ~1× while push-to-talk answers played at 1.4× — the same reply sounded
/// like two different products. `AVSpeechUtterance.rate` is a 0…1 scale where ~0.47 is
/// conversational pace, so the user's multiplier scales that base, clamped to the
/// framework's legal range.
nonisolated static func systemSpeechRate(playbackSpeed: Float) -> Float {
let base: Float = 0.47
return min(
AVSpeechUtteranceMaximumSpeechRate,
max(AVSpeechUtteranceMinimumSpeechRate, base * playbackSpeed))
}
private func enqueueSystemSpeech(_ text: String) {
guard !text.trimmingCharacters(in: .whitespacesAndNewlines).isEmpty else {
if let lease = activePTTLease {
activePTTLease = nil
VoiceTurnCoordinator.shared.publish(
.playbackFailedScoped(
turnID: lease.turnID,
identity: lease.identity,
leaseID: lease.id,
message: "no fallback speech available"))
}
clearFloatingPillResponseGlowIfIdle()
return
}
let utterance = AVSpeechUtterance(string: text)
utterance.rate = Self.systemSpeechRate(playbackSpeed: playbackRate)
utterance.pitchMultiplier = 1.02
utterance.volume = 1.0
utterance.voice = preferredSystemVoice()
activeSystemSpeechToken = SystemSpeechToken(
generation: playbackGeneration,
leaseID: activePTTLease?.id,
utterance: utterance)
speechSynthesizer.speak(utterance)
tracer?.end("tts_start")
}
nonisolated func audioPlayerDidFinishPlaying(_ player: AVAudioPlayer, successfully flag: Bool) {
Task { @MainActor [weak self] in
guard let self else { return }
guard self.audioPlayer === player else { return }
if let acknowledgement = self.activeRealtimeSlowToolAcknowledgement {
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement finished kind=\(acknowledgement.rawValue) transport=\(self.activeRealtimeSlowToolAcknowledgementTransport ?? "unknown") success=\(flag)"
)
self.activeRealtimeSlowToolAcknowledgement = nil
self.activeRealtimeSlowToolAcknowledgementTransport = nil
}
let fallbackText = self.activePlayerFallbackText
self.audioPlayer = nil
self.activePlayerFallbackText = ""
if !flag, !fallbackText.isEmpty {
log("FloatingBarVoicePlaybackService: player ended unsuccessfully; using system voice")
self.recordSelectedVoiceFallback(
to: "system_voice_fallback", reason: "enqueue_failed", outcome: .degraded)
self.enqueueSystemSpeech(fallbackText)
return
}
self.startPlaybackIfNeeded()
self.clearFloatingPillResponseGlowIfIdle()
}
}
nonisolated func speechSynthesizer(
_ synthesizer: AVSpeechSynthesizer,
didStart utterance: AVSpeechUtterance
) {
let utteranceBox = UtteranceBox(utterance)
Task { @MainActor [weak self, utteranceBox] in
guard let self,
SystemSpeechCallbackPolicy.matchesCurrentUtterance(
callbackUtterance: utteranceBox.value,
currentToken: self.activeSystemSpeechToken,
playbackGeneration: self.playbackGeneration),
let acknowledgement = self.activeRealtimeSlowToolAcknowledgement
else { return }
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement started kind=\(acknowledgement.rawValue) transport=\(self.activeRealtimeSlowToolAcknowledgementTransport ?? "system_voice")"
)
}
}
nonisolated func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didFinish utterance: AVSpeechUtterance) {
let utteranceBox = UtteranceBox(utterance)
Task { @MainActor [weak self, utteranceBox] in
guard let self else { return }
guard self.completeSystemSpeechIfCurrent(utteranceBox.value) else { return }
if let acknowledgement = self.activeRealtimeSlowToolAcknowledgement {
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement finished kind=\(acknowledgement.rawValue) transport=\(self.activeRealtimeSlowToolAcknowledgementTransport ?? "system_voice") success=true"
)
self.activeRealtimeSlowToolAcknowledgement = nil
self.activeRealtimeSlowToolAcknowledgementTransport = nil
}
self.startPlaybackIfNeeded()
self.clearFloatingPillResponseGlowIfIdle()
}
}
nonisolated func speechSynthesizer(_ synthesizer: AVSpeechSynthesizer, didCancel utterance: AVSpeechUtterance) {
let utteranceBox = UtteranceBox(utterance)
Task { @MainActor [weak self, utteranceBox] in
guard let self else { return }
guard self.completeSystemSpeechIfCurrent(utteranceBox.value) else { return }
if let acknowledgement = self.activeRealtimeSlowToolAcknowledgement {
log(
"FloatingBarVoicePlaybackService: realtime slow-tool acknowledgement finished kind=\(acknowledgement.rawValue) transport=\(self.activeRealtimeSlowToolAcknowledgementTransport ?? "system_voice") success=false"
)
self.activeRealtimeSlowToolAcknowledgement = nil
self.activeRealtimeSlowToolAcknowledgementTransport = nil
}
self.clearFloatingPillResponseGlowIfIdle()
}
}
private func resetPlaybackPipeline(clearMode: Bool, notifyPTTDrain: Bool = false) {
let leaseToRelease = activePTTLease
playbackGeneration &+= 1
playbackTask?.cancel()
playbackTask = nil
fillerTask?.cancel()
fillerTask = nil
isFillerSynthesizing = false
isOneShotSynthesizing = false
if clearMode {
currentMode = nil
// Drop the tracer only on full teardown. interruptCurrentResponse uses
// clearMode:false and runs just before the next query assigns a fresh
// tracer, so clearing there would discard the live one.
tracer = nil
}
streamedText = ""
bufferedText = ""
synthesisQueue.removeAll()
audioQueue.removeAll()
isSynthesizing = false
hasStartedRealPlayback = false
hasEmittedFirstChunk = false
audioPlayer?.stop()
audioPlayer = nil
activePlayerFallbackText = ""
speechSynthesizer.stopSpeaking(at: .immediate)
activeSystemSpeechToken = nil
activeRealtimeSlowToolAcknowledgement = nil
activeRealtimeSlowToolAcknowledgementTransport = nil
activePTTLease = nil
if let lease = leaseToRelease, notifyPTTDrain {
_ = VoiceTurnCoordinator.shared.releaseOutput(lease)
}
setFloatingPillResponseGlow(false)
}
private func setFloatingPillResponseGlow(_ active: Bool) {
if let lease = activePTTLease {
VoiceTurnCoordinator.shared.publish(
.responseActiveChanged(turnID: lease.turnID, active: active))
return
}
VoiceTurnCoordinator.shared.setUnscopedResponseActive(active)
}
private func clearFloatingPillResponseGlowIfIdle() {
if !isSpeaking {
finishActivePTTLeaseIfIdle()
setFloatingPillResponseGlow(false)
}
}
private func acquirePTTLeaseIfNeeded(_ lane: VoiceOutputLane) -> VoiceOutputLease? {
if let turnID = VoiceTurnCoordinator.shared.activeTurnID {
_ = preemptFillerIfNeeded(for: lane, turnID: turnID)
}
if let activePTTLease {
return activePTTLease.lane == lane ? activePTTLease : nil
}
guard let turnID = VoiceTurnCoordinator.shared.activeTurnID else { return nil }
switch VoiceTurnCoordinator.shared.acquireOutput(lane, turnID: turnID) {
case .acquired(let lease):
activePTTLease = lease
guard let providerIdentity = VoiceTurnCoordinator.shared.activeTurn?.providerEffectIdentity else {
log("FloatingBarVoicePlaybackService: dropping PTT output without provider effect identity")
activePTTLease = nil
return nil
}
VoiceTurnCoordinator.shared.publish(
.providerResponseStartedScoped(
turnID: turnID,
identity: providerIdentity,
sessionID: nil,
responseID: nil))
return lease
case .denied(let active):
log(
"FloatingBarVoicePlaybackService: dropping \(lane.rawValue) PTT output; "
+ "active_lane=\(active.lane.rawValue)")
return nil
case .staleTurn:
log("FloatingBarVoicePlaybackService: dropping stale \(lane.rawValue) PTT output")
return nil
}
}
/// Real output always wins over a provisional filler phrase. Stop the audio
/// engine before releasing its lease so the incoming lane cannot overlap it.
@discardableResult
func preemptFillerIfNeeded(for incomingLane: VoiceOutputLane, turnID: VoiceTurnID) -> Bool {
guard let lease = activePTTLease,
VoiceOutputHandoffPolicy.fillerCanYield(
active: lease,