From e2a14985c95237c290bf1e9dd8212c31353b4f73 Mon Sep 17 00:00:00 2001 From: Peter Schnebel Date: Sun, 27 Oct 2013 11:08:42 +0100 Subject: [PATCH] added the echonest plugin --- docs/plugins/echonest.rst | 31 ++++++++++++++++--------------- docs/plugins/echonest_tempo.rst | 4 ++++ 2 files changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/plugins/echonest.rst b/docs/plugins/echonest.rst index 84458e128..dd3fb1689 100644 --- a/docs/plugins/echonest.rst +++ b/docs/plugins/echonest.rst @@ -13,8 +13,12 @@ flexattrs and *not* in the audio file itself. ``tempo`` will be stored in - speechiness - tempo +See `Acoustic Attributes`_ for a detailed description. + .. _EchoNest API: http://developer.echonest.com/ +.. _Acoustic Attributes: http://developer.echonest.com/acoustic-attributes.html + Installing Dependencies ----------------------- @@ -29,22 +33,20 @@ like so:: To transcode music, this plugin requires the `ffmpeg`_ command-line tool. +To get fingerprinting working, you'll need to install the `ENMFP`_ codegen +command-line tool. The ``ENMFP`` codegen binary distribution has executables +for all major OSs and architectures. Please note that fingerprinting is not +required if ``upload`` and ``convert`` is enabled, which is the default. + .. _pip: http://pip.openplans.org/ .. _FFmpeg: http://ffmpeg.org - -To get fingerprinting working, you'll need to install -the `ENMFP `_ codegen -command-line tool. - -You will need to install ``ENMFP``, as a command-line tool. The ``ENMFP`` -codegen binary distribution has executables for all major OSs and -architectures. +.. _ENMFP: http://static.echonest.com/ENMFP_codegen.zip Configuring ----------- Beets includes its own Echo Nest API key, but you can `apply for your own`_ for -free from the EchoNest. To specify your own API key, add the key to your +free from the Echo Nest. To specify your own API key, add the key to your :doc:`configuration file ` as the value for ``apikey`` under the key ``echonest_tempo`` like so:: @@ -57,23 +59,22 @@ fetching during import. To do so, add this to your ``config.yaml``:: echonest: auto: no -The ``echonest`` plugin tries to upload files to the EchoNest server if it can -not be identified by other means. If you don't want that, disable the +The ``echonest`` plugin tries to upload files to the Echo Nest server if it +can not be identified by other means. If you don't want that, disable the ``upload`` config option like so:: echonest: upload: no -The EchoNest server only supports a limited range of file formats. The +The Echo Nest server only supports a limited range of file formats. The ``plugin`` automatically converts unsupported files to ``ogg``. If you don't want that, disable the ``convert`` config option like so:: echonest: convert: no -You can enable fingerprinting by editing your :doc:`configuration file -`. If the ``ENMFP`` binary is not in your path, you'll -need to add a key called ``codegen`` under the ``echonest`` section like so:: +If the ``ENMFP`` binary is not in your path, you'll need to add a key called +``codegen`` under the ``echonest`` section like so:: echonest: codegen: PATH/TO/YOUR/CODEGEN/BINARY diff --git a/docs/plugins/echonest_tempo.rst b/docs/plugins/echonest_tempo.rst index 9fdafa02d..13fbe9339 100644 --- a/docs/plugins/echonest_tempo.rst +++ b/docs/plugins/echonest_tempo.rst @@ -1,10 +1,14 @@ EchoNest Tempo Plugin ===================== +*Note*: A new plugin :doc:`echonest` is available, that in addition to +``tempo`` also fetches `Acoustic Attributes`_ from the EchoNest. + The ``echonest_tempo`` plugin fetches and stores a track's tempo (the "bpm" field) from the `EchoNest API`_ .. _EchoNest API: http://developer.echonest.com/ +.. _Acoustic Attributes: http://developer.echonest.com/acoustic-attributes.html Installing Dependencies -----------------------