-
Notifications
You must be signed in to change notification settings - Fork 977
/
Buffer.js
572 lines (517 loc) · 14.1 KB
/
Buffer.js
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
import Tone from "../core/Tone";
import "../core/Emitter";
import "../type/Type";
import "../shim/AudioBuffer";
/**
* @class Buffer loading and storage. Tone.Buffer is used internally by all
* classes that make requests for audio files such as Tone.Player,
* Tone.Sampler and Tone.Convolver.
*
* Aside from load callbacks from individual buffers, Tone.Buffer
* provides events which keep track of the loading progress
* of _all_ of the buffers. These are Tone.Buffer.on("load" / "progress" / "error")
*
* @constructor
* @extends {Tone}
* @param {AudioBuffer|String} url The url to load, or the audio buffer to set.
* @param {Function=} onload A callback which is invoked after the buffer is loaded.
* It's recommended to use `Tone.Buffer.on('load', callback)` instead
* since it will give you a callback when _all_ buffers are loaded.
* @param {Function=} onerror The callback to invoke if there is an error
* @example
* var buffer = new Tone.Buffer("path/to/sound.mp3", function(){
* //the buffer is now available.
* var buff = buffer.get();
* });
* @example
* //can load provide fallback extension types if the first type is not supported.
* var buffer = new Tone.Buffer("path/to/sound.[mp3|ogg|wav]");
*/
Tone.Buffer = function(){
var options = Tone.defaults(arguments, ["url", "onload", "onerror"], Tone.Buffer);
Tone.call(this);
/**
* stores the loaded AudioBuffer
* @type {AudioBuffer}
* @private
*/
this._buffer = null;
/**
* indicates if the buffer should be reversed or not
* @type {Boolean}
* @private
*/
this._reversed = options.reverse;
/**
* The XHR
* @type {XMLHttpRequest}
* @private
*/
this._xhr = null;
/**
* Private callback when the buffer is loaded.
* @type {Function}
* @private
*/
this.onload = Tone.noOp;
if (options.url instanceof AudioBuffer || options.url instanceof Tone.Buffer){
this.set(options.url);
if (!this.loaded){
this.onload = options.onload;
}
} else if (Tone.isString(options.url)){
this.load(options.url).then(options.onload).catch(options.onerror);
}
};
Tone.extend(Tone.Buffer);
/**
* the default parameters
* @type {Object}
*/
Tone.Buffer.defaults = {
"url" : undefined,
"reverse" : false,
"onload" : Tone.noOp,
"onerror" : Tone.noOp
};
/**
* Pass in an AudioBuffer or Tone.Buffer to set the value
* of this buffer.
* @param {AudioBuffer|Tone.Buffer} buffer the buffer
* @returns {Tone.Buffer} this
*/
Tone.Buffer.prototype.set = function(buffer){
if (buffer instanceof Tone.Buffer){
//if it's loaded, set it
if (buffer.loaded){
this._buffer = buffer.get();
} else {
//otherwise when it's loaded, invoke it's callback
buffer.onload = function(){
this.set(buffer);
this.onload(this);
}.bind(this);
}
} else {
this._buffer = buffer;
}
//reverse it initially
if (this._reversed){
this._reverse();
}
return this;
};
/**
* @return {AudioBuffer} The audio buffer stored in the object.
*/
Tone.Buffer.prototype.get = function(){
return this._buffer;
};
/**
* Makes an xhr reqest for the selected url then decodes
* the file as an audio buffer. Invokes
* the callback once the audio buffer loads.
* @param {String} url The url of the buffer to load.
* filetype support depends on the
* browser.
* @returns {Promise} returns a Promise which resolves with the Tone.Buffer
*/
Tone.Buffer.prototype.load = function(url, onload, onerror){
var promise = new Promise(function(load, error){
this._xhr = Tone.Buffer.load(url,
//success
function(buff){
this._xhr = null;
this.set(buff);
load(this);
this.onload(this);
if (onload){
onload(this);
}
}.bind(this),
//error
function(err){
this._xhr = null;
error(err);
if (onerror){
onerror(err);
}
}.bind(this));
}.bind(this));
return promise;
};
/**
* dispose and disconnect
* @returns {Tone.Buffer} this
*/
Tone.Buffer.prototype.dispose = function(){
Tone.prototype.dispose.call(this);
this._buffer = null;
if (this._xhr){
Tone.Buffer._removeFromDownloadQueue(this._xhr);
this._xhr.abort();
this._xhr = null;
}
return this;
};
/**
* If the buffer is loaded or not
* @memberOf Tone.Buffer#
* @type {Boolean}
* @name loaded
* @readOnly
*/
Object.defineProperty(Tone.Buffer.prototype, "loaded", {
"get" : function(){
return this.length > 0;
},
});
/**
* The duration of the buffer.
* @memberOf Tone.Buffer#
* @type {Number}
* @name duration
* @readOnly
*/
Object.defineProperty(Tone.Buffer.prototype, "duration", {
"get" : function(){
if (this._buffer){
return this._buffer.duration;
} else {
return 0;
}
},
});
/**
* The length of the buffer in samples
* @memberOf Tone.Buffer#
* @type {Number}
* @name length
* @readOnly
*/
Object.defineProperty(Tone.Buffer.prototype, "length", {
"get" : function(){
if (this._buffer){
return this._buffer.length;
} else {
return 0;
}
},
});
/**
* The number of discrete audio channels. Returns 0 if no buffer
* is loaded.
* @memberOf Tone.Buffer#
* @type {Number}
* @name numberOfChannels
* @readOnly
*/
Object.defineProperty(Tone.Buffer.prototype, "numberOfChannels", {
"get" : function(){
if (this._buffer){
return this._buffer.numberOfChannels;
} else {
return 0;
}
},
});
/**
* Set the audio buffer from the array. To create a multichannel AudioBuffer,
* pass in a multidimensional array.
* @param {Float32Array} array The array to fill the audio buffer
* @return {Tone.Buffer} this
*/
Tone.Buffer.prototype.fromArray = function(array){
var isMultidimensional = array[0].length > 0;
var channels = isMultidimensional ? array.length : 1;
var len = isMultidimensional ? array[0].length : array.length;
var buffer = this.context.createBuffer(channels, len, this.context.sampleRate);
if (!isMultidimensional && channels === 1){
array = [array];
}
for (var c = 0; c < channels; c++){
buffer.copyToChannel(array[c], c);
}
this._buffer = buffer;
return this;
};
/**
* Sums muliple channels into 1 channel
* @param {Number=} channel Optionally only copy a single channel from the array.
* @return {Array}
*/
Tone.Buffer.prototype.toMono = function(chanNum){
if (Tone.isNumber(chanNum)){
this.fromArray(this.toArray(chanNum));
} else {
var outputArray = new Float32Array(this.length);
var numChannels = this.numberOfChannels;
for (var channel = 0; channel < numChannels; channel++){
var channelArray = this.toArray(channel);
for (var i = 0; i < channelArray.length; i++){
outputArray[i] += channelArray[i];
}
}
//divide by the number of channels
outputArray = outputArray.map(function(sample){
return sample / numChannels;
});
this.fromArray(outputArray);
}
return this;
};
/**
* Get the buffer as an array. Single channel buffers will return a 1-dimensional
* Float32Array, and multichannel buffers will return multidimensional arrays.
* @param {Number=} channel Optionally only copy a single channel from the array.
* @return {Array}
*/
Tone.Buffer.prototype.toArray = function(channel){
if (Tone.isNumber(channel)){
return this.getChannelData(channel);
} else if (this.numberOfChannels === 1){
return this.toArray(0);
} else {
var ret = [];
for (var c = 0; c < this.numberOfChannels; c++){
ret[c] = this.getChannelData(c);
}
return ret;
}
};
/**
* Returns the Float32Array representing the PCM audio data for the specific channel.
* @param {Number} channel The channel number to return
* @return {Float32Array} The audio as a TypedArray
*/
Tone.Buffer.prototype.getChannelData = function(channel){
return this._buffer.getChannelData(channel);
};
/**
* Cut a subsection of the array and return a buffer of the
* subsection. Does not modify the original buffer
* @param {Time} start The time to start the slice
* @param {Time=} end The end time to slice. If none is given
* will default to the end of the buffer
* @return {Tone.Buffer} this
*/
Tone.Buffer.prototype.slice = function(start, end){
end = Tone.defaultArg(end, this.duration);
var startSamples = Math.floor(this.context.sampleRate * this.toSeconds(start));
var endSamples = Math.floor(this.context.sampleRate * this.toSeconds(end));
var replacement = [];
for (var i = 0; i < this.numberOfChannels; i++){
replacement[i] = this.toArray(i).slice(startSamples, endSamples);
}
var retBuffer = new Tone.Buffer().fromArray(replacement);
return retBuffer;
};
/**
* Reverse the buffer.
* @private
* @return {Tone.Buffer} this
*/
Tone.Buffer.prototype._reverse = function(){
if (this.loaded){
for (var i = 0; i < this.numberOfChannels; i++){
Array.prototype.reverse.call(this.getChannelData(i));
}
}
return this;
};
/**
* Reverse the buffer.
* @memberOf Tone.Buffer#
* @type {Boolean}
* @name reverse
*/
Object.defineProperty(Tone.Buffer.prototype, "reverse", {
"get" : function(){
return this._reversed;
},
"set" : function(rev){
if (this._reversed !== rev){
this._reversed = rev;
this._reverse();
}
},
});
///////////////////////////////////////////////////////////////////////////
// STATIC METHODS
///////////////////////////////////////////////////////////////////////////
//statically inherits Emitter methods
Tone.Emitter.mixin(Tone.Buffer);
/**
* the static queue for all of the xhr requests
* @type {Array}
* @private
*/
Tone.Buffer._downloadQueue = [];
/**
* A path which is prefixed before every url.
* @type {String}
* @static
*/
Tone.Buffer.baseUrl = "";
/**
* Create a Tone.Buffer from the array. To create a multichannel AudioBuffer,
* pass in a multidimensional array.
* @param {Float32Array} array The array to fill the audio buffer
* @return {Tone.Buffer} A Tone.Buffer created from the array
*/
Tone.Buffer.fromArray = function(array){
return (new Tone.Buffer()).fromArray(array);
};
/**
* Creates a Tone.Buffer from a URL, returns a promise
* which resolves to a Tone.Buffer
* @param {String} url The url to load.
* @return {Promise<Tone.Buffer>} A promise which resolves to a Tone.Buffer
*/
Tone.Buffer.fromUrl = function(url){
var buffer = new Tone.Buffer();
return buffer.load(url).then(function(){
return buffer;
});
};
/**
* Remove an xhr request from the download queue
* @private
*/
Tone.Buffer._removeFromDownloadQueue = function(request){
var index = Tone.Buffer._downloadQueue.indexOf(request);
if (index !== -1){
Tone.Buffer._downloadQueue.splice(index, 1);
}
};
/**
* Loads a url using XMLHttpRequest.
* @param {String} url
* @param {Function} onload
* @param {Function} onerror
* @param {Function} onprogress
* @return {XMLHttpRequest}
*/
Tone.Buffer.load = function(url, onload, onerror){
//default
onload = Tone.defaultArg(onload, Tone.noOp);
// test if the url contains multiple extensions
var matches = url.match(/\[(.+\|?)+\]$/);
if (matches){
var extensions = matches[1].split("|");
var extension = extensions[0];
for (var i = 0; i < extensions.length; i++){
if (Tone.Buffer.supportsType(extensions[i])){
extension = extensions[i];
break;
}
}
url = url.replace(matches[0], extension);
}
function onError(e){
Tone.Buffer._removeFromDownloadQueue(request);
Tone.Buffer.emit("error", e);
if (onerror){
onerror(e);
} else {
throw e;
}
}
function onProgress(){
//calculate the progress
var totalProgress = 0;
for (var i = 0; i < Tone.Buffer._downloadQueue.length; i++){
totalProgress += Tone.Buffer._downloadQueue[i].progress;
}
Tone.Buffer.emit("progress", totalProgress / Tone.Buffer._downloadQueue.length);
}
var request = new XMLHttpRequest();
request.open("GET", Tone.Buffer.baseUrl + url, true);
request.responseType = "arraybuffer";
//start out as 0
request.progress = 0;
Tone.Buffer._downloadQueue.push(request);
request.addEventListener("load", function(){
if (request.status === 200){
Tone.context.decodeAudioData(request.response).then(function(buff){
request.progress = 1;
onProgress();
onload(buff);
Tone.Buffer._removeFromDownloadQueue(request);
if (Tone.Buffer._downloadQueue.length === 0){
//emit the event at the end
Tone.Buffer.emit("load");
}
}).catch(function(){
Tone.Buffer._removeFromDownloadQueue(request);
onError("Tone.Buffer: could not decode audio data: "+url);
});
} else {
onError("Tone.Buffer: could not locate file: "+url);
}
});
request.addEventListener("error", onError);
request.addEventListener("progress", function(event){
if (event.lengthComputable){
//only go to 95%, the last 5% is when the audio is decoded
request.progress = (event.loaded / event.total) * 0.95;
onProgress();
}
});
request.send();
return request;
};
/**
* Stop all of the downloads in progress
* @return {Tone.Buffer}
* @static
*/
Tone.Buffer.cancelDownloads = function(){
Tone.Buffer._downloadQueue.slice().forEach(function(request){
Tone.Buffer._removeFromDownloadQueue(request);
request.abort();
});
return Tone.Buffer;
};
/**
* Checks a url's extension to see if the current browser can play that file type.
* @param {String} url The url/extension to test
* @return {Boolean} If the file extension can be played
* @static
* @example
* Tone.Buffer.supportsType("wav"); //returns true
* Tone.Buffer.supportsType("path/to/file.wav"); //returns true
*/
Tone.Buffer.supportsType = function(url){
var extension = url.split(".");
extension = extension[extension.length - 1];
var response = document.createElement("audio").canPlayType("audio/"+extension);
return response !== "";
};
/**
* Returns a Promise which resolves when all of the buffers have loaded
* @return {Promise}
*/
Tone.loaded = function(){
var onload, onerror;
function removeEvents(){
//remove the events when it's resolved
Tone.Buffer.off("load", onload);
Tone.Buffer.off("error", onerror);
}
return new Promise(function(success, fail){
onload = function(){
success();
};
onerror = function(){
fail();
};
//add the event listeners
Tone.Buffer.on("load", onload);
Tone.Buffer.on("error", onerror);
}).then(removeEvents).catch(function(e){
removeEvents();
throw new Error(e);
});
};
export default Tone.Buffer;