lavalink-client 2.2.1 → 2.3.0

package/dist/cjs/structures/Filters.d.ts

@@ -1,5 +1,5 @@
-import { Player } from "./Player";
-import { FloatNumber, IntegerNumber } from "./Utils";
+import type { Player } from "./Player";
+import type { AudioOutputs, EQBand, FilterData, PlayerFilters, TimescaleFilter } from "./Types/Filters";
 /**
  * The FilterManager for each player
  */
@@ -143,218 +143,3 @@ export declare class FilterManager {
     /** Clears the equalizer bands. */
     clearEQ(): Promise<this>;
 }
-/** The Audio Outputs type */
-export type AudioOutputs = "mono" | "stereo" | "left" | "right";
-/**  The audio Outputs Data map declaration */
-export declare const audioOutputsData: Record<AudioOutputs, ChannelMixFilter>;
-/** The "active" / "disabled" Player Filters */
-export interface PlayerFilters {
-    /** Sets nightcore to false, and vaporwave to false */
-    custom: boolean;
-    /** Sets custom to false, and vaporwave to false */
-    nightcore: boolean;
-    /** Sets custom to false, and nightcore to false */
-    vaporwave: boolean;
-    /** If rotation filter is enabled / not */
-    rotation: boolean;
-    /** if karaoke filter is enabled / not */
-    karaoke: boolean;
-    /** if tremolo filter is enabled / not */
-    tremolo: boolean;
-    /** if vibrato filter is enabled / not */
-    vibrato: boolean;
-    lowPass: boolean;
-    /** audio Output (default stereo, mono sounds the fullest and best for not-stereo tracks) */
-    audioOutput: AudioOutputs;
-    /** Lavalink Volume FILTER (not player Volume, think of it as a gain booster) */
-    volume: boolean;
-    /** Filters for the Lavalink Filter Plugin */
-    lavalinkFilterPlugin: {
-        /** if echo filter is enabled / not */
-        echo: boolean;
-        /** if reverb filter is enabled / not */
-        reverb: boolean;
-    };
-    lavalinkLavaDspxPlugin: {
-        /** if lowPass filter is enabled / not */
-        lowPass: boolean;
-        /** if highPass filter is enabled / not */
-        highPass: boolean;
-        /** if normalization filter is enabled / not */
-        normalization: boolean;
-        /** if echo filter is enabled / not */
-        echo: boolean;
-    };
-}
-/**
- * There are 15 bands (0-14) that can be changed.
- * "gain" is the multiplier for the given band.
- * The default value is 0.
- *  Valid values range from -0.25 to 1.0, where -0.25 means the given band is completely muted, and 0.25 means it is doubled.
- * Modifying the gain could also change the volume of the output.
- */
-export interface EQBand {
-    /** On what band position (0-14) it should work */
-    band: IntegerNumber | number;
-    /** The gain (-0.25 to 1.0) */
-    gain: FloatNumber | number;
-}
-/**
- * Uses equalization to eliminate part of a band, usually targeting vocals.
- */
-export interface KaraokeFilter {
-    /** The level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect) */
-    level?: number;
-    /** The mono level (0 to 1.0 where 0.0 is no effect and 1.0 is full effect) */
-    monoLevel?: number;
-    /** The filter band (in Hz) */
-    filterBand?: number;
-    /**	The filter width */
-    filterWidth?: number;
-}
-/**
- * Changes the speed, pitch, and rate
- */
-export interface TimescaleFilter {
-    /** The playback speed 0.0 ≤ x */
-    speed?: number;
-    /** The pitch 0.0 ≤ x */
-    pitch?: number;
-    /** The rate 0.0 ≤ x */
-    rate?: number;
-}
-/**
- * Uses amplification to create a shuddering effect, where the volume quickly oscillates.
- * Demo: https://en.wikipedia.org/wiki/File:Fuse_Electronics_Tremolo_MK-III_Quick_Demo.ogv
- */
-export interface TremoloFilter {
-    /** The frequency 0.0 < x */
-    frequency?: number;
-    /** The tremolo depth 0.0 < x ≤ 1.0 */
-    depth?: number;
-}
-/**
- * Similar to tremolo. While tremolo oscillates the volume, vibrato oscillates the pitch.
- */
-export interface VibratoFilter {
-    /** The frequency 0.0 < x ≤ 14.0 */
-    frequency?: number;
-    /** The vibrato depth 0.0 < x ≤ 1.0 */
-    depth?: number;
-}
-/**
- * Rotates the sound around the stereo channels/user headphones (aka Audio Panning).
- * It can produce an effect similar to https://youtu.be/QB9EB8mTKcc (without the reverb).
- */
-export interface RotationFilter {
-    /** The frequency of the audio rotating around the listener in Hz. 0.2 is similar to the example video above */
-    rotationHz?: number;
-}
-/**
- * Distortion effect. It can generate some pretty unique audio effects.
- */
-export interface DistortionFilter {
-    sinOffset?: number;
-    sinScale?: number;
-    cosOffset?: number;
-    cosScale?: number;
-    tanOffset?: number;
-    tanScale?: number;
-    offset?: number;
-    scale?: number;
-}
-/**
- * Mixes both channels (left and right), with a configurable factor on how much each channel affects the other.
- * With the defaults, both channels are kept independent of each other.
- * Setting all factors to 0.5 means both channels get the same audio.
- */
-export interface ChannelMixFilter {
-    /** The left to left channel mix factor (0.0 ≤ x ≤ 1.0) */
-    leftToLeft?: number;
-    /** The left to right channel mix factor (0.0 ≤ x ≤ 1.0) */
-    leftToRight?: number;
-    /** The right to left channel mix factor (0.0 ≤ x ≤ 1.0) */
-    rightToLeft?: number;
-    /** The right to right channel mix factor (0.0 ≤ x ≤ 1.0) */
-    rightToRight?: number;
-}
-/**
- * Higher frequencies get suppressed, while lower frequencies pass through this filter, thus the name low pass.
- * Any smoothing values equal to or less than 1.0 will disable the filter.
- */
-export interface LowPassFilter {
-    /** The smoothing factor (1.0 < x) */
-    smoothing?: number;
-}
-/**
- * Filter Data stored in the Client and partially sent to Lavalink
- */
-export interface FilterData {
-    volume?: number;
-    karaoke?: KaraokeFilter;
-    timescale?: TimescaleFilter;
-    tremolo?: TremoloFilter;
-    vibrato?: VibratoFilter;
-    rotation?: RotationFilter;
-    distortion?: DistortionFilter;
-    channelMix?: ChannelMixFilter;
-    lowPass?: LowPassFilter;
-    pluginFilters?: {
-        "lavalink-filter-plugin"?: {
-            "echo"?: {
-                delay?: number;
-                decay?: number;
-            };
-            "reverb"?: {
-                delays?: number[];
-                gains?: number[];
-            };
-        };
-        "high-pass"?: {
-            cutoffFrequency?: number;
-            boostFactor?: number;
-        };
-        "low-pass"?: {
-            cutoffFrequency?: number;
-            boostFactor?: number;
-        };
-        normalization?: {
-            maxAmplitude?: number;
-            adaptive?: boolean;
-        };
-        echo?: {
-            echoLength?: number;
-            decay?: number;
-        };
-    };
-}
-/**
- * Actual Filter Data sent to Lavalink
- */
-export interface LavalinkFilterData extends FilterData {
-    equalizer?: EQBand[];
-}
-export declare const EQList: {
-    /** A Bassboost Equalizer, so high it distorts the audio */
-    BassboostEarrape: EQBand[];
-    /** A High and decent Bassboost Equalizer */
-    BassboostHigh: EQBand[];
-    /** A decent Bassboost Equalizer */
-    BassboostMedium: EQBand[];
-    /** A slight Bassboost Equalizer */
-    BassboostLow: EQBand[];
-    /** Makes the Music slightly "better" */
-    BetterMusic: EQBand[];
-    /** Makes the Music sound like rock music / sound rock music better */
-    Rock: EQBand[];
-    /** Makes the Music sound like Classic music / sound Classic music better */
-    Classic: EQBand[];
-    /** Makes the Music sound like Pop music / sound Pop music better */
-    Pop: EQBand[];
-    /** Makes the Music sound like Electronic music / sound Electronic music better */
-    Electronic: EQBand[];
-    /** Boosts all Bands slightly for louder and fuller sound */
-    FullSound: EQBand[];
-    /** Boosts basses + lower highs for a pro gaming sound */
-    Gaming: EQBand[];
-};

