https://github.com/evanpurkhiser/keyfinder-cli

A CLI wrapper for libkeyfinder. Making DJs lives easier.
https://github.com/evanpurkhiser/keyfinder-cli

audio automation dj key-notations keyfinder

Last synced: 6 days ago
JSON representation

A CLI wrapper for libkeyfinder. Making DJs lives easier.

• Host: GitHub
• URL: https://github.com/evanpurkhiser/keyfinder-cli
• Owner: evanpurkhiser
• License: gpl-3.0
• Created: 2015-01-02T15:12:33.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-11-05T02:55:53.000Z (about 2 months ago)
• Last Synced: 2024-12-14T16:09:28.845Z (13 days ago)
• Topics: audio, automation, dj, key-notations, keyfinder
• Language: C++
• Homepage:
• Size: 66.4 KB
• Stars: 118
• Watchers: 7
• Forks: 25
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Keyfinder Command Line Interface

This small utility is the automation-oriented DJs best friend. By making use of

[Ibrahim Sha'ath](http://www.ibrahimshaath.co.uk/)'s high quality

[libKeyFinder](https://github.com/mixxxdj/libkeyfinder) library (now maintained

by [Mixxx DJ](https://github.com/mixxxdj)), this utility can be used to

estimate the musical key of many different audio file formats.

[![Build Status](https://github.com/evanpurkhiser/keyfinder-cli/workflows/build/badge.svg)](https://github.com/evanpurkhiser/keyfinder-cli/actions?query=workflow%3Abuild)

### 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.

```sh

$ 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**](https://www.beatunes.com/en/open-key-notation.html)

   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**](http://www.mixedinkey.com/HowTo)

   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

- [ffmpeg](https://www.ffmpeg.org/) (This was not tested with `libav`)

- [libkeyfinder](https://github.com/mixxxdj/libkeyfinder/)

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

```