-
Notifications
You must be signed in to change notification settings - Fork 98
/
AudioConfig.ts
374 lines (330 loc) · 11.9 KB
/
AudioConfig.ts
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
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT license.
/* eslint-disable max-classes-per-file */
import { PathLike } from "fs";
import {
FileAudioSource,
MicAudioSource,
PcmRecorder,
} from "../../common.browser/Exports.js";
import { ISpeechConfigAudioDevice } from "../../common.speech/Exports.js";
import {
AudioSourceEvent,
EventSource,
IAudioDestination,
IAudioSource,
IAudioStreamNode
} from "../../common/Exports.js";
import { Contracts } from "../Contracts.js";
import {
AudioInputStream,
AudioOutputStream,
AudioStreamFormat,
IPlayer,
PullAudioInputStreamCallback,
PullAudioOutputStream,
PushAudioOutputStream,
PushAudioOutputStreamCallback,
SpeakerAudioDestination
} from "../Exports.js";
import { AudioFileWriter } from "./AudioFileWriter.js";
import { PullAudioInputStreamImpl, PushAudioInputStreamImpl } from "./AudioInputStream.js";
import { PullAudioOutputStreamImpl, PushAudioOutputStreamImpl } from "./AudioOutputStream.js";
import { AudioStreamFormatImpl } from "./AudioStreamFormat.js";
/**
* Represents audio input configuration used for specifying what type of input to use (microphone, file, stream).
* @class AudioConfig
* Updated in version 1.11.0
*/
export abstract class AudioConfig {
/**
* Creates an AudioConfig object representing the default microphone on the system.
* @member AudioConfig.fromDefaultMicrophoneInput
* @function
* @public
* @returns {AudioConfig} The audio input configuration being created.
*/
public static fromDefaultMicrophoneInput(): AudioConfig {
const pcmRecorder = new PcmRecorder(true);
return new AudioConfigImpl(new MicAudioSource(pcmRecorder));
}
/**
* Creates an AudioConfig object representing a microphone with the specified device ID.
* @member AudioConfig.fromMicrophoneInput
* @function
* @public
* @param {string | undefined} deviceId - Specifies the device ID of the microphone to be used.
* Default microphone is used the value is omitted.
* @returns {AudioConfig} The audio input configuration being created.
*/
public static fromMicrophoneInput(deviceId?: string): AudioConfig {
const pcmRecorder = new PcmRecorder(true);
return new AudioConfigImpl(new MicAudioSource(pcmRecorder, deviceId));
}
/**
* Creates an AudioConfig object representing the specified file.
* @member AudioConfig.fromWavFileInput
* @function
* @public
* @param {File} fileName - Specifies the audio input file. Currently, only WAV / PCM is supported.
* @returns {AudioConfig} The audio input configuration being created.
*/
public static fromWavFileInput(file: File | Buffer, name: string = "unnamedBuffer.wav"): AudioConfig {
return new AudioConfigImpl(new FileAudioSource(file, name));
}
/**
* Creates an AudioConfig object representing the specified stream.
* @member AudioConfig.fromStreamInput
* @function
* @public
* @param {AudioInputStream | PullAudioInputStreamCallback | MediaStream} audioStream - Specifies the custom audio input
* stream. Currently, only WAV / PCM is supported.
* @returns {AudioConfig} The audio input configuration being created.
*/
public static fromStreamInput(audioStream: AudioInputStream | PullAudioInputStreamCallback
| MediaStream): AudioConfig {
if (audioStream instanceof PullAudioInputStreamCallback) {
return new AudioConfigImpl(new PullAudioInputStreamImpl(audioStream));
}
if (audioStream instanceof AudioInputStream) {
return new AudioConfigImpl(audioStream as PushAudioInputStreamImpl);
}
if (typeof MediaStream !== "undefined" && audioStream instanceof MediaStream) {
const pcmRecorder = new PcmRecorder(false);
return new AudioConfigImpl(new MicAudioSource(pcmRecorder, null, null, audioStream));
}
throw new Error("Not Supported Type");
}
/**
* Creates an AudioConfig object representing the default speaker.
* @member AudioConfig.fromDefaultSpeakerOutput
* @function
* @public
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
public static fromDefaultSpeakerOutput(): AudioConfig {
return new AudioOutputConfigImpl(new SpeakerAudioDestination());
}
/**
* Creates an AudioConfig object representing the custom IPlayer object.
* You can use the IPlayer object to control pause, resume, etc.
* @member AudioConfig.fromSpeakerOutput
* @function
* @public
* @param {IPlayer} player - the IPlayer object for playback.
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.12.0
*/
public static fromSpeakerOutput(player?: IPlayer): AudioConfig {
if (player === undefined) {
return AudioConfig.fromDefaultSpeakerOutput();
}
if (player instanceof SpeakerAudioDestination) {
return new AudioOutputConfigImpl(player);
}
throw new Error("Not Supported Type");
}
/**
* Creates an AudioConfig object representing a specified output audio file
* @member AudioConfig.fromAudioFileOutput
* @function
* @public
* @param {PathLike} filename - the filename of the output audio file
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
public static fromAudioFileOutput(filename: PathLike): AudioConfig {
return new AudioOutputConfigImpl(new AudioFileWriter(filename));
}
/**
* Creates an AudioConfig object representing a specified audio output stream
* @member AudioConfig.fromStreamOutput
* @function
* @public
* @param {AudioOutputStream | PushAudioOutputStreamCallback} audioStream - Specifies the custom audio output
* stream.
* @returns {AudioConfig} The audio output configuration being created.
* Added in version 1.11.0
*/
public static fromStreamOutput(audioStream: AudioOutputStream | PushAudioOutputStreamCallback): AudioConfig {
if (audioStream instanceof PushAudioOutputStreamCallback) {
return new AudioOutputConfigImpl(new PushAudioOutputStreamImpl(audioStream));
}
if (audioStream instanceof PushAudioOutputStream) {
return new AudioOutputConfigImpl(audioStream as PushAudioOutputStreamImpl);
}
if (audioStream instanceof PullAudioOutputStream) {
return new AudioOutputConfigImpl(audioStream as PullAudioOutputStreamImpl);
}
throw new Error("Not Supported Type");
}
/**
* Explicitly frees any external resource attached to the object
* @member AudioConfig.prototype.close
* @function
* @public
*/
public abstract close(): void;
/**
* Sets an arbitrary property.
* @member SpeechConfig.prototype.setProperty
* @function
* @public
* @param {string} name - The name of the property to set.
* @param {string} value - The new value of the property.
*/
public abstract setProperty(name: string, value: string): void;
/**
* Returns the current value of an arbitrary property.
* @member SpeechConfig.prototype.getProperty
* @function
* @public
* @param {string} name - The name of the property to query.
* @param {string} def - The value to return in case the property is not known.
* @returns {string} The current value, or provided default, of the given property.
*/
public abstract getProperty(name: string, def?: string): string;
}
/**
* Represents audio input stream used for custom audio input configurations.
* @private
* @class AudioConfigImpl
*/
export class AudioConfigImpl extends AudioConfig implements IAudioSource {
private privSource: IAudioSource;
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {IAudioSource} source - An audio source.
*/
public constructor(source: IAudioSource) {
super();
this.privSource = source;
}
/**
* Format information for the audio
*/
public get format(): Promise<AudioStreamFormatImpl> {
return this.privSource.format;
}
/**
* @member AudioConfigImpl.prototype.close
* @function
* @public
*/
public close(cb?: () => void, err?: (error: string) => void): void {
this.privSource.turnOff().then((): void => {
if (!!cb) {
cb();
}
}, (error: string): void => {
if (!!err) {
err(error);
}
});
}
/**
* @member AudioConfigImpl.prototype.id
* @function
* @public
*/
public id(): string {
return this.privSource.id();
}
/**
* @member AudioConfigImpl.prototype.turnOn
* @function
* @public
* @returns {Promise<void>} A promise.
*/
public turnOn(): Promise<void> {
return this.privSource.turnOn();
}
/**
* @member AudioConfigImpl.prototype.attach
* @function
* @public
* @param {string} audioNodeId - The audio node id.
* @returns {Promise<IAudioStreamNode>} A promise.
*/
public attach(audioNodeId: string): Promise<IAudioStreamNode> {
return this.privSource.attach(audioNodeId);
}
/**
* @member AudioConfigImpl.prototype.detach
* @function
* @public
* @param {string} audioNodeId - The audio node id.
*/
public detach(audioNodeId: string): void {
return this.privSource.detach(audioNodeId);
}
/**
* @member AudioConfigImpl.prototype.turnOff
* @function
* @public
* @returns {Promise<void>} A promise.
*/
public turnOff(): Promise<void> {
return this.privSource.turnOff();
}
/**
* @member AudioConfigImpl.prototype.events
* @function
* @public
* @returns {EventSource<AudioSourceEvent>} An event source for audio events.
*/
public get events(): EventSource<AudioSourceEvent> {
return this.privSource.events;
}
public setProperty(name: string, value: string): void {
Contracts.throwIfNull(value, "value");
if (undefined !== this.privSource.setProperty) {
this.privSource.setProperty(name, value);
} else {
throw new Error("This AudioConfig instance does not support setting properties.");
}
}
public getProperty(name: string, def?: string): string {
if (undefined !== this.privSource.getProperty) {
return this.privSource.getProperty(name, def);
} else {
throw new Error("This AudioConfig instance does not support getting properties.");
}
return def;
}
public get deviceInfo(): Promise<ISpeechConfigAudioDevice> {
return this.privSource.deviceInfo;
}
}
export class AudioOutputConfigImpl extends AudioConfig implements IAudioDestination {
private privDestination: IAudioDestination;
/**
* Creates and initializes an instance of this class.
* @constructor
* @param {IAudioDestination} destination - An audio destination.
*/
public constructor(destination: IAudioDestination) {
super();
this.privDestination = destination;
}
public set format(format: AudioStreamFormat) {
this.privDestination.format = format;
}
public write(buffer: ArrayBuffer): void {
this.privDestination.write(buffer);
}
public close(): void {
this.privDestination.close();
}
public id(): string {
return this.privDestination.id();
}
public setProperty(): void {
throw new Error("This AudioConfig instance does not support setting properties.");
}
public getProperty(): string {
throw new Error("This AudioConfig instance does not support getting properties.");
}
}