forked from BasedHardware/omi
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathtranscription_service.dart
More file actions
643 lines (574 loc) · 21 KB
/
Copy pathtranscription_service.dart
File metadata and controls
643 lines (574 loc) · 21 KB
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
import 'dart:async';
import 'dart:convert';
import 'dart:io';
import 'package:omi/backend/preferences.dart';
import 'package:omi/backend/schema/bt_device/bt_device.dart';
import 'package:omi/backend/schema/geolocation.dart';
import 'package:omi/backend/schema/message_event.dart';
import 'package:omi/backend/schema/transcript_segment.dart';
import 'package:omi/env/env.dart';
import 'package:omi/models/custom_stt_config.dart';
import 'package:omi/models/stt_provider.dart';
import 'package:omi/services/sockets/on_device_apple_provider.dart';
import 'package:omi/services/sockets/on_device_whisper_provider.dart';
import 'package:omi/services/sockets/pure_socket.dart';
import 'package:omi/services/sockets/transcription_service.dart';
import 'package:omi/utils/debug_log_manager.dart';
import 'package:omi/utils/hard_secret_detector.dart';
import 'package:omi/utils/logger.dart';
export 'package:omi/utils/audio/audio_transcoder.dart';
export 'package:omi/services/sockets/composite_transcription_socket.dart';
export 'package:omi/services/sockets/pure_polling.dart';
export 'package:omi/services/sockets/pure_streaming_stt.dart';
export 'package:omi/models/stt_response_schema.dart';
export 'package:omi/models/stt_result.dart';
export 'package:omi/services/sockets/transcription_polling_service.dart';
abstract interface class ITransctiptSegmentSocketServiceListener {
void onMessageEventReceived(MessageEvent event);
void onSegmentReceived(List<TranscriptSegment> segments);
void onError(Object err);
void onConnected();
void onClosed([int? closeCode]);
}
class SpeechProfileTranscriptSegmentSocketService extends TranscriptSegmentSocketService {
SpeechProfileTranscriptSegmentSocketService.create(
super.sampleRate,
super.codec,
super.language, {
super.source,
super.customSttMode,
super.onboardingMode,
super.geolocation,
super.clientConversationId,
super.speechProfileRedo,
}) : super.create(includeSpeechProfile: false);
}
class ConversationTranscriptSegmentSocketService extends TranscriptSegmentSocketService {
ConversationTranscriptSegmentSocketService.create(
super.sampleRate,
super.codec,
super.language, {
super.source,
super.customSttMode,
super.geolocation,
super.clientConversationId,
}) : super.create(includeSpeechProfile: true);
}
class CustomSttTranscriptSegmentSocketService extends TranscriptSegmentSocketService {
CustomSttTranscriptSegmentSocketService.create(
super.sampleRate,
super.codec,
super.language, {
super.source,
super.geolocation,
super.clientConversationId,
bool includeSpeechProfile = true,
}) : super.create(includeSpeechProfile: includeSpeechProfile, customSttMode: true);
}
enum SocketServiceState { connected, disconnected }
class TranscriptSegmentSocketService implements IPureSocketListener {
late IPureSocket _socket;
final Map<Object, ITransctiptSegmentSocketServiceListener> _listeners = {};
/// Access to the underlying socket (for composite service creation)
IPureSocket get socket => _socket;
SocketServiceState get state =>
_socket.status == PureSocketStatus.connected ? SocketServiceState.connected : SocketServiceState.disconnected;
int sampleRate;
BleAudioCodec codec;
String language;
bool includeSpeechProfile;
String? source;
bool customSttMode;
String? sttConfigId;
String? clientConversationId;
bool onboardingMode;
bool speechProfileRedo;
Geolocation? geolocation;
TranscriptSegmentSocketService.create(
this.sampleRate,
this.codec,
this.language, {
this.includeSpeechProfile = false,
this.source,
this.customSttMode = false,
this.sttConfigId,
this.onboardingMode = false,
this.speechProfileRedo = false,
this.geolocation,
this.clientConversationId,
}) {
var params = '?language=$language&sample_rate=$sampleRate&codec=$codec&uid=${SharedPreferencesUtil().uid}'
'&include_speech_profile=$includeSpeechProfile&stt_service=${SharedPreferencesUtil().transcriptionModel}'
'&conversation_timeout=${SharedPreferencesUtil().conversationSilenceDuration}';
if (source != null && source!.isNotEmpty) {
params += '&source=${Uri.encodeComponent(source!)}';
}
if (clientConversationId != null && clientConversationId!.isNotEmpty) {
params += '&client_conversation_id=${Uri.encodeComponent(clientConversationId!)}';
}
if (customSttMode) {
params += '&custom_stt=enabled';
}
if (onboardingMode) {
params += '&onboarding=enabled';
}
if (speechProfileRedo) {
params += '&speech_profile_redo=enabled';
}
// Enable server-side speaker auto-assignment (backward compatibility flag)
params += '&speaker_auto_assign=enabled';
// Whether the backend may auto-create a new person when it detects a name.
// Mirrors the user's "Auto-create Speakers" setting; a detected name with no
// existing match is still surfaced for manual tagging when this is off.
params += '&create_speakers=${SharedPreferencesUtil().autoCreateSpeakersEnabled}';
if (SharedPreferencesUtil().vadGateEnabled) {
params += '&vad_gate=enabled';
}
String url =
Env.apiBaseUrl!.replaceFirst('https://', 'wss://').replaceFirst('http://', 'ws://') + 'v4/listen$params';
_socket = PureSocket(
url,
extraHeaders: {if (geolocation != null) 'X-Omi-Conversation-Geolocation': jsonEncode(geolocation!.toJson())},
);
_socket.setListener(this);
}
TranscriptSegmentSocketService.withSocket(
this.sampleRate,
this.codec,
this.language,
IPureSocket socket, {
this.includeSpeechProfile = false,
this.source,
this.customSttMode = false,
this.sttConfigId,
this.onboardingMode = false,
this.speechProfileRedo = false,
this.geolocation,
this.clientConversationId,
}) {
_socket = socket;
_socket.setListener(this);
}
void subscribe(Object context, ITransctiptSegmentSocketServiceListener listener) {
_listeners.remove(context.hashCode);
_listeners.putIfAbsent(context.hashCode, () => listener);
}
void unsubscribe(Object context) {
_listeners.remove(context.hashCode);
}
Future start() async {
bool ok = await _socket.connect();
if (!ok) {
Logger.debug("Can not connect to websocket");
await DebugLogManager.logWarning('transcription_socket_connect_failed', {
'url': Env.apiBaseUrl?.replaceAll('https', 'wss') ?? 'null',
'sample_rate': sampleRate,
'codec': codec.toString(),
'language': language,
});
}
}
Future stop({String? reason}) async {
await _socket.stop();
_listeners.clear();
if (reason != null) {
Logger.debug(reason);
await DebugLogManager.logInfo('transcription_socket_stopped', {'reason': reason});
}
}
Future send(dynamic message) async {
_socket.send(message);
return;
}
Future sendText(String message) async {
_socket.send(message);
return;
}
Future requestFirstOnboardingQuestion() async {
await sendText(jsonEncode({'type': 'start_onboarding'}));
}
@override
void onClosed([int? closeCode]) {
_listeners.forEach((k, v) {
v.onClosed(closeCode);
});
DebugLogManager.logEvent('transcription_socket_closed', {'close_code': closeCode ?? -1});
}
@override
void onError(Object err, StackTrace trace) {
_listeners.forEach((k, v) {
v.onError(err);
});
DebugLogManager.logError(err, trace, 'transcription_socket_error');
}
@override
void onMessage(event) {
// Decode json
dynamic jsonEvent;
try {
jsonEvent = jsonDecode(event);
} on FormatException catch (e) {
Logger.debug(e.toString());
DebugLogManager.logWarning('transcription_socket_parse_error', {'error': e.toString()});
}
if (jsonEvent == null) {
Logger.debug("Can not decode message event json $event");
return;
}
// Transcript segments
if (jsonEvent is List) {
var segments = _dropSecretSegments(jsonEvent);
if (segments.isEmpty) {
return;
}
_listeners.forEach((k, v) {
v.onSegmentReceived(segments.map((e) => TranscriptSegment.fromJson(e)).toList());
});
return;
}
// Message event
if (jsonEvent.containsKey("type")) {
var event = MessageEvent.fromJson(jsonEvent);
_listeners.forEach((k, v) {
v.onMessageEventReceived(event);
});
return;
}
Logger.debug(event.toString());
DebugLogManager.logInfo('transcription_socket_unhandled_message: ${event.toString()}');
}
List<dynamic> _dropSecretSegments(List<dynamic> segments) {
final kept = <dynamic>[];
final categories = <String>{};
var droppedCount = 0;
for (final segment in segments) {
final text = segment is Map ? segment['text']?.toString() : null;
if (text != null && HardSecretDetector.contains(text)) {
categories.addAll(HardSecretDetector.categories(text));
droppedCount += 1;
continue;
}
kept.add(segment);
}
if (droppedCount > 0) {
final sortedCategories = categories.toList()..sort();
unawaited(
DebugLogManager.logEvent('hard_secret_artifact_dropped', {
'source': 'transcription_socket',
'artifact_type': 'transcript_segment',
'dropped_count': droppedCount,
'categories': sortedCategories,
}),
);
}
return kept;
}
@override
void onConnected() {
_listeners.forEach((k, v) {
v.onConnected();
});
DebugLogManager.logEvent('transcription_socket_connected', {
'sample_rate': sampleRate,
'codec': codec.toString(),
'language': language,
'include_speech_profile': includeSpeechProfile,
});
}
}
class TranscriptSocketServiceFactory {
TranscriptSocketServiceFactory._();
/// Codecs supported by custom STT providers
static const List<BleAudioCodec> _customSttSupportedCodecs = [
BleAudioCodec.pcm8,
BleAudioCodec.pcm16,
BleAudioCodec.opus,
BleAudioCodec.opusFS320,
];
/// Check if a codec is supported for custom STT
static bool isCodecSupportedForCustomStt(BleAudioCodec codec) {
return _customSttSupportedCodecs.contains(codec);
}
static bool shouldBlockUnsupportedCodecFallback(
BleAudioCodec codec,
CustomSttConfig? config, {
bool allowanceOnDevice = false,
}) {
if (isCodecSupportedForCustomStt(codec)) return false;
if (allowanceOnDevice) return true;
if (config == null || !config.isEnabled) return false;
return !config.sendRawAudioToOmi;
}
/// Create default Omi transcription service
static TranscriptSegmentSocketService createDefault(
int sampleRate,
BleAudioCodec codec,
String language, {
bool includeSpeechProfile = true,
String? source,
String? sttConfigId,
Geolocation? geolocation,
String? clientConversationId,
}) {
return TranscriptSegmentSocketService.create(
sampleRate,
codec,
language,
includeSpeechProfile: includeSpeechProfile,
source: source,
sttConfigId: sttConfigId ?? 'omi:default',
geolocation: geolocation,
clientConversationId: clientConversationId,
);
}
/// Create speech profile transcription service
static TranscriptSegmentSocketService createSpeechProfile(
int sampleRate,
BleAudioCodec codec,
String language, {
String? source,
}) {
return SpeechProfileTranscriptSegmentSocketService.create(sampleRate, codec, language, source: source);
}
/// Speech-profile (onboarding-question) socket transcribed on-device.
///
/// Fallback for when the backend's streaming STT is unavailable. The
/// question flow and progress only need *some* transcript to arrive, and the
/// backend already accepts client-supplied `suggested_transcript` segments in
/// custom-STT mode (routers/listen/receiver.py) and feeds them to the
/// OnboardingHandler exactly like server-side STT output. Raw audio follows
/// the same forwarding setting as the conversation composite (a local-only
/// config keeps raw audio off the Omi socket; suggested transcripts still
/// reach the backend and keep its session clock alive); the voice print
/// itself is computed from the WAV the client uploads at finalize(), never
/// from the transcript, so a locally transcribed session yields the same
/// profile.
static TranscriptSegmentSocketService createSpeechProfileOnDevice(
int sampleRate,
BleAudioCodec codec,
String language,
CustomSttConfig config, {
String? source,
bool speechProfileRedo = false,
}) {
final primarySocket = _createPollingSocket(sampleRate, codec, config);
final secondaryService = SpeechProfileTranscriptSegmentSocketService.create(
sampleRate,
codec,
language,
source: source,
customSttMode: true,
onboardingMode: true,
speechProfileRedo: speechProfileRedo,
);
final compositeSocket = CompositeTranscriptionSocket(
primarySocket: primarySocket,
secondarySocket: secondaryService.socket,
sttProvider: config.provider.name,
forwardRawAudioToSecondary: config.sendRawAudioToOmi,
);
return TranscriptSegmentSocketService.withSocket(
sampleRate,
codec,
language,
compositeSocket,
source: source,
customSttMode: true,
sttConfigId: config.sttConfigId,
onboardingMode: true,
speechProfileRedo: speechProfileRedo,
);
}
/// Main entry point: Create transcription service from CustomSttConfig
/// Uses config.isLive to decide between streaming and polling sockets
static TranscriptSegmentSocketService createFromCustomConfig(
int sampleRate,
BleAudioCodec codec,
String language,
CustomSttConfig config, {
String? source,
Geolocation? geolocation,
String? clientConversationId,
}) {
if (!config.isEnabled) {
return createDefault(
sampleRate,
codec,
language,
source: source,
geolocation: geolocation,
clientConversationId: clientConversationId,
);
}
final sttConfigId = config.sttConfigId;
final effectiveLang = config.effectiveLanguage;
final effectiveModel = config.effectiveModel;
Logger.debug(
"[STTFactory] Creating socket: provider=${config.provider.name}, isLive=${config.isLive}, lang=$effectiveLang, model=$effectiveModel",
);
// Create primary socket based on isLive/isPolling
final primarySocket = config.isLive
? _createStreamingSocket(sampleRate, codec, config)
: _createPollingSocket(sampleRate, codec, config);
// Wrap with composite service (primary STT + Omi backend)
return _createCompositeService(
sampleRate,
codec,
effectiveLang,
primarySocket: primarySocket,
source: source,
geolocation: geolocation,
sttConfigId: sttConfigId,
sttProvider: config.provider.name,
forwardRawAudioToSecondary: config.sendRawAudioToOmi,
clientConversationId: clientConversationId,
);
}
/// S19: synthesized freemium local mode is unnamed. User Custom STT keeps
/// today's speech-profile request on the Omi secondary socket.
static bool includeSpeechProfileForCustomSecondary(String? sttConfigId) {
return sttConfigId != 'freemium:on-device';
}
/// Create streaming WebSocket for live STT
static IPureSocket _createStreamingSocket(int sampleRate, BleAudioCodec codec, CustomSttConfig config) {
final transcoder = AudioTranscoderFactory.createToRawPcm(sourceCodec: codec, sampleRate: sampleRate);
// Special case: Gemini Live has unique protocol (setup message, base64 audio)
if (config.provider == SttProvider.geminiLive) {
return GeminiStreamingSttSocket(
apiKey: config.apiKey ?? '',
model:
config.effectiveModel.isNotEmpty ? config.effectiveModel : 'gemini-2.5-flash-native-audio-preview-12-2025',
language: config.effectiveLanguage,
sampleRate: sampleRate,
transcoder: transcoder,
);
}
// Deepgram Live and other streaming providers
final requestConfig = config.requestConfig;
final url = requestConfig['url'] ?? config.effectiveUrl;
final headers =
requestConfig['headers'] != null ? Map<String, String>.from(requestConfig['headers']) : (config.headers ?? {});
final params =
requestConfig['params'] != null ? Map<String, String>.from(requestConfig['params']) : (config.params ?? {});
// Build WebSocket URL with query params
final wsUrl = _buildUrlWithParams(url, params);
return PureStreamingSttSocket(
config: StreamingSttConfig.schemaBased(
wsUrl: wsUrl,
schema: config.schema,
headers: headers,
transcoder: transcoder,
serviceId: config.provider.name,
sendKeepAlive: config.provider == SttProvider.deepgramLive,
keepAliveInterval: const Duration(seconds: 8),
),
);
}
/// Create polling HTTP socket for batch STT
static IPureSocket _createPollingSocket(int sampleRate, BleAudioCodec codec, CustomSttConfig config) {
final transcoder = AudioTranscoderFactory.createToWav(sourceCodec: codec, sampleRate: sampleRate);
final requestConfig = config.requestConfig;
final url = requestConfig['url'] ?? config.effectiveUrl;
final headers =
requestConfig['headers'] != null ? Map<String, String>.from(requestConfig['headers']) : (config.headers ?? {});
final params =
requestConfig['params'] != null ? Map<String, String>.from(requestConfig['params']) : (config.params ?? {});
final audioFieldName = requestConfig['audio_field_name'] ?? config.audioFieldName ?? 'file';
final requestType = config.effectiveRequestType;
// Build URL with query params for raw_binary type
final effectiveUrl = requestType == SttRequestType.rawBinary ? _buildUrlWithParams(url, params) : url;
// Special handling for On-Device Whisper
if (config.provider == SttProvider.onDeviceWhisper) {
// Use Native iOS Speech Recognition on iOS
if (Platform.isIOS) {
return PurePollingSocket(
config: AudioPollingConfig(
bufferDuration: const Duration(seconds: 5),
minBufferSizeBytes: sampleRate * 2,
serviceId: config.provider.name,
transcoder: transcoder,
),
sttProvider: OnDeviceAppleProvider(language: config.language ?? 'en'),
);
}
if (config.url == null || config.url!.isEmpty) {
throw ArgumentError("[STTFactory] OnDeviceWhisper selected but no model path provided.");
}
return PurePollingSocket(
config: AudioPollingConfig(
bufferDuration: const Duration(seconds: 5),
minBufferSizeBytes: sampleRate * 2,
serviceId: config.provider.name,
transcoder: transcoder,
),
sttProvider: OnDeviceWhisperProvider(modelPath: config.url ?? '', language: config.language ?? 'en'),
);
}
return PurePollingSocket(
config: AudioPollingConfig(
bufferDuration: const Duration(seconds: 5),
minBufferSizeBytes: sampleRate * 2,
serviceId: config.provider.name,
transcoder: transcoder,
),
sttProvider: SchemaBasedSttProvider(
apiUrl: effectiveUrl,
schema: config.schema,
defaultHeaders: headers,
defaultFields: requestType == SttRequestType.rawBinary ? {} : params,
audioFieldName: audioFieldName,
requestType: requestType,
),
);
}
/// Build URL with query parameters
static String _buildUrlWithParams(String baseUrl, Map<String, String> params) {
if (params.isEmpty) return baseUrl;
final uri = Uri.tryParse(baseUrl);
if (uri == null) {
Logger.warning('[STTFactory] Invalid URL, cannot append params: $baseUrl');
return baseUrl;
}
return uri.replace(queryParameters: {...uri.queryParameters, ...params}).toString();
}
/// Create composite service: primary STT socket + Omi backend for conversation processing
static TranscriptSegmentSocketService _createCompositeService(
int sampleRate,
BleAudioCodec codec,
String language, {
required IPureSocket primarySocket,
String? source,
String? sttConfigId,
String? sttProvider,
required bool forwardRawAudioToSecondary,
Geolocation? geolocation,
String? clientConversationId,
}) {
final secondaryService = CustomSttTranscriptSegmentSocketService.create(
sampleRate,
codec,
language,
source: source,
geolocation: geolocation,
clientConversationId: clientConversationId,
includeSpeechProfile: includeSpeechProfileForCustomSecondary(sttConfigId),
);
final compositeSocket = CompositeTranscriptionSocket(
primarySocket: primarySocket,
secondarySocket: secondaryService.socket,
sttProvider: sttProvider,
forwardRawAudioToSecondary: forwardRawAudioToSecondary,
);
return TranscriptSegmentSocketService.withSocket(
sampleRate,
codec,
language,
compositeSocket,
source: source,
customSttMode: true,
sttConfigId: sttConfigId,
geolocation: geolocation,
clientConversationId: clientConversationId,
);
}
}