-
Notifications
You must be signed in to change notification settings - Fork 977
/
ToneEvent.ts
394 lines (358 loc) · 10.4 KB
/
ToneEvent.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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
import "../core/clock/Transport";
import { ToneWithContext, ToneWithContextOptions } from "../core/context/ToneWithContext";
import { TicksClass } from "../core/type/Ticks";
import { TransportTimeClass } from "../core/type/TransportTime";
import { NormalRange, Positive, Seconds, Ticks, Time, TransportTime } from "../core/type/Units";
import { defaultArg, optionsFromArguments } from "../core/util/Defaults";
import { noOp } from "../core/util/Interface";
import { BasicPlaybackState, StateTimeline } from "../core/util/StateTimeline";
import { isBoolean, isNumber } from "../core/util/TypeCheck";
export type ToneEventCallback<T> = (time: Seconds, value: T) => void;
export interface ToneEventOptions<T> extends ToneWithContextOptions {
callback: ToneEventCallback<T>;
loop: boolean | number;
loopEnd: Time;
loopStart: Time;
playbackRate: Positive;
value?: T;
probability: NormalRange;
mute: boolean;
humanize: boolean | Time;
}
/**
* ToneEvent abstracts away this.context.transport.schedule and provides a schedulable
* callback for a single or repeatable events along the timeline.
*
* @example
* const synth = new Tone.PolySynth().toDestination();
* const chordEvent = new Tone.ToneEvent(((time, chord) => {
* // the chord as well as the exact time of the event
* // are passed in as arguments to the callback function
* synth.triggerAttackRelease(chord, 0.5, time);
* }), ["D4", "E4", "F4"]);
* // start the chord at the beginning of the transport timeline
* chordEvent.start();
* // loop it every measure for 8 measures
* chordEvent.loop = 8;
* chordEvent.loopEnd = "1m";
* @category Event
*/
export class ToneEvent<ValueType = any> extends ToneWithContext<ToneEventOptions<ValueType>> {
readonly name: string = "ToneEvent";
/**
* Loop value
*/
protected _loop: boolean | number;
/**
* The callback to invoke.
*/
callback: ToneEventCallback<ValueType>;
/**
* The value which is passed to the
* callback function.
*/
value: ValueType;
/**
* When the note is scheduled to start.
*/
protected _loopStart: Ticks;
/**
* When the note is scheduled to start.
*/
protected _loopEnd: Ticks;
/**
* Tracks the scheduled events
*/
protected _state: StateTimeline<{
id: number;
}> = new StateTimeline("stopped");
/**
* The playback speed of the note. A speed of 1
* is no change.
*/
protected _playbackRate: Positive;
/**
* A delay time from when the event is scheduled to start
*/
protected _startOffset: Ticks = 0;
/**
* private holder of probability value
*/
protected _probability: NormalRange;
/**
* the amount of variation from the given time.
*/
protected _humanize: boolean | Time;
/**
* If mute is true, the callback won't be invoked.
*/
mute: boolean;
/**
* @param callback The callback to invoke at the time.
* @param value The value or values which should be passed to the callback function on invocation.
*/
constructor(callback?: ToneEventCallback<ValueType>, value?: ValueType);
constructor(options?: Partial<ToneEventOptions<ValueType>>);
constructor() {
super(optionsFromArguments(ToneEvent.getDefaults(), arguments, ["callback", "value"]));
const options = optionsFromArguments(ToneEvent.getDefaults(), arguments, ["callback", "value"]);
this._loop = options.loop;
this.callback = options.callback;
this.value = options.value;
this._loopStart = this.toTicks(options.loopStart);
this._loopEnd = this.toTicks(options.loopEnd);
this._playbackRate = options.playbackRate;
this._probability = options.probability;
this._humanize = options.humanize;
this.mute = options.mute;
this._playbackRate = options.playbackRate;
this._state.increasing = true;
// schedule the events for the first time
this._rescheduleEvents();
}
static getDefaults(): ToneEventOptions<any> {
return Object.assign(ToneWithContext.getDefaults(), {
callback: noOp,
humanize: false,
loop: false,
loopEnd: "1m",
loopStart: 0,
mute: false,
playbackRate: 1,
probability: 1,
value: null,
});
}
/**
* Reschedule all of the events along the timeline
* with the updated values.
* @param after Only reschedules events after the given time.
*/
private _rescheduleEvents(after: Ticks = -1): void {
// if no argument is given, schedules all of the events
this._state.forEachFrom(after, event => {
let duration;
if (event.state === "started") {
if (event.id !== -1) {
this.context.transport.clear(event.id);
}
const startTick = event.time + Math.round(this.startOffset / this._playbackRate);
if (this._loop === true || isNumber(this._loop) && this._loop > 1) {
duration = Infinity;
if (isNumber(this._loop)) {
duration = (this._loop) * this._getLoopDuration();
}
const nextEvent = this._state.getAfter(startTick);
if (nextEvent !== null) {
duration = Math.min(duration, nextEvent.time - startTick);
}
if (duration !== Infinity) {
// schedule a stop since it's finite duration
this._state.setStateAtTime("stopped", startTick + duration + 1, { id: -1 });
duration = new TicksClass(this.context, duration);
}
const interval = new TicksClass(this.context, this._getLoopDuration());
event.id = this.context.transport.scheduleRepeat(
this._tick.bind(this), interval, new TicksClass(this.context, startTick), duration);
} else {
event.id = this.context.transport.schedule(this._tick.bind(this), new TicksClass(this.context, startTick));
}
}
});
}
/**
* Returns the playback state of the note, either "started" or "stopped".
*/
get state(): BasicPlaybackState {
return this._state.getValueAtTime(this.context.transport.ticks) as BasicPlaybackState;
}
/**
* The start from the scheduled start time.
*/
get startOffset(): Ticks {
return this._startOffset;
}
set startOffset(offset) {
this._startOffset = offset;
}
/**
* The probability of the notes being triggered.
*/
get probability(): NormalRange {
return this._probability;
}
set probability(prob) {
this._probability = prob;
}
/**
* If set to true, will apply small random variation
* to the callback time. If the value is given as a time, it will randomize
* by that amount.
* @example
* const event = new Tone.ToneEvent();
* event.humanize = true;
*/
get humanize(): Time | boolean {
return this._humanize;
}
set humanize(variation) {
this._humanize = variation;
}
/**
* Start the note at the given time.
* @param time When the event should start.
*/
start(time?: TransportTime | TransportTimeClass): this {
const ticks = this.toTicks(time);
if (this._state.getValueAtTime(ticks) === "stopped") {
this._state.add({
id: -1,
state: "started",
time: ticks,
});
this._rescheduleEvents(ticks);
}
return this;
}
/**
* Stop the Event at the given time.
* @param time When the event should stop.
*/
stop(time?: TransportTime | TransportTimeClass): this {
this.cancel(time);
const ticks = this.toTicks(time);
if (this._state.getValueAtTime(ticks) === "started") {
this._state.setStateAtTime("stopped", ticks, { id: -1 });
const previousEvent = this._state.getBefore(ticks);
let reschedulTime = ticks;
if (previousEvent !== null) {
reschedulTime = previousEvent.time;
}
this._rescheduleEvents(reschedulTime);
}
return this;
}
/**
* Cancel all scheduled events greater than or equal to the given time
* @param time The time after which events will be cancel.
*/
cancel(time?: TransportTime | TransportTimeClass): this {
time = defaultArg(time, -Infinity);
const ticks = this.toTicks(time);
this._state.forEachFrom(ticks, event => {
this.context.transport.clear(event.id);
});
this._state.cancel(ticks);
return this;
}
/**
* The callback function invoker. Also
* checks if the Event is done playing
* @param time The time of the event in seconds
*/
protected _tick(time: Seconds): void {
const ticks = this.context.transport.getTicksAtTime(time);
if (!this.mute && this._state.getValueAtTime(ticks) === "started") {
if (this.probability < 1 && Math.random() > this.probability) {
return;
}
if (this.humanize) {
let variation = 0.02;
if (!isBoolean(this.humanize)) {
variation = this.toSeconds(this.humanize);
}
time += (Math.random() * 2 - 1) * variation;
}
this.callback(time, this.value);
}
}
/**
* Get the duration of the loop.
*/
protected _getLoopDuration(): Ticks {
return Math.round((this._loopEnd - this._loopStart) / this._playbackRate);
}
/**
* If the note should loop or not
* between ToneEvent.loopStart and
* ToneEvent.loopEnd. If set to true,
* the event will loop indefinitely,
* if set to a number greater than 1
* it will play a specific number of
* times, if set to false, 0 or 1, the
* part will only play once.
*/
get loop(): boolean | number {
return this._loop;
}
set loop(loop) {
this._loop = loop;
this._rescheduleEvents();
}
/**
* The playback rate of the note. Defaults to 1.
* @example
* const note = new Tone.ToneEvent();
* note.loop = true;
* // repeat the note twice as fast
* note.playbackRate = 2;
*/
get playbackRate(): Positive {
return this._playbackRate;
}
set playbackRate(rate) {
this._playbackRate = rate;
this._rescheduleEvents();
}
/**
* The loopEnd point is the time the event will loop
* if ToneEvent.loop is true.
*/
get loopEnd(): Time {
return new TicksClass(this.context, this._loopEnd).toSeconds();
}
set loopEnd(loopEnd) {
this._loopEnd = this.toTicks(loopEnd);
if (this._loop) {
this._rescheduleEvents();
}
}
/**
* The time when the loop should start.
*/
get loopStart(): Time {
return new TicksClass(this.context, this._loopStart).toSeconds();
}
set loopStart(loopStart) {
this._loopStart = this.toTicks(loopStart);
if (this._loop) {
this._rescheduleEvents();
}
}
/**
* The current progress of the loop interval.
* Returns 0 if the event is not started yet or
* it is not set to loop.
*/
get progress(): NormalRange {
if (this._loop) {
const ticks = this.context.transport.ticks;
const lastEvent = this._state.get(ticks);
if (lastEvent !== null && lastEvent.state === "started") {
const loopDuration = this._getLoopDuration();
const progress = (ticks - lastEvent.time) % loopDuration;
return progress / loopDuration;
} else {
return 0;
}
} else {
return 0;
}
}
dispose(): this {
super.dispose();
this.cancel();
this._state.dispose();
return this;
}
}