-
Notifications
You must be signed in to change notification settings - Fork 4.7k
/
SpeechRecognitionEngine.cs
646 lines (567 loc) · 23.4 KB
/
SpeechRecognitionEngine.cs
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
644
645
646
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel;
using System.Globalization;
using System.IO;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using System.Speech.AudioFormat;
using System.Speech.Internal;
using System.Speech.Internal.ObjectTokens;
using System.Speech.Internal.SapiInterop;
namespace System.Speech.Recognition
{
public class SpeechRecognitionEngine : IDisposable
{
#region Constructors
public SpeechRecognitionEngine()
{
Initialize(null);
}
public SpeechRecognitionEngine(CultureInfo culture)
{
Helpers.ThrowIfNull(culture, nameof(culture));
if (culture.Equals(CultureInfo.InvariantCulture))
{
throw new ArgumentException(SR.Get(SRID.InvariantCultureInfo), nameof(culture));
}
// Enumerate using collection. It would also be possible to directly access the token from SAPI.
foreach (RecognizerInfo recognizerInfo in InstalledRecognizers())
{
if (culture.Equals(recognizerInfo.Culture))
{
Initialize(recognizerInfo);
return;
}
}
// No exact match for the culture, try out with a SR engine of the same base culture.
foreach (RecognizerInfo recognizerInfo in InstalledRecognizers())
{
if (Helpers.CompareInvariantCulture(recognizerInfo.Culture, culture))
{
Initialize(recognizerInfo);
return;
}
}
// No match even with culture having the same parent
throw new ArgumentException(SR.Get(SRID.RecognizerNotFound), nameof(culture));
}
public SpeechRecognitionEngine(string recognizerId)
{
Helpers.ThrowIfEmptyOrNull(recognizerId, nameof(recognizerId));
foreach (RecognizerInfo recognizerInfo in InstalledRecognizers())
{
if (recognizerId.Equals(recognizerInfo.Id, StringComparison.OrdinalIgnoreCase))
{
Initialize(recognizerInfo);
return;
}
}
throw new ArgumentException(SR.Get(SRID.RecognizerNotFound), nameof(recognizerId));
}
public SpeechRecognitionEngine(RecognizerInfo recognizerInfo)
{
Helpers.ThrowIfNull(recognizerInfo, nameof(recognizerInfo));
Initialize(recognizerInfo);
}
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
protected virtual void Dispose(bool disposing)
{
if (disposing && !_disposed)
{
if (_recognizerBase != null)
{
_recognizerBase.Dispose();
_recognizerBase = null;
}
if (_sapiRecognizer != null)
{
_sapiRecognizer.Dispose();
_sapiRecognizer = null;
}
_disposed = true; // Don't set RecognizerBase to null as every method will then need to throw ObjectDisposedException.
}
}
#endregion
#region Static Methods
// Get attributes of all the recognizers that are installed
public static ReadOnlyCollection<RecognizerInfo> InstalledRecognizers()
{
List<RecognizerInfo> recognizers = new();
// Get list of ObjectTokens
using (ObjectTokenCategory category = ObjectTokenCategory.Create(SAPICategories.Recognizers))
{
if (category != null)
{
// For each element in list
foreach (ObjectToken token in (IEnumerable<ObjectToken>)category)
{
// Create RecognizerInfo + add to collection
RecognizerInfo recognizerInfo = RecognizerInfo.Create(token);
if (recognizerInfo == null)
{
// But if this entry has a corrupt registry entry then skip it.
// Otherwise one bogus entry prevents the whole method from working.
continue;
}
recognizers.Add(recognizerInfo);
}
}
}
return new ReadOnlyCollection<RecognizerInfo>(recognizers);
}
#endregion
#region public Properties
// Settings:
[EditorBrowsable(EditorBrowsableState.Advanced)]
public TimeSpan InitialSilenceTimeout
{
get { return RecoBase.InitialSilenceTimeout; }
set { RecoBase.InitialSilenceTimeout = value; }
}
[EditorBrowsable(EditorBrowsableState.Advanced)]
public TimeSpan BabbleTimeout
{
get { return RecoBase.BabbleTimeout; }
set { RecoBase.BabbleTimeout = value; }
}
[EditorBrowsable(EditorBrowsableState.Advanced)]
public TimeSpan EndSilenceTimeout
{
get { return TimeSpan.FromMilliseconds(RecoBase.QueryRecognizerSettingAsInt(SapiConstants.SPPROP_RESPONSE_SPEED)); }
set
{
if (value.TotalMilliseconds < 0.0f || value.TotalMilliseconds > 10000.0f)
{
throw new ArgumentOutOfRangeException(nameof(value), SR.Get(SRID.EndSilenceOutOfRange));
}
RecoBase.UpdateRecognizerSetting(SapiConstants.SPPROP_RESPONSE_SPEED, (int)value.TotalMilliseconds);
}
}
[EditorBrowsable(EditorBrowsableState.Advanced)]
public TimeSpan EndSilenceTimeoutAmbiguous
{
get { return TimeSpan.FromMilliseconds(RecoBase.QueryRecognizerSettingAsInt(SapiConstants.SPPROP_COMPLEX_RESPONSE_SPEED)); }
set
{
if (value.TotalMilliseconds < 0.0f || value.TotalMilliseconds > 10000.0f)
{
throw new ArgumentOutOfRangeException(nameof(value), SR.Get(SRID.EndSilenceOutOfRange));
}
RecoBase.UpdateRecognizerSetting(SapiConstants.SPPROP_COMPLEX_RESPONSE_SPEED, (int)value.TotalMilliseconds);
}
}
// Gives access to the collection of grammars that are currently active. Read-only.
public ReadOnlyCollection<Grammar> Grammars
{
get { return RecoBase.Grammars; }
}
// Gives access to the set of attributes exposed by this recognizer.
public RecognizerInfo RecognizerInfo
{
get { return RecoBase.RecognizerInfo; }
}
// Data on the audio stream the recognizer is processing
public AudioState AudioState
{
get { return RecoBase.AudioState; }
}
// Data on the audio stream the recognizer is processing
public int AudioLevel
{
get { return RecoBase.AudioLevel; }
}
// Data on the audio stream the recognizer is processing
public TimeSpan RecognizerAudioPosition
{
get { return RecoBase.RecognizerAudioPosition; }
}
// Data on the audio stream the recognizer is processing
public TimeSpan AudioPosition
{
get { return RecoBase.AudioPosition; }
}
public SpeechAudioFormatInfo AudioFormat
{
get { return RecoBase.AudioFormat; }
}
public int MaxAlternates
{
get { return RecoBase.MaxAlternates; }
set { RecoBase.MaxAlternates = value; }
}
#endregion
#region public Methods
public void SetInputToWaveFile(string path)
{
Helpers.ThrowIfEmptyOrNull(path, nameof(path));
RecoBase.SetInput(path);
}
public void SetInputToWaveStream(Stream audioSource)
{
RecoBase.SetInput(audioSource, null);
}
public void SetInputToAudioStream(Stream audioSource, SpeechAudioFormatInfo audioFormat)
{
Helpers.ThrowIfNull(audioSource, nameof(audioSource));
Helpers.ThrowIfNull(audioFormat, nameof(audioFormat));
RecoBase.SetInput(audioSource, audioFormat);
}
// Detach the audio input
public void SetInputToNull()
{
RecoBase.SetInput(null, null);
}
// Data on the audio stream the recognizer is processing
public void SetInputToDefaultAudioDevice()
{
RecoBase.SetInputToDefaultAudioDevice();
}
// Methods to control recognition process:
// Does a single synchronous Recognition and then stops the audio stream.
// Returns null if there was a timeout. Throws on error.
public RecognitionResult Recognize()
{
return RecoBase.Recognize(RecoBase.InitialSilenceTimeout);
}
public RecognitionResult Recognize(TimeSpan initialSilenceTimeout)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
return RecoBase.Recognize(initialSilenceTimeout);
}
// Does a single asynchronous Recognition and then stops the audio stream.
public void RecognizeAsync()
{
RecognizeAsync(RecognizeMode.Single);
}
// Can do either a single or multiple recognitions depending on the mode.
public void RecognizeAsync(RecognizeMode mode)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
RecoBase.RecognizeAsync(mode);
}
// This method stops recognition immediately without completing processing the audio. Then a RecognizeCompelted event is sent.
public void RecognizeAsyncCancel()
{
RecoBase.RecognizeAsyncCancel();
}
// This method stops recognition but audio currently buffered is still processed, so a final SpeechRecognized event may be sent {before the RecognizeCompleted event}.
public void RecognizeAsyncStop()
{
RecoBase.RecognizeAsyncStop();
}
// Note: Currently this can't be exposed as a true collection in Yakima {it can't be enumerated}. If we think this would be useful we could do this.
public object QueryRecognizerSetting(string settingName)
{
return RecoBase.QueryRecognizerSetting(settingName);
}
public void UpdateRecognizerSetting(string settingName, string updatedValue)
{
RecoBase.UpdateRecognizerSetting(settingName, updatedValue);
}
public void UpdateRecognizerSetting(string settingName, int updatedValue)
{
RecoBase.UpdateRecognizerSetting(settingName, updatedValue);
}
public void LoadGrammar(Grammar grammar)
{
RecoBase.LoadGrammar(grammar);
}
public void LoadGrammarAsync(Grammar grammar)
{
RecoBase.LoadGrammarAsync(grammar);
}
public void UnloadGrammar(Grammar grammar)
{
RecoBase.UnloadGrammar(grammar);
}
public void UnloadAllGrammars()
{
RecoBase.UnloadAllGrammars();
}
public RecognitionResult EmulateRecognize(string inputText)
{
return EmulateRecognize(inputText, CompareOptions.IgnoreCase | CompareOptions.IgnoreKanaType | CompareOptions.IgnoreWidth);
}
public RecognitionResult EmulateRecognize(string inputText, CompareOptions compareOptions)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
return RecoBase.EmulateRecognize(inputText, compareOptions);
}
public RecognitionResult EmulateRecognize(RecognizedWordUnit[] wordUnits, CompareOptions compareOptions)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
return RecoBase.EmulateRecognize(wordUnits, compareOptions);
}
public void EmulateRecognizeAsync(string inputText)
{
EmulateRecognizeAsync(inputText, CompareOptions.IgnoreCase | CompareOptions.IgnoreKanaType | CompareOptions.IgnoreWidth);
}
public void EmulateRecognizeAsync(string inputText, CompareOptions compareOptions)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
RecoBase.EmulateRecognizeAsync(inputText, compareOptions);
}
public void EmulateRecognizeAsync(RecognizedWordUnit[] wordUnits, CompareOptions compareOptions)
{
if (Grammars.Count == 0)
{
throw new InvalidOperationException(SR.Get(SRID.RecognizerHasNoGrammar));
}
RecoBase.EmulateRecognizeAsync(wordUnits, compareOptions);
}
// Methods to pause the recognizer to do atomic updates:
public void RequestRecognizerUpdate()
{
RecoBase.RequestRecognizerUpdate();
}
public void RequestRecognizerUpdate(object userToken)
{
RecoBase.RequestRecognizerUpdate(userToken);
}
public void RequestRecognizerUpdate(object userToken, TimeSpan audioPositionAheadToRaiseUpdate)
{
RecoBase.RequestRecognizerUpdate(userToken, audioPositionAheadToRaiseUpdate);
}
#endregion
#region public Events
// Fired when the RecognizeAsync process completes.
public event EventHandler<RecognizeCompletedEventArgs> RecognizeCompleted;
// Fired when the RecognizeAsync process completes.
public event EventHandler<EmulateRecognizeCompletedEventArgs> EmulateRecognizeCompleted;
public event EventHandler<LoadGrammarCompletedEventArgs> LoadGrammarCompleted;
// The event fired when speech is detected. Used for barge-in.
public event EventHandler<SpeechDetectedEventArgs> SpeechDetected;
// The event fired on a recognition.
public event EventHandler<SpeechRecognizedEventArgs> SpeechRecognized;
// The event fired on a no recognition
public event EventHandler<SpeechRecognitionRejectedEventArgs> SpeechRecognitionRejected;
public event EventHandler<RecognizerUpdateReachedEventArgs> RecognizerUpdateReached;
// Occurs when a spoken phrase is partially recognized.
public event EventHandler<SpeechHypothesizedEventArgs> SpeechHypothesized
{
[MethodImplAttribute(MethodImplOptions.Synchronized)]
add
{
Helpers.ThrowIfNull(value, nameof(value));
if (_speechHypothesizedDelegate == null)
{
RecoBase.SpeechHypothesized += SpeechHypothesizedProxy;
}
_speechHypothesizedDelegate += value;
}
[MethodImplAttribute(MethodImplOptions.Synchronized)]
remove
{
Helpers.ThrowIfNull(value, nameof(value));
_speechHypothesizedDelegate -= value;
if (_speechHypothesizedDelegate == null)
{
RecoBase.SpeechHypothesized -= SpeechHypothesizedProxy;
}
}
}
public event EventHandler<AudioSignalProblemOccurredEventArgs> AudioSignalProblemOccurred
{
[MethodImplAttribute(MethodImplOptions.Synchronized)]
add
{
Helpers.ThrowIfNull(value, nameof(value));
if (_audioSignalProblemOccurredDelegate == null)
{
RecoBase.AudioSignalProblemOccurred += AudioSignalProblemOccurredProxy;
}
_audioSignalProblemOccurredDelegate += value;
}
[MethodImplAttribute(MethodImplOptions.Synchronized)]
remove
{
Helpers.ThrowIfNull(value, nameof(value));
_audioSignalProblemOccurredDelegate -= value;
if (_audioSignalProblemOccurredDelegate == null)
{
RecoBase.AudioSignalProblemOccurred -= AudioSignalProblemOccurredProxy;
}
}
}
public event EventHandler<AudioLevelUpdatedEventArgs> AudioLevelUpdated
{
[MethodImplAttribute(MethodImplOptions.Synchronized)]
add
{
Helpers.ThrowIfNull(value, nameof(value));
if (_audioLevelUpdatedDelegate == null)
{
RecoBase.AudioLevelUpdated += AudioLevelUpdatedProxy;
}
_audioLevelUpdatedDelegate += value;
}
[MethodImplAttribute(MethodImplOptions.Synchronized)]
remove
{
Helpers.ThrowIfNull(value, nameof(value));
_audioLevelUpdatedDelegate -= value;
if (_audioLevelUpdatedDelegate == null)
{
RecoBase.AudioLevelUpdated -= AudioLevelUpdatedProxy;
}
}
}
public event EventHandler<AudioStateChangedEventArgs> AudioStateChanged
{
[MethodImplAttribute(MethodImplOptions.Synchronized)]
add
{
Helpers.ThrowIfNull(value, nameof(value));
if (_audioStateChangedDelegate == null)
{
RecoBase.AudioStateChanged += AudioStateChangedProxy;
}
_audioStateChangedDelegate += value;
}
[MethodImplAttribute(MethodImplOptions.Synchronized)]
remove
{
Helpers.ThrowIfNull(value, nameof(value));
_audioStateChangedDelegate -= value;
if (_audioStateChangedDelegate == null)
{
RecoBase.AudioStateChanged -= AudioStateChangedProxy;
}
}
}
#endregion
#region Private Methods
private void Initialize(RecognizerInfo recognizerInfo)
{
try
{
_sapiRecognizer = new SapiRecognizer(SapiRecognizer.RecognizerType.InProc);
}
catch (COMException e)
{
throw RecognizerBase.ExceptionFromSapiCreateRecognizerError(e);
}
if (recognizerInfo != null)
{
ObjectToken token = recognizerInfo.GetObjectToken();
if (token == null)
{
throw new ArgumentException(SR.Get(SRID.NullParamIllegal), nameof(recognizerInfo));
}
try
{
_sapiRecognizer.SetRecognizer(token.SAPIToken);
}
catch (COMException e)
{
throw new ArgumentException(SR.Get(SRID.RecognizerNotFound), RecognizerBase.ExceptionFromSapiCreateRecognizerError(e));
}
}
// For the SpeechRecognitionEngine we don't want recognition to start until the Recognize() or RecognizeAsync() methods are called.
_sapiRecognizer.SetRecoState(SPRECOSTATE.SPRST_INACTIVE);
}
// Proxy event handlers used to translate the sender from the RecognizerBase to this class:
private void RecognizeCompletedProxy(object sender, RecognizeCompletedEventArgs e)
{
RecognizeCompleted?.Invoke(this, e);
}
private void EmulateRecognizeCompletedProxy(object sender, EmulateRecognizeCompletedEventArgs e)
{
EmulateRecognizeCompleted?.Invoke(this, e);
}
private void LoadGrammarCompletedProxy(object sender, LoadGrammarCompletedEventArgs e)
{
LoadGrammarCompleted?.Invoke(this, e);
}
private void SpeechDetectedProxy(object sender, SpeechDetectedEventArgs e)
{
SpeechDetected?.Invoke(this, e);
}
private void SpeechRecognizedProxy(object sender, SpeechRecognizedEventArgs e)
{
SpeechRecognized?.Invoke(this, e);
}
private void SpeechRecognitionRejectedProxy(object sender, SpeechRecognitionRejectedEventArgs e)
{
SpeechRecognitionRejected?.Invoke(this, e);
}
private void RecognizerUpdateReachedProxy(object sender, RecognizerUpdateReachedEventArgs e)
{
RecognizerUpdateReached?.Invoke(this, e);
}
private void SpeechHypothesizedProxy(object sender, SpeechHypothesizedEventArgs e)
{
_speechHypothesizedDelegate?.Invoke(this, e);
}
private void AudioSignalProblemOccurredProxy(object sender, AudioSignalProblemOccurredEventArgs e)
{
_audioSignalProblemOccurredDelegate?.Invoke(this, e);
}
private void AudioLevelUpdatedProxy(object sender, AudioLevelUpdatedEventArgs e)
{
_audioLevelUpdatedDelegate?.Invoke(this, e);
}
private void AudioStateChangedProxy(object sender, AudioStateChangedEventArgs e)
{
_audioStateChangedDelegate?.Invoke(this, e);
}
#endregion
#region Private Properties
private RecognizerBase RecoBase
{
get
{
if (_disposed)
{
throw new ObjectDisposedException("SpeechRecognitionEngine");
}
if (_recognizerBase == null)
{
_recognizerBase = new RecognizerBase();
_recognizerBase.Initialize(_sapiRecognizer, true);
// Add event handlers for low-overhead events:
_recognizerBase.RecognizeCompleted += RecognizeCompletedProxy;
_recognizerBase.EmulateRecognizeCompleted += EmulateRecognizeCompletedProxy;
_recognizerBase.LoadGrammarCompleted += LoadGrammarCompletedProxy;
_recognizerBase.SpeechDetected += SpeechDetectedProxy;
_recognizerBase.SpeechRecognized += SpeechRecognizedProxy;
_recognizerBase.SpeechRecognitionRejected += SpeechRecognitionRejectedProxy;
_recognizerBase.RecognizerUpdateReached += RecognizerUpdateReachedProxy;
}
return _recognizerBase;
}
}
#endregion
#region Private Fields
private bool _disposed;
private RecognizerBase _recognizerBase;
private SapiRecognizer _sapiRecognizer;
private EventHandler<AudioSignalProblemOccurredEventArgs> _audioSignalProblemOccurredDelegate;
private EventHandler<AudioLevelUpdatedEventArgs> _audioLevelUpdatedDelegate;
private EventHandler<AudioStateChangedEventArgs> _audioStateChangedDelegate;
private EventHandler<SpeechHypothesizedEventArgs> _speechHypothesizedDelegate;
#endregion
}
}