forked from Picovoice/rhino
-
Notifications
You must be signed in to change notification settings - Fork 0
/
rhino.dart
324 lines (275 loc) · 11.2 KB
/
rhino.dart
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
//
// Copyright 2021 Picovoice Inc.
//
// You may not use this file except in compliance with the license. A copy of the license is located in the "LICENSE"
// file accompanying this source.
//
// Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
// an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
// specific language governing permissions and limitations under the License.
//
import 'dart:ffi';
import 'dart:async';
import 'dart:io';
import 'dart:typed_data';
import 'package:flutter/services.dart';
import 'package:ffi/ffi.dart';
import 'package:flutter/services.dart' show rootBundle;
import 'package:path_provider/path_provider.dart';
import 'package:rhino/rhino_error.dart';
class Rhino {
static bool _resourcesExtracted = false;
static String _defaultModelPath;
int _handle;
final String _contextInfo;
final Pointer<Int16> _cFrame;
/// Rhino version string
static String get version => _rhinoVersion().toDartString();
/// The number of audio samples per frame required by Rhino
static int get frameLength => _rhinoFrameLength();
/// The audio sample rate required by Rhino
static int get sampleRate => _rhinoSampleRate();
/// Gets the source of the Rhino context in YAML format. Shows the list of intents,
/// which expressions map to those intents, as well as slots and their possible values.
String get contextInfo => _contextInfo;
/// Static creator for initializing Rhino
///
/// [contextPath] (Optional) Absolute path to the Rhino context file (.rhn).
///
/// [modelPath] (Optional) Path to the file containing model parameters.
/// If not set it will be set to the default location.
///
/// [sensitivity] Inference sensitivity. A higher sensitivity value results in
/// fewer misses at the cost of (potentially) increasing the erroneous inference rate.
/// Sensitivity should be a floating-point number within 0 and 1.
///
/// Thows a `PvError` if not initialized correctly
///
/// returns an instance of the speech-to-intent engine
static Future<Rhino> create(String contextPath,
{String modelPath, double sensitivity = 0.5}) async {
if (!_resourcesExtracted) {
await _extractRhinoResources();
_resourcesExtracted = true;
}
if (contextPath == null || contextPath.isEmpty) {
throw new PvArgumentError("No context file provided.");
}
modelPath ??= _defaultModelPath;
if (sensitivity < 0 || sensitivity > 1 || sensitivity.isNaN) {
throw new PvArgumentError(
"Sensitivity value ($sensitivity) in given 'sensitivities' not in range [0,1]");
}
// generate arguments for ffi
Pointer<Utf8> cModelPath = modelPath.toNativeUtf8();
Pointer<Utf8> cContextPath = contextPath.toNativeUtf8();
Pointer<IntPtr> handlePtr = malloc<IntPtr>(1);
// init rhino
int status = _rhinoInit(cModelPath, cContextPath, sensitivity, handlePtr);
PvStatus pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Failed to initialize Rhino.");
}
int handle = handlePtr.value;
Pointer<Pointer<Utf8>> cContextInfo = malloc(1);
status = _rhinoContextInfo(handle, cContextInfo);
pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Failed to get Rhino context info.");
}
String contextInfo = cContextInfo[0].toDartString();
return new Rhino._(handle, contextInfo);
}
// private constructor
Rhino._(this._handle, this._contextInfo)
: _cFrame = malloc<Int16>(frameLength);
/// Process a frame of pcm audio with the speech-to-intent engine.
///
/// [frame] frame of 16-bit integers of 16kHz linear PCM mono audio.
/// The specific array length is obtained from Rhino via the frameLength field.
///
/// returns a map object with the following fields:
/// - isFinalized: whether Rhino has made an inference
/// - isUnderstood: if isFinalized, whether Rhino understood what it heard based on the context
/// - intent: if isUnderstood, name of intent that were inferred
/// - slots: if isUnderstood, dictionary of slot keys and values that were inferred
Map<String, dynamic> process(List<int> frame) {
if (_handle == null) {
throw new PvStateError(
"Attempted to process an audio frame after Rhino was been deleted.");
}
if (frame == null) {
throw new PvArgumentError(
"Frame array provided to Rhino process was null.");
}
if (frame.length != frameLength) {
throw new PvArgumentError(
"Size of frame array provided to 'process' (${frame.length}) does not match the engine 'frameLength' ($frameLength)");
}
// call to process lib function
_cFrame.asTypedList(frame.length).setAll(0, frame);
Pointer<Uint8> isFinalized = malloc(1);
int status = _rhinoProcess(_handle, _cFrame, isFinalized);
PvStatus pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Rhino failed to process an audio frame.");
}
// return if not finalized
if (isFinalized.value == 0) {
return {'isFinalized': false};
}
Map<String, dynamic> inference = {'isFinalized': true};
// get isUnderstood
Pointer<Uint8> isUnderstood = malloc(1);
status = _rhinoIsUnderstood(_handle, isUnderstood);
pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Rhino failed to get IsUnderstood value.");
}
if (isUnderstood.value == 1) {
inference['isUnderstood'] = true;
// get intent
Pointer<Pointer<Utf8>> cIntent = malloc(1);
Pointer<Int32> cNumSlots = malloc(1);
Pointer<Pointer<Pointer<Utf8>>> cSlots = malloc(1);
Pointer<Pointer<Pointer<Utf8>>> cValues = malloc(1);
status = _rhinoGetIntent(_handle, cIntent, cNumSlots, cSlots, cValues);
pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Rhino failed to get intent.");
}
inference['intent'] = cIntent[0].toDartString();
// decode slot map
Map<String, String> slots = new Map();
for (var i = 0; i < cNumSlots.value; i++) {
final String slot = cSlots[0][i].toDartString();
final String value = cValues[0][i].toDartString();
slots[slot] = value;
}
inference['slots'] = slots;
// free slots
status = _rhinoFreeSlotsAndValues(_handle, cSlots[0], cValues[0]);
pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Rhino failed to free slots.");
}
} else {
inference['isUnderstood'] = false;
}
// reset Rhino
status = _rhinoReset(_handle);
pvStatus = PvStatus.values[status];
if (pvStatus != PvStatus.SUCCESS) {
pvStatusToException(pvStatus, "Rhino failed to reset.");
}
return inference;
}
/// Frees memory that was allocated for Rhino
void delete() {
if (_handle != null) {
_rhinoDelete(_handle);
_handle = null;
}
}
static const String _assetDir = "packages/rhino/assets";
static Future<void> _extractRhinoResources() async {
_defaultModelPath =
await _extractResource("$_assetDir/lib/common/rhino_params.pv");
}
static Future<String> _extractResource(String filePath) async {
String resourceDirectory = (await getApplicationDocumentsDirectory()).path;
String outputPath = '$resourceDirectory/$filePath';
File outputFile = new File(outputPath);
ByteData data = await rootBundle.load(filePath);
final buffer = data.buffer;
await outputFile.create(recursive: true);
await outputFile.writeAsBytes(
buffer.asUint8List(data.offsetInBytes, data.lengthInBytes));
return outputPath;
}
}
// loads lib
final _rhinoLib = _load();
DynamicLibrary _load() {
if (Platform.isAndroid) {
return DynamicLibrary.open("libpv_rhino.so");
} else {
return DynamicLibrary.process();
}
}
// pv_rhino_init
typedef NativeInit = Int32 Function(
Pointer<Utf8>, Pointer<Utf8>, Float, Pointer<IntPtr>);
typedef Init = int Function(
Pointer<Utf8>, Pointer<Utf8>, double, Pointer<IntPtr>);
final Init _rhinoInit =
_rhinoLib.lookup<NativeFunction<NativeInit>>('pv_rhino_init').asFunction();
// pv_rhino_process
typedef NativeProcess = Int32 Function(IntPtr, Pointer<Int16>, Pointer<Uint8>);
typedef Process = int Function(int, Pointer<Int16>, Pointer<Uint8>);
final Process _rhinoProcess = _rhinoLib
.lookup<NativeFunction<NativeProcess>>('pv_rhino_process')
.asFunction();
// pv_rhino_is_understood
typedef NativeIsUnderstood = Int32 Function(IntPtr, Pointer<Uint8>);
typedef IsUnderstood = int Function(int, Pointer<Uint8>);
final IsUnderstood _rhinoIsUnderstood = _rhinoLib
.lookup<NativeFunction<NativeIsUnderstood>>('pv_rhino_is_understood')
.asFunction();
// pv_rhino_get_intent
typedef NativeGetIntent = Int32 Function(
IntPtr,
Pointer<Pointer<Utf8>>,
Pointer<Int32>,
Pointer<Pointer<Pointer<Utf8>>>,
Pointer<Pointer<Pointer<Utf8>>>);
typedef GetIntent = int Function(int, Pointer<Pointer<Utf8>>, Pointer<Int32>,
Pointer<Pointer<Pointer<Utf8>>>, Pointer<Pointer<Pointer<Utf8>>>);
final GetIntent _rhinoGetIntent = _rhinoLib
.lookup<NativeFunction<NativeGetIntent>>('pv_rhino_get_intent')
.asFunction();
// pv_rhino_free_slots_and_values
typedef NativeFreeSlotsAndValues = Int32 Function(
IntPtr, Pointer<Pointer<Utf8>>, Pointer<Pointer<Utf8>>);
typedef FreeSlotsAndValues = int Function(
int, Pointer<Pointer<Utf8>>, Pointer<Pointer<Utf8>>);
final FreeSlotsAndValues _rhinoFreeSlotsAndValues = _rhinoLib
.lookup<NativeFunction<NativeFreeSlotsAndValues>>(
'pv_rhino_free_slots_and_values')
.asFunction();
// pv_rhino_reset
typedef NativeReset = Int32 Function(IntPtr);
typedef Reset = int Function(int);
final Reset _rhinoReset = _rhinoLib
.lookup<NativeFunction<NativeReset>>('pv_rhino_reset')
.asFunction();
// pv_rhino_delete
typedef NativeDelete = Void Function(IntPtr);
typedef Delete = void Function(int);
final Delete _rhinoDelete = _rhinoLib
.lookup<NativeFunction<NativeDelete>>('pv_rhino_delete')
.asFunction();
// pv_rhino_context_info
typedef NativeContextInfo = Int32 Function(IntPtr, Pointer<Pointer<Utf8>>);
typedef ContextInfo = int Function(int, Pointer<Pointer<Utf8>>);
final ContextInfo _rhinoContextInfo = _rhinoLib
.lookup<NativeFunction<NativeContextInfo>>('pv_rhino_context_info')
.asFunction();
// pv_rhino_version
typedef NativeVersion = Pointer<Utf8> Function();
typedef Version = Pointer<Utf8> Function();
final Version _rhinoVersion = _rhinoLib
.lookup<NativeFunction<NativeVersion>>('pv_rhino_version')
.asFunction();
// pv_rhino_frame_length
typedef NativeFrameLength = Int32 Function();
typedef FrameLength = int Function();
final FrameLength _rhinoFrameLength = _rhinoLib
.lookup<NativeFunction<NativeFrameLength>>('pv_rhino_frame_length')
.asFunction();
// pv_sample_rate
typedef NativeSampleRate = Int32 Function();
typedef SampleRate = int Function();
final SampleRate _rhinoSampleRate = _rhinoLib
.lookup<NativeFunction<NativeSampleRate>>('pv_sample_rate')
.asFunction();