Merge pull request #4668 from ywwg/eject-undo

Implement Un-eject

CMakeLists.txt

@@ -1658,6 +1658,7 @@ add_executable(mixxx-test
   src/test/nativeeffects_test.cpp
   src/test/performancetimer_test.cpp
   src/test/playcountertest.cpp
+  src/test/playermanagertest.cpp
   src/test/playlisttest.cpp
   src/test/portmidicontroller_test.cpp
   src/test/portmidienumeratortest.cpp

src/engine/enginebuffer.cpp

@@ -185,11 +185,6 @@ EngineBuffer::EngineBuffer(const QString& group,
     m_pKeylock = new ControlPushButton(ConfigKey(m_group, "keylock"), true);
     m_pKeylock->setButtonMode(ControlPushButton::TOGGLE);
 
-    m_pEject = new ControlPushButton(ConfigKey(m_group, "eject"));
-    connect(m_pEject, &ControlObject::valueChanged,
-            this, &EngineBuffer::slotEjectTrack,
-            Qt::DirectConnection);
-
     m_pTrackLoaded = new ControlObject(ConfigKey(m_group, "track_loaded"), false);
     m_pTrackLoaded->setReadOnly();
 
@@ -325,7 +320,6 @@ EngineBuffer::~EngineBuffer() {
     delete m_pScaleRB;
 
     delete m_pKeylock;
-    delete m_pEject;
 
     SampleUtil::free(m_pCrossfadeBuffer);
 
@@ -1442,17 +1436,6 @@ TrackPointer EngineBuffer::getLoadedTrack() const {
     return m_pCurrentTrack;
 }
 
-void EngineBuffer::slotEjectTrack(double v) {
-    if (v > 0) {
-        // Don't allow rejections while playing a track. We don't need to lock to
-        // call ControlObject::get() so this is fine.
-        if (m_playButton->get() > 0) {
-            return;
-        }
-        ejectTrack();
-    }
-}
-
 mixxx::audio::FramePos EngineBuffer::getExactPlayPos() const {
     if (!m_visualPlayPos->isValid()) {
         return mixxx::audio::kStartFramePos;

src/engine/enginebuffer.h

@@ -122,6 +122,7 @@ class EngineBuffer : public EngineObject {
 
     bool isTrackLoaded() const;
     TrackPointer getLoadedTrack() const;
+    void ejectTrack();
 
     mixxx::audio::FramePos getExactPlayPos() const;
     double getVisualPlayPos() const;
@@ -174,8 +175,6 @@ class EngineBuffer : public EngineObject {
     void slotControlSeek(double);
     void slotKeylockEngineChanged(double);
 
-    void slotEjectTrack(double);
-
   signals:
     void trackLoaded(TrackPointer pNewTrack, TrackPointer pOldTrack);
     void trackLoadFailed(TrackPointer pTrack, const QString& reason);
@@ -207,8 +206,6 @@ class EngineBuffer : public EngineObject {
 
     void hintReader(const double rate);
 
-    void ejectTrack();
-
     double fractionalPlayposFromAbsolute(mixxx::audio::FramePos position);
 
     void doSeekFractional(double fractionalPos, enum SeekRequest seekType);
@@ -351,7 +348,6 @@ class EngineBuffer : public EngineObject {
     // thread, which is required to avoid segfaults.
     ControlProxy* m_pPassthroughEnabled;
 
-    ControlPushButton* m_pEject;
     ControlObject* m_pTrackLoaded;
 
     // Whether or not to repeat the track when at the end

src/mixer/auxiliary.cpp

@@ -7,9 +7,12 @@
 #include "soundio/soundmanager.h"
 #include "soundio/soundmanagerutil.h"
 
-Auxiliary::Auxiliary(QObject* pParent, const QString& group, int index,
-                     SoundManager* pSoundManager, EngineMaster* pEngine,
-                     EffectsManager* pEffectsManager)
+Auxiliary::Auxiliary(PlayerManager* pParent,
+        const QString& group,
+        int index,
+        SoundManager* pSoundManager,
+        EngineMaster* pEngine,
+        EffectsManager* pEffectsManager)
         : BasePlayer(pParent, group) {
     ChannelHandleAndGroup channelGroup = pEngine->registerChannelGroup(group);
     EngineAux* pAuxiliary = new EngineAux(channelGroup, pEffectsManager);

src/mixer/auxiliary.h

@@ -14,12 +14,12 @@ class SoundManager;
 class Auxiliary : public BasePlayer {
     Q_OBJECT
   public:
-    Auxiliary(QObject* pParent,
-              const QString& group,
-              int index,
-              SoundManager* pSoundManager,
-              EngineMaster* pMixingEngine,
-              EffectsManager* pEffectsManager);
+    Auxiliary(PlayerManager* pParent,
+            const QString& group,
+            int index,
+            SoundManager* pSoundManager,
+            EngineMaster* pMixingEngine,
+            EffectsManager* pEffectsManager);
     ~Auxiliary() override;
 
   signals:

src/mixer/baseplayer.cpp

@@ -2,7 +2,8 @@
 
 #include "moc_baseplayer.cpp"
 
-BasePlayer::BasePlayer(QObject* pParent, const QString& group)
+BasePlayer::BasePlayer(PlayerManager* pParent, const QString& group)
         : QObject(pParent),
+          m_pPlayerManager(pParent),
           m_group(group) {
 }

src/mixer/baseplayer.h

@@ -3,16 +3,21 @@
 #include <QObject>
 #include <QString>
 
+#include "mixer/playermanager.h"
+
 class BasePlayer : public QObject {
     Q_OBJECT
   public:
-    BasePlayer(QObject* pParent, const QString& group);
+    BasePlayer(PlayerManager* pParent, const QString& group);
     ~BasePlayer() override = default;
 
     inline const QString& getGroup() const {
         return m_group;
     }
 
+  protected:
+    PlayerManager* m_pPlayerManager;
+
   private:
     const QString m_group;
 };

src/mixer/basetrackplayer.cpp

@@ -33,12 +33,12 @@ inline double trackColorToDouble(mixxx::RgbColor::optional_t color) {
 }
 } // namespace
 
-BaseTrackPlayer::BaseTrackPlayer(QObject* pParent, const QString& group)
+BaseTrackPlayer::BaseTrackPlayer(PlayerManager* pParent, const QString& group)
         : BasePlayer(pParent, group) {
 }
 
 BaseTrackPlayerImpl::BaseTrackPlayerImpl(
-        QObject* pParent,
+        PlayerManager* pParent,
         UserSettingsPointer pConfig,
         EngineMaster* pMixingEngine,
         EffectsManager* pEffectsManager,
@@ -83,6 +83,13 @@ BaseTrackPlayerImpl::BaseTrackPlayerImpl(
             this,
             &BaseTrackPlayerImpl::slotLoadFailed);
 
+    m_pEject = std::make_unique<ControlPushButton>(ConfigKey(getGroup(), "eject"));
+    connect(m_pEject.get(),
+            &ControlObject::valueChanged,
+            this,
+            &BaseTrackPlayerImpl::slotEjectTrack,
+            Qt::DirectConnection);
+
     // Get loop point control objects
     m_pLoopInPoint = make_parented<ControlProxy>(
             getGroup(), "loop_start_position", this);
@@ -297,6 +304,26 @@ void BaseTrackPlayerImpl::loadTrack(TrackPointer pTrack) {
     connectLoadedTrack();
 }
 
+void BaseTrackPlayerImpl::slotEjectTrack(double v) {
+    if (v <= 0) {
+        return;
+    }
+    if (!m_pLoadedTrack) {
+        TrackPointer lastEjected = m_pPlayerManager->getLastEjectedTrack();
+        if (lastEjected) {
+            slotLoadTrack(lastEjected, false);
+        }
+        return;
+    }
+
+    // Don't allow rejections while playing a track. We don't need to lock to
+    // call ControlObject::get() so this is fine.
+    if (m_pPlay->toBool()) {
+        return;
+    }
+    m_pChannel->getEngineBuffer()->ejectTrack();
+}
+
 TrackPointer BaseTrackPlayerImpl::unloadTrack() {
     if (!m_pLoadedTrack) {
         // nothing to do
@@ -344,6 +371,7 @@ TrackPointer BaseTrackPlayerImpl::unloadTrack() {
 
     TrackPointer pUnloadedTrack(std::move(m_pLoadedTrack));
     DEBUG_ASSERT(!m_pLoadedTrack);
+    emit trackUnloaded(pUnloadedTrack);
     return pUnloadedTrack;
 }
 

src/mixer/basetrackplayer.h

@@ -32,7 +32,7 @@ class BaseTrackPlayer : public BasePlayer {
         RESET_SPEED
     };
 
-    BaseTrackPlayer(QObject* pParent, const QString& group);
+    BaseTrackPlayer(PlayerManager* pParent, const QString& group);
     ~BaseTrackPlayer() override = default;
 
     virtual TrackPointer getLoadedTrack() const = 0;
@@ -41,9 +41,11 @@ class BaseTrackPlayer : public BasePlayer {
     virtual void slotLoadTrack(TrackPointer pTrack, bool bPlay = false) = 0;
     virtual void slotCloneFromGroup(const QString& group) = 0;
     virtual void slotCloneDeck() = 0;
+    virtual void slotEjectTrack(double) = 0;
 
   signals:
     void newTrackLoaded(TrackPointer pLoadedTrack);
+    void trackUnloaded(TrackPointer pUnloadedTrack);
     void loadingTrack(TrackPointer pNewTrack, TrackPointer pOldTrack);
     void playerEmpty();
     void noVinylControlInputConfigured();
@@ -52,7 +54,7 @@ class BaseTrackPlayer : public BasePlayer {
 class BaseTrackPlayerImpl : public BaseTrackPlayer {
     Q_OBJECT
   public:
-    BaseTrackPlayerImpl(QObject* pParent,
+    BaseTrackPlayerImpl(PlayerManager* pParent,
             UserSettingsPointer pConfig,
             EngineMaster* pMixingEngine,
             EffectsManager* pEffectsManager,
@@ -76,6 +78,7 @@ class BaseTrackPlayerImpl : public BaseTrackPlayer {
 
   public slots:
     void slotLoadTrack(TrackPointer track, bool bPlay) final;
+    void slotEjectTrack(double) final;
     void slotCloneFromGroup(const QString& group) final;
     void slotCloneDeck() final;
     void slotTrackLoaded(TrackPointer pNewTrack, TrackPointer pOldTrack);
@@ -117,6 +120,8 @@ class BaseTrackPlayerImpl : public BaseTrackPlayer {
     bool m_replaygainPending;
     EngineChannel* m_pChannelToCloneFrom;
 
+    std::unique_ptr<ControlPushButton> m_pEject;
+
     // Deck clone control
     std::unique_ptr<ControlObject> m_pCloneFromDeck;
     std::unique_ptr<ControlObject> m_pCloneFromSampler;

src/mixer/deck.cpp

@@ -2,7 +2,7 @@
 
 #include "moc_deck.cpp"
 
-Deck::Deck(QObject* pParent,
+Deck::Deck(PlayerManager* pParent,
         UserSettingsPointer pConfig,
         EngineMaster* pMixingEngine,
         EffectsManager* pEffectsManager,

src/mixer/deck.h

@@ -7,7 +7,7 @@
 class Deck : public BaseTrackPlayerImpl {
     Q_OBJECT
   public:
-    Deck(QObject* pParent,
+    Deck(PlayerManager* pParent,
             UserSettingsPointer pConfig,
             EngineMaster* pMixingEngine,
             EffectsManager* pEffectsManager,

src/mixer/microphone.cpp

@@ -7,9 +7,12 @@
 #include "soundio/soundmanager.h"
 #include "soundio/soundmanagerutil.h"
 
-Microphone::Microphone(QObject* pParent, const QString& group, int index,
-                       SoundManager* pSoundManager, EngineMaster* pEngine,
-                       EffectsManager* pEffectsManager)
+Microphone::Microphone(PlayerManager* pParent,
+        const QString& group,
+        int index,
+        SoundManager* pSoundManager,
+        EngineMaster* pEngine,
+        EffectsManager* pEffectsManager)
         : BasePlayer(pParent, group) {
     ChannelHandleAndGroup channelGroup = pEngine->registerChannelGroup(group);
     EngineMicrophone* pMicrophone =

src/mixer/microphone.h

@@ -14,12 +14,12 @@ class SoundManager;
 class Microphone : public BasePlayer {
     Q_OBJECT
   public:
-    Microphone(QObject* pParent,
-               const QString& group,
-               int index,
-               SoundManager* pSoundManager,
-               EngineMaster* pMixingEngine,
-               EffectsManager* pEffectsManager);
+    Microphone(PlayerManager* pParent,
+            const QString& group,
+            int index,
+            SoundManager* pSoundManager,
+            EngineMaster* pMixingEngine,
+            EffectsManager* pEffectsManager);
     ~Microphone() override;
 
   signals:

src/mixer/playermanager.cpp

@@ -6,7 +6,6 @@
 #include "effects/effectsmanager.h"
 #include "engine/channels/enginedeck.h"
 #include "engine/enginemaster.h"
-#include "library/library.h"
 #include "mixer/auxiliary.h"
 #include "mixer/deck.h"
 #include "mixer/microphone.h"
@@ -163,6 +162,7 @@ PlayerManager::~PlayerManager() {
 }
 
 void PlayerManager::bindToLibrary(Library* pLibrary) {
+    m_pLibrary = pLibrary;
     const auto locker = lockMutex(&m_mutex);
     connect(pLibrary, &Library::loadTrackToPlayer, this, &PlayerManager::slotLoadTrackToPlayer);
     connect(pLibrary,
@@ -411,6 +411,10 @@ void PlayerManager::addDeckInner() {
             &BaseTrackPlayer::noVinylControlInputConfigured,
             this,
             &PlayerManager::noVinylControlInputConfigured);
+    connect(pDeck,
+            &BaseTrackPlayer::trackUnloaded,
+            this,
+            &PlayerManager::slotSaveEjectedTrack);
 
     if (m_pTrackAnalysisScheduler) {
         connect(pDeck,
@@ -469,6 +473,10 @@ void PlayerManager::addSamplerInner() {
                 this,
                 &PlayerManager::slotAnalyzeTrack);
     }
+    connect(pSampler,
+            &BaseTrackPlayer::trackUnloaded,
+            this,
+            &PlayerManager::slotSaveEjectedTrack);
 
     m_players[handleGroup.handle()] = pSampler;
     m_samplers.append(pSampler);
@@ -590,6 +598,13 @@ Sampler* PlayerManager::getSampler(unsigned int sampler) const {
     return m_samplers[sampler - 1];
 }
 
+TrackPointer PlayerManager::getLastEjectedTrack() const {
+    if (m_pLibrary) {
+        return m_pLibrary->trackCollectionManager()->getTrackById(m_lastEjectedTrackId);
+    }
+    return nullptr;
+}
+
 Microphone* PlayerManager::getMicrophone(unsigned int microphone) const {
     const auto locker = lockMutex(&m_mutex);
     if (microphone < 1 || microphone >= static_cast<unsigned int>(m_microphones.size())) {
@@ -729,6 +744,13 @@ void PlayerManager::slotAnalyzeTrack(TrackPointer track) {
     }
 }
 
+void PlayerManager::slotSaveEjectedTrack(TrackPointer track) {
+    VERIFY_OR_DEBUG_ASSERT(track) {
+        return;
+    }
+    m_lastEjectedTrackId = track->getId();
+}
+
 void PlayerManager::onTrackAnalysisProgress(TrackId trackId, AnalyzerProgress analyzerProgress) {
     emit trackAnalyzerProgress(trackId, analyzerProgress);
 }