keyword_spotter.dart
7.2 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
// Copyright (c) 2024 Xiaomi Corporation
import 'dart:convert';
import 'dart:ffi';
import 'package:ffi/ffi.dart';
import './feature_config.dart';
import './online_stream.dart';
import './online_recognizer.dart';
import './sherpa_onnx_bindings.dart';
import './utils.dart';
class KeywordSpotterConfig {
const KeywordSpotterConfig({
this.feat = const FeatureConfig(),
required this.model,
this.maxActivePaths = 4,
this.numTrailingBlanks = 1,
this.keywordsScore = 1.0,
this.keywordsThreshold = 0.25,
this.keywordsFile = '',
this.keywordsBuf = '',
this.keywordsBufSize = 0,
});
factory KeywordSpotterConfig.fromJson(Map<String, dynamic> json) {
return KeywordSpotterConfig(
feat: json['feat'] != null
? FeatureConfig.fromJson(json['feat'] as Map<String, dynamic>)
: const FeatureConfig(),
model: OnlineModelConfig.fromJson(json['model'] as Map<String, dynamic>),
maxActivePaths: json['maxActivePaths'] as int? ?? 4,
numTrailingBlanks: json['numTrailingBlanks'] as int? ?? 1,
keywordsScore: (json['keywordsScore'] as num?)?.toDouble() ?? 1.0,
keywordsThreshold:
(json['keywordsThreshold'] as num?)?.toDouble() ?? 0.25,
keywordsFile: json['keywordsFile'] as String? ?? '',
keywordsBuf: json['keywordsBuf'] as String? ?? '',
keywordsBufSize: json['keywordsBufSize'] as int? ?? 0,
);
}
@override
String toString() {
return 'KeywordSpotterConfig(feat: $feat, model: $model, maxActivePaths: $maxActivePaths, numTrailingBlanks: $numTrailingBlanks, keywordsScore: $keywordsScore, keywordsThreshold: $keywordsThreshold, keywordsFile: $keywordsFile, keywordsBuf: $keywordsBuf, keywordsBufSize: $keywordsBufSize)';
}
Map<String, dynamic> toJson() => {
'feat': feat.toJson(),
'model': model.toJson(),
'maxActivePaths': maxActivePaths,
'numTrailingBlanks': numTrailingBlanks,
'keywordsScore': keywordsScore,
'keywordsThreshold': keywordsThreshold,
'keywordsFile': keywordsFile,
'keywordsBuf': keywordsBuf,
'keywordsBufSize': keywordsBufSize,
};
final FeatureConfig feat;
final OnlineModelConfig model;
final int maxActivePaths;
final int numTrailingBlanks;
final double keywordsScore;
final double keywordsThreshold;
final String keywordsFile;
final String keywordsBuf;
final int keywordsBufSize;
}
class KeywordResult {
KeywordResult({required this.keyword});
factory KeywordResult.fromJson(Map<String, dynamic> json) {
return KeywordResult(
keyword: json['keyword'] as String? ?? '',
);
}
@override
String toString() {
return 'KeywordResult(keyword: $keyword)';
}
Map<String, dynamic> toJson() => {
'keyword': keyword,
};
final String keyword;
}
class KeywordSpotter {
KeywordSpotter.fromPtr({required this.ptr, required this.config});
KeywordSpotter._({required this.ptr, required this.config});
/// The user is responsible to call the OnlineRecognizer.free()
/// method of the returned instance to avoid memory leak.
factory KeywordSpotter(KeywordSpotterConfig config) {
final c = calloc<SherpaOnnxKeywordSpotterConfig>();
c.ref.feat.sampleRate = config.feat.sampleRate;
c.ref.feat.featureDim = config.feat.featureDim;
// transducer
c.ref.model.transducer.encoder =
config.model.transducer.encoder.toNativeUtf8();
c.ref.model.transducer.decoder =
config.model.transducer.decoder.toNativeUtf8();
c.ref.model.transducer.joiner =
config.model.transducer.joiner.toNativeUtf8();
// paraformer
c.ref.model.paraformer.encoder =
config.model.paraformer.encoder.toNativeUtf8();
c.ref.model.paraformer.decoder =
config.model.paraformer.decoder.toNativeUtf8();
// zipformer2Ctc
c.ref.model.zipformer2Ctc.model =
config.model.zipformer2Ctc.model.toNativeUtf8();
// nemoCtc
c.ref.model.nemoCtc.model = config.model.nemoCtc.model.toNativeUtf8();
c.ref.model.tokens = config.model.tokens.toNativeUtf8();
c.ref.model.numThreads = config.model.numThreads;
c.ref.model.provider = config.model.provider.toNativeUtf8();
c.ref.model.debug = config.model.debug ? 1 : 0;
c.ref.model.modelType = config.model.modelType.toNativeUtf8();
c.ref.model.modelingUnit = config.model.modelingUnit.toNativeUtf8();
c.ref.model.bpeVocab = config.model.bpeVocab.toNativeUtf8();
c.ref.maxActivePaths = config.maxActivePaths;
c.ref.numTrailingBlanks = config.numTrailingBlanks;
c.ref.keywordsScore = config.keywordsScore;
c.ref.keywordsThreshold = config.keywordsThreshold;
c.ref.keywordsFile = config.keywordsFile.toNativeUtf8();
c.ref.keywordsBuf = config.keywordsBuf.toNativeUtf8();
c.ref.keywordsBufSize = config.keywordsBufSize;
if (SherpaOnnxBindings.createKeywordSpotter == null) {
throw Exception("Please initialize sherpa-onnx first");
}
final ptr = SherpaOnnxBindings.createKeywordSpotter?.call(c) ?? nullptr;
if (ptr == nullptr) {
throw Exception("Failed to create kws. Please check your config");
}
calloc.free(c.ref.keywordsBuf);
calloc.free(c.ref.keywordsFile);
calloc.free(c.ref.model.bpeVocab);
calloc.free(c.ref.model.modelingUnit);
calloc.free(c.ref.model.modelType);
calloc.free(c.ref.model.provider);
calloc.free(c.ref.model.tokens);
calloc.free(c.ref.model.nemoCtc.model);
calloc.free(c.ref.model.zipformer2Ctc.model);
calloc.free(c.ref.model.paraformer.encoder);
calloc.free(c.ref.model.paraformer.decoder);
calloc.free(c.ref.model.transducer.encoder);
calloc.free(c.ref.model.transducer.decoder);
calloc.free(c.ref.model.transducer.joiner);
calloc.free(c);
return KeywordSpotter._(ptr: ptr, config: config);
}
void free() {
SherpaOnnxBindings.destroyKeywordSpotter?.call(ptr);
ptr = nullptr;
}
/// The user has to invoke stream.free() on the returned instance
/// to avoid memory leak
OnlineStream createStream({String keywords = ''}) {
if (keywords == '') {
final p = SherpaOnnxBindings.createKeywordStream?.call(ptr) ?? nullptr;
return OnlineStream(ptr: p);
}
final utf8 = keywords.toNativeUtf8();
final p =
SherpaOnnxBindings.createKeywordStreamWithKeywords?.call(ptr, utf8) ??
nullptr;
calloc.free(utf8);
return OnlineStream(ptr: p);
}
bool isReady(OnlineStream stream) {
int ready =
SherpaOnnxBindings.isKeywordStreamReady?.call(ptr, stream.ptr) ?? 0;
return ready == 1;
}
KeywordResult getResult(OnlineStream stream) {
final json =
SherpaOnnxBindings.getKeywordResultAsJson?.call(ptr, stream.ptr) ??
nullptr;
if (json == nullptr) {
return KeywordResult(keyword: '');
}
final parsedJson = jsonDecode(toDartString(json));
SherpaOnnxBindings.freeKeywordResultJson?.call(json);
return KeywordResult(
keyword: parsedJson['keyword'],
);
}
void decode(OnlineStream stream) {
SherpaOnnxBindings.decodeKeywordStream?.call(ptr, stream.ptr);
}
void reset(OnlineStream stream) {
SherpaOnnxBindings.resetKeywordStream?.call(ptr, stream.ptr);
}
Pointer<SherpaOnnxKeywordSpotter> ptr;
KeywordSpotterConfig config;
}