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
|
#include "library/coverart.h"
#include <QDebugStateSaver>
#include "library/coverartutils.h"
#include "track/track.h"
#include "util/debug.h"
#include "util/logger.h"
namespace {
mixxx::Logger kLogger("CoverArt");
QString sourceToString(CoverInfo::Source source) {
switch (source) {
case CoverInfo::UNKNOWN:
return "UNKNOWN";
case CoverInfo::GUESSED:
return "GUESSED";
case CoverInfo::USER_SELECTED:
return "USER_SELECTED";
}
return "INVALID INFO VALUE";
}
QString typeToString(CoverInfo::Type type) {
switch (type) {
case CoverInfo::NONE:
return "NONE";
case CoverInfo::METADATA:
return "METADATA";
case CoverInfo::FILE:
return "FILE";
}
return "INVALID TYPE VALUE";
}
quint16 calculateLegacyHash(
const QImage& image) {
const auto legacyHash = qChecksum(
reinterpret_cast<const char*>(image.constBits()),
#if QT_VERSION >= QT_VERSION_CHECK(5, 10, 0)
image.sizeInBytes()
#else
image.byteCount()
#endif
);
DEBUG_ASSERT(image.isNull() || legacyHash != CoverInfo::defaultLegacyHash());
DEBUG_ASSERT(!image.isNull() || legacyHash == CoverInfo::defaultLegacyHash());
return legacyHash;
}
} // anonymous namespace
CoverInfoRelative::CoverInfoRelative()
: source(UNKNOWN),
type(NONE),
m_legacyHash(defaultLegacyHash()) {
}
void CoverInfoRelative::setImage(
const QImage& image) {
color = CoverImageUtils::extractBackgroundColor(image);
m_imageDigest = CoverImageUtils::calculateDigest(image);
DEBUG_ASSERT(image.isNull() == m_imageDigest.isEmpty());
m_legacyHash = calculateLegacyHash(image);
DEBUG_ASSERT(image.isNull() == (m_legacyHash == defaultLegacyHash()));
DEBUG_ASSERT(image.isNull() != hasImage());
}
bool operator==(const CoverInfoRelative& lhs, const CoverInfoRelative& rhs) {
return lhs.source == rhs.source &&
lhs.type == rhs.type &&
lhs.color == rhs.color &&
lhs.legacyHash() == rhs.legacyHash() &&
lhs.imageDigest() == rhs.imageDigest() &&
lhs.coverLocation == rhs.coverLocation;
}
bool operator!=(const CoverInfoRelative& lhs, const CoverInfoRelative& rhs) {
return !(lhs == rhs);
}
QDebug operator<<(QDebug dbg, const CoverInfoRelative& info) {
const QDebugStateSaver saver(dbg);
dbg = dbg.maybeSpace() << "CoverInfoRelative";
return dbg.nospace()
<< '{'
<< typeToString(info.type)
<< ','
<< sourceToString(info.source)
<< ','
<< info.color
<< ','
<< info.coverLocation
<< ','
<< info.imageDigest()
<< ','
<< info.legacyHash()
<< '}';
}
CoverInfo::LoadedImage CoverInfo::loadImage(
const SecurityTokenPointer& pTrackLocationToken) const {
LoadedImage loadedImage(LoadedImage::Result::ErrorUnknown);
if (type == CoverInfo::METADATA) {
VERIFY_OR_DEBUG_ASSERT(!trackLocation.isEmpty()) {
loadedImage.result = LoadedImage::Result::ErrorMetadataWithEmptyTrackLocation;
return loadedImage;
}
loadedImage.filePath = trackLocation;
loadedImage.image = CoverArtUtils::extractEmbeddedCover(
TrackFile(trackLocation),
pTrackLocationToken);
if (loadedImage.image.isNull()) {
// TODO: extractEmbeddedCover() should indicate if no image
// is available or if loading the embedded image failed.
// Until then we assume optimistically that no image is
// available instead of presuming that an error occurred.
loadedImage.result = LoadedImage::Result::NoImage;
} else {
loadedImage.result = LoadedImage::Result::Ok;
}
} else if (type == CoverInfo::FILE) {
auto coverFile = QFileInfo(coverLocation);
if (coverFile.isRelative()) {
VERIFY_OR_DEBUG_ASSERT(!trackLocation.isEmpty()) {
// This is not expected to happen, because every track
// must have a valid location, i.e. a file path. Most
// likely a programming error, but might also be caused
// by yet unknown circumstances.
loadedImage.result = LoadedImage::Result::
ErrorRelativeFilePathWithEmptyTrackLocation;
return loadedImage;
}
// Compose track directory with relative path
const auto trackFile = TrackFile(trackLocation);
DEBUG_ASSERT(trackFile.asFileInfo().isAbsolute());
coverFile = QFileInfo(
trackFile.directory(),
coverLocation);
}
DEBUG_ASSERT(coverFile.isAbsolute());
loadedImage.filePath = coverFile.filePath();
if (!coverFile.exists()) {
loadedImage.result = LoadedImage::Result::ErrorFilePathDoesNotExist;
return loadedImage;
}
SecurityTokenPointer pToken =
Sandbox::openSecurityToken(
coverFile,
true);
if (loadedImage.image.load(loadedImage.filePath)) {
DEBUG_ASSERT(!loadedImage.image.isNull());
loadedImage.result = LoadedImage::Result::Ok;
} else {
DEBUG_ASSERT(loadedImage.image.isNull());
loadedImage.result = LoadedImage::Result::ErrorLoadingFailed;
}
} else if (type == CoverInfo::NONE) {
loadedImage.result = LoadedImage::Result::NoImage;
} else {
DEBUG_ASSERT(!"unhandled CoverInfo::Type");
}
return loadedImage;
}
bool CoverInfo::refreshImageDigest(
const QImage& loadedImage,
const SecurityTokenPointer& pTrackLocationToken) {
if (!imageDigest().isEmpty()) {
// Assume that a non-empty digest has been calculated from
// the corresponding image. Otherwise we would refresh all
// digests over and over again.
// Invalid legacy hash values are ignored. These will only
// be refreshed when opened with a previous version.
return false;
}
QImage image = loadedImage;
if (image.isNull()) {
image = loadImage(pTrackLocationToken).image;
}
if (image.isNull() && type != CoverInfo::NONE) {
kLogger.warning()
<< "Resetting cover info"
<< *this;
reset();
return true;
}
setImage(image);
return true;
}
bool operator==(const CoverInfo& lhs, const CoverInfo& rhs) {
return static_cast<const CoverInfoRelative&>(lhs) ==
static_cast<const CoverInfoRelative&>(rhs) &&
lhs.trackLocation == rhs.trackLocation;
}
bool operator!=(const CoverInfo& lhs, const CoverInfo& rhs) {
return !(lhs == rhs);
}
QDebug operator<<(QDebug dbg, const CoverInfo& info) {
const QDebugStateSaver saver(dbg);
dbg = dbg.maybeSpace() << "CoverInfo";
return dbg.nospace()
<< '{'
<< static_cast<const CoverInfoRelative&>(info)
<< ','
<< info.trackLocation
<< '}';
}
QDebug operator<<(QDebug dbg, const CoverInfo::LoadedImage::Result& result) {
switch (result) {
case CoverInfo::LoadedImage::Result::Ok:
return dbg << "Ok";
case CoverInfo::LoadedImage::Result::NoImage:
return dbg << "NoImage";
case CoverInfo::LoadedImage::Result::ErrorMetadataWithEmptyTrackLocation:
return dbg << "ErrorMetadataWithEmptyTrackLocation";
case CoverInfo::LoadedImage::Result::ErrorRelativeFilePathWithEmptyTrackLocation:
return dbg << "ErrorRelativeFilePathWithEmptyTrackLocation";
case CoverInfo::LoadedImage::Result::ErrorFilePathDoesNotExist:
return dbg << "ErrorFilePathDoesNotExist";
case CoverInfo::LoadedImage::Result::ErrorLoadingFailed:
return dbg << "ErrorLoadingFailed";
case CoverInfo::LoadedImage::Result::ErrorUnknown:
return dbg << "ErrorUnknown";
}
DEBUG_ASSERT(!"unreachable");
return dbg;
}
QDebug operator<<(QDebug dbg, const CoverInfo::LoadedImage& loadedImage) {
const QDebugStateSaver saver(dbg);
dbg = dbg.maybeSpace() << "CoverInfo::LoadedImage";
return dbg.nospace()
<< '{'
<< loadedImage.filePath
<< ','
<< loadedImage.
|
