X-Git-Url: https://git.kaliko.me/?a=blobdiff_plain;f=sima%2Flib%2Fplugin.py;h=83c28b5fda38ad642df9ea4251de48a664e30f2e;hb=d0232dae194becb33696266083df400a54afbd27;hp=0d6583e921176c0a42a0956cb111a69d222c5387;hpb=1c01e4a7aa37eeef825c6918fc90b154a7f4ccc7;p=mpd-sima.git diff --git a/sima/lib/plugin.py b/sima/lib/plugin.py index 0d6583e..83c28b5 100644 --- a/sima/lib/plugin.py +++ b/sima/lib/plugin.py @@ -1,5 +1,5 @@ # -*- coding: utf-8 -*- -# Copyright (c) 2013-2015 Jack Kaliko +# Copyright (c) 2013-2015, 2020 kaliko # # This file is part of sima # @@ -21,6 +21,11 @@ Plugin object to derive from """ +import random + +from .track import Track +from .meta import Album, Artist + class Plugin: """ @@ -45,9 +50,10 @@ class Plugin: def __init__(self, daemon): self.log = daemon.log - self.__daemon = daemon self.player = daemon.player self.plugin_conf = None + self.main_conf = daemon.config + self.sdb = daemon.sdb self.__get_config() def __str__(self): @@ -56,7 +62,7 @@ class Plugin: def __get_config(self): """Get plugin's specific configuration from global applications's config """ - conf = self.__daemon.config + conf = self.main_conf for sec in conf.sections(): # Discovering plugin conf if sec == self.__class__.__name__.lower(): self.plugin_conf = conf[sec] @@ -65,8 +71,7 @@ class Plugin: if not self.plugin_conf: self.plugin_conf = {'priority': '80'} #if self.plugin_conf: - # self.log.debug('Got config for {0}: {1}'.format(self, - # self.plugin_conf)) + # self.log.debug('Got config for %s: %s', self, self.plugin_conf) @property def priority(self): @@ -123,5 +128,126 @@ class Plugin: pass +class AdvancedPlugin(Plugin): + """Object to derive from for plugins + Exposes advanced music library look up with use of play history + """ + + # Query History + def get_history(self, artist=False): + """Constructs Track list of already played artists. + + :param Artist artist: Artist object to look history for + """ + duration = self.main_conf.getint('sima', 'history_duration') + name = None + if artist: + name = artist.name + from_db = self.sdb.get_history(duration=duration, artist=name) + hist = [Track(artist=tr[0], album=tr[1], title=tr[2], + file=tr[3]) for tr in from_db] + return hist + + def get_album_history(self, artist): + """Retrieve album history""" + hist = [] + tracks_from_db = self.get_history(artist=artist) + for trk in tracks_from_db: + if trk.album and trk.album in hist: + continue + hist.append(Album(name=trk.album, artist=Artist(trk.artist))) + return hist + + def get_reorg_artists_list(self, alist): + """ + Move around items in artists_list in order to play first not recently + played artists + + :param list(str) alist: + """ + hist = list() + duration = self.main_conf.getint('sima', 'history_duration') + for art in self.sdb.get_artists_history(alist, duration=duration): + if art not in hist: + hist.insert(0, art) + reorg = [art for art in alist if art not in hist] + reorg.extend(hist) + return reorg + # /Query History + + # Find not recently played/unplayed + def album_candidate(self, artist, unplayed=True): + """Search an album for artist + + :param Artist artist: Artist to fetch an album for + :param bool unplayed: Fetch only unplayed album + """ + self.log.info('Searching an album for "%s"...' % artist) + albums = self.player.search_albums(artist) + if not albums: + return [] + self.log.debug('Albums candidate: %s', albums) + albums_hist = self.get_album_history(artist) + self.log.debug('Albums history: %s', [a.name for a in albums_hist]) + albums_not_in_hist = [a for a in albums if a.name not in albums_hist] + # Get to next artist if there are no unplayed albums + if not albums_not_in_hist: + self.log.info('No unplayed album found for "%s"' % artist) + if unplayed: + return [] + random.shuffle(albums_not_in_hist) + albums_not_in_hist.extend(albums_hist) + album_to_queue = [] + for album in albums_not_in_hist: + # Controls the album found is not already queued + if album in {t.album for t in self.player.queue}: + self.log.debug('"%s" already queued, skipping!', album) + return [] + # In random play mode use complete playlist to filter + if self.player.playmode.get('random'): + if album in {t.album for t in self.player.playlist}: + self.log.debug('"%s" already in playlist, skipping!', + album) + return [] + album_to_queue = album + if not album_to_queue: + self.log.info('No album found for "%s"', artist) + return [] + self.log.info('%s album candidate: %s - %s', self.__class__.__name__, + artist, album_to_queue) + return album_to_queue + + def filter_track(self, tracks, unplayed=False): + """ + Extract one unplayed track from a Track object list. + * not in history + * not already in the queue + """ + artist = tracks[0].Artist + # In random play mode use complete playlist to filter + if self.player.playmode.get('random'): + deny_list = self.player.playlist + else: + deny_list = self.player.queue + not_in_hist = list(set(tracks) - set(self.get_history(artist=artist))) + if not not_in_hist: + self.log.debug('All tracks already played for "%s"', artist) + if unplayed: + return None + random.shuffle(not_in_hist) + candidates = [] + for trk in [_ for _ in not_in_hist if _ not in deny_list]: + # Should use albumartist heuristic as well + if self.plugin_conf.getboolean('single_album', False): # pylint: disable=no-member + if (trk.album == self.player.current.album or + trk.album in [tr.album for tr in deny_list]): + self.log.debug('Found unplayed track ' + + 'but from an album already queued: %s', trk) + continue + candidates.append(trk) + if not candidates: + return None + return random.choice(candidates) + # VIM MODLINE # vim: ai ts=4 sw=4 sts=4 expandtab