distube 5.1.1 → 5.2.0

package/dist/index.mjs

@@ -2,7 +2,15 @@ var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 
 // src/constant.ts
-var version = "5.1.1";
+var version = "5.2.0";
+var AUDIO_SAMPLE_RATE = 48e3;
+var AUDIO_CHANNELS = 2;
+var DEFAULT_VOLUME = 50;
+var JOIN_TIMEOUT_MS = 3e4;
+var RECONNECT_TIMEOUT_MS = 5e3;
+var RECONNECT_MAX_ATTEMPTS = 5;
+var HTTP_REDIRECT_CODES = /* @__PURE__ */ new Set([301, 302, 303, 307, 308]);
+var MAX_REDIRECT_DEPTH = 5;
 var defaultFilters = {
   "3d": "apulsator=hz=0.125",
   bassboost: "bass=g=10",
@@ -222,17 +230,17 @@ var DisTubeVoice = class extends TypedEmitter {
       if (newState.reason === VoiceConnectionDisconnectReason.Manual) {
         this.leave();
       } else if (newState.reason === VoiceConnectionDisconnectReason.WebSocketClose && newState.closeCode === 4014) {
-        entersState(this.connection, VoiceConnectionStatus.Connecting, 5e3).catch(() => {
+        entersState(this.connection, VoiceConnectionStatus.Connecting, RECONNECT_TIMEOUT_MS).catch(() => {
           if (![VoiceConnectionStatus.Ready, VoiceConnectionStatus.Connecting].includes(this.connection.state.status)) {
             this.leave();
           }
         });
-      } else if (this.connection.rejoinAttempts < 5) {
+      } else if (this.connection.rejoinAttempts < RECONNECT_MAX_ATTEMPTS) {
         setTimeout(
           () => {
             this.connection.rejoin();
           },
-          (this.connection.rejoinAttempts + 1) * 5e3
+          (this.connection.rejoinAttempts + 1) * RECONNECT_TIMEOUT_MS
         ).unref();
       } else if (this.connection.state.status !== VoiceConnectionStatus.Destroyed) {
         this.leave(new DisTubeError("VOICE_RECONNECT_FAILED"));
@@ -288,15 +296,14 @@ var DisTubeVoice = class extends TypedEmitter {
    * @param channel - A voice channel
    */
   async join(channel) {
-    const TIMEOUT = 3e4;
     if (channel) this.channel = channel;
     try {
-      await entersState(this.connection, VoiceConnectionStatus.Ready, TIMEOUT);
+      await entersState(this.connection, VoiceConnectionStatus.Ready, JOIN_TIMEOUT_MS);
     } catch {
       if (this.connection.state.status === VoiceConnectionStatus.Ready) return this;
       if (this.connection.state.status !== VoiceConnectionStatus.Destroyed) this.connection.destroy();
       this.voices.remove(this.id);
-      throw new DisTubeError("VOICE_CONNECT_FAILED", TIMEOUT / 1e3);
+      throw new DisTubeError("VOICE_CONNECT_FAILED", JOIN_TIMEOUT_MS / 1e3);
     }
     return this;
   }
@@ -321,6 +328,7 @@ var DisTubeVoice = class extends TypedEmitter {
   stop(force = false) {
     this.audioPlayer.stop(force);
   }
+  #streamErrorHandler;
   /**
    * Play a {@link DisTubeStream}
    * @param dtStream - DisTubeStream
@@ -331,11 +339,15 @@ var DisTubeVoice = class extends TypedEmitter {
       throw new DisTubeError("ENCRYPTION_LIBRARIES_MISSING");
     }
     this.emittedError = false;
-    dtStream.on("error", (error) => {
+    if (this.stream && this.#streamErrorHandler) {
+      this.stream.off("error", this.#streamErrorHandler);
+    }
+    this.#streamErrorHandler = (error) => {
       if (this.emittedError || error.code === "ERR_STREAM_PREMATURE_CLOSE") return;
       this.emittedError = true;
       this.emit("error", error);
-    });
+    };
+    dtStream.on("error", this.#streamErrorHandler);
     if (this.audioPlayer.state.status !== AudioPlayerStatus.Paused) {
       this.audioPlayer.play(dtStream.audioResource);
       this.stream?.kill();
@@ -363,11 +375,17 @@ var DisTubeVoice = class extends TypedEmitter {
     return this.#volume;
   }
   /**
-   * Playback duration of the audio resource in seconds
+   * Playback duration of the audio resource in seconds (time since playback started)
    */
   get playbackDuration() {
     return (this.stream?.audioResource?.playbackDuration ?? 0) / 1e3;
   }
+  /**
+   * Current playback time in seconds, accounting for seek offset
+   */
+  get playbackTime() {
+    return this.playbackDuration + (this.stream?.seekTime ?? 0);
+  }
   pause() {
     this.audioPlayer.pause();
   }
@@ -663,7 +681,10 @@ var Queue = class extends DisTubeBase {
    */
   stopped;
   /**
-   * Whether or not the stream is currently playing.
+   * Whether or not the queue is active.
+   *
+   * Note: This remains `true` when paused. It only becomes `false` when stopped.
+   * @deprecated Use `!queue.paused` to check if audio is playing. Will be removed in v6.0.
    */
   playing;
   /**
@@ -690,19 +711,23 @@ var Queue = class extends DisTubeBase {
   textChannel;
   /**
    * What time in the song to begin (in seconds).
+   * @internal
    */
   _beginTime;
   #filters;
   /**
    * Whether or not the queue is being updated manually (skip, jump, previous)
+   * @internal
    */
   _manualUpdate;
   /**
    * Task queuing system
+   * @internal
    */
   _taskQueue;
   /**
    * {@link DisTubeVoice} listener
+   * @internal
    */
   _listeners;
   /**
@@ -715,7 +740,7 @@ var Queue = class extends DisTubeBase {
     super(distube);
     this.voice = voice;
     this.id = voice.id;
-    this.volume = 50;
+    this.volume = DEFAULT_VOLUME;
     this.songs = [];
     this.previousSongs = [];
     this.stopped = false;
@@ -780,7 +805,7 @@ var Queue = class extends DisTubeBase {
    * What time in the song is playing (in seconds).
    */
   get currentTime() {
-    return this.voice.playbackDuration + this._beginTime;
+    return this.voice.playbackTime;
   }
   /**
    * Formatted {@link Queue#currentTime} string.
@@ -828,13 +853,15 @@ var Queue = class extends DisTubeBase {
     return this;
   }
   /**
-   * @returns `true` if the queue is playing
+   * @returns `true` if the queue is active (not stopped)
+   * @deprecated Use `!queue.paused` to check if audio is playing. Will be removed in v6.0.
    */
   isPlaying() {
     return this.playing;
   }
   /**
    * @returns `true` if the queue is paused
+   * @deprecated Use `queue.paused` property instead. Will be removed in v6.0.
    */
   isPaused() {
     return this.paused;
@@ -1039,7 +1066,7 @@ var Queue = class extends DisTubeBase {
    */
   remove() {
     this.playing = false;
-    this.paused = false;
+    this.paused = true;
     this.stopped = true;
     this.songs = [];
     this.previousSongs = [];
@@ -1431,7 +1458,6 @@ var Song = class {
 };
 
 // src/core/DisTubeHandler.ts
-var REDIRECT_CODES = /* @__PURE__ */ new Set([301, 302, 303, 307, 308]);
 var DisTubeHandler = class extends DisTubeBase {
   static {
     __name(this, "DisTubeHandler");
@@ -1518,7 +1544,7 @@ var DisTubeHandler = class extends DisTubeBase {
       song.stream.song = altSong;
     }
   }
-  async followRedirectLink(url, maxRedirect = 5) {
+  async followRedirectLink(url, maxRedirect = MAX_REDIRECT_DEPTH) {
     if (maxRedirect === 0) return url;
     const res = await request(url, {
       method: "HEAD",
@@ -1526,7 +1552,7 @@ var DisTubeHandler = class extends DisTubeBase {
         "user-agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/129.0.0.0 Safari/537.3"
       }
     });
-    if (REDIRECT_CODES.has(res.statusCode ?? 200)) {
+    if (HTTP_REDIRECT_CODES.has(res.statusCode ?? 200)) {
       let location = res.headers.location;
       if (typeof location !== "string") location = location?.[0] ?? url;
       return this.followRedirectLink(location, --maxRedirect);
@@ -1655,7 +1681,8 @@ var checkFFmpeg = /* @__PURE__ */ __name((distube) => {
     if (!version2) throw new Error("Invalid FFmpeg version");
     debug(`[test] ffmpeg version: ${version2}`);
   } catch (e) {
-    debug(`[test] failed to spawn ffmpeg at '${path}': ${e?.stack ?? e}`);
+    const errorMessage = e instanceof Error ? e.stack ?? e.message : String(e);
+    debug(`[test] failed to spawn ffmpeg at '${path}': ${errorMessage}`);
     throw new DisTubeError("FFMPEG_NOT_INSTALLED", path);
   }
   checked = true;
@@ -1669,6 +1696,10 @@ var DisTubeStream = class extends TypedEmitter2 {
   process;
   stream;
   audioResource;
+  /**
+   * The seek time in seconds that this stream started from
+   */
+  seekTime;
   /**
    * Create a DisTubeStream to play with {@link DisTubeVoice}
    * @param url     - Stream URL
@@ -1677,6 +1708,7 @@ var DisTubeStream = class extends TypedEmitter2 {
   constructor(url, options) {
     super();
     const { ffmpeg, seek } = options;
+    this.seekTime = typeof seek === "number" && seek > 0 ? seek : 0;
     const opts = {
       reconnect: 1,
       reconnect_streamed: 1,
@@ -1686,8 +1718,8 @@ var DisTubeStream = class extends TypedEmitter2 {
       ...ffmpeg.args.global,
       ...ffmpeg.args.input,
       i: url,
-      ar: 48e3,
-      ac: 2,
+      ar: AUDIO_SAMPLE_RATE,
+      ac: AUDIO_CHANNELS,
       ...ffmpeg.args.output,
       f: "s16le"
     };
@@ -1895,8 +1927,8 @@ var QueueManager = class extends GuildIdManager {
         this.emit("disconnect" /* DISCONNECT */, queue);
         if (error) this.emitError(error, queue, queue.songs?.[0]);
       }, "disconnect"),
-      error: /* @__PURE__ */ __name((error) => this.#handlePlayingError(queue, error), "error"),
-      finish: /* @__PURE__ */ __name(() => this.handleSongFinish(queue), "finish")
+      error: /* @__PURE__ */ __name((error) => void this.#handlePlayingError(queue, error), "error"),
+      finish: /* @__PURE__ */ __name(() => void this.handleSongFinish(queue), "finish")
     };
     for (const event of objectKeys(queue._listeners)) {
       queue.voice.on(event, queue._listeners[event]);
@@ -1929,8 +1961,13 @@ var QueueManager = class extends GuildIdManager {
           this.debug(`[QueueManager] Adding related song: ${queue.id}`);
           await queue.addRelatedSong(song);
         } catch (e) {
-          this.debug(`[${queue.id}] Add related song error: ${e.message}`);
-          this.emit("noRelated" /* NO_RELATED */, queue, e);
+          const errorMessage = e instanceof Error ? e.message : String(e);
+          this.debug(`[${queue.id}] Add related song error: ${errorMessage}`);
+          if (e instanceof DisTubeError) {
+            this.emit("noRelated" /* NO_RELATED */, queue, e);
+          } else {
+            this.emit("noRelated" /* NO_RELATED */, queue, new DisTubeError("NO_RELATED"));
+          }
         }
       }
       if (queue.songs.length === 0) {
@@ -1953,7 +1990,7 @@ var QueueManager = class extends GuildIdManager {
    * @param queue - queue
    * @param error - error
    */
-  #handlePlayingError(queue, error) {
+  async #handlePlayingError(queue, error) {
     const song = queue.songs.shift();
     try {
       error.name = "PlayingError";
@@ -1963,10 +2000,10 @@ var QueueManager = class extends GuildIdManager {
     this.emitError(error, queue, song);
     if (queue.songs.length > 0) {
       this.debug(`[${queue.id}] Playing next song: ${queue.songs[0]}`);
-      this.playSong(queue);
+      await this.playSong(queue);
     } else {
       this.debug(`[${queue.id}] Queue is empty, stopping...`);
-      queue.stop();
+      await queue.stop();
     }
   }
   /**
@@ -1977,7 +2014,7 @@ var QueueManager = class extends GuildIdManager {
   async playSong(queue, emitPlaySong = true) {
     if (!queue) return;
     if (queue.stopped || !queue.songs.length) {
-      queue.stop();
+      await queue.stop();
       return;
     }
     try {
@@ -1999,13 +2036,15 @@ var QueueManager = class extends GuildIdManager {
         },
         seek: willPlaySong.duration ? queue._beginTime : void 0
       };
+      queue._beginTime = 0;
       const dtStream = new DisTubeStream(stream.url, streamOptions);
       dtStream.on("debug", (data) => this.emit("ffmpegDebug" /* FFMPEG_DEBUG */, `[${queue.id}] ${data}`));
       this.debug(`[${queue.id}] Started playing: ${willPlaySong}`);
       await queue.voice.play(dtStream);
       if (emitPlaySong) this.emit("playSong" /* PLAY_SONG */, queue, song);
     } catch (e) {
-      this.#handlePlayingError(queue, e);
+      const error = e instanceof Error ? e : new Error(String(e));
+      this.#handlePlayingError(queue, error);
     }
   }
 };
@@ -2213,12 +2252,15 @@ var DisTube = class extends TypedEmitter3 {
       else if (skip) await queue.skip();
     } catch (e) {
       if (!(e instanceof DisTubeError)) {
-        this.debug(`[${queue.id}] Unexpected error while playing song: ${e.stack || e.message}`);
-        try {
-          e.name = "PlayError";
-          e.message = `${typeof song === "string" ? song : song.url}
+        const errorMessage = e instanceof Error ? e.stack ?? e.message : String(e);
+        this.debug(`[${queue.id}] Unexpected error while playing song: ${errorMessage}`);
+        if (e instanceof Error) {
+          try {
+            e.name = "PlayError";
+            e.message = `${typeof song === "string" ? song : song.url}
 ${e.message}`;
-        } catch {
+          } catch {
+          }
         }
       }
       throw e;
@@ -2280,6 +2322,7 @@ ${e.message}`;
    * Pause the guild stream
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The guild queue
+   * @deprecated Use `distube.getQueue(guild).pause()` instead. Will be removed in v6.0.
    */
   pause(guild) {
     return this.#getQueue(guild).pause();
@@ -2288,6 +2331,7 @@ ${e.message}`;
    * Resume the guild stream
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The guild queue
+   * @deprecated Use `distube.getQueue(guild).resume()` instead. Will be removed in v6.0.
    */
   resume(guild) {
     return this.#getQueue(guild).resume();
@@ -2295,6 +2339,7 @@ ${e.message}`;
   /**
    * Stop the guild stream
    * @param guild - The type can be resolved to give a {@link Queue}
+   * @deprecated Use `distube.getQueue(guild).stop()` instead. Will be removed in v6.0.
    */
   stop(guild) {
     return this.#getQueue(guild).stop();
@@ -2304,6 +2349,7 @@ ${e.message}`;
    * @param guild   - The type can be resolved to give a {@link Queue}
    * @param percent - The percentage of volume you want to set
    * @returns The guild queue
+   * @deprecated Use `distube.getQueue(guild).setVolume(percent)` instead. Will be removed in v6.0.
    */
   setVolume(guild, percent) {
     return this.#getQueue(guild).setVolume(percent);
@@ -2314,6 +2360,7 @@ ${e.message}`;
    * play a related song.</info>
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The new Song will be played
+   * @deprecated Use `distube.getQueue(guild).skip(options)` instead. Will be removed in v6.0.
    */
   skip(guild, options) {
     return this.#getQueue(guild).skip(options);
@@ -2322,6 +2369,7 @@ ${e.message}`;
    * Play the previous song
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The new Song will be played
+   * @deprecated Use `distube.getQueue(guild).previous()` instead. Will be removed in v6.0.
    */
   previous(guild) {
     return this.#getQueue(guild).previous();
@@ -2330,6 +2378,7 @@ ${e.message}`;
    * Shuffle the guild queue songs
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The guild queue
+   * @deprecated Use `distube.getQueue(guild).shuffle()` instead. Will be removed in v6.0.
    */
   shuffle(guild) {
     return this.#getQueue(guild).shuffle();
@@ -2340,6 +2389,7 @@ ${e.message}`;
    * @param guild - The type can be resolved to give a {@link Queue}
    * @param num   - The song number to play
    * @returns The new Song will be played
+   * @deprecated Use `distube.getQueue(guild).jump(num, options)` instead. Will be removed in v6.0.
    */
   jump(guild, num, options) {
     return this.#getQueue(guild).jump(num, options);
@@ -2350,6 +2400,7 @@ ${e.message}`;
    * @param guild - The type can be resolved to give a {@link Queue}
    * @param mode  - The repeat modes (toggle if `undefined`)
    * @returns The new repeat mode
+   * @deprecated Use `distube.getQueue(guild).setRepeatMode(mode)` instead. Will be removed in v6.0.
    */
   setRepeatMode(guild, mode) {
     return this.#getQueue(guild).setRepeatMode(mode);
@@ -2358,6 +2409,7 @@ ${e.message}`;
    * Toggle autoplay mode
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns Autoplay mode state
+   * @deprecated Use `distube.getQueue(guild).toggleAutoplay()` instead. Will be removed in v6.0.
    */
   toggleAutoplay(guild) {
     const queue = this.#getQueue(guild);
@@ -2368,6 +2420,7 @@ ${e.message}`;
    * Add related song to the queue
    * @param guild - The type can be resolved to give a {@link Queue}
    * @returns The guild queue
+   * @deprecated Use `distube.getQueue(guild).addRelatedSong()` instead. Will be removed in v6.0.
    */
   addRelatedSong(guild) {
     return this.#getQueue(guild).addRelatedSong();
@@ -2377,6 +2430,7 @@ ${e.message}`;
    * @param guild - The type can be resolved to give a {@link Queue}
    * @param time  - Time in seconds
    * @returns Seeked queue
+   * @deprecated Use `distube.getQueue(guild).seek(time)` instead. Will be removed in v6.0.
    */
   seek(guild, time) {
     return this.#getQueue(guild).seek(time);
@@ -2421,7 +2475,7 @@ var ExtractorPlugin = class extends Plugin {
   type = "extractor" /* EXTRACTOR */;
 };
 
-// src/struct/InfoExtratorPlugin.ts
+// src/struct/InfoExtractorPlugin.ts
 var InfoExtractorPlugin = class extends Plugin {
   static {
     __name(this, "InfoExtractorPlugin");
@@ -2429,7 +2483,7 @@ var InfoExtractorPlugin = class extends Plugin {
   type = "info-extractor" /* INFO_EXTRACTOR */;
 };
 
-// src/struct/PlayableExtratorPlugin.ts
+// src/struct/PlayableExtractorPlugin.ts
 var PlayableExtractorPlugin = class extends Plugin {
   static {
     __name(this, "PlayableExtractorPlugin");
@@ -2437,7 +2491,10 @@ var PlayableExtractorPlugin = class extends Plugin {
   type = "playable-extractor" /* PLAYABLE_EXTRACTOR */;
 };
 export {
+  AUDIO_CHANNELS,
+  AUDIO_SAMPLE_RATE,
   BaseManager,
+  DEFAULT_VOLUME,
   DisTube,
   DisTubeBase,
   DisTubeError,
@@ -2449,14 +2506,21 @@ export {
   ExtractorPlugin,
   FilterManager,
   GuildIdManager,
+  HTTP_REDIRECT_CODES,
   InfoExtractorPlugin,
+  InfoExtractorPlugin as InfoExtratorPlugin,
+  JOIN_TIMEOUT_MS,
+  MAX_REDIRECT_DEPTH,
   Options,
   PlayableExtractorPlugin,
+  PlayableExtractorPlugin as PlayableExtratorPlugin,
   Playlist,
   Plugin,
   PluginType,
   Queue,
   QueueManager,
+  RECONNECT_MAX_ATTEMPTS,
+  RECONNECT_TIMEOUT_MS,
   RepeatMode,
   Song,
   TaskQueue,