Docs/changelog for #866

This commit is contained in:
Adrian Sampson 2014-07-13 22:23:59 -07:00
parent 01edb0de19
commit b7da5df5ee
2 changed files with 6 additions and 5 deletions

View file

@ -12,6 +12,7 @@ New stuff
IFF chunks.
* A new :ref:`required` configuration option for the importer skips matches
that are missing certain data. Thanks to oprietop.
* The new :doc:`/plugins/bpm` lets you manually measure the tempo of a playing song. Thanks to aroquen.
Little improvements and fixes:

View file

@ -1,18 +1,18 @@
BPM Plugin
==========
This ``bpm`` plugin allows to determine the bpm (beats per minute) of a song by recording the user's keystrokes. The rationale is that sometimes the bpm of a song cannot be obtained from the echonest database (via the ``echonest`` plugin) or it is simply plain wrong. Whenever you need to fix the bpm of a song manually, the ``bpm`` plugin comes to the rescue.
This ``bpm`` plugin lets you to get the tempo (beats per minute) of a song by tapping out the beat on your keyboard.
Usage
------
-----
First, enable the plugin ``bpm`` as described in :doc:`/plugins/index`. Then, suppose you want to set or modify the bpm of ``<song>``, where ``<song>`` is any valid query that matches the song of interest. Start playing it with your favorite media player, fire up a terminal and type::
First, enable the plugin ``bpm`` as described in :doc:`/plugins/index`. Then, play a song you want to measure in your favorite media player and type::
beet bpm <song>
You'll be prompted to press Enter three times to the rhythm. This typically allows to determine the bpm within 5% accuracy.
You'll be prompted to press Enter three times to the rhythm. This typically allows to determine the BPM within 5% accuracy.
The plugin works best if you wrap it in a script that gets the playing song, for instance with ``mpc`` you can do something like::
The plugin works best if you wrap it in a script that gets the playing song. for instance, with ``mpc`` you can do something like::
beet bpm $(mpc |head -1|tr -d "-")