Merge pull request #144 from tortis/main

Add `outLength` to full API, tells caller how many samples were written
aolsenjazz · Aug 16, 2024 · bcb1764 · bcb1764
2 parents 6c4b1c2 + 13c0c80
commit bcb1764
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -149,11 +149,14 @@ simple(dataIn) { ... }
  *
  * More (and better) info available at: http://www.mega-nerd.com/SRC/api_full.html
  *
- * @param  {Float32Array}         dataIn  Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
- * @param  {Float32Array || null} dataOut Optionally, pass a Float32Array to avoid allocating an extra array for every esampling operation
- * @return {Float32Array}                 The resampled data. If dataOut != null, dataOut is returned
+ * @param {Float32Array}      dataIn              Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
+ * @param {Float32Array|null} dataOut             Optionally, pass a Float32Array to avoid allocating an extra array for every esampling operation
+ * @param {Object|null}       outLength           Amount of data written to dataOut
+ * @param {number}            [outLength.frames]  The number of frames in the output
+
+ * @return {Float32Array} The resampled data. If dataOut != null, dataOut is returned
  */
-full(dataIn, dataOut=null) { ... }
+full(dataIn, dataOut=null, outLength = null) { ... }
 ```
 
 ### `destroy`

diff --git a/dist/libsamplerate.js b/dist/libsamplerate.js
diff --git a/dist/libsamplerate.worklet.js b/dist/libsamplerate.worklet.js
diff --git a/dist/src.d.ts b/dist/src.d.ts
@@ -45,9 +45,12 @@ export declare class SRC {
      *
      * @param dataIn Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
      * @param dataOut Optionally, pass a Float32Array to avoid allocating an extra array for every resampling operation
+     * @param outLength if resampleFunc === this.module.full, pass an optional object get get the number of frames written to dataOut
      * @returns The resampled data. If dataOut != null, dataOut is returned
      */
-    full(dataIn: Float32Array, dataOut?: Float32Array | null): Float32Array;
+    full(dataIn: Float32Array, dataOut?: Float32Array | null, outLength?: {
+        frames: number;
+    } | null): Float32Array;
     /**
      * Cleans up WASM SRC resources. Once this is called on an instance, that instance must be
      * reinitialized with src.init() before it can be used again.
@@ -77,7 +80,10 @@ export declare class SRC {
      * @param resampleFunc this.module.simple || this.module.full
      * @param dataIn Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
      * @param dataOut if resampleFunc === this.module.full, pass an optional resuable buffer to avoid extra allocations
+     * @param outLength if resampleFunc === this.module.full, pass an optional object get get the number of frames written to dataOut
      * @returns The resampled audio, if any
      */
-    _resample(resampleFunc: ModuleType['simple'] | ModuleType['full'], dataIn: Float32Array, dataOut?: Float32Array | null): Float32Array;
+    _resample(resampleFunc: ModuleType['simple'] | ModuleType['full'], dataIn: Float32Array, dataOut?: Float32Array | null, outLength?: {
+        frames: number;
+    } | null): Float32Array;
 }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@alexanderolsen/libsamplerate-js",
-  "version": "2.1.1",
+  "version": "2.1.2",
   "description": "Resample audio in node or browser using a webassembly port of libsamplerate.",
   "keywords": [
     "web assembly",

diff --git a/src/glue.js b/src/glue.js
diff --git a/src/src.ts b/src/src.ts
@@ -81,13 +81,15 @@ export class SRC {
 	 *
 	 * @param dataIn Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
 	 * @param dataOut Optionally, pass a Float32Array to avoid allocating an extra array for every resampling operation
+	 * @param outLength if resampleFunc === this.module.full, pass an optional object get get the number of frames written to dataOut
 	 * @returns The resampled data. If dataOut != null, dataOut is returned
 	 */
 	full(
 		dataIn: Float32Array,
-		dataOut: Float32Array | null = null
+		dataOut: Float32Array | null = null,
+		outLength: {frames: number} | null = null,
 	): Float32Array {
-		return this._resample(this.module.full, dataIn, dataOut);
+		return this._resample(this.module.full, dataIn, dataOut, outLength);
 	}
 
 	/**
@@ -206,12 +208,14 @@ export class SRC {
 	 * @param resampleFunc this.module.simple || this.module.full
 	 * @param dataIn Float32Array containing mono|interleaved audio data where -1 < dataIn[i] < 1
 	 * @param dataOut if resampleFunc === this.module.full, pass an optional resuable buffer to avoid extra allocations
+	 * @param outLength if resampleFunc === this.module.full, pass an optional object get get the number of frames written to dataOut
 	 * @returns The resampled audio, if any
 	 */
 	_resample(
 		resampleFunc: ModuleType['simple'] | ModuleType['full'],
 		dataIn: Float32Array,
-		dataOut: Float32Array | null = null
+		dataOut: Float32Array | null = null,
+		outLength: {frames: number} | null = null,
 	): Float32Array {
 		// if we don't actually need to resample, just copy values
 		if (this.inputSampleRate === this.outputSampleRate) return dataIn;
@@ -235,6 +239,10 @@ export class SRC {
 			this.outputSampleRate // ignored by module.full()
 		);
 
+		if (typeof outLength === 'object' && outLength !== null) {
+			outLength.frames = outputFrames;
+		}
+
 		return copyOrWriteArray(
 			outputFrames * this.nChannels,
 			this.targetArray,