Add warning for hardware timestamp override when assigning sync lines

Author: anjaldoshi

Source/Processors/Parameter/ParameterEditor.cpp

@@ -25,6 +25,7 @@
 
 #include "../Editors/GenericEditor.h"
 #include "../GenericProcessor/GenericProcessor.h"
+#include "../RecordNode/RecordNode.h"
 
 void ParameterEditor::setLayout (Layout newLayout)
 {
@@ -980,6 +981,27 @@ TtlLineParameterEditor::TtlLineParameterEditor (Parameter* param,
 
 void TtlLineParameterEditor::selectedLineChanged (int newLine)
 {
+    int prevLine = getSelectedLine();
+    // If a sync line is assigned, show a warning if the stream generates hardware timestamps
+    if (syncParam != nullptr)
+    {
+        DataStream* paramStream = ((DataStream*) param->getOwner());
+        if (! RecordNode::overrideTimestampWarningShown
+            && paramStream->generatesTimestamps()
+            && newLine >= 0
+            && prevLine == -1)
+        {
+            AlertWindow::showMessageBox (AlertWindow::WarningIcon,
+                                         "Hardware Timestamps Will Be Overridden",
+                                         "The \"" + paramStream->getKey() + "\" stream is synchronized using hardware-generated timestamps, but a sync line has been assigned. "
+                                         "As a result, the hardware timestamps will be replaced with software-generated ones from the Synchronizer, using the main stream's clock and sync events.\n\n"
+                                         "To continue using hardware-generated timestamps, please remove the sync line by clicking it again",
+                                         "OK");
+
+            RecordNode::overrideTimestampWarningShown = true;
+        }
+    }
+
     param->setNextValue (newLine);
     updateView();
 }

Source/Processors/RecordNode/RecordNode.cpp

@@ -39,6 +39,8 @@ using namespace std::chrono;
 #define CONTINUOUS_CHANNELS_ON_BY_DEFAULT true
 #define RECEIVED_SOFTWARE_TIME (event.getVelocity() == 136)
 
+bool RecordNode::overrideTimestampWarningShown = false;
+
 EventMonitor::EventMonitor()
     : receivedEvents (0),
       receivedSpikes (0),
@@ -162,9 +164,20 @@ void RecordNode::parameterValueChanged (Parameter* p)
     {
         LOGD ("Parameter changed: sync_line");
         int selectedLine = ((TtlLineParameter*) p)->getSelectedLine();
-        synchronizer.setSyncLine (getDataStream (p->getStreamId())->getKey(), selectedLine);
+        const String streamKey = getDataStream (p->getStreamId())->getKey();
+
+        synchronizer.setSyncLine (streamKey, selectedLine);
+
+        // Assume overrideTimestampWarningShown is already true if a sync line is set for any hardware-synced stream
+        if (getDataStream (streamKey)->generatesTimestamps() 
+            && selectedLine >= 0 
+            && !overrideTimestampWarningShown)
+        {
+            overrideTimestampWarningShown = true;
+        }
 
-        if (selectedLine == -1 && synchronizer.mainStreamKey == getDataStream (p->getStreamId())->getKey())
+        // If sync line is set to none and this is the main stream, we need to find another main stream
+        if (selectedLine == -1 && synchronizer.mainStreamKey == streamKey)
         {
             int streamIndex = 0;
             for (auto stream : dataStreams)
@@ -186,7 +199,7 @@ void RecordNode::parameterValueChanged (Parameter* p)
             int streamIndex = 0;
             for (auto stream : dataStreams)
             {
-                if (stream->getKey() == getDataStream (p->getStreamId())->getKey())
+                if (stream->getKey() == streamKey)
                 {
                     getParameter ("main_sync")->setNextValue (streamIndex, false);
                     return;

Source/Processors/RecordNode/RecordNode.h

@@ -257,6 +257,10 @@ class TESTABLE RecordNode : public GenericProcessor,
     /** Actual sync monitor update -- can be called independently of timer*/
     void updateSyncMonitors();
 
+    /** Static flag to ensure override timestamps warning 
+     * for hardware-synced streams is shown only once per run */
+    static bool overrideTimestampWarningShown;
+
 private:
     /** Handles other types of events (text, sync texts, etc.) */
     void handleEvent (const EventChannel* channel, const EventPacket& eventPacket);