Remove echonest_tempo (fix #1119)

This commit is contained in:
Adrian Sampson 2014-11-30 12:03:28 -08:00
parent 92fa8711bf
commit 5d37f9a2f0
4 changed files with 3 additions and 158 deletions

View file

@ -65,7 +65,7 @@ shockingly simple if you know a little Python.
.. _acoustic fingerprints:
http://beets.readthedocs.org/page/plugins/chroma.html
.. _ReplayGain: http://beets.readthedocs.org/page/plugins/replaygain.html
.. _tempos: http://beets.readthedocs.org/page/plugins/echonest_tempo.html
.. _tempos: http://beets.readthedocs.org/page/plugins/echonest.html
.. _genres: http://beets.readthedocs.org/page/plugins/lastgenre.html
.. _album art: http://beets.readthedocs.org/page/plugins/fetchart.html
.. _lyrics: http://beets.readthedocs.org/page/plugins/lyrics.html

View file

@ -1,156 +0,0 @@
# This file is part of beets.
# Copyright 2013, David Brenner <david.a.brenner gmail>
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be
# included in all copies or substantial portions of the Software.
"""Gets tempo (bpm) for imported music from the EchoNest API. Requires
the pyechonest library (https://github.com/echonest/pyechonest).
"""
import time
import logging
from beets.plugins import BeetsPlugin
from beets import ui
from beets import config
import pyechonest.config
import pyechonest.song
import socket
# Global logger.
log = logging.getLogger('beets')
RETRY_INTERVAL = 10 # Seconds.
RETRIES = 10
def fetch_item_tempo(lib, loglevel, item, write):
"""Fetch and store tempo for a single item. If ``write``, then the
tempo will also be written to the file itself in the bpm field. The
``loglevel`` parameter controls the visibility of the function's
status log messages.
"""
# Skip if the item already has the tempo field.
if item.bpm:
log.log(loglevel, u'bpm already present: {0} - {1}'
.format(item.artist, item.title))
return
# Fetch tempo.
tempo = get_tempo(item.artist, item.title, item.length)
if not tempo:
log.log(loglevel, u'tempo not found: {0} - {1}'
.format(item.artist, item.title))
return
log.log(loglevel, u'fetched tempo: {0} - {1}'
.format(item.artist, item.title))
item.bpm = int(tempo)
if write:
item.try_write()
item.store()
def get_tempo(artist, title, duration):
"""Get the tempo for a song."""
# We must have sufficient metadata for the lookup. Otherwise the API
# will just complain.
artist = artist.replace(u'\n', u' ').strip().lower()
title = title.replace(u'\n', u' ').strip().lower()
if not artist or not title:
return None
for i in range(RETRIES):
try:
# Unfortunately, all we can do is search by artist and title.
# EchoNest supports foreign ids from MusicBrainz, but currently
# only for artists, not individual tracks/recordings.
results = pyechonest.song.search(
artist=artist, title=title, results=100,
buckets=['audio_summary']
)
except pyechonest.util.EchoNestAPIError as e:
if e.code == 3:
# Wait and try again.
time.sleep(RETRY_INTERVAL)
else:
log.warn(u'echonest_tempo: {0}'.format(e.args[0][0]))
return None
except (pyechonest.util.EchoNestIOError, socket.error) as e:
log.debug(u'echonest_tempo: IO error: {0}'.format(e))
time.sleep(RETRY_INTERVAL)
else:
break
else:
# If we exited the loop without breaking, then we used up all
# our allotted retries.
log.debug(u'echonest_tempo: exceeded retries')
return None
# The Echo Nest API can return songs that are not perfect matches.
# So we look through the results for songs that have the right
# artist and title. The API also doesn't have MusicBrainz track IDs;
# otherwise we could use those for a more robust match.
min_distance = duration
pick = None
for result in results:
if result.artist_name.lower() == artist and \
result.title.lower() == title:
distance = abs(duration - result.audio_summary['duration'])
log.debug(
u'echonest_tempo: candidate {0:2.2f} '
u'(distance: {1:2.2f}) = {2}'.format(
result.audio_summary['duration'],
distance,
result.audio_summary['tempo'],
)
)
if distance < min_distance:
min_distance = distance
pick = result.audio_summary['tempo']
return pick
class EchoNestTempoPlugin(BeetsPlugin):
def __init__(self):
super(EchoNestTempoPlugin, self).__init__()
self.import_stages = [self.imported]
self.config.add({
'apikey': u'NY2KTZHQ0QDSHBAP6',
'auto': True,
})
pyechonest.config.ECHO_NEST_API_KEY = \
self.config['apikey'].get(unicode)
def commands(self):
cmd = ui.Subcommand('tempo', help='fetch song tempo (bpm)')
cmd.parser.add_option('-p', '--print', dest='printbpm',
action='store_true', default=False,
help='print tempo (bpm) to console')
def func(lib, opts, args):
# The "write to files" option corresponds to the
# import_write config value.
write = config['import']['write'].get(bool)
for item in lib.items(ui.decargs(args)):
fetch_item_tempo(lib, logging.INFO, item, write)
if opts.printbpm and item.bpm:
ui.print_('{0} BPM'.format(item.bpm))
cmd.func = func
return [cmd]
# Auto-fetch tempo on import.
def imported(self, config, task):
if self.config['auto']:
for item in task.imported_items():
fetch_item_tempo(config.lib, logging.DEBUG, item, False)

View file

@ -20,6 +20,8 @@ Fixed:
* When deleting fields with the :ref:`modify-cmd` command, do not crash when
the field cannot be removed (i.e., when it does not exist, when it is a
built-in field, or when it is a computed field). :bug:`1124`
* The deprecated ``echonest_tempo`` plugin has been removed. Please use the
:doc:`/plugins/echonest` instead.
.. _Plex: https://plex.tv/

View file

@ -101,7 +101,6 @@ setup(
'chroma': ['pyacoustid'],
'discogs': ['discogs-client>=2.0.0'],
'echonest': ['pyechonest'],
'echonest_tempo': ['pyechonest'],
'lastgenre': ['pylast'],
'mpdstats': ['python-mpd'],
'web': ['flask'],