mirror of
https://github.com/beetbox/beets.git
synced 2025-12-07 17:16:07 +01:00
c9f59ee38d
* fix broken links * add link check command to tox * add link check to the weekly integration test
67 lines
2.5 KiB
ReStructuredText
67 lines
2.5 KiB
ReStructuredText
AcousticBrainz Submit Plugin
|
|
============================
|
|
|
|
The ``absubmit`` plugin lets you submit acoustic analysis results to the
|
|
`AcousticBrainz`_ server.
|
|
|
|
Installation
|
|
------------
|
|
|
|
The ``absubmit`` plugin requires the `streaming_extractor_music`_ program
|
|
to run. Its source can be found on `GitHub`_, and while it is possible to
|
|
compile the extractor from source, AcousticBrainz would prefer if you used
|
|
their binary (see the AcousticBrainz `FAQ`_).
|
|
|
|
The ``absubmit`` plugin also requires `requests`_, which you can install
|
|
using `pip`_ by typing::
|
|
|
|
pip install requests
|
|
|
|
After installing both the extractor binary and requests you can enable
|
|
the plugin ``absubmit`` in your configuration (see :ref:`using-plugins`).
|
|
|
|
Submitting Data
|
|
---------------
|
|
|
|
Type::
|
|
|
|
beet absubmit [-f] [-d] [QUERY]
|
|
|
|
To run the analysis program and upload its results. 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 refetch
|
|
data even when it already exists. You can use the ``-d`` or ``--dry`` swtich
|
|
to check which files will be analyzed, before you start a longer period
|
|
of processing.
|
|
|
|
The plugin works on music with a MusicBrainz track ID attached. The plugin
|
|
will also skip music that the analysis tool doesn't support.
|
|
`streaming_extractor_music`_ currently supports files with the extensions
|
|
``mp3``, ``ogg``, ``oga``, ``flac``, ``mp4``, ``m4a``, ``m4r``, ``m4b``,
|
|
``m4p``, ``aac``, ``wma``, ``asf``, ``mpc``, ``wv``, ``spx``, ``tta``,
|
|
``3g2``, ``aif``, ``aiff`` and ``ape``.
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
To configure the plugin, make a ``absubmit:`` section in your configuration
|
|
file. The available options are:
|
|
|
|
- **auto**: Analyze every file on import. Otherwise, you need to use the
|
|
``beet absubmit`` command explicitly.
|
|
Default: ``no``
|
|
- **extractor**: The absolute path to the `streaming_extractor_music`_ binary.
|
|
Default: search for the program in your ``$PATH``
|
|
- **force**: Analyze items and submit of AcousticBrainz data even for tracks
|
|
that already have it.
|
|
Default: ``no``.
|
|
- **pretend**: Do not analyze and submit of AcousticBrainz data but print out
|
|
the items which would be processed.
|
|
Default: ``no``.
|
|
|
|
.. _streaming_extractor_music: https://acousticbrainz.org/download
|
|
.. _FAQ: https://acousticbrainz.org/faq
|
|
.. _pip: https://pip.pypa.io
|
|
.. _requests: https://requests.readthedocs.io/en/master/
|
|
.. _github: https://github.com/MTG/essentia
|
|
.. _AcousticBrainz: https://acousticbrainz.org
|