Refactored the way audio input file patterns are handled, fixing some defaulting behaviour, and adding support for custom default patterns and locations to EngineBehaviour

Author: julianstorer

modules/tracktion_engine/playback/devices/tracktion_WaveInputDevice.cpp

@@ -64,56 +64,70 @@ static const char* datePattern     = "%date%";
 static const char* timePattern     = "%time%";
 static const char* takePattern     = "%take%";
 
-static juce::String expandPatterns (Edit& ed, const juce::String& s, Track* track, int take)
+static juce::String expandPatterns (Edit& ed, juce::String s, Track* track, int take)
 {
-    juce::String editName (TRANS("Unknown"));
-    juce::String trackName (TRANS("Unknown"));
-    auto projDir = juce::File::getCurrentWorkingDirectory().getFullPathName();
+    {
+        auto editName = ed.getName();
 
-    editName = juce::File::createLegalFileName (ed.getName());
+        if (editName.isEmpty())
+            s = s.replace (juce::String (editPattern) + "_", {}, true);
 
-    if (track != nullptr)
-        trackName = juce::File::createLegalFileName (track->getName());
+        s = s.replace (editPattern, editName, true);
+    }
 
-    if (auto proj = getProjectForEdit (ed))
     {
-        projDir = proj->getDirectoryForMedia (ProjectItem::Category::recorded).getFullPathName();
+        juce::String trackName;
+
+        if (track != nullptr)
+            trackName = track->getName();
+
+        if (trackName.isEmpty())
+            s = s.replace (juce::String (trackPattern) + "_", {}, true);
+
+        s = s.replace (trackPattern, trackName, true);
     }
-    else if (ed.editFileRetriever)
+
     {
-        auto editFile = ed.editFileRetriever();
+        auto projDir = ed.engine.getEngineBehaviour().getDefaultFolderForAudioRecordings (ed).getFullPathName();
 
-        if (editFile != juce::File() && editFile.getParentDirectory().isDirectory())
-            projDir = editFile.getParentDirectory().getFullPathName();
+        if (auto proj = getProjectForEdit (ed))
+        {
+            projDir = proj->getDirectoryForMedia (ProjectItem::Category::recorded).getFullPathName();
+        }
+        else if (ed.editFileRetriever)
+        {
+            auto editFile = ed.editFileRetriever();
+
+            if (editFile != juce::File() && editFile.getParentDirectory().isDirectory())
+                projDir = editFile.getParentDirectory().getFullPathName();
+        }
+
+        s = s.replace (projDirPattern, projDir, true);
     }
 
     auto now = juce::Time::getCurrentTime();
 
-    juce::String date;
+    {
+        juce::String date;
 
-    date << now.getDayOfMonth()
-         << juce::Time::getMonthName (now.getMonth(), true)
-         << now.getYear();
+        date << now.getDayOfMonth()
+            << juce::Time::getMonthName (now.getMonth(), true)
+            << now.getYear();
 
-    auto time = juce::String::formatted ("%d%02d%02d",
-                                         now.getHours(),
-                                         now.getMinutes(),
-                                         now.getSeconds());
+        s = s.replace (datePattern, date, true);
+    }
 
-    juce::String s2;
+    s = s.replace (timePattern, juce::String::formatted ("%d%02d%02d",
+                                                         now.getHours(),
+                                                         now.getMinutes(),
+                                                         now.getSeconds()), true);
 
     if (! s.contains (takePattern))
-        s2 = s + "_" + juce::String (takePattern);
-    else
-        s2 = s;
-
-    return juce::File::createLegalPathName (s2.replace (projDirPattern, projDir, true)
-                                              .replace (editPattern, editName, true)
-                                              .replace (trackPattern, trackName, true)
-                                              .replace (datePattern, date, true)
-                                              .replace (timePattern, time, true)
-                                              .replace (takePattern, juce::String (take), true)
-                                              .trim());
+        s += "_" + juce::String (takePattern);
+
+    s = s.replace (takePattern, juce::String (take), true);
+
+    return juce::File::createLegalPathName (s.trim());
 }
 
 
@@ -345,7 +359,7 @@ class WaveInputDeviceInstance  : public InputDeviceInstance
                     return tl::unexpected (TRANS("The current project is read-only, so new clips can't be recorded into it!"));
 
             auto format = getFormatToUse();
-            const auto res = getDestinationRecordingFile (edit, targetID, *format, getWaveInput().filenameMask);
+            const auto res = getDestinationRecordingFile (edit, targetID, *format, getWaveInput().getFilenameMask());
 
             if (! res)
                 return tl::unexpected (res.error());
@@ -1002,7 +1016,7 @@ class WaveInputDeviceInstance  : public InputDeviceInstance
                 return nullptr;
 
             auto format = getFormatToUse();
