README

musly-php is a simple PHP wrapper around the musly command-line tool.

Musly is a fast and high-quality audio music similarity library written in C/C++.

-- Musly website

Installation

It is recommended to install musly-php via Composer.

$ composer require iammordaty/musly-php

Requirements

• PHP 8.0
• Musly with the command-line tool

You may also be interested in iammordaty/musly fork, which allows you to calculate the distance between similar tracks (see PR #51 for more information).

Basic usage

use Musly\Musly;

$musly = new Musly();

$musly->initializeCollection();
$musly->analyze('/path/to/dir/or/track.mp3');

$similarTracks = $musly->getSimilarTracks('/path/to/track.mp3');

Advanced usage

use Musly\Collection;
use Musly\Exception\FileNotFoundException;
use Musly\Exception\FileNotFoundInCollectionException;
use Musly\Exception\MuslyProcessFailedException;
use Musly\Musly;

$collection = new Collection([
    'pathname' => '/path/to/collection.musly',
    'similarityMethod' => Collection::SIMILARITY_METHOD_TIMBRE,
    'jukeboxPathname' => '/path/to/collection.jbox',
]);

// ... or
// $collection = new Collection('/path/to/collection.musly');
// $collection->setSimilarityMethod(Collection::SIMILARITY_METHOD_TIMBRE);
// $collection->setJukeboxPathname('/path/to/collection.jbox');

$musly = new Musly([ 'binary' => '/path/to/musly/binary' ]);

try {
    if (!$collection->isInitialized()) {
        $musly->initializeCollection($collection);
    }

    $musly->setCollection($collection);
    $musly->analyze('/path/to/dir/', 'mp3');
    $musly->analyze('/path/to/track.mp3');

    $similarTracks = $musly->getSimilarTracks('/path/to/track.mp3', 20);
    $collectionTracks = $musly->getAllTracks();
}
catch (FileNotFoundException | FileNotFoundInCollectionException $e) {
    // handle exception
}
catch (MuslyProcessFailedException $e) {
    // handle exception
}

See the musly command-line tool help for more information.

Tests

Copy the phpunit.xml.dist file to phpunit.xml, then use PHPUnit to run the tests:

$ ./vendor/bin/phpunit

Further information

• Musly website
• Musly repository
• musly command-line tool usage

License

iammordaty/musly-php is licensed under the MIT License.