discord-player 5.3.2-dev.2 → 5.3.2-dev.3

package/dist/Player.js

@@ -1,4 +1,5 @@
 "use strict";
+var _Player_lastLatency;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Player = void 0;
 const tslib_1 = require("tslib");
@@ -33,12 +34,14 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 highWaterMark: 1 << 25
             },
             connectionTimeout: 20000,
-            smoothVolume: true
+            smoothVolume: true,
+            lagMonitor: 30000
         };
         this.queues = new discord_js_1.Collection();
         this.voiceUtils = new VoiceUtils_1.VoiceUtils();
         this.extractors = new discord_js_1.Collection();
         this.requiredEvents = ["error", "connectionError"];
+        _Player_lastLatency.set(this, -1);
         /**
          * The discord.js client
          * @type {Client}
@@ -59,6 +62,27 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
                 ["Attachment", "Facebook", "Reverbnation", "Vimeo"].forEach((ext) => void this.use(ext, nv[ext]));
             }
         }
+        if (typeof this.options.lagMonitor === "number" && this.options.lagMonitor > 0) {
+            setInterval(() => {
+                const start = performance.now();
+                setTimeout(() => {
+                    tslib_1.__classPrivateFieldSet(this, _Player_lastLatency, performance.now() - start, "f");
+                }, 0).unref();
+            }, this.options.lagMonitor).unref();
+        }
+    }
+    /**
+     * Event loop lag
+     * @type {number}
+     */
+    get eventLoopLag() {
+        return tslib_1.__classPrivateFieldGet(this, _Player_lastLatency, "f");
+    }
+    /**
+     * Generates statistics
+     */
+    generateStatistics() {
+        return this.queues.map((m) => m.generateStatistics());
     }
     /**
      * Handles voice state update
@@ -569,7 +593,7 @@ class Player extends tiny_typed_emitter_1.TypedEmitter {
     resolveQueue(queueLike) {
         return this.getQueue(queueLike instanceof Queue_1.Queue ? queueLike.guild : queueLike);
     }
-    *[Symbol.iterator]() {
+    *[(_Player_lastLatency = new WeakMap(), Symbol.iterator)]() {
         yield* Array.from(this.queues.values());
     }
     /**

package/dist/Structures/Queue.js

@@ -13,6 +13,8 @@ const youtube_sr_1 = tslib_1.__importDefault(require("youtube-sr"));
 const AudioFilters_1 = tslib_1.__importDefault(require("../utils/AudioFilters"));
 const PlayerError_1 = require("./PlayerError");
 const FFmpegStream_1 = require("../utils/FFmpegStream");
+const os_1 = tslib_1.__importDefault(require("os"));
+const worker_threads_1 = require("worker_threads");
 class Queue {
     /**
      * Queue constructor
@@ -632,6 +634,39 @@ class Queue {
             return;
         return this.tracks.length > 0 ? this.tracks.map((t) => t.durationMS).reduce((p, c) => p + c) : 0;
     }
+    /**
+     * Generates statistics
+     */
+    generateStatistics() {
+        return {
+            guild: this.guild.id,
+            memory: process.memoryUsage(),
+            tracks: this.tracks.length,
+            os: {
+                cpuCount: os_1.default.cpus().length,
+                totalMem: os_1.default.totalmem(),
+                freeMem: os_1.default.freemem(),
+                platform: process.platform
+            },
+            isShard: typeof process.send === "function" || worker_threads_1.parentPort != null,
+            latency: {
+                client: this.player.client.ws.ping,
+                udp: this.connection.voiceConnection.ping.udp,
+                ws: this.connection.voiceConnection.ping.ws,
+                eventLoop: this.player.eventLoopLag
+            },
+            subscribers: this.player.queues.size,
+            connections: this.player.queues.filter((x) => x.connection?.voiceConnection != null).size,
+            extractors: this.player.extractors.size
+        };
+    }
+    /**
+     * Voice connection latency in ms
+     * @type {number}
+     */
+    get ping() {
+        return this.connection.voiceConnection.ping.udp;
+    }
     /**
      * Play stream in a voice/stage channel
      * @param {Track} [src] The track to play (if empty, uses first track from the queue)

package/dist/index.d.ts

@@ -234,6 +234,7 @@ declare class ExtractorModel {
 }
 
 declare class Player extends TypedEmitter<PlayerEvents> {
+    #private;
     readonly client: Client;
     readonly options: PlayerInitOptions;
     readonly queues: Collection<string, Queue<unknown>>;
@@ -246,6 +247,35 @@ declare class Player extends TypedEmitter<PlayerEvents> {
      * @param {PlayerInitOptions} [options] The player init options
      */
     constructor(client: Client, options?: PlayerInitOptions);
