Rework global timestamp source system

Author: aacuevas

Builds/VisualStudio2013/open-ephys.vcxproj

@@ -325,6 +325,7 @@
     <ClCompile Include="..\..\Source\Processors\Visualization\Visualizer.cpp" />
     <ClCompile Include="..\..\Source\Processors\Visualization\DataWindow.cpp" />
     <ClCompile Include="..\..\Source\Processors\Visualization\MatlabLikePlot.cpp" />
+    <ClCompile Include="..\..\Source\UI\TimestampSourceSelection.cpp" />
     <ClCompile Include="..\..\Source\UI\Utils\TiledButtonGroupManager.cpp" />
     <ClCompile Include="..\..\Source\UI\Utils\LinearButtonGroupManager.cpp" />
     <ClCompile Include="..\..\Source\UI\Utils\ButtonGroupManager.cpp" />
@@ -1994,6 +1995,7 @@
     <ClInclude Include="..\..\Source\Processors\Visualization\DataWindow.h" />
     <ClInclude Include="..\..\Source\Processors\Visualization\Visualizer.h" />
     <ClInclude Include="..\..\Source\Processors\Visualization\MatlabLikePlot.h" />
+    <ClInclude Include="..\..\Source\UI\TimestampSourceSelection.h" />
     <ClInclude Include="..\..\Source\UI\Utils\TiledButtonGroupManager.h" />
     <ClInclude Include="..\..\Source\UI\Utils\LinearButtonGroupManager.h" />
     <ClInclude Include="..\..\Source\UI\Utils\ButtonGroupManager.h" />

Builds/VisualStudio2013/open-ephys.vcxproj.filters

@@ -2337,6 +2337,9 @@
     <ClCompile Include="..\..\Source\Processors\Events\Events.cpp">
       <Filter>open-ephys\Source\Processors\Events</Filter>
     </ClCompile>
+    <ClCompile Include="..\..\Source\UI\TimestampSourceSelection.cpp">
+      <Filter>open-ephys\Source\UI</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="..\..\Source\Audio\AudioComponent.h">
@@ -4546,6 +4549,23 @@
     <ClInclude Include="..\..\JuceLibraryCode\modules\juce_gui_extra\juce_gui_extra.h" />
     <ClInclude Include="..\..\JuceLibraryCode\modules\juce_opengl\juce_opengl.h" />
     <ClInclude Include="..\..\JuceLibraryCode\modules\juce_video\juce_video.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_audio_basics\juce_audio_basics.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_audio_devices\juce_audio_devices.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_audio_formats\juce_audio_formats.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_audio_processors\juce_audio_processors.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_audio_utils\juce_audio_utils.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_core\juce_core.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_cryptography\juce_cryptography.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_data_structures\juce_data_structures.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_events\juce_events.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_graphics\juce_graphics.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_gui_basics\juce_gui_basics.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_gui_extra\juce_gui_extra.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_opengl\juce_opengl.h" />
+    <ClInclude Include="..\..\JuceLibraryCode\modules\juce_video\juce_video.h" />
+    <ClInclude Include="..\..\Source\UI\TimestampSourceSelection.h">
+      <Filter>open-ephys\Source\UI</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <None Include="..\..\Resources\Icons\icon-large.png">

Source/CoreServices.cpp

@@ -80,17 +80,22 @@ void highlightEditor(GenericEditor* ed)
 
 int64 getGlobalTimestamp()
 {
-    return static_cast<MessageCenter*>(&(getMessageCenter()->processor))->getGlobalTimestamp();
+	return getProcessorGraph()->getGlobalTimestamp(false);
 }
 
 int64 getSoftwareTimestamp()
 {
-	return static_cast<MessageCenter*>(&(getMessageCenter()->processor))->getGlobalTimestamp(true);
+	return getProcessorGraph()->getGlobalTimestamp(true);
 }
 
 float getGlobalSampleRate()
 {
-	return static_cast<MessageCenter*>(&(getMessageCenter()->processor))->getGlobalSampleRate();
+	return getProcessorGraph()->getGlobalSampleRate(false);
+}
+
+float getSoftwareSampleRate()
+{
+	return getProcessorGraph()->getGlobalSampleRate(true);
 }
 
 void setRecordingDirectory(String dir)

Source/CoreServices.h

@@ -71,6 +71,9 @@ PLUGIN_API float getGlobalSampleRate();
 /** Gets the software timestamp based on a high resolution timer aligned to the start of each processing block */
 PLUGIN_API int64 getSoftwareTimestamp();
 
+/** Gets the ticker frequency of the software timestamp clock*/
+PLUGIN_API float getSoftwareSampleRate();
+
 /** Set new recording directory */
 PLUGIN_API void setRecordingDirectory(String dir);
 

Source/Processors/GenericProcessor/GenericProcessor.cpp

@@ -46,6 +46,7 @@ GenericProcessor::GenericProcessor (const String& name)
     , m_processorType                   (PROCESSOR_TYPE_UTILITY)
 {
     settings.numInputs = settings.numOutputs = 0;
+	m_lastProcessTime = Time::getHighResolutionTicks();
 }
 
 
