-
Notifications
You must be signed in to change notification settings - Fork 977
/
Source.ts
339 lines (313 loc) · 10.1 KB
/
Source.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
import { Volume } from "../component/channel/Volume";
import "../core/context/Destination";
import "../core/clock/Transport";
import { Param } from "../core/context/Param";
import { OutputNode, ToneAudioNode, ToneAudioNodeOptions } from "../core/context/ToneAudioNode";
import { Decibels, Seconds, Time } from "../core/type/Units";
import { defaultArg } from "../core/util/Defaults";
import { noOp, readOnly } from "../core/util/Interface";
import { BasicPlaybackState, StateTimeline, StateTimelineEvent } from "../core/util/StateTimeline";
import { isDefined, isUndef } from "../core/util/TypeCheck";
import { assert, assertContextRunning } from "../core/util/Debug";
import { GT } from "../core/util/Math";
type onStopCallback = (source: Source<any>) => void;
export interface SourceOptions extends ToneAudioNodeOptions {
volume: Decibels;
mute: boolean;
onstop: onStopCallback;
}
/**
* Base class for sources.
* start/stop of this.context.transport.
*
* ```
* // Multiple state change events can be chained together,
* // but must be set in the correct order and with ascending times
* // OK
* state.start().stop("+0.2");
* // OK
* state.start().stop("+0.2").start("+0.4").stop("+0.7")
* // BAD
* state.stop("+0.2").start();
* // BAD
* state.start("+0.3").stop("+0.2");
* ```
*/
export abstract class Source<Options extends SourceOptions> extends ToneAudioNode<Options> {
/**
* The output volume node
*/
private _volume: Volume;
/**
* The output note
*/
output: OutputNode;
/**
* Sources have no inputs
*/
input = undefined;
/**
* The volume of the output in decibels.
* @example
* const source = new Tone.PWMOscillator().toDestination();
* source.volume.value = -6;
*/
volume: Param<"decibels">;
/**
* The callback to invoke when the source is stopped.
*/
onstop: onStopCallback;
/**
* Keep track of the scheduled state.
*/
protected _state: StateTimeline<{
duration?: Seconds;
offset?: Seconds;
/**
* Either the buffer is explicitly scheduled to end using the stop method,
* or it's implicitly ended when the buffer is over.
*/
implicitEnd?: boolean;
}> = new StateTimeline("stopped");
/**
* The synced `start` callback function from the transport
*/
protected _synced = false;
/**
* Keep track of all of the scheduled event ids
*/
private _scheduled: number[] = [];
/**
* Placeholder functions for syncing/unsyncing to transport
*/
private _syncedStart: (time: Seconds, offset: Seconds) => void = noOp;
private _syncedStop: (time: Seconds) => void = noOp;
constructor(options: SourceOptions) {
super(options);
this._state.memory = 100;
this._state.increasing = true;
this._volume = this.output = new Volume({
context: this.context,
mute: options.mute,
volume: options.volume,
});
this.volume = this._volume.volume;
readOnly(this, "volume");
this.onstop = options.onstop;
}
static getDefaults(): SourceOptions {
return Object.assign(ToneAudioNode.getDefaults(), {
mute: false,
onstop: noOp,
volume: 0,
});
}
/**
* Returns the playback state of the source, either "started" or "stopped".
* @example
* const player = new Tone.Player("https://tonejs.github.io/audio/berklee/ahntone_c3.mp3", () => {
* player.start();
* console.log(player.state);
* }).toDestination();
*/
get state(): BasicPlaybackState {
if (this._synced) {
if (this.context.transport.state === "started") {
return this._state.getValueAtTime(this.context.transport.seconds) as BasicPlaybackState;
} else {
return "stopped";
}
} else {
return this._state.getValueAtTime(this.now()) as BasicPlaybackState;
}
}
/**
* Mute the output.
* @example
* const osc = new Tone.Oscillator().toDestination().start();
* // mute the output
* osc.mute = true;
*/
get mute(): boolean {
return this._volume.mute;
}
set mute(mute: boolean) {
this._volume.mute = mute;
}
// overwrite these functions
protected abstract _start(time: Time, offset?: Time, duration?: Time): void;
protected abstract _stop(time: Time): void;
protected abstract _restart(time: Seconds, offset?: Time, duration?: Time): void;
/**
* Ensure that the scheduled time is not before the current time.
* Should only be used when scheduled unsynced.
*/
private _clampToCurrentTime(time: Seconds): Seconds {
if (this._synced) {
return time;
} else {
return Math.max(time, this.context.currentTime);
}
}
/**
* Start the source at the specified time. If no time is given,
* start the source now.
* @param time When the source should be started.
* @example
* const source = new Tone.Oscillator().toDestination();
* source.start("+0.5"); // starts the source 0.5 seconds from now
*/
start(time?: Time, offset?: Time, duration?: Time): this {
let computedTime = isUndef(time) && this._synced ? this.context.transport.seconds : this.toSeconds(time);
computedTime = this._clampToCurrentTime(computedTime);
// if it's started, stop it and restart it
if (!this._synced && this._state.getValueAtTime(computedTime) === "started") {
// time should be strictly greater than the previous start time
assert(GT(computedTime, (this._state.get(computedTime) as StateTimelineEvent).time), "Start time must be strictly greater than previous start time");
this._state.cancel(computedTime);
this._state.setStateAtTime("started", computedTime);
this.log("restart", computedTime);
this.restart(computedTime, offset, duration);
} else {
this.log("start", computedTime);
this._state.setStateAtTime("started", computedTime);
if (this._synced) {
// add the offset time to the event
const event = this._state.get(computedTime);
if (event) {
event.offset = this.toSeconds(defaultArg(offset, 0));
event.duration = duration ? this.toSeconds(duration) : undefined;
}
const sched = this.context.transport.schedule(t => {
this._start(t, offset, duration);
}, computedTime);
this._scheduled.push(sched);
// if the transport is already started
// and the time is greater than where the transport is
if (this.context.transport.state === "started" &&
this.context.transport.getSecondsAtTime(this.immediate()) > computedTime) {
this._syncedStart(this.now(), this.context.transport.seconds);
}
} else {
assertContextRunning(this.context);
this._start(computedTime, offset, duration);
}
}
return this;
}
/**
* Stop the source at the specified time. If no time is given,
* stop the source now.
* @param time When the source should be stopped.
* @example
* const source = new Tone.Oscillator().toDestination();
* source.start();
* source.stop("+0.5"); // stops the source 0.5 seconds from now
*/
stop(time?: Time): this {
let computedTime = isUndef(time) && this._synced ? this.context.transport.seconds : this.toSeconds(time);
computedTime = this._clampToCurrentTime(computedTime);
if (this._state.getValueAtTime(computedTime) === "started" || isDefined(this._state.getNextState("started", computedTime))) {
this.log("stop", computedTime);
if (!this._synced) {
this._stop(computedTime);
} else {
const sched = this.context.transport.schedule(this._stop.bind(this), computedTime);
this._scheduled.push(sched);
}
this._state.cancel(computedTime);
this._state.setStateAtTime("stopped", computedTime);
}
return this;
}
/**
* Restart the source.
*/
restart(time?: Time, offset?: Time, duration?: Time): this {
time = this.toSeconds(time);
if (this._state.getValueAtTime(time) === "started") {
this._state.cancel(time);
this._restart(time, offset, duration);
}
return this;
}
/**
* Sync the source to the Transport so that all subsequent
* calls to `start` and `stop` are synced to the TransportTime
* instead of the AudioContext time.
*
* @example
* const osc = new Tone.Oscillator().toDestination();
* // sync the source so that it plays between 0 and 0.3 on the Transport's timeline
* osc.sync().start(0).stop(0.3);
* // start the transport.
* Tone.Transport.start();
* // set it to loop once a second
* Tone.Transport.loop = true;
* Tone.Transport.loopEnd = 1;
*/
sync(): this {
if (!this._synced) {
this._synced = true;
this._syncedStart = (time, offset) => {
if (offset > 0) {
// get the playback state at that time
const stateEvent = this._state.get(offset);
// listen for start events which may occur in the middle of the sync'ed time
if (stateEvent && stateEvent.state === "started" && stateEvent.time !== offset) {
// get the offset
const startOffset = offset - this.toSeconds(stateEvent.time);
let duration: number | undefined;
if (stateEvent.duration) {
duration = this.toSeconds(stateEvent.duration) - startOffset;
}
this._start(time, this.toSeconds(stateEvent.offset) + startOffset, duration);
}
}
};
this._syncedStop = time => {
const seconds = this.context.transport.getSecondsAtTime(Math.max(time - this.sampleTime, 0));
if (this._state.getValueAtTime(seconds) === "started") {
this._stop(time);
}
};
this.context.transport.on("start", this._syncedStart);
this.context.transport.on("loopStart", this._syncedStart);
this.context.transport.on("stop", this._syncedStop);
this.context.transport.on("pause", this._syncedStop);
this.context.transport.on("loopEnd", this._syncedStop);
}
return this;
}
/**
* Unsync the source to the Transport. See Source.sync
*/
unsync(): this {
if (this._synced) {
this.context.transport.off("stop", this._syncedStop);
this.context.transport.off("pause", this._syncedStop);
this.context.transport.off("loopEnd", this._syncedStop);
this.context.transport.off("start", this._syncedStart);
this.context.transport.off("loopStart", this._syncedStart);
}
this._synced = false;
// clear all of the scheduled ids
this._scheduled.forEach(id => this.context.transport.clear(id));
this._scheduled = [];
this._state.cancel(0);
// stop it also
this._stop(0);
return this;
}
/**
* Clean up.
*/
dispose(): this {
super.dispose();
this.onstop = noOp;
this.unsync();
this._volume.dispose();
this._state.dispose();
return this;
}
}