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
use std::time::Duration;
use futures_util::{SinkExt, StreamExt};
use serde::Deserialize;
use tokio::sync::{broadcast, mpsc, oneshot};
use tokio_tungstenite::{
connect_async,
tungstenite::{client::IntoClientRequest, handshake::client::Request, Message},
};
use super::{EngineConfig, EngineEvent, EngineHandle, Segment, TranscriptionEngine};
/// Voice Bird Web cloud engine. Opens a WebSocket to the user-configured
/// `/api/audio/stream` endpoint of a voice_bird_web deployment, performs
/// the JSON `init` handshake, forwards 16-kHz mono PCM as binary frames
/// (PCM16LE), and maps transcript JSON messages onto `EngineEvent`s. The
/// voice_bird_web server in turn fans audio out to its configured
/// upstream transcription provider and pushes results back over the same
/// WebSocket — see voice_bird_web/server.ts and streamSessionRegistry.ts.
pub struct VoiceBirdEngine {
api_key: String,
server_url: String,
}
impl VoiceBirdEngine {
pub fn new(api_key: String, server_url: String) -> Self {
Self {
api_key,
server_url,
}
}
}
#[derive(Debug, Deserialize)]
#[serde(tag = "type", rename_all = "snake_case")]
enum ServerMessage {
Connected {
#[allow(dead_code)]
#[serde(default)]
message: Option<String>,
},
InitSuccess {
#[allow(dead_code)]
session_id: String,
#[allow(dead_code)]
#[serde(default)]
message: Option<String>,
#[serde(default)]
transcription_available: Option<bool>,
#[serde(default)]
transcription_error: Option<String>,
},
Transcript {
#[serde(default)]
text: String,
#[serde(default)]
is_final: bool,
#[serde(default)]
audio_start_ms: Option<u64>,
#[serde(default)]
audio_end_ms: Option<u64>,
},
TerminateSuccess {},
Error {
#[serde(default)]
message: Option<String>,
#[serde(default)]
code: Option<String>,
},
#[serde(other)]
Unknown,
}
fn ws_url_override() -> Option<String> {
std::env::var("VOICEBIRD_WS_URL_OVERRIDE").ok()
}
impl TranscriptionEngine for VoiceBirdEngine {
fn start(&mut self, cfg: EngineConfig) -> anyhow::Result<EngineHandle> {
let (api_key_cfg, language, sample_rate, server_url_cfg, device_name, app_name) = match cfg
{
EngineConfig::Cloud {
api_key,
language,
sample_rate,
server_url,
device_name,
app_name,
} => (
api_key,
language,
sample_rate,
server_url,
device_name,
app_name,
),
EngineConfig::Local { .. } => {
anyhow::bail!("VoiceBirdEngine requires EngineConfig::Cloud");
}
};
// Engine-level api_key/url passed at construction win over the
// per-call config only if the latter is empty (preserves the same
// pattern AssemblyAiEngine used for keys).
let api_key = if api_key_cfg.is_empty() {
self.api_key.clone()
} else {
api_key_cfg
};
let server_url = ws_url_override()
.or_else(|| (!server_url_cfg.is_empty()).then(|| server_url_cfg.clone()))
.unwrap_or_else(|| self.server_url.clone());
if api_key.is_empty() {
anyhow::bail!("VoiceBirdEngine: api_key is empty");
}
if server_url.is_empty() {
anyhow::bail!("VoiceBirdEngine: server_url is empty");
}
if sample_rate != 16_000 {
anyhow::bail!("VoiceBirdEngine requires 16 kHz PCM; got {sample_rate}");
}
let (pcm_tx, mut pcm_rx) = mpsc::channel::<Vec<f32>>(32);
let (events_tx, events_rx) = broadcast::channel::<EngineEvent>(256);
// The trait exposes a shutdown sender, but callers may drop it
// immediately. Treating a dropped sender as shutdown closes the
// WebSocket before the first PCM frame, so this engine shuts down when
// the PCM channel closes.
let (shutdown_tx, _shutdown_rx) = oneshot::channel::<()>();
let session_id = uuid::Uuid::new_v4().to_string();
let lang_for_init = language.clone().unwrap_or_else(|| "en".into());
tokio::spawn(async move {
let req: Request = match server_url.clone().into_client_request() {
Ok(r) => r,
Err(e) => {
let _ = events_tx.send(EngineEvent::Error(format!("bad url: {e}")));
return;
}
};
let (mut ws, _resp) = match connect_async(req).await {
Ok(pair) => pair,
Err(e) => {
let _ = events_tx.send(EngineEvent::Error(format!("connect: {e}")));
return;
}
};
// Send the init message immediately. The server validates the
// API key, sets up an upstream transcription session, and
// replies with `init_success` (or an `error`).
let init = serde_json::json!({
"type": "init",
"api_key": api_key,
"session_id": session_id,
"device_name": device_name,
"device_type": "desktop",
"app_name": app_name,
"sample_rate": sample_rate,
"channels": 1,
"audio_format": "pcm16le",
"language": lang_for_init,
});
if let Err(e) = ws.send(Message::Text(init.to_string())).await {
let _ = events_tx.send(EngineEvent::Error(format!("ws send init: {e}")));
return;
}
// Wait for `init_success` before forwarding any PCM. The server's
// init handler is async (validates the API key, initializes the
// DB stream row and opens the upstream transcription socket) and
// `ws.sessionMetadata` is only populated after that finishes.
// Binary frames arriving during that window are rejected with
// `Session not initialized. Send init message first.` and the
// engine bails. Backpressure on `pcm_rx` (capacity 32) keeps the
// producer from running away while we wait.
let mut handshake_ok = false;
while !handshake_ok {
let Some(msg) = ws.next().await else {
return;
};
let msg = match msg {
Ok(m) => m,
Err(e) => {
let _ = events_tx.send(EngineEvent::Error(format!("ws recv: {e}")));
return;
}
};
match msg {
Message::Text(txt) => match serde_json::from_str::<ServerMessage>(&txt) {
Ok(ServerMessage::Connected { .. }) => {}
Ok(ServerMessage::InitSuccess {
transcription_available,
transcription_error,
..
}) => {
if transcription_available == Some(false) {
let m = transcription_error.unwrap_or_else(|| {
"transcription unavailable on server".into()
});
let _ = events_tx.send(EngineEvent::Error(m));
return;
}
let _ = events_tx.send(EngineEvent::ModelLoaded {
name: "voice-bird-web".into(),
});
handshake_ok = true;
}
Ok(ServerMessage::Error { message, code }) => {
let m = message
.unwrap_or_else(|| code.unwrap_or_else(|| "server error".into()));
let _ = events_tx.send(EngineEvent::Error(m));
return;
}
Ok(_) => {
log::warn!(
"voicebird ws: unexpected message before init_success — raw: {txt}"
);
}
Err(e) => {
log::warn!(
"voicebird ws: parse error during handshake: {e} — raw: {txt}"
);
}
},
Message::Close(_) => return,
_ => {}
}
}
loop {
tokio::select! {
maybe_pcm = pcm_rx.recv() => {
let Some(chunk) = maybe_pcm else { break; };
// ~50 ms frames at 16 kHz mono = 800 samples = 1600 bytes.
const FRAME_SAMPLES: usize = 800;
for win in chunk.chunks(FRAME_SAMPLES) {
let mut bytes = Vec::with_capacity(win.len() * 2);
for &s in win {
let clamped = s.clamp(-1.0, 1.0);
let i = (clamped * i16::MAX as f32) as i16;
bytes.extend_from_slice(&i.to_le_bytes());
}
if let Err(e) = ws.send(Message::Binary(bytes)).await {
let _ = events_tx.send(EngineEvent::Error(
format!("ws send: {e}"),
));
break;
}
}
}
maybe_msg = ws.next() => {
let Some(msg) = maybe_msg else { break; };
let msg = match msg {
Ok(m) => m,
Err(e) => {
let _ = events_tx.send(EngineEvent::Error(
format!("ws recv: {e}"),
));
break;
}
};
match msg {
Message::Text(txt) => {
match serde_json::from_str::<ServerMessage>(&txt) {
Ok(ServerMessage::Connected { .. }) => {}
Ok(ServerMessage::InitSuccess {
transcription_available,
transcription_error,
..
}) => {
if transcription_available == Some(false) {
let msg = transcription_error.unwrap_or_else(|| {
"transcription unavailable on server".into()
});
let _ = events_tx.send(EngineEvent::Error(msg));
break;
}
let _ = events_tx.send(EngineEvent::ModelLoaded {
name: "voice-bird-web".into(),
});
}
Ok(ServerMessage::Transcript {
text,
is_final,
audio_start_ms,
audio_end_ms,
}) => {
if is_final {
let seg = Segment {
t_start: Duration::from_millis(
audio_start_ms.unwrap_or(0),
),
t_end: Duration::from_millis(
audio_end_ms.unwrap_or(0),
),
text,
tokens: Vec::new(),
};
let _ = events_tx.send(EngineEvent::Committed(seg));
} else {
let _ = events_tx.send(EngineEvent::Tentative(text));
}
}
Ok(ServerMessage::TerminateSuccess {}) => break,
Ok(ServerMessage::Error { message, code }) => {
let m = message.unwrap_or_else(|| {
code.unwrap_or_else(|| "server error".into())
});
let _ = events_tx.send(EngineEvent::Error(m));
break;
}
Ok(ServerMessage::Unknown) => {
log::warn!(
"voicebird ws: unknown server message shape — raw: {txt}"
);
}
Err(e) => {
log::warn!(
"voicebird ws: parse error: {e} — raw: {txt}"
);
}
}
}
Message::Close(_) => break,
_ => {}
}
}
}
}
let terminate = serde_json::json!({
"type": "terminate",
"session_id": session_id,
});
let _ = ws.send(Message::Text(terminate.to_string())).await;
let _ = ws.close(None).await;
});
Ok(EngineHandle {
pcm_tx,
events_rx,
shutdown: shutdown_tx,
})
}
}