Some changes to device name/alias getter and setters

Author: julianstorer

modules/tracktion_engine/model/tracks/tracktion_TrackOutput.cpp

@@ -205,7 +205,7 @@ juce::String TrackOutput::getDescriptiveOutputName() const
     }
 
     if (auto dev = getOutputDevice (false))
-        return dev->getAlias();
+        return dev->getAliasOrName();
 
     return outputDevice;
 }
@@ -288,7 +288,7 @@ void TrackOutput::getPossibleOutputDeviceNames (const juce::Array<AudioTrack*>&
                 }
 
                 s.add (out->getName());
-                a.add (out->getAlias());
+                a.add (out->getAliasOrName());
             }
         }
     }

modules/tracktion_engine/playback/devices/tracktion_IODevice.cpp

@@ -26,38 +26,39 @@ juce::String IODevice::getAliasPropName() const
     return "devicealias_" + deviceID;
 }
 
-juce::String IODevice::getAlias() const
+juce::String IODevice::getAliasOrName() const
 {
-    if (alias.isNotEmpty())
-        return alias;
+    return alias.isNotEmpty() ? alias : name;
+}
 
-    return getName();
+juce::String IODevice::getAliasIfSet() const
+{
+    return alias;
 }
 
 void IODevice::setAlias (const juce::String& a)
 {
-    if (alias != a)
-    {
-        alias = a.substring (0, 40).trim();
+    auto newAlias = a.substring (0, 50).trim();
 
-        if (alias == getName())
-            alias = {};
+    if (newAlias == getName())
+        newAlias = {};
 
-        if (! isTrackDevice())
-        {
-            if (alias.isNotEmpty())
-                engine.getPropertyStorage().setPropertyItem (SettingID::invalid, getAliasPropName(), alias);
-            else
-                engine.getPropertyStorage().removePropertyItem (SettingID::invalid, getAliasPropName());
-        }
+    if (alias != newAlias)
+    {
+        alias = newAlias;
+
+        if (alias.isNotEmpty() && ! isTrackDevice())
+            engine.getPropertyStorage().setPropertyItem (SettingID::invalid, getAliasPropName(), alias);
+        else
+            engine.getPropertyStorage().removePropertyItem (SettingID::invalid, getAliasPropName());
 
         changed();
     }
 }
 
 juce::String IODevice::getSelectableDescription()
 {
-    return name + " (" + TRANS(getDeviceTypeDescription()) + ")";
+    return getAliasOrName() + " (" + TRANS(getDeviceTypeDescription()) + ")";
 }
 
 bool IODevice::isEnabled() const
@@ -66,5 +67,4 @@ bool IODevice::isEnabled() const
 }
 
 
-
 }} // namespace tracktion { inline namespace engine

modules/tracktion_engine/playback/devices/tracktion_IODevice.h

@@ -24,8 +24,8 @@ class IODevice   : public Selectable
     ~IODevice() override;
 
     //==============================================================================
-    const juce::String& getName() const         { return name; }
-    juce::String getDeviceID() const            { return deviceID; }
+    const juce::String& getName() const                       { return name; }
+    juce::String getDeviceID() const                          { return deviceID; }
 
     bool isEnabled() const;
     virtual void setEnabled (bool) = 0;
@@ -35,8 +35,11 @@ class IODevice   : public Selectable
     virtual juce::String getDeviceTypeDescription() const = 0;
 
     /// the alias is the name shown in the draggable input device components
-    juce::String getAlias() const;
     void setAlias (const juce::String& newAlias);
+    /// Returns the alias if set, otherwise the name.
+    juce::String getAliasOrName() const;
+    /// Returns the alias, or an empty string if not set.
+    juce::String getAliasIfSet() const;
 
     juce::String getSelectableDescription() override;
 

modules/tracktion_engine/playback/devices/tracktion_VirtualMidiInputDevice.cpp

@@ -134,12 +134,4 @@ void VirtualMidiInputDevice::handleMessageFromPhysicalDevice (PhysicalMidiInputD
         handleIncomingMidiMessage (m, dev.getMPESourceID());
 }
 
-juce::String VirtualMidiInputDevice::getSelectableDescription()
-{
-    if (getDeviceType() == trackMidiDevice)
-        return getAlias() + " (" + getDeviceTypeDescription() + ")";
-
-    return MidiInputDevice::getSelectableDescription();
-}
-
 }} // namespace tracktion { inline namespace engine

modules/tracktion_engine/playback/devices/tracktion_VirtualMidiInputDevice.h

@@ -21,7 +21,6 @@ class VirtualMidiInputDevice  : public MidiInputDevice
 
     using MidiInputDevice::handleIncomingMidiMessage;
     void handleIncomingMidiMessage (const juce::MidiMessage&, MPESourceID) override;
-    juce::String getSelectableDescription() override;
 
     void setEnabled (bool) override;
     void loadProps() override;

modules/tracktion_engine/playback/devices/tracktion_WaveDeviceDescription.cpp

@@ -572,13 +572,20 @@ static juce::String getDefaultChannelName (bool isInput, uint32_t index)
             .replace ("123", std::to_string (index + 1));
 }
 
