cacophony 0.1.1 → 0.1.3

package/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Christopher Toth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -17,7 +17,7 @@ Cacophony is a highly robust and versatile audio library for Typescript leveragi
 Cacophony is provided as a regular NPM module. Install it using:
 
 ```bash
-$ npm install cacophony-ts
+$ npm install cacophony
 ```
 
 ## Straightforward Usage
@@ -50,7 +50,7 @@ Crafts a `Sound` instance using either an `AudioBuffer` or a URL string leading
 
 #### Method: `async createGroup(sounds: Sound[]): Promise<Group>`
 
-Fabricates a `Group` entity from an array of `Sound` instances.
+Creates a `Group` entity from an array of `Sound` instances.
 
 #### Method: `async createGroupFromUrls(urls: string[]): Promise<Group>`
 

package/package.json

@@ -1,25 +1,26 @@
-{
-  "name": "cacophony",
-  "version": "0.1.1",
-  "description": "Typescript audio library with caching",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "build": "npm run clean && tsc --build",
-    "clean": "tsc --build --clean",
-    "prepublishOnly": "npm run build",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [
-    "audio",
-    "webaudio"
-  ],
-  "author": "Christopher Toth",
-  "license": "ISC",
-  "devDependencies": {
-    "typescript": "^5.1.6"
-  },
-  "dependencies": {
-    "standardized-audio-context": "^25.3.55"
-  }
-}
+{
+  "name": "cacophony",
+  "version": "0.1.3",
+  "description": "Typescript audio library with caching",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "npm run clean && tsc --build",
+    "clean": "tsc --build --clean",
+    "prepublishOnly": "npm run build",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [
+    "audio",
+    "webaudio"
+  ],
+  "author": "Christopher Toth",
+  "license": "ISC",
+  "devDependencies": {
+    "standardized-audio-context-mock": "^9.6.29",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "standardized-audio-context": "^25.3.55"
+  }
+}

package/src/cacophony.ts

@@ -21,6 +21,8 @@ export interface BaseSound {
     addFilter(filter: BiquadFilterNode): void;
     removeFilter(filter: BiquadFilterNode): void;
     moveTo(x: number, y: number, z: number): void;
+    volume: number;
+
     loop(loopCount?: LoopCount): LoopCount;
 }
 
@@ -68,7 +70,6 @@ export class Cacophony {
         return filter;
     }
 
-
     pause() {
         if ('suspend' in this.context) {
             this.context.suspend();
@@ -91,6 +92,14 @@ export class Cacophony {
         this.globalGainNode.gain.value = volume;
     }
 
+    get volume(): number {
+        return this.globalGainNode.gain.value;
+    }
+
+    set volume(volume: number) {
+        this.setGlobalVolume(volume);
+    }
+
     mute() {
         this.prevVolume = this.globalGainNode.gain.value;
         this.setGlobalVolume(0);
@@ -197,8 +206,16 @@ export class Sound extends FilterManager implements BaseSound {
         super.removeFilter(filter);
         this.playbacks.forEach(p => p.removeFilter(filter));
     }
-}
 
+    get volume(): number {
+        return this.globalGainNode.gain.value;
+    }
+
+    set volume(volume: number) {
+        this.globalGainNode.gain.value = volume;
+        this.playbacks.forEach(p => p.volume = volume);
+    }
+}
 
 class Playback extends FilterManager implements BaseSound {
     context: AudioContext;
@@ -223,7 +240,6 @@ class Playback extends FilterManager implements BaseSound {
         source.start();
     }
 
-
     handleLoop(): void {
         if (this.loopCount === 'infinite' || this.currentLoop < this.loopCount) {
             this.currentLoop++;
@@ -238,25 +254,26 @@ class Playback extends FilterManager implements BaseSound {
         return [this];
     }
 
+    get volume(): number {
+        return this.gainNode.gain.value;
+    }
+
     set volume(v: number) {
         this.gainNode.gain.value = v;
     }
 
     fadeIn(time: number, FfadeType: FadeType = 'linear'): Promise<void> {
         return new Promise(resolve => {
-            // Setting the initial gain value to 0
-            this.gainNode.gain.setValueAtTime(0, this.context.currentTime);
-            switch (FfadeType) {
-                case 'exponential':
-                    // Scheduling an exponential fade up
-                    this.gainNode.gain.exponentialRampToValueAtTime(1, this.context.currentTime + time);
-                    break;
-                case 'linear':
-                    // Scheduling a linear ramp to the target gain value over the given duration
-                    this.gainNode.gain.linearRampToValueAtTime(1, this.context.currentTime + time);
-            }
-            // Resolving the Promise after the fade-in time
-            setTimeout(() => resolve(), time * 1000);
+            let volume = 0;
+            const increment = this.gainNode.gain.value / (time * 60); // Assuming time is in seconds
+            const interval = setInterval(() => {
+                volume += increment;
+                this.gainNode.gain.value = volume;
+                if (volume >= this.gainNode.gain.value) {
+                    clearInterval(interval);
+                    resolve();
+                }
+            }, 1000 / 60); // 60 times per second
         });
     }
 
@@ -297,8 +314,8 @@ class Playback extends FilterManager implements BaseSound {
         if ('suspend' in this.source.context) {
             this.source.context.suspend();
         }
-
     }
+
     resume(): void {
         if ('resume' in this.source.context) {
             this.source.context.resume();
@@ -391,6 +408,13 @@ export class Group implements BaseSound {
         this.sounds.forEach(sound => sound.moveTo(x, y, z));
     }
 
+    get volume(): number {
+        return this.sounds[0].volume;
+    }
+
+    set volume(volume: number) {
+        this.sounds.forEach(sound => sound.volume = volume);
+    }
 
 }