Merge pull request #35 from ytdl-node/dev

feat: Inbuilt mp3 player

Author: roerohan

.eslintrc.json

@@ -20,7 +20,8 @@
         "project": [
             "./tsconfig.json",
             "./config/tsconfig.examples.json",
-            "./config/tsconfig.test.json"
+            "./config/tsconfig.test.json",
+            "./config/tsconfig.preinstall.json"
         ]
     },
     "rules": {
@@ -53,6 +54,12 @@
             "parserOptions": {
                 "ecmaVersion": 2019
             }
+        },
+        {
+            "files": "./preinstall.js",
+            "rules": {
+                "no-console": "off"
+            }
         }
     ]
 }

.github/workflows/build.yml

@@ -12,6 +12,10 @@ jobs:
     steps:
     - uses: actions/checkout@v2
 
+    - run: |
+        sudo apt-get update
+        sudo apt-get install libasound2-dev # For alsa/asoundlib.h header needed for npm install
+
     - name: npm install, build and test
       run: |
         npm install

.github/workflows/publish.yml

@@ -28,9 +28,13 @@ jobs:
         run: |
           echo "versionChanged- ${{steps.check.outputs.versionChanged}}"
           echo "releaseVersion- ${{steps.check.outputs.releaseVersion}}"
+      
+      - run: |
+          sudo apt-get update
+          sudo apt-get install libasound2-dev # For alsa/asoundlib.h header needed for npm install
 
       - if: steps.check.outputs.versionChanged == 'true'
-        run: yarn install
+        run: npm install
 
       - if: steps.check.outputs.versionChanged == 'true'
         run: npm publish --access public

.github/workflows/release.yml

@@ -29,7 +29,11 @@ jobs:
         run: |
           echo "versionChanged- ${{steps.check.outputs.versionChanged}}"
           echo "releaseVersion- ${{steps.check.outputs.releaseVersion}}"
-        
+
+      - run: |
+          sudo apt-get update
+          sudo apt-get install libasound2-dev # For alsa/asoundlib.h header needed for npm install
+      
       - name: Pack
         if: steps.check.outputs.versionChanged == 'true'
         run: |

README.md

