Improve timestamp source information on events info objects

Author: aacuevas

Source/Processors/Channel/InfoObjects.cpp

@@ -337,8 +337,28 @@ bool DataChannel::checkEqual(const InfoObjectCommon& other, bool similar) const
 
 //EventChannel
 EventChannel::EventChannel(EventChannelTypes type, unsigned int nChannels, unsigned int dataLength, float sampleRate, GenericProcessor* source, uint16 subproc)
-	: InfoObjectCommon(source->eventChannelCount++, source->eventChannelTypeCount[type]++, sampleRate, source, subproc),
-		m_type(type)
+	: InfoObjectCommon(source->eventChannelCount++, source->eventChannelTypeCount[type]++, 
+	((sampleRate > 0) ? sampleRate : (source->isGeneratesTimestamps() ? source->getSampleRate(subproc) : CoreServices::getGlobalSampleRate())),
+	source, subproc),
+	m_type(type),
+	m_timestampOrigin(source->isGeneratesTimestamps() ? timestampsFromContinuousSource : timestampsFromGlobalSource ),
+	m_timestampOriginProcessor(source->getNodeId()),
+	m_timestampOriginSubProcessor(subproc)
+{
+	initializeEvent(nChannels, dataLength);
+}
+
+EventChannel::EventChannel(EventChannelTypes type, unsigned int nChannels, unsigned int dataLength, const DataChannel* originChannel, GenericProcessor* source, uint16 subproc)
+	: InfoObjectCommon(source->eventChannelCount++, source->eventChannelTypeCount[type]++, originChannel->getSampleRate(), source, subproc),
+	m_type(type),
+	m_timestampOrigin(timestampsDerivedFromChannel),
+	m_timestampOriginProcessor(originChannel->getSourceNodeID()),
+	m_timestampOriginSubProcessor(originChannel->getSubProcessorIdx())
+{
+	initializeEvent(nChannels, dataLength);
+}
+
+void EventChannel::initializeEvent(int nChannels, int dataLength)
 {
 	m_numChannels = nChannels;
 	if (m_type == TTL)

Source/Processors/Channel/InfoObjects.h

@@ -299,11 +299,22 @@ class PLUGIN_API EventChannel :
 		BINARY_BASE_VALUE = 10
 	};
 
-	/** Default constructor
+	/**
+	Enumerator indicating where the timestamps for the event are originating, so they can be easily synchronized
+	*/
+	enum EventTimestampOrigin 
+	{
+		timestampsFromContinuousSource, /* The timestamps from this event originate in a source processor alongside related continuous signals. 
+										Typical for  */
+		timestampsDerivedFromChannel, /* The timestamps are derived from a channel. Typical for events created by filter nodes */
+		timestampsFromGlobalSource /* The timestamps are derived from the global timed. Typical for sources without continuous channels */
+	};
+
+	/** Default constructor. Use this if the event is unrelated to any continuous data.
 	@param type The type of event this channel represents (TTL, TEXT, BYINARY_MSG)
 	@param numChannels The number of virtual channels
 	@param dataLength The length of the event payload
-	@param sampleRate the sample rate this channel timestamps are referred to
+	@param sampleRate the sample rate this channel timestamps are referred to. If less or equal than zero will automatically get set to the processor sample rate or the global one
 	@param source A pointer to the source processor
 	@param subproc Optional. The source subprocessor index.
 
@@ -316,9 +327,35 @@ class PLUGIN_API EventChannel :
 	-For message events, the length of the string in characters
 	-For typed array events, the number of elements
 
+	This constructor will set the timestamp origin flag to timestampFromContinuousSource if the source processor isGeneratesTimestamps() returns true
+	and to timestampsFromGlobalSource otherwise
+
 	*/
 	EventChannel(EventChannelTypes type, unsigned int numChannels, unsigned int dataLength, float sampleRate, GenericProcessor* source, uint16 subproc = 0);
 
+	/** Constructor for derived events.
+	Intended for events that are created from a continuous channel data
+	@param type The type of event this channel represents (TTL, TEXT, BYINARY_MSG)
+	@param numChannels The number of virtual channels
+	@param dataLength The length of the event payload
+	@param originChannel The channel this event is derived from
+	@param source A pointer to the source processor
+	@param subproc Optional. The source subprocessor index.
+
+	The virtual channels mean:
+	-For TTL signals, it must be the number of bits in the TTL word.
+	-For other events, this might be used to differentiate between different origins within the same processor
+
+	The event length mean:
+	-For TTL signals, this method will do nothing, as the size is fixed by the number of ttl channels
+	-For message events, the length of the string in characters
+	-For typed array events, the number of elements
+
+	This constructor will set the timestamp origin flag to timestampDerivedFromChannel and set the sample rate to that of the channel
+
+	*/
+	EventChannel(EventChannelTypes type, unsigned int numChannels, unsigned int dataLength, const DataChannel* originChannel, GenericProcessor* source, uint16 subproc = 0);
+
 	virtual ~EventChannel();
 
 	EventChannelTypes getChannelType() const;
@@ -358,11 +395,25 @@ class PLUGIN_API EventChannel :
 	/** Handy method to get an equivalente metadata value type for the main event data*/
 	BaseType getEquivalentMetaDataType() const;
 
+	/** Returns which kind of origin the timestamps for these events have */
+	EventTimestampOrigin getTimestampOrigin() const;
+
+	/** Returns the processor id which generated the timestamps, in case they are derived from a channel. Otherwise it returns the same as getSourceNodeId()*/
+	uint16 getTimestampOriginProcessor() const;
+
+	/** Returns the subprocessor index which generated the timestamps, in case they are derived from a channel. Otherwise it returns the same as getSubProcessorIdx()*/
+	uint16 getTimestampOriginSubProcessor() const;
+
 	InfoObjectType getInfoObjectType() const override;
 	void setDefaultNameAndDescription() override;
 private:
 	bool checkEqual(const InfoObjectCommon& other, bool similar) const override;
+	void initializeEvent(int nChannels, int dataLength);
 	const EventChannelTypes m_type;
+	const EventTimestampOrigin m_timestampOrigin;
+	const uint16 m_timestampOriginProcessor;
+	const uint16 m_timestampOriginSubProcessor;
+	
 	unsigned int m_numChannels{ 1 };
 	size_t m_dataSize{ 1 };
 	unsigned int m_length{ 1 };

Source/Processors/PluginManager/OpenEphysPlugin.h

@@ -48,7 +48,7 @@ class SourceNode;
 class RecordEngineManager;
 class FileSource;
 
-#define PLUGIN_API_VER 5
+#define PLUGIN_API_VER 6
 
 typedef GenericProcessor*(*ProcessorCreator)();
 typedef DataThread*(*DataThreadCreator)(SourceNode*);