hex/ios/HEXKeyboard/KeyboardLiveTyping.swift
Ryan Vogel 130835701d
iOS keyboard: Show what I say and Type as I speak (words while you dictate) (#2410)
* iOS keyboard: live words over the keys while dictating (stage 1, two looks)

What: while the keyboard records (in-keyboard dictation, iOS 26+), the capture's
16-bit chunks also feed Apple's SpeechAnalyzer (SpeechTranscriber with volatile and
fast results, DictationTranscriber's progressive preset for its languages), and the
words so far show over the keys: settled words in the keys' ink, the tentative tail
muted, newest line in view, whole lines at the top. Two looks behind a temporary App
Group key (debug.liveDictationLook): dim (keys at 10%) and hide. The preview takes every
touch on the keys, so nothing types while it shows; the recording bar, its cancel and
done, and the globe (drawn over the words where the keyboard has its own) work as before.
The final text still comes from the recording exactly as today; the live recogniser is
stopped when the capture stops (model lingering for the final pass).

Why: Ryan asked for the dictation to show in real time over a hidden or dimmed keyboard.
LiveTranscriptSource is one small protocol so the source can be swapped:
ParakeetLiveTranscriber (the audio so far again about once a second, a 20 s window) is
written but not wired. Never worse than today: no preview when neither switch wants it,
when less than 24 MB is left, when the language's model isn't on the iPhone (no
download), on an error, or before iOS 26. Hooks in KeyboardLocalDictation stay in the
capture's events and phase, away from the transcription call.

Verified: Studio simulator (iPhone 17 Pro iOS 27.2, SE iOS 26.5), real keyboard in a
host app with results recorded from Apple's recogniser on macOS 27.2.1 replayed (the
simulator has no speech models; LiveTranscriptReplay is simulator-only): both looks,
light and dark, upright and turned, a 60 s dictation scrolling, taps on Q and space
while recording type nothing with the preview (and "Q " without it), the globe switches
keyboards on the SE, no model -> no preview and the keys as today. Measured on macOS
with the same source: first words 0.5-1.0 s after the first word ends, word lag median
0.56-0.76 s, 2.1% of shown words rewritten, +0.4-2.6 MB in the feeding process.
code-shape.py passes. No settings UI yet (stage 2).

* iOS keyboard: Show what I say (hide look) and Type as I speak

What: look (b) only. While the keyboard records by itself the keys go and the words
so far take their place under the recording bar; the dim look and its temporary
debug.liveDictationLook key are gone. Two switches in Settings › Dictation on their
own card under the style card, iOS 26 and later only, Simplified Chinese:
- Show what I say (on by default): the preview.
- Type as I speak (off by default, "Words can change until you stop"):
  LiveFieldTyping types the live words through the text document proxy, retyping only
  the changed tail, and keeps exactly what it typed. It edits only while the text
  before the cursor still ends with that (smart quotes allowed for; a host showing only
  the end must show the part that changes); otherwise it stops and leaves the field,
  and the dictation goes in at the cursor as today. When the dictation's text goes in,
  KeyboardLiveTyping.handOver takes the words out first and returns the field as it was,
  so spacing, Undo dictation (the whole dictation), Learn how I type and typing logs see
  exactly what they did before. Cancel, a failure, nothing heard and the keyboard hiding
  take the words out (a held dictation goes in at the next keyboard as before). Never
  in secure, password, one-time code or card number fields, over a selection or a
  two-thumb Dictate's range, or with Translate what I say on (Ryan's call).
- Never worse than today: live words only with 32 MB left once the capture runs (the
  speech model's 24 MB transcription headroom plus the recogniser's share), stopped under
  24 MB or on a memory warning; the preview never shows before a recogniser is running,
  so a dictation without one never flashes it.
- The hand-over: the preview fades with the words it had while the keys and the
  dictation's own text come in; with Parakeet now English's default the field's words
  can differ slightly from the preview's (Apple's), and never flash in the preview.

Why: Ryan picked look (b) and the two switch names at the checkpoint.

