Remove default cover handling from CoverArtCache.

Add <DefaultCover> configuration option to WCoverArt to let skin authors
pick a default cover.

src/dlgcoverartfullsize.cpp

@@ -28,7 +28,8 @@ void DlgCoverArtFullSize::init(CoverInfo info) {
         info.coverLocation = cache->trackInDBHash(info.trackId);
     }
 
-    if (info.coverLocation == cache->getDefaultCoverLocation())  {
+    // If it's still empty, we don't have a cover.
+    if (info.coverLocation.isEmpty()) {
         return;
     }
 

src/library/coverartcache.cpp

@@ -13,10 +13,7 @@ const int kMaxCoverSize = 300;
 
 CoverArtCache::CoverArtCache()
         : m_pCoverArtDAO(NULL),
-          m_pTrackDAO(NULL),
-          m_sDefaultCoverLocation(":/images/library/default_cover.png"),
-          m_imgDefaultCover(m_sDefaultCoverLocation),
-          m_pxDefaultCover(m_sDefaultCoverLocation) {
+          m_pTrackDAO(NULL) {
     // The initial QPixmapCache limit is 10MB.
     // But it is not used just by the coverArt stuff,
     // it is also used by Qt to handle other things behind the scenes.
@@ -208,11 +205,6 @@ void CoverArtCache::imageLoaded() {
         QPixmapCache::insert(cacheKey, pixmap);
     }
 
-    // The widgets expects a signal response.
-    if (pixmap.isNull()) {
-        pixmap = m_pxDefaultCover;
-    }
-
     if (res.issueRepaint) {
         emit(requestRepaint());
     } else {
@@ -249,11 +241,6 @@ CoverArtCache::FutureResult CoverArtCache::searchImage(
                                                   kMaxCoverSize);
     }
 
-    if (res.img.isNull()) {
-        res.coverLocation = m_sDefaultCoverLocation;
-        res.img = m_imgDefaultCover;
-    }
-
     res.hash = CoverArtUtils::calculateHash(res.img);
 
     // adjusting the cover size according to the final purpose

src/library/coverartcache.h

@@ -18,8 +18,7 @@ struct CoverInfo {
     QString hash;
 };
 
-class CoverArtCache : public QObject, public Singleton<CoverArtCache>
-{
+class CoverArtCache : public QObject, public Singleton<CoverArtCache> {
     Q_OBJECT
   public:
     /* This method is used to request a cover art pixmap.
@@ -46,8 +45,6 @@ class CoverArtCache : public QObject, public Singleton<CoverArtCache>
     void setCoverArtDAO(CoverArtDAO* coverdao);
     void setTrackDAO(TrackDAO* trackdao);
 
-    QString getDefaultCoverLocation() { return m_sDefaultCoverLocation; }
-    QPixmap getDefaultCoverArt() { return m_pxDefaultCover; }
     // This is for widgets that try to get the covers directly from the cache
     // instead of waiting for the signal with the cover. Because we update the
     // database in large batches it can happen that a widget looks up a track
@@ -93,9 +90,6 @@ class CoverArtCache : public QObject, public Singleton<CoverArtCache>
   private:
     CoverArtDAO* m_pCoverArtDAO;
     TrackDAO* m_pTrackDAO;
-    const QString m_sDefaultCoverLocation;
-    const QImage m_imgDefaultCover;
-    const QPixmap m_pxDefaultCover;
     QSet<int> m_runningIds;
     QHash<int, QPair<QString, QString> > m_queueOfUpdates;
 };

src/library/coverartdelegate.cpp

@@ -9,11 +9,6 @@ CoverArtDelegate::CoverArtDelegate(QObject *parent)
           m_iCoverHashColumn(-1),
           m_iTrackLocationColumn(-1),
           m_iIdColumn(-1) {
-    CoverArtCache* pCache = CoverArtCache::instance();
-    if (pCache != NULL) {
-        m_sDefaultCover = pCache->getDefaultCoverLocation();
-    }
-
     // This assumes that the parent is wtracktableview
     connect(parent, SIGNAL(onlyCachedCoverArt(bool)),
             this, SLOT(slotOnlyCachedCoverArt(bool)));
@@ -71,9 +66,8 @@ void CoverArtDelegate::paint(QPainter *painter,
         return;
     }
 
-    // drawing only an existing cover_art,
-    // otherwise leave it blank...
-    if (coverLocation != m_sDefaultCover) {
+    // drawing only an existing cover_art, otherwise leave it blank...
+    if (!coverLocation.isEmpty()) {
         CoverInfo info;
         info.trackId = trackId;
         info.coverLocation = coverLocation;
@@ -86,11 +80,7 @@ void CoverArtDelegate::paint(QPainter *painter,
         QPixmap pixmap = pCache->requestPixmap(info, coverSize,
                                                m_bOnlyCachedCover, true);
 
-        if (info.coverLocation.isEmpty()) {
-            info.coverLocation = pCache->trackInDBHash(info.trackId);
-        }
-
-        if (!pixmap.isNull() && info.coverLocation != m_sDefaultCover) {
+        if (!pixmap.isNull()) {
             int width = pixmap.width();
             if (option.rect.width() < width) {
                 width = option.rect.width();

src/library/coverartdelegate.h

@@ -33,7 +33,6 @@ class CoverArtDelegate : public QStyledItemDelegate {
 
   private:
     bool m_bOnlyCachedCover;
-    QString m_sDefaultCover;
     int m_iCoverLocationColumn;
     int m_iCoverHashColumn;
     int m_iTrackLocationColumn;

src/library/coverartutils.h

@@ -12,6 +12,10 @@
 
 class CoverArtUtils {
   public:
+    static QString defaultCoverLocation() {
+        return QString(":/images/library/default_cover.png");
+    }
+
     // Extracts the first cover art image embedded within the file at
     // trackLocation.
     static QImage extractEmbeddedCover(const QString& trackLocation) {

src/test/coverartcache_test.cpp

@@ -38,7 +38,7 @@ class CoverArtCacheTest : public MixxxTest, public CoverArtCache {
     TrackCollection* m_pTrackCollection;
 };
 
-const QString& kCoverLocationTest("res/images/library/default_cover.png");
+const QString kCoverLocationTest("res/images/library/default_cover.png");
 const QString kTrackLocationTest(QDir::currentPath() %
                                  "/src/test/id3-test-data/cover-test.mp3");
 
@@ -142,8 +142,7 @@ TEST_F(CoverArtCacheTest, searchImage) {
     // looking for cover in an empty directory
     CoverArtCache::FutureResult res;
     res = CoverArtCache::searchImage(cInfo, QSize(0,0), false);
-    EXPECT_QSTRING_EQ(res.coverLocation,
-                      getDefaultCoverLocation());
+    EXPECT_TRUE(res.coverLocation.isEmpty());
 
     // looking for a track with embedded cover
     cInfo.trackLocation = kTrackLocationTest;

src/widget/wcoverart.cpp

@@ -8,6 +8,7 @@
 #include "widget/wcoverart.h"
 #include "widget/wskincolor.h"
 #include "library/coverartcache.h"
+#include "library/coverartutils.h"
 
 WCoverArt::WCoverArt(QWidget* parent,
                      TrackCollection* pTrackCollection)
@@ -23,8 +24,6 @@ WCoverArt::WCoverArt(QWidget* parent,
     if (pCache != NULL) {
         connect(pCache, SIGNAL(pixmapFound(int, QPixmap)),
                 this, SLOT(slotPixmapFound(int, QPixmap)));
-        m_loadedCover = pCache->getDefaultCoverArt();
-        m_loadedCoverScaled = scaledCoverArt(m_loadedCover);
     }
     connect(m_pMenu,
             SIGNAL(coverLocationUpdated(const QString&, const QString&, QPixmap)),
@@ -59,13 +58,24 @@ void WCoverArt::setup(QDomNode node, const SkinContext& context) {
     m_fgc = QColor(255 - bgc.red(), 255 - bgc.green(), 255 - bgc.blue());
     pal.setBrush(foregroundRole(), m_fgc);
     setPalette(pal);
+
+    if (context.hasNode(node, "DefaultCover")) {
+        m_defaultCover = QPixmap(context.selectString(node, "DefaultCover"));
+    }
+
+    // If no default cover is specified or we failed to load it, fall back on
+    // the resource bundle default cover.
+    if (m_defaultCover.isNull()) {
+        m_defaultCover = QPixmap(CoverArtUtils::defaultCoverLocation());
+    }
+    m_defaultCoverScaled = scaledCoverArt(m_defaultCover);
 }
 
 void WCoverArt::slotCoverLocationUpdated(const QString& newLoc,
                                          const QString& oldLoc,
-                                         QPixmap px) {
+                                         QPixmap newCover) {
     Q_UNUSED(oldLoc);
-    Q_UNUSED(px);
+    Q_UNUSED(newCover);
     CoverArtCache* pCache = CoverArtCache::instance();
     if (pCache != NULL && !pCache->changeCoverArt(
             m_lastRequestedCover.trackId, newLoc)) {
@@ -86,11 +96,8 @@ void WCoverArt::slotEnable(bool enable) {
 
 void WCoverArt::slotReset() {
     m_lastRequestedCover = CoverInfo();
-    CoverArtCache* pCache = CoverArtCache::instance();
-    if (pCache != NULL) {
-        m_loadedCover = pCache->getDefaultCoverArt();
-        m_loadedCoverScaled = scaledCoverArt(m_loadedCover);
-    }
+    m_loadedCover = QPixmap();
+    m_loadedCoverScaled = QPixmap();
     update();
 }
 
@@ -134,13 +141,22 @@ void WCoverArt::paintEvent(QPaintEvent* pEvent) {
     }
 
     QPainter painter(this);
-    int x = 3 + width() / 2 - m_loadedCoverScaled.width() / 2;
-    int y = 8;
-    painter.drawPixmap(x, y, m_loadedCoverScaled);
+
+    QPixmap toDraw = m_loadedCoverScaled;
+    if (toDraw.isNull()) {
+        toDraw = m_defaultCoverScaled;
+    }
+
+    if (!toDraw.isNull()) {
+        int x = 3 + width() / 2 - toDraw.width() / 2;
+        int y = 8;
+        painter.drawPixmap(x, y, toDraw);
+    }
+
     QPen pen = painter.pen();
     pen.setColor(QColor("#656565"));
     painter.setPen(pen);
-    painter.drawRoundedRect(5, 5, width()-7, height()-10, 0, 0);
+    painter.drawRoundedRect(5, 5, width() - 7, height() - 10, 0, 0);
 }
 
 void WCoverArt::resizeEvent(QResizeEvent*) {
@@ -149,13 +165,8 @@ void WCoverArt::resizeEvent(QResizeEvent*) {
         setMinimumHeight(h);
         setMaximumHeight(h);
     }
-    if (m_lastRequestedCover.trackId < 1) {
-        CoverArtCache* pCache = CoverArtCache::instance();
-        if (pCache != NULL) {
-            m_loadedCover = pCache->getDefaultCoverArt();
-        }
-    }
     m_loadedCoverScaled = scaledCoverArt(m_loadedCover);
+    m_defaultCoverScaled = scaledCoverArt(m_defaultCover);
 }
 
 void WCoverArt::mousePressEvent(QMouseEvent* event) {

src/widget/wcoverart.h

@@ -46,6 +46,8 @@ class WCoverArt : public QWidget, public WBaseWidget {
     WCoverArtMenu* m_pMenu;
     QPixmap m_loadedCover;
     QPixmap m_loadedCoverScaled;
+    QPixmap m_defaultCover;
+    QPixmap m_defaultCoverScaled;
     TrackDAO& m_trackDAO;
     CoverInfo m_lastRequestedCover;
     DlgCoverArtFullSize* m_pDlgFullSize;

src/widget/wcoverartlabel.cpp

@@ -1,11 +1,16 @@
 #include "widget/wcoverartlabel.h"
 
+#include "library/coverartutils.h"
+
+static const QSize s_labelDisplaySize = QSize(100, 100);
+
 WCoverArtLabel::WCoverArtLabel(QWidget* parent)
         : QLabel(parent),
           m_pTrack(TrackPointer()),
           m_coverInfo(CoverInfo()),
           m_pCoverMenu(new WCoverArtMenu(this)),
-          m_pDlgFullSize(new DlgCoverArtFullSize()) {
+          m_pDlgFullSize(new DlgCoverArtFullSize()),
+          m_defaultCover(CoverArtUtils::defaultCoverLocation()) {
     setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::MinimumExpanding);
     setFrameShape(QFrame::Box);
     setAlignment(Qt::AlignCenter);
@@ -16,6 +21,11 @@ WCoverArtLabel::WCoverArtLabel(QWidget* parent)
             SIGNAL(coverLocationUpdated(const QString&, const QString&, QPixmap)),
             this,
             SIGNAL(coverLocationUpdated(const QString&, const QString&, QPixmap)));
+
+    m_defaultCover = m_defaultCover.scaled(s_labelDisplaySize,
+                                           Qt::KeepAspectRatio,
+                                           Qt::SmoothTransformation);
+    setPixmap(m_defaultCover);
 }
 
 WCoverArtLabel::~WCoverArtLabel() {
@@ -26,7 +36,13 @@ WCoverArtLabel::~WCoverArtLabel() {
 void WCoverArtLabel::setCoverArt(TrackPointer track, CoverInfo info, QPixmap px) {
     m_pTrack = track;
     m_coverInfo = info;
-    setPixmap(px.scaled(100, 100, Qt::KeepAspectRatio, Qt::SmoothTransformation));
+
+    if (px.isNull()) {
+        setPixmap(m_defaultCover);
+    } else {
+        setPixmap(px.scaled(s_labelDisplaySize, Qt::KeepAspectRatio,
+                            Qt::SmoothTransformation));
+    }
 
     QSize frameSize = pixmap()->size();
     frameSize += QSize(2,2); // margin

src/widget/wcoverartlabel.h

@@ -4,6 +4,7 @@
 #include <QLabel>
 #include <QMouseEvent>
 #include <QWidget>
+#include <QPixmap>
 
 #include "dlgcoverartfullsize.h"
 #include "widget/wcoverartmenu.h"
@@ -17,7 +18,9 @@ class WCoverArtLabel : public QLabel {
     void setCoverArt(TrackPointer track, CoverInfo info, QPixmap px);
 
   signals:
-    void coverLocationUpdated(const QString&, const QString&, QPixmap);
+    void coverLocationUpdated(const QString& newLocation,
+                              const QString& oldLocation,
+                              QPixmap newCover);
 
   protected:
     void leaveEvent(QEvent*);
@@ -31,6 +34,7 @@ class WCoverArtLabel : public QLabel {
     CoverInfo m_coverInfo;
     WCoverArtMenu* m_pCoverMenu;
     DlgCoverArtFullSize* m_pDlgFullSize;
+    QPixmap m_defaultCover;
 };
 
 #endif // WCOVERARTLABEL_H

src/widget/wcoverartmenu.cpp

@@ -59,8 +59,7 @@ void WCoverArtMenu::slotChange() {
     // get initial directory (trackdir or coverdir)
     QString initialDir;
     QString trackPath = m_pTrack->getDirectory();
-    if (m_coverInfo.coverLocation.isEmpty() ||
-            m_coverInfo.coverLocation == pCache->getDefaultCoverLocation()) {
+    if (m_coverInfo.coverLocation.isEmpty()) {
         initialDir = trackPath;
     } else {
         initialDir = m_coverInfo.coverLocation;
@@ -141,7 +140,6 @@ void WCoverArtMenu::slotUnset() {
     if (pCache == NULL) {
         return;
     }
-    QString newLoc = pCache->getDefaultCoverLocation();
-    QPixmap px = pCache->getDefaultCoverArt();
-    emit(coverLocationUpdated(newLoc, m_coverInfo.coverLocation, px));
+    QPixmap px;
+    emit(coverLocationUpdated(QString(), m_coverInfo.coverLocation, QPixmap()));
 }

src/widget/wcoverartmenu.h

@@ -25,7 +25,7 @@ class WCoverArtMenu : public QMenu {
   signals:
     void coverLocationUpdated(const QString& newLocation,
                               const QString& oldLocation,
-                              QPixmap px);
+                              QPixmap newCover);
 
   private slots:
     void slotChange();