sfxmix 1.0.2 → 1.0.6

package/README.md

@@ -44,21 +44,21 @@ npm install sfxmix
 ```javascript
 const SfxMix = require('sfxmix');
 
-const processor = new SfxMix();
-
-processor
-  .add('intro.mp3')
-  .silence(2000) // 2 seconds of silence
-  .add('main.mp3')
-  .filter('normalize', { i: -14, tp: -2.0, lra: 7.0 })
-  .mix('background.mp3', { duration: 'first' })
-  .save('final_output.mp3')
-  .then(() => {
-    console.log('Audio processing completed successfully! 🎉');
-  })
-  .catch((err) => {
-    console.error('Error during audio processing:', err);
-  });
+const sfx = new SfxMix();
+
+sfx
+    .add('intro.mp3')
+    .silence(2000) // 2 seconds of silence
+    .add('main.mp3')
+    .filter('normalize', { i: -14, tp: -2.0, lra: 7.0 })
+    .mix('background.mp3', { duration: 'first' })
+    .save('final_output.mp3')
+    .then(() => {
+        console.log('Audio exported to final_output.mp3 🎉');
+    })
+    .catch((err) => {
+        console.error('Error during audio processing:', err);
+    });
 ```
 ---
 
@@ -67,53 +67,53 @@ processor
 ### 1. Concatenate and Mix with Background Music
 
 ```javascript
-processor
-  .add('intro.mp3')
-  .add('chapter1.mp3')
-  .add('chapter2.mp3')
-  .mix('background_music.mp3', { duration: 'first' })
-  .save('audiobook_with_music.mp3');
+sfx
+    .add('intro.mp3')
+    .add('chapter1.mp3')
+    .add('chapter2.mp3')
+    .mix('background_music.mp3', { duration: 'first' })
+    .save('audiobook_with_music.mp3');
 ```
 
 ### 2. Apply Multiple Filters
 
 ```javascript
-processor
-  .add('voiceover.mp3')
-  .filter('normalize', { i: -14 })
-  .filter('equalizer', { frequency: 3000, width: 1000, gain: 5 })
-  .save('processed_voiceover.mp3');
+sfx
+    .add('voiceover.mp3')
+    .filter('normalize', { i: -14 })
+    .filter('equalizer', { frequency: 3000, width: 1000, gain: 5 })
+    .save('processed_voiceover.mp3');
 ```
 
 ### 3. Insert Silence Between Tracks
 
 ```javascript
-processor
-  .add('track1.mp3')
-  .silence(2000)
-  .add('track2.mp3')
-  .silence(2000)
-  .add('track3.mp3')
-  .save('album_with_silence.mp3');
+sfx
+    .add('track1.mp3')
+    .silence(2000)
+    .add('track2.mp3')
+    .silence(2000)
+    .add('track3.mp3')
+    .save('album_with_silence.mp3');
 ```
 
 ### 4. Apply Telephone Effect
 
 ```javascript
-processor
-  .add('dialogue.mp3')
-  .filter('telephone')
-  .save('telephone_effect.mp3');
+sfx
+    .add('dialogue.mp3')
+    .filter('telephone')
+    .save('telephone_effect.mp3');
 ```
 
 ### 5. Adjust Volume and Add Echo
 
 ```javascript
-processor
-  .add('announcement.mp3')
-  .filter('volume', { volume: 1.5 })
-  .filter('echo', { delay: 750, decay: 0.7 })
-  .save('enhanced_announcement.mp3');
+sfx
+    .add('announcement.mp3')
+    .filter('volume', { volume: 1.5 })
+    .filter('echo', { delay: 750, decay: 0.7 })
+    .save('enhanced_announcement.mp3');
 ```
 
 ---
@@ -134,7 +134,7 @@ processor
 
 ### `add(input)`
 
-Adds an audio file to the processor for concatenation.
+Adds an audio file to the sfx for concatenation.
 
 - **Parameters:**
   - `input` (string): Path to the audio file.
@@ -143,7 +143,7 @@ Adds an audio file to the processor for concatenation.
 **Example:**
 
 ```javascript
-processor.add('part1.mp3').add('part2.mp3');
+sfx.add('part1.mp3').add('part2.mp3');
 ```
 
 ---
