1 # -*- coding: utf-8 -*-
2 # Copyright (c) 2020-2021 kaliko <kaliko@azylum.org>
4 # This file is part of sima
6 # sima is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
11 # sima is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License
17 # along with sima. If not, see <http://www.gnu.org/licenses/>.
21 Add titles based on Genre tag
24 # standard library import
25 from collections import Counter
26 from random import shuffle
28 # third parties components
31 from ...lib.plugin import AdvancedPlugin
32 from ...lib.meta import Artist, MetaContainer
33 from ...utils.utils import PluginException
36 def forge_filter(genre):
37 mpd_filter = f"(Genre == '{genre.strip()}')"
38 # Ensure there is at least an artist name
39 mpd_filter = f"({mpd_filter} AND (artist != ''))"
43 class Genre(AdvancedPlugin):
44 """Add track based on tags content
47 def __init__(self, daemon):
48 super().__init__(daemon)
49 self._setup_tagsneeded()
51 def _setup_tagsneeded(self):
52 """Ensure needed tags are exposed by MPD"""
53 self.log.debug('%s plugin needs the following metadata: Genre', self)
54 self.player.needed_tags |= {'genre'}
57 if (0, 21, 0) > tuple(map(int, self.player.mpd_version.split('.'))):
58 self.log.warning('MPD protocol version: %s < 0.21.0',
59 self.player.mpd_version)
61 'Need at least MPD 0.21 to use Genre plugin (filters required)')
62 self.player.disconnect()
63 raise PluginException('MPD >= 0.21 required')
65 def fetch_genres(self):
68 current_titles = self.player.playlist[-pldepth:]
70 for track in current_titles:
72 self.log.debug('No genre found in %s', track)
74 genres.extend(track.genres)
75 genres_analysis = Counter(genres)
76 if genres_analysis.most_common():
77 self.log.debug('Most common genres: %s', genres_analysis.most_common())
78 return dict(genres_analysis.most_common(nbgenres)).keys()
80 def callback_need_track(self):
82 queue_mode = self.plugin_conf.get('queue_mode', 'track')
83 target = self.plugin_conf.getint(f'{queue_mode}_to_add')
84 genres = self.fetch_genres()
86 self.log.warning('No genre tag set in current tracks!')
88 self.log.info('Genre plugin looking for genre: %s', ' / '.join(genres))
89 artists = MetaContainer([])
91 mpd_filter = forge_filter(genre)
92 self.log.debug('mpd filter: %s', mpd_filter)
93 _ = self.player.list('artist', mpd_filter)
95 artists |= MetaContainer([Artist(name=a) for a in _])
97 self.log.info('Genre plugin found nothing to queue')
99 artists = self.get_reorg_artists_list(artists)
100 self.log.debug('Genre plugin found: %s…', ' / '.join(map(str, artists[:4])))
101 for artist in artists:
102 self.log.debug('looking for %s', artist)
103 tracks = self.player.find_tracks(artist)
104 trk = self.filter_track(tracks)
107 if queue_mode == 'track':
108 self.log.info('Genre plugin chose: {}'.format(trk))
109 candidates.append(trk)
110 if len(candidates) == target:
113 album = self.album_candidate(trk.Artist, unplayed=True)
116 candidates.extend(self.player.find_tracks(album))
117 if len({t.album for t in candidates}) == target:
122 # vim: ai ts=4 sw=4 sts=4 expandtab