]> kaliko git repositories - mpd-sima.git/blobdiff - sima/mpdclient.py
MPD client: Use tagtypes to control and set tags
[mpd-sima.git] / sima / mpdclient.py
index 9b8df6a18d42e474949d7dc268f55d1fbe698a89..97be9dabf0c3dddbb1e4e9bf8b743896b37c6cb1 100644 (file)
@@ -26,7 +26,7 @@ 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
@@ -92,7 +92,7 @@ def blacklist(artist=False, album=False, track=False):
                 if track and cls.database.get_bl_album(elem, add_not=True):
                     # filter album as well in track mode
                     # (artist have already been)
-                    cls.log.debug('Blacklisted alb. "{0.album}"'.format(elem))
+                    cls.log.debug('Blacklisted alb. "%s"', elem)
                     continue
                 results.append(elem)
             return results
@@ -115,6 +115,10 @@ class MPD(MPDClient):
     """
     needed_cmds = ['status', 'stats', 'add', 'find',
                    'search', 'currentsong', 'ping']
+    needed_mbid_tags = {'Artist', 'Album', 'AlbumArtist',
+                        'Title', 'Track', 'Genre',
+                        'MUSICBRAINZ_ARTISTID', 'MUSICBRAINZ_ALBUMID',
+                        'MUSICBRAINZ_ALBUMARTISTID', 'MUSICBRAINZ_TRACKID'}
     database = None
 
     def __init__(self, daemon):
@@ -176,20 +180,24 @@ class MPD(MPDClient):
                                   'but command "%s" not available' %
                                   (host, cmd))
         # 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')
+        self.tagtypes('clear')
+        for tag in MPD.needed_mbid_tags:
+            self.tagtypes('enable', tag)
+        if self.daemon.config.get('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 #########
 
@@ -251,9 +259,9 @@ class MPD(MPDClient):
             super().__getattr__('add')(payload.file)
         elif isinstance(payload, list):
             self.command_list_ok_begin()
-            for tr in payload:  # TODO: use send command here
+            for tr in payload:
                 self.add(tr)
-            results = client.command_list_end()
+            self.command_list_end()
         else:
             self.log.error('Cannot add %s', payload)
 
@@ -325,7 +333,7 @@ class MPD(MPDClient):
             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_ARTISTID == '{album.artist.mbid}') AND (album == '{album.name_sz}'))"
+            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
             filt = f"((albumartist == '{album.artist!s}') AND (album == '{album.name_sz}'))"
@@ -388,7 +396,7 @@ class MPD(MPDClient):
                               fuzz, artist)
         if found:
             if artist.aliases:
-                self.log.debug('Found: %s', '/'.join(list(artist.names)[:4]))
+                self.log.debug('Found aliases: %s', '/'.join(artist.names))
             return artist
         return None
 
@@ -419,42 +427,49 @@ class MPD(MPDClient):
 
     @blacklist(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_sz:
-            if artist.aliases:
-                self.log.debug('Searching album for aliase: "%s"', name)
-            kwalbart = {'albumartist': name, 'artist': name}
-            # MPD falls back to artist if albumartist is not available
-            for album in self.list('album', f"( albumartist == '{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 album_artists and 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 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 "%s"', artist)
+        if artist.aliases:
+            self.log.debug('Searching album for %s aliases: "%s"',
+                           artist, artist.aliases)
+        for name_sz in artist.names_sz:
+            raw_albums = self.list('album', f"( albumartist == '{name_sz}')")
+            albums = [Album(a, albumartist=artist.name, artist=artist) for a in raw_albums if a]
+        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