-            const auto res = getDestinationRecordingFile (edit, dstTrack->itemID, *format, getWaveInput().filenameMask);
+            const auto res = getDestinationRecordingFile (edit, dstTrack->itemID, *format, getWaveInput().getFilenameMask());
 
             if (! res)
                 return {};
@@ -1419,7 +1433,7 @@ void WaveInputDevice::closeDevice()
 
 void WaveInputDevice::loadProps()
 {
-    filenameMask = getDefaultMask();
+    filenameMask = {};
     inputGainDb = 0.0f;
     monitorMode = MonitorMode::automatic;
     outputFormat = engine.getAudioFileFormatManager().getDefaultFormat()->getFormatName();
@@ -1434,6 +1448,10 @@ void WaveInputDevice::loadProps()
     if (auto n = engine.getPropertyStorage().getXmlPropertyItem (SettingID::wavein, propName))
     {
         filenameMask = n->getStringAttribute ("filename", filenameMask);
+
+        if (filenameMask == engine.getEngineBehaviour().getDefaultAudioRecordingFilePattern())
+            filenameMask = {};
+
         inputGainDb = (float) n->getDoubleAttribute ("gainDb", inputGainDb);
         monitorMode = magic_enum::enum_cast<MonitorMode> (n->getStringAttribute ("monitorMode").toStdString()).value_or (MonitorMode::automatic);
 
@@ -1458,7 +1476,9 @@ void WaveInputDevice::saveProps()
 {
     juce::XmlElement n ("SETTINGS");
 
-    n.setAttribute ("filename", filenameMask);
+    if (filenameMask.isNotEmpty())
+        n.setAttribute ("filename", filenameMask);
+
     n.setAttribute ("gainDb", inputGainDb);
     n.setAttribute ("monitorMode", std::string (magic_enum::enum_name (monitorMode)));
     n.setAttribute ("format", outputFormat);
@@ -1534,30 +1554,31 @@ void WaveInputDevice::setRecordTriggerDb (float newDB)
     }
 }
 
-juce::String WaveInputDevice::getDefaultMask()
+juce::String WaveInputDevice::getFilenameMask() const
 {
-    juce::String defaultFile;
-    defaultFile << projDirPattern << juce::File::getSeparatorChar() << editPattern << '_'
-                << trackPattern<< '_'  << TRANS("Take") << '_' << takePattern;
+    if (filenameMask.isNotEmpty())
+        return filenameMask;
 
-    return defaultFile;
+    return engine.getEngineBehaviour().getDefaultAudioRecordingFilePattern();
 }
 
 void WaveInputDevice::setFilenameMask (const juce::String& newMask)
 {
     if (filenameMask != newMask)
     {
-        filenameMask = newMask.isNotEmpty() ? newMask
-                                            : getDefaultMask();
+        filenameMask = newMask;
+
+        if (filenameMask == engine.getEngineBehaviour().getDefaultAudioRecordingFilePattern())
+            filenameMask = {};
+
         changed();
         saveProps();
     }
 }
 
 void WaveInputDevice::setFilenameMaskToDefault()
 {
-    if (getDefaultMask() != filenameMask)
-        setFilenameMask ({});
+    setFilenameMask ({});
 }
 
 void WaveInputDevice::setBitDepth (int newDepth)

modules/tracktion_engine/playback/devices/tracktion_WaveInputDevice.h

@@ -47,10 +47,10 @@ class WaveInputDevice   : public InputDevice
     float getInputGainDb() const                                { return inputGainDb; }
     void setRecordTriggerDb (float);
     float getRecordTriggerDb() const                            { return recordTriggerDb; }
+
+    juce::String getFilenameMask() const;
     void setFilenameMask (const juce::String&);
-    juce::String getFilenameMask() const                        { return filenameMask; }
     void setFilenameMaskToDefault();
-    static juce::String getDefaultMask();
 
     void setOutputFormat (const juce::String&);
     juce::String getOutputFormat() const                        { return outputFormat; }

modules/tracktion_engine/utilities/tracktion_EngineBehaviour.h

@@ -136,6 +136,13 @@ class EngineBehaviour
     /// 0 = normal, 1 = high, 2 = realtime
     virtual void setProcessPriority (int /*level*/)                                 {}
 
+    /// If this is implemented, this folder will be used for the %project% pattern when
+    /// parsing an audio input device's target filename.
+    virtual juce::File getDefaultFolderForAudioRecordings (Edit&)                   { return {}; }
+
+    /// The default filename that will be used for audio input devices if not overridden
+    virtual juce::String getDefaultAudioRecordingFilePattern()                      { return "%projectdir%/%edit%_%track%_Take_%take%"; }
+
     //==============================================================================
     // Model-related options