+    /**
+     * Event loop lag
+     * @type {number}
+     */
+    get eventLoopLag(): number;
+    /**
+     * Generates statistics
+     */
+    generateStatistics(): {
+        guild: string;
+        memory: NodeJS.MemoryUsage;
+        tracks: number;
+        os: {
+            cpuCount: number;
+            totalMem: number;
+            freeMem: number;
+            platform: NodeJS.Platform;
+        };
+        isShard: boolean;
+        latency: {
+            client: number;
+            udp: number;
+            ws: number;
+            eventLoop: number;
+        };
+        subscribers: number;
+        connections: number;
+        extractors: number;
+    }[];
     /**
      * Handles voice state update
      * @param {VoiceState} oldState The old voice state
@@ -528,6 +558,35 @@ declare class Queue<T = unknown> {
      * @type {Number}
      */
     get totalTime(): number;
+    /**
+     * Generates statistics
+     */
+    generateStatistics(): {
+        guild: string;
+        memory: NodeJS.MemoryUsage;
+        tracks: number;
+        os: {
+            cpuCount: number;
+            totalMem: number;
+            freeMem: number;
+            platform: NodeJS.Platform;
+        };
+        isShard: boolean;
+        latency: {
+            client: number;
+            udp: number;
+            ws: number;
+            eventLoop: number;
+        };
+        subscribers: number;
+        connections: number;
+        extractors: number;
+    };
+    /**
+     * Voice connection latency in ms
+     * @type {number}
+     */
+    get ping(): number;
     /**
      * Play stream in a voice/stage channel
      * @param {Track} [src] The track to play (if empty, uses first track from the queue)
@@ -1005,17 +1064,19 @@ interface PlaylistJSON {
  * @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
+ * @property {boolean} [lagMonitor=30000] Time in ms to re-monitor event loop lag
  */
 interface PlayerInitOptions {
     autoRegisterExtractor?: boolean;
     ytdlOptions?: downloadOptions;
     connectionTimeout?: number;
     smoothVolume?: boolean;
+    lagMonitor?: number;
 }
 
 declare class AudioFilters {
     constructor();
-    static get filters(): Record<FiltersName, string>;
+    static filters: Record<FiltersName, string>;
     static get<K extends FiltersName>(name: K): Record<keyof QueueFilters, string>[K];
     static has<K extends FiltersName>(name: K): boolean;
     static [Symbol.iterator](): IterableIterator<{
@@ -1176,7 +1237,7 @@ declare class Util {
      * @param {number} time The time in ms to wait
      * @returns {Promise<unknown>}
      */
-    static wait(time: number): Promise<unknown>;
+    static wait(time: number): Promise<any>;
     static noop(): void;
     static getFetch(): Promise<any>;
 }

package/dist/index.js

@@ -4,6 +4,7 @@ exports.version = exports.Util = exports.StreamDispatcher = exports.VoiceUtils =
 const tslib_1 = require("tslib");
 // try applying smooth volume patch on load
 require("./smoothVolume");
+const discord_js_1 = require("discord.js");
 var AudioFilters_1 = require("./utils/AudioFilters");
 Object.defineProperty(exports, "AudioFilters", { enumerable: true, get: function () { return AudioFilters_1.AudioFilters; } });
 var ExtractorModel_1 = require("./Structures/ExtractorModel");
@@ -32,3 +33,6 @@ tslib_1.__exportStar(require("./types/types"), exports);
 tslib_1.__exportStar(require("./utils/FFmpegStream"), exports);
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 exports.version = require(`${__dirname}/../package.json`).version;
+if (!discord_js_1.version.startsWith("14")) {
+    process.emitWarning(`Discord.js v${discord_js_1.version} is incompatible with Discord Player v${exports.version}! Please use >=v14.x of Discord.js`);
+}

package/dist/utils/AudioFilters.js

@@ -6,43 +6,6 @@ class AudioFilters {
     constructor() {
         return AudioFilters;
     }
-    static get filters() {
-        return {
-            bassboost_low: bass(15),
-            bassboost: bass(20),
-            bassboost_high: bass(30),
-            "8D": "apulsator=hz=0.09",
-            vaporwave: "aresample=48000,asetrate=48000*0.8",
-            nightcore: "aresample=48000,asetrate=48000*1.25",
-            phaser: "aphaser=in_gain=0.4",
-            tremolo: "tremolo",
-            vibrato: "vibrato=f=6.5",
-            reverse: "areverse",
-            treble: "treble=g=5",
-            normalizer2: "dynaudnorm=g=101",
-            normalizer: "acompressor",
-            surrounding: "surround",
-            pulsator: "apulsator=hz=1",
-            subboost: "asubboost",
-            karaoke: "stereotools=mlev=0.03",
-            flanger: "flanger",
-            gate: "agate",
-            haas: "haas",
-            mcompand: "mcompand",
-            mono: "pan=mono|c0=.5*c0+.5*c1",
-            mstlr: "stereotools=mode=ms>lr",
-            mstrr: "stereotools=mode=ms>rr",
-            compressor: "compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6",
-            expander: "compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3",
-            softlimiter: "compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8",
-            chorus: "chorus=0.7:0.9:55:0.4:0.25:2",
-            chorus2d: "chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3",
-            chorus3d: "chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3",
-            fadein: "afade=t=in:ss=0:d=10",
-            dim: `afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"`,
-            earrape: "channelsplit,sidechaingate=level_in=64"
-        };
-    }
     static get(name) {
         return this.filters[name];
     }
@@ -94,4 +57,39 @@ class AudioFilters {
     }
 }
 exports.AudioFilters = AudioFilters;
+AudioFilters.filters = {
+    bassboost_low: bass(15),
+    bassboost: bass(20),
+    bassboost_high: bass(30),
+    "8D": "apulsator=hz=0.09",
+    vaporwave: "aresample=48000,asetrate=48000*0.8",
+    nightcore: "aresample=48000,asetrate=48000*1.25",
+    phaser: "aphaser=in_gain=0.4",
+    tremolo: "tremolo",
+    vibrato: "vibrato=f=6.5",
+    reverse: "areverse",
+    treble: "treble=g=5",
+    normalizer2: "dynaudnorm=g=101",
+    normalizer: "acompressor",
+    surrounding: "surround",
+    pulsator: "apulsator=hz=1",
+    subboost: "asubboost",
+    karaoke: "stereotools=mlev=0.03",
+    flanger: "flanger",
+    gate: "agate",
+    haas: "haas",
+    mcompand: "mcompand",
+    mono: "pan=mono|c0=.5*c0+.5*c1",
+    mstlr: "stereotools=mode=ms>lr",
+    mstrr: "stereotools=mode=ms>rr",
+    compressor: "compand=points=-80/-105|-62/-80|-15.4/-15.4|0/-12|20/-7.6",
+    expander: "compand=attacks=0:points=-80/-169|-54/-80|-49.5/-64.6|-41.1/-41.1|-25.8/-15|-10.8/-4.5|0/0|20/8.3",
+    softlimiter: "compand=attacks=0:points=-80/-80|-12.4/-12.4|-6/-8|0/-6.8|20/-2.8",
+    chorus: "chorus=0.7:0.9:55:0.4:0.25:2",
+    chorus2d: "chorus=0.6:0.9:50|60:0.4|0.32:0.25|0.4:2|1.3",
+    chorus3d: "chorus=0.5:0.9:50|60|40:0.4|0.32|0.3:0.25|0.4|0.3:2|2.3|1.3",
+    fadein: "afade=t=in:ss=0:d=10",
+    dim: `afftfilt="'real=re * (1-clip((b/nb)*b,0,1))':imag='im * (1-clip((b/nb)*b,0,1))'"`,
+    earrape: "channelsplit,sidechaingate=level_in=64"
+};
 exports.default = AudioFilters;

package/dist/utils/Util.js

@@ -24,6 +24,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Util = void 0;
+const promises_1 = require("timers/promises");
 class Util {
     /**
      * Utils
@@ -108,13 +109,13 @@ class Util {
      * @returns {Promise<unknown>}
      */
     static wait(time) {
-        return new Promise((r) => setTimeout(r, time).unref());
+        return (0, promises_1.setTimeout)(time, undefined, { ref: false });
     }
     static noop() { } // eslint-disable-line @typescript-eslint/no-empty-function
     static async getFetch() {
         if ("fetch" in globalThis)
             return globalThis.fetch;
-        for (const lib of ["undici", "node-fetch"]) {
+        for (const lib of ["node-fetch", "undici"]) {
             try {
                 return await Promise.resolve().then(() => __importStar(require(lib))).then((res) => res.fetch || res.default?.fetch || res.default);
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discord-player",
-  "version": "5.3.2-dev.2",
+  "version": "5.3.2-dev.3",
   "description": "Complete framework to facilitate music commands using discord.js",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",