v5.0.3

twlite · May 5, 2021 · ee6926d · ee6926d
1 parent b91f32d
commit ee6926d
Show file tree

Hide file tree

Showing 6 changed files with 121 additions and 75 deletions.
diff --git a/.npmignore b/.npmignore
@@ -1 +1,2 @@
-test/
+test/
+index.ts
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,7 @@
+{
+  "tabWidth": 4,
+  "useTabs": false,
+  "semi": true,
+  "printWidth": 80,
+  "singleQuote": true
+}
diff --git a/README.md b/README.md
@@ -2,9 +2,7 @@
 Simple ytdl wrapper for discord bots with custom ffmpeg args support.
 
 # Installing
-
-| WARNING: To use `discord-ytdl-core`, you will need to install `ytdl-core` on your own (from v5.x). |
-| --- |
+> First of all, you need to install `ytdl-core` with `npm install --save ytdl-core`.
 
 ## Install ytdl core
 
@@ -246,6 +244,7 @@ Check out **[ytdl-core](https://npmjs.com/package/ytdl-core)** for other functio
 [![](https://www.paypalobjects.com/webstatic/icon/pp258.png)](https://paypal.me/devsnowflake)
 
 # Related
+- **[youtube-sr](https://npmjs.com/package/youtube-sr)**
 - **[ytdl-core-discord](https://npmjs.com/package/ytdl-core-discord)**
 - **[discord-player](https://npmjs.com/discord-player)**
 

diff --git a/index.ts b/index.ts
@@ -1,64 +1,83 @@
-import ytdl, { downloadOptions } from "ytdl-core";
-import { opus as Opus, FFmpeg } from "prism-media";
-import { Readable, Duplex } from "stream";
+import ytdl, { downloadOptions } from 'ytdl-core';
+import { opus as Opus, FFmpeg } from 'prism-media';
+import { Readable, Duplex } from 'stream';
 
 // ytdl events
-const evn = ["info", "progress", "abort", "request", "response", "error", "redirect", "retry", "reconnect"];
+const evn = [
+    'info',
+    'progress',
+    'abort',
+    'request',
+    'response',
+    'error',
+    'redirect',
+    'retry',
+    'reconnect',
+];
 
 interface YTDLStreamOptions extends downloadOptions {
     seek?: number;
     encoderArgs?: string[];
     fmt?: string;
     opusEncoded?: boolean;
-};
+}
 
 interface StreamOptions {
     seek?: number;
     encoderArgs?: string[];
     fmt?: string;
     opusEncoded?: boolean;
-};
+}
 
 /**
-  * Create an opus stream for your video with provided encoder args
-  * @param url - YouTube URL of the video
-  * @param options - YTDL options
-  * @example const ytdl = require("discord-ytdl-core");
-  * const stream = ytdl("VIDEO_URL", {
-  *     seek: 3,
-  *     encoderArgs: ["-af", "bass=g=10"],
-  *     opusEncoded: true
-  * });
-  * VoiceConnection.play(stream, {
-  *     type: "opus"
-  * });
-  */
-const StreamDownloader = (url: string, options: YTDLStreamOptions) => {
+ * Create an opus stream for your video with provided encoder args
+ * @param url - YouTube URL of the video
+ * @param options - YTDL options
+ * @example const ytdl = require("discord-ytdl-core");
+ * const stream = ytdl("VIDEO_URL", {
+ *     seek: 3,
+ *     encoderArgs: ["-af", "bass=g=10"],
+ *     opusEncoded: true
+ * });
+ * VoiceConnection.play(stream, {
+ *     type: "opus"
+ * });
+ */
+const StreamDownloader = (url: string, options?: YTDLStreamOptions) => {
     if (!url) {
-        throw new Error("No input url provided");
+        throw new Error('No input url provided');
     }
-    if (typeof url !== "string") {
-        throw new SyntaxError(`input URL must be a string. Received ${typeof url}!`);
+    if (typeof url !== 'string') {
+        throw new SyntaxError(
+            `input URL must be a string. Received ${typeof url}!`
+        );
     }
 
+    options ??= {};
+
     let FFmpegArgs: string[] = [
-        "-analyzeduration", "0",
-        "-loglevel", "0",
-        "-f", `${options && options.fmt && typeof (options.fmt) == "string" ? options.fmt : "s16le"}`,
-        "-ar", "48000",
-        "-ac", "2"
+        '-analyzeduration',
+        '0',
+        '-loglevel',
+        '0',
+        '-f',
+        `${typeof options.fmt === 'string' ? options.fmt : 's16le'}`,
+        '-ar',
+        '48000',
+        '-ac',
+        '2',
     ];
 
-    if (options && options.seek && !isNaN(options.seek)) {
-        FFmpegArgs.unshift("-ss", options.seek.toString());
+    if (!isNaN(options.seek)) {
+        FFmpegArgs.unshift('-ss', options.seek.toString());
     }
 
-    if (options && options.encoderArgs && Array.isArray(options.encoderArgs)) {
+    if (Array.isArray(options.encoderArgs)) {
         FFmpegArgs = FFmpegArgs.concat(options.encoderArgs);
     }
 
     const transcoder = new FFmpeg({
-        args: FFmpegArgs
+        args: FFmpegArgs,
     });
 
     const inputStream = ytdl(url, options);
@@ -67,26 +86,26 @@ const StreamDownloader = (url: string, options: YTDLStreamOptions) => {
         for (const event of evn) {
             inputStream.on(event, (...args) => output.emit(event, ...args));
         }
-        inputStream.on("error", () => transcoder.destroy());
-        output.on("close", () => transcoder.destroy());
+        inputStream.on('error', () => transcoder.destroy());
+        output.on('close', () => transcoder.destroy());
         return output;
-    };
+    }
 
     const opus = new Opus.Encoder({
         rate: 48000,
         channels: 2,
-        frameSize: 960
+        frameSize: 960,
     });
 
     const outputStream = output.pipe(opus);
 
-    output.on('error', e => outputStream.emit('error', e));
+    output.on('error', (e) => outputStream.emit('error', e));
 
     for (const event of evn) {
         inputStream.on(event, (...args) => outputStream.emit(event, ...args));
     }
 
-    outputStream.on("close", () => {
+    outputStream.on('close', () => {
         transcoder.destroy();
         opus.destroy();
     });
@@ -102,73 +121,92 @@ const StreamDownloader = (url: string, options: YTDLStreamOptions) => {
  *     encoderArgs: ["-af", "asetrate=44100*1.25"],
  *     fmt: "mp3"
  * });
- * 
+ *
  * stream.pipe(fs.createWriteStream("kpop.mp3"));
  */
-const arbitraryStream = (stream: string | Readable | Duplex, options: StreamOptions) => {
+const arbitraryStream = (
+    stream: string | Readable | Duplex,
+    options?: StreamOptions
+) => {
     if (!stream) {
-        throw new Error("No stream source provided");
+        throw new Error('No stream source provided');
     }
 
+    options ??= {};
+
     let FFmpegArgs: string[];
-    if (typeof stream === "string") {
+    if (typeof stream === 'string') {
         FFmpegArgs = [
-            '-reconnect', '1',
-            '-reconnect_streamed', '1',
-            '-reconnect_delay_max', '5',
-            "-i", stream,
-            "-analyzeduration", "0",
-            "-loglevel", "0",
-            "-f", `${options && options.fmt && typeof (options.fmt) == "string" ? options.fmt : "s16le"}`,
-            "-ar", "48000",
-            "-ac", "2"
+            '-reconnect',
+            '1',
+            '-reconnect_streamed',
+            '1',
+            '-reconnect_delay_max',
+            '5',
+            '-i',
+            stream,
+            '-analyzeduration',
+            '0',
+            '-loglevel',
+            '0',
+            '-f',
+            `${typeof options.fmt === 'string' ? options.fmt : 's16le'}`,
+            '-ar',
+            '48000',
+            '-ac',
+            '2',
         ];
     } else {
         FFmpegArgs = [
-            "-analyzeduration", "0",
-            "-loglevel", "0",
-            "-f", `${options && options.fmt && typeof (options.fmt) == "string" ? options.fmt : "s16le"}`,
-            "-ar", "48000",
-            "-ac", "2"
+            '-analyzeduration',
+            '0',
+            '-loglevel',
+            '0',
+            '-f',
+            `${typeof options.fmt === 'string' ? options.fmt : 's16le'}`,
+            '-ar',
+            '48000',
+            '-ac',
+            '2',
         ];
     }
 
-    if (options && options.seek && !isNaN(options.seek)) {
-        FFmpegArgs.unshift("-ss", options.seek.toString());
+    if (!isNaN(options.seek)) {
+        FFmpegArgs.unshift('-ss', options.seek.toString());
     }
 
-    if (options && options.encoderArgs && Array.isArray(options.encoderArgs)) {
+    if (Array.isArray(options.encoderArgs)) {
         FFmpegArgs = FFmpegArgs.concat(options.encoderArgs);
     }
 
     let transcoder = new FFmpeg({
-        args: FFmpegArgs
+        args: FFmpegArgs,
     });
-    if (typeof stream !== "string") {
+    if (typeof stream !== 'string') {
         transcoder = stream.pipe(transcoder);
-        stream.on("error", () => transcoder.destroy());
+        stream.on('error', () => transcoder.destroy());
     }
     if (options && !options.opusEncoded) {
-        transcoder.on("close", () => transcoder.destroy());
+        transcoder.on('close', () => transcoder.destroy());
         return transcoder;
-    };
+    }
     const opus = new Opus.Encoder({
         rate: 48000,
         channels: 2,
-        frameSize: 960
+        frameSize: 960,
     });
 
     const outputStream = transcoder.pipe(opus);
-    outputStream.on("close", () => {
+    outputStream.on('close', () => {
         transcoder.destroy();
         opus.destroy();
     });
     return outputStream;
 };
 
 StreamDownloader.arbitraryStream = arbitraryStream;
-StreamDownloader.version = require("./package.json").version;
+StreamDownloader.version = require('./package.json').version;
 
 const DiscordYTDLCore = Object.assign(StreamDownloader, ytdl);
 
-export = DiscordYTDLCore;
+export = DiscordYTDLCore;
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "discord-ytdl-core",
-    "version": "5.0.2",
+    "version": "5.0.3",
     "description": "Simple ytdl wrapper for discord bots with custom ffmpeg args support.",
     "main": "index.js",
     "types": "index.d.ts",
@@ -49,10 +49,11 @@
     },
     "homepage": "https://ytdl.snowflakedev.xyz",
     "dependencies": {
-        "prism-media": "^1.2.7"
+        "prism-media": "^1.2.9"
     },
     "devDependencies": {
         "@types/node": "^14.14.31",
+        "discord.js": "^12.5.3",
         "ffmpeg-static": "^4.2.6",
         "node-opus": "^0.3.2",
         "ytdl-core": "^4.5.0"

diff --git a/tsconfig.json b/tsconfig.json
@@ -1,7 +1,7 @@
 {
     "compilerOptions": {
         "module": "commonjs",
-        "target": "ES2020",
+        "target": "ES6",
         "declaration": false,
         "strict": true,
         "strictNullChecks": false,