@@ -797,8 +798,10 @@ void GenericProcessor::processBlock (AudioSampleBuffer& buffer, MidiBuffer& even
 	m_currentMidiBuffer = &eventBuffer;
     processEventBuffer (); // extract buffer sizes and timestamps,
     // set flag on all TTL events to zero
-
+	
+	m_lastProcessTime = Time::getHighResolutionTicks();
     process (buffer);
+
 }
 
 const DataChannel* GenericProcessor::getDataChannel(int index) const
@@ -1193,6 +1196,17 @@ void GenericProcessor::setEnabledState (bool t)
     isEnabled = t;
 }
 
+bool GenericProcessor::enableProcessor()
+{
+	m_lastProcessTime = Time::getHighResolutionTicks();
+	return enable();
+}
+
+bool GenericProcessor::disableProcessor()
+{
+	return disable();
+}
+
 bool GenericProcessor::enable()
 {
     return isEnabled;
@@ -1223,6 +1237,11 @@ uint32 GenericProcessor::getProcessorFullId(uint16 sid, uint16 subid)
 	return uint32(sid) << 16 + subid;
 }
 
+int64 GenericProcessor::getLastProcessedsoftwareTime() const
+{
+	return m_lastProcessTime;
+}
+
 void ChannelCreationIndexes::clearChannelCreationCounts()
 {
 	dataChannelCount = 0;
@@ -1231,4 +1250,4 @@ void ChannelCreationIndexes::clearChannelCreationCounts()
 	eventChannelTypeCount.clear();
 	spikeChannelCount = 0;
 	spikeChannelTypeCount.clear();
-}
+}

Source/Processors/GenericProcessor/GenericProcessor.h

@@ -337,9 +337,13 @@ class PLUGIN_API GenericProcessor   : public AudioProcessor
     /** Returns true if a processor is ready to process data (e.g., all of its parameters are initialized, and its data source is connected).*/
     virtual bool isReady();
 
+	bool enableProcessor();
+
     /** Called immediately prior to the start of data acquisition, once all processors in the signal chain have indicated they are ready to process data.*/
     virtual bool enable();
 
+	bool disableProcessor();
+
     /** Called immediately after the end of data acquisition.*/
     virtual bool disable();
 
@@ -484,9 +488,6 @@ class PLUGIN_API GenericProcessor   : public AudioProcessor
 	@see GenericProcessor::getProcessorFullId(uint16,uint16) */
 	uint64 getSourceTimestamp(uint32 fullSourceID) const;
 
-    /** Used to set the timestamp for a given buffer, for a given source node. */
-    void setTimestampAndSamples (uint64 timestamp, uint32 nSamples, int subProcessorIdx = 0);
-
 	virtual int getNumSubProcessors() const;
 
 	int getDataChannelIndex(int channelIdx, int processorID, int subProcessorIdx = 0) const;
@@ -517,6 +518,8 @@ class PLUGIN_API GenericProcessor   : public AudioProcessor
 
     PluginProcessorType getProcessorType() const;
 
+	int64 getLastProcessedsoftwareTime() const;
+
 	static uint32 getProcessorFullId(uint16 processorId, uint16 subprocessorIdx);
 
 	class PLUGIN_API DefaultEventInfo
@@ -531,6 +534,8 @@ class PLUGIN_API GenericProcessor   : public AudioProcessor
 	};
 
 protected:
+	/** Used to set the timestamp for a given buffer, for a given source node. */
+	void setTimestampAndSamples(uint64 timestamp, uint32 nSamples, int subProcessorIdx = 0);
 
 	/** Can be called by processors that need to respond to incoming events.
 	Set respondToSpikes to true if the processor should also search for spikes*/
@@ -595,6 +600,8 @@ class PLUGIN_API GenericProcessor   : public AudioProcessor
 	std::map<uint32, uint32> numSamples;
 	std::map<uint32, int64> timestamps;
 
+	int64 m_lastProcessTime;
+
 	void createDataChannelsByType(DataChannel::DataChannelTypes type);
 
 	/** Each processor has a unique integer ID that can be used to identify it.*/

Source/Processors/MessageCenter/MessageCenter.cpp

@@ -29,8 +29,7 @@
 //---------------------------------------------------------------------
 
 MessageCenter::MessageCenter() :
