Add support for handling incoming events inside the Python module

Author: anjaldoshi

Modules/template/processor_template.py

@@ -4,7 +4,13 @@
 class PyProcessor:
 
     def __init__(self, num_channels, sample_rate):
-        """ A new processor is initialized whenever the plugin settings are updated """
+        """ 
+        A new processor is initialized whenever the plugin settings are updated
+        
+        Parameters:
+        num_channels (int): number of input channels in the selected stream.
+        sample_rate (float): sample rate of the selected stream
+        """
         print("Num Channels: ", num_channels, " | Sample Rate: ", sample_rate)
         # pass
 
@@ -27,13 +33,26 @@ def start_acquisition(self):
     def stop_acquisition(self):
         """ Called when acquisition is stopped """
         pass
+
+    def handle_ttl_event(self, source_node, channel, sample_number, line, state):
+        """
+        Handle each incoming ttl event.
+        
+        Parameters:
+        source_node (int): id of the processor this event was generated from
+        channel (str): name of the event channel
+        sample_number (int): sample number of the event
+        line (int): the line on which event was generated (0-255) 
+        state (int): event state 0 (OFF) or 1 (ON)
+        """
+        pass
 
     def start_recording(self, recording_dir):
         """ 
         Called when recording starts
 
         Parameters:
-        recording_dir - recording directory to be used by future record nodes.
+        recording_dir (str): recording directory to be used by future record nodes.
         """
         pass
 

Source/PythonProcessor.cpp

@@ -91,7 +91,7 @@ void PythonProcessor::process(AudioBuffer<float>& buffer)
     if( !moduleReady )
         return;
 
-    // checkForEvents(true);
+    checkForEvents(true);
 
     for (auto stream : getDataStreams())
     {
@@ -138,25 +138,29 @@ void PythonProcessor::process(AudioBuffer<float>& buffer)
     }
 }
 
-// void PythonProcessor::handleTTLEvent(TTLEventPtr event)
-// {
-//     // Get ttl info
-//     const int state = event->getState() ? 1 : 0;
-//     const int64 sampleNumber = event->getSampleNumber();
-//     const int channel = event->getChannelIndex();
-//     const uint8 line = event->getLine();
-//     const uint16 streamId = event->getStreamId();
-
-//     // Give to python
-//     // py::gil_scoped_acquire acquire;
+void PythonProcessor::handleTTLEvent(TTLEventPtr event)
+{
+    if (event->getStreamId() == currentStream)
+    {
+        // Get ttl info
+        auto chanInfo = event->getChannelInfo();
+        auto channelName = chanInfo->getName();
+        const int sourceNodeId = chanInfo->getSourceNodeId();
+        const int64 sampleNumber = event->getSampleNumber();
+        const uint8 line = event->getLine();
+        const int state = event->getState() ? 1 : 0;
+
+        // Give to python
+        // py::gil_scoped_acquire acquire;
 
-//     try {
-//         pyObject->attr("handle_ttl_event")(state, sampleNumber, channel, line, streamId);
-//     }
-//     catch (py::error_already_set& e) {
-//         handlePythonException(e);
-//     }
-// }
+        try {
+            pyObject->attr("handle_ttl_event")(sourceNodeId, channelName.toRawUTF8(), sampleNumber, line, state);
+        }
+        catch (py::error_already_set& e) {
+            handlePythonException(e);
+        }
+    }
+}
 
 
 // void PythonProcessor::handleSpike(SpikePtr event)

Source/PythonProcessor.h

@@ -90,7 +90,7 @@ class PythonProcessor : public GenericProcessor
 	// /** Handles events received by the processor
 	// 	Called automatically for each received event whenever checkForEvents() is called from
 	// 	the plugin's process() method */
-	// void handleTTLEvent(TTLEventPtr event) override;
+	void handleTTLEvent(TTLEventPtr event) override;
 
 	// /** Handles spikes received by the processor
 	// 	Called automatically for each received spike whenever checkForEvents(true) is called from