Skip to content

fix(engine): stabilize dictation capture and release paste #1

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

Open
future3OOO wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix(engine): stabilize dictation capture and release paste #1

Show file tree
Hide file tree
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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ Latency ≈ 200-500 ms on an RTX 3080. Designed for 20-30 s dictation bursts.

#### 💨 Option B — Maximum speed (medium.en + prompt tricks)

medium.en delivers ≈ 5-20 ms interface latency while staying surprisingly
accurate when paired with a good prompt and a larger beam.
medium.en delivers ≈ 5-200 ms interface latency while staying surprisingly
accurate when paired with a preset and a larger beam.

## 📧 Fast e-mail workflow — preset **email**

Expand Down
94 changes: 60 additions & 34 deletions dictation_tool/engine.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
• Extended punctuation map (“at sign” → @)
• JSONL profiler, adaptive batching, back-pressure, dynamic ring growth
"""

from __future__ import annotations

import asyncio
Expand Down Expand Up @@ -44,8 +45,8 @@
if sys.platform == "win32":
try:
import win32clipboard as _wc # type: ignore
import win32con as _wcon # type: ignore
except ImportError: # pywin32 not installed
import win32con as _wcon # type: ignore
except ImportError: # pywin32 not installed
_wc = _wcon = None
else:
_wc = _wcon = None
Expand Down Expand Up @@ -82,6 +83,7 @@ def _paste_retry() -> None:
time.sleep(0.02)
LOGGER.warning("Auto-paste ultimately failed")


# ══════════════════════════════════ Audio ring buffer ═════════════════════════
class _Ring:
"""Lock-free power-of-two ring for int16 audio."""
Expand All @@ -103,7 +105,7 @@ def push(self, chunk: np.ndarray) -> None:
if not n:
return
cap = self._view.shape[0]
if n >= cap: # keep only the last <cap> samples
if n >= cap: # keep only the last <cap> samples
self._view[:] = chunk[-cap:]
self._head = self._tail = 0
self._full = True
Expand Down Expand Up @@ -134,7 +136,12 @@ def pop(self) -> np.ndarray:

@property
def size(self) -> int:
return self._view.shape[0] if self._full else (self._head - self._tail) & self._mask
return (
self._view.shape[0]
if self._full
else (self._head - self._tail) & self._mask
)


# ══════════════════════════════════ Punctuation map ═══════════════════════════
class _Punct:
Expand Down Expand Up @@ -180,6 +187,7 @@ def __call__(self, text: str) -> str:
out = self._spc_after.sub(r"\1", out)
return out.strip()


# ═════════════════════════ Thread-safe context ════════════════════════════════
class _Context:
"""Rolling prompt history (mutex-guarded)."""
Expand All @@ -198,6 +206,7 @@ def prompt(self) -> str:
with self._lock:
return " ".join(self._buf) + ". " if self._buf else ""


# ═══════════════════ Adaptive batch controller ════════════════════════════════
class _BatchCtl:
def __init__(self, cfg: Config) -> None:
Expand All @@ -215,10 +224,14 @@ def feed(self, samples: int) -> None:
avg = self._seen // self._chunks
self.min_samples = max(8_000, min(int(avg * 0.8) // 16 * 16, 24_000))
self.max_chunks = max(4, min(ceil(self.min_samples / avg), 10))
LOGGER.info("Adaptive batch tuned → %d samples | %d chunks",
self.min_samples, self.max_chunks)
LOGGER.info(
"Adaptive batch tuned → %d samples | %d chunks",
self.min_samples,
self.max_chunks,
)
self._lock = True


# ═════════════════════ Clipboard wrapper class ════════════════════════════════
class _Clipboard:
"""Thread-pool clipboard copy; never blocks event loop."""
Expand All @@ -245,19 +258,26 @@ async def copy(self, text: str) -> None:
await loop.run_in_executor(self._pool, pyperclip.copy, text)
self._last = (text, time.time())


# ───────────────────────── command cleanup ──────────────────────────
_CMD_SUBS: tuple[tuple[re.Pattern, str], ...] = (
# single line break – eat optional punctuation / spaces after the cue
(re.compile(r"\b(?:new\s+line|line\s*break|newline)\b[ \t]*[.,!?;:]?[ \t]*",
re.I), "\n"),
(
re.compile(
r"\b(?:new\s+line|line\s*break|newline)\b[ \t]*[.,!?;:]?[ \t]*", re.I
),
"\n",
),
# blank line (paragraph) – same idea, but keep the double LF
(re.compile(r"\bnew\s+paragraph\b[ \t]*[.,!?;:]?[ \t]*", re.I), "\n\n"),
(re.compile(r"\bbullet\s+point\b", re.I), "\n• "),
# strip runs of smart quotes, plain quote, back-tick, or � (U+FFFD)
(re.compile(r'[\u201C\u201D"`\uFFFD]+'), ""),
)

_SPACES_AROUND_DOT_AT = re.compile(r"[ \t\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]*([@.])[ \t\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]*")
_SPACES_AROUND_DOT_AT = re.compile(
r"[ \t\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]*([@.])[ \t\u00A0\u1680\u2000-\u200A\u202F\u205F\u3000]*"
)

_SIGNOFFS = ("kind regards", "best regards", "regards", "cheers")
SIGNOFF_PAT = re.compile(
Expand All @@ -267,15 +287,17 @@ async def copy(self, text: str) -> None:

# Greeting lines that should end with a comma before a blank line
_GREETING_BREAK = re.compile(
r'(?i)(^|\n)(\s*(?:hi|hello|hey|kia(?:\s+ora)?|dear)\b[^\n]*?)\s*\n\n'
r"(?i)(^|\n)(\s*(?:hi|hello|hey|kia(?:\s+ora)?|dear)\b[^\n]*?)\s*\n\n"
)


# ══════════════════════════ Dictation Engine ══════════════════════════════════
class DictationEngine:
"""Microphone → (VAD) → Whisper → clipboard."""

_EMAIL_RE = re.compile(r"\b([\w.-]+)\s+at(?:\s+sign)?\s+([\w.-]+)\s+dot\s+com\b",
re.I)
_EMAIL_RE = re.compile(
r"\b([\w.-]+)\s+at(?:\s+sign)?\s+([\w.-]+)\s+dot\s+com\b", re.I
)
_URL_DOT = re.compile(r"\b([a-zA-Z0-9_-]+)\s+\.\s+([a-zA-Z0-9_-]+)")

# ───────────────────────── init ──────────────────────────
Expand Down Expand Up @@ -422,43 +444,43 @@ async def _transcribe(self, audio: np.ndarray) -> str:
txt = self._EMAIL_RE.sub(r"\1@\2.com", self._URL_DOT.sub(r"\1.\2", txt))
for pat, rep in _CMD_SUBS:
txt = pat.sub(rep, txt)

# ── NEW: collapse duplicate commas (word "comma" + real comma) ─────────
txt = re.sub(r',\s*,+', ',', txt)
txt = re.sub(r",\s*,+", ",", txt)

# ── NEW: if a comma sneaks in *before* the paragraph break, make it a '.' ─
txt = re.sub(r',\s*\n\n', '.\n\n', txt)
txt = re.sub(r",\s*\n\n", ".\n\n", txt)

# ── turn greeting + blank line into "Greeting,<LF><LF>"
txt = _GREETING_BREAK.sub(
lambda m: f"{m.group(1)}{m.group(2).rstrip(' ,.!?;:')},\n\n",
txt,
)

# ── NEW: add full stop before paragraph break when *no* punctuation spoken ─
txt = re.sub(r'([^\s.,!?;:])\s*\n\n', r'\1.\n\n', txt)
txt = re.sub(r"([^\s.,!?;:])\s*\n\n", r"\1.\n\n", txt)

# final space trim around @ and .
txt = _SPACES_AROUND_DOT_AT.sub(r'\1', txt)
txt = _SPACES_AROUND_DOT_AT.sub(r"\1", txt)

# safety-pass: remove spaces or tabs (NOT new-lines) that may survive
txt = re.sub(r'@[ \t]+', '@', txt) # john @ gmail → john@gmail
txt = re.sub(r'\.[ \t]+', '.', txt) # gmail . com → gmail.com
txt = re.sub(r"@[ \t]+", "@", txt) # john @ gmail → john@gmail
txt = re.sub(r"\.[ \t]+", ".", txt) # gmail . com → gmail.com

# -------------------------------------------------------------------------
# 8. sentence-/signature-polish (run *after* all previous tweaks)
# -------------------------------------------------------------------------

# 8-a normalise common e-mail sign-offs
txt = SIGNOFF_PAT.sub(lambda m: f"{m.group(1)}{m.group(2).title()},\n", txt)

# 8-b capitalise first alphabetical char of every logical line
txt = re.sub(
r"(^|\n)([• \t]*)([a-z])",
lambda m: m.group(1) + m.group(2) + m.group(3).upper(),
txt,
)

return txt

# ──────────────────── shadow helper ──────────────────────
Expand All @@ -468,9 +490,8 @@ def _add_to_shadow(self, chunk: np.ndarray) -> None:
# ──────────────────── trigger install ─────────────────────
def _install_triggers(self) -> None:
def ok() -> bool:
return (
not self.cfg.dual_trigger_required
or (self._mouse_pressed and is_pressed(self.cfg.hotkey))
return not self.cfg.dual_trigger_required or (
self._mouse_pressed and is_pressed(self.cfg.hotkey)
)

def toggle(src: str) -> None:
Expand Down Expand Up @@ -498,7 +519,7 @@ def click(_x: int, _y: int, button: mouse.Button, down: bool) -> None:
if down:
self._mouse_pressed = True
if self.cfg.mouse_hold_to_record:
self._raw_shadow.clear() # start fresh
self._raw_shadow.clear() # start fresh
self._mouse_press = time.time()
self._holding = False
self._hold_timer = threading.Timer(
Expand Down Expand Up @@ -547,7 +568,9 @@ async def _flush_hold(self) -> str:
if self._raw_shadow:
segs.append(concatenate(self._raw_shadow))
self._raw_shadow.clear()
if self._vad_gate:
if self._vad_gate:
self._vad_gate.force_flush()
elif self._vad_gate:
tail = self._vad_gate.force_flush()
if tail is not None and tail.size:
segs.append(tail)
Expand Down Expand Up @@ -590,10 +613,13 @@ async def _run(self) -> None:
continue

if self._clip_q.qsize() > 8:
await asyncio.sleep(0.02) # back-pressure clipboard
await asyncio.sleep(0.02) # back-pressure clipboard

if self.cfg.use_vad:
if chunk.size:
if self.cfg.mouse_hold_to_record and self._holding:
continue

batch.append(chunk)
samples += chunk.size
self._batch_ctl.feed(chunk.size)
Expand Down
Loading