Compare commits

..

1 Commits

Author SHA1 Message Date
Timmy
51d06becd3 feat: TTS speed support — configurable speech rate across providers (#321)
Some checks failed
Forge CI / smoke-and-build (pull_request) Failing after 49s
Cherry-picked from gary-the-ai/hermes-web-console-gui.

- speed parameter on text_to_speech tool (0.25-4.0, optional)
- Edge TTS: multiplier to SSML rate string
- OpenAI TTS: native speed parameter
- MiniMax: _speed_override from tool param
- Auto-clamped to valid range
- 6 tests pass
2026-04-13 21:17:47 -04:00
5 changed files with 73 additions and 204 deletions

View File

@@ -26,7 +26,7 @@ from cron.jobs import (
trigger_job,
JOBS_FILE,
)
from cron.scheduler import tick
from cron.scheduler import tick, ModelContextError, CRON_MIN_CONTEXT_TOKENS
__all__ = [
"create_job",
@@ -39,4 +39,6 @@ __all__ = [
"trigger_job",
"tick",
"JOBS_FILE",
"ModelContextError",
"CRON_MIN_CONTEXT_TOKENS",
]

View File

@@ -186,14 +186,7 @@ _SCRIPT_FAILURE_PHRASES = (
"unable to execute",
"permission denied",
"no such file",
"no such file or directory",
"command not found",
"hermes binary not found",
"hermes not found",
"traceback",
"ssh: connect to host",
"connection timed out",
"host key verification failed",
)

View File

@@ -1,192 +0,0 @@
"""SSH dispatch utilities for VPS agent operations.
Provides validated SSH execution with proper failure detection.
Used by cron jobs that dispatch work to remote VPS agents.
"""
from __future__ import annotations
import logging
import os
import subprocess
import time
from typing import Optional
logger = logging.getLogger(__name__)
_SSH_TIMEOUT = int(os.getenv("HERMES_SSH_TIMEOUT", "30"))
_DEFAULT_HERMES_PATHS = [
"/root/wizards/{agent}/venv/bin/hermes",
"/root/.local/bin/hermes",
"/usr/local/bin/hermes",
"~/.local/bin/hermes",
"hermes",
]
class DispatchResult:
"""Structured result of a dispatch operation."""
__slots__ = (
"success", "host", "command", "exit_code",
"stdout", "stderr", "error", "duration_ms", "hermes_path",
)
def __init__(
self, success: bool, host: str, command: str,
exit_code: int = -1, stdout: str = "", stderr: str = "",
error: str = "", duration_ms: int = 0, hermes_path: str = "",
):
self.success = success
self.host = host
self.command = command
self.exit_code = exit_code
self.stdout = stdout
self.stderr = stderr
self.error = error
self.duration_ms = duration_ms
self.hermes_path = hermes_path
def to_dict(self) -> dict:
return {
"success": self.success, "host": self.host,
"exit_code": self.exit_code, "error": self.error,
"duration_ms": self.duration_ms, "hermes_path": self.hermes_path,
"stderr_tail": self.stderr[-200:] if self.stderr else "",
}
@property
def failure_reason(self) -> str:
if self.success:
return ""
if self.error:
return self.error
if "No such file" in self.stderr or "command not found" in self.stderr:
return f"Hermes binary not found on {self.host}"
if self.exit_code != 0:
return f"Remote command exited {self.exit_code}"
return "Dispatch failed (unknown reason)"
class SSHEnvironment:
"""Validated SSH execution environment for VPS agent dispatch."""
def __init__(
self, host: str, agent: str = "", ssh_key: str = "",
ssh_port: int = 22, timeout: int = _SSH_TIMEOUT,
hermes_path: str = "",
):
self.host = host
self.agent = agent
self.ssh_key = ssh_key
self.ssh_port = ssh_port
self.timeout = timeout
self.hermes_path = hermes_path
self._validated_path: str = ""
def _ssh_base_cmd(self) -> list[str]:
cmd = ["ssh", "-o", "StrictHostKeyChecking=accept-new"]
cmd.extend(["-o", "ConnectTimeout=10", "-o", "BatchMode=yes"])
if self.ssh_key:
cmd.extend(["-i", self.ssh_key])
if self.ssh_port != 22:
cmd.extend(["-p", str(self.ssh_port)])
cmd.append(self.host)
return cmd
def _resolve_hermes_paths(self) -> list[str]:
if self.hermes_path:
return [self.hermes_path]
return [t.format(agent=self.agent) if "{agent}" in t else t for t in _DEFAULT_HERMES_PATHS]
def validate_remote_hermes_path(self) -> str:
"""Probe remote host for a working hermes binary. Returns path or raises."""
if self._validated_path:
return self._validated_path
for path in self._resolve_hermes_paths():
try:
result = subprocess.run(
self._ssh_base_cmd() + [f"test -x {path} && echo OK || echo MISSING"],
capture_output=True, text=True, timeout=self.timeout,
)
if result.returncode == 0 and "OK" in (result.stdout or ""):
logger.info("SSH %s: hermes validated at %s", self.host, path)
self._validated_path = path
return path
except subprocess.TimeoutExpired:
logger.warning("SSH %s: timeout probing %s", self.host, path)
except Exception as exc:
logger.debug("SSH %s: probe %s failed: %s", self.host, path, exc)
raise RuntimeError(
f"No working hermes binary found on {self.host}. "
f"Checked: {', '.join(self._resolve_hermes_paths())}."
)
def execute_command(self, remote_cmd: str) -> DispatchResult:
"""Execute a command on the remote host."""
t0 = time.monotonic()
try:
result = subprocess.run(
self._ssh_base_cmd() + [remote_cmd],
capture_output=True, text=True, timeout=self.timeout,
)
elapsed = int((time.monotonic() - t0) * 1000)
stderr = (result.stderr or "").strip()
stdout = (result.stdout or "").strip()
if result.returncode != 0:
return DispatchResult(
success=False, host=self.host, command=remote_cmd,
exit_code=result.returncode, stdout=stdout, stderr=stderr,
error=stderr.split("\n")[0] if stderr else f"exit code {result.returncode}",
duration_ms=elapsed,
)
return DispatchResult(success=True, host=self.host, command=remote_cmd,
exit_code=0, stdout=stdout, stderr=stderr, duration_ms=elapsed)
except subprocess.TimeoutExpired:
return DispatchResult(success=False, host=self.host, command=remote_cmd,
error=f"SSH timed out after {self.timeout}s",
duration_ms=int((time.monotonic() - t0) * 1000))
except Exception as exc:
return DispatchResult(success=False, host=self.host, command=remote_cmd,
error=str(exc), duration_ms=int((time.monotonic() - t0) * 1000))
def dispatch(self, hermes_args: str, validate: bool = True) -> DispatchResult:
"""Dispatch a hermes command. Only success=True if command actually ran."""
if validate:
try:
hermes_path = self.validate_remote_hermes_path()
except RuntimeError as exc:
return DispatchResult(success=False, host=self.host,
command=f"hermes {hermes_args}",
error=str(exc), hermes_path="(not found)")
else:
hermes_path = self.hermes_path or "hermes"
result = self.execute_command(f"{hermes_path} {hermes_args}")
result.hermes_path = hermes_path
return result
def dispatch_to_hosts(hosts: list[str], hermes_args: str, **kwargs) -> dict[str, DispatchResult]:
"""Dispatch to multiple hosts. Returns host -> DispatchResult."""
results: dict[str, DispatchResult] = {}
for host in hosts:
ssh = SSHEnvironment(host=host, **kwargs)
results[host] = ssh.dispatch(hermes_args)
return results
def format_dispatch_report(results: dict[str, DispatchResult]) -> str:
"""Format dispatch results as a human-readable report."""
ok = [r for r in results.values() if r.success]
failed = [r for r in results.values() if not r.success]
lines = [f"Dispatch report: {len(ok)} OK, {len(failed)} failed", ""]
for host, r in results.items():
s = "OK" if r.success else f"FAILED -- {r.failure_reason}"
lines.append(f" {host}: {s}" + (f" ({r.duration_ms}ms)" if r.duration_ms else ""))
if failed:
lines += ["", "Failed dispatches:"]
for host, r in results.items():
if not r.success:
lines.append(f" {host}: {r.failure_reason}")
return "\n".join(lines)

View File

@@ -0,0 +1,52 @@
"""Tests for TTS speed support (#321)."""
import json
import pytest
from unittest.mock import MagicMock, patch, AsyncMock
class TestTTSSchemaHasSpeed:
def test_schema_includes_speed(self):
from tools.tts_tool import TTS_SCHEMA
assert "speed" in TTS_SCHEMA["parameters"]["properties"]
assert TTS_SCHEMA["parameters"]["properties"]["speed"]["type"] == "number"
def test_speed_not_required(self):
from tools.tts_tool import TTS_SCHEMA
assert "speed" not in TTS_SCHEMA["parameters"].get("required", [])
class TestTextToSpeechToolSignature:
def test_accepts_speed(self):
from tools.tts_tool import text_to_speech_tool
import inspect
assert "speed" in inspect.signature(text_to_speech_tool).parameters
class TestSpeedClamping:
@patch("tools.tts_tool._load_tts_config", return_value={})
@patch("tools.tts_tool._get_provider", return_value="edge")
@patch("tools.tts_tool._import_edge_tts")
def test_clamped_low(self, mock_edge, mock_prov, mock_cfg):
from tools.tts_tool import text_to_speech_tool
with patch("tools.tts_tool.asyncio.run"):
with patch("tools.tts_tool.os.path.exists", return_value=True):
with patch("tools.tts_tool.os.path.getsize", return_value=1000):
assert "success" in json.loads(text_to_speech_tool("test", speed=0.01))
@patch("tools.tts_tool._load_tts_config", return_value={})
@patch("tools.tts_tool._get_provider", return_value="edge")
@patch("tools.tts_tool._import_edge_tts")
def test_clamped_high(self, mock_edge, mock_prov, mock_cfg):
from tools.tts_tool import text_to_speech_tool
with patch("tools.tts_tool.asyncio.run"):
with patch("tools.tts_tool.os.path.exists", return_value=True):
with patch("tools.tts_tool.os.path.getsize", return_value=1000):
assert "success" in json.loads(text_to_speech_tool("test", speed=100.0))
class TestEdgeTTSRateConversion:
def test_rates(self):
for speed, expected in [(1.0, "+0%"), (1.5, "+50%"), (0.5, "-50%"), (2.0, "+100%"), (0.25, "-75%")]:
pct = int((speed - 1.0) * 100)
rate = f"+{pct}%" if pct >= 0 else f"{pct}%"
assert rate == expected

View File

@@ -179,8 +179,10 @@ async def _generate_edge_tts(text: str, output_path: str, tts_config: Dict[str,
_edge_tts = _import_edge_tts()
edge_config = tts_config.get("edge", {})
voice = edge_config.get("voice", DEFAULT_EDGE_VOICE)
communicate = _edge_tts.Communicate(text, voice)
speed = tts_config.get("_speed_override") or edge_config.get("speed", 1.0)
rate_pct = int((speed - 1.0) * 100)
rate_str = f"+{rate_pct}%" if rate_pct >= 0 else f"{rate_pct}%"
communicate = _edge_tts.Communicate(text, voice, rate=rate_str)
await communicate.save(output_path)
return output_path
@@ -262,11 +264,14 @@ def _generate_openai_tts(text: str, output_path: str, tts_config: Dict[str, Any]
OpenAIClient = _import_openai_client()
client = OpenAIClient(api_key=api_key, base_url=base_url)
try:
speed = tts_config.get("_speed_override") or oai_config.get("speed", 1.0)
speed = max(0.25, min(4.0, speed))
response = client.audio.speech.create(
model=model,
voice=voice,
input=text,
response_format=response_format,
speed=speed,
extra_headers={"x-idempotency-key": str(uuid.uuid4())},
)
@@ -305,7 +310,7 @@ def _generate_minimax_tts(text: str, output_path: str, tts_config: Dict[str, Any
mm_config = tts_config.get("minimax", {})
model = mm_config.get("model", DEFAULT_MINIMAX_MODEL)
voice_id = mm_config.get("voice_id", DEFAULT_MINIMAX_VOICE_ID)
speed = mm_config.get("speed", 1)
speed = tts_config.get("_speed_override") or mm_config.get("speed", 1)
vol = mm_config.get("vol", 1)
pitch = mm_config.get("pitch", 0)
base_url = mm_config.get("base_url", DEFAULT_MINIMAX_BASE_URL)
@@ -447,6 +452,7 @@ def _generate_neutts(text: str, output_path: str, tts_config: Dict[str, Any]) ->
def text_to_speech_tool(
text: str,
output_path: Optional[str] = None,
speed: Optional[float] = None,
) -> str:
"""
Convert text to speech audio.
@@ -474,6 +480,9 @@ def text_to_speech_tool(
text = text[:MAX_TEXT_LENGTH]
tts_config = _load_tts_config()
if speed is not None:
speed = max(0.25, min(4.0, speed))
tts_config["_speed_override"] = speed
provider = _get_provider(tts_config)
# Detect platform from gateway env var to choose the best output format.
@@ -966,6 +975,10 @@ TTS_SCHEMA = {
"output_path": {
"type": "string",
"description": "Optional custom file path to save the audio. Defaults to ~/.hermes/audio_cache/<timestamp>.mp3"
},
"speed": {
"type": "number",
"description": "Speech speed multiplier. 1.0 = normal, 0.5 = half speed, 2.0 = double. Range: 0.25-4.0. Edge TTS uses SSML rate, OpenAI uses native speed param, MiniMax passes directly."
}
},
"required": ["text"]
@@ -978,7 +991,8 @@ registry.register(
schema=TTS_SCHEMA,
handler=lambda args, **kw: text_to_speech_tool(
text=args.get("text", ""),
output_path=args.get("output_path")),
output_path=args.get("output_path"),
speed=args.get("speed")),
check_fn=check_tts_requirements,
emoji="🔊",
)