discord-player 5.3.2-dev.3 → 5.4.0

package/README.md

@@ -32,6 +32,7 @@ $ npm install --save @discordjs/opus
 - Simple & easy to use 🤘
 - Beginner friendly 😱
 - Audio filters 🎸
+- Lavalink compatible 15 band equalizer 🎚️
 - Lightweight ☁️
 - Custom extractors support 🌌
 - Multiple sources support ✌
@@ -163,6 +164,7 @@ These bots are made by the community, they can help you build your own!
 * **[Discord Music Bot](https://github.com/Androz2091/discord-music-bot)** by [Androz2091](https://github.com/Androz2091)
 * [Dodong](https://github.com/nizeic/Dodong) by [nizeic](https://github.com/nizeic)
 * [Musico](https://github.com/Whirl21/Musico) by [Whirl21](https://github.com/Whirl21)
+* [Melody](https://github.com/NerdyTechy/Melody) by [NerdyTechy](https://github.com/NerdyTechy)
 * [Eyesense-Music-Bot](https://github.com/naseif/Eyesense-Music-Bot) by [naseif](https://github.com/naseif)
 * [Music-bot](https://github.com/ZerioDev/Music-bot) by [ZerioDev](https://github.com/ZerioDev)
 * [AtlantaBot](https://github.com/Androz2091/AtlantaBot) by [Androz2091](https://github.com/Androz2091) (**outdated**)

package/dist/Player.js

@@ -95,6 +95,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
         const queue = this.getQueue(oldState.guild.id);
         if (!queue || !queue.connection)
             return;
+        this.emit("voiceStateUpdate", queue, oldState, newState);
         if (oldState.channelId && !newState.channelId && newState.member.id === newState.guild.members.me.id) {
             try {
                 queue.destroy();
@@ -105,11 +106,11 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
             return void this.emit("botDisconnect", queue);
         }
         if (!oldState.channelId && newState.channelId && newState.member.id === newState.guild.members.me.id) {
-            if (!oldState.serverMute && newState.serverMute) {
+            if (oldState.serverMute !== newState.serverMute) {
                 // state.serverMute can be null
                 queue.setPaused(!!newState.serverMute);
             }
-            else if (!oldState.suppress && newState.suppress) {
+            else if (oldState.suppress !== newState.suppress) {
                 // state.suppress can be null
                 queue.setPaused(!!newState.suppress);
                 if (newState.suppress) {
@@ -117,20 +118,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 }
             }
         }
-        if (oldState.channelId === newState.channelId && newState.member.id === newState.guild.members.me.id) {
-            if (!oldState.serverMute && newState.serverMute) {
-                // state.serverMute can be null
-                queue.setPaused(!!newState.serverMute);
-            }
-            else if (!oldState.suppress && newState.suppress) {
-                // state.suppress can be null
-                queue.setPaused(!!newState.suppress);
-                if (newState.suppress) {
-                    newState.guild.members.me.voice.setRequestToSpeak(true).catch(Util_1.Util.noop);
-                }
-            }
-        }
-        if (queue.connection && !newState.channelId && oldState.channelId === queue.connection.channel.id) {
+        if (!newState.channelId && oldState.channelId === queue.connection.channel.id) {
             if (!Util_1.Util.isVoiceEmpty(queue.connection.channel))
                 return;
             const timeout = setTimeout(() => {
@@ -144,7 +132,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
             }, queue.options.leaveOnEmptyCooldown || 0).unref();
             queue._cooldownsTimeout.set(`empty_${oldState.guild.id}`, timeout);
         }
-        if (queue.connection && newState.channelId && newState.channelId === queue.connection.channel.id) {
+        if (newState.channelId && newState.channelId === queue.connection.channel.id) {
             const emptyTimeout = queue._cooldownsTimeout.get(`empty_${oldState.guild.id}`);
             const channelEmpty = Util_1.Util.isVoiceEmpty(queue.connection.channel);
             if (!channelEmpty && emptyTimeout) {
@@ -152,26 +140,54 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 queue._cooldownsTimeout.delete(`empty_${oldState.guild.id}`);
             }
         }
-        if (oldState.channelId && newState.channelId && oldState.channelId !== newState.channelId && newState.member.id === newState.guild.members.me.id) {
-            if (queue.connection && newState.member.id === newState.guild.members.me.id)
-                queue.connection.channel = newState.channel;
-            const emptyTimeout = queue._cooldownsTimeout.get(`empty_${oldState.guild.id}`);
-            const channelEmpty = Util_1.Util.isVoiceEmpty(queue.connection.channel);
-            if (!channelEmpty && emptyTimeout) {
-                clearTimeout(emptyTimeout);
-                queue._cooldownsTimeout.delete(`empty_${oldState.guild.id}`);
+        if (oldState.channelId && newState.channelId && oldState.channelId !== newState.channelId) {
+            if (newState.member.id === newState.guild.members.me.id) {
+                if (queue.connection && newState.member.id === newState.guild.members.me.id)
+                    queue.connection.channel = newState.channel;
+                const emptyTimeout = queue._cooldownsTimeout.get(`empty_${oldState.guild.id}`);
+                const channelEmpty = Util_1.Util.isVoiceEmpty(queue.connection.channel);
+                if (!channelEmpty && emptyTimeout) {
+                    clearTimeout(emptyTimeout);
+                    queue._cooldownsTimeout.delete(`empty_${oldState.guild.id}`);
+                }
+                else {
+                    const timeout = setTimeout(() => {
+                        if (queue.connection && !Util_1.Util.isVoiceEmpty(queue.connection.channel))
+                            return;
+                        if (!this.queues.has(queue.guild.id))
+                            return;
+                        if (queue.options.leaveOnEmpty)
+                            queue.destroy(true);
+                        this.emit("channelEmpty", queue);
+                    }, queue.options.leaveOnEmptyCooldown || 0).unref();
+                    queue._cooldownsTimeout.set(`empty_${oldState.guild.id}`, timeout);
+                }
             }
             else {
-                const timeout = setTimeout(() => {
-                    if (queue.connection && !Util_1.Util.isVoiceEmpty(queue.connection.channel))
+                if (newState.channelId !== queue.connection.channel.id) {
+                    if (!Util_1.Util.isVoiceEmpty(queue.connection.channel))
                         return;
-                    if (!this.queues.has(queue.guild.id))
+                    if (queue._cooldownsTimeout.has(`empty_${oldState.guild.id}`))
                         return;
-                    if (queue.options.leaveOnEmpty)
-                        queue.destroy(true);
-                    this.emit("channelEmpty", queue);
-                }, queue.options.leaveOnEmptyCooldown || 0).unref();
-                queue._cooldownsTimeout.set(`empty_${oldState.guild.id}`, timeout);
+                    const timeout = setTimeout(() => {
+                        if (!Util_1.Util.isVoiceEmpty(queue.connection.channel))
+                            return;
+                        if (!this.queues.has(queue.guild.id))
+                            return;
+                        if (queue.options.leaveOnEmpty)
+                            queue.destroy(true);
+                        this.emit("channelEmpty", queue);
+                    }, queue.options.leaveOnEmptyCooldown || 0).unref();
+                    queue._cooldownsTimeout.set(`empty_${oldState.guild.id}`, timeout);
+                }
+                else {
+                    const emptyTimeout = queue._cooldownsTimeout.get(`empty_${oldState.guild.id}`);
+                    const channelEmpty = Util_1.Util.isVoiceEmpty(queue.connection.channel);
+                    if (!channelEmpty && emptyTimeout) {
+                        clearTimeout(emptyTimeout);
+                        queue._cooldownsTimeout.delete(`empty_${oldState.guild.id}`);
+                    }
+                }
             }
         }
     }
@@ -429,14 +445,14 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 }
                 else {
                     // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                    playlist.tracks = spotifyPlaylist.tracks.items.map((m) => {
+                    playlist.tracks = spotifyPlaylist.trackList.map((m) => {
                         const data = new Track_1.default(this, {
-                            title: m.track.name ?? "",
-                            description: m.track.description ?? "",
-                            author: m.track.artists?.[0]?.name ?? "Unknown Artist",
-                            url: m.track.external_urls?.spotify ?? query,
-                            thumbnail: m.track.album?.images?.[0]?.url ?? "https://www.scdn.co/i/_global/twitter_card-default.jpg",
-                            duration: Util_1.Util.buildTimeCode(Util_1.Util.parseMS(m.track.duration_ms)),
+                            title: m.title ?? "",
+                            description: m.description ?? "",
+                            author: m.subtitle ?? "Unknown Artist",
+                            url: m.external_urls?.spotify ?? query,
+                            thumbnail: m.album?.images?.[0]?.url ?? "https://www.scdn.co/i/_global/twitter_card-default.jpg",
+                            duration: Util_1.Util.buildTimeCode(Util_1.Util.parseMS(m.duration)),
                             views: 0,
                             requestedBy: options.requestedBy,
                             playlist,

package/dist/Structures/Queue.js

@@ -34,6 +34,7 @@ class Queue {
         this._cooldownsTimeout = new discord_js_1.Collection();
         this._activeFilters = []; // eslint-disable-line @typescript-eslint/no-explicit-any
         this._filtersUpdate = false;
+        this._lastEQBands = [];
         _Queue_destroyed.set(this, false);
         this.onBeforeCreateStream = null;
         /**
@@ -96,12 +97,98 @@ class Queue {
             initialVolume: 100,
             bufferingTimeout: 3000,
             spotifyBridge: true,
-            disableVolume: false
+            disableVolume: false,
+            disableEqualizer: false,
+            equalizerBands: []
         }, options);
+        if (Array.isArray(options.equalizerBands))
+            this._lastEQBands = options.equalizerBands;
         if ("onBeforeCreateStream" in this.options)
             this.onBeforeCreateStream = this.options.onBeforeCreateStream;
         this.player.emit("debug", this, `Queue initialized:\n\n${this.player.scanDeps()}`);
     }
+    /**
+     * Set equalizer bands
+     * @param bands Equalizer band multiplier array
+     */
+    setEqualizer(bands) {
+        if (!this.connection.equalizer)
+            return false;
+        if (!Array.isArray(bands) || !bands.length) {
+            this.connection.equalizer.resetEQ();
+            this._lastEQBands = this.getEqualizer();
+        }
+        else {
+            this.connection.equalizer.setEQ(bands);
+            this._lastEQBands = this.getEqualizer();
+        }
+        return true;
+    }
+    /**
+     * Set particular equalizer band multiplier
+     * @param band The band to update
+     * @param gain The gain
+     */
+    setEqualizerBand(band, gain) {
+        if (!this.connection.equalizer)
+            return null;
+        this.connection.equalizer.equalizer.setGain(band, gain);
+        this._lastEQBands = this.getEqualizer();
+        return true;
+    }
+    /**
+     * Returns gain value of specific equalizer band
+     * @param band The band to get value of
+     */
+    getEqualizerBand(band) {
+        if (!this.connection.equalizer)
+            return null;
+        return this.connection.equalizer.equalizer.getGain(band);
+    }
+    /**
+     * Returns entire equalizer bands
+     */
+    getEqualizer() {
+        if (!this.connection.equalizer)
+            return [];
+        return this.connection.equalizer.getEQ();
+    }
+    /**
+     * Check if equalizer is enabled
+     */
+    isEqualizerEnabled() {
+        return !this.connection.equalizer?.disabled;
+    }
+    /**
+     * Toggles equalizer on/off
+     */
+    toggleEqualizer() {
+        const eq = this.connection.equalizer;
+        if (!eq)
+            return false;
+        eq.toggle();
+        return !eq.disabled;
+    }
+    /**
+     * Enables equalizer
+     */
+    enableEqualizer() {
+        const eq = this.connection.equalizer;
+        if (!eq)
+            return false;
+        eq.enable();
+        return !eq.disabled;
+    }
+    /**
+     * Disables equalizer
+     */
+    disableEqualizer() {
+        const eq = this.connection.equalizer;
+        if (!eq)
+            return false;
+        eq.disable();
+        return eq.disabled;
+    }
     /**
      * Forces next play
      * @returns {Promise<void>}
@@ -185,8 +272,6 @@ class Queue {
             if (this._filtersUpdate)
                 return;
             this._streamTime = 0;
-            if (resource?.metadata)
-                this.previousTracks.push(resource.metadata);
             this.player.emit("trackEnd", this, resource.metadata);
             if (!this.tracks.length && this.repeatMode === types_1.QueueRepeatMode.OFF) {
                 this.emitEnd();
@@ -730,7 +815,9 @@ class Queue {
         const resource = this.connection.createStream(ffmpegStream, {
             type: voice_1.StreamType.Raw,
             data: track,
-            disableVolume: Boolean(this.options.disableVolume)
+            disableVolume: Boolean(this.options.disableVolume),
+            disableEqualizer: Boolean(this.options.disableEqualizer),
+            eq: this._lastEQBands
         });
         if (options.seek)
             this._streamTime = options.seek;

package/dist/VoiceInterface/StreamDispatcher.js

@@ -5,6 +5,7 @@ const voice_1 = require("@discordjs/voice");
 const tiny_typed_emitter_1 = require("tiny-typed-emitter");
 const Util_1 = require("../utils/Util");
 const PlayerError_1 = require("../Structures/PlayerError");
+const equalizer_1 = require("@discord-player/equalizer");
 class StreamDispatcher extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Creates new connection object
@@ -16,6 +17,7 @@ class StreamDispatcher extends tiny_typed_emitter_1.TypedEmitter {
         super();
         this.connectionTimeout = connectionTimeout;
         this.readyLock = false;
+        this.equalizer = null;
         /**
          * The voice connection
          * @type {VoiceConnection}
@@ -95,6 +97,10 @@ class StreamDispatcher extends tiny_typed_emitter_1.TypedEmitter {
             else if (newState.status === voice_1.AudioPlayerStatus.Idle && oldState.status !== voice_1.AudioPlayerStatus.Idle) {
                 if (!this.paused) {
                     void this.emit("finish", this.audioResource);
+                    if (this.equalizer) {
+                        this.equalizer.destroy();
+                        this.equalizer = null;
+                    }
                     this.audioResource = null;
                 }
             }
@@ -111,11 +117,17 @@ class StreamDispatcher extends tiny_typed_emitter_1.TypedEmitter {
      */
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     createStream(src, ops) {
-        this.audioResource = (0, voice_1.createAudioResource)(src, {
+        if (!ops.disableEqualizer)
+            this.equalizer = new equalizer_1.EqualizerStream({
+                channels: 1,
+                disabled: false,
+                bandMultiplier: ops.eq || []
+            });
+        const stream = this.equalizer && typeof src !== "string" ? src.pipe(this.equalizer) : src;
+        this.audioResource = (0, voice_1.createAudioResource)(stream, {
             inputType: ops?.type ?? voice_1.StreamType.Arbitrary,
             metadata: ops?.data,
-            // eslint-disable-next-line no-extra-boolean-cast
-            inlineVolume: !Boolean(ops?.disableVolume)
+            inlineVolume: !ops?.disableVolume
         });
         return this.audioResource;
     }

package/dist/index.d.ts

@@ -1,8 +1,9 @@
 /// <reference types="node" />
-import { User, VoiceChannel, StageChannel, Collection, Snowflake, Client, GuildResolvable, Guild, GuildChannelResolvable, UserResolvable } from 'discord.js';
+import { User, VoiceChannel, StageChannel, Collection, Snowflake, Client, GuildResolvable, Guild, GuildChannelResolvable, VoiceState, UserResolvable } from 'discord.js';
 import { Readable, Duplex, TransformOptions, Transform } from 'stream';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, StreamType, AudioPlayerStatus } from '@discordjs/voice';
+import { EqualizerStream, EqualizerBand } from '@discord-player/equalizer';
 import { downloadOptions } from 'ytdl-core';
 
 declare class Playlist {
@@ -96,6 +97,7 @@ declare class StreamDispatcher extends TypedEmitter<VoiceEvents> {
     audioResource?: AudioResource<Track>;
     private readyLock;
     paused: boolean;
+    equalizer: EqualizerStream | null;
     /**
      * Creates new connection object
      * @param {VoiceConnection} connection The connection
@@ -113,6 +115,8 @@ declare class StreamDispatcher extends TypedEmitter<VoiceEvents> {
         type?: StreamType;
         data?: any;
         disableVolume?: boolean;
+        disableEqualizer?: boolean;
+        eq?: EqualizerBand[];
     }): AudioResource<Track>;
     /**
      * The player status
@@ -367,6 +371,7 @@ declare class Queue<T = unknown> {
     _cooldownsTimeout: Collection<string, NodeJS.Timeout>;
     private _activeFilters;
     private _filtersUpdate;
+    private _lastEQBands;
     onBeforeCreateStream: (track: Track, source: TrackSource, queue: Queue) => Promise<Readable | undefined>;
     /**
      * Queue constructor
@@ -375,6 +380,42 @@ declare class Queue<T = unknown> {
      * @param {PlayerOptions} [options] Player options for the queue
      */
     constructor(player: Player, guild: Guild, options?: PlayerOptions);
+    /**
+     * Set equalizer bands
+     * @param bands Equalizer band multiplier array
+     */
+    setEqualizer(bands?: EqualizerBand[]): boolean;
+    /**
+     * Set particular equalizer band multiplier
+     * @param band The band to update
+     * @param gain The gain
+     */
+    setEqualizerBand(band: number, gain: number): boolean;
+    /**
+     * Returns gain value of specific equalizer band
+     * @param band The band to get value of
+     */
+    getEqualizerBand(band: number): number;
+    /**
+     * Returns entire equalizer bands
+     */
+    getEqualizer(): EqualizerBand[];
+    /**
+     * Check if equalizer is enabled
+     */
+    isEqualizerEnabled(): boolean;
+    /**
+     * Toggles equalizer on/off
+     */
+    toggleEqualizer(): boolean;
+    /**
+     * Enables equalizer
+     */
+    enableEqualizer(): boolean;
+    /**
+     * Disables equalizer
+     */
+    disableEqualizer(): boolean;
     /**
      * Forces next play
      * @returns {Promise<void>}
@@ -744,8 +785,10 @@ interface PlayerProgressbarOptions {
  * @property {number} [bufferingTimeout=3000] Buffering timeout for the stream
  * @property {boolean} [spotifyBridge=true] If player should bridge spotify source to youtube
  * @property {boolean} [disableVolume=false] If player should disable inline volume
+ * @property {boolean} [disableEqualizer=false] If player should disable equalizer
  * @property {number} [volumeSmoothness=0] The volume transition smoothness between volume changes (lower the value to get better result)
  * Setting this or leaving this empty will disable this effect. Example: `volumeSmoothness: 0.1`
+ * @property {EqualizerBand[]} [equalizerBands] The equalizer bands array for 15 band equalizer.
  * @property {Function} [onBeforeCreateStream] Runs before creating stream
  */
 interface PlayerOptions {
@@ -760,7 +803,9 @@ interface PlayerOptions {
     bufferingTimeout?: number;
     spotifyBridge?: boolean;
     disableVolume?: boolean;
+    disableEqualizer?: boolean;
     volumeSmoothness?: number;
+    equalizerBands?: EqualizerBand[];
     onBeforeCreateStream?: (track: Track, source: TrackSource, queue: Queue) => Promise<Readable>;
 }
 /**
@@ -923,6 +968,13 @@ declare enum QueryType {
  * @param {Queue} queue The queue
  * @param {Track} track The track
  */
+/**
+ * Emitted when a track ends
+ * @event Player#voiceStateUpdate
+ * @param {Queue} queue The queue that this update belongs to
+ * @param {VoiceState} oldState The old voice state
+ * @param {VoiceState} newState The new voice state
+ */
 interface PlayerEvents {
     botDisconnect: (queue: Queue) => any;
     channelEmpty: (queue: Queue) => any;
@@ -935,6 +987,7 @@ interface PlayerEvents {
     tracksAdd: (queue: Queue, track: Track[]) => any;
     trackStart: (queue: Queue, track: Track) => any;
     trackEnd: (queue: Queue, track: Track) => any;
+    voiceStateUpdate: (queue: Queue, oldState: VoiceState, newState: VoiceState) => any;
 }
 /**
  * @typedef {object} PlayOptions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-player",
-  "version": "5.3.2-dev.3",
+  "version": "5.4.0",
   "description": "Complete framework to facilitate music commands using discord.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -65,6 +65,7 @@
   },
   "homepage": "https://discord-player.js.org",
   "dependencies": {
+    "@discord-player/equalizer": "^0.1.2",
     "@discordjs/voice": "^0.11.0",
     "libsodium-wrappers": "^0.7.10",
     "tiny-typed-emitter": "^2.1.0",