/jukebox

Remote audio player (on Raspberry Pi)?

Primary LanguageJavaScriptMIT LicenseMIT

Build Status Greenkeeper badge

Remote audio player (on Raspberry Pi)?

⚠️ Caution ⚠️

async/await, Fetch API, ES6 syntax are used in this application. So please use the latest version web browser.
I am checking the operation with the latest version of chrome and firefox.

Configuration

Environment value

Writing each environment variable to .env, it is reflected.

Parameter Default Example Description
JUKEBOX_NO_WEB_UI '' 'yes' If you set the value, startup with no web UI.
JUKEBOX_PORT 8888 3000 If you set the value, startup with the port of the set value.
JUKEBOX_CACHE_TIME 60000 0 Request cache time (mill seconds).
JUKEBOX_SPEAKER_BUFFER_TIME 50 1000 Time to send data for internal buffering of speaker before music playback. This value relates to the response time of music stop and volume change. If noise is heard, increase this value.
JUKEBOX_FORCE_MUTE '' 'yes' If you set yes, true or 1 to the value, the speaker don't sound (even if the volume is changed).

for development

Parameter Default Example Description
DEBUG 'jukebox:server:*' 'jukebox:*,-jukebox:speaker:stream:*' Debugging namespaces. See debug. Supported namespaces can be confirmed by executing find src -name \*.js -exec cat {} \; | grep -E "(require\('debug'\)\()|(Debug\()" | sed -E "s/.*\('(.*)'\).*/\1/"

for E2E tests

Parameter Default Example Description
E2E_WAIT_TIME 5000 1000 The number of milliseconds to wait to check behavior with our eyes and ears. This can be set as a small value in local tests, but care that a too small value causes bugs.
E2E_PRESENT_WAIT_TIME 30000 60000 The maximum number of milliseconds to wait presentation. Please increase this value when the network speed is slow.

Installation

Prerequisites

yarn

This project uses yarn for package management and task runner.

On Debian/Ubuntu:

$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
$ sudo apt-get update && sudo apt-get install yarn

for speaker package

speaker package requires alsa.h header file.

On Debian/Ubuntu:

$ sudo apt-get install libasound2-dev

for fluent-ffmpeg package

fluent-ffmpeg package requires ffmpeg command.

On Debian/Ubuntu:

$ sudo apt-get install ffmpeg

for Users

First, comment in <script src="https://unpkg.com/vue/dist/vue.min.js"></script> in assets/index.html.
Next, comment out <script src="https://unpkg.com/vue"></script> in the same file.

$ export NODE_ENV=production
$ yarn install
$ yarn start

Let's access to http://localhost:8888

for Developers

$ yarn install
$ yarn run dev // start nodemon

Let's access to http://localhost:8888

Currently supported providers

Support for other providers will come later.

Contributing

Submitting a Pull Request

  1. Fork it
  2. Create a branch (git checkout -b my-fix)
  3. Commit your changes (git commit -am "fix something")
  4. Push to the branch (git push origin my-fix)
  5. Open a Pull Request
  6. Have a coffee break and wait

API

Player

Play audio

POST /player/start

curl command example

$ curl -X POST http://localhost:8888/player/start

Stop playing audio

POST /player/stop

curl command example

$ curl -X POST http://localhost:8888/player/stop

Play next audio

POST /player/next

curl command example

$ curl -X POST http://localhost:8888/player/next

Play previous audio

POST /player/prev

curl command example

$ curl -X POST http://localhost:8888/player/prev

Start one audio loop

POST /player/loop/one/on

curl command example

$ curl -X POST http://localhost:8888/player/loop/one/on

Stop one audio loop

POST /player/loop/one/off

curl command example

$ curl -X POST http://localhost:8888/player/loop/one/off

Start audio loop in the playlist

POST /player/loop/playlist/on

curl command example

$ curl -X POST http://localhost:8888/player/loop/playlist/on

Stop audio loop in the playlist

POST /player/loop/playlist/off

curl command example

$ curl -X POST http://localhost:8888/player/loop/playlist/off

Get information of the player and the playlist

GET /player/status

Response Body

An object of information of the player status and the playlist links.

example
{
  "one_loop": false,
  "playlist_loop": false,
  "now_playing": false,
  "now_playing_idx": 0,
  "now_playing_content": null,
  "playlist": [
    {
      "provider": "youtube",
      "link": "https://youtu.be/1m53lVsc2As",
      "length_seconds": "275",
      "id": "1m53lVsc2As",
      "title": "\"Beautiful Flight\" / performed by H ZETTRIO 【Official MV】",
      "thumbnail_link": "http://i.ytimg.com/vi/1m53lVsc2As/maxresdefault.jpg"
    },
    {
      "provider": "youtube",
      "link": "https://www.youtube.com/watch?v=gjDrEdEzfQc",
      "length_seconds": "330",
      "id": "gjDrEdEzfQc",
      "title": "bohemianvoodoo \"Adria Blue\" 【Music Video】",
      "thumbnail_link": "http://i.ytimg.com/vi/gjDrEdEzfQc/maxresdefault.jpg"
    }
  ]
}

curl command example

$ curl -X GET http://localhost:8888/player/status

Playlist

Add audio links to the playlist

POST /playlist

Request Body

An array of audio links that you want to add to the playlist.

example
[
  "https://youtu.be/id1",
  "https://youtu.be/id2",
  "https://youtu.be/id3"
]

Response Body

An array of unavailable links and error messages.

example
[
  {
    "link": "https://youtu.be/id1",
    "err_msg": "This link belongs to an unsupported provider"
  },
  {
    "link": "https://youtu.be/id2",
    "err_msg": "This 'provider name' link can not be played at the moment"
  }
]

curl command example

$ curl -H "content-type:application/json" -X POST -d '["https://youtu.be/1m53lVsc2As","https://www.youtube.com/watch?v=gjDrEdEzfQc"]' http://localhost:8888/playlist

Delete all audio links of the playlist

DELETE /playlist

curl command example

$ curl -X DELETE http://localhost:8888/playlist

Event stream from Websocket

A response of /player/status is delivered when some event(e.g. audio play started) occurs.

Get connection to websocket

GET /socket