@@ -161,7 +161,7 @@ Mixes an audio file with the current audio.
 **Example:**
 
 ```javascript
-processor.mix('sound_effect.wav', { duration: 'first' });
+sfx.mix('sound_effect.wav', { duration: 'first' });
 ```
 
 ---
@@ -177,7 +177,7 @@ Inserts silence into the audio sequence.
 **Example:**
 
 ```javascript
-processor.silence(3000); // Inserts 3 seconds of silence
+sfx.silence(3000); // Inserts 3 seconds of silence
 ```
 
 ---
@@ -193,14 +193,19 @@ Applies an audio filter to the current audio.
 
 **Supported Filters:**
 
-- [`normalize`](#filternormalize)
-- [`telephone`](#filtertelephone)
-- [`echo`](#filterecho)
-- [`reverb`](#filterreverb)
-- [`highpass`](#filterhighpass)
-- [`lowpass`](#filterlowpass)
-- [`volume`](#filtervolume)
-- [`equalizer`](#filterequalizer)
+- [`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)
 
 ---
 
@@ -215,7 +220,7 @@ Processes the audio according to the specified actions and saves the result.
 **Example:**
 
 ```javascript
-processor.save('output.mp3');
+sfx.save('output.mp3');
 ```
 
 ---
@@ -227,14 +232,14 @@ processor.save('output.mp3');
 Normalizes audio loudness to a specified target using the EBU R128 standard.
 
 - **Options:**
-  - `tp` (number): Maximum true peak level in dBTP (default: `-1.5`).
+  - `tp` (number): Maximum true peak level in dBTP (default: `-3`).
   - `i` (number): Target integrated loudness in LUFS (default: `-16`).
   - `lra` (number): Loudness range in LU (default: `11`).
 
 **Example:**
 
 ```javascript
-processor.filter('normalize', { i: -14, tp: -2.0, lra: 7.0 });
+sfx.filter('normalize', { i: -14, tp: -2.0, lra: 7.0 });
 ```
 
 ---
@@ -245,12 +250,12 @@ Applies a telephone effect by applying high-pass and low-pass filters.
 
 - **Options:**
   - `lowFreq` (number): High-pass filter cutoff frequency in Hz (default: `300`).
-  - `highFreq` (number): Low-pass filter cutoff frequency in Hz (default: `3400`).
+  - `highFreq` (number): Low-pass filter cutoff frequency in Hz (default: `3000`).
 
 **Example:**
 
 ```javascript
-processor.filter('telephone', { lowFreq: 400, highFreq: 3000 });
+sfx.filter('telephone', { lowFreq: 400, highFreq: 3000 });
 ```
 
 ---
@@ -266,7 +271,7 @@ Adds an echo effect to the audio.
 **Example:**
 
 ```javascript
-processor.filter('echo', { delay: 1000, decay: 0.6 });
+sfx.filter('echo', { delay: 1000, decay: 0.6 });
 ```
 
 ---
@@ -275,12 +280,20 @@ processor.filter('echo', { delay: 1000, decay: 0.6 });
 
 Applies a reverb effect to the audio.
 
-- **Options:** None
+- **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
-processor.filter('reverb');
+sfx.filter('reverb');
 ```
 
 ---
@@ -295,7 +308,7 @@ Applies a high-pass filter to remove frequencies below the cutoff.
 **Example:**
 
 ```javascript
-processor.filter('highpass', { frequency: 1000 });
+sfx.filter('highpass', { frequency: 1000 });
 ```
 
 ---
@@ -310,7 +323,7 @@ Applies a low-pass filter to remove frequencies above the cutoff.
 **Example:**
 
 ```javascript
-processor.filter('lowpass', { frequency: 2000 });
+sfx.filter('lowpass', { frequency: 2000 });
 ```
 
 ---
@@ -325,7 +338,7 @@ Adjusts the audio volume.
 **Example:**
 
 ```javascript
-processor.filter('volume', { volume: 0.8 });
+sfx.filter('volume', { volume: 0.8 });
 ```
 
 ---
@@ -342,29 +355,108 @@ Applies an equalizer effect to adjust specific frequencies.
 **Example:**
 
 ```javascript
-processor.filter('equalizer', { frequency: 1000, width: 200, gain: -10 });
+sfx.filter('equalizer', { frequency: 1000, width: 200, gain: -10 });
 ```
 
 ---
 
-## ⚠️ Important Notes
+### Filter: `compressor`
 
-- **FFmpeg Installation:** Ensure FFmpeg is installed and accessible in your system's PATH.
-- **File Permissions:** The module creates and deletes temporary files during processing. Ensure the application has the necessary permissions.
-- **Audio Formats:** The module assumes input files are in MP3 format. For other formats, adjust codec and format settings accordingly.
-- **Error Handling:** Always handle rejections from the `save()` method to catch any processing errors.
+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 });
+```
 
 ---
 
-## 📄 License
+### Filter: `flanger`
+
+Applies a flanger effect to the audio.
+
+- **Options:**
+  - `delay` (number): Base delay in milliseconds (default: `0`).
+  - `depth` (number): Oscillation depth (default: `2`).
+  - `regen` (number): Regeneration (feedback) (default: `0`).
+  - `width` (number): Percentage of delayed signal mixed (default: `71`).
+  - `speed` (number): Oscillation speed in Hz (default: `0.5`).
+  - `shape` (string): Oscillator wave shape (`'sine'` or `'triangular'`) (default: `'sine'`).
+  - `phase` (number): Percentage of offset for second delayed signal (default: `25`).
+  - `interp` (string): Delay line interpolation (`'linear'` or `'quadratic'`) (default: `'linear'`).
+
+**Example:**
+
+```javascript
+sfx.filter('flanger', { delay: 5, depth: 3, speed: 0.8 });
+```
+
+---
+
+### Filter: `pitch`
+
+Shifts the pitch of the audio.
+
+- **Options:**
+  - `pitch` (number): Pitch shift in semitones (positive or negative).
+
+**Example:**
+
+```javascript
+sfx.filter('pitch', { pitch: 2 }); // Shift pitch up by 2 semitones
+```
+
+---
+
+### Filter: `tremolo`
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+Applies a tremolo effect to the audio.
+
+- **Options:**
+  - `speed` (number): Modulation frequency in Hz (default: `5`).
+  - `depth` (number): Modulation depth (0-1) (default: `0.5`).
+
+**Example:**
+
+```javascript
+sfx.filter('tremolo', { speed: 6, depth: 0.7 });
+```
+
+---
+
+### Filter: `phaser`
+
+Applies a phaser effect to the audio.
+
+- **Options:**
+  - `in_gain` (number): Input gain (default: `0.4`).
+  - `out_gain` (number): Output gain (default: `0.74`).
+  - `delay` (number): Delay in milliseconds (default: `3`).
+  - `decay` (number): Decay (default: `0.4`).
+  - `speed` (number): Modulation speed in Hz (default: `0.5`).
+  - `type` (number): Modulation type (0-1) (default: `0`).
+
+**Example:**
+
+```javascript
+sfx.filter('phaser', { delay: 4, decay: 0.5, speed: 0.8 });
+```
 
 ---
 
-## 🙌 Contributing
+## ⚠️ Important Notes
 
-Contributions are welcome! Feel free to submit a pull request or open an issue on GitHub.
+- **FFmpeg Installation:** Ensure FFmpeg is installed and accessible in your system's PATH.
+- **File Permissions:** The module creates and deletes temporary files during processing. Ensure the application has the necessary permissions.
+- **Audio Formats:** The module assumes input files are in MP3 format. For other formats, adjust codec and format settings accordingly.
+- **Error Handling:** Always handle rejections from the `save()` method to catch any processing errors.
 
 ---
 
@@ -388,4 +480,24 @@ If you encounter any issues or have questions, please open an issue on the [GitH
 
 ---
 
+## 🤝 Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvement, please open an issue or submit a pull request on the [GitHub repository](https://github.com/clasen/ModelMix).
+
+---
+
+## 📄 License
+
+The MIT License (MIT)
+
+Copyright (c) Martin Clasen
+
+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.
+
+---
+
 Enjoy processing your audio with **SfxMix**! 🎶✨

package/index.js

@@ -209,55 +209,120 @@ function getFilterChain(filterName, options) {
     switch (filterName) {
         case 'normalize':
             // Normalize audio using loudnorm filter with parameters
-            // Options: i (target integrated loudness), tp (true peak), lra (loudness range)
+            const tp = options.tp || -3;
             const i = options.i || -16;
-            const tp = options.tp || -1.5;
             const lra = options.lra || 11;
             return `loudnorm=I=${i}:TP=${tp}:LRA=${lra}:print_format=none`;
+
         case 'telephone':
             // Telephone effect with parameters
-            // Options: lowFreq (default 300), highFreq (default 3400)
             const lowFreq = options.lowFreq || 300;
-            const highFreq = options.highFreq || 3400;
+            const highFreq = options.highFreq || 3000;
             return `highpass=f=${lowFreq}, lowpass=f=${highFreq}`;
+
         case 'echo':
-            // Default echo parameters: delay=500ms, decay=0.5
+            // 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':
-            // Simple reverb effect
-            return 'areverb';
+            // 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}`;
+
         case 'highpass':
-            // High-pass filter: cutoff frequency in Hz
+            // High-pass filter
             if (options.frequency) {
                 return `highpass=f=${options.frequency}`;
             } else {
                 throw new Error('High-pass filter requires "frequency" option.');
             }
+
         case 'lowpass':
-            // Low-pass filter: cutoff frequency in Hz
+            // Low-pass filter
             if (options.frequency) {
                 return `lowpass=f=${options.frequency}`;
             } else {
                 throw new Error('Low-pass filter requires "frequency" option.');
             }
+
         case 'volume':
-            // Volume adjustment: volume multiplier (e.g., 0.5 for 50%)
+            // Volume adjustment
             if (options.volume !== undefined) {
                 return `volume=${options.volume}`;
             } else {
                 throw new Error('Volume filter requires "volume" option.');
             }
+
         case 'equalizer':
-            // Equalizer filter: frequency, width, gain
+            // Equalizer filter
             if (options.frequency && options.width && options.gain !== undefined) {
                 return `equalizer=f=${options.frequency}:width_type=h:width=${options.width}:g=${options.gain}`;
             } else {
                 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
+            const flangerDelay = options.delay !== undefined ? options.delay : 0;
+            const depth = options.depth !== undefined ? options.depth : 2;
+            const regen = options.regen !== undefined ? options.regen : 0;
+            const width = options.width !== undefined ? options.width : 71;
+            const speed = options.speed !== undefined ? options.speed : 0.5;
+            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}`;
+
+        case 'pitch':
+            // Pitch shift effect
+            // Options: pitch (in semitones)
+            if (options.pitch !== undefined) {
+                const pitch = options.pitch;
+                return `asetrate=44100*${Math.pow(2, pitch / 12)},aresample=44100`;
+            } else {
+                throw new Error('Pitch filter requires "pitch" option.');
+            }
+
+        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}`;
+
+        case 'phaser':
+            // Phaser effect
+            // Options: in_gain, out_gain, delay, decay, speed, type
+            const in_gain = options.in_gain !== undefined ? options.in_gain : 0.4;
+            const out_gain = options.out_gain !== undefined ? options.out_gain : 0.74;
+            const delay = options.delay !== undefined ? options.delay : 3;
+            const decay = options.decay !== undefined ? options.decay : 0.4;
+            const speed_ph = options.speed !== undefined ? options.speed : 0.5;
+            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}`;
+
         default:
-            return null;
+            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.2",
+    "version": "1.0.6",
     "main": "index.js",
     "dependencies": {
         "fluent-ffmpeg": "^2.1.3",
@@ -22,6 +22,14 @@
         "wav",
         "echo",
         "delay",
+        "tremolo",
+        "pitch",
+        "phaser",
+        "compressor",
+        "flanger",
+        "reverb",
+        "highpass",
+        "lowpass",        
         "telephone",
         "equalizer",
         "volume",