Verified: Studio simulator (iPhone 17 Pro, iOS 27.2) with the replayed recogniser
results: the field typed and revised as the words came ("Quick note: Hey, I am running
about 10 minutes late. Can you grab us a table by...") and back to "Quick note:" after
Cancel; Settings › Dictation in English, dark with both on, and Simplified Chinese.
New tests in DictationLearningTests (LiveDictationTests: accumulator, joining, switch
defaults, typing and revising, stopping when the field changes or reports nothing,
private fields). README describes what the keyboard shows while recording.
code-shape.py passes.

* iOS keyboard: the preview draws only the end of a long dictation

What: LiveDictationPreviewView draws its words with one label in a clipping box, moved up by
whole lines once they overflow it, and only about the box's worth of text and three lines more
(from a word's start). It replaces the scrolling UITextView, so the words can no longer be
dragged back.

Why: on the iPhone 17 Pro a 60 s dictation with the preview held up to 27 MB more in the
keyboard (peak 103 MB, against 60 MB with the recogniser on and the preview off); the Studio
simulator showed the same, +24.5 MB.

Verified: Studio simulator, the 60 s replay: +24.5 MB (text view) -> +17.3 (capped text view)
-> +5.7 MB with the label, against +7.0 MB for the same recording without the preview. Test
for the tail in LiveDictationTests.

* iOS keyboard: the preview's tail keeps a word that starts right at the cut

Verified: LiveDictationTests on the Studio simulator.

* iOS keyboard: Type as I speak's words are replaced by the held text after the keyboard hides

What: when the keyboard hides mid-dictation, KeyboardLiveTyping notes the words it typed
(LiveDictationSettings.leftover, in the App Group) as well as taking them out. When the held
dictation goes in (inserted by itself or by Paste dictation), it replaces those words if the
text before the cursor still ends with them (LiveFieldTyping(resuming:in:)); otherwise it goes in
at the cursor as before. A new dictation clears the note.

Why: on the iPhone 17 Pro, pressing Home mid-dictation left the typed words in the field (an
app gone to the background takes no edits) and, back in the app (a new document identifier),
the strip offered Paste dictation, which would have put the dictation after them.

Verified: LiveDictationTests on the Studio simulator (9 tests).

* iOS README: what the keyboard shows while recording, measured on the iPhone 17 Pro

Adds the phone's numbers (first words about 1.2-1.3 s after speech starts; 60 s dictation 60.1 MB
with the preview against 58.1 MB without, peaks 66.5 against 60.1), the hidden-keyboard case for
Type as I speak, and what is verified where and what isn't (VoiceOver on a device, lagging hosts).
2026-11-22 13:37:37 -05:00

109 lines
4.7 KiB
Swift

import Combine
import Foundation
/// Type as I speak in the keyboard: follows the live words (`LiveDictationText`) into the
/// field through `LiveFieldTyping` while the switch was on as the dictation started (never
/// with Translate what I say on), hands the field back as it was just before the dictation's
/// own text goes in (`handOver`), and takes the words back when a dictation ends without
/// text (cancelled, failed, nothing heard) or the keyboard hides mid-dictation (its text is
/// then held for the next keyboard, as without the switch).
@MainActor
final class KeyboardLiveTyping {
private let target: KeyboardTextTarget
private var typing: LiveFieldTyping?
/// The dictation being followed (`LiveDictationText.dictation`), typed into or declined.
private var dictation = 0
private var subscription: AnyCancellable?
/// False while the full keyboard waits to put a two-thumb Dictate's words over its range.
var mayType: () -> Bool = { true }
/// The field changed under the keys: they read it afresh.
var didEdit: () -> Void = {}
init(target: KeyboardTextTarget) {
self.target = target
}
func attach(_ text: LiveDictationText) {
subscription = text.$transcript.sink { [weak self, weak text] transcript in
guard let self, let text else { return }
self.follow(transcript, in: text)
}
}
private func follow(_ transcript: LiveTranscript?, in text: LiveDictationText) {
guard let transcript else {
// Over without its text going in: the field goes back as it was.
cancel()
return
}
if typing == nil {
guard text.typesIntoField, dictation != text.dictation, !transcript.isEmpty else { return }
dictation = text.dictation
guard mayType() else { return }
guard let started = LiveFieldTyping(target: target) else {
KeyboardProbeLog.shared.write("live: not typing in this field")
return
}
typing = started
}
guard let typing, !typing.stopped else { return }
typing.show(transcript.text)
if typing.stopped {
KeyboardProbeLog.shared.write("live: the field changed, stopped typing")
}
didEdit()
}
/// The dictation's own text is about to go in: the live words come out first, and the field
/// as it was before them is returned for its spacing. Nil when nothing was typed, or the
/// field changed (the words stay and the text goes in at the cursor).
func handOver() -> DictationEditTracker.Context? {
guard let typing = typing ?? resumeLeftover() else { return nil }
self.typing = nil
let typed = !typing.typed.isEmpty
guard typing.takeBack(), typed else {
if typed { KeyboardProbeLog.shared.write("live: field changed, the dictation goes in at the cursor") }
return nil
}
didEdit()
let after = target.documentContextAfterInput
return DictationEditTracker.Context(
before: typing.base,
after: after,
hasText: !(typing.base ?? "").isEmpty || !(after ?? "").isEmpty
)
}
/// The words an earlier keyboard left when it hid (`LiveDictationSettings.leftover`), for
/// the held text that replaces them, within the time it is offered.
private func resumeLeftover() -> LiveFieldTyping? {
let settings = LiveDictationSettings()
guard let left = settings.leftover else { return nil }
settings.leftover = nil
guard Date().timeIntervalSince1970 - left.at < KeyboardSnapshot.resultOfferWindow else { return nil }
let resumed = LiveFieldTyping(resuming: left.text, in: target)
KeyboardProbeLog.shared.write("live: words left by a hidden keyboard \(resumed == nil ? "no longer in the field" : "replaced")")
return resumed
}
/// The keyboard hides mid-dictation: the words come out where the app still takes edits, and
/// are noted for the held text to replace where it doesn't (one gone to the background).
func keyboardWillHide() {
if let typing, !typing.stopped, !typing.typed.isEmpty {
LiveDictationSettings().leftover = (typing.typed, Date().timeIntervalSince1970)
}
cancel()
}
/// Cancelled, failed, nothing heard, or the keyboard hiding: the live words come out.
func cancel() {
guard let typing else { return }
self.typing = nil
let typed = !typing.typed.isEmpty
if typing.takeBack() {
if typed { didEdit() }
} else {
KeyboardProbeLog.shared.write("live: field changed, typed words left as they are")
}
}
}