added modules/shared/common.js and improved some logging

Author: fquirin

src/modules/example-processor.js

@@ -1,4 +1,6 @@
-//import { RingBuffer } from './shared/ring-buffer.js';		//not yet supported by FF :-( (Dec 2020)
+//TODO: not yet supported by FF :-( (Dec 2020)
+//import { SampleSizeException } from './shared/common.js';
+//import { RingBuffer } from './shared/ring-buffer.js';
 class RingBuffer{constructor(a,b,c){this._readIndex=0,this._writeIndex=0,this._framesAvailable=0,this._channelCount=b,this._length=a,this._channelData=[];for(let d=0;d<this._channelCount;++d)this._channelData[d]="Uint16"==c?new Uint16Array(a):"Int16"==c?new Int16Array(a):"Uint8"==c?new Uint8Array(a):"Int8"==c?new Int8Array(a):new Float32Array(a)}get framesAvailable(){return this._framesAvailable}push(a){let b=a[0].length;for(let c,d=0;d<b;++d){c=(this._writeIndex+d)%this._length;for(let b=0;b<this._channelCount;++b)this._channelData[b][c]=a[b][d]}this._writeIndex+=b,this._writeIndex>=this._length&&(this._writeIndex-=this._length),this._framesAvailable+=b,this._framesAvailable>this._length&&(this._framesAvailable=this._length)}pull(a){if(0!==this._framesAvailable){let b=a[0].length;for(let c,d=0;d<b;++d){c=(this._readIndex+d)%this._length;for(let b=0;b<this._channelCount;++b)a[b][d]=this._channelData[b][c]}this._readIndex+=b,this._readIndex>=this._length&&(this._readIndex-=this._length),this._framesAvailable-=b,0>this._framesAvailable&&(this._framesAvailable=0)}}};
 
 var someExampleVar;

src/modules/example-worker.js

@@ -1,4 +1,5 @@
 //imports
+importScripts('./shared/common.js');
 importScripts('./shared/ring-buffer.min.js');
 
 onmessage = function(e) {

src/modules/shared/common.js

@@ -0,0 +1,29 @@
+//Exceptions / Errors
+
+function SampleRateException(message) {
+	this.message = message;
+	this.name = "SampleRateException";
+}
+function ArrayTypeException(message) {
+	this.message = message;
+	this.name = "ArrayTypeException";
+}
+function SampleSizeException(message){
+	this.message = message;
+	this.name = "SampleSizeException";
+}
+function BufferSizeException(message){
+	this.message = message;
+	this.name = "BufferSizeException";
+}
+
+//Converters
+
+var CommonConverters = {};
+
+CommonConverters.floatTo16BitPCM = function (output, input){
+	for (let i = 0; i < input.length; i++) {
+		let s = Math.max(-1, Math.min(1, input[i]));
+		output[i] = s < 0 ? s * 0x8000 : s * 0x7FFF;
+	}
+}

src/modules/speex-resample-worker.js

@@ -1,4 +1,5 @@
 //imports
+importScripts('./shared/common.js');
 importScripts('./shared/ring-buffer.min.js');
 importScripts('./shared/speex-resampler-interface.min.js');
 importScripts('./shared/speex-resampler-wasm.js');
@@ -117,21 +118,26 @@ function constructWorker(options) {
 	resampleRatio = targetSampleRate/sourceSamplerate;
 	init();
 
+	function onSpeexLog(msg){
+		console.error("SpeexModuleLog -", msg);			//DEBUG (use postMessage?)
+	}
+	//function onSpeexError(msg){}		//TODO: we could wrap the 'resampler.processChunk' function in try-catch and log the error here
+	
 	//prepare
 	if (resamplingMode){
 		if (!speexModule){
-			console.error("Init Speex");			//DEBUG
+			onSpeexLog("Init. Speex WASM module");
 			SpeexResampler.initPromise = Speex().then(function(s){
-				console.error("Speex ready");		//DEBUG
-				speexModule = s;
+				onSpeexLog("Speex WASM module ready");
+				speexModule = s;	//NOTE: used inside Speex
 				ready(false);
 			});
 		}else{
-			console.error("Speex already there");	//DEBUG
+			onSpeexLog("Speex WASM moduel already loaded");
 			ready(false);
 		}
 	}else{
-		console.error("Speex not needed");			//DEBUG
+		onSpeexLog("Speex WASM module not needed");
 		ready(true);
 	}
 }
@@ -202,7 +208,6 @@ function process(data) {
 			});
 		}
 	}
