npm - loudness-worklet - Versions diffs - 1.4.2 → 1.5.0 - Mend

loudness-worklet 1.4.2 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md CHANGED Viewed

@@ -1,9 +1,14 @@
 # Loudness Audio Worklet Processor
-A loudness meter for the `Web Audio API`, based on the [ITU-R BS.1770-5](https://www.itu.int/rec/R-REC-BS.1770) standard and implemented as an AudioWorkletProcessor, [try demo](https://lcweden.github.io/loudness-audio-worklet-processor/).
+[![npm version](https://img.shields.io/npm/v/loudness-worklet.svg)](https://www.npmjs.com/package/loudness-worklet)
+[![license](https://img.shields.io/github/license/lcweden/loudness-audio-worklet-processor.svg)](LICENSE)
+A loudness meter for the `Web Audio API`, based on the [ITU-R BS.1770-5](https://www.itu.int/rec/R-REC-BS.1770) standard and implemented as an AudioWorkletProcessor.
 [![screenshot](https://github.com/lcweden/loudness-audio-worklet-processor/blob/main/public/screenshots/meter.png)](https://lcweden.github.io/loudness-audio-worklet-processor/)
+<p align="center"><a href="https://lcweden.github.io/loudness-audio-worklet-processor/">Demo</a></p>
 ## Features
 - **Loudness Measurement**: Compliant with the **ITU-R BS.1770-5** standard.
@@ -13,6 +18,15 @@ A loudness meter for the `Web Audio API`, based on the [ITU-R BS.1770-5](https:/
 ## Installation
+### CDN
+Import directly in your code:
+```javascript
+const module = new URL("https://lcweden.github.io/loudness-audio-worklet-processor/loudness.worklet.js");
+audioContext.audioWorklet.addModule(module);
+```
 ### Download
 1. Download the pre-built file: [loudness.worklet.js](https://lcweden.github.io/loudness-audio-worklet-processor/loudness.worklet.js).
@@ -22,13 +36,36 @@ A loudness meter for the `Web Audio API`, based on the [ITU-R BS.1770-5](https:/
 audioContext.audioWorklet.addModule("loudness.worklet.js");
 ```
-### Import
+### NPM
-Import the `AudioWorkletProcessor` directly in your code:
+Install via [npm](https://www.npmjs.com/package/loudness-worklet):
+```bash
+npm install loudness-worklet
+```
+Use helper functions to create and load the worklet:
 ```javascript
-const module = new URL("https://lcweden.github.io/loudness-audio-worklet-processor/loudness.worklet.js");
-audioContext.audioWorklet.addModule(module);
+import { createLoudnessWorklet, LoudnessWorkletNode } from "loudness-worklet";
+const worklet = await createLoudnessWorklet(audioContext, {
+  processorOptions: {
+    interval: 0.1,
+    capacity: 600
+  }
+});
+// or
+await LoudnessWorkletNode.loadModule(audioContext);
+const worklet = new LoudnessWorkletNode(audioContext, {
+  processorOptions: {
+    interval: 0.1,
+    capacity: 600
+  }
+});
 ```
 ## Quick Start
@@ -41,29 +78,38 @@ This example shows the easiest way to get started with the Loudness Audio Workle
 <!doctype html>
 <html>
   <body>
+    <button>Share Screen</button>
     <pre></pre>
     <script>
+      const script = "https://lcweden.github.io/loudness-audio-worklet-processor/loudness.worklet.js";
+      const button = document.querySelector("button");
       const pre = document.querySelector("pre");
-      navigator.mediaDevices.getDisplayMedia({ audio: true }).then((mediaStream) => {
-        const audioTrack = mediaStream.getAudioTracks()[0];
-        const { channelCount } = audioTrack.getSettings();
+      button.onclick = async () => {
+        // Get the screen stream with audio, for example a youtube tab
+        const mediaStream = await navigator.mediaDevices.getDisplayMedia({ audio: true });
         const context = new AudioContext();
-        context.audioWorklet
-          .addModule("https://lcweden.github.io/loudness-audio-worklet-processor/loudness.worklet.js")
-          .then(() => {
-            const source = new MediaStreamAudioSourceNode(context, { mediaStream });
-            const worklet = new AudioWorkletNode(context, "loudness-processor", {
-              processorOptions: {
-                interval: 0.1,
-                capacity: 600
-              }
-            });
-            source.connect(worklet).port.onmessage = (event) => {
-              pre.textContent = JSON.stringify(event.data, null, 2);
-            };
-          });
-      });
+        // Load the loudness worklet processor
+        await context.audioWorklet.addModule(script);
+        // Create the audio node from the stream
+        const source = new MediaStreamAudioSourceNode(context, { mediaStream });
+        // Create the loudness worklet node
+        const worklet = new AudioWorkletNode(context, "loudness-processor", {
+          processorOptions: {
+            interval: 0.1,
+            capacity: 600 // it means 1 minute of history can be stored
+          }
+        });
+        worklet.port.onmessage = (event) => {
+          pre.textContent = JSON.stringify(event.data, null, 2);
+        };
+        // Connect the nodes
+        source.connect(worklet);
+      };
     </script>
   </body>
 </html>
@@ -85,6 +131,17 @@ await context.audioWorklet.addModule("loudness.worklet.js");
 const source = new AudioBufferSourceNode(context, { buffer: audioBuffer });
 const worklet = new AudioWorkletNode(context, "loudness-processor");
+// Or using the helper function
+//
+// import { createLoudnessWorklet } from "loudness-worklet";
+//
+// const worklet = await createLoudnessWorklet(audioContext, {
+//   processorOptions: {
+//     interval: 0.1,
+//     capacity: 600
+//    }
+//  });
 worklet.port.onmessage = (event) => {
   console.log("Loudness Data:", event.data);
 };

package/dist/index.d.ts CHANGED Viewed

@@ -1,6 +1,15 @@
+interface LoudnessWorkletProcessorOptions {
+    numberOfInputs?: AudioWorkletNodeOptions["numberOfInputs"];
+    numberOfOutputs?: AudioWorkletNodeOptions["numberOfOutputs"];
+    outputChannelCount?: AudioWorkletNodeOptions["outputChannelCount"];
+    processorOptions?: {
+        interval?: number;
+        capacity?: number;
+    };
+}
 declare class LoudnessWorkletNode extends AudioWorkletNode {
-    constructor(context: BaseAudioContext, options?: AudioWorkletNodeOptions);
+    constructor(context: BaseAudioContext, options?: LoudnessWorkletProcessorOptions);
     static loadModule(context: BaseAudioContext): Promise<void>;
 }
-declare function createLoudnessWorklet(context: BaseAudioContext, options?: AudioWorkletNodeOptions): Promise<AudioWorkletNode>;
+declare function createLoudnessWorklet(context: BaseAudioContext, options?: LoudnessWorkletProcessorOptions): Promise<AudioWorkletNode>;
 export { createLoudnessWorklet, LoudnessWorkletNode };

package/dist/index.js CHANGED Viewed

@@ -2,11 +2,11 @@ const i = `/**
  * A lightweight and efficient AudioWorklet for real-time loudness measurement in the browser, compliant with the ITU-R BS.1770-5 standard.
  *
  * @file loudness.worklet.js
- * @version 1.4.2
+ * @version 1.5.0
  * @author lcweden
  * @license MIT
- * @see git+https://github.com/lcweden/loudness-audio-worklet-processor.git
- * @date 2025-09-25T17:15:25.559Z
+ * @see https://github.com/lcweden/loudness-audio-worklet-processor.git
+ * @date 2025-10-07T13:01:56.024Z
  */\r
 \r
 class O {
@@ -35,12 +35,14 @@ class O {
    * Sets new filter coefficients.
    * @param { number[] } a - Feedback coefficients [a1, a2]
    * @param { number[] } b - Feedforward coefficients [b0, b1, b2]
+   * @returns { void }
    */
   set(e, r) {
     this.#t.set((e.length = 2, e)), this.#e.set((r.length = 3, r));
   }
   /**
    * Resets the filter state.
+   * @returns { void }
    */
   reset() {
     this.#s.fill(0), this.#r.fill(0);
@@ -52,22 +54,45 @@ class d {
   #s = 0;
   #r = 0;
   #n = 0;
+  /**
+   * Creates a new CircularBuffer with given capacity.
+   * @param { number } capacity - The maximum number of items the buffer can hold.
+   */
   constructor(e) {
     this.#e = e || 0, this.#t = new Array(e);
   }
+  /**
+   * Adds an item to the buffer.
+   * @param item - The item to add to the buffer.
+   * @returns { void }
+   */
   push(e) {
     this.#t[this.#r] = e, this.isFull() ? this.#s = (this.#s + 1) % this.#e : this.#n++, this.#r = (this.#r + 1) % this.#e;
   }
+  /**
+   * Removes and returns the oldest item from the buffer.
+   * @returns { T | undefined }
+   */
   pop() {
     if (this.isEmpty())
       return;
     const e = this.#t[this.#s];
     return this.#s = (this.#s + 1) % this.#e, this.#n--, e;
   }
+  /**
+   * Returns the oldest item from the buffer without removing it.
+   * @returns { T | undefined }
+   */
   peek() {
     if (!this.isEmpty())
       return this.#t[this.#s];
   }
+  /**
+   * Returns a slice of the buffer contents.
+   * @param { number } start - The starting index of the slice (inclusive).
+   * @param { number } end - The ending index of the slice (exclusive).
+   * @returns { T[] }
+   */
   slice(e = 0, r = this.#n) {
     if (e < 0 && (e = 0), r > this.#n && (r = this.#n), e >= r)
       return [];
@@ -78,18 +103,29 @@ class d {
     }
     return n;
   }
+  /**
+   * Checks if the buffer is empty.
+   * @returns { boolean }
+   */
   isEmpty() {
     return this.#n === 0;
   }
+  /**
+   * Checks if the buffer is full.
+   * @returns { boolean }
+   */
   isFull() {
     return this.#n === this.#e;
   }
+  /** @type { number } */
   get length() {
     return this.#n;
   }
+  /** @type { number } */
   get capacity() {
     return this.#e;
   }
+  /** @type { IterableIterator<T> } */
   *[Symbol.iterator]() {
     for (let e = 0; e < this.#n; e++) {
       const r = (this.#s + e) % this.#e;
@@ -209,6 +245,10 @@ const L = {
 class F {
   #t;
   #e;
+  /**
+   * Creates an instance of the filter.
+   * @param coefficients - The filter coefficients.
+   */
   constructor(e) {
     this.#t = e, this.#e = Array(e.length).fill(0);
   }
@@ -224,6 +264,10 @@ class F {
       return n;
     }
   }
+  /**
+   * Resets the filter state.
+   * @returns { void }
+   */
   reset() {
     this.#e.fill(0);
   }
@@ -372,19 +416,27 @@ class X extends AudioWorkletProcessor {
   }
 }
 registerProcessor("loudness-processor", X);
-`, e = URL.createObjectURL(new Blob([i], { type: "application/javascript" })), t = "loudness-processor";
-class h extends AudioWorkletNode {
-  constructor(n, r) {
-    super(n, t, r);
+`, t = "loudness-processor";
+class o extends AudioWorkletNode {
+  constructor(n, s) {
+    super(n, t, s);
   }
   static async loadModule(n) {
-    return await n.audioWorklet.addModule(e);
+    return r(n);
   }
 }
-async function o(s, n) {
-  return await s.audioWorklet.addModule(e), new AudioWorkletNode(s, t, n);
+async function h(e, n) {
+  return await r(e), new AudioWorkletNode(e, t, n);
+}
+async function r(e) {
+  const n = new Blob([i], { type: "application/javascript" }), s = URL.createObjectURL(n);
+  try {
+    await e.audioWorklet.addModule(s);
+  } finally {
+    URL.revokeObjectURL(s);
+  }
 }
 export {
-  h as LoudnessWorkletNode,
-  o as createLoudnessWorklet
+  o as LoudnessWorkletNode,
+  h as createLoudnessWorklet
 };

package/package.json CHANGED Viewed

@@ -1,7 +1,26 @@
 {
   "name": "loudness-worklet",
-  "version": "1.4.2",
+  "version": "1.5.0",
   "description": "A lightweight and efficient AudioWorklet for real-time loudness measurement in the browser, compliant with the ITU-R BS.1770-5 standard.",
+  "keywords": [
+    "web-audio",
+    "web-audio-api",
+    "audio-meter",
+    "audio-worklet",
+    "loudness",
+    "loudness-meter",
+    "browser-audio",
+    "ebu-r128",
+    "itu-r-bs1770",
+    "audio-processing",
+    "audio-analysis",
+    "true-peak",
+    "lufs",
+    "lra",
+    "javascript",
+    "typescript",
+    "lightweight"
+  ],
   "type": "module",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -18,7 +37,8 @@
   "author": "lcweden",
   "homepage": "https://lcweden.github.io/loudness-audio-worklet-processor/",
   "repository": {
-    "url": "git+https://github.com/lcweden/loudness-audio-worklet-processor.git"
+    "type": "git",
+    "url": "https://github.com/lcweden/loudness-audio-worklet-processor.git"
   },
   "bugs": {
     "url": "https://github.com/lcweden/loudness-audio-worklet-processor/issues"