@@ -5,6 +5,9 @@
 **ytdl** provides a library to integrate a Youtube Downloader for `Node.js` projects, and a CLI to download content from [Youtube](https://www.youtube.com). **ytdl** can also stream audio/video from YouTube, **without downloading**, directly to your locally installed media player!
 
 > Note: You need [ffmpeg](https://ffmpeg.org/download.html) to be installed on your computer for complete functionality. Without it, you won't be able to some formats/qualities of videos.
+<br />
+
+> Note: To use the inbuilt mp3 player `ytdl-mp3` on Linux distros, `<alsa/asoundlib.h>` header file must be present. The preinstall script logs a warning if it is not present. Ubuntu/Debian users require to install the `libasound2-dev` package (`sudo apt-get install libasound2-dev`), if not present already; before installing the library.
 
 # Contents
 
@@ -317,19 +320,26 @@ ytdl('https://www.youtube.com/watch?v=fJ9rUzIMcZQ').then((video) => {
 - Play audio or video from YouTube in your local media player.
 - `quality` may be an `itag` or among the ones mentioned [here](#quality-string).
 - Options are of [this](#options-object) format. This is ignored if parameter `quality` is an `itag`.
+- The function returns a `Player` object, with attributes `player` and `play(url, stream)`.
+
+### Audio
+- By default, audio is played on a cross-platform player integrated with ytdl.
+- However, if the parameter `player` is passed, it is played on the specified media player.
+
+### Video
+- `cvlc` is the default video player.
 - Allowed media players are: `cvlc`, `vlc`, `mplayer`, `afplay`, `mpg123`, `mpg321`, `play`, `omxplayer`, `aplay`, `cmdmp3`.
 
-> Default player is `cvlc`.
 > The media player set must be on your [PATH](https://en.wikipedia.org/wiki/PATH_(variable)) or in your Environment Variables. On UNIX based systems, you can check if your media player is on your PATH by using the which command, e.g. `which mplayer`.
 
 ```javascript
 const ytdl = require('@ytdl/ytdl').default;
 
 async function play() {
   const video = await ytdl('https://www.youtube.com/watch?v=fJ9rUzIMcZQ');
-  video.play('any', { audioOnly: true }, 'mplayer');
+  video.play('any', { audioOnly: true });
 
-  // Play audio of any quality on mplayer.
+  // Play audio of any quality on ytdl-mp3 player.
 }
 
 play();
@@ -341,9 +351,36 @@ play();
 const ytdl = require('@ytdl/ytdl').default;
 
 ytdl('https://www.youtube.com/watch?v=fJ9rUzIMcZQ').then((video) => {
-  video.play('any', { audioOnly: true }, 'mplayer');
+  video.play('any', { audioOnly: true });
+
+  // Play audio of any quality on ytdl-mp3 player.
+});
+```
+
+- The `Player` object returned can be used to log the name of the player being used.
+- In this example, `mplayer` is being used.
+
+```javascript
+async function playLocal() {
+  const video = await ytdl.init('https://www.youtube.com/watch?v=A7ry4cx6HfY');
+  const player = await video.play('any', { audioOnly: true }, 'mplayer');
+  console.log(`Player: ${player.player}`);
 
-  // Play audio of any quality on mplayer.
+  // Logs the player on which media is being played.
+}
+
+playLocal();
+```
+
+### OR
+
+```javascript
+ytdl.init('https://www.youtube.com/watch?v=A7ry4cx6HfY').then((video) => {
+  video.play('any', { audioOnly: true }, 'mplayer').then((player) => {
+      console.log(`Player: ${player.player}`);
+
+      // Logs the player on which media is being played.
+  });
 });
 ```
 

config/tsconfig.preinstall.json

@@ -0,0 +1,10 @@
+{
+    "extends": "./tsconfig.base.json",
+    "compilerOptions": {
+        "allowJs": true,
+        "checkJs": true,
+    },
+    "files": [
+        "../preinstall.js"
+    ]
+}

examples/play.example.js

@@ -1,11 +1,23 @@
 const ytdl = require('..'); // require('@ytdl/ytdl');
 
 /**
- * This function players audio from 'https://www.youtube.com/watch?v=A7ry4cx6HfY' on locally installed 'mplayer'
+ * This function players audio from 'https://www.youtube.com/watch?v=A7ry4cx6HfY' on 'ytdl-mp3' player;
  */
 async function play() {
     const video = await ytdl.init('https://www.youtube.com/watch?v=A7ry4cx6HfY');
-    video.play('any', { audioOnly: true }, 'mplayer');
+    const player = await video.play('any', { audioOnly: true });
+    console.log(`Player: ${player.player}`);
 }
 
 play();
+
+/**
+ * This function players audio from 'https://www.youtube.com/watch?v=A7ry4cx6HfY' on 'mplayer';
+ */
+async function playLocal() {
+    const video = await ytdl.init('https://www.youtube.com/watch?v=A7ry4cx6HfY');
+    const player = await video.play('any', { audioOnly: true }, 'mplayer');
+    console.log(`Player: ${player.player}`);
+}
+
+playLocal();

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@ytdl/ytdl",
-    "version": "1.4.4",
+    "version": "1.4.5",
     "description": "A CLI/Library written in typescript/javascript, which allows you to download/play videos from YouTube onto your system.",
     "keywords": [
         "youtube",
@@ -16,14 +16,15 @@
     "main": "dist/src/index.js",
     "scripts": {
         "build": "npm run clean && tsc",
-        "clean": "rm -rf ./dist",
+        "clean": "rimraf ./dist",
         "test": "mocha --config test/.mocharc.json test/**/*.ts",
         "lint": "eslint \"src/**/*.{ts,js,jsx}\" \"test/**/*.ts\" \"examples/**/*.{ts,js}\"",
         "pack-src": "ncc build src/index.ts -o dist/src",
         "pack-cli": "ncc build bin/ytdl -o dist/cli && mv dist/cli/index.js dist/cli/ytdl",
         "pack": "npm run clean && npm run build && npm run pack-cli",
         "start": "ts-node src/index.ts",
-        "prepare": "npm run build"
+        "prepare": "npm run build",
+        "preinstall": "node ./preinstall.js"
     },
     "bin": {
         "ytdl": "bin/ytdl"
@@ -71,5 +72,8 @@
         "commander": "^5.0.0",
         "fluent-ffmpeg": "^2.1.2",
         "winston": "^3.2.1"
+    },
+    "optionalDependencies": {
+        "speaker": "^0.5.1"
     }
 }

package.json

@@ -0,0 +1,16 @@
+const { execSync } = require('child_process');
+
+if (process.platform === 'linux') {
+    let exitStatus;
+    try {
+        execSync('echo "#include <alsa/asoundlib.h>" | gcc -H -o /dev/null -x c - 2>&1 | head -n1').toString();
+        exitStatus = 0;
+    } catch (err) {
+        exitStatus = err.status;
+    }
+
+    if (exitStatus !== 0) {
+        console.warn(`WARN: 'alsa/asoundlib.h' is absent. For Ubuntu/Debian operating systems, install using the following command:
+        \nsudo apt-get update && sudo apt-get install libasound2-dev\n`);
+    }
+}

preinstall.js

@@ -77,12 +77,13 @@ async function parseOptions(program: commander.Command): Promise<void> {
 
         logger.info(`Video ID: ${id}`);
         logger.info(`Video Title: ${title}`);
-        logger.info(`Video Time: ${time} seconds`);
+        logger.info(`Video Time: ${time}`);
         logger.info(`Video Description:\n ${description}`);
     }
 
     if (program.play) {
-        ytdl.play(quality, options, program.setPlayer);
+        const player = await ytdl.play(quality, options, program.setPlayer);
+        logger.info(`Playing on ${player.player}.`);
     }
 
     if (program.download) {

src/cli.ts

@@ -0,0 +1,35 @@
+/* eslint global-require: "off" */
+/* eslint import/no-extraneous-dependencies: "off" */
+
+import { ReadStream } from 'fs';
+import ffmpeg from 'fluent-ffmpeg';
+
+import Player from './player';
+
+export default class AudioPlayer implements Player {
+    url: string;
+
+    stream: ReadStream;
+
+    player: string;
+
+    Speaker: any;
+
+    constructor() {
+        this.url = '';
+        this.player = 'ytdl-mp3';
+
+        this.Speaker = require('speaker');
+    }
+
+    /**
+     * Play video given a url and a stream.
+     * @param url Stream URL
+     * @param stream Media stream
+     */
+    public play(url: string, stream: ReadStream) {
+        this.url = url;
+        this.stream = stream;
+        ffmpeg(stream).toFormat('s16le').pipe(new this.Speaker());
+    }
+}