# -*- coding: utf-8 -*-
-# Copyright (c) 2009-2020 kaliko <kaliko@azylum.org>
+# Copyright (c) 2009-2021 kaliko <kaliko@azylum.org>
#
# This file is part of sima
#
from difflib import get_close_matches
from functools import wraps
from itertools import dropwhile
+from logging import getLogger
# external module
from musicpd import MPDClient, MPDError
# local import
-from .lib.meta import Artist, Album
+from .lib.meta import Meta, Artist, Album
from .lib.track import Track
from .lib.simastr import SimaStr
from .utils.leven import levenshtein_ratio
class PlayerError(Exception):
- """Fatal error in poller."""
+ """Fatal error in the player."""
# Some decorators
return func(*args, **kwargs)
result = func(*args, **kwargs)
if not result:
- return
+ return None
names = list()
for art in result.names:
- if cls.database.get_bl_artist(art, add_not=True):
- cls.log.debug('Blacklisted "%s"', art)
+ artist = Artist(name=art, mbid=result.mbid)
+ if cls.database.get_bl_artist(artist, add=False):
+ cls.log.debug('Artist "%s" in blocklist!', artist)
continue
names.append(art)
if not names:
- return
+ return None
resp = Artist(name=names.pop(), mbid=result.mbid)
for name in names:
resp.add_alias(name)
return resp
return wrapper
+
def tracks_wrapper(func):
+ """Convert plain track mapping as returned by MPDClient into :py:obj:Track
+ objects. This decorator accepts single track or list of tracks as input.
+ """
@wraps(func)
def wrapper(*args, **kwargs):
ret = func(*args, **kwargs)
if isinstance(ret, dict):
return Track(**ret)
- elif isinstance(ret, list):
- return [Track(**t) for t in ret]
+ return [Track(**t) for t in ret]
return wrapper
# / decorators
-def blacklist(artist=False, album=False, track=False):
- #pylint: disable=C0111,W0212
+
+def blocklist(album=False, track=False):
+ # pylint: disable=C0111,W0212
field = (album, track)
+
def decorated(func):
def wrapper(*args, **kwargs):
if not args[0].database:
#cls.log.debug('using {0} as bl filter'.format(bl_getter.__name__))
results = list()
for elem in func(*args, **kwargs):
- if bl_getter(elem, add_not=True):
+ if bl_getter(elem, add=False):
#cls.log.debug('Blacklisted "{0}"'.format(elem))
continue
- if track and cls.database.get_bl_album(elem, add_not=True):
+ if track and cls.database.get_bl_album(elem, add=False):
# filter album as well in track mode
# (artist have already been)
- cls.log.debug('Blacklisted alb. "{0.album}"'.format(elem))
+ cls.log.debug('Album "%s" in blocklist', elem)
continue
results.append(elem)
return results
.. note::
- * find methods are looking for exact match of the object provided attributes in MPD music library
+ * find methods are looking for exact match of the object provided
+ attributes in MPD music library
* search methods are looking for exact match + fuzzy match.
"""
needed_cmds = ['status', 'stats', 'add', 'find',
'search', 'currentsong', 'ping']
+ needed_tags = {'Artist', 'Album', 'AlbumArtist', 'Title', 'Track'}
+ needed_mbid_tags = {'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+ 'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
+ MPD_supported_tags = {'Artist', 'ArtistSort', 'Album', 'AlbumSort', 'AlbumArtist',
+ 'AlbumArtistSort', 'Title', 'Track', 'Name', 'Genre',
+ 'Date', 'OriginalDate', 'Composer', 'Performer',
+ 'Conductor', 'Work', 'Grouping', 'Disc', 'Label',
+ 'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+ 'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID',
+ 'MUSICBRAINZ_RELEASETRACKID', 'MUSICBRAINZ_WORKID'}
database = None
- def __init__(self, daemon):
+ def __init__(self, config):
super().__init__()
self.use_mbid = True
- self.daemon = daemon
- self.log = daemon.log
- self.config = self.daemon.config['MPD']
+ self.log = getLogger('sima')
+ self.config = config
self._cache = None
# ######### Overriding MPDClient ###########
def __getattr__(self, cmd):
"""Wrapper around MPDClient calls for abstract overriding"""
- track_wrapped = {
- 'currentsong',
- 'find',
- 'playlistinfo',
- }
+ track_wrapped = {'currentsong', 'find', 'playlistinfo', }
if cmd in track_wrapped:
return tracks_wrapper(super().__getattr__(cmd))
return super().__getattr__(cmd)
def connect(self):
"""Overriding explicitly MPDClient.connect()"""
+ mpd_config = self.config['MPD']
# host, port, password
- host = self.config.get('host')
- port = self.config.get('port')
- password = self.config.get('password', fallback=None)
+ host = mpd_config.get('host')
+ port = mpd_config.get('port')
+ password = mpd_config.get('password', fallback=None)
self.disconnect()
try:
super().connect(host, port)
try:
self.password(password)
except (MPDError, IOError) as err:
- raise PlayerError("Could not connect to '%s': %s", (host, err))
+ raise PlayerError("Could not connect to '%s': %s" % (host, err))
# Controls we have sufficient rights
available_cmd = self.commands()
for cmd in MPD.needed_cmds:
raise PlayerError('Could connect to "%s", '
'but command "%s" not available' %
(host, cmd))
+ self.tagtypes('clear')
+ for tag in MPD.needed_tags:
+ self.tagtypes('enable', tag)
+ tt = set(map(str.lower, self.tagtypes()))
+ needed_tags = set(map(str.lower, MPD.needed_tags))
+ if len(needed_tags & tt) != len(MPD.needed_tags):
+ self.log.warning('MPD exposes: %s', tt)
+ self.log.warning('Tags needed: %s', needed_tags)
+ raise PlayerError('Missing mandatory metadata!')
+ for tag in MPD.needed_mbid_tags:
+ self.tagtypes('enable', tag)
# Controls use of MusicBrainzIdentifier
- # TODO: Use config instead of Artist object attibute?
- if self.use_mbid:
- tt = self.tagtypes()
- if 'MUSICBRAINZ_ARTISTID' not in tt:
- self.log.warning('Use of MusicBrainzIdentifier is set but MPD is '
- 'not providing related metadata')
+ if self.config.getboolean('sima', 'musicbrainzid'):
+ tt = set(self.tagtypes())
+ if len(MPD.needed_mbid_tags & tt) != len(MPD.needed_mbid_tags):
+ self.log.warning('Use of MusicBrainzIdentifier is set but MPD '
+ 'is not providing related metadata')
self.log.info(tt)
self.log.warning('Disabling MusicBrainzIdentifier')
- self.use_mbid = False
+ self.use_mbid = Meta.use_mbid = False
else:
- self.log.debug('Available metadata: %s', tt) # pylint: disable=no-member
+ self.log.debug('Available metadata: %s', tt)
+ self.use_mbid = Meta.use_mbid = True
else:
self.log.warning('Use of MusicBrainzIdentifier disabled!')
self.log.info('Consider using MusicBrainzIdentifier for your music library')
+ self.use_mbid = Meta.use_mbid = False
self._reset_cache()
# ######### / Overriding MPDClient #########
def _reset_cache(self):
"""
Both flushes and instantiates _cache
+
+ * artists: all artists
+ * nombid_artists: artists with no mbid (set only when self.use_mbid is True)
+ * artist_tracks: caching last artist tracks, used in search_track
"""
if isinstance(self._cache, dict):
self.log.info('Player: Flushing cache!')
else:
self.log.info('Player: Initialising cache!')
self._cache = {'artists': frozenset(),
- 'nombid_artists': frozenset()}
+ 'nombid_artists': frozenset(),
+ 'artist_tracks': {}}
self._cache['artists'] = frozenset(filter(None, self.list('artist')))
- if Artist.use_mbid:
- self._cache['nombid_artists'] = frozenset(filter(None, self.list('artist', 'musicbrainz_artistid', '')))
+ if self.use_mbid:
+ artists = self.list('artist', "(MUSICBRAINZ_ARTISTID == '')")
+ self._cache['nombid_artists'] = frozenset(filter(None, artists))
def _skipped_track(self, previous):
if (self.state == 'stop'
return self.current.id != previous.id # pylint: disable=no-member
def monitor(self):
- """OLD socket Idler
- Monitor player for change
+ """Monitor player for change
Returns a list a events among:
* database player media library has changed
self.log.warning('pending commands: %s', self._pending)
def add(self, payload):
- """Overriding MPD's add method to accept Track objects"""
+ """Overriding MPD's add method to accept Track objects
+
+ :param Track,list payload: Either a single :py:obj:`Track` or a list of it
+ """
if isinstance(payload, Track):
super().__getattr__('add')(payload.file)
elif isinstance(payload, list):
self.command_list_ok_begin()
- for tr in payload: # TODO: use send command here
- self.add(tr)
- results = client.command_list_end()
+ map(self.add, payload)
+ self.command_list_end()
else:
self.log.error('Cannot add %s', payload)
"""
if isinstance(what, Artist):
return self._find_art(what)
- elif isinstance(what, Album):
+ if isinstance(what, Album):
return self._find_alb(what)
- elif isinstance(what, str):
+ if isinstance(what, str):
return self.find_tracks(Artist(name=what))
+ raise PlayerError('Bad input argument')
def _find_art(self, artist):
tracks = set()
return list(tracks)
def _find_alb(self, album):
+ if not hasattr(album, 'artist'):
+ raise PlayerError('Album object have no artist attribute')
albums = []
if self.use_mbid and album.mbid:
- filt = f'(MUSICBRAINZ_ALBUMID == {album.mbid})'
+ filt = f"(MUSICBRAINZ_ALBUMID == '{album.mbid}')"
albums = self.find(filt)
# Now look for album with no MusicBrainzIdentifier
if not albums and album.artist.mbid and self.use_mbid: # Use album artist MBID if possible
- filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album!s}'))"
- albums = self.find(filt)
- if not albums: # Falls back to albumartist/album name
- filt = f"((albumartist == '{album.artist!s}') AND (album == '{album!s}'))"
- albums = self.find(filt)
- if not albums: # Falls back to artist/album name
- filt = f"((artist == '{album.artist!s}') AND (album == '{album!s}'))"
+ filt = f"((MUSICBRAINZ_ALBUMARTISTID == '{album.artist.mbid}') AND (album == '{album.name_sz}'))"
albums = self.find(filt)
+ if not albums: # Falls back to (album)?artist/album name
+ for artist in album.artist.names_sz:
+ filt = f"((albumartist == '{artist}') AND (album == '{album.name_sz}'))"
+ albums.extend(self.find(filt))
return albums
# #### / find_tracks ##
"""
Search artists based on a fuzzy search in the media library
>>> art = Artist(name='the beatles', mbid=<UUID4>) # mbid optional
- >>> bea = player.search_artist(art)c
+ >>> bea = player.search_artist(art)
>>> print(bea.names)
>>> ['The Beatles', 'Beatles', 'the beatles']
+ :param Artist artist: Artist to look for in MPD music library
+
Returns an Artist object
"""
- self.log.trace('Looking for "%r" in library', artist)
found = False
if self.use_mbid and artist.mbid:
# look for exact search w/ musicbrainz_artistid
- exact_m = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")
- if exact_m:
+ library = self.list('artist', f"(MUSICBRAINZ_ARTISTID == '{artist.mbid}')")
+ if library:
found = True
- # Looking for "Esthero" adds "DJ Krush feat. Esthero" to aliases
- # This seems wrong, disables it for now
- #_ = [artist.add_alias(name) for name in exact_m]
- # then complete with fuzzy search on artist with no musicbrainz_artistid
- if artist.mbid:
- # we already performed a lookup on artists with mbid set
- # search through remaining artists
- artists = self._cache.get('nombid_artists')
- else:
- artists = self._cache.get('artists')
+ self.log.trace('Found mbid "%r" in library', artist)
+ # library could fetch several artist name for a single MUSICBRAINZ_ARTISTID
+ if len(library) > 1:
+ self.log.debug('I got "%s" searching for %r', library, artist)
+ elif len(library) == 1 and library[0] != artist.name:
+ new_alias = artist.name
+ self.log.info('Update artist name %s->%s', artist, library[0])
+ self.log.debug('Also add alias for %s: %s', artist, new_alias)
+ artist = Artist(name=library[0], mbid=artist.mbid)
+ artist.add_alias(new_alias)
+ # Fetches remaining artists for potential match
+ artists = self._cache['nombid_artists']
+ else: # not using MusicBrainzIDs
+ artists = self._cache['artists']
match = get_close_matches(artist.name, artists, 50, 0.73)
if not match and not found:
return None
if len(match) > 1:
- self.log.debug('found close match for "%s": %s', artist, '/'.join(match))
+ self.log.debug('found close match for "%s": %s',
+ artist, '/'.join(match))
+ # First lowercased comparison
+ for close_art in match:
+ # Regular lowered string comparison
+ if artist.name.lower() == close_art.lower():
+ artist.add_alias(close_art)
+ found = True
+ if artist.name != close_art:
+ self.log.debug('"%s" matches "%s".', close_art, artist)
# Does not perform fuzzy matching on short and single word strings
# Only lowercased comparison
if ' ' not in artist.name and len(artist.name) < 8:
- for close_art in match:
- # Regular lowered string comparison
- if artist.name.lower() == close_art.lower():
- artist.add_alias(close_art)
- return artist
- else:
- return None
- for fuzz_art in match:
- # Regular lowered string comparison
- if artist.name.lower() == fuzz_art.lower():
- found = True
- artist.add_alias(fuzz_art)
- if artist.name != fuzz_art:
- self.log.debug('"%s" matches "%s".', fuzz_art, artist)
+ self.log.trace('no fuzzy matching for %r', artist)
+ if found:
+ return artist
+ return None
+ # Now perform fuzzy search
+ for fuzz in match:
+ if fuzz in artist.names: # Already found in lower cased comparison
continue
# SimaStr string __eq__ (not regular string comparison here)
- if SimaStr(artist.name) == fuzz_art:
+ if SimaStr(artist.name) == fuzz:
found = True
- artist.add_alias(fuzz_art)
- self.log.info('"%s" quite probably matches "%s" (SimaStr)',
- fuzz_art, artist)
+ artist.add_alias(fuzz)
+ self.log.debug('"%s" quite probably matches "%s" (SimaStr)',
+ fuzz, artist)
if found:
if artist.aliases:
- self.log.debug('Found: %s', '/'.join(list(artist.names)[:4]))
+ self.log.info('Found aliases: %s', '/'.join(artist.names))
return artist
+ return None
- @blacklist(track=True)
+ @blocklist(track=True)
def search_track(self, artist, title):
"""Fuzzy search of title by an artist
"""
+ cache = self._cache.get('artist_tracks').get(artist)
# Retrieve all tracks from artist
- all_tracks = self.find_tracks(artist)
+ all_tracks = cache or self.find_tracks(artist)
+ if not cache:
+ self._cache['artist_tracks'] = {} # clean up
+ self._cache.get('artist_tracks')[artist] = all_tracks
# Get all titles (filter missing titles set to 'None')
all_artist_titles = frozenset([tr.title for tr in all_tracks
if tr.title is not None])
match = get_close_matches(title, all_artist_titles, 50, 0.78)
+ tracks = []
if not match:
return []
for mtitle in match:
- leven = levenshtein_ratio(title.lower(), mtitle.lower())
+ leven = levenshtein_ratio(title, mtitle)
if leven == 1:
- pass
- elif leven >= 0.79: # PARAM
+ tracks.extend([t for t in all_tracks if t.title == mtitle])
+ elif leven >= 0.77:
self.log.debug('title: "%s" should match "%s" (lr=%1.3f)',
mtitle, title, leven)
+ tracks.extend([t for t in all_tracks if t.title == mtitle])
else:
self.log.debug('title: "%s" does not match "%s" (lr=%1.3f)',
mtitle, title, leven)
- return []
- return self.find('artist', artist, 'title', mtitle)
+ return tracks
- @blacklist(album=True)
+ @blocklist(album=True)
def search_albums(self, artist):
- """
- Fetch all albums for "AlbumArtist" == artist
- Then look for albums for "artist" == artist and try to filters
- multi-artists albums
+ """Find potential albums for "artist"
- NB: Running "client.list('album', 'artist', name)" MPD returns any album
- containing at least a track with "artist" == name
- TODO: Use MusicBrainzID here cf. #30 @gitlab
+ * Fetch all albums for "AlbumArtist" == artist
+ → falls back to "Artist" == artist when no "AlbumArtist" tag is set
+ * Tries to filter some mutli-artists album
+ For instance an album by Artist_A may have a track by Artist_B. Then
+ looking for albums for Artist_B returns wrongly this album.
"""
- albums = []
- for name in artist.names:
- if artist.aliases:
- self.log.debug('Searching album for aliase: "%s"', name)
- kwalbart = {'albumartist': name, 'artist': name}
- for album in self.list('album', 'albumartist', name):
- if album and album not in albums:
- albums.append(Album(name=album, **kwalbart))
- for album in self.list('album', 'artist', name):
- if not album: # list can return "" as an album
- continue
- album_trks = self.find_tracks(Album(name=album, artist=Artist(name=name)))
- album_artists = [tr.albumartist for tr in album_trks if tr.albumartist]
- if 'Various Artists' in [tr.albumartist for tr in album_trks]:
- self.log.debug('Discarding %s ("Various Artists" set)', album)
- continue
- if name not in album_artists:
- self.log.debug('Discarding "%s", "%s" not set as albumartist', album, name)
- continue
- arts = {trk.artist for trk in album_trks}
- # Avoid selecting album where artist is credited for a single
- # track of the album
- if len(set(arts)) < 2: # TODO: better heuristic, use a ratio instead
- if album not in albums:
- albums.append(Album(name=album, **kwalbart))
- elif album and album not in albums:
- self.log.debug('"{0}" probably not an album of "{1}"'.format(
- album, artist) + '({0})'.format('/'.join(arts)))
- return albums
+ # First, look for all potential albums
+ self.log.debug('Searching album for "%r"', artist)
+ if artist.aliases:
+ self.log.debug('Searching album for %s aliases: "%s"',
+ artist, artist.aliases)
+ for name_sz in artist.names_sz:
+ mpd_filter = f"((albumartist == '{name_sz}') AND ( album != ''))"
+ raw_albums = self.list('album', mpd_filter)
+ albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums]
+ candidates = []
+ for album in albums:
+ album_trks = self.find_tracks(album)
+ album_artists = {tr.albumartist for tr in album_trks if tr.albumartist}
+ if album.artist.names & album_artists:
+ candidates.append(album)
+ continue
+ if 'Various Artists' in album_artists:
+ self.log.debug('Discarding %s ("Various Artists" set)', album)
+ continue
+ if album_artists and album.artist.name not in album_artists:
+ self.log.debug('Discarding "%s", "%s" not set as albumartist', album, album.artist)
+ continue
+ # Attempt to detect false positive
+ # Avoid selecting albums where artist is credited for a single
+ # track of the album
+ album_trks = self.find(f"(album == '{album.name_sz}')")
+ arts = [trk.artist for trk in album_trks] # Artists in the album
+ # count artist occurences
+ ratio = arts.count(album.artist.name)/len(arts)
+ if ratio >= 0.8:
+ candidates.append(album)
+ else:
+ self.log.debug('"%s" probably not an album of "%s" (ratio=%.2f)',
+ album, artist, ratio)
+ continue
+ return candidates
# #### / Search Methods ###
# VIM MODLINE
home / dev / repositories / mpd-sima.git / blobdiff