AcousticBrainz Plugin
=====================

The ``acousticbrainz`` plugin gets acoustic-analysis information from the
AcousticBrainz_ project. This plugin is now deprecated since the AcousicBrainz
project has been shut down.

As an alternative the beets-xtractor_ plugin can be used.

.. _acousticbrainz: https://acousticbrainz.org/

.. _beets-xtractor: https://github.com/adamjakab/BeetsPluginXtractor

Enable the ``acousticbrainz`` plugin in your configuration (see
:ref:`using-plugins`) and run it by typing:

::

    $ beet acousticbrainz [-f] [QUERY]

By default, the command will only look for AcousticBrainz data when the tracks
doesn't already have it; the ``-f`` or ``--force`` switch makes it re-download
data even when it already exists. If you specify a query, only matching tracks
will be processed; otherwise, the command processes every track in your library.

For all tracks with a MusicBrainz recording ID, the plugin currently sets these
fields:

- ``average_loudness``
- ``bpm``
- ``chords_changes_rate``
- ``chords_key``
- ``chords_number_rate``
- ``chords_scale``
- ``danceable``
- ``gender``
- ``genre_rosamerica``
- ``initial_key`` (This is a built-in beets field, which can also be provided by
  :doc:`/plugins/keyfinder`.)
- ``key_strength``
- ``mood_acoustic``
- ``mood_aggressive``
- ``mood_electronic``
- ``mood_happy``
- ``mood_party``
- ``mood_relaxed``
- ``mood_sad``
- ``moods_mirex``
- ``rhythm``
- ``timbre``
- ``tonal``
- ``voice_instrumental``

Warning
-------

The AcousticBrainz project has shut down. To use this plugin you must set the
``base_url`` configuration option to a server offering the AcousticBrainz API.

Automatic Tagging
-----------------

To automatically tag files using AcousticBrainz data during import, just enable
the ``acousticbrainz`` plugin (see :ref:`using-plugins`). When importing new
files, beets will query the AcousticBrainz API using MBID and set the
appropriate metadata.

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

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

- **auto**: Enable AcousticBrainz during ``beet import``. Default: ``yes``.
- **force**: Download AcousticBrainz data even for tracks that already have it.
  Default: ``no``.
- **tags**: Which tags from the list above to set on your files. Default: []
  (all).
- **base_url**: The base URL of the AcousticBrainz server. The plugin has no
  function if this option is not set. Default: None