Address some review comments by @FallingSnow and myself format and rebuild

Author: padenot

README.md

@@ -70,15 +70,21 @@ allows rebuilding the documentation.
 
 ## Performance Benchmarks
 
-As of version `0.4.0`, the whole codebase has been ported to TypeScript,  tooling has been modernized and dependencies were updated. The pakcage is now also marked as side-effect free, which allows bundlers to tree-shake the code for unused symbols when imported. 
+As of version `0.4.0`, the whole codebase has been ported to TypeScript, tooling
+has been modernized and dependencies were updated. The package is now also
+marked as side-effect free, which allows bundlers to tree-shake the code for
+unused symbols when imported.
 
 Alongside these updates, two performance optimizations were introduced:
 
-- `_copy` has been optimized by a loop factor of 16. [`bench`](bench/deinterleave-bench.html)
-- `deinterleave` has been optimized by a loop unroll factor of 4. [`bench`](bench/copy-bench.html)
+- `_copy` has been optimized by a loop factor of 16.
+[`bench`](bench/deinterleave-bench.html)
+- `deinterleave` has been optimized by unrolling the loop with a factor of 4.
+[`bench`](bench/copy-bench.html)
 
-Early, and limited test results have shown
-a substantial performance improvement in buffer copying by **~325%**. For ongoing monitoring in engine behaviour, benchmarks have been added for independent verification of the results. 
+Early, and limited test results have shown a substantial performance improvement
+in buffer copying by **~325%**. For ongoing monitoring in engine behaviour,
+benchmarks have been added for independent verification of the results.
 
 ## Compatibility
 
@@ -97,7 +103,7 @@ As of 2023-05-25, the following browsers are compatible:
 - Chrome Desktop and Chromium-based browsers (for a long time)
 - Chrome for Android
 - Safari
- 
+
 ## License
 
 Mozilla Public License 2.0

package.json

