README

Supported formats

FLAC (audio/flac)
MP3 (audio/mpeg)
Vorbis in OGG container (audio/ogg)
Opus in OGG container (audio/ogg or audio/opus)
All formats listed for your browser on this table

Note: it might be unable to play some particular files.

Note: sometimes it might be unable to play all FLAC and MP3 files (especially in Firefox), in this case restarting the browser may help.

Detail

This app utilizes 2 backend players: Aurora.js and SoundManager2.

SoundManager2 utilizes the browser's built-in codec. Aurora.js uses Javascript and HTML5 Audio API to decode and play music, and it doesn't use the browser's built-in codec.

This app choose SoundManager2 if the browser has a suitable codec available and Aurora.js otherwise. In practice, SoundManager is used for OGG files, Aurora.js for FLAC files, and playback backend for MP3 files varies by the browser.

Usage hints

Commands

Following commands are available(see script occ in your ownCloud root folder):

Scan music files

./occ music:scan USERNAME1 USERNAME2 ...

This scans all not scanned music files of the user USERNAME and saves the extracted metadata into the music tables in the database. This is also done if you browse the music app web interface. There the scan is done in steps of 20 tracks and the current state is visible at the bottom of the interface.

./occ music:scan --all

This scans music files for all users.

Both of the above commands can be combined with the --debug switch, which enables debug output and shows the memory usage of each scan step.

Reset scanned metadata

Warning: This command will delete data! It will remove unavailable tracks from playlists as playlists are linked against the track metadata.

./occ music:reset-database USERNAME1 USERNAME2 ...

This will reset the scanned metadata of the provided users.

./occ music:reset-database --all

This will reset the scanned metadata of all users.

Ampache

In the settings the URL you need for Ampache is listed and looks like this:

https://cloud.domain.org/index.php/apps/music/ampache/

This is the common path. Some clients append the last part (server/xml.server.php) automatically. If you have connection problems try the longer version of the URL with the server/xml.server.php appended.

Authentication

To use Ampache you can't use your ownCloud password. Instead, you need to generate APIKEY for Ampache. Go to "Your username" → "Personal", and check section Music/Ampache, where you can generate your key. Enter your ownCloud username and the generated key as password to your client.

You may use the /settings/userkey/generate endpoint to programatically generate a random password. The endpoint expects two parameters, length (optional) and description (mandatory) and returns a JSON response. Please note that the minimum password length is 10 characters. The HTTP return codes represent also the status of the request.

POST /settings/userkey/generate

Parameters:

{
	"length": <length>,
	"description": <description>
}

Response (success):

HTTP/1.1 201 Created

{
	"id": <userkey_id>,
	"password": <random_password>,
	"description": <description>
}

Response (error - no description provided):

HTTP/1.1 400 Bad request

{
	"message": "Please provide a description"
}

Response (error - error while saving password):

HTTP/1.1 500 Internal Server Error

{
	"message": "Error while saving the credentials"
}

Installation

Music App can be installed using the App Management in ownCloud. Instructions can be found here.

Known issues

Huge music collections

The current version doesn't scale well for huge music collections. There are plans for a kind of paginated version, which hides the pagination and should be useable as known before. #78

Application can not be activated because of illegal code

The current music app can't be installed and ownCloud prints following error message: "Application can not be activated because of illegal code". This is due to the appcodechecker in core (which is kind of broken), but you can do the installation if the appcodechecker is deactivated:

set appcodechecker to false in config.php (see the config.sample.php )
now you can install the app
afterwards re-enable the appcodechecker

Development

L10n hints

Sometimes translatable strings aren't detected. Try to move the translate attribute more to the beginning of the HTML element.

Build frontend bundle

All the frontend javascript sources of the Music app, excluding the vendor libraries, are bundled into a single file for deployment. The bundle file is js/public/app.js. Generating it requires make and npm utilities, and happens by running:

cd build
make

Build appstore package

git archive HEAD --format=zip --prefix=music/ > build/music.zip

Install test dependencies

composer install

Run tests

PHP unit tests

phpunit --coverage-html coverage-html-unit --configuration tests/php/unit/phpunit.xml tests/php/unit

PHP integration tests

cd ../..          # owncloud core
./occ maintenance:install --admin-user admin --admin-pass admin --database sqlite
./occ app:enable music
cd apps/music
phpunit --coverage-html coverage-html-integration --configuration tests/php/integration/phpunit.xml tests/php/integration

Behat acceptance tests

cd tests
cp behat.yml.dist behat.yml
# add credentials for Ampache API to behat.yml
../vendor/bin/behat

For the acceptance tests you need to upload all tracks of the following 3 artists:

3rdparty libs

update JavaScript libraries

cd js
bower update

API

The music app implements the Shiva API except the resources /artists/<int:artist_id>/shows, /tracks/<int:track_id>/lyrics and the meta resources. You can use this API under https://own.cloud.example.org/index.php/apps/music/api/.

Beside those mentioned resources following additional resources are implemented:

/api/log
/api/collection
/api/file/{fileId}
/api/scan
Playlist API at /api/playlist/
Settings API at /api/settings
Ampache API at /ampache/server/xml.server.php

`/api/log`

Allows to log a message to ownCloud defined log system.

POST /api/log