package/dist/cjs/structures/Filters.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EQList = exports.audioOutputsData = exports.FilterManager = void 0;
+exports.FilterManager = void 0;
+const Constants_1 = require("./Constants");
 /**
  * The FilterManager for each player
  */
@@ -78,16 +79,16 @@ class FilterManager {
             // "cutoffFrequency": 284, // Integer, higher than zero, in Hz.
             // "boostFactor": 1.24389    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.
             },
-            "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}. 
+            "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}.
             // "maxAmplitude": 0.6327, // Float, within the range of 0.0 - 1.0. A value of 0.0 mutes the output.
-            // "adaptive": true    // false 
+            // "adaptive": true    // false
             },
             "echo": { // Self-explanatory; provides an echo effect.
             // "echoLength": 0.5649, // Float, higher than 0.0, in seconds (1.0 = 1 second).
             // "decay": 0.4649       // Float, within the range of 0.0 - 1.0. A value of 1.0 means no decay, and a value of 0.0 means
             },
         },
-        channelMix: exports.audioOutputsData.stereo,
+        channelMix: Constants_1.audioOutputsData.stereo,
         /*distortion: {
             sinOffset: 0,
             sinScale: 1,
@@ -253,9 +254,9 @@ class FilterManager {
                 // "cutoffFrequency": 284, // Integer, higher than zero, in Hz.
                 // "boostFactor": 1.24389    // Float, higher than 0.0. This alters volume output. A value of 1.0 means no volume change.
                 },
-                "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}. 
+                "normalization": { // Attenuates peaking where peaks are defined as having a higher value than {maxAmplitude}.
                 // "maxAmplitude": 0.6327, // Float, within the range of 0.0 - 1.0. A value of 0.0 mutes the output.
-                // "adaptive": true    // false 
+                // "adaptive": true    // false
                 },
                 "echo": { // Self-explanatory; provides an echo effect.
                 // "echoLength": 0.5649, // Float, higher than 0.0, in seconds (1.0 = 1 second).
@@ -273,7 +274,7 @@ class FilterManager {
                 frequency: 0,
                 depth: 0 // 0 < x = 1
             },
-            channelMix: exports.audioOutputsData.stereo,
+            channelMix: Constants_1.audioOutputsData.stereo,
         })) {
             this.data[key] = value;
         }
@@ -300,9 +301,9 @@ class FilterManager {
     async setAudioOutput(type) {
         if (this.player.node.info && !this.player.node.info?.filters?.includes("channelMix"))
             throw new Error("Node#Info#filters does not include the 'channelMix' Filter (Node has it not enable)");
-        if (!type || !exports.audioOutputsData[type])
+        if (!type || !Constants_1.audioOutputsData[type])
             throw "Invalid audio type added, must be 'mono' / 'stereo' / 'left' / 'right'";
-        this.data.channelMix = exports.audioOutputsData[type];
+        this.data.channelMix = Constants_1.audioOutputsData[type];
         this.filters.audioOutput = type;
         await this.applyPlayerFilters();
         return this.filters.audioOutput;
@@ -383,7 +384,8 @@ class FilterManager {
             throw new Error("Node#Info#filters does not include the 'rotation' Filter (Node has it not enable)");
         this.data.rotation.rotationHz = this.filters.rotation ? 0 : rotationHz;
         this.filters.rotation = !this.filters.rotation;
-        return await this.applyPlayerFilters(), this.filters.rotation;
+        await this.applyPlayerFilters();
+        return this.filters.rotation;
     }
     /**
      * Enables / Disables the Vibrato effect, (Optional: provide your Own Data)
@@ -671,229 +673,3 @@ class FilterManager {
     }
 }
 exports.FilterManager = FilterManager;
-/**  The audio Outputs Data map declaration */
-exports.audioOutputsData = {
-    mono: {
-        leftToLeft: 0.5,
-        leftToRight: 0.5,
-        rightToLeft: 0.5,
-        rightToRight: 0.5,
-    },
-    stereo: {
-        leftToLeft: 1,
-        leftToRight: 0,
-        rightToLeft: 0,
-        rightToRight: 1,
-    },
-    left: {
-        leftToLeft: 1,
-        leftToRight: 0,
-        rightToLeft: 1,
-        rightToRight: 0,
-    },
-    right: {
-        leftToLeft: 0,
-        leftToRight: 1,
-        rightToLeft: 0,
-        rightToRight: 1,
-    },
-};
-exports.EQList = {
-    /** A Bassboost Equalizer, so high it distorts the audio */
-    BassboostEarrape: [
-        { band: 0, gain: 0.6 * 0.375 },
-        { band: 1, gain: 0.67 * 0.375 },
-        { band: 2, gain: 0.67 * 0.375 },
-        { band: 3, gain: 0.4 * 0.375 },
-        { band: 4, gain: -0.5 * 0.375 },
-        { band: 5, gain: 0.15 * 0.375 },
-        { band: 6, gain: -0.45 * 0.375 },
-        { band: 7, gain: 0.23 * 0.375 },
-        { band: 8, gain: 0.35 * 0.375 },
-        { band: 9, gain: 0.45 * 0.375 },
-        { band: 10, gain: 0.55 * 0.375 },
-        { band: 11, gain: -0.6 * 0.375 },
-        { band: 12, gain: 0.55 * 0.375 },
-        { band: 13, gain: -0.5 * 0.375 },
-        { band: 14, gain: -0.75 * 0.375 },
-    ],
-    /** A High and decent Bassboost Equalizer */
-    BassboostHigh: [
-        { band: 0, gain: 0.6 * 0.25 },
-        { band: 1, gain: 0.67 * 0.25 },
-        { band: 2, gain: 0.67 * 0.25 },
-        { band: 3, gain: 0.4 * 0.25 },
-        { band: 4, gain: -0.5 * 0.25 },
-        { band: 5, gain: 0.15 * 0.25 },
-        { band: 6, gain: -0.45 * 0.25 },
-        { band: 7, gain: 0.23 * 0.25 },
-        { band: 8, gain: 0.35 * 0.25 },
-        { band: 9, gain: 0.45 * 0.25 },
-        { band: 10, gain: 0.55 * 0.25 },
-        { band: 11, gain: -0.6 * 0.25 },
-        { band: 12, gain: 0.55 * 0.25 },
-        { band: 13, gain: -0.5 * 0.25 },
-        { band: 14, gain: -0.75 * 0.25 },
-    ],
-    /** A decent Bassboost Equalizer */
-    BassboostMedium: [
-        { band: 0, gain: 0.6 * 0.1875 },
-        { band: 1, gain: 0.67 * 0.1875 },
-        { band: 2, gain: 0.67 * 0.1875 },
-        { band: 3, gain: 0.4 * 0.1875 },
-        { band: 4, gain: -0.5 * 0.1875 },
-        { band: 5, gain: 0.15 * 0.1875 },
-        { band: 6, gain: -0.45 * 0.1875 },
-        { band: 7, gain: 0.23 * 0.1875 },
-        { band: 8, gain: 0.35 * 0.1875 },
-        { band: 9, gain: 0.45 * 0.1875 },
-        { band: 10, gain: 0.55 * 0.1875 },
-        { band: 11, gain: -0.6 * 0.1875 },
-        { band: 12, gain: 0.55 * 0.1875 },
-        { band: 13, gain: -0.5 * 0.1875 },
-        { band: 14, gain: -0.75 * 0.1875 },
-    ],
-    /** A slight Bassboost Equalizer */
-    BassboostLow: [
-        { band: 0, gain: 0.6 * 0.125 },
-        { band: 1, gain: 0.67 * 0.125 },
-        { band: 2, gain: 0.67 * 0.125 },
-        { band: 3, gain: 0.4 * 0.125 },
-        { band: 4, gain: -0.5 * 0.125 },
-        { band: 5, gain: 0.15 * 0.125 },
-        { band: 6, gain: -0.45 * 0.125 },
-        { band: 7, gain: 0.23 * 0.125 },
-        { band: 8, gain: 0.35 * 0.125 },
-        { band: 9, gain: 0.45 * 0.125 },
-        { band: 10, gain: 0.55 * 0.125 },
-        { band: 11, gain: -0.6 * 0.125 },
-        { band: 12, gain: 0.55 * 0.125 },
-        { band: 13, gain: -0.5 * 0.125 },
-        { band: 14, gain: -0.75 * 0.125 },
-    ],
-    /** Makes the Music slightly "better" */
-    BetterMusic: [
-        { band: 0, gain: 0.25 },
-        { band: 1, gain: 0.025 },
-        { band: 2, gain: 0.0125 },
-        { band: 3, gain: 0 },
-        { band: 4, gain: 0 },
-        { band: 5, gain: -0.0125 },
-        { band: 6, gain: -0.025 },
-        { band: 7, gain: -0.0175 },
-        { band: 8, gain: 0 },
-        { band: 9, gain: 0 },
-        { band: 10, gain: 0.0125 },
-        { band: 11, gain: 0.025 },
-        { band: 12, gain: 0.25 },
-        { band: 13, gain: 0.125 },
-        { band: 14, gain: 0.125 },
-    ],
-    /** Makes the Music sound like rock music / sound rock music better */
-    Rock: [
-        { band: 0, gain: 0.300 },
-        { band: 1, gain: 0.250 },
-        { band: 2, gain: 0.200 },
-        { band: 3, gain: 0.100 },
-        { band: 4, gain: 0.050 },
-        { band: 5, gain: -0.050 },
-        { band: 6, gain: -0.150 },
-        { band: 7, gain: -0.200 },
-        { band: 8, gain: -0.100 },
-        { band: 9, gain: -0.050 },
-        { band: 10, gain: 0.050 },
-        { band: 11, gain: 0.100 },
-        { band: 12, gain: 0.200 },
-        { band: 13, gain: 0.250 },
-        { band: 14, gain: 0.300 },
-    ],
-    /** Makes the Music sound like Classic music / sound Classic music better */
-    Classic: [
-        { band: 0, gain: 0.375 },
-        { band: 1, gain: 0.350 },
-        { band: 2, gain: 0.125 },
-        { band: 3, gain: 0 },
-        { band: 4, gain: 0 },
-        { band: 5, gain: 0.125 },
-        { band: 6, gain: 0.550 },
-        { band: 7, gain: 0.050 },
-        { band: 8, gain: 0.125 },
-        { band: 9, gain: 0.250 },
-        { band: 10, gain: 0.200 },
-        { band: 11, gain: 0.250 },
-        { band: 12, gain: 0.300 },
-        { band: 13, gain: 0.250 },
-        { band: 14, gain: 0.300 },
-    ],
-    /** Makes the Music sound like Pop music / sound Pop music better */
-    Pop: [
-        { band: 0, gain: 0.2635 },
-        { band: 1, gain: 0.22141 },
-        { band: 2, gain: -0.21141 },
-        { band: 3, gain: -0.1851 },
-        { band: 4, gain: -0.155 },
-        { band: 5, gain: 0.21141 },
-        { band: 6, gain: 0.22456 },
-        { band: 7, gain: 0.237 },
-        { band: 8, gain: 0.237 },
-        { band: 9, gain: 0.237 },
-        { band: 10, gain: -0.05 },
-        { band: 11, gain: -0.116 },
-        { band: 12, gain: 0.192 },
-        { band: 13, gain: 0 },
-    ],
-    /** Makes the Music sound like Electronic music / sound Electronic music better */
-    Electronic: [
-        { band: 0, gain: 0.375 },
-        { band: 1, gain: 0.350 },
-        { band: 2, gain: 0.125 },
-        { band: 3, gain: 0 },
-        { band: 4, gain: 0 },
-        { band: 5, gain: -0.125 },
-        { band: 6, gain: -0.125 },
-        { band: 7, gain: 0 },
-        { band: 8, gain: 0.25 },
-        { band: 9, gain: 0.125 },
-        { band: 10, gain: 0.15 },
-        { band: 11, gain: 0.2 },
-        { band: 12, gain: 0.250 },
-        { band: 13, gain: 0.350 },
-        { band: 14, gain: 0.400 },
-    ],
-    /** Boosts all Bands slightly for louder and fuller sound */
-    FullSound: [
-        { band: 0, gain: 0.25 + 0.375 },
-        { band: 1, gain: 0.25 + 0.025 },
-        { band: 2, gain: 0.25 + 0.0125 },
-        { band: 3, gain: 0.25 + 0 },
-        { band: 4, gain: 0.25 + 0 },
-        { band: 5, gain: 0.25 + -0.0125 },
-        { band: 6, gain: 0.25 + -0.025 },
-        { band: 7, gain: 0.25 + -0.0175 },
-        { band: 8, gain: 0.25 + 0 },
-        { band: 9, gain: 0.25 + 0 },
-        { band: 10, gain: 0.25 + 0.0125 },
-        { band: 11, gain: 0.25 + 0.025 },
-        { band: 12, gain: 0.25 + 0.375 },
-        { band: 13, gain: 0.25 + 0.125 },
-        { band: 14, gain: 0.25 + 0.125 },
-    ],
-    /** Boosts basses + lower highs for a pro gaming sound */
-    Gaming: [
-        { band: 0, gain: 0.350 },
-        { band: 1, gain: 0.300 },
-        { band: 2, gain: 0.250 },
-        { band: 3, gain: 0.200 },
-        { band: 4, gain: 0.150 },
-        { band: 5, gain: 0.100 },
-        { band: 6, gain: 0.050 },
-        { band: 7, gain: -0.0 },
-        { band: 8, gain: -0.050 },
-        { band: 9, gain: -0.100 },
-        { band: 10, gain: -0.150 },
-        { band: 11, gain: -0.200 },
-        { band: 12, gain: -0.250 },
-        { band: 13, gain: -0.300 },
-        { band: 14, gain: -0.350 },
-    ],
-};