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
use clap::{Parser, Subcommand};
use phostt::server::{OriginPolicy, RuntimeLimits, ServerConfig};
use phostt::{inference, inspect, model, server};
use std::net::IpAddr;
use tracing_subscriber::EnvFilter;
#[derive(Parser)]
#[command(
name = "phostt",
version,
about = "Local Vietnamese STT server powered by Zipformer-vi RNN-T"
)]
struct Cli {
/// Log level [default: info]
#[arg(long, global = true, default_value = "info")]
log_level: String,
#[command(subcommand)]
command: Commands,
}
#[derive(Subcommand)]
enum Commands {
/// Start WebSocket STT server (auto-downloads model if missing)
Serve {
/// Port to listen on
#[arg(short, long, default_value_t = 9876)]
port: u16,
/// Bind address. Loopback by default; non-loopback requires `--bind-all`.
#[arg(long, default_value = "127.0.0.1")]
host: String,
/// Model directory
#[arg(long, default_value_t = model::default_model_dir())]
model_dir: String,
/// Number of concurrent inference sessions
#[arg(long, default_value_t = 4)]
pool_size: usize,
/// Explicitly acknowledge binding to a non-loopback address.
/// Can also be enabled via `PHOSTT_ALLOW_BIND_ANY=1`.
/// Without this flag the server refuses to listen on anything other than
/// 127.0.0.1 / ::1 / localhost to prevent accidental public exposure.
#[arg(long, default_value_t = false)]
bind_all: bool,
/// Additional Origin allowed to call the REST / WebSocket API (repeatable).
/// Loopback origins (localhost, 127.0.0.1, ::1) are always allowed.
/// Match is exact and case-insensitive, e.g. `https://app.example.com`.
#[arg(long = "allow-origin", value_name = "URL")]
allow_origin: Vec<String>,
/// Echo `Access-Control-Allow-Origin: *` and accept any cross-origin
/// caller. Disabled by default — every non-loopback Origin must be
/// listed explicitly via `--allow-origin` unless this flag is set.
#[arg(long, default_value_t = false)]
cors_allow_any: bool,
/// WebSocket idle timeout (seconds). Server closes the connection
/// when no frame arrives within this window.
#[arg(long, env = "PHOSTT_IDLE_TIMEOUT_SECS", default_value_t = 300)]
idle_timeout_secs: u64,
/// Maximum WebSocket frame / message size (bytes).
#[arg(long, env = "PHOSTT_WS_FRAME_MAX_BYTES", default_value_t = 512 * 1024)]
ws_frame_max_bytes: usize,
/// Maximum REST request body size (bytes).
#[arg(long, env = "PHOSTT_BODY_LIMIT_BYTES", default_value_t = 50 * 1024 * 1024)]
body_limit_bytes: usize,
/// Per-IP rate limit — requests per minute. 0 = off (default).
#[arg(long, env = "PHOSTT_RATE_LIMIT_PER_MINUTE", default_value_t = 0)]
rate_limit_per_minute: u32,
/// Rate-limit burst size (default 10).
#[arg(long, env = "PHOSTT_RATE_LIMIT_BURST", default_value_t = 10)]
rate_limit_burst: u32,
/// Expose Prometheus metrics at `GET /metrics`. Off by default —
/// keeps the server quiet for single-user installs. The endpoint is
/// attached to the protected router so the Origin allowlist applies.
#[arg(long, env = "PHOSTT_METRICS", default_value_t = false)]
metrics: bool,
/// Maximum wall-clock duration of a single WebSocket session (seconds).
/// `0` disables the cap (not recommended — a silence-streaming client
/// will hold a triplet forever).
#[arg(long, env = "PHOSTT_MAX_SESSION_SECS", default_value_t = 3600)]
max_session_secs: u64,
/// Grace window (seconds) after shutdown during which in-flight
/// WebSocket / SSE sessions may emit their Final frames and close.
/// Values of `0` are clamped to `1`. Should comfortably fit inside
/// your orchestrator's `terminationGracePeriodSeconds`.
#[arg(long, env = "PHOSTT_SHUTDOWN_DRAIN_SECS", default_value_t = 10)]
shutdown_drain_secs: u64,
/// Streaming window size in milliseconds (default 4000 = 4 s).
/// Must be a multiple of 40 ms because the encoder subsamples by 4.
#[arg(long, env = "PHOSTT_STREAMING_WINDOW_MS", default_value_t = 4000)]
streaming_window_ms: u32,
/// Streaming overlap in milliseconds (default 1000 = 1 s).
/// Must be smaller than window and a multiple of 40 ms.
#[arg(long, env = "PHOSTT_STREAMING_OVERLAP_MS", default_value_t = 1000)]
streaming_overlap_ms: u32,
/// Fuzzy match threshold for overlap word deduplication [0.0–1.0].
/// 1.0 = exact match (default). Lower values allow small spelling
/// variations on window boundaries to be treated as the same word.
#[arg(long, env = "PHOSTT_STREAMING_FUZZY_THRESHOLD", default_value_t = 1.0)]
streaming_fuzzy_threshold: f32,
/// Enable Silero VAD for simulated streaming. Speech is segmented by
/// voice activity instead of the fixed overlap-buffer; each detected
/// utterance is transcribed offline. Eliminates boundary artefacts at
/// the cost of no partial (interim) results.
#[arg(long, default_value_t = false)]
vad: bool,
},
/// Download model bundle without starting the server
Download {
/// Model directory
#[arg(long, default_value_t = model::default_model_dir())]
model_dir: String,
/// Also download speaker diarization model
#[cfg(feature = "diarization")]
#[arg(long, default_value_t = false)]
diarization: bool,
},
/// Transcribe an audio file (offline)
Transcribe {
/// Path to WAV file (PCM16 mono)
file: String,
/// Model directory
#[arg(long, default_value_t = model::default_model_dir())]
model_dir: String,
},
/// Print encoder/decoder/joiner ONNX I/O metadata for debugging
Inspect {
/// Model directory
#[arg(long, default_value_t = model::default_model_dir())]
model_dir: String,
},
}
fn log_rss() {
#[cfg(target_os = "linux")]
{
if let Ok(status) = std::fs::read_to_string("/proc/self/status")
&& let Some(line) = status.lines().find(|l| l.starts_with("VmRSS:"))
{
tracing::info!("{}", line.trim());
}
}
// On macOS/other platforms, use `ps` as a simple cross-platform fallback
#[cfg(not(target_os = "linux"))]
{
if let Ok(output) = std::process::Command::new("ps")
.args(["-o", "rss=", "-p", &std::process::id().to_string()])
.output()
&& let Ok(rss) = String::from_utf8_lossy(&output.stdout)
.trim()
.parse::<u64>()
{
tracing::info!(rss_mb = rss / 1024, "memory_after_load");
}
}
}
/// Guard non-loopback binds. Privacy-first default: the server will only
/// listen on 127.0.0.1 / ::1 / localhost unless the operator opts in via
/// `--bind-all` or `PHOSTT_ALLOW_BIND_ANY=1`. Mirrors the intent of Docker's
/// `--host 0.0.0.0` — explicit consent to expose a local STT service.
fn ensure_bind_allowed(host: &str, bind_all_flag: bool) -> anyhow::Result<()> {
if is_loopback_host(host) {
return Ok(());
}
let env_opt_in = std::env::var("PHOSTT_ALLOW_BIND_ANY")
.map(|v| matches!(v.trim(), "1" | "true" | "TRUE" | "yes" | "YES"))
.unwrap_or(false);
if bind_all_flag || env_opt_in {
tracing::warn!(
host = %host,
"binding to non-loopback address — anyone on the network can reach this server"
);
return Ok(());
}
anyhow::bail!(
"refusing to bind to '{host}': non-loopback addresses require \
`--bind-all` (or env PHOSTT_ALLOW_BIND_ANY=1) to prevent accidental \
public exposure of local transcription"
)
}
fn is_loopback_host(host: &str) -> bool {
// Accept the common human forms first.
let lowered = host.trim().to_ascii_lowercase();
if lowered == "localhost" || lowered == "::1" {
return true;
}
// Strip optional brackets around IPv6 literals.
let stripped = lowered.trim_start_matches('[').trim_end_matches(']');
if let Ok(ip) = stripped.parse::<IpAddr>() {
return ip.is_loopback();
}
false
}
#[tokio::main]
async fn main() -> anyhow::Result<()> {
let cli = Cli::parse();
let directive = format!("phostt={}", cli.log_level);
tracing_subscriber::fmt()
.with_env_filter(EnvFilter::from_default_env().add_directive(directive.parse()?))
.init();
match cli.command {
Commands::Serve {
port,
host,
model_dir,
pool_size,
bind_all,
allow_origin,
cors_allow_any,
idle_timeout_secs,
ws_frame_max_bytes,
body_limit_bytes,
rate_limit_per_minute,
rate_limit_burst,
metrics,
max_session_secs,
shutdown_drain_secs,
streaming_window_ms,
streaming_overlap_ms,
streaming_fuzzy_threshold,
vad,
} => {
ensure_bind_allowed(&host, bind_all)?;
model::ensure_model(&model_dir).await?;
// 1 mel frame = 10 ms (hop_length 160 @ 16 kHz).
let window_frames = (streaming_window_ms / 10) as usize;
let overlap_frames = (streaming_overlap_ms / 10) as usize;
let streaming_config = inference::StreamingConfig {
window_frames,
overlap_frames,
fuzzy_match_threshold: streaming_fuzzy_threshold,
};
if let Err(e) = streaming_config.validate() {
anyhow::bail!("Invalid streaming config: {e}");
}
let engine = inference::Engine::load_with_pool_size_and_config_and_vad(
&model_dir,
pool_size,
streaming_config,
vad,
)?;
log_rss();
let config = ServerConfig {
port,
host,
origin_policy: OriginPolicy {
allow_any: cors_allow_any,
allowed_origins: allow_origin,
},
limits: RuntimeLimits {
idle_timeout_secs,
ws_frame_max_bytes,
body_limit_bytes,
rate_limit_per_minute,
rate_limit_burst,
max_session_secs,
shutdown_drain_secs,
},
metrics_enabled: metrics,
};
server::run_with_config(engine, config, None).await?;
}
Commands::Download {
model_dir,
#[cfg(feature = "diarization")]
diarization,
} => {
model::ensure_model(&model_dir).await?;
#[cfg(feature = "diarization")]
{
if diarization {
model::ensure_speaker_model(&model_dir).await?;
}
}
tracing::info!("Model ready at {model_dir}");
}
Commands::Transcribe { file, model_dir } => {
model::ensure_model(&model_dir).await?;
let engine = inference::Engine::load_with_pool_size(&model_dir, 1)?;
log_rss();
let mut guard = engine.pool.checkout().await?;
let result = engine.transcribe_file(&file, &mut guard);
drop(guard);
println!("{}", result?.text);
}
Commands::Inspect { model_dir } => {
model::ensure_model(&model_dir).await?;
inspect::inspect_models(std::path::Path::new(&model_dir))?;
}
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_is_loopback_host_recognises_common_forms() {
assert!(is_loopback_host("127.0.0.1"));
assert!(is_loopback_host("localhost"));
assert!(is_loopback_host("::1"));
assert!(is_loopback_host("[::1]"));
assert!(is_loopback_host("127.0.0.2")); // loopback /8
assert!(!is_loopback_host("0.0.0.0"));
assert!(!is_loopback_host("192.168.1.10"));
assert!(!is_loopback_host("example.com"));
}
#[test]
fn test_ensure_bind_allowed_loopback_ok() {
ensure_bind_allowed("127.0.0.1", false).expect("loopback must be allowed");
ensure_bind_allowed("localhost", false).expect("localhost must be allowed");
}
#[test]
fn test_ensure_bind_allowed_non_loopback_requires_flag() {
// Temporarily strip any env opt-in that might exist on the runner.
// SAFETY: single-threaded test harness inside this fn body; env mutation is fine.
let previous = std::env::var("PHOSTT_ALLOW_BIND_ANY").ok();
// SAFETY: tests are run sequentially within this module — transient env mutation.
unsafe {
std::env::remove_var("PHOSTT_ALLOW_BIND_ANY");
}
let result = ensure_bind_allowed("0.0.0.0", false);
if let Some(v) = previous {
unsafe {
std::env::set_var("PHOSTT_ALLOW_BIND_ANY", v);
}
}
assert!(
result.is_err(),
"0.0.0.0 without --bind-all must be rejected"
);
}
#[test]
fn test_ensure_bind_allowed_explicit_flag_ok() {
ensure_bind_allowed("0.0.0.0", true).expect("explicit --bind-all must pass");
}
}