/
cluster.py
433 lines (347 loc) · 13.1 KB
/
cluster.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
# -*- coding: utf-8 -*-
#
# Picard, the next-generation MusicBrainz tagger
#
# Copyright (C) 2004 Robert Kaye
# Copyright (C) 2006-2008, 2011 Lukáš Lalinský
# Copyright (C) 2008 Hendrik van Antwerpen
# Copyright (C) 2008 Will
# Copyright (C) 2010-2011, 2014, 2018-2022 Philipp Wolfer
# Copyright (C) 2011-2013 Michael Wiencek
# Copyright (C) 2012 Chad Wilson
# Copyright (C) 2012 Wieland Hoffmann
# Copyright (C) 2013-2015, 2018-2021 Laurent Monin
# Copyright (C) 2014, 2017 Sophist-UK
# Copyright (C) 2016 Rahul Raturi
# Copyright (C) 2016-2017 Sambhav Kothari
# Copyright (C) 2017 Antonio Larrosa
# Copyright (C) 2018 Vishal Choudhary
# Copyright (C) 2020 Gabriel Ferreira
# Copyright (C) 2020 Ray Bouchard
# Copyright (C) 2021 Petit Minion
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
from collections import (
Counter,
defaultdict,
)
from operator import attrgetter
import re
from PyQt5 import QtCore
from picard.config import get_config
from picard.file import File
from picard.metadata import (
Metadata,
SimMatchRelease,
)
from picard.util import (
album_artist_from_path,
find_best_match,
format_time,
)
from picard.util.imagelist import (
add_metadata_images,
remove_metadata_images,
update_metadata_images,
)
from picard.ui.item import (
FileListItem,
Item,
)
class FileList(QtCore.QObject, FileListItem):
metadata_images_changed = QtCore.pyqtSignal()
def __init__(self, files=None):
QtCore.QObject.__init__(self)
FileListItem.__init__(self, files)
self.metadata = Metadata()
self.orig_metadata = Metadata()
if self.files and self.can_show_coverart:
for file in self.files:
file.metadata_images_changed.connect(self.update_metadata_images)
update_metadata_images(self)
def iterfiles(self, save=False):
yield from self.files
def update(self, signal=True):
pass
@property
def can_show_coverart(self):
return True
class Cluster(FileList):
# Weights for different elements when comparing a cluster to a release
comparison_weights = {
'album': 17,
'albumartist': 6,
'totalalbumtracks': 5,
'releasetype': 10,
'releasecountry': 2,
'format': 2,
'date': 4,
}
def __init__(self, name, artist="", special=False, related_album=None, hide_if_empty=False):
super().__init__()
self.item = None
self.metadata['album'] = name
self.metadata['albumartist'] = artist
self.metadata['totaltracks'] = 0
self.special = special
self.hide_if_empty = hide_if_empty
self.related_album = related_album
self.lookup_task = None
def __repr__(self):
if self.related_album:
return '<Cluster %s %r>' % (
self.related_album.id,
self.related_album.metadata['album'] + '/' + self.metadata['album']
)
return '<Cluster %r>' % self.metadata['album']
def __len__(self):
return len(self.files)
@property
def album(self):
return self.related_album
def _update_related_album(self, added_files=None, removed_files=None):
if self.related_album:
if added_files:
add_metadata_images(self.related_album, added_files)
if removed_files:
remove_metadata_images(self.related_album, removed_files)
self.related_album.update()
def add_files(self, files, new_album=True):
added_files = set(files) - set(self.files)
if not added_files:
return
for file in added_files:
self.metadata.length += file.metadata.length
file._move(self)
file.update(signal=False)
if self.can_show_coverart:
file.metadata_images_changed.connect(self.update_metadata_images)
added_files = sorted(added_files, key=attrgetter('discnumber', 'tracknumber', 'base_filename'))
self.files.extend(added_files)
self.update(signal=False)
if self.can_show_coverart:
add_metadata_images(self, added_files)
self.item.add_files(added_files)
if new_album:
self._update_related_album(added_files=added_files)
def add_file(self, file, new_album=True):
self.add_files([file], new_album=new_album)
def remove_file(self, file, new_album=True):
self.tagger.window.set_processing(True)
self.metadata.length -= file.metadata.length
self.files.remove(file)
self.update(signal=False)
self.item.remove_file(file)
if self.can_show_coverart:
file.metadata_images_changed.disconnect(self.update_metadata_images)
remove_metadata_images(self, [file])
if new_album:
self._update_related_album(removed_files=[file])
self.tagger.window.set_processing(False)
if not self.special and self.get_num_files() == 0:
self.tagger.remove_cluster(self)
def update(self, signal=True):
self.metadata['~totalalbumtracks'] = self.metadata['totaltracks'] = len(self.files)
if signal and self.item:
self.item.update()
def get_num_files(self):
return len(self.files)
def can_save(self):
"""Return if this object can be saved."""
return bool(self.files)
def can_remove(self):
"""Return if this object can be removed."""
return not self.special
def can_edit_tags(self):
"""Return if this object supports tag editing."""
return True
def can_analyze(self):
"""Return if this object can be fingerprinted."""
return any(_file.can_analyze() for _file in self.files)
def can_autotag(self):
return True
def can_refresh(self):
return False
def can_browser_lookup(self):
return not self.special
def can_view_info(self):
return bool(self.files)
def can_submit(self):
return not self.special and bool(self.files)
def is_album_like(self):
return True
def column(self, column):
if column == 'title':
return '%s (%d)' % (self.metadata['album'], len(self.files))
elif self.special and column in {'~length', 'album', 'covercount'}:
return ''
elif column == '~length':
return format_time(self.metadata.length)
elif column == 'artist':
return self.metadata['albumartist']
elif column == 'tracknumber':
return self.metadata['totaltracks']
elif column == 'discnumber':
return self.metadata['totaldiscs']
elif column == 'covercount':
return self.cover_art_description()
return self.metadata[column]
def _lookup_finished(self, document, http, error):
self.lookup_task = None
try:
releases = document['releases']
except (KeyError, TypeError):
releases = None
def statusbar(message):
self.tagger.window.set_statusbar_message(
message,
{'album': self.metadata['album']},
timeout=3000
)
best_match_release = None
if releases:
config = get_config()
best_match_release = self._match_to_release(releases, threshold=config.setting['cluster_lookup_threshold'])
if best_match_release:
statusbar(N_("Cluster %(album)s identified!"))
self.tagger.move_files_to_album(self.files, best_match_release['id'])
else:
statusbar(N_("No matching releases for cluster %(album)s"))
def _match_to_release(self, releases, threshold=0):
# multiple matches -- calculate similarities to each of them
def candidates():
for release in releases:
match = self.metadata.compare_to_release(release, Cluster.comparison_weights)
if match.similarity >= threshold:
yield match
no_match = SimMatchRelease(similarity=-1, release=None)
best_match = find_best_match(candidates(), no_match)
return best_match.result.release
def lookup_metadata(self):
"""Try to identify the cluster using the existing metadata."""
if self.lookup_task:
return
self.tagger.window.set_statusbar_message(
N_("Looking up the metadata for cluster %(album)s…"),
{'album': self.metadata['album']}
)
config = get_config()
self.lookup_task = self.tagger.mb_api.find_releases(self._lookup_finished,
artist=self.metadata['albumartist'],
release=self.metadata['album'],
tracks=str(len(self.files)),
limit=config.setting['query_limit'])
def clear_lookup_task(self):
if self.lookup_task:
self.tagger.webservice.remove_task(self.lookup_task)
self.lookup_task = None
@staticmethod
def cluster(files):
"""Group the provided files into clusters, based on album tag in metadata.
Args:
files: List of File objects.
Yields:
FileCluster objects
"""
config = get_config()
various_artists = config.setting['va_name']
cluster_list = defaultdict(FileCluster)
for file in files:
artist = file.metadata['albumartist'] or file.metadata['artist']
album = file.metadata['album']
# Improve clustering from directory structure if no existing tags
# Only used for grouping and to provide cluster title / artist - not added to file tags.
album, artist = album_artist_from_path(file.filename, album, artist)
token = tokenize(album)
if token:
cluster_list[token].add(album, artist or various_artists, file)
yield from cluster_list.values()
class UnclusteredFiles(Cluster):
"""Special cluster for 'Unmatched Files' which have not been clustered."""
def __init__(self):
super().__init__(_("Unclustered Files"), special=True)
def add_files(self, files, new_album=True):
super().add_files(files, new_album=new_album)
self.tagger.window.enable_cluster(bool(self.files))
def remove_file(self, file, new_album=True):
super().remove_file(file, new_album=new_album)
self.tagger.window.enable_cluster(bool(self.files))
def lookup_metadata(self):
self.tagger.autotag(self.files)
def can_edit_tags(self):
return False
def can_autotag(self):
return bool(self.files)
def can_view_info(self):
return False
def can_remove(self):
return bool(self.files)
@property
def can_show_coverart(self):
return False
class ClusterList(list, Item):
"""A list of clusters."""
def __init__(self):
super().__init__()
def __hash__(self):
return id(self)
def __bool__(self):
# An existing Item object should not be considered False, even if it
# is based on a list.
return True
def iterfiles(self, save=False):
for cluster in self:
yield from cluster.iterfiles(save)
def can_save(self):
return len(self) > 0
def can_analyze(self):
return any(cluster.can_analyze() for cluster in self)
def can_autotag(self):
return len(self) > 0
def can_browser_lookup(self):
return False
def lookup_metadata(self):
for cluster in self:
cluster.lookup_metadata()
class FileCluster:
def __init__(self):
self._files = []
self._artist_counts = Counter()
self._artists = defaultdict(Counter)
self._titles = Counter()
def add(self, album, artist, file):
self._files.append(file)
token = tokenize(artist)
self._artist_counts[token] += 1
self._artists[token][artist] += 1
self._titles[album] += 1
@property
def files(self):
yield from (file for file in self._files if file.state != File.REMOVED)
@property
def artist(self):
tokenized_artist = self._artist_counts.most_common(1)[0][0]
candidates = self._artists[tokenized_artist]
return candidates.most_common(1)[0][0]
@property
def title(self):
# Find the most common title
return self._titles.most_common(1)[0][0]
_re_non_alphanum = re.compile(r'\W', re.UNICODE)
_re_spaces = re.compile(r'\s', re.UNICODE)
def tokenize(word):
word = word.lower()
token = _re_non_alphanum.sub('', word)
return token if token else _re_spaces.sub('', word)