Show a Sub Mixer's tracks in the Device Rack

- List the tracks its member devices play on

- Give the track list more room before eliding it

Author: juzzlin

CHANGELOG

@@ -193,6 +193,11 @@ Bug fixes:
 * Speech's Line mode now fits a line to its note in a render as well as in
   playback, having always fallen back to Length when rendering
 
+Other:
+
+* The Device Rack lists the tracks a Sub Mixer carries, and gives the track
+  list more room before cutting it short
+
 8.0.0
 =====
 

src/unit_tests/device_rack_controller_test/device_rack_controller_test.cpp

@@ -265,6 +265,57 @@ void DeviceRackControllerTest::test_subMixerCandidates_shouldCarryTrackNames()
     QVERIFY(!entry["typeName"].toString().isEmpty());
 }
 
+void DeviceRackControllerTest::test_usageSummary_device_shouldReturnTrackNames()
+{
+    const auto audioEngine = std::make_shared<AudioEngine>();
+    const auto deviceService = std::make_shared<DeviceService>(audioEngine, std::make_shared<DataService>());
+    const auto deviceName = "Device 1";
+    deviceService->setDevice(0, std::make_shared<MockDevice>(deviceName));
+
+    const auto editorService = std::make_shared<MockEditorService>();
+    editorService->setMockIndices({ 0 });
+    editorService->setMockTrackName(0, "Drums");
+    editorService->setMockInstrumentPortName(0, QString::fromStdString(deviceName));
+
+    DeviceRackController controller { deviceService, {}, editorService };
+
+    QCOMPARE(controller.usageSummary(0), QString { "Drums" });
+}
+
+void DeviceRackControllerTest::test_usageSummary_subMixer_shouldReturnMemberTrackNames()
+{
+    const auto audioEngine = std::make_shared<AudioEngine>();
+    const auto deviceService = std::make_shared<DeviceService>(audioEngine, std::make_shared<DataService>());
+    deviceService->setDevice(0, std::make_shared<MockDevice>("Device 1"));
+    deviceService->setDevice(1, std::make_shared<MockDevice>("Device 2"));
+    deviceService->setDevice(2, std::make_shared<MockDevice>("Device 3"));
+    deviceService->setDevice(3, std::make_shared<SubMixerDevice>("Inner"));
+    deviceService->setDevice(4, std::make_shared<SubMixerDevice>("Outer"));
+
+    const auto editorService = std::make_shared<MockEditorService>();
+    editorService->setMockIndices({ 0, 1, 2, 3 });
+    editorService->setMockTrackName(0, "Drums");
+    editorService->setMockInstrumentPortName(0, "Device 1");
+    editorService->setMockTrackName(1, "Bass");
+    editorService->setMockInstrumentPortName(1, "Device 2");
+    editorService->setMockTrackName(2, "Bass, doubled");
+    editorService->setMockInstrumentPortName(2, "Device 2");
+    editorService->setMockTrackName(3, "Pads");
+    editorService->setMockInstrumentPortName(3, "Device 3");
+
+    DeviceRackController controller { deviceService, {}, editorService };
+
+    QCOMPARE(controller.usageSummary(4), QString {});
+
+    QVERIFY(controller.addSubMixerMember(3, 2));
+    QVERIFY(controller.addSubMixerMember(4, 0));
+    QVERIFY(controller.addSubMixerMember(4, 1));
+    QVERIFY(controller.addSubMixerMember(4, 3));
+    QCOMPARE(controller.usageSummary(3), QString { "Pads" });
+    // A nested SubMixer contributes the tracks of its own members.
+    QCOMPARE(controller.usageSummary(4), QString { "Drums, Bass, Bass, doubled, Pads" });
+}
+
 void DeviceRackControllerTest::test_deviceGain_shouldDefaultToUnityAndRoundTrip()
 {
     const auto audioEngine = std::make_shared<AudioEngine>();

src/unit_tests/device_rack_controller_test/device_rack_controller_test.hpp

@@ -31,6 +31,8 @@ private slots:
     void test_devices_shouldReturnDeviceNames();
     void test_trackNames_shouldReturnTrackNamesForDevice();
     void test_subMixerCandidates_shouldCarryTrackNames();
+    void test_usageSummary_device_shouldReturnTrackNames();
+    void test_usageSummary_subMixer_shouldReturnMemberTrackNames();
     void test_deviceGain_shouldDefaultToUnityAndRoundTrip();
     void test_setDevice_shouldAddDeviceAndNotify();
     void test_replaceDevice_shouldKeepInsertEffectsAndNotify();

src/view/controllers/device_rack_controller.cpp

@@ -462,19 +462,43 @@ QString DeviceRackController::deviceName(int slotIndex) const
     return "";
 }
 
