Skip to content

Latest commit

 

History

History
64 lines (43 loc) · 2.24 KB

README.md

File metadata and controls

64 lines (43 loc) · 2.24 KB
Raw

Keyfinder Command Line Interface

This small utility is the automation-oriented DJs best friend. By making use of Ibrahim Sha'ath's high quality libKeyFinder library (now maintained by Mixxx DJ), this utility can be used to estimate the musical key of many different audio file formats.

Build Status

Usage and Expected Behavior

Installing this software exposes the keyfinder-cli command on your system.

The most basic usage of this utility is to provide a path to an audio file, it will quickly compute the estimated global music key of the audio file and print it to stdout.

$ keyfinder-cli AMajor.mp3
A

In the case that there is no key (silence) nothing will be printed to stdout and the program will exit with a 0 status code.

Different key notations

Three different key notations are supported and can be toggled:

  1. -n standard for Standard Key Notation

    Keys are outputted using the standard notation. For example, Eb is equivalent to E flat. A is equivalent to A Major. Sharps are not used. This is the default notation mode used to output keys when no other options are specified

  2. -n openkey for Open Key Notation

    Keys are outputted using BeaTunes Open Key notation. Keys like 1m are equivalent to C Major. This is what Traktor uses for it's key notation.

  3. -n camelot for Camelot Key Notation

    Keys are outputted using the Camelot Easymix Wheel notation. Similar to Open Key notation 8B is equivalent to C Major.

Building

You will need to have the following dependencies installed on your machine

As long as these two dependencies are installed then you should be able to simply type:

$ make
$ make install

# Or suffix with PREFIX= to specify the install prefix
$ PREFIX=$HOME/.local make install