How to Host a Music Server (Draft)

This guide explains how to host a music server on Bemuse.

Prerequisites

Mac OS X

• Homebrew
• Node.js
• SoX: brew install sox --with-libvorbis

Prerequisite Check

Run these commands inside the Terminal.

Node.js: You should see the version number:

$ node -v
v0.12.7

SoX: You should see the SoX version:

$ sox --version
sox:      SoX v14.4.1

On some computer it will not display the version number:

sox:      SoX v

Windows

• Node.js
• SoX: Download from http://sourceforge.net/projects/sox/files/sox/
• QuickTime Player or iTunes
• qaac

Installation

Create a directory to store the program files. For example: C:\Bemuse\vendor\bin. Extract files into that folder. Your tree should look like this:

C:
└── Bemuse
    └── vendor
        └── bin
            ├── libflac-8.dll
            ├── libgcc_s_sjlj-1.dll
            ├── libgomp-1.dll
            ├── libid3tag-0.dll
            ├── libogg-0.dll
            ├── libpng16-16.dll
            ├── libsox-3.dll
            ├── libsoxconvolver64.dll
            ├── libsoxr64.dll
            ├── libssp-0.dll
            ├── libvorbis-0.dll
            ├── libvorbisenc-2.dll
            ├── libvorbisfile-3.dll
            ├── libwavpack-1.dll
            ├── libwinpthread-1.dll
            ├── qaac.exe
            ├── refalac.exe
            ├── sox.exe
            ├── wget.exe
            ├── wget.ini
            └── zlib1.dll

Prerequisite Check

Open Powershell (or Command Prompt) and add the PATH variable:

PS> $env:Path += ";C:\Bemuse\vendor\bin"

Node.js: You should see the version number:

PS> node -v
v0.12.0

SoX: You should see the version number:

PS> sox --version
C:\Bemuse\vendor\bin\sox.exe:      SoX v14.4.2

qaac: You should see the help text:

PS> qaac
qaac 2.47
Usage: qaac [options] infiles....

...
...
...

Install Bemuse Tools

Bemuse Tools is a command line application to help you generate files for Bemuse music server. Install it using npm command, which comes with Node.js:

PS> npm install -g bemuse-tools

Installation Check

Run the following command:

PS> bemuse-tools

It should display the version:

This is bemuse-tools v1.1.0-beta.1

  bemuse-tools: Tools for Bemuse

  index [-r] — Index BMS files in current directory
  pack <path> — Packs sounds and BGAs into assets folder
  server <path> — Serves a Bemuse server (no indexing or conversion)

Creating Your Server Folder

Extract your BMS files into a folder. One song per folder. For example:

C:
└── Bemuse
    └── myserver
        ├── song1
        │   ├── song1_N.bms
        │   ├── song1_H.bms
        │   ├── song1_A.bms
        │   ├── bass.wav
        │   └── kick.wav
        └── song2
            ├── song2_N.bms
            ├── song2_H.bms
            ├── song2_A.bms
            ├── go.wav
            ├── back.wav
            ├── to.wav
            ├── your.wav
            └── rave.wav

Creating Bemuse Packages

Normally, a BMS package comes in .rar or .zip format. Inside that package, there are few BMS files and hundreds of sound files.

It's not practical to extract .rar or .zip files in the browser. It's also not practical to download hundreds of small files (very slow).

In Bemuse, keysounds are packed into .bemuse format. They are split into many parts. Each part is about 1.4mb.

Inside Terminal or Powershell, cd to the server folder:

PS> cd C:\Bemuse\myserver

Then invoke bemuse-tools pack with the folder you want to pack:

PS> bemuse-tools pack 'Lapis - SHIKI'
-> Loading audios
-> Loading movies
-> Loading and converting images

-> Converting audio to ogg [better audio performance]
.....................................................................................................
..................................................
-> Converting audio to m4a [for iOS and Safari]
.....................................................................................................
..................................................
-> Writing...
Written m4a.1.550eda0a.bemuse
Written m4a.2.50a08444.bemuse
Written m4a.3.6b0990a9.bemuse
...
Written metadata.json

Now if you look at your song folder, you should see a new folder called assets:

Lapis - SHIKI
├── assets
│   ├── bga.1.e0a51d24.bemuse
│   ├── bga.2.d582293b.bemuse
│   ├── bga.3.28d51957.bemuse
│   │   ...
│   ├── m4a.1.550eda0a.bemuse
│   ├── m4a.2.50a08444.bemuse
│   ├── m4a.3.6b0990a9.bemuse
│   │   ...
│   ├── metadata.json
│   ├── ogg.1.d9bfef56.bemuse
│   ├── ogg.2.2105f7cc.bemuse
│   └── ogg.3.766f65d4.bemuse
│       ...
├── ba11.ogg
├── ba12.ogg
├── ba13.ogg
│   ...
├── lapis5key.bms
├── lapis7keya.bme
├── lapis7keyl.bme
│   ...
├── syn9.ogg
└── synpad.ogg

Creating Index File

Now, the client needs to know what songs are available in the server. You need to create an index file. You can do it by running this command in the server folder:

PS> bemuse-tools index

Absurd Gaff - siromaru       160bpm [schranz] siromaru / BMSSP-Absurd Gaff 3 6 8 10 10 21 [no-meta]
ametsuchi - stereoberry      122bpm [discopunk / shoegazer] stereoberry / BMSSP-ametsuchi 1 3 5 5 8 [no-meta]
atonement you you - unknown  197bpm [NO GENRE] Unknown Artist / BMSSP-atonement you you 4 6 [no-meta]
AVALON - Team.SASAKURATION   200bpm [Ω] Team:SASAKURATION-AVALON 0 5 6 10 10 12 12 [no-me ta]
...

After running, you will see these index.json and index.cache appear in your folder:

myserver
├── AVALON - Team.SASAKURATION
├── Absurd Gaff - siromaru
├── Declinin' - ____(sta)
├── HE is an Energizer - Mr.ABC
├── I'll_forget_you_you'll_never_forget_me - mommy
├── Lapis - SHIKI
│   ...
├── index.cache
└── index.json

Upload

Upload index.json, all *.bemuse and *.bms/bme/bml files to a web server. Make sure the directory layout is the same. Enable cross-origin resource sharing on your web server to allow Bemuse client to connect.

Try It

Go to http://bemuse.ninja/?BEMUSE_MUSIC_SERVER=<your URL>

Example: http://bemuse.ninja/?BEMUSE_MUSIC_SERVER=http://flicknote.bemuse.ninja/bemuse/mumei12