discord-player 5.3.0 → 5.3.2-dev.1

package/dist/Player.js

@@ -32,7 +32,8 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
             ytdlOptions: {
                 highWaterMark: 1 << 25
             },
-            connectionTimeout: 20000
+            connectionTimeout: 20000,
+            smoothVolume: true
         };
         this.queues = new discord_js_1.Collection();
         this.voiceUtils = new VoiceUtils_1.VoiceUtils();
@@ -164,7 +165,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
             return this.queues.get(guild.id);
         const _meta = queueInitOptions.metadata;
         delete queueInitOptions["metadata"];
-        queueInitOptions.volumeSmoothness ?? (queueInitOptions.volumeSmoothness = 0.08);
+        queueInitOptions.volumeSmoothness ?? (queueInitOptions.volumeSmoothness = this.options.smoothVolume ? 0.08 : 0);
         queueInitOptions.ytdlOptions ?? (queueInitOptions.ytdlOptions = this.options.ytdlOptions);
         const queue = new Queue_1.Queue(this, guild, queueInitOptions);
         queue.metadata = _meta;
@@ -174,7 +175,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
     /**
      * Returns the queue if available
      * @param {GuildResolvable} guild The guild id
-     * @returns {Queue}
+     * @returns {Queue | undefined}
      */
     getQueue(guild) {
         guild = this.client.guilds.resolve(guild);
@@ -346,10 +347,11 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                     description: spotifyData.description ?? "",
                     author: spotifyData.artists[0]?.name ?? "Unknown Artist",
                     url: spotifyData.external_urls?.spotify ?? query,
-                    thumbnail: spotifyData.album?.images[0]?.url ?? spotifyData.preview_url?.length
-                        ? `https://i.scdn.co/image/${spotifyData.preview_url?.split("?cid=")[1]}`
-                        : "https://www.scdn.co/i/_global/twitter_card-default.jpg",
-                    duration: Util_1.Util.buildTimeCode(Util_1.Util.parseMS(spotifyData.duration_ms)),
+                    thumbnail: (spotifyData.coverArt?.sources?.[0]?.url ??
+                        spotifyData.album?.images[0]?.url ??
+                        (spotifyData.preview_url?.length && `https://i.scdn.co/image/${spotifyData.preview_url?.split("?cid=")[1]}`)) ||
+                        "https://www.scdn.co/i/_global/twitter_card-default.jpg",
+                    duration: Util_1.Util.buildTimeCode(Util_1.Util.parseMS(spotifyData.duration_ms ?? spotifyData.duration ?? spotifyData.maxDuration)),
                     views: 0,
                     requestedBy: options.requestedBy,
                     source: "spotify"
@@ -366,7 +368,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 const playlist = new Playlist_1.Playlist(this, {
                     title: spotifyPlaylist.name ?? spotifyPlaylist.title,
                     description: spotifyPlaylist.description ?? "",
-                    thumbnail: spotifyPlaylist.images[0]?.url ?? "https://www.scdn.co/i/_global/twitter_card-default.jpg",
+                    thumbnail: spotifyPlaylist.coverArt?.sources?.[0]?.url ?? spotifyPlaylist.images[0]?.url ?? "https://www.scdn.co/i/_global/twitter_card-default.jpg",
                     type: spotifyPlaylist.type,
                     source: "spotify",
                     author: spotifyPlaylist.type !== "playlist"

package/dist/Structures/Queue.js

@@ -86,6 +86,7 @@ class Queue {
             leaveOnEnd: true,
             leaveOnStop: true,
             leaveOnEmpty: true,
+            leaveOnEndCooldown: 1000,
             leaveOnEmptyCooldown: 1000,
             autoSelfDeaf: true,
             ytdlOptions: {
@@ -100,6 +101,18 @@ class Queue {
             this.onBeforeCreateStream = this.options.onBeforeCreateStream;
         this.player.emit("debug", this, `Queue initialized:\n\n${this.player.scanDeps()}`);
     }
+    /**
+     * Forces next play
+     * @returns {Promise<void>}
+     */
+    async forceNext() {
+        if (this.connection.audioResource) {
+            this.connection.emit("finish", this.connection.audioResource);
+        }
+        else if (this.tracks.length) {
+            await this.play();
+        }
+    }
     /**
      * Returns current track
      * @type {Track}
@@ -175,9 +188,7 @@ class Queue {
                 this.previousTracks.push(resource.metadata);
             this.player.emit("trackEnd", this, resource.metadata);
             if (!this.tracks.length && this.repeatMode === types_1.QueueRepeatMode.OFF) {
-                if (this.options.leaveOnEnd)
-                    this.destroy();
-                this.player.emit("queueEnd", this);
+                this.emitEnd();
             }
             else if (!this.tracks.length && this.repeatMode === types_1.QueueRepeatMode.AUTOPLAY) {
                 this._handleAutoplay(Util_1.Util.last(this.previousTracks));
@@ -194,6 +205,25 @@ class Queue {
         });
         return this;
     }
+    emitEnd() {
+        const timeout = setTimeout(() => {
+            if (!this.player.queues.has(this.guild.id))
+                return;
+            if (this.tracks.length || this.current)
+                return;
+            if (this.options.leaveOnEnd)
+                this.destroy();
+            this.player.emit("queueEnd", this);
+        }, this.options.leaveOnEndCooldown || 0).unref();
+        this._cooldownsTimeout.set(`queueEnd_${this.guild.id}`, timeout);
+    }
+    refreshEndCooldown() {
+        const existingTimeout = this._cooldownsTimeout.get(`queueEnd_${this.guild.id}`);
+        if (this.tracks.length || this.current) {
+            clearTimeout(existingTimeout);
+            this._cooldownsTimeout.delete(`queueEnd_${this.guild.id}`);
+        }
+    }
     /**
      * Destroys this queue
      * @param {boolean} [disconnect=this.options.leaveOnStop] If it should leave on destroy
@@ -234,6 +264,7 @@ class Queue {
         if (!(track instanceof Track_1.default))
             throw new PlayerError_1.PlayerError("invalid track", PlayerError_1.ErrorStatusCode.INVALID_TRACK);
         this.tracks.push(track);
+        this.refreshEndCooldown();
         this.player.emit("trackAdd", this, track);
     }
     /**
@@ -246,6 +277,7 @@ class Queue {
         if (!tracks.every((y) => y instanceof Track_1.default))
             throw new PlayerError_1.PlayerError("invalid track", PlayerError_1.ErrorStatusCode.INVALID_TRACK);
         this.tracks.push(...tracks);
+        this.refreshEndCooldown();
         this.player.emit("tracksAdd", this, tracks);
     }
     /**
@@ -450,14 +482,12 @@ class Queue {
     shuffle() {
         if (tslib_1.__classPrivateFieldGet(this, _Queue_instances, "m", _Queue_watchDestroyed).call(this))
             return;
-        if (!this.tracks.length || this.tracks.length < 3)
+        if (!this.tracks.length || this.tracks.length < 2)
             return false;
-        const currentTrack = this.tracks.shift();
         for (let i = this.tracks.length - 1; i > 0; i--) {
             const j = Math.floor(Math.random() * (i + 1));
             [this.tracks[i], this.tracks[j]] = [this.tracks[j], this.tracks[i]];
         }
-        this.tracks.unshift(currentTrack);
         return true;
     }
     /**
@@ -632,7 +662,9 @@ class Queue {
             if (this.options.spotifyBridge && track.raw.source === "spotify" && !track.raw.engine) {
                 track.raw.engine = await youtube_sr_1.default.search(`${track.author} ${track.title}`, { type: "video" })
                     .then((res) => res[0].url)
-                    .catch(() => null);
+                    .catch(() => {
+                    /* void */
+                });
                 spotifyResolved = true;
             }
             const url = track.raw.source === "spotify" ? track.raw.engine : track.url;
@@ -691,9 +723,7 @@ class Queue {
         if (tslib_1.__classPrivateFieldGet(this, _Queue_instances, "m", _Queue_watchDestroyed).call(this))
             return;
         if (!track || ![track.source, track.raw?.source].includes("youtube")) {
-            if (this.options.leaveOnEnd)
-                this.destroy();
-            return void this.player.emit("queueEnd", this);
+            return this.emitEnd();
         }
         let info = await youtube_sr_1.default.getVideo(track.url)
             .then((x) => x.videos[0])
@@ -704,9 +734,7 @@ class Queue {
                 .then((x) => x[0])
                 .catch(Util_1.Util.noop);
         if (!info) {
-            if (this.options.leaveOnEnd)
-                this.destroy();
-            return void this.player.emit("queueEnd", this);
+            return this.emitEnd();
         }
         const nextTrack = new Track_1.default(this.player, {
             title: info.title,

package/dist/VoiceInterface/StreamDispatcher.js

@@ -171,8 +171,9 @@ class StreamDispatcher extends tiny_typed_emitter_1.TypedEmitter {
     async playStream(resource = this.audioResource) {
         if (!resource)
             throw new PlayerError_1.PlayerError("Audio resource is not available!", PlayerError_1.ErrorStatusCode.NO_AUDIO_RESOURCE);
-        if (resource.ended)
-            return void this.emit("error", new PlayerError_1.PlayerError("Cannot play a resource that has already ended."));
+        if (resource.ended) {
+            return void this.emit("finish", resource);
+        }
         if (!this.audioResource)
             this.audioResource = resource;
         if (this.voiceConnection.state.status !== voice_1.VoiceConnectionStatus.Ready) {

package/dist/VoiceInterface/VolumeTransformer.js

@@ -108,7 +108,7 @@ class VolumeTransformer extends stream_1.Transform {
         this._smoothing = smoothness;
     }
     smoothingEnabled() {
-        return Number.isFinite(this._smoothing) && this._smoothing > 0;
+        return typeof this._smoothing === "number" && !Number.isNaN(this._smoothing) && Number.isFinite(this._smoothing) && this._smoothing > 0;
     }
     get hasSmoothness() {
         return true;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import { User, VoiceChannel, StageChannel, Collection, Snowflake, Client, GuildResolvable, Guild, GuildChannelResolvable, UserResolvable } from 'discord.js';
-import { Readable, Duplex } from 'stream';
+import { Readable, Duplex, TransformOptions, Transform } from 'stream';
 import { TypedEmitter } from 'tiny-typed-emitter';
 import { AudioPlayerError, AudioResource, VoiceConnection, AudioPlayer, StreamType, AudioPlayerStatus } from '@discordjs/voice';
 import { downloadOptions } from 'ytdl-core';
@@ -266,9 +266,9 @@ declare class Player extends TypedEmitter<PlayerEvents> {
     /**
      * Returns the queue if available
      * @param {GuildResolvable} guild The guild id
-     * @returns {Queue}
+     * @returns {Queue | undefined}
      */
-    getQueue<T = unknown>(guild: GuildResolvable): Queue<T>;
+    getQueue<T = unknown>(guild: GuildResolvable): Queue<T> | undefined;
     /**
      * Deletes a queue and returns deleted queue object
      * @param {GuildResolvable} guild The guild id to remove
@@ -345,6 +345,11 @@ declare class Queue<T = unknown> {
      * @param {PlayerOptions} [options] Player options for the queue
      */
     constructor(player: Player, guild: Guild, options?: PlayerOptions);
+    /**
+     * Forces next play
+     * @returns {Promise<void>}
+     */
+    forceNext(): Promise<void>;
     /**
      * Returns current track
      * @type {Track}
@@ -366,6 +371,8 @@ declare class Queue<T = unknown> {
      * @returns {Promise<Queue>}
      */
     connect(channel: GuildChannelResolvable): Promise<this>;
+    private emitEnd;
+    private refreshEndCooldown;
     /**
      * Destroys this queue
      * @param {boolean} [disconnect=this.options.leaveOnStop] If it should leave on destroy
@@ -671,6 +678,7 @@ interface PlayerProgressbarOptions {
  * @property {boolean} [leaveOnStop=true] If it should leave on stop
  * @property {boolean} [leaveOnEmpty=true] If it should leave on empty
  * @property {number} [leaveOnEmptyCooldown=1000] The cooldown in ms
+ * @property {number} [leaveOnEndCooldown=1000] The cooldown in ms
  * @property {boolean} [autoSelfDeaf=true] If it should set the bot in deaf mode
  * @property {YTDLDownloadOptions} [ytdlOptions] The youtube download options
  * @property {number} [initialVolume=100] The initial player volume
@@ -683,6 +691,7 @@ interface PlayerProgressbarOptions {
  */
 interface PlayerOptions {
     leaveOnEnd?: boolean;
+    leaveOnEndCooldown?: number;
     leaveOnStop?: boolean;
     leaveOnEmpty?: boolean;
     leaveOnEmptyCooldown?: number;
@@ -995,11 +1004,13 @@ interface PlaylistJSON {
  * @property {boolean} [autoRegisterExtractor=true] If it should automatically register `@discord-player/extractor`
  * @property {YTDLDownloadOptions} [ytdlOptions] The options passed to `ytdl-core`
  * @property {number} [connectionTimeout=20000] The voice connection timeout
+ * @property {boolean} [smoothVolume=true] Toggle smooth volume transition
  */
 interface PlayerInitOptions {
     autoRegisterExtractor?: boolean;
     ytdlOptions?: downloadOptions;
     connectionTimeout?: number;
+    smoothVolume?: boolean;
 }
 
 declare class AudioFilters {
@@ -1019,7 +1030,7 @@ declare class AudioFilters {
      * @param filter The filter name
      * @returns
      */
-    static create(filters?: FiltersName[]): string;
+    static create<K extends FiltersName>(filters?: K[]): string;
     /**
      * Defines audio filter
      * @param filterName The name of the filter
@@ -1087,6 +1098,38 @@ declare class QueryResolver {
     static getVimeoID(query: string): string;
 }
 
+interface VolumeTransformerOptions extends TransformOptions {
+    type?: "s16le" | "s16be" | "s32le" | "s32be";
+    smoothness?: number;
+    volume?: number;
+}
+declare class VolumeTransformer extends Transform {
+    private _bits;
+    private _smoothing;
+    private _bytes;
+    private _extremum;
+    private _chunk;
+    volume: number;
+    private _targetVolume;
+    type: "s16le" | "s32le" | "s16be" | "s32be";
+    constructor(options?: VolumeTransformerOptions);
+    _readInt(buffer: Buffer, index: number): number;
+    _writeInt(buffer: Buffer, int: number, index: number): number;
+    _applySmoothness(): void;
+    _transform(chunk: Buffer, encoding: BufferEncoding, done: () => unknown): unknown;
+    _destroy(err: Error, cb: (error: Error) => void): void;
+    setVolume(volume: number): void;
+    setVolumeDecibels(db: number): void;
+    setVolumeLogarithmic(value: number): void;
+    get volumeDecibels(): number;
+    get volumeLogarithmic(): number;
+    get smoothness(): number;
+    setSmoothness(smoothness: number): void;
+    smoothingEnabled(): boolean;
+    get hasSmoothness(): boolean;
+    static get hasSmoothing(): boolean;
+}
+
 declare class Util {
     /**
      * Utils
@@ -1155,4 +1198,4 @@ declare function createFFmpegStream(stream: Readable | Duplex | string, options?
 
 declare const version: string;
 
-export { AudioFilters, ErrorStatusCode, ExtractorModel, ExtractorModelData, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFmpegStreamOptions, FiltersName, PlayOptions, Player, PlayerError, PlayerEvents, PlayerInitOptions, PlayerOptions, PlayerProgressbarOptions, PlayerSearchResult, Playlist, PlaylistInitData, PlaylistJSON, QueryResolver, QueryType, Queue, QueueFilters, QueueRepeatMode, RawTrackData, SearchOptions, StreamDispatcher, TimeData, Track, TrackJSON, TrackSource, Util, VoiceEvents, VoiceUtils, createFFmpegStream, version };
+export { AudioFilters, ErrorStatusCode, ExtractorModel, ExtractorModelData, FFMPEG_ARGS_PIPED, FFMPEG_ARGS_STRING, FFmpegStreamOptions, FiltersName, PlayOptions, Player, PlayerError, PlayerEvents, PlayerInitOptions, PlayerOptions, PlayerProgressbarOptions, PlayerSearchResult, Playlist, PlaylistInitData, PlaylistJSON, QueryResolver, QueryType, Queue, QueueFilters, QueueRepeatMode, RawTrackData, SearchOptions, StreamDispatcher, TimeData, Track, TrackJSON, TrackSource, Util, VoiceEvents, VoiceUtils, VolumeTransformer, VolumeTransformerOptions, createFFmpegStream, version };

package/dist/index.js

@@ -25,6 +25,7 @@ var VoiceUtils_1 = require("./VoiceInterface/VoiceUtils");
 Object.defineProperty(exports, "VoiceUtils", { enumerable: true, get: function () { return VoiceUtils_1.VoiceUtils; } });
 var StreamDispatcher_1 = require("./VoiceInterface/StreamDispatcher");
 Object.defineProperty(exports, "StreamDispatcher", { enumerable: true, get: function () { return StreamDispatcher_1.StreamDispatcher; } });
+tslib_1.__exportStar(require("./VoiceInterface/VolumeTransformer"), exports);
 var Util_1 = require("./utils/Util");
 Object.defineProperty(exports, "Util", { enumerable: true, get: function () { return Util_1.Util; } });
 tslib_1.__exportStar(require("./types/types"), exports);

package/dist/index.mjs

@@ -17,5 +17,6 @@ export const StreamDispatcher = mod.StreamDispatcher;
 export const Track = mod.Track;
 export const Util = mod.Util;
 export const VoiceUtils = mod.VoiceUtils;
+export const VolumeTransformer = mod.VolumeTransformer;
 export const createFFmpegStream = mod.createFFmpegStream;
 export const version = mod.version;

package/dist/smoothVolume.js

@@ -1,13 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const VolumeTransformer_1 = require("./VoiceInterface/VolumeTransformer");
-try {
-    // eslint-disable-next-line
-    const mod = require("prism-media");
-    if (typeof mod.VolumeTransformer.hasSmoothing !== "boolean") {
-        Reflect.set(mod, "VolumeTransformer", VolumeTransformer_1.VolumeTransformer);
+if (!("DISABLE_DISCORD_PLAYER_SMOOTH_VOLUME" in process.env)) {
+    try {
+        // eslint-disable-next-line
+        const mod = require("prism-media");
+        if (typeof mod.VolumeTransformer.hasSmoothing !== "boolean") {
+            Reflect.set(mod, "VolumeTransformer", VolumeTransformer_1.VolumeTransformer);
+        }
+    }
+    catch {
+        /* do nothing */
     }
-}
-catch {
-    /* do nothing */
 }

package/dist/utils/AudioFilters.js

@@ -50,17 +50,16 @@ class AudioFilters {
         return name in this.filters;
     }
     static *[Symbol.iterator]() {
-        for (const [k, v] of Object.entries(this)) {
-            if (typeof this.filters[k] === "string")
-                yield { name: k, value: v };
+        for (const [k, v] of Object.entries(this.filters)) {
+            yield { name: k, value: v };
         }
     }
     static get names() {
-        return Object.keys(this).filter((p) => !["names", "length"].includes(p) && typeof this.filters[p] !== "function");
+        return Object.keys(this.filters);
     }
     // @ts-expect-error AudioFilters.length
     static get length() {
-        return Object.keys(this).filter((p) => !["names", "length"].includes(p) && typeof this.filters[p] !== "function").length;
+        return this.names.length;
     }
     static toString() {
         return this.names.map((m) => this[m]).join(","); // eslint-disable-line @typescript-eslint/no-explicit-any

package/dist/utils/QueryResolver.js

@@ -7,7 +7,7 @@ const types_1 = require("../types/types");
 // eslint-disable-next-line @typescript-eslint/ban-ts-comment
 // @ts-ignore
 const soundcloud_scraper_1 = require("soundcloud-scraper");
-// scary things below *sigh*
+// #region scary things below *sigh*
 const spotifySongRegex = /https?:\/\/(?:embed\.|open\.)(?:spotify\.com\/)(?:track\/|\?uri=spotify:track:)((\w|-){22})/;
 const spotifyPlaylistRegex = /https?:\/\/(?:embed\.|open\.)(?:spotify\.com\/)(?:playlist\/|\?uri=spotify:playlist:)((\w|-){22})/;
 const spotifyAlbumRegex = /https?:\/\/(?:embed\.|open\.)(?:spotify\.com\/)(?:album\/|\?uri=spotify:album:)((\w|-){22})/;
@@ -15,7 +15,7 @@ const vimeoRegex = /(http|https)?:\/\/(www\.|player\.)?vimeo\.com\/(?:channels\/
 const facebookRegex = /(https?:\/\/)(www\.|m\.)?(facebook|fb).com\/.*\/videos\/.*/;
 const reverbnationRegex = /https:\/\/(www.)?reverbnation.com\/(.+)\/song\/(.+)/;
 const attachmentRegex = /^(?:(?:https?|ftp):\/\/)?(?:(?!(?:10|127)(?:\.\d{1,3}){3})(?!(?:169\.254|192\.168)(?:\.\d{1,3}){2})(?!172\.(?:1[6-9]|2\d|3[0-1])(?:\.\d{1,3}){2})(?:[1-9]\d?|1\d\d|2[01]\d|22[0-3])(?:\.(?:1?\d{1,2}|2[0-4]\d|25[0-5])){2}(?:\.(?:[1-9]\d?|1\d\d|2[0-4]\d|25[0-4]))|(?:(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)(?:\.(?:[a-z\u00a1-\uffff0-9]-*)*[a-z\u00a1-\uffff0-9]+)*(?:\.(?:[a-z\u00a1-\uffff]{2,})))(?::\d{2,5})?(?:\/\S*)?$/;
-// scary things above *sigh*
+// #endregion scary things above *sigh*
 class QueryResolver {
     /**
      * Query resolver

package/dist/utils/Util.js

@@ -45,6 +45,8 @@ class Util {
      * @returns {TimeData}
      */
     static parseMS(milliseconds) {
+        if (isNaN(milliseconds))
+            milliseconds = 0;
         const round = milliseconds > 0 ? Math.floor : Math.ceil;
         return {
             days: round(milliseconds / 86400000),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-player",
-  "version": "5.3.0",
+  "version": "5.3.2-dev.1",
   "description": "Complete framework to facilitate music commands using discord.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
     "./dist/*": "./dist/*"
   },
   "scripts": {
-    "dev": "cd example/test && ts-node index.ts",
+    "dev": "cd examples/test && ts-node index.ts",
     "build": "rimraf dist && tsc && npm run build:esm",
     "build:check": "tsc --noEmit --incremental false",
     "prepublishOnly": "rollup-type-bundler -e stream",
@@ -67,12 +67,14 @@
   "dependencies": {
     "@discordjs/voice": "^0.11.0",
     "libsodium-wrappers": "^0.7.10",
-    "soundcloud-scraper": "^5.0.3",
-    "spotify-url-info": "^3.1.2",
     "tiny-typed-emitter": "^2.1.0",
-    "tslib": "^2.4.0",
-    "youtube-sr": "^4.3.0",
-    "ytdl-core": "^4.11.0"
+    "tslib": "^2.4.0"
+  },
+  "peerDependencies": {
+    "soundcloud-scraper": "5.x",
+    "spotify-url-info": "3.x",
+    "youtube-sr": "4.x",
+    "ytdl-core": "4.x"
   },
   "devDependencies": {
     "@discordjs/ts-docgen": "^0.4.1",
@@ -89,8 +91,12 @@
     "opusscript": "^0.0.8",
     "prettier": "^2.7.1",
     "rimraf": "^3.0.2",
+    "soundcloud-scraper": "^5.0.3",
+    "spotify-url-info": "^3.1.7",
     "ts-node": "^10.9.1",
     "typedoc": "^0.23.10",
-    "typescript": "^4.7.4"
+    "typescript": "^4.7.4",
+    "youtube-sr": "^4.3.4",
+    "ytdl-core": "^4.11.2"
   }
 }