-	return true;
 }
 
 function handleEvent(data){
@@ -242,19 +247,11 @@ function release(options){
 	_newInputBuffer = null;
 	_newOutputBuffer = null;
 	resampler = null;
+	speexModule = null;
 }
 
 //--- helpers ---
 
-function SampleSizeException(message){
-	this.message = message;
-	this.name = "SampleSizeException";
-}
-function BufferSizeException(message){
-	this.message = message;
-	this.name = "BufferSizeException";
-}
-
 function floatTo16BitInterleavedPCM(inFloat32, outInt16, i){
 	let sampleVal = Math.max(-1, Math.min(1, inFloat32[0][i]));		//we need -1 to 1 - If this is the first processor we could skip clipping
 	outInt16[0][i] = sampleVal < 0 ? sampleVal * 0x8000 : sampleVal * 0x7FFF;

src/modules/wave-encoder-worker.js

@@ -36,20 +36,33 @@ onmessage = function(e) {
 	//custom interface
 	if (e.data.gate != undefined){
 		console.error("Message", e.data);			//DEBUG
-		gateControl(e.data.gate && e.data.gate == "open");
+		gateControl(e.data.gate && e.data.gate == "open", e.data.gateOptions);
 	}
 	if (e.data.request){
 		console.error("Message", e.data);			//DEBUG
-		switch (e.data.request.get){
-			case "buffer":
-				getBuffer(e.data.request.start, e.data.request.end);
-				break;
-			case "wave":
-				getWave(e.data.request.start, e.data.request.end);
-				break;
-			default:
-				console.log("Unknown request message:", e.data);
-				break;
+		if (e.data.request.get){
+			switch (e.data.request.get){
+				case "buffer":
+					getBuffer(e.data.request.start, e.data.request.end);
+					break;
+				case "wave":
+					getWave(e.data.request.start, e.data.request.end);
+					break;
+				default:
+					console.log("Unknown request message:", e.data);
+					break;
+			}
+		}else if (e.data.request.clear){
+			switch (e.data.request.clear){
+				case "buffer":
+					//TODO: clear buffer and release lookback lock
+					break;
+				default:
+					console.log("Unknown request message:", e.data);
+					break;
+			}
+		}else{
+			console.log("Unknown request message:", e.data);
 		}
 	}else if (e.data.encode && e.data.encode.data){
 		encodeInterface(e.data.encode);
@@ -145,7 +158,8 @@ function encodeInterface(e){
 	}
 }
 
-function gateControl(open){
+function gateControl(open, gateOptions){
+	if (!gateOptions) gateOptions = {}; 		//TODO: use e.g. for (lookbackBufferNeedsReset = false)
 	var msg = {
 		moduleEvent: true,		//use 'moduleEvent' to distinguish from normal processing result
 		gate: {}
@@ -197,6 +211,7 @@ function constructWorker(options){
 		moduleInfo: {
 			inputSampleRate: inputSampleRate,
 			inputSampleSize: inputSampleSize,
+			inputIsFloat32: isFloat32Input,
 			channelCount: channelCount,
 			lookbackBufferSizeKb: Math.ceil((_lookbackBufferSize * 2)/1024),	//1 sample = 2 bytes
 			lookbackLimitMs: lookbackBufferMs,
@@ -210,21 +225,21 @@ function process(data){
 	//TODO: check process values against constructor values (sampleSize etc.)
 	if (data && data.samples){
 		if (_isFirstValidProcess){
+			//console.error("data info", data);		//DEBUG
 			_isFirstValidProcess = false;
-			console.error("data info", data);		//DEBUG
 			//check: inputSampleRate, inputSampleSize, channelCount, float32
 			if (data.sampleRate != inputSampleRate){
 				var msg = "Sample-rate mismatch! Should be '" + inputSampleRate + "' is '" + data.sampleRate + "'";
 				console.error("Audio Worker sample-rate exception - Msg.: " + msg);
-				throw new SampleRateException(msg);		//TODO: this probably needs to be a string to show up in worker.onerror properly :-/
+				throw JSON.stringify(new SampleRateException(msg));			//NOTE: this needs to be a string to show up in worker.onerror properly :-/
 				return;
 			}
-			var inputArrayType = data.samples[0].constructor.name;
+			var inputArrayType = data.type || data.samples[0].constructor.name;
 			var isFloat32 = (inputArrayType.indexOf("Float32") >= 0);
 			if (isFloat32 != isFloat32Input){
 				var msg = "Array type mismatch! Input samples are of type '" + inputArrayType + "' but expected: " + (isFloat32Input? "Float32" : "Int16");
 				console.error("Audio Worker type exception - Msg.: " + msg);
-				throw new ArrayTypeException(msg);		//TODO: this probably needs to be a string to show up in worker.onerror properly :-/
+				throw JSON.stringify(new ArrayTypeException(msg));			//NOTE: this needs to be a string to show up in worker.onerror properly :-/
 				return;
 			}
 			//TODO: should we re-init. instead of fail?
@@ -295,6 +310,7 @@ function buildBuffer(start, end){
 		_lookbackRingBuffer.pull(lookbackSamples);
 	}
 	var dataLength = recordedBuffers.length * inputSampleSize + (lookbackSamples? lookbackSamples[0].length : 0);
+	//TODO: any chance to allocate 'collectBuffer' in advance and keep it? (max. rec + lookback maybe?)
 	var collectBuffer = isFloat32? new Float32Array(dataLength) : new Int16Array(dataLength); 	//TODO: this is usually too big because the last buffer is not full ...
 	var n = 0;
 	if (lookbackSamples){
@@ -316,6 +332,7 @@ function buildBuffer(start, end){
 		isFloat32: isFloat32
 	}
 	//TODO: we clear lookback buffer here ... so we should clear everything
+	lookbackBufferNeedsReset = false;
 }
 
 function encodeWAV(samples, sampleRate, numChannels, convertFromFloat32){

src/processor.js

@@ -1093,7 +1093,7 @@ if (!(typeof SepiaFW == "object")){
 			var offlineAudioContext = new OfflineAudioContext(channels, buffer.length, inputSampleRate);	//we just need this to setup the module
 			var moduleFolder = WebAudio.defaultProcessorOptions.moduleFolder.replace(/\/$/, "") + "/";
 			var moduleName = "speex-resample-switch";
-			offlineAudioContext.audioWorklet.addModule(moduleFolder + moduleName + ".js").then(function(){
+			offlineAudioContext.audioWorklet.addModule(moduleFolder + moduleName + ".js").then(function(){	//NOTE: if the folder is wrong this can fail with poor error message
 				var options = {
 					processorOptions: {
 						ctxInfo: {