-GenericProcessor("Message Center"), newEventAvailable(false), isRecording(false), sourceNodeId(0), sourceNodeSubIdx(0),
-	timestampSource(nullptr), lastTime(0), softTimestamp(0)
+GenericProcessor("Message Center"), newEventAvailable(false), isRecording(false)
 {
 
     setPlayConfigDetails(0, // number of inputs
@@ -46,7 +45,7 @@ MessageCenter::~MessageCenter()
 
 void MessageCenter::addSpecialProcessorChannels(Array<EventChannel*>& channels) 
 {
-	EventChannel* chan = new EventChannel(EventChannel::TEXT, 1, MAX_MSG_LENGTH, getGlobalSampleRate(), this, 0);
+	EventChannel* chan = new EventChannel(EventChannel::TEXT, 1, MAX_MSG_LENGTH, CoreServices::getGlobalSampleRate(), this, 0);
 	chan->setName("GUI Messages");
 	chan->setDescription("Messages from the GUI Message Center");
 	channels.add(chan);
@@ -80,25 +79,6 @@ void MessageCenter::setParameter(int parameterIndex, float newValue)
 bool MessageCenter::enable()
 {
     messageCenterEditor->startAcquisition();
-	lastTime = Time::getHighResolutionTicks();
-	softTimestamp = 0;
-    if (sourceNodeId)
-    {
-        AudioProcessorGraph::Node* node = AccessClass::getProcessorGraph()->getNodeForId(sourceNodeId);
-        if (node)
-        {
-            timestampSource = static_cast<GenericProcessor*>(node->getProcessor());
-        }
-        else
-        {
-            std::cout << "Message Center: BAD node id " << sourceNodeId << std::endl;
-            timestampSource = nullptr;
-            sourceNodeId = 0;
-        }
-    }
-    else
-        timestampSource = nullptr;
-
     return true;
 }
 
@@ -108,52 +88,14 @@ bool MessageCenter::disable()
     return true;
 }
 
-void MessageCenter::setSourceNodeId(int id, int sub)
-{
-    sourceNodeId = id;
-	sourceNodeSubIdx = sub;
-	AudioProcessorGraph::Node* node = AccessClass::getProcessorGraph()->getNodeForId(sourceNodeId);
-	if (node)
-	{
-		timestampSource = static_cast<GenericProcessor*>(node->getProcessor());
-	}
-}
-
-int MessageCenter::getSourceNodeId()
-{
-    return sourceNodeId;
-}
-
-int MessageCenter::getSourceSubIdx()
-{
-	return sourceNodeSubIdx;
-}
-
-int64 MessageCenter::getGlobalTimestamp(bool softwareTime)
-{
-	if (!softwareTime && sourceNodeId > 0)
-		return timestampSource->getSourceTimestamp(sourceNodeId, sourceNodeSubIdx);
-    else
-        return (softTimestamp);
-}
-
-float MessageCenter::getGlobalSampleRate()
-{
-	if (sourceNodeId > 0)
-		return timestampSource->getSampleRate(sourceNodeSubIdx);
-	else
-		return Time::getHighResolutionTicksPerSecond();
-}
 
 void MessageCenter::process(AudioSampleBuffer& buffer)
 {
-	softTimestamp = Time::getHighResolutionTicks() - lastTime;
-    setTimestampAndSamples(getGlobalTimestamp(), 0);
     if (needsToSendTimestampMessage)
     {
 		MidiBuffer& eventBuffer = *AccessClass::ExternalProcessorAccessor::getMidiBuffer(this);
 		HeapBlock<char> data;
-		size_t dataSize = SystemEvent::fillTimestampSyncTextData(data, this, 0, getTimestamp(true), true);
+		size_t dataSize = SystemEvent::fillTimestampSyncTextData(data, this, 0, CoreServices::getGlobalTimestamp(), true);
 
 		eventBuffer.addEvent(data, dataSize, 0);
 
@@ -168,21 +110,11 @@ void MessageCenter::process(AudioSampleBuffer& buffer)
 
 		eventString = eventString.dropLastCharacters(eventString.length() - MAX_MSG_LENGTH);
 
-		TextEventPtr event = TextEvent::createTextEvent(getEventChannel(0), getGlobalTimestamp(), eventString);
+		TextEventPtr event = TextEvent::createTextEvent(getEventChannel(0), CoreServices::getGlobalTimestamp(), eventString);
 		addEvent(getEventChannel(0), event, 0);
 
         newEventAvailable = false;
     }
 
 
-}
-
-void MessageCenter::addSourceProcessor(GenericProcessor* p)
-{
-    messageCenterEditor->addSourceProcessor(p);
-}
-
-void MessageCenter::removeSourceProcessor(GenericProcessor* p)
-{
-    messageCenterEditor->removeSourceProcessor(p);
 }

Source/Processors/MessageCenter/MessageCenter.h

@@ -75,25 +75,11 @@ class MessageCenter : public GenericProcessor
         needsToSendTimestampMessage = false;
     }
 
-    void setSourceNodeId(int id, int sub);
-    int getSourceNodeId();
-	int getSourceSubIdx();
-
-    void addSourceProcessor(GenericProcessor* p);
-    void removeSourceProcessor(GenericProcessor* p);
-
-    int64 getGlobalTimestamp(bool softwareTime = false);
-	float getGlobalSampleRate();
-	
 	void addSpecialProcessorChannels(Array<EventChannel*>& channel);
 private:
 
     bool newEventAvailable;
     bool isRecording;
-    int sourceNodeId;
-	int sourceNodeSubIdx;
-    const GenericProcessor* timestampSource;
-    int64 lastTime, softTimestamp;
     bool needsToSendTimestampMessage;
 
     JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(MessageCenter);