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
use rustpotter::{
DetectedWakeword, SampleFormat as RustpotterSampleFormat, WakewordDetector,
WakewordDetectorBuilder,
};
use wasm_bindgen::prelude::*;
mod utils;
// When the `wee_alloc` feature is enabled, use `wee_alloc` as the global
// allocator.
#[cfg(feature = "wee_alloc")]
#[global_allocator]
static ALLOC: wee_alloc::WeeAlloc = wee_alloc::WeeAlloc::INIT;
#[wasm_bindgen]
pub struct RustpotterJS {
detector: WakewordDetector,
}
#[wasm_bindgen]
#[allow(non_snake_case)]
impl RustpotterJS {
/// Loads a wakeword from its model bytes.
pub fn addWakewordModelBytes(&mut self, data: Vec<u8>) {
self.detector
.add_wakeword_from_model_bytes(data, true)
.unwrap();
}
/// Process i32 audio chunks.
///
/// Asserts that the audio chunk length should match the return
/// of the get_samples_per_frame method.
///
/// Assumes sample rate match the configured for the detector.
///
/// Asserts that detector bits_per_sample is one of: 8, 16, 24, 32.
///
/// Asserts that detector sample_format is 'int'.
pub fn processInt32(&mut self, buffer: &[i32]) -> Option<RustpotterDetection> {
transform_detection(self.detector.process_i32(buffer))
}
/// Process i16 audio chunks.
///
/// Asserts that the audio chunk length should match the return
/// of the get_samples_per_frame method.
///
/// Assumes sample rate match the configured for the detector.
///
/// Asserts that detector bits_per_sample is one of: 8, 16.
///
/// Asserts that detector sample_format is 'int'.
pub fn processInt16(&mut self, buffer: &[i16]) -> Option<RustpotterDetection> {
transform_detection(self.detector.process_i16(buffer))
}
/// Process i8 audio chunks.
///
/// Asserts that the audio chunk length should match the return
/// of the get_samples_per_frame method.
///
/// Assumes sample rate match the configured for the detector.
///
/// Asserts that detector bits_per_sample is 8.
///
/// Asserts that detector sample_format is 'int'.
pub fn processInt8(&mut self, buffer: &[i8]) -> Option<RustpotterDetection> {
transform_detection(self.detector.process_i8(buffer))
}
/// Process f32 audio chunks.
///
/// Asserts that the audio chunk length should match the return
/// of the get_samples_per_frame method.
///
/// Assumes sample rate match the configured for the detector.
///
/// Asserts that detector bits_per_sample is 32.
///
/// Asserts that detector sample_format is 'float'.
pub fn processFloat32(&mut self, buffer: &[f32]) -> Option<RustpotterDetection> {
transform_detection(self.detector.process_f32(buffer))
}
/// Returns the desired chunk size.
pub fn getFrameSize(&self) -> usize {
self.detector.get_samples_per_frame()
}
}
fn transform_detection(detection_option: Option<DetectedWakeword>) -> Option<RustpotterDetection> {
if detection_option.is_some() {
let result = detection_option.unwrap();
Some(RustpotterDetection{
name: result.wakeword.clone(),
score: result.score,
})
} else {
None
}
}
#[wasm_bindgen]
pub struct RustpotterDetection {
name: String,
score: f32,
}
#[wasm_bindgen]
#[allow(non_snake_case)]
impl RustpotterDetection {
/// Get detected wakeword name
pub fn getName(&self) -> String {
self.name.clone()
}
/// Get detected wakeword score
pub fn getScore(&self) -> f32 {
self.score
}
}
#[wasm_bindgen]
pub struct RustpotterJSBuilder {
builder: WakewordDetectorBuilder,
}
#[wasm_bindgen]
#[allow(non_snake_case)]
impl RustpotterJSBuilder {
pub fn new() -> Self {
utils::set_panic_hook();
Self {
builder: WakewordDetectorBuilder::new(),
}
}
/// Configures the detector threshold,
/// is the min score (in range 0. to 1.) that some of
/// the wakeword templates should obtain to trigger a detection.
///
/// Defaults to 0.5, wakeword defined value takes prevalence if present.
pub fn setThreshold(&mut self, value: f32) {
self.builder.set_threshold(value);
}
/// Configures the detector threshold,
/// is the min score (in range 0. to 1.) that
/// the averaged wakeword template should obtain to allow
/// to continue with the detection. This way it can prevent to
/// run the comparison of the current frame against each of the wakeword templates.
/// If set to 0. this functionality is disabled.
///
/// Defaults to half of the configured threshold, wakeword defined value takes prevalence if present.
pub fn setAveragedThreshold(&mut self, value: f32) {
self.builder.set_averaged_threshold(value);
}
/// Configures the detector expected bit per sample for the audio chunks to process.
///
/// Defaults to 16; Allowed values: 8, 16, 24, 32
pub fn setBitsPerSample(&mut self, value: u16) {
self.builder.set_bits_per_sample(value);
}
/// Configures the detector expected sample rate for the audio chunks to process.
///
/// Defaults to 16000
pub fn setSampleRate(&mut self, value: usize) {
self.builder.set_sample_rate(value);
}
/// Configures the detector expected sample format for the audio chunks to process.
///
/// Defaults to int
pub fn setSampleFormat(&mut self, value: SampleFormat) {
self.builder.set_sample_format(transform_format(value));
}
/// Configures the detector expected number of channels for the audio chunks to process.
/// Rustpotter will only use data for first channel.
///
/// Defaults to 1
pub fn setChannels(&mut self, value: u16) {
self.builder.set_channels(value);
}
/// Configures the band-size for the comparator used to match the samples.
///
/// Defaults to 6
pub fn setComparatorBandSize(&mut self, value: usize) {
self.builder.set_comparator_band_size(value);
}
/// Configures the reference for the comparator used to match the samples.
///
/// Defaults to 0.22
pub fn setComparatorRef(&mut self, value: f32) {
self.builder.set_comparator_ref(value);
}
/// Enables eager mode.
/// Terminate the detection as son as one result is above the score,
/// instead of wait to see if the next frame has a higher score.
///
/// Recommended for real usage.
///
/// Defaults to false.
pub fn setEagerMode(&mut self, value: bool) {
self.builder.set_eager_mode(value);
}
/// Unless enabled the comparison against multiple wakewords run
/// in separate threads.
///
/// Defaults to false.
///
/// Only applies when more than a wakeword is loaded.
pub fn setSingleThread(&mut self, value: bool) {
self.builder.set_single_thread(value);
}
/// construct the wakeword detector
pub fn build(&self) -> RustpotterJS {
RustpotterJS {
detector: self.builder.build(),
}
}
}
#[wasm_bindgen]
#[allow(non_camel_case_types)]
pub enum SampleFormat {
int,
float,
}
fn transform_format(format: SampleFormat) -> RustpotterSampleFormat {
match format {
SampleFormat::int => RustpotterSampleFormat::Int,
SampleFormat::float => RustpotterSampleFormat::Float,
}
}