+static void replaceBareNumbersWithNames (juce::StringArray& channelNames, bool isInput)
+{
+    for (int i = 0; i < channelNames.size(); ++i)
+        if (channelNames[i].trim() != juce::String (i + 1))
+            return;
+
+    for (int i = 0; i < channelNames.size(); ++i)
+        if (channelNames[i].trim() == juce::String (i + 1))
+            channelNames.set (i, getDefaultChannelName (isInput, (uint32_t) i));
+}
+
 static void refreshNamesInList (std::vector<WaveDeviceDescription>& descriptions, juce::StringArray channelNames, bool isInput)
 {
-    if (channelNames.size() <= 2)
-    {
-        channelNames.set (0, getDefaultChannelName (isInput, 0));
-        channelNames.set (1, getDefaultChannelName (isInput, 1));
-    }
+    replaceBareNumbersWithNames (channelNames, isInput);
 
     for (auto& desc : descriptions)
     {

modules/tracktion_engine/playback/devices/tracktion_WaveInputDevice.cpp

@@ -1518,14 +1518,6 @@ void WaveInputDevice::saveProps()
 }
 
 //==============================================================================
-juce::String WaveInputDevice::getSelectableDescription()
-{
-    if (getDeviceType() == trackWaveDevice)
-        return getAlias() + " (" + getDeviceTypeDescription() + ")";
-
-    return InputDevice::getSelectableDescription();
-}
-
 bool WaveInputDevice::isStereoPair() const
 {
     return deviceDescription.getNumChannels() == 2;
@@ -1542,18 +1534,25 @@ void WaveInputDevice::setStereoPair (bool stereo)
     engine.getDeviceManager().setDeviceNumChannels (*this, stereo ? 2 : 1);
 }
 
-juce::PopupMenu WaveInputDevice::createChannelGroupMenu()
+juce::PopupMenu WaveInputDevice::createChannelGroupMenu (bool includeSetAllChannelsOptions)
 {
     juce::PopupMenu m;
     auto& dm = engine.getDeviceManager();
     uint32_t channelNum = 0;
+    auto currentNumChannels = deviceDescription.getNumChannels();
 
     for (auto& option : dm.getPossibleChannelGroupsForDevice (*this, DeviceManager::maxNumChannelsPerDevice))
-        m.addItem (option, [this, &dm, num = ++channelNum] { dm.setDeviceNumChannels (*this, num); });
+    {
+        auto num = ++channelNum;
+        m.addItem (option, true, num == currentNumChannels, [this, &dm, num] { dm.setDeviceNumChannels (*this, num); });
+    }
 
-    m.addSeparator();
-    m.addItem ("Set all to mono channels", [&dm] { dm.setAllWaveInputsToNumChannels (1); });
-    m.addItem ("Set all to stereo pairs",  [&dm] { dm.setAllWaveInputsToNumChannels (2); });
+    if (includeSetAllChannelsOptions)
+    {
+        m.addSeparator();
+        m.addItem ("Set all to mono channels", [&dm] { dm.setAllWaveInputsToNumChannels (1); });
+        m.addItem ("Set all to stereo pairs",  [&dm] { dm.setAllWaveInputsToNumChannels (2); });
+    }
 
     return m;
 }

modules/tracktion_engine/playback/devices/tracktion_WaveInputDevice.h

@@ -41,7 +41,7 @@ class WaveInputDevice   : public InputDevice
     double getRecordAdjustmentMs() const                        { return recordAdjustMs; }
     bool isStereoPair() const;
     void setStereoPair (bool);
-    juce::PopupMenu createChannelGroupMenu();
+    juce::PopupMenu createChannelGroupMenu (bool includeSetAllChannelsOptions);
     juce::Array<int> getAvailableBitDepths() const;
     void setBitDepth (int);
     int getBitDepth() const                                     { return bitDepth; }
@@ -71,8 +71,6 @@ class WaveInputDevice   : public InputDevice
     void updateRetrospectiveBufferLength (double length) override;
 
     //==============================================================================
-    juce::String getSelectableDescription() override;
-
     const WaveDeviceDescription deviceDescription;
 
 protected:

modules/tracktion_engine/playback/devices/tracktion_WaveOutputDevice.cpp

@@ -143,18 +143,25 @@ void WaveOutputDevice::setStereoPair (bool stereo)
     engine.getDeviceManager().setDeviceNumChannels (*this, stereo ? 2 : 1);
 }
 
-juce::PopupMenu WaveOutputDevice::createChannelGroupMenu()
+juce::PopupMenu WaveOutputDevice::createChannelGroupMenu (bool includeSetAllChannelsOptions)
 {
     juce::PopupMenu m;
     auto& dm = engine.getDeviceManager();
     uint32_t channelNum = 0;
+    auto currentNumChannels = deviceDescription.getNumChannels();
 
     for (auto& option : dm.getPossibleChannelGroupsForDevice (*this, DeviceManager::maxNumChannelsPerDevice))
-        m.addItem (option, [this, &dm, num = ++channelNum] { dm.setDeviceNumChannels (*this, num); });
+    {
+        auto num = ++channelNum;
+        m.addItem (option, true, num == currentNumChannels, [this, &dm, num] { dm.setDeviceNumChannels (*this, num); });
+    }
 
-    m.addSeparator();
-    m.addItem ("Set all to mono channels", [&dm] { dm.setAllWaveOutputsToNumChannels (1); });
-    m.addItem ("Set all to stereo pairs",  [&dm] { dm.setAllWaveOutputsToNumChannels (2); });
+    if (includeSetAllChannelsOptions)
+    {
+        m.addSeparator();
+        m.addItem ("Set all to mono channels", [&dm] { dm.setAllWaveOutputsToNumChannels (1); });
+        m.addItem ("Set all to stereo pairs",  [&dm] { dm.setAllWaveOutputsToNumChannels (2); });
+    }
 
     return m;
 }

modules/tracktion_engine/playback/devices/tracktion_WaveOutputDevice.h

@@ -48,7 +48,7 @@ class WaveOutputDevice  : public OutputDevice
 
     bool isStereoPair() const;
     void setStereoPair (bool);
-    juce::PopupMenu createChannelGroupMenu();
+    juce::PopupMenu createChannelGroupMenu (bool includeSetAllChannelsOptions);
 
     WaveOutputDeviceInstance* createInstance (EditPlaybackContext&);