-QString DeviceRackController::trackNames(int slotIndex) const
+QStringList DeviceRackController::trackNameList(int slotIndex) const
 {
+    QStringList trackNames;
     if (const auto device = m_deviceService->device(static_cast<size_t>(slotIndex))) {
         const auto deviceName = QString::fromStdString(device->name());
-        QStringList trackNames;
         for (const auto index : m_editorService->trackIndices()) {
             if (const auto portName = m_editorService->instrumentPortName(index); portName == deviceName) {
                 trackNames << m_editorService->trackName(index);
             }
         }
-        return trackNames.join(", ");
     }
-    return "";
+    return trackNames;
+}
+
+QString DeviceRackController::trackNames(int slotIndex) const
+{
+    return trackNameList(slotIndex).join(", ");
+}
+
+QStringList DeviceRackController::usageTrackNames(int slotIndex) const
+{
+    // A SubMixer plays nothing itself; what it carries is whatever its members play, so it borrows
+    // their tracks, through any SubMixer nested inside it. DeviceService rules out cycles.
+    if (const auto subMixer = std::dynamic_pointer_cast<SubMixerDevice>(m_deviceService->device(static_cast<size_t>(slotIndex)))) {
+        QStringList names;
+        for (const auto memberSlot : subMixer->members()) {
+            names << usageTrackNames(static_cast<int>(memberSlot));
+        }
+        names.removeDuplicates();
+        return names;
+    }
+    return trackNameList(slotIndex);
+}
+
+QString DeviceRackController::usageSummary(int slotIndex) const
+{
+    return usageTrackNames(slotIndex).join(", ");
 }
 
 QVariantList DeviceRackController::availableDevices() const

src/view/controllers/device_rack_controller.hpp

@@ -89,6 +89,9 @@ class DeviceRackController : public QAbstractListModel
     Q_INVOKABLE QString deviceTypeName(int slotIndex) const;
     Q_INVOKABLE QString deviceName(int slotIndex) const;
     Q_INVOKABLE QString trackNames(int slotIndex) const;
+    //! What the Device Rack shows beside a device: the tracks it plays on, or for a SubMixer the
+    //! tracks its members play on.
+    Q_INVOKABLE QString usageSummary(int slotIndex) const;
     Q_INVOKABLE QVariantList availableDevices() const;
 
     //! Every occupied slot a SubMixer could take, with whether it already belongs to one.
@@ -193,6 +196,8 @@ class DeviceRackController : public QAbstractListModel
 
 private:
     QString trackNames(const QString & deviceName) const;
+    QStringList trackNameList(int slotIndex) const;
+    QStringList usageTrackNames(int slotIndex) const;
 
     //! Push the current gate onto every device's taps. Needed after any slot change, because a
     //! freshly created device starts with its meters off regardless of what is on screen.

src/view/qml/Dialogs/DeviceRackDialog.qml

@@ -102,9 +102,9 @@ AnimatedDialog {
                     deviceRackController.revision;
                     return deviceRackController.deviceName(index);
                 }
-                readonly property string trackNames: {
+                readonly property string usageSummary: {
                     deviceRackController.revision;
-                    return deviceRackController.trackNames(index);
+                    return deviceRackController.usageSummary(index);
                 }
                 readonly property var meterLevels: {
                     deviceListView.meterTick;
@@ -177,19 +177,29 @@ AnimatedDialog {
                         // The buttons and meters on the row have fixed widths, so the name is what
                         // gives way on a narrow rack instead of running over them
                         Layout.fillWidth: true
+                        Layout.preferredWidth: implicitWidth
                         Layout.minimumWidth: 0
                         elide: Text.ElideRight
                         visible: deviceType !== ""
                     }
 
                     Text {
-                        text: trackNames
+                        text: usageSummary
                         color: "#aaa"
                         font.pointSize: 11
-                        Layout.preferredWidth: 150
+                        // Shares the slack with the name in proportion to their lengths, so a long
+                        // list of tracks is not cut to a fixed stub while the name has room to spare
+                        Layout.fillWidth: true
+                        Layout.preferredWidth: implicitWidth
+                        Layout.minimumWidth: 0
                         horizontalAlignment: Text.AlignRight
                         elide: Text.ElideRight
                         visible: deviceType !== ""
+                        ToolTip.visible: truncated && summaryHover.hovered
+                        ToolTip.text: usageSummary
+                        HoverHandler {
+                            id: summaryHover
+                        }
                     }
 
                     Image {