Skip to content

Latest commit

 

History

History
executable file
·
52 lines (33 loc) · 3.18 KB

README.md

File metadata and controls

executable file
·
52 lines (33 loc) · 3.18 KB
Raw

libkeyfinder

build

libkeyfinder is a small C++11 library for estimating the musical key of digital audio. It is published under the GNU General Public License version 3 or later.

The library was written by Ibrahim Shaath in 2011 as part of a master's project in computer science, "Estimations of key in digital music recordings", and originally hosted in this repo.

A GUI application to use it is available for macOS and Windows. This app is no longer maintained, however, and does not build on contemporary Linux distributions.

In 2020, Ibrahim handed over maintenance of libkeyfinder to the Mixxx DJ software team who incorporated it into Mixxx as of Mixxx 2.3. If you want to discuss anything related to libkeyfinder with us, please get in touch on the Mixxx Zulip chat. Contributions are welcome by opening pull requests and issues on GitHub.

Installation

First, you will need to install FFTW3:

  • Fedora: $ sudo dnf install cmake fftw-devel catch2-devel
  • Debian & Ubuntu: $ sudo apt install cmake libfftw3-dev
  • Arch Linux: $ sudo pacman -S cmake fftw catch2
  • MacOS (via Homebrew): $ brew install cmake fftw catch2
  • Windows: > vcpkg install fftw3 catch2

Catch2 is required for building the tests. It is not available in Debian 10 or Ubuntu 20.04 LTS, although it is available in Ubuntu 20.10 and Debian 11 testing. If catch2 is not found, it will be automatically downloaded by CMake. Alternatively, it's possible disable building the unit tests by passing -DBUILD_TESTING=OFF to CMake.

Once dependencies are installed, from the top level folder of this libkeyfinder repository:

$ cmake -DCMAKE_INSTALL_PREFIX=/where/you/want/to/install/to -S . -B build
$ cmake --build build --parallel number-of-cpu-cores
$ cmake --install build

If you want to build libkeyfinder statically, add -DBUILD_SHARED_LIBS=OFF to the first call to cmake above.

On MacOS, a typical location to install to is /usr/local and you can check the number of CPU cores by running $ sysctl -n hw.logicalcpu.

Testing

The tests are built together with the library. Simply run ctest from the build directory:

$ cd build
$ ctest --parallel number-of-cpu-cores

Note that there is a known intermittent failure in the FftAdapterTest/ForwardAndBackward test. Try running the tests a handful of times to determine whether you are hitting the intermittent failure or have introduced a new bug.

Usage

Refer to the documentation.