GSoC 2020: Mixxx Macros [Moved]

CMakeLists.txt

@@ -601,6 +601,7 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/engine/controls/enginecontrol.cpp
   src/engine/controls/keycontrol.cpp
   src/engine/controls/loopingcontrol.cpp
+  src/engine/controls/macrocontrol.cpp
   src/engine/controls/quantizecontrol.cpp
   src/engine/controls/ratecontrol.cpp
   src/engine/effects/engineeffect.cpp
@@ -659,6 +660,7 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/library/dao/cuedao.cpp
   src/library/dao/directorydao.cpp
   src/library/dao/libraryhashdao.cpp
+  src/library/dao/macrodao.cpp
   src/library/dao/playlistdao.cpp
   src/library/dao/settingsdao.cpp
   src/library/dao/trackdao.cpp
@@ -785,6 +787,7 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/preferences/settingsmanager.cpp
   src/preferences/upgrade.cpp
   src/recording/recordingmanager.cpp
+  src/recording/recordingmanagerbase.cpp
   src/qml/asyncimageprovider.cpp
   src/qml/qmlapplication.cpp
   src/qml/qmlcontrolproxy.cpp
@@ -832,6 +835,8 @@ add_library(mixxx-lib STATIC EXCLUDE_FROM_ALL
   src/track/keyfactory.cpp
   src/track/keys.cpp
   src/track/keyutils.cpp
+  src/track/macro.cpp
+  src/track/macroaction.cpp
   src/track/playcounter.cpp
   src/track/replaygain.cpp
   src/track/serato/beatgrid.cpp
@@ -1620,6 +1625,11 @@ add_executable(mixxx-test
   src/test/libraryscannertest.cpp
   src/test/librarytest.cpp
   src/test/looping_control_test.cpp
+  src/test/macros/macrocontrol_test.cpp
+  src/test/macros/macrodao_test.cpp
+  src/test/macros/macrorecording_test.cpp
+  src/test/macros/macroplayback_test.cpp
+  src/test/macros/macro_test.cpp
   src/test/main.cpp
   src/test/mathutiltest.cpp
   src/test/metadatatest.cpp

res/schema.xml

@@ -582,4 +582,18 @@ reapplying those migrations.
       UPDATE library SET filetype='aiff' WHERE filetype='aif';
     </sql>
   </revision>
+  <revision version="40" min_compatible="3">
+    <description>
+      Add Macros
+    </description>
+    <sql>
+      CREATE TABLE IF NOT EXISTS macros (
+        id INTEGER PRIMARY KEY,
+        track_id INTEGER NOT NULL REFERENCES library(id),
+        slot INTEGER,
+        label TEXT,
+        state INTEGER,
+        content BLOB);
+    </sql>
+  </revision>
 </schema>

res/skins/LateNight/macros/macro.xml

@@ -0,0 +1,99 @@
+<Template>
+  <SetVariable name="MacroPrefix"><Variable name="Group"/>,macro_<Variable name="MacroSlot"/>_</SetVariable>
+
+  <WidgetGroup>
+    <ObjectName>Macro</ObjectName>
+    <Layout>horizontal</Layout>
+    <SizePolicy>me,min</SizePolicy>
+    <Children>
+      <PushButton>
+        <!--<TooltipId>macro_activate_toggle</TooltipId>-->
+        <ObjectName>MacroActivate</ObjectName>
+        <Size>34f,34f</Size>
+        <NumberStates>1</NumberStates>
+        <Connection>
+          <ConfigKey><Variable name="MacroPrefix"/>activate</ConfigKey>
+          <ConnectValueToWidget>false</ConnectValueToWidget>
+          <ButtonState>LeftButton</ButtonState>
+        </Connection>
+        <Connection>
+          <ConfigKey><Variable name="MacroPrefix"/>toggle</ConfigKey>
+          <ConnectValueToWidget>false</ConnectValueToWidget>
+          <ButtonState>RightButton</ButtonState>
+        </Connection>
+        <Connection>
+          <ConfigKey><Variable name="MacroPrefix"/>status</ConfigKey>
+          <ConnectValueFromWidget>false</ConnectValueFromWidget>
+        </Connection>
+      </PushButton>
+
+      <WidgetGroup>
+        <ObjectName></ObjectName>
+        <Layout>vertical</Layout>
+        <Size>0me,36f</Size>
+        <Children>
+
+          <WidgetGroup>
+            <ObjectName>SamplerTitleBoxMini</ObjectName>
+            <Layout>horizontal</Layout>
+            <SizePolicy>i,f</SizePolicy>
+            <MinimumSize>,18</MinimumSize>
+            <Children>
+              <Label>
+                <ObjectName>SamplerTitleMini</ObjectName>
+                <SizePolicy>me,me</SizePolicy>
+                <Elide>right</Elide>
+                <Text>Macro <Variable name="MacroSlot"/></Text>
+                <Connection>
+                  <ConfigKey><Variable name="MacroPrefix"/>status</ConfigKey>
+                  <BindProperty>Text</BindProperty>
+                </Connection>
+              </Label>
+            </Children>
+          </WidgetGroup>
+
+          <WidgetGroup>
+            <ObjectName>SamplerBPMSettingsMini</ObjectName>
+            <Layout>horizontal</Layout>
+            <Size>,18f</Size>
+            <Children>
+              <TrackProperty>
+                <ObjectName>SamplerBpm</ObjectName>
+                <SizePolicy>me,me</SizePolicy>
+                <Property>title</Property>
+                <Group><Variable name="Group"/></Group>
+                <Elide>right</Elide>
+              </TrackProperty>
+
+              <PushButton>
+                <!--<SetVariable name="TooltipId">macro_clear</SetVariable>-->
+                <ObjectName>EjectButton12</ObjectName>
+                <Size>21f,18f</Size>
+                <NumberStates>1</NumberStates>
+                <State>
+                  <Number>0</Number>
+                  <Unpressed scalemode="STRETCH">skin:/<Variable name="BtnScheme"/>/buttons/btn_<Variable name="BtnType"/>_<Variable name="BtnSize"/>.svg</Unpressed>
+                  <Pressed scalemode="STRETCH">skin:/<Variable name="BtnScheme"/>/buttons/btn_<Variable name="BtnType"/>_<Variable name="BtnSize"/>_active.svg</Pressed>
+                </State>
+                <Connection>
+                  <ConfigKey><Variable name="MacroPrefix"/>clear</ConfigKey>
+                </Connection>
+                <Connection>
+                  <ConfigKey><Variable name="MacroPrefix"/>status</ConfigKey>
+                  <Transform><IsEqual>3</IsEqual></Transform>
+                  <BindProperty>visible</BindProperty>
+                </Connection>
+              </PushButton>
+            </Children>
+            <Connection>
+              <ConfigKey><Variable name="Group"/>,track_loaded</ConfigKey>
+              <BindProperty>visible</BindProperty>
+            </Connection>
+          </WidgetGroup><!-- SamplerBPMSettingsMini -->
+
+        </Children>
+      </WidgetGroup><!-- SamplerMiniControls -->
+
+    </Children>
+  </WidgetGroup><!-- SamplerMini -->
+</Template>

res/skins/LateNight/macros/macros_channel.xml

@@ -0,0 +1,20 @@
+<Template>
+  <WidgetGroup>
+    <Layout>horizontal</Layout>
+    <SizePolicy>me,max</SizePolicy>
+    <Children>
+      <Template src="skin:/macros/macro.xml">
+        <SetVariable name="MacroSlot">1</SetVariable>
+      </Template>
+      <Template src="skin:/macros/macro.xml">
+        <SetVariable name="MacroSlot">2</SetVariable>
+      </Template>
+      <Template src="skin:/macros/macro.xml">
+        <SetVariable name="MacroSlot">3</SetVariable>
+      </Template>
+      <Template src="skin:/macros/macro.xml">
+        <SetVariable name="MacroSlot">4</SetVariable>
+      </Template>
+    </Children>
+  </WidgetGroup>
+</Template>

res/skins/LateNight/macros_rack.xml

@@ -0,0 +1,14 @@
+<Template>
+  <WidgetGroup>
+    <Layout>horizontal</Layout>
+    <SizePolicy>me,max</SizePolicy>
+    <Children>
+      <Template src="skin:/macros/macros_channel.xml">
+        <SetVariable name="Group">[Channel1]</SetVariable>
+      </Template>
+      <Template src="skin:/macros/macros_channel.xml">
+        <SetVariable name="Group">[Channel2]</SetVariable>
+      </Template>
+    </Children>
+  </WidgetGroup>
+</Template>

res/skins/LateNight/skin.xml

@@ -457,6 +457,7 @@
                           </Children>
                         </WidgetGroup>
 
+                        <Template src="skin:macros_rack.xml"/>
                         <Template src="skin:fx_rack.xml"/>
                         <Template src="skin:samplers_rack.xml"/>
                         <Template src="skin:mic_aux_rack.xml"/>

src/coreservices.cpp

@@ -286,8 +286,8 @@ void CoreServices::initialize(QApplication* pApp) {
     m_pPlayerManager = std::make_shared<PlayerManager>(
             pConfig,
             m_pSoundManager.get(),
-            m_pEffectsManager.get(),
-            m_pEngine.get());
+            m_pEngine.get(),
+            m_pEffectsManager.get());
     // TODO: connect input not configured error dialog slots
     PlayerInfo::create();
 

src/database/mixxxdb.cpp

@@ -12,7 +12,7 @@
 const QString MixxxDb::kDefaultSchemaFile(":/schema.xml");
 
 //static
-const int MixxxDb::kRequiredSchemaVersion = 39;
+const int MixxxDb::kRequiredSchemaVersion = 40;
 
 namespace {
 

src/database/mixxxdb.h

@@ -3,10 +3,8 @@
 #include <QSqlDatabase>
 
 #include "preferences/usersettings.h"
-
 #include "util/db/dbconnectionpool.h"
 
-
 class MixxxDb : public QObject {
     Q_OBJECT
 

src/engine/channels/enginedeck.cpp

@@ -17,7 +17,9 @@ EngineDeck::EngineDeck(
         EffectsManager* pEffectsManager,
         EngineChannel::ChannelOrientation defaultOrientation,
         bool primaryDeck)
-        : EngineChannel(handleGroup, defaultOrientation, pEffectsManager,
+        : EngineChannel(handleGroup,
+                  defaultOrientation,
+                  pEffectsManager,
                   /*isTalkoverChannel*/ false,
                   primaryDeck),
           m_pConfig(pConfig),

src/engine/channels/enginedeck.h

@@ -11,13 +11,13 @@
 
 #include "soundio/soundmanagerutil.h"
 
+class ControlPushButton;
 class EngineBuffer;
 class EnginePregain;
 class EngineBuffer;
 class EngineMaster;
 class EngineVuMeter;
 class EngineEffectsManager;
-class ControlPushButton;
 
 class EngineDeck : public EngineChannel, public AudioDestination {
     Q_OBJECT

src/engine/controls/cuecontrol.cpp

@@ -1,5 +1,8 @@
 #include "engine/controls/cuecontrol.h"
 
+#include <QDebug>
+#include <QtCore>
+
 #include "control/controlindicator.h"
 #include "control/controlobject.h"
 #include "control/controlpushbutton.h"
@@ -2528,6 +2531,7 @@ void HotcueControl::slotHotcueCueLoop(double v) {
 }
 
 void HotcueControl::slotHotcueActivate(double v) {
+    qCDebug(QLoggingCategory("macros")) << "hotcue" << m_hotcueIndex + 1 << "activated:" << v;
     emit hotcueActivate(this, v, HotcueSetMode::Auto);
 }
 

src/engine/controls/enginecontrol.h

@@ -9,7 +9,6 @@
 #include "control/controlvalue.h"
 #include "engine/cachingreader/cachingreader.h"
 #include "engine/effects/groupfeaturestate.h"
-#include "engine/sync/syncable.h"
 #include "preferences/usersettings.h"
 #include "track/beats.h"
 #include "track/track_decl.h"
@@ -42,17 +41,17 @@ class EngineControl : public QObject {
             UserSettingsPointer pConfig);
     ~EngineControl() override;
 
-    // Called by EngineBuffer::process every latency period. See the above
-    // comments for information about guarantees that hold during this call. An
-    // EngineControl can perform any upkeep operations that are necessary during
-    // this call.
+    /// Called by EngineBuffer::process every latency period.
+    /// See the above comments for information about guarantees that hold during this call.
+    /// An EngineControl can perform any upkeep operations necessary here.
+    /// @param dRate current playback rate in audio frames per second
     virtual void process(const double dRate,
             mixxx::audio::FramePos currentPosition,
             const int iBufferSize);
 
-    // hintReader allows the EngineControl to provide hints to the reader to
-    // indicate that the given portion of a song is a potential imminent seek
-    // target.
+    /// hintReader allows the EngineControl to provide hints to the reader
+    /// to indicate that the given portion of a song
+    /// is a potential imminent seek target.
     virtual void hintReader(HintVector* pHintList);
 
     virtual void setEngineMaster(EngineMaster* pEngineMaster);
@@ -67,7 +66,7 @@ class EngineControl : public QObject {
             mixxx::audio::FramePos endPosition,
             bool enabled);
 
-    // Called to collect player features for effects processing.
+    /// Collect player features for effects processing.
     virtual void collectFeatureState(GroupFeatureState* pGroupFeatures) const {
         Q_UNUSED(pGroupFeatures);
     }
@@ -97,9 +96,10 @@ class EngineControl : public QObject {
     }
     void seek(double fractionalPosition);
     void seekAbs(mixxx::audio::FramePos position);
-    // Seek to an exact sample and don't allow quantizing adjustment.
-    void seekExact(mixxx::audio::FramePos position);
-    // Returns an EngineBuffer to target for syncing. Returns nullptr if none found
+    /// Seek to an exact frame, no quantizing
+    /// virtual only for tests!
+    virtual void seekExact(mixxx::audio::FramePos position);
+    /// Return an EngineBuffer to target for syncing. Returns nullptr if none found.
     EngineBuffer* pickSyncTarget();
 
     UserSettingsPointer getConfig();