File: autobpm.rst

package info (click to toggle)
beets 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,016 kB
  • sloc: python: 46,429; javascript: 8,018; xml: 334; sh: 261; makefile: 125
file content (40 lines) | stat: -rw-r--r-- 1,227 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
AutoBPM Plugin
==============

The ``autobpm`` plugin uses the Librosa_ library to calculate the BPM of a track
from its audio data and store it in the ``bpm`` field of your database. It does
so automatically when importing music or through the ``beet autobpm [QUERY]``
command.

Install
-------

To use the ``autobpm`` plugin, first enable it in your configuration (see
:ref:`using-plugins`). Then, install ``beets`` with ``autobpm`` extra

.. code-block:: bash

    pip install "beets[autobpm]"

Configuration
-------------

To configure the plugin, make a ``autobpm:`` section in your configuration file.
The available options are:

- **auto**: Analyze every file on import. Otherwise, you need to use the ``beet
  autobpm`` command explicitly. Default: ``yes``
- **overwrite**: Calculate a BPM even for files that already have a ``bpm``
  value. Default: ``no``.
- **beat_track_kwargs**: Any extra keyword arguments that you would like to
  provide to librosa's beat_track_ function call, for example:

.. code-block:: yaml

    autobpm:
      beat_track_kwargs:
        start_bpm: 160

.. _beat_track: https://librosa.org/doc/latest/generated/librosa.beat.beat_track.html

.. _librosa: https://github.com/librosa/librosa/