@tsparticles/plugin-sounds 3.0.2 → 3.1.0

package/browser/Options/Classes/Sounds.js

@@ -3,6 +3,7 @@ import { SoundsIcons } from "./SoundsIcons.js";
 import { SoundsVolume } from "./SoundsVolume.js";
 export class Sounds {
     constructor() {
+        this.autoPlay = true;
         this.enable = false;
         this.events = [];
         this.icons = new SoundsIcons();
@@ -12,6 +13,9 @@ export class Sounds {
         if (!data) {
             return;
         }
+        if (data.autoPlay !== undefined) {
+            this.autoPlay = data.autoPlay;
+        }
         if (data.enable !== undefined) {
             this.enable = data.enable;
         }

package/browser/Options/Classes/SoundsEvent.js

@@ -41,10 +41,11 @@ export class SoundsEvent {
                 return tmp;
             });
         }
-        if (data.filter !== undefined) {
+        if (data.filter) {
             if (isString(data.filter)) {
-                if (isFunction(window[data.filter])) {
-                    this.filter = window[data.filter];
+                const filterFunc = window[data.filter];
+                if (isFunction(filterFunc)) {
+                    this.filter = filterFunc;
                 }
             }
             else {

package/browser/Options/Classes/SoundsIcon.js

@@ -2,6 +2,7 @@ export class SoundsIcon {
     constructor() {
         this.width = 24;
         this.height = 24;
+        this.style = "";
     }
     load(data) {
         if (!data) {

package/browser/Options/Classes/SoundsIcons.js

@@ -5,6 +5,7 @@ export class SoundsIcons {
         this.unmute = new SoundsIcon();
         this.volumeDown = new SoundsIcon();
         this.volumeUp = new SoundsIcon();
+        this.enable = false;
         this.mute.svg = `<?xml version="1.0"?>
 <svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
     xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
@@ -46,6 +47,9 @@ export class SoundsIcons {
         if (!data) {
             return;
         }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
         this.mute.load(data.mute);
         this.unmute.load(data.unmute);
         this.volumeDown.load(data.volumeDown);

package/browser/SoundsInstance.js

@@ -1,12 +1,18 @@
-import { clamp, executeOnSingleOrMultiple, getLogger, isArray, isNumber, itemFromArray, itemFromSingleOrMultiple, } from "@tsparticles/engine";
-import { getNoteFrequency } from "./utils.js";
+import { clamp, executeOnSingleOrMultiple, getLogger, isArray, isNumber, itemFromArray, itemFromSingleOrMultiple, mouseDownEvent, percentDenominator, touchStartEvent, } from "@tsparticles/engine";
+import { getNoteFrequency, isWindowMuted, unmuteWindow } from "./utils.js";
+const zIndexOffset = 1, rightOffset = 1, minVolume = 0;
 function initImage(data) {
-    const img = document.createElement("img"), { clickCb, container, display, iconOptions, margin, options, pos, rightOffsets } = data, { width, path, svg } = iconOptions;
-    setIconStyle(img, pos.top + margin, pos.right - (margin * (rightOffsets.length + 1) + width + rightOffsets.reduce((a, b) => a + b, 0)), display, options.fullScreen.zIndex + 1, width, margin);
+    const img = document.createElement("img"), { clickCb, container, display, iconOptions, margin, options, pos, rightOffsets } = data, { width, path, style, svg } = iconOptions, defaultAccumulator = 0;
+    setIconStyle(img, pos.top + margin, pos.right -
+        (margin * (rightOffsets.length + rightOffset) +
+            width +
+            rightOffsets.reduce((a, b) => a + b, defaultAccumulator)), display, options.fullScreen.zIndex + zIndexOffset, width, margin, style);
     img.src = path ?? (svg ? `data:image/svg+xml;base64,${btoa(svg)}` : "");
-    const parent = container.canvas.element?.parentNode || document.body;
+    const parent = container.canvas.element?.parentNode ?? document.body;
     parent.append(img);
-    img.addEventListener("click", clickCb);
+    img.addEventListener("click", () => {
+        void clickCb();
+    });
     return img;
 }
 function removeImage(image) {
@@ -15,14 +21,15 @@ function removeImage(image) {
     }
     image.remove();
 }
-function setIconStyle(icon, top, left, display, zIndex, width, margin) {
+function setIconStyle(icon, top, left, display, zIndex, width, margin, style) {
     icon.style.userSelect = "none";
     icon.style.webkitUserSelect = "none";
     icon.style.position = "absolute";
     icon.style.top = `${top + margin}px`;
     icon.style.left = `${left - margin - width}px`;
     icon.style.display = display;
-    icon.style.zIndex = `${zIndex + 1}`;
+    icon.style.zIndex = `${zIndex + zIndexOffset}`;
+    icon.style.cssText += style;
 }
 export class SoundsInstance {
     constructor(container, engine) {
@@ -43,12 +50,12 @@ export class SoundsInstance {
             }
             for (const event of soundsOptions.events) {
                 const cb = (args) => {
-                    (async () => {
+                    void (async () => {
                         const filterNotValid = event.filter && !event.filter(args);
                         if (this._container !== args.container) {
                             return;
                         }
-                        if (!this._container || this._container.muted || this._container.destroyed) {
+                        if (!this._container || !!this._container.muted || this._container.destroyed) {
                             executeOnSingleOrMultiple(event.event, (item) => {
                                 this._engine.removeEventListener(item, cb);
                             });
@@ -57,21 +64,22 @@ export class SoundsInstance {
                         if (filterNotValid) {
                             return;
                         }
+                        const defaultNoteIndex = 0;
                         if (event.audio) {
                             this._playBuffer(itemFromSingleOrMultiple(event.audio));
                         }
                         else if (event.melodies) {
                             const melody = itemFromArray(event.melodies);
                             if (melody.melodies.length) {
-                                await Promise.allSettled(melody.melodies.map((m) => this._playNote(m.notes, 0, melody.loop)));
+                                await Promise.allSettled(melody.melodies.map((m) => this._playNote(m.notes, defaultNoteIndex, melody.loop)));
                             }
                             else {
-                                await this._playNote(melody.notes, 0, melody.loop);
+                                await this._playNote(melody.notes, defaultNoteIndex, melody.loop);
                             }
                         }
                         else if (event.notes) {
                             const note = itemFromArray(event.notes);
-                            await this._playNote([note], 0, false);
+                            await this._playNote([note], defaultNoteIndex, false);
                         }
                     })();
                 };
@@ -80,18 +88,15 @@ export class SoundsInstance {
                 });
             }
         };
-        this._mute = () => {
-            const container = this._container;
-            if (!container.audioContext) {
-                return;
-            }
+        this._mute = async () => {
+            const container = this._container, audioContext = this._getAudioContext();
             for (const source of this._audioSources) {
                 this._removeAudioSource(source);
             }
             if (this._gain) {
                 this._gain.disconnect();
             }
-            container.audioContext.close();
+            await audioContext.close();
             container.audioContext = undefined;
             this._engine.dispatchEvent("soundsMuted", { container: this._container });
         };
@@ -111,10 +116,10 @@ export class SoundsInstance {
             source.start();
         };
         this._playFrequency = async (frequency, duration) => {
-            if (!this._container.audioContext || !this._gain) {
+            if (!this._gain || this._container.muted) {
                 return;
             }
-            const oscillator = this._addOscillator(this._container.audioContext);
+            const audioContext = this._getAudioContext(), oscillator = this._addOscillator(audioContext);
             oscillator.connect(this._gain);
             oscillator.type = "sine";
             oscillator.frequency.value = frequency;
@@ -127,14 +132,13 @@ export class SoundsInstance {
             });
         };
         this._playMuteSound = () => {
-            const container = this._container;
-            if (!container.audioContext) {
+            if (this._container.muted) {
                 return;
             }
-            const gain = container.audioContext.createGain();
-            gain.connect(container.audioContext.destination);
+            const audioContext = this._getAudioContext(), gain = audioContext.createGain();
+            gain.connect(audioContext.destination);
             gain.gain.value = 0;
-            const oscillator = container.audioContext.createOscillator();
+            const oscillator = audioContext.createOscillator();
             oscillator.connect(gain);
             oscillator.type = "sine";
             oscillator.frequency.value = 1;
@@ -158,7 +162,8 @@ export class SoundsInstance {
                 return this._playNoteValue(notes, noteIdx, idx);
             });
             await (isArray(promises) ? Promise.allSettled(promises) : promises);
-            let nextNoteIdx = noteIdx + 1;
+            const indexOffset = 1;
+            let nextNoteIdx = noteIdx + indexOffset;
             if (loop && nextNoteIdx >= notes.length) {
                 nextNoteIdx = nextNoteIdx % notes.length;
             }
@@ -187,29 +192,31 @@ export class SoundsInstance {
         this._removeAudioSource = (source) => {
             source.stop();
             source.disconnect();
-            this._audioSources.splice(this._audioSources.indexOf(source), 1);
+            const deleteCount = 1;
+            this._audioSources.splice(this._audioSources.indexOf(source), deleteCount);
         };
         this._unmute = () => {
             const container = this._container, options = container.actualOptions, soundsOptions = options.sounds;
             if (!soundsOptions) {
                 return;
             }
-            if (!container.audioContext) {
-                container.audioContext = new AudioContext();
-            }
-            const { audioContext } = container;
+            const audioContext = this._getAudioContext();
             if (!this._audioSources) {
                 this._audioSources = [];
             }
             const gain = audioContext.createGain();
             gain.connect(audioContext.destination);
-            gain.gain.value = soundsOptions.volume.value / 100;
+            gain.gain.value = soundsOptions.volume.value / percentDenominator;
             this._gain = gain;
             this._initEvents();
             this._engine.dispatchEvent("soundsUnmuted", { container: this._container });
         };
         this._updateMuteIcons = () => {
-            const container = this._container, muteImg = this._muteImg, unmuteImg = this._unmuteImg;
+            const container = this._container, soundsOptions = container.actualOptions.sounds;
+            if (!soundsOptions?.enable || !soundsOptions.icons.enable) {
+                return;
+            }
+            const muteImg = this._muteImg, unmuteImg = this._unmuteImg;
             if (muteImg) {
                 muteImg.style.display = container.muted ? "block" : "none";
             }
@@ -218,13 +225,13 @@ export class SoundsInstance {
             }
         };
         this._updateMuteStatus = async () => {
-            const container = this._container;
+            const container = this._container, audioContext = this._getAudioContext();
             if (container.muted) {
-                await container.audioContext?.suspend();
-                this._mute();
+                await audioContext?.suspend();
+                await this._mute();
             }
             else {
-                await container.audioContext?.resume();
+                await audioContext?.resume();
                 this._unmute();
                 this._playMuteSound();
             }
@@ -236,12 +243,12 @@ export class SoundsInstance {
             }
             clamp(this._volume, soundsOptions.volume.min, soundsOptions.volume.max);
             let stateChanged = false;
-            if (this._volume <= 0 && !container.muted) {
+            if (this._volume <= minVolume && !container.muted) {
                 this._volume = 0;
                 container.muted = true;
                 stateChanged = true;
             }
-            else if (this._volume > 0 && container.muted) {
+            else if (this._volume > minVolume && container.muted) {
                 container.muted = false;
                 stateChanged = true;
             }
@@ -250,7 +257,7 @@ export class SoundsInstance {
                 await this._updateMuteStatus();
             }
             if (this._gain?.gain) {
-                this._gain.gain.value = this._volume / 100;
+                this._gain.gain.value = this._volume / percentDenominator;
             }
         };
         this._container = container;
@@ -264,6 +271,20 @@ export class SoundsInstance {
         if (!soundsOptions?.enable) {
             return;
         }
+        if (soundsOptions.autoPlay && isWindowMuted()) {
+            const firstClickHandler = () => {
+                removeEventListener(mouseDownEvent, firstClickHandler);
+                removeEventListener(touchStartEvent, firstClickHandler);
+                unmuteWindow();
+                void this.unmute();
+            };
+            const listenerOptions = {
+                capture: true,
+                once: true,
+            };
+            addEventListener(mouseDownEvent, firstClickHandler, listenerOptions);
+            addEventListener(touchStartEvent, firstClickHandler, listenerOptions);
+        }
         this._volume = soundsOptions.volume.value;
         const events = soundsOptions.events;
         this._audioMap = new Map();
@@ -271,16 +292,25 @@ export class SoundsInstance {
             if (!event.audio) {
                 continue;
             }
-            executeOnSingleOrMultiple(event.audio, async (audio) => {
+            const promises = executeOnSingleOrMultiple(event.audio, async (audio) => {
                 const response = await fetch(audio.source);
                 if (!response.ok) {
                     return;
                 }
-                const arrayBuffer = await response.arrayBuffer();
-                container.audioContext = new AudioContext();
-                const audioBuffer = await container.audioContext.decodeAudioData(arrayBuffer);
+                const arrayBuffer = await response.arrayBuffer(), audioContext = this._getAudioContext(), audioBuffer = await audioContext.decodeAudioData(arrayBuffer);
                 this._audioMap.set(audio.source, audioBuffer);
             });
+            if (promises instanceof Promise) {
+                await promises;
+            }
+            else {
+                await Promise.allSettled(promises);
+            }
+        }
+    }
+    async mute() {
+        if (!this._container.muted) {
+            await this.toggleMute();
         }
     }
     async start() {
@@ -292,17 +322,14 @@ export class SoundsInstance {
         const canvas = container.canvas.element, pos = {
             top: canvas.offsetTop,
             right: canvas.offsetLeft + canvas.offsetWidth,
-        }, { mute, unmute, volumeDown, volumeUp } = soundsOptions.icons, margin = 10;
-        const toggleMute = async () => {
-            container.muted = !container.muted;
-            this._updateMuteIcons();
-            await this._updateMuteStatus();
-        };
+        }, { mute, unmute, volumeDown, volumeUp } = soundsOptions.icons, margin = 10, toggleMute = async () => {
+            await this.toggleMute();
+        }, enableIcons = soundsOptions.icons.enable, display = enableIcons ? "block" : "none";
         this._muteImg = initImage({
             container,
             options,
             pos,
-            display: "block",
+            display,
             iconOptions: mute,
             margin,
             rightOffsets: [volumeDown.width, volumeUp.width],
@@ -322,41 +349,75 @@ export class SoundsInstance {
             container,
             options,
             pos,
-            display: "block",
+            display,
             iconOptions: volumeDown,
             margin,
             rightOffsets: [volumeUp.width],
             clickCb: async () => {
-                if (container.muted) {
-                    this._volume = 0;
-                }
-                this._volume -= soundsOptions.volume.step;
-                await this._updateVolume();
+                await this.volumeDown();
             },
         });
         this._volumeUpImg = initImage({
             container,
             options,
             pos,
-            display: "block",
+            display,
             iconOptions: volumeUp,
             margin,
             rightOffsets: [],
             clickCb: async () => {
-                if (container.muted) {
-                    this._volume = 0;
-                }
-                this._volume += soundsOptions.volume.step;
-                await this._updateVolume();
+                await this.volumeUp();
             },
         });
+        if (!isWindowMuted() && soundsOptions.autoPlay) {
+            await this.unmute();
+        }
     }
     stop() {
         this._container.muted = true;
-        this._mute();
-        removeImage(this._muteImg);
-        removeImage(this._unmuteImg);
-        removeImage(this._volumeDownImg);
-        removeImage(this._volumeUpImg);
+        void (async () => {
+            await this._mute();
+            removeImage(this._muteImg);
+            removeImage(this._unmuteImg);
+            removeImage(this._volumeDownImg);
+            removeImage(this._volumeUpImg);
+        })();
+    }
+    async toggleMute() {
+        const container = this._container;
+        container.muted = !container.muted;
+        this._updateMuteIcons();
+        await this._updateMuteStatus();
+    }
+    async unmute() {
+        if (this._container.muted) {
+            await this.toggleMute();
+        }
+    }
+    async volumeDown() {
+        const container = this._container, soundsOptions = container.actualOptions.sounds;
+        if (!soundsOptions?.enable) {
+            return;
+        }
+        if (container.muted) {
+            this._volume = 0;
+        }
+        this._volume -= soundsOptions.volume.step;
+        await this._updateVolume();
+    }
+    async volumeUp() {
+        const container = this._container, soundsOptions = container.actualOptions.sounds;
+        if (!soundsOptions?.enable) {
+            return;
+        }
+        this._volume += soundsOptions.volume.step;
+        await this._updateVolume();
+    }
+    _getAudioContext() {
+        const container = this._container;
+        if (!container.audioContext) {
+            container.audioContext = new AudioContext();
+        }
+        return container.audioContext;
     }
 }

package/browser/index.js

@@ -1,9 +1,22 @@
+import { mouseDownEvent, touchStartEvent, } from "@tsparticles/engine";
 import { Sounds } from "./Options/Classes/Sounds.js";
 import { SoundsInstance } from "./SoundsInstance.js";
+import { unmuteWindow } from "./utils.js";
+const generalFirstClickHandler = () => {
+    removeEventListener(mouseDownEvent, generalFirstClickHandler);
+    removeEventListener(touchStartEvent, generalFirstClickHandler);
+    unmuteWindow();
+};
 class SoundsPlugin {
     constructor(engine) {
         this.id = "sounds";
         this._engine = engine;
+        const listenerOptions = {
+            capture: true,
+            once: true,
+        };
+        addEventListener(mouseDownEvent, generalFirstClickHandler, listenerOptions);
+        addEventListener(touchStartEvent, generalFirstClickHandler, listenerOptions);
     }
     getPlugin(container) {
         return new SoundsInstance(container, this._engine);

package/browser/utils.js

@@ -13,13 +13,20 @@ notes.set("Bb", [29.14, 58.27, 116.54, 233.08, 466.16, 932.33, 1864.66, 3729.31,
 notes.set("B", [30.87, 61.74, 123.47, 246.94, 493.88, 987.77, 1975.53, 3951.07, 7902.13]);
 notes.set("pause", [0]);
 export function getNoteFrequency(note) {
-    const regex = /(([A-G]b?)(\d))|pause/i, result = regex.exec(note);
-    if (!result || !result.length) {
+    const regex = /(([A-G]b?)(\d))|pause/i, result = regex.exec(note), groupKey = 2, defaultMatchKey = 0, innerGroupKey = 3;
+    if (!result?.length) {
         return;
     }
-    const noteKey = result[2] || result[0], noteItem = notes.get(noteKey);
+    const noteKey = result[groupKey] || result[defaultMatchKey], noteItem = notes.get(noteKey);
     if (!noteItem) {
         return;
     }
-    return noteItem[parseInt(result[3] || "0")];
+    return noteItem[parseInt(result[innerGroupKey] || "0")];
 }
+let muted = true;
+export const isWindowMuted = () => {
+    return muted;
+};
+export const unmuteWindow = () => {
+    muted = false;
+};

package/cjs/Options/Classes/Sounds.js

@@ -6,6 +6,7 @@ const SoundsIcons_js_1 = require("./SoundsIcons.js");
 const SoundsVolume_js_1 = require("./SoundsVolume.js");
 class Sounds {
     constructor() {
+        this.autoPlay = true;
         this.enable = false;
         this.events = [];
         this.icons = new SoundsIcons_js_1.SoundsIcons();
@@ -15,6 +16,9 @@ class Sounds {
         if (!data) {
             return;
         }
+        if (data.autoPlay !== undefined) {
+            this.autoPlay = data.autoPlay;
+        }
         if (data.enable !== undefined) {
             this.enable = data.enable;
         }

package/cjs/Options/Classes/SoundsEvent.js

@@ -44,10 +44,11 @@ class SoundsEvent {
                 return tmp;
             });
         }
-        if (data.filter !== undefined) {
+        if (data.filter) {
             if ((0, engine_1.isString)(data.filter)) {
-                if ((0, engine_1.isFunction)(window[data.filter])) {
-                    this.filter = window[data.filter];
+                const filterFunc = window[data.filter];
+                if ((0, engine_1.isFunction)(filterFunc)) {
+                    this.filter = filterFunc;
                 }
             }
             else {

package/cjs/Options/Classes/SoundsIcon.js

@@ -5,6 +5,7 @@ class SoundsIcon {
     constructor() {
         this.width = 24;
         this.height = 24;
+        this.style = "";
     }
     load(data) {
         if (!data) {

package/cjs/Options/Classes/SoundsIcons.js

@@ -8,6 +8,7 @@ class SoundsIcons {
         this.unmute = new SoundsIcon_js_1.SoundsIcon();
         this.volumeDown = new SoundsIcon_js_1.SoundsIcon();
         this.volumeUp = new SoundsIcon_js_1.SoundsIcon();
+        this.enable = false;
         this.mute.svg = `<?xml version="1.0"?>
 <svg baseProfile="tiny" height="24px" version="1.2" viewBox="0 0 24 24" width="24px"
     xml:space="preserve" xmlns="http://www.w3.org/2000/svg"
@@ -49,6 +50,9 @@ class SoundsIcons {
         if (!data) {
             return;
         }
+        if (data.enable !== undefined) {
+            this.enable = data.enable;
+        }
         this.mute.load(data.mute);
         this.unmute.load(data.unmute);
         this.volumeDown.load(data.volumeDown);