distube 4.2.0 → 4.2.1

package/README.md

@@ -19,7 +19,7 @@
 
 # DisTube
 
-A Discord.js module to simplify your music commands and play songs with audio filters on Discord without any API key.
+A powerful Discord.js module for simplifying music commands and effortless playback of various sources with integrated audio filters.
 
 [DisTube Support Server](https://discord.gg/feaDd9h) - [Frequently Asked Questions](https://discord.gg/feaDd9h)
 

package/dist/index.d.ts

@@ -127,7 +127,7 @@ type DisTubeOptions = {
     searchCooldown?: number;
     /**
      * YouTube cookies. Guide: {@link
-     * https://distube.js.org/#/docs/DisTube/main/general/cookie | YouTube Cookies}
+     * https://github.com/skick1234/DisTube/wiki/YouTube-Cookies | YouTube Cookies}
      */
     youtubeCookie?: Cookie[] | string;
     /**
@@ -167,12 +167,31 @@ type DisTubeOptions = {
     directLink?: boolean;
     /**
      * FFmpeg path
+     * @deprecated
      */
     ffmpegPath?: string;
     /**
      * FFmpeg default arguments
-     */
-    ffmpegDefaultArgs?: FFmpegOptions;
+     * @deprecated
+     */
+    ffmpegDefaultArgs?: FFmpegArgs;
+    /**
+     * FFmpeg options
+     */
+    ffmpeg?: {
+        /**
+         * FFmpeg path
+         */
+        path?: string;
+        /**
+         * FFmpeg default arguments
+         */
+        args?: {
+            global?: FFmpegArgs;
+            input?: FFmpegArgs;
+            output?: FFmpegArgs;
+        };
+    };
 };
 /**
  * Data that can be resolved to give a guild id string. This can be:
@@ -364,7 +383,15 @@ declare enum Events {
     SEARCH_RESULT = "searchResult",
     FFMPEG_DEBUG = "ffmpegDebug"
 }
-type FFmpegOptions = Record<string, string | number | boolean | Array<string | null | undefined> | null | undefined>;
+type FFmpegArgs = Record<string, string | number | boolean | Array<string | null | undefined> | null | undefined>;
+type FFmpegOptions = {
+    path: string;
+    args: {
+        global: FFmpegArgs;
+        input: FFmpegArgs;
+        output: FFmpegArgs;
+    };
+};
 
 /**
  * Default DisTube audio filters.
@@ -387,11 +414,6 @@ declare const defaultOptions: {
     joinNewVoiceChannel: true;
     streamType: StreamType.OPUS;
     directLink: true;
-    ffmpegPath: string;
-    ffmpegDefaultArgs: {
-        analyzeduration: number;
-        hide_banner: true;
-    };
 };
 
 declare const ERROR_MESSAGES: {
@@ -413,6 +435,8 @@ declare const ERROR_MESSAGES: {
     VOICE_RECONNECT_FAILED: string;
     VOICE_DIFFERENT_GUILD: string;
     VOICE_DIFFERENT_CLIENT: string;
+    FFMPEG_EXITED: (code: number) => string;
+    FFMPEG_NOT_INSTALLED: (path: string) => string;
     NO_QUEUE: string;
     QUEUE_EXIST: string;
     PAUSED: string;
@@ -759,19 +783,18 @@ declare class DisTubeVoice extends TypedEmitter<DisTubeVoiceEvents> {
 }
 
 interface StreamOptions {
-    ffmpeg: {
-        path: string;
-        args: FFmpegOptions;
-    };
+    ffmpeg: FFmpegOptions;
     seek?: number;
     type?: StreamType;
 }
 declare const chooseBestVideoFormat: ({ duration, formats, isLive }: Song) => ytdl.videoFormat | undefined;
+declare const checkFFmpeg: (distube: DisTube) => void;
 /**
  * Create a stream to play with {@link DisTubeVoice}
  */
 declare class DisTubeStream extends TypedEmitter<{
     debug: (debug: string) => Awaitable;
+    error: (error: Error) => Awaitable;
 }> {
     private killed;
     process: ChildProcess;
@@ -899,8 +922,11 @@ declare class Options {
     joinNewVoiceChannel: boolean;
     streamType: StreamType;
     directLink: boolean;
-    ffmpegPath: string;
-    ffmpegDefaultArgs: FFmpegOptions;
+    /** @deprecated */
+    ffmpegPath: undefined;
+    /** @deprecated */
+    ffmpegDefaultArgs: undefined;
+    ffmpeg: FFmpegOptions;
     constructor(options: DisTubeOptions);
 }
 
@@ -1011,7 +1037,7 @@ declare class FilterManager extends BaseManager<Filter> {
      * Array of enabled filters
      */
     get values(): Filter[];
-    get ffmpegArgs(): FFmpegOptions;
+    get ffmpegArgs(): FFmpegArgs;
     toString(): string;
 }
 
@@ -1616,9 +1642,9 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     readonly filters: Filters;
     /**
      * @deprecated Use `youtubeCookie: Cookie[]` instead. Guide: {@link
-     * https://distube.js.org/#/docs/DisTube/main/general/cookie | YouTube Cookies}
+     * https://github.com/skick1234/DisTube/wiki/YouTube-Cookies | YouTube Cookies}
      */
-    constructor(client: Client, otp: DisTubeOptions & {
+    constructor(client: Client, opts: DisTubeOptions & {
         youtubeCookie: string;
     });
     /**
@@ -1638,9 +1664,9 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
      * @throws {@link DisTubeError}
      *
      * @param client - Discord.JS client
-     * @param otp    - Custom DisTube options
+     * @param opts   - Custom DisTube options
      */
-    constructor(client: Client, otp?: DisTubeOptions);
+    constructor(client: Client, opts?: DisTubeOptions);
     static get version(): string;
     /**
      * DisTube version
@@ -1965,4 +1991,4 @@ declare class DisTube extends TypedEmitter<TypedDisTubeEvents> {
     emitError(error: Error, channel?: GuildTextBasedChannel): void;
 }
 
-export { type Awaitable, BaseManager, type Chapter, type CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, type DisTubeEvents, DisTubeHandler, type DisTubeOptions, DisTubeStream, DisTubeVoice, type DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, type FFmpegOptions, type Filter, FilterManager, type FilterResolvable, type Filters, GuildIdManager, type GuildIdResolvable, Options, type OtherSongInfo, type PlayHandlerOptions, type PlayOptions, Playlist, type PlaylistInfo, Plugin, PluginType, Queue, QueueManager, type RelatedSong, RepeatMode, type ResolveOptions, type ResolvePlaylistOptions, type SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, type TypedDisTubeEvents, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isNsfwChannel, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isTruthy, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };
+export { type Awaitable, BaseManager, type Chapter, type CustomPlaylistOptions, CustomPlugin, DirectLinkPlugin, DisTube, DisTubeBase, DisTubeError, type DisTubeEvents, DisTubeHandler, type DisTubeOptions, DisTubeStream, DisTubeVoice, type DisTubeVoiceEvents, DisTubeVoiceManager, Events, ExtractorPlugin, type FFmpegArgs, type FFmpegOptions, type Filter, FilterManager, type FilterResolvable, type Filters, GuildIdManager, type GuildIdResolvable, Options, type OtherSongInfo, type PlayHandlerOptions, type PlayOptions, Playlist, type PlaylistInfo, Plugin, PluginType, Queue, QueueManager, type RelatedSong, RepeatMode, type ResolveOptions, type ResolvePlaylistOptions, type SearchResult, SearchResultPlaylist, SearchResultType, SearchResultVideo, Song, StreamType, TaskQueue, type TypedDisTubeEvents, checkFFmpeg, checkIntents, checkInvalidKey, chooseBestVideoFormat, DisTube as default, defaultFilters, defaultOptions, formatDuration, isClientInstance, isGuildInstance, isMemberInstance, isMessageInstance, isNsfwChannel, isObject, isRecord, isSnowflake, isSupportedVoiceChannel, isTextChannelInstance, isTruthy, isURL, isVoiceChannelEmpty, objectKeys, parseNumber, resolveGuildId, toSecond, version };

package/dist/index.js

@@ -63,7 +63,7 @@ var require_package = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "distube",
-      version: "4.2.0",
+      version: "4.2.1",
       description: "A Discord.js module to simplify your music commands and play songs with audio filters on Discord without any API key.",
       main: "./dist/index.js",
       types: "./dist/index.d.ts",
@@ -202,6 +202,7 @@ __export(src_exports, {
   Song: () => Song,
   StreamType: () => StreamType,
   TaskQueue: () => TaskQueue,
+  checkFFmpeg: () => checkFFmpeg,
   checkIntents: () => checkIntents,
   checkInvalidKey: () => checkInvalidKey,
   chooseBestVideoFormat: () => chooseBestVideoFormat,
@@ -307,12 +308,7 @@ var defaultOptions = {
   emitAddListWhenCreatingQueue: true,
   joinNewVoiceChannel: true,
   streamType: 0 /* OPUS */,
-  directLink: true,
-  ffmpegPath: "ffmpeg",
-  ffmpegDefaultArgs: {
-    analyzeduration: 0,
-    hide_banner: true
-  }
+  directLink: true
 };
 
 // src/struct/DisTubeError.ts
@@ -336,6 +332,8 @@ var ERROR_MESSAGES = {
   VOICE_RECONNECT_FAILED: "Cannot reconnect to the voice channel",
   VOICE_DIFFERENT_GUILD: "Cannot join a voice channel in a different guild",
   VOICE_DIFFERENT_CLIENT: "Cannot join a voice channel created by a different client",
+  FFMPEG_EXITED: (code) => `ffmpeg exited with code ${code}`,
+  FFMPEG_NOT_INSTALLED: (path) => `ffmpeg is not installed at '${path}' path`,
   NO_QUEUE: "There is no playing queue in this guild",
   QUEUE_EXIST: "This guild has a Queue already",
   PAUSED: "The queue has been paused already",
@@ -962,7 +960,7 @@ var _DisTubeVoice = class _DisTubeVoice extends import_tiny_typed_emitter.TypedE
    */
   play(dtStream) {
     this.emittedError = false;
-    dtStream.stream.on("error", (error) => {
+    dtStream.on("error", (error) => {
       if (this.emittedError || error.code === "ERR_STREAM_PREMATURE_CLOSE")
         return;
       this.emittedError = true;
@@ -1080,11 +1078,41 @@ __name(_DisTubeVoice, "DisTubeVoice");
 var DisTubeVoice = _DisTubeVoice;
 
 // src/core/DisTubeStream.ts
-var import_child_process = require("child_process");
 var import_node_stream = require("stream");
+var import_child_process = require("child_process");
 var import_tiny_typed_emitter2 = require("tiny-typed-emitter");
 var import_voice2 = require("@discordjs/voice");
 var chooseBestVideoFormat = /* @__PURE__ */ __name(({ duration, formats, isLive }) => formats && formats.filter((f) => f.hasAudio && (duration < 10 * 60 || f.hasVideo) && (!isLive || f.isHLS)).sort((a, b) => Number(b.audioBitrate) - Number(a.audioBitrate) || Number(a.bitrate) - Number(b.bitrate))[0], "chooseBestVideoFormat");
+var checked = process.env.NODE_ENV === "test";
+var checkFFmpeg = /* @__PURE__ */ __name((distube) => {
+  if (checked)
+    return;
+  const path = distube.options.ffmpeg.path;
+  const debug = /* @__PURE__ */ __name((str) => distube.emit("ffmpegDebug" /* FFMPEG_DEBUG */, str), "debug");
+  try {
+    debug(`[test] spawn ffmpeg at '${path}' path`);
+    const process2 = (0, import_child_process.spawnSync)(path, ["-h"], { windowsHide: true, shell: true, encoding: "utf-8" });
+    if (process2.error)
+      throw process2.error;
+    if (process2.stderr && !process2.stdout)
+      throw new Error(process2.stderr);
+    const result = process2.output.join("\n");
+    const version2 = /ffmpeg version (\S+)/iu.exec(result)?.[1];
+    if (!version2)
+      throw new Error("Invalid FFmpeg version");
+    debug(`[test] ffmpeg version: ${version2}`);
+    if (result.includes("--enable-libopus")) {
+      debug("[test] ffmpeg supports libopus");
+    } else {
+      debug("[test] ffmpeg does not support libopus");
+      distube.options.streamType = 1 /* RAW */;
+    }
+  } catch (e) {
+    debug(`[test] failed to spawn ffmpeg at '${path}': ${e?.stack ?? e}`);
+    throw new DisTubeError("FFMPEG_NOT_INSTALLED", path);
+  }
+  checked = true;
+}, "checkFFmpeg");
 var _DisTubeStream = class _DisTubeStream extends import_tiny_typed_emitter2.TypedEmitter {
   /**
    * Create a DisTubeStream to play with {@link DisTubeVoice}
@@ -1103,13 +1131,16 @@ var _DisTubeStream = class _DisTubeStream extends import_tiny_typed_emitter2.Typ
     this.type = !type ? import_voice2.StreamType.OggOpus : import_voice2.StreamType.Raw;
     const opts = {
       reconnect: 1,
-      reconnect_on_network_error: 1,
       reconnect_streamed: 1,
       reconnect_delay_max: 5,
+      analyzeduration: 0,
+      hide_banner: true,
+      ...ffmpeg.args.global,
+      ...ffmpeg.args.input,
       i: url,
       ar: 48e3,
       ac: 2,
-      ...ffmpeg.args
+      ...ffmpeg.args.output
     };
     if (!type) {
       opts.f = "opus";
@@ -1129,19 +1160,26 @@ var _DisTubeStream = class _DisTubeStream extends import_tiny_typed_emitter2.Typ
         ).flat(),
         "pipe:1"
       ],
-      { stdio: ["ignore", "pipe", "pipe"] }
-    ).on("error", (err) => this.debug(`[process] error: ${err.message}`)).on("exit", (code, signal) => {
+      { stdio: ["ignore", "pipe", "pipe"], shell: false, windowsHide: true }
+    ).on("error", (err) => {
+      this.debug(`[process] error: ${err.message}`);
+      this.emit("error", err);
+    }).on("exit", (code, signal) => {
       this.debug(`[process] exit: code=${code ?? "unknown"} signal=${signal ?? "unknown"}`);
       if (!code || [0, 255].includes(code))
         return;
       this.debug(`[process] error: ffmpeg exited with code ${code}`);
+      this.emit("error", new DisTubeError("FFMPEG_EXITED", code));
     });
     if (!this.process.stdout || !this.process.stderr) {
       this.kill();
       throw new Error("Failed to create ffmpeg process");
     }
     this.stream = new import_node_stream.PassThrough();
-    this.stream.on("close", () => this.kill()).on("error", (err) => this.debug(`[stream] error: ${err.message}`)).on("finish", () => this.debug("[stream] log: stream finished"));
+    this.stream.on("close", () => this.kill()).on("error", (err) => {
+      this.debug(`[stream] error: ${err.message}`);
+      this.emit("error", err);
+    }).on("finish", () => this.debug("[stream] log: stream finished"));
     this.process.stdout.pipe(this.stream);
     this.process.stderr.setEncoding("utf8")?.on("data", (data) => {
       const lines = data.split(/\r\n|\r|\n/u);
@@ -1247,7 +1285,7 @@ var _DisTubeHandler = class _DisTubeHandler extends DisTubeBase {
       const cookies = __privateSet(this, _cookie, this.options.youtubeCookie);
       if (typeof cookies === "string") {
         console.warn(
-          "\x1B[33mWARNING:\x1B[0m You are using the old YouTube cookie format, please use the new one instead. (https://distube.js.org/#/docs/DisTube/main/general/cookie)"
+          "\x1B[33mWARNING:\x1B[0m You are using the old YouTube cookie format, please use the new one instead. (https://github.com/skick1234/DisTube/wiki/YouTube-Cookies)"
         );
         options.agent = import_ytdl_core.default.createAgent(
           cookies.split(";").map((c) => import_tough_cookie.Cookie.parse(c)).filter(isTruthy)
@@ -1544,10 +1582,11 @@ __name(_DisTubeHandler, "DisTubeHandler");
 var DisTubeHandler = _DisTubeHandler;
 
 // src/core/DisTubeOptions.ts
-var _validateOptions, validateOptions_fn;
+var _validateOptions, validateOptions_fn, _ffmpegOption, ffmpegOption_fn;
 var _Options = class _Options {
   constructor(options) {
     __privateAdd(this, _validateOptions);
+    __privateAdd(this, _ffmpegOption);
     __publicField(this, "plugins");
     __publicField(this, "emitNewSongOnly");
     __publicField(this, "leaveOnFinish");
@@ -1566,8 +1605,11 @@ var _Options = class _Options {
     __publicField(this, "joinNewVoiceChannel");
     __publicField(this, "streamType");
     __publicField(this, "directLink");
+    /** @deprecated */
     __publicField(this, "ffmpegPath");
+    /** @deprecated */
     __publicField(this, "ffmpegDefaultArgs");
+    __publicField(this, "ffmpeg");
     if (typeof options !== "object" || Array.isArray(options)) {
       throw new DisTubeError("INVALID_TYPE", "object", options, "DisTubeOptions");
     }
@@ -1590,8 +1632,7 @@ var _Options = class _Options {
     this.joinNewVoiceChannel = opts.joinNewVoiceChannel;
     this.streamType = opts.streamType;
     this.directLink = opts.directLink;
-    this.ffmpegPath = opts.ffmpegPath;
-    this.ffmpegDefaultArgs = opts.ffmpegDefaultArgs;
+    this.ffmpeg = __privateMethod(this, _ffmpegOption, ffmpegOption_fn).call(this, options);
     checkInvalidKey(opts, this, "DisTubeOptions");
     __privateMethod(this, _validateOptions, validateOptions_fn).call(this);
   }
@@ -1611,8 +1652,8 @@ validateOptions_fn = /* @__PURE__ */ __name(function(options = this) {
     "directLink"
   ]);
   const numberOptions = /* @__PURE__ */ new Set(["searchCooldown", "emptyCooldown", "searchSongs"]);
-  const stringOptions = /* @__PURE__ */ new Set(["ffmpegPath"]);
-  const objectOptions = /* @__PURE__ */ new Set(["customFilters", "ytdlOptions", "ffmpegDefaultArgs"]);
+  const stringOptions = /* @__PURE__ */ new Set();
+  const objectOptions = /* @__PURE__ */ new Set(["customFilters", "ytdlOptions", "ffmpeg"]);
   const optionalOptions = /* @__PURE__ */ new Set(["youtubeCookie", "customFilters"]);
   for (const [key, value] of Object.entries(options)) {
     if (value === void 0 && optionalOptions.has(key))
@@ -1642,6 +1683,29 @@ validateOptions_fn = /* @__PURE__ */ __name(function(options = this) {
     }
   }
 }, "#validateOptions");
+_ffmpegOption = new WeakSet();
+ffmpegOption_fn = /* @__PURE__ */ __name(function(opts) {
+  let path;
+  const args = { global: {}, input: {}, output: {} };
+  if (opts.ffmpegPath) {
+    console.warn("`DisTubeOptions.ffmpegPath` is deprecated. Use `ffmpeg.path` instead.");
+    path = opts.ffmpegPath;
+  }
+  if (opts.ffmpegDefaultArgs) {
+    console.warn("`DisTubeOptions.ffmpegDefaultArgs` is deprecated. Use `ffmpeg.args` instead.");
+    args.global = opts.ffmpegDefaultArgs;
+  }
+  path ??= opts.ffmpeg?.path ?? `ffmpeg${process.platform === "win32" ? ".exe" : ""}`;
+  if (opts.ffmpeg?.args) {
+    if (opts.ffmpeg.args.global)
+      args.global = opts.ffmpeg.args.global;
+    if (opts.ffmpeg.args.input)
+      args.input = opts.ffmpeg.args.input;
+    if (opts.ffmpeg.args.output)
+      args.output = opts.ffmpeg.args.output;
+  }
+  return { path, args };
+}, "#ffmpegOption");
 __name(_Options, "Options");
 var Options = _Options;
 
@@ -1920,6 +1984,7 @@ var _QueueManager = class _QueueManager extends GuildIdManager {
     const queue = new Queue(this.distube, voice, song, textChannel);
     await queue._taskQueue.queuing();
     try {
+      checkFFmpeg(this.distube);
       await voice.join();
       __privateMethod(this, _voiceEventHandler, voiceEventHandler_fn).call(this, queue);
       this.add(queue.id, queue);
@@ -1940,10 +2005,11 @@ var _QueueManager = class _QueueManager extends GuildIdManager {
     const { duration, source, streamURL } = song;
     const streamOptions = {
       ffmpeg: {
-        path: this.options.ffmpegPath,
+        path: this.options.ffmpeg.path,
         args: {
-          ...this.options.ffmpegDefaultArgs,
-          ...queue.filters.ffmpegArgs
+          global: { ...this.options.ffmpeg.args.global },
+          input: { ...this.options.ffmpeg.args.input },
+          output: { ...this.options.ffmpeg.args.output, ...queue.filters.ffmpegArgs }
         }
       },
       seek: duration ? queue.beginTime : void 0,
@@ -1951,6 +2017,8 @@ var _QueueManager = class _QueueManager extends GuildIdManager {
     };
     if (source === "youtube")
       return DisTubeStream.YouTube(song, streamOptions);
+    if (!streamURL)
+      throw new Error("No streamURL, something went wrong");
     return DisTubeStream.DirectLink(streamURL, streamOptions);
   }
   /**
@@ -2737,15 +2805,9 @@ var _DirectLinkPlugin = class _DirectLinkPlugin extends ExtractorPlugin {
     return false;
   }
   resolve(url, options = {}) {
-    url = url.replace(/\/+$/, "");
-    return new Song(
-      {
-        name: url.substring(url.lastIndexOf("/") + 1).replace(/((\?|#).*)?$/, "") || url,
-        url,
-        src: "direct_link"
-      },
-      options
-    );
+    const u = new URL(url);
+    const name = u.pathname.split("/").pop() || u.href;
+    return new Song({ name, url, src: "direct_link" }, options);
   }
 };
 __name(_DirectLinkPlugin, "DirectLinkPlugin");
@@ -2757,7 +2819,7 @@ var import_tiny_typed_emitter3 = require("tiny-typed-emitter");
 var { version } = require_package();
 var _getQueue, getQueue_fn;
 var _DisTube = class _DisTube extends import_tiny_typed_emitter3.TypedEmitter {
-  constructor(client, otp = {}) {
+  constructor(client, opts = {}) {
     super();
     __privateAdd(this, _getQueue);
     __publicField(this, "handler");
@@ -2773,7 +2835,7 @@ var _DisTube = class _DisTube extends import_tiny_typed_emitter3.TypedEmitter {
       throw new DisTubeError("INVALID_TYPE", "Discord.Client", client, "client");
     this.client = client;
     checkIntents(client.options);
-    this.options = new Options(otp);
+    this.options = new Options(opts);
     this.voices = new DisTubeVoiceManager(this);
     this.handler = new DisTubeHandler(this);
     this.queues = new QueueManager(this);
@@ -3261,7 +3323,7 @@ ${e.message}`;
       console.error(error);
       console.warn("Unhandled 'error' event.");
       console.warn(
-        "See: https://distube.js.org/#/docs/DisTube/stable/class/DisTube?scrollTo=e-error and https://nodejs.org/api/events.html#events_error_events"
+        "See: https://distube.js.org/classes/DisTube.html#error and https://nodejs.org/api/events.html#events_error_events"
       );
     }
   }
@@ -3304,6 +3366,7 @@ var DisTube = _DisTube;
   Song,
   StreamType,
   TaskQueue,
+  checkFFmpeg,
   checkIntents,
   checkInvalidKey,
   chooseBestVideoFormat,