@@ -22,16 +22,17 @@
   "types": "./dist/index.d.cts",
   "sideEffects": false,
   "engines": {
-    "node": ">=14",
-    "npm": ">=6"
+    "node": ">=18",
+    "npm": ">=9"
   },
   "keywords": [
     "ring buffer",
     "shared array buffer",
     "thread-safe",
     "single-consumer",
     "single-producer",
-    "wait-free"
+    "wait-free",
+    "garbage collector"
   ],
   "scripts": {
     "build": "pkgroll --sourcemap",

public/example/index.js

@@ -11,7 +11,10 @@ import type { RingBuffer } from "./ringbuf.ts";
  * where n is the channel count.
  * @param output is an array of 128-frames arrays.
  */
-export function deinterleave(input: Float32Array, output: Float32Array[]): void {
+export function deinterleave(
+  input: Float32Array,
+  output: Float32Array[],
+): void {
   const channel_count = input.length / 128;
   if (output.length !== channel_count) {
     throw new RangeError(
@@ -20,7 +23,7 @@ export function deinterleave(input: Float32Array, output: Float32Array[]): void
   }
 
   /* Original algorithm:
-    
+
     for (let i = 0; i < channel_count; i++) {
       const out_channel = output[i];
       let interleaved_idx = i;

src/audioqueue.ts

@@ -4,5 +4,5 @@ export {
   deinterleave,
   interleave,
 } from "./audioqueue.js";
-export { ParameterReader, ParameterWriter } from "./param.js";
-export { RingBuffer } from "./ringbuf.js";
+export { ParameterReader, ParameterWriter } from "./param";
+export { RingBuffer } from "./ringbuf";

src/index.ts

@@ -48,15 +48,29 @@ export class ParameterWriter {
    * @param value The value of the parameter.
    * @return True if enqueuing succeeded, false otherwise.
    */
-  enqueue_change(index: number, value: number): boolean {
+  enqueueChange(index: number, value: number): boolean {
     const SIZE_ELEMENT = 5;
     if (this.ringbuf.availableWrite() < SIZE_ELEMENT) {
       return false;
     }
     this.view.setUint8(0, index);
-    this.view.setFloat32(1, value); 
+    this.view.setFloat32(1, value);
     return this.ringbuf.push(this.array) === SIZE_ELEMENT;
   }
+
+  /**
+   * Enqueue a parameter change for parameter of index `index`, with a new value
+   * of `value`.
+   *
+   * @param index The index of the parameter.
+   * @param value The value of the parameter.
+   * @return True if enqueuing succeeded, false otherwise.
+   *
+   * @deprecated
+   */
+  enqueue_change(index: number, value: number): boolean {
+    return this.enqueueChange(index, value);
+  }
 }
 
 /**
@@ -99,7 +113,7 @@ export class ParameterReader {
    * @param o An object with two attributes: `index` and `value`.
    * @return true if a parameter change has been dequeued, false otherwise.
    */
-  dequeue_change(o: { index: number; value: number }): boolean {
+  dequeueChange(o: { index: number; value: number }): boolean {
     if (this.ringbuf.empty()) {
       return false;
     }
@@ -109,4 +123,15 @@ export class ParameterReader {
 
     return rv === this.array.length;
   }
+
+  /**
+   * Attempt to dequeue a single parameter change.
+   * @param o An object with two attributes: `index` and `value`.
+   * @return true if a parameter change has been dequeued, false otherwise.
+   *
+   * @deprecated
+   */
+  dequeue_change(o: { index: number; value: number }): boolean {
+    return this.dequeueChange(o);
+  }
 }

src/param.ts

@@ -1,6 +1,11 @@
-import type { RingBufferWriteCallback, RingBufferWriteCallbackWithOffset, TypedArray, TypedArrayConstructor } from "./types";
-
-/** 
+import type {
+  RingBufferWriteCallback,
+  RingBufferWriteCallbackWithOffset,
+  TypedArray,
+  TypedArrayConstructor,
+} from "./types";
+
+/**
  * The base RingBuffer class
  *
  * A Single Producer - Single Consumer thread-safe wait-free ring buffer.
@@ -9,7 +14,6 @@ import type { RingBufferWriteCallback, RingBufferWriteCallbackWithOffset, TypedA
  * except with external synchronization.
  */
 export class RingBuffer {
-
   /** Allocate the SharedArrayBuffer for a RingBuffer, based on the type and
    * capacity required
    * @param capacity The number of elements the ring buffer will be
@@ -18,7 +22,10 @@ export class RingBuffer {
    * buffer will hold.
    * @return A SharedArrayBuffer of the right size.
    */
-  static getStorageForCapacity(capacity: number, type: TypedArrayConstructor): SharedArrayBuffer {
+  static getStorageForCapacity(
+    capacity: number,
+    type: TypedArrayConstructor,
+  ): SharedArrayBuffer {
     if (!type.BYTES_PER_ELEMENT) {
       throw TypeError("Pass in an ArrayBuffer subclass");
     }
@@ -80,7 +87,7 @@ export class RingBuffer {
 
     if ((wr + 1) % this._storage_capacity() === rd) {
       // full
-      return 0; 
+      return 0;
     }
 
     const len = length !== undefined ? length : elements.length;
@@ -94,9 +101,9 @@ export class RingBuffer {
 
     // publish the enqueued data to the other side
     Atomics.store(
-      this.write_ptr, 
-      0, 
-      (wr + to_write) % this._storage_capacity()
+      this.write_ptr,
+      0,
+      (wr + to_write) % this._storage_capacity(),
     );
 
     return to_write;
@@ -179,7 +186,10 @@ export class RingBuffer {
    * been written started at the beginning of the requested buffer space.
    * @return The number of elements written to the queue.
    */
-  writeCallbackWithOffset(amount: number, cb: RingBufferWriteCallbackWithOffset) {
+  writeCallbackWithOffset(
+    amount: number,
+    cb: RingBufferWriteCallbackWithOffset,
+  ) {
     const rd = Atomics.load(this.read_ptr, 0);
     const wr = Atomics.load(this.write_ptr, 0);
 
@@ -233,7 +243,7 @@ export class RingBuffer {
     this._copy(this.storage, 0, elements, offset + first_part, second_part);
 
     Atomics.store(this.read_ptr, 0, (rd + to_read) % this._storage_capacity());
-    
+
     return to_read;
   }
 
@@ -292,7 +302,7 @@ export class RingBuffer {
     return this.availableRead();
   }
 
- /**
+  /**
    * @return The number of elements available for writing. This can be late, and
    * report less elements that is actually available for writing, when something
    * has just been dequeued.
@@ -360,9 +370,8 @@ export class RingBuffer {
     offset_input: number,
     output: TypedArray,
     offset_output: number,
-    size: number
+    size: number,
   ): void {
-
     if (!size) {
       return;
     }
@@ -416,4 +425,4 @@ export class RingBuffer {
       output[offset_output + i] = input[offset_input + i];
     }
   }
-}
+}