Library: add overview column

CMakeLists.txt

@@ -1219,6 +1219,7 @@ add_library(
   src/library/missing_hidden/hiddentablemodel.cpp
   src/library/missing_hidden/missingtablemodel.cpp
   src/library/mixxxlibraryfeature.cpp
+  src/library/overviewcache.cpp
   src/library/parser.cpp
   src/library/parsercsv.cpp
   src/library/parserm3u.cpp
@@ -1248,6 +1249,7 @@ add_library(
   src/library/tabledelegates/keydelegate.cpp
   src/library/tabledelegates/locationdelegate.cpp
   src/library/tabledelegates/multilineeditdelegate.cpp
+  src/library/tabledelegates/overviewdelegate.cpp
   src/library/tabledelegates/previewbuttondelegate.cpp
   src/library/tabledelegates/stardelegate.cpp
   src/library/tabledelegates/stareditor.cpp
@@ -1470,11 +1472,13 @@ add_library(
   src/util/workerthreadscheduler.cpp
   src/util/xml.cpp
   src/waveform/guitick.cpp
+  src/waveform/overviewtype.cpp
   src/waveform/renderers/glwaveformrenderbackground.cpp
   src/waveform/renderers/glvsynctestrenderer.cpp
   src/waveform/renderers/waveformmark.cpp
   src/waveform/renderers/waveformmarkrange.cpp
   src/waveform/renderers/waveformmarkset.cpp
+  src/waveform/renderers/waveformoverviewrenderer.cpp
   src/waveform/renderers/waveformrenderbackground.cpp
   src/waveform/renderers/waveformrenderbeat.cpp
   src/waveform/renderers/waveformrendererabstract.cpp

res/skins/Deere/library.xml

@@ -72,6 +72,10 @@
               <Library>
                 <ShowButtonText>false</ShowButtonText>
                 <TrackTableBackgroundColorOpacity>0.175</TrackTableBackgroundColorOpacity>
+                <!-- Colors for the render modes of the Overview column -->
+                <!-- For the overview column we only set the signal color,
+                     other colors are the defaults. -->
+                <SignalColor><Variable name="SignalColor"/></SignalColor>
               </Library>
 
             </Children>

res/skins/Deere/preview_deck.xml

@@ -100,7 +100,7 @@
                     <SignalRGBHighColor></SignalRGBHighColor>
                     <SignalRGBMidColor></SignalRGBMidColor>
                     <SignalRGBLowColor></SignalRGBLowColor>
-                    <SignalColor>#FF8000</SignalColor>
+                    <SignalColor><Variable name="SignalColor"/></SignalColor>
                     <PlayPosColor>#00FF00</PlayPosColor>
                     <ShowCueTimes>false</ShowCueTimes>
                     <DefaultMark>

res/skins/Deere/sampler_controls_row.xml

@@ -42,7 +42,7 @@
             <SignalRGBHighColor></SignalRGBHighColor>
             <SignalRGBMidColor></SignalRGBMidColor>
             <SignalRGBLowColor></SignalRGBLowColor>
-            <SignalColor>#FF8000</SignalColor>
+            <SignalColor><Variable name="SignalColor"/></SignalColor>
             <PlayPosColor>#00FF00</PlayPosColor>
             <ShowCueTimes>false</ShowCueTimes>
             <DefaultMark>

res/skins/Deere/skin.xml

@@ -135,6 +135,9 @@
     <SetVariable name="VerticalStretchButtonMaximumSize">22,-1</SetVariable>
     <SetVariable name="VerticalStretchButtonSizePolicy">f,me</SetVariable>
 
+    <!-- Signal color for waveform overview in preview deck, samplers and library -->
+    <SetVariable name="SignalColor">#FF8000</SetVariable>
+
     <!-- The waveforms (zoomed and overview) use a lot of memory. They appear in multiple places in
     main_decks.xml, left_deck.xml, and right_deck.xml, so define them in singletons. This makes
     toggling between 2/4 decks and stacked/split waveforms slower, but it makes Mixxx startup

res/skins/LateNight/library.xml

@@ -110,6 +110,10 @@
               <Library>
                 <ShowButtonText>false</ShowButtonText>
                 <TrackTableBackgroundColorOpacity>0.175</TrackTableBackgroundColorOpacity>
+                <!-- Colors for the render modes of the Overview column -->
+                <!-- For the overview column we only set the signal color,
+                     other colors are the defaults. -->
+                <SignalColor><Variable name="SignalColor_12"/></SignalColor>
               </Library>
 
             </Children>

res/skins/Shade/deck_overview.xml

@@ -9,7 +9,7 @@
     <SignalHighColor></SignalHighColor>
     <SignalMidColor></SignalMidColor>
     <SignalLowColor></SignalLowColor>
-    <SignalColor>#191F24</SignalColor>
+    <SignalColor><Variable name="SignalColor"/></SignalColor>
     <PlayPosColor>#00FF00</PlayPosColor>
     <EndOfTrackColor>#EA0000</EndOfTrackColor>
     <PassthroughLabelColor><Variable name="PassthroughLabelColor"/></PassthroughLabelColor>

res/skins/Shade/preview_deck.xml

@@ -171,7 +171,7 @@
                             <SignalHighColor></SignalHighColor>
                             <SignalMidColor></SignalMidColor>
                             <SignalLowColor></SignalLowColor>
-                            <SignalColor>#191F24</SignalColor>
+                            <SignalColor><Variable name="SignalColor"/></SignalColor>
                             <PlayPosColor>#00FF00</PlayPosColor>
                             <ShowCueTimes>false</ShowCueTimes>
                             <DefaultMark>

res/skins/Shade/sampler.xml

@@ -176,7 +176,7 @@
                     <SignalHighColor></SignalHighColor>
                     <SignalMidColor></SignalMidColor>
                     <SignalLowColor></SignalLowColor>
-                    <SignalColor>#191F24</SignalColor>
+                    <SignalColor><Variable name="SignalColor"/></SignalColor>
                     <PlayPosColor>#00FF00</PlayPosColor>
                     <ShowCueTimes>false</ShowCueTimes>
                     <DefaultMark>

res/skins/Shade/skin.xml

@@ -273,6 +273,17 @@
   <Layout>vertical</Layout>
 
     <Children>
+
+    <!-- Signal color for waveform overview in preview deck, samplers and library -->
+    <SetVariable name="SignalColor">#191F24</SetVariable>
+    <SetVariable name="PassthroughLabelColor">#55F764</SetVariable>
+    <!-- Shade has overview and waveform very close, so it would be redundant and distracting
+        to paint the 'Passthrough' labels on both with an alarming color.
+        This is the regular background color, so the label will be invisible: -->
+    <SetVariable name="PassthroughLabelColorWaveform">#8d98a3</SetVariable>
+    <!-- This is slightly brighter that the background: -->
+    <!-- <SetVariable name="PassthroughLabelColorWaveform">#9fabb7</SetVariable> -->
+
     <!--
     ############################################################################################
     ############################################################################################
@@ -284,13 +295,6 @@
     ############################################################################################
     ############################################################################################
     -->
-    <SetVariable name="PassthroughLabelColor">#55F764</SetVariable>
-    <!-- Shade has overview and waveform very close, so it would be redundant and distracting
-        to paint the 'Passthrough' labels on both with an alarming color.
-        This is the regular background color, so the label will be invisible: -->
-    <SetVariable name="PassthroughLabelColorWaveform">#8d98a3</SetVariable>
-    <!-- This is slightly brighter that the background: -->
-    <!-- <SetVariable name="PassthroughLabelColorWaveform">#9fabb7</SetVariable> -->
 
     <SingletonDefinition>
       <ObjectName>Overview1</ObjectName>

res/skins/Tango/decks/preview_deck.xml

@@ -114,7 +114,7 @@ Variables:
                 <Size>1me,34f</Size>
                 <Group><Variable name="group"/></Group>
                 <BgColor>#151515</BgColor>
-                <SignalColor>#bababa</SignalColor>
+                <SignalColor><Variable name="SignalColor"/></SignalColor>
                 <PlayPosColor>#FF4300</PlayPosColor>
                 <PlayedOverlayColor><Variable name="PlayedOverlayColor"/></PlayedOverlayColor>
                 <MarkerColor>#00FF00</MarkerColor>

res/skins/Tango/library.xml

@@ -118,6 +118,10 @@ Description:
                     <FgColor>#eece33</FgColor>
                     <ShowButtonText>false</ShowButtonText>
                     <TrackTableBackgroundColorOpacity>0.2</TrackTableBackgroundColorOpacity>
+                    <!-- Colors for the render modes of the Overview column -->
+                    <!-- For the overview column we only set the signal color,
+                         other colors are the defaults. -->
+                    <SignalColor><Variable name="SignalColor"/></SignalColor>
                   </Library>
                 </Children>
               </WidgetGroup><!-- /Library Table -->

res/skins/Tango/mic_aux_sampler/sampler.xml

@@ -200,7 +200,7 @@ Variables:
                     <SizePolicy>me,min</SizePolicy>
                     <Group><Variable name="group"/></Group>
                     <BgColor>#151515</BgColor>
-                    <SignalColor>#bababa</SignalColor>
+                    <SignalColor><Variable name="SignalColor"/></SignalColor>
                     <PlayPosColor>#FF4300</PlayPosColor>
                     <PlayedOverlayColor><Variable name="PlayedOverlayColor"/></PlayedOverlayColor>
                     <ShowCueTimes>false</ShowCueTimes>

res/skins/Tango/skin.xml

@@ -182,6 +182,8 @@
     <SetVariable name="SignalBgColor_34">#19260B</SetVariable>
     <SetVariable name="SpinnyCoverColor_12">purple</SetVariable>
     <SetVariable name="SpinnyCoverColor_34">green</SetVariable>
+    <!-- Signal color for waveform overview in decks 1/2, preview deck, samplers and library -->
+    <SetVariable name="SignalColor">#bababa</SetVariable>
 
 <!--################################################################
      Singleton definitions  #######################################

src/analyzer/analyzerwaveform.cpp

@@ -71,7 +71,7 @@ bool AnalyzerWaveform::initialize(const AnalyzerTrack& track,
             sampleRate, frameLength, mainWaveformSampleRate, summaryWaveformSamples, stemCount));
 
     // Now, that the Waveform memory is initialized, we can set set them to
-    // the TIO. Be aware that other threads of Mixxx can touch them from
+    // the track. Be aware that other threads of Mixxx can touch them from
     // now.
     track.getTrack()->setWaveform(m_waveform);
     track.getTrack()->setWaveformSummary(m_waveformSummary);
@@ -98,16 +98,16 @@ bool AnalyzerWaveform::initialize(const AnalyzerTrack& track,
     return true;
 }
 
-bool AnalyzerWaveform::shouldAnalyze(TrackPointer tio) const {
-    ConstWaveformPointer pTrackWaveform = tio->getWaveform();
-    ConstWaveformPointer pTrackWaveformSummary = tio->getWaveformSummary();
+bool AnalyzerWaveform::shouldAnalyze(TrackPointer pTrack) const {
+    ConstWaveformPointer pTrackWaveform = pTrack->getWaveform();
+    ConstWaveformPointer pTrackWaveformSummary = pTrack->getWaveformSummary();
     ConstWaveformPointer pLoadedTrackWaveform;
     ConstWaveformPointer pLoadedTrackWaveformSummary;
 #ifdef __STEM__
-    bool isStemTrack = !tio->getStemInfo().isEmpty();
+    bool isStemTrack = !pTrack->getStemInfo().isEmpty();
 #endif
 
-    TrackId trackId = tio->getId();
+    TrackId trackId = pTrack->getId();
     bool missingWaveform = pTrackWaveform.isNull();
     bool missingWavesummary = pTrackWaveformSummary.isNull();
 
@@ -162,10 +162,10 @@ bool AnalyzerWaveform::shouldAnalyze(TrackPointer tio) const {
     if (!missingWaveform && !missingWavesummary) {
         kLogger.debug() << "loadStored - Stored waveform loaded";
         if (pLoadedTrackWaveform) {
-            tio->setWaveform(pLoadedTrackWaveform);
+            pTrack->setWaveform(pLoadedTrackWaveform);
         }
         if (pLoadedTrackWaveformSummary) {
-            tio->setWaveformSummary(pLoadedTrackWaveformSummary);
+            pTrack->setWaveformSummary(pLoadedTrackWaveformSummary);
         }
         return false;
     }
@@ -321,15 +321,14 @@ void AnalyzerWaveform::cleanup() {
     m_waveformSummaryData = nullptr;
 }
 
-void AnalyzerWaveform::storeResults(TrackPointer tio) {
+void AnalyzerWaveform::storeResults(TrackPointer pTrack) {
     // Force completion to waveform size
     if (m_waveform) {
         m_waveform->setSaveState(Waveform::SaveState::SavePending);
         m_waveform->setCompletion(m_waveform->getDataSize());
         m_waveform->setVersion(WaveformFactory::currentWaveformVersion());
         m_waveform->setDescription(WaveformFactory::currentWaveformDescription());
     }
-    tio->setWaveform(m_waveform);
 
     // Force completion to waveform size
     if (m_waveformSummary) {
@@ -338,7 +337,6 @@ void AnalyzerWaveform::storeResults(TrackPointer tio) {
         m_waveformSummary->setVersion(WaveformFactory::currentWaveformSummaryVersion());
         m_waveformSummary->setDescription(WaveformFactory::currentWaveformSummaryDescription());
     }
-    tio->setWaveformSummary(m_waveformSummary);
 
 #ifdef TEST_HEAT_MAP
     test_heatMap->save("heatMap.png");
@@ -349,11 +347,16 @@ void AnalyzerWaveform::storeResults(TrackPointer tio) {
     // and then it is not called. The other analyzers have signals which control
     // the update of their data.
     m_analysisDao.saveTrackAnalyses(
-            tio->getId(),
+            pTrack->getId(),
             m_waveform,
             m_waveformSummary);
 
-    kLogger.debug() << "Waveform generation for track" << tio->getId() << "done"
+    // Set waveforms on track AFTER they'been written to disk in order to have
+    // a consistency when OverviewCache asks AnalysisDAO for a waveform summary.
+    pTrack->setWaveform(m_waveform);
+    pTrack->setWaveformSummary(m_waveformSummary);
+
+    kLogger.debug() << "Waveform generation for track" << pTrack->getId() << "done"
                     << m_timer.elapsed().debugSecondsWithUnit();
 }
 

src/coreservices.cpp

@@ -21,6 +21,7 @@
 #include "library/coverartcache.h"
 #include "library/library.h"
 #include "library/library_prefs.h"
+#include "library/overviewcache.h"
 #include "library/trackcollection.h"
 #include "library/trackcollectionmanager.h"
 #include "mixer/playerinfo.h"
@@ -372,6 +373,12 @@ void CoreServices::initialize(QApplication* pApp) {
             m_pPlayerManager.get(),
             m_pRecordingManager.get());
 
+    OverviewCache* pOverviewCache = OverviewCache::createInstance(pConfig, m_pDbConnectionPool);
+    connect(&(m_pTrackCollectionManager->internalCollection()->getTrackDAO()),
+            &TrackDAO::waveformSummaryUpdated,
+            pOverviewCache,
+            &OverviewCache::onTrackSummaryChanged);
+
     // Binding the PlayManager to the Library may already trigger
     // loading of tracks which requires that the GlobalTrackCache has
     // been created. Otherwise Mixxx might hang when accessing

src/library/analysis/analysisfeature.cpp

@@ -160,6 +160,15 @@ void AnalysisFeature::analyzeTracks(const QList<AnalyzerScheduledTrack>& tracks)
                 &TrackAnalysisScheduler::finished,
                 this,
                 &AnalysisFeature::onTrackAnalysisSchedulerFinished);
+        // Forward the signal to be picked up by Library.
+        // Used by WOverview to render the re-analysis progress of loaded tracks.
+        // This is the equivalent to PlayerManager's progress signal fired for
+        // analysis triggered by loading a track.
+        connect(m_pTrackAnalysisScheduler.get(),
+                &TrackAnalysisScheduler::trackProgress,
+                this,
+                &AnalysisFeature::trackProgress,
+                Qt::DirectConnection);
 
         emit analysisActive(true);
     }

src/library/analysis/analysisfeature.h

@@ -34,6 +34,7 @@ class AnalysisFeature : public LibraryFeature {
 
   signals:
     void analysisActive(bool bActive);
+    void trackProgress(TrackId trackId, AnalyzerProgress progress);
 
   public slots:
     void activate() override;

src/library/basesqltablemodel.cpp

@@ -767,6 +767,8 @@ bool BaseSqlTableModel::setTrackValueForColumn(
         pTrack->setBpmLocked(value.toBool());
     } else {
         // We never should get up to this point!
+        // Might happen editing read-only column values, so make sure to return
+        // the read-only flags for those in BaseTrackTableModel::readWriteFlags().
         qWarning() << "Column"
                    << columnNameForFieldIndex(column)
                    << "is not editable!";

src/library/basetracktablemodel.cpp

@@ -16,6 +16,7 @@
 #include "library/tabledelegates/keydelegate.h"
 #include "library/tabledelegates/locationdelegate.h"
 #include "library/tabledelegates/multilineeditdelegate.h"
+#include "library/tabledelegates/overviewdelegate.h"
 #include "library/tabledelegates/previewbuttondelegate.h"
 #include "library/tabledelegates/stardelegate.h"
 #include "library/trackcollection.h"
@@ -71,6 +72,7 @@ const QStringList kDefaultTableColumns = {
         LIBRARYTABLE_TITLE,
         LIBRARYTABLE_TRACKNUMBER,
         LIBRARYTABLE_YEAR,
+        LIBRARYTABLE_WAVESUMMARYHEX,
 };
 
 inline QSqlDatabase cloneDatabase(
@@ -256,6 +258,9 @@ void BaseTrackTableModel::initHeaderProperties() {
             ColumnCache::COLUMN_TRACKLOCATIONSTABLE_LOCATION,
             tr("Location"),
             defaultColumnWidth() * 6);
+    setHeaderProperties(ColumnCache::COLUMN_LIBRARYTABLE_WAVESUMMARYHEX,
+            tr("Overview"),
+            defaultColumnWidth() * 8);
     setHeaderProperties(
             ColumnCache::COLUMN_LIBRARYTABLE_PREVIEW,
             tr("Preview"),
@@ -517,7 +522,7 @@ QAbstractItemDelegate* BaseTrackTableModel::delegateForColumn(
                 new CoverArtDelegate(pTableView);
         // WLibraryTableView -> CoverArtDelegate
         connect(pTableView,
-                &WLibraryTableView::onlyCachedCoverArt,
+                &WLibraryTableView::onlyCachedCoversAndOverviews,
                 pCoverArtDelegate,
                 &CoverArtDelegate::slotInhibitLazyLoading);
         // CoverArtDelegate -> BaseTrackTableModel
@@ -528,6 +533,17 @@ QAbstractItemDelegate* BaseTrackTableModel::delegateForColumn(
         return pCoverArtDelegate;
     } else if (index == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_KEY)) {
         return new KeyDelegate(pTableView);
+    } else if (index == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_WAVESUMMARYHEX)) {
+        auto* pOverviewDelegate = new OverviewDelegate(pTableView);
+        connect(pOverviewDelegate,
+                &OverviewDelegate::overviewRowsChanged,
+                this,
+                &BaseTrackTableModel::slotRefreshOverviewRows);
+        connect(pTableView,
+                &WLibraryTableView::onlyCachedCoversAndOverviews,
+                pOverviewDelegate,
+                &OverviewDelegate::slotInhibitLazyLoading);
+        return pOverviewDelegate;
     }
     return nullptr;
 }
@@ -1090,7 +1106,8 @@ Qt::ItemFlags BaseTrackTableModel::readWriteFlags(
             column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_FILETYPE) ||
             column == fieldIndex(ColumnCache::COLUMN_TRACKLOCATIONSTABLE_LOCATION) ||
             column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_REPLAYGAIN) ||
-            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_SAMPLERATE)) {
+            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_SAMPLERATE) ||
+            column == fieldIndex(ColumnCache::COLUMN_LIBRARYTABLE_WAVESUMMARYHEX)) {
         return readOnlyFlags(index);
     }
 
@@ -1192,6 +1209,17 @@ void BaseTrackTableModel::slotRefreshCoverRows(
     emitDataChangedForMultipleRowsInColumn(rows, column);
 }
 
+void BaseTrackTableModel::slotRefreshOverviewRows(const QList<int>& rows) {
+    if (rows.isEmpty()) {
+        return;
+    }
+    const int column = fieldIndex(LIBRARYTABLE_WAVESUMMARYHEX);
+    VERIFY_OR_DEBUG_ASSERT(column >= 0) {
+        return;
+    }
+    emitDataChangedForMultipleRowsInColumn(rows, column);
+}
+
 void BaseTrackTableModel::slotRefreshAllRows() {
     select();
 }