sfxmix 1.0.8 → 1.1.2

package/README.md

@@ -9,7 +9,7 @@
 - **Concatenate** multiple audio files seamlessly.
 - **Mix** audio tracks with adjustable durations.
 - **Insert silence** at any point in your audio sequence.
-- **Apply filters** like echo, reverb, normalize, and more.
+- **Apply filters** like echo, normalize, highpass, lowpass, volume, equalizer, flanger, pitch, tremolo, phaser, tempo, and more.
 - **Parameterizable filters** for fine-grained control.
 - **Fluent interface** for chaining multiple operations.
 
@@ -116,6 +116,15 @@ sfx
     .save('enhanced_announcement.mp3');
 ```
 
+### 6. Change Tempo of Audio
+
+```javascript
+sfx
+    .add('speech.mp3')
+    .filter('tempo', { x: 1.25 }) // Increase tempo by 25%
+    .save('faster_speech.mp3');
+```
+
 ---
 
 ## 📖 API Documentation
@@ -196,16 +205,15 @@ Applies an audio filter to the current audio.
 - [`normalize`](#filter-normalize)
 - [`telephone`](#filter-telephone)
 - [`echo`](#filter-echo)
-- [`reverb`](#filter-reverb)
 - [`highpass`](#filter-highpass)
 - [`lowpass`](#filter-lowpass)
 - [`volume`](#filter-volume)
 - [`equalizer`](#filter-equalizer)
-- [`compressor`](#filter-compressor)
 - [`flanger`](#filter-flanger)
 - [`pitch`](#filter-pitch)
 - [`tremolo`](#filter-tremolo)
 - [`phaser`](#filter-phaser)
+- [`tempo`](#filter-tempo)
 
 ---
 
@@ -276,28 +284,6 @@ sfx.filter('echo', { delay: 1000, decay: 0.6 });
 
 ---
 
-### Filter: `reverb`
-
-Applies a reverb effect to the audio.
-
-- **Options:**
-  - `room_size` (number): Size of the room (default: `50`).
-  - `reverberance` (number): Amount of reverberation (default: `50`).
-  - `damping` (number): Damping factor (default: `50`).
-  - `hf_damping` (number): High-frequency damping (default: `50`).
-  - `stereo_depth` (number): Stereo depth (default: `0`).
-  - `pre_delay` (number): Pre-delay time in milliseconds (default: `0`).
-  - `wet_gain` (number): Gain of the wet signal (default: `0`).
-  - `wet_only` (number): If set to `1`, only the wet signal is output (default: `0`).
-
-**Example:**
-
-```javascript
-sfx.filter('reverb');
-```
-
----
-
 ### Filter: `highpass`
 
 Applies a high-pass filter to remove frequencies below the cutoff.
@@ -360,24 +346,6 @@ sfx.filter('equalizer', { frequency: 1000, width: 200, gain: -10 });
 
 ---
 
-### Filter: `compressor`
-
-Applies a dynamic range compressor to the audio.
-
-- **Options:**
-  - `threshold` (number): Threshold level in dB (default: `-18`).
-  - `ratio` (number): Compression ratio (default: `2`).
-  - `attack` (number): Attack time in milliseconds (default: `20`).
-  - `release` (number): Release time in milliseconds (default: `250`).
-
-**Example:**
-
-```javascript
-sfx.filter('compressor', { threshold: -20, ratio: 4, attack: 15, release: 300 });
-```
-
----
-
 ### Filter: `flanger`
 
 Applies a flanger effect to the audio.
@@ -451,6 +419,21 @@ sfx.filter('phaser', { delay: 4, decay: 0.5, speed: 0.8 });
 
 ---
 
+### Filter: `tempo`
+
+Changes the tempo of the audio without altering its pitch.
+
+- **Options:**
+  - `x` (number): Tempo change factor (e.g., `1.25` to increase tempo by 25%, `0.8` to decrease by 20%). Must be between `0.5` and `2.0`.
+
+**Example:**
+
+```javascript
+sfx.filter('tempo', { x: 1.25 }); // Increase tempo by 25%
+```
+
+---
+
 ## ⚠️ Important Notes
 
 - **FFmpeg Installation:** Ensure FFmpeg is installed and accessible in your system's PATH.

package/demo/demo_6.mjs

@@ -0,0 +1,14 @@
+import SfxMix from '../index.js';
+const sfx = new SfxMix();
+
+// Slow down part1.mp3 by 25%
+await sfx
+    .add('part1.mp3')
+    .filter('tempo', { x: 0.75 })
+    .save('demo6_part1_slow.mp3')
+    .then(() => {
+        console.log('Successfully exported: demo6_part1_slow.mp3');
+    })
+    .catch((error) => {
+        console.error('Error during audio processing:', error);
+    });

package/demo/demo_7.mjs

@@ -0,0 +1,14 @@
+import SfxMix from '../index.js';
+const sfx = new SfxMix();
+
+// Slow down part1.mp3 by 25%
+await sfx
+    .add('part1.mp3')
+    .filter('echo', { delays: [1000, 2000, 3000, 4000], decays: [0.5, 0.5, 0.5, 0.5] })
+    .save('demo7_part1_echo.mp3')
+    .then(() => {
+        console.log('Successfully exported: demo7_part1_echo.mp3');
+    })
+    .catch((error) => {
+        console.error('Error during audio processing:', error);
+    });

package/index.js

@@ -95,6 +95,7 @@ class SfxMix {
 
                 resolve(output);
             } catch (err) {
+                console.error('Error during audio processing:', err);
                 reject(err);
             }
         });
@@ -221,23 +222,15 @@ function getFilterChain(filterName, options) {
             return `highpass=f=${lowFreq}, lowpass=f=${highFreq}`;
 
         case 'echo':
-            // Echo effect with parameters
-            const echoDelay = options.delay || 500;
-            const echoDecay = options.decay || 0.5;
-            return `aecho=0.8:0.88:${echoDelay}:${echoDecay}`;
-
-        case 'reverb':
-            // Reverb effect with parameters
-            // Options: room_size, reverberance, damping, hf_damping, stereo_depth, pre_delay, wet_gain, wet_only
-            const room_size = options.room_size !== undefined ? options.room_size : 50;
-            const reverberance = options.reverberance !== undefined ? options.reverberance : 50;
-            const damping = options.damping !== undefined ? options.damping : 50;
-            const hf_damping = options.hf_damping !== undefined ? options.hf_damping : 50;
-            const stereo_depth = options.stereo_depth !== undefined ? options.stereo_depth : 0;
-            const pre_delay = options.pre_delay !== undefined ? options.pre_delay : 0;
-            const wet_gain = options.wet_gain !== undefined ? options.wet_gain : 0;
-            const wet_only = options.wet_only !== undefined ? options.wet_only : 0;
-            return `areverb=room_size=${room_size}:reverberance=${reverberance}:damping=${damping}:hf_damping=${hf_damping}:stereo_depth=${stereo_depth}:pre_delay=${pre_delay}:wet_gain=${wet_gain}:wet_only=${wet_only}`;
+            // Reverb effect using aecho filter
+            const inGain = options.inGain !== undefined ? options.inGain : 0.8;
+            const outGain = options.outGain !== undefined ? options.outGain : 0.9;
+            const delays = options.delays !== undefined ? options.delays : [1, 200, 300, 400];
+            const decays = options.decays !== undefined ? options.decays : [0.5, 0.5, 0.5, 0.5];
+
+            const delaysStr = delays.join('|');
+            const decaysStr = decays.join('|');
+            return `aecho=${inGain}:${outGain}:${delaysStr}:${decaysStr}`;
 
         case 'highpass':
             // High-pass filter
@@ -271,15 +264,6 @@ function getFilterChain(filterName, options) {
                 throw new Error('Equalizer filter requires "frequency", "width", and "gain" options.');
             }
 
-        case 'compressor':
-            // Compressor effect
-            // Options: threshold, ratio, attack, release
-            const threshold = options.threshold !== undefined ? options.threshold : -18;
-            const ratio = options.ratio !== undefined ? options.ratio : 2;
-            const attack = options.attack !== undefined ? options.attack : 20;
-            const release = options.release !== undefined ? options.release : 250;
-            return `acompressor=threshold=${threshold}:ratio=${ratio}:attack=${attack}:release=${release}`;
-
         case 'flanger':
             // Flanger effect
             // Options: delay, depth, regen, width, speed, shape, phase, interp
@@ -291,7 +275,7 @@ function getFilterChain(filterName, options) {
             const shape = options.shape !== undefined ? options.shape : 'sine';
             const phase = options.phase !== undefined ? options.phase : 25;
             const interp = options.interp !== undefined ? options.interp : 'linear';
-            return `flanger=delay=${flangerDelay}:depth=${depth}:regen=${regen}:width=${width}:speed=${speed}:shape=${shape}:phase=${phase}:interp=${interp}`;
+            return `aflanger=delay=${flangerDelay}:depth=${depth}:regen=${regen}:width=${width}:speed=${speed}:shape=${shape}:phase=${phase}:interp=${interp}`;
 
         case 'pitch':
             // Pitch shift effect
@@ -305,10 +289,9 @@ function getFilterChain(filterName, options) {
 
         case 'tremolo':
             // Tremolo effect
-            // Options: speed, depth
-            const tremoloSpeed = options.speed !== undefined ? options.speed : 5;
-            const tremoloDepth = options.depth !== undefined ? options.depth : 0.5;
-            return `tremolo=f=${tremoloSpeed}:d=${tremoloDepth}`;
+            // Options: frequency
+            const frequency = options.frequency !== undefined ? options.frequency : 1;
+            return `tremolo=f=${frequency}`;
 
         case 'phaser':
             // Phaser effect
@@ -321,6 +304,34 @@ function getFilterChain(filterName, options) {
             const type = options.type !== undefined ? options.type : 0;
             return `aphaser=in_gain=${in_gain}:out_gain=${out_gain}:delay=${delay}:decay=${decay}:speed=${speed_ph}:type=${type}`;
 
+        case 'tempo':
+            // Change the speed without changing the tone
+            // Options: x (speed factor, between 0.5 and 2.0)
+            if (options.x !== undefined) {
+                const tempo = options.x;
+                if (tempo < 0.5 || tempo > 2.0) {
+                    // If the value is outside the supported range, chain filters
+                    const tempos = [];
+                    let remainingTempo = tempo;
+                    while (remainingTempo < 0.5 || remainingTempo > 2.0) {
+                        if (remainingTempo < 0.5) {
+                            tempos.push(0.5);
+                            remainingTempo /= 0.5;
+                        } else {
+                            tempos.push(2.0);
+                            remainingTempo /= 2.0;
+                        }
+                    }
+                    tempos.push(remainingTempo);
+                    const atempoFilters = tempos.map(t => `atempo=${t}`).join(',');
+                    return atempoFilters;
+                } else {
+                    return `atempo=${tempo}`;
+                }
+            } else {
+                throw new Error('The tempo filter requires the "x" option.');
+            }
+
         default:
             throw new Error(`Unknown filter: ${filterName}`);
     }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "sfxmix",
-    "description": "🎧 SfxMix - powerful and easy-to-use module for processing audio",
-    "version": "1.0.8",
+    "description": "🎧 SfxMix - Powerful and easy-to-use module for processing audio.",
+    "version": "1.1.2",
     "main": "index.js",
     "dependencies": {
         "fluent-ffmpeg": "^2.1.3",