Add support for sending and receiving events

Fix conda-numpy import error on Windows

Author: anjaldoshi

Modules/examples/bandpass_filter.py

@@ -1,5 +1,6 @@
 import numpy as np
 from scipy import signal
+import oe_pyprocessor
 
 def butter_bandpass(lowcut, highcut, sample_rate, order=2):
     """
@@ -33,11 +34,12 @@ def butter_bandpass_filter(sos, data):
 
 class PyProcessor:
 
-    def __init__(self, num_channels, sample_rate):
+    def __init__(self, processor, num_channels, sample_rate):
         """ A new bandpass filter is initialized whenever the plugin settings are updated """
 
         self.num_chans = num_channels
         self.sample_rate = sample_rate
+        self.processor = processor
 
         self.sos = []
         sos_t = butter_bandpass(500, 2000, sample_rate)
@@ -67,6 +69,19 @@ 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 (bool): event state true (ON) or false (OFF)
+        """
+        pass
+
     def start_recording(self, recording_dir):
         """ 
         Called when recording starts

Modules/template/processor_template.py

@@ -1,13 +1,15 @@
 import numpy as np
+import oe_pyprocessor
 # Add additional imports here
 
 class PyProcessor:
 
-    def __init__(self, num_channels, sample_rate):
+    def __init__(self, processor, num_channels, sample_rate):
         """ 
         A new processor is initialized whenever the plugin settings are updated
         
         Parameters:
+        processor (object): Python Processor class object used for adding events from python.
         num_channels (int): number of input channels in the selected stream.
         sample_rate (float): sample rate of the selected stream
         """
@@ -43,7 +45,7 @@ def handle_ttl_event(self, source_node, channel, sample_number, line, state):
         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)
+        state (bool): event state True (ON) or False (OFF)
         """
         pass
 

Source/PythonProcessor.cpp

@@ -29,6 +29,11 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 namespace py = pybind11;
 
+PYBIND11_EMBEDDED_MODULE(oe_pyprocessor, module){
+
+    py::class_<PythonProcessor> (module, "PythonProcessor")
+        .def("add_python_event", &PythonProcessor::addPythonEvent);
+}
 
 PythonProcessor::PythonProcessor()
     : GenericProcessor("Python Processor")
@@ -74,6 +79,30 @@ void PythonProcessor::updateSettings()
 {
     if (getDataStreams().size() == 0)
         currentStream = 0;
+
+    localEventChannels.clear();
+
+    for (auto stream : getDataStreams())
+    {
+        const uint16 streamId = stream->getStreamId();
+        
+        // TTL Channel
+        EventChannel* ttlChan;
+        EventChannel::Settings ttlChannelSettings{
+            EventChannel::Type::TTL,
+            "Python Processor Output",
+            "TTL event triggerd by the python module.",
+            "pythonprocessor.ttl",
+            getDataStream(stream->getStreamId())
+        };
+
+        ttlChan = new EventChannel(ttlChannelSettings);
+        ttlChan->addProcessor(processorInfo.get());
+        eventChannels.add(ttlChan);
+
+        localEventChannels[streamId] = eventChannels.getLast();
+
+    }
 }
 
 void PythonProcessor::initialize(bool signalChainIsLoading)
@@ -93,12 +122,13 @@ void PythonProcessor::process(AudioBuffer<float>& buffer)
 
     checkForEvents(true);
 
+    int64 sampleNum = getFirstSampleNumberForBlock(currentStream);
+
     for (auto stream : getDataStreams())
     {
 
         if (stream->getStreamId() == currentStream)
         {
-
             const uint16 streamId = stream->getStreamId();
 
             const int numSamples = getNumSamplesInBlock(streamId);
@@ -135,6 +165,16 @@ void PythonProcessor::process(AudioBuffer<float>& buffer)
             // py::gil_scoped_release release;
 
         }
+
+        {
+            ScopedLock TTLlock(TTLqueueLock);
+            while (!TTLQueue.empty())
+            {
+                const StringTTL& TTLmsg = TTLQueue.front();
+                triggerTTLEvent(TTLmsg, sampleNum);
+                TTLQueue.pop();
+            }
+        }
     }
 }
 
@@ -148,7 +188,7 @@ void PythonProcessor::handleTTLEvent(TTLEventPtr event)
         const int sourceNodeId = chanInfo->getSourceNodeId();
         const int64 sampleNumber = event->getSampleNumber();
         const uint8 line = event->getLine();
-        const int state = event->getState() ? 1 : 0;
+        const bool state = event->getState();
 
         // Give to python
         // py::gil_scoped_acquire acquire;
@@ -180,6 +220,29 @@ void PythonProcessor::handleTTLEvent(TTLEventPtr event)
 
 // }
 
+void PythonProcessor::addPythonEvent(int line, bool state)
+{
+    // LOGC("[PYTHON] Event received!! Line: ", line, " | State: ", state);
+    {
+        ScopedLock TTLlock(TTLqueueLock);
+        if (CoreServices::getAcquisitionStatus()) 
+        {
+            TTLQueue.push({ line, state });
+        }
+    }
+}
+
+void PythonProcessor::triggerTTLEvent(StringTTL TTLmsg, juce::int64 sampleNum)
+{
+    TTLEventPtr event = 
+        TTLEvent::createTTLEvent(localEventChannels[currentStream], 
+                                 sampleNum, 
+                                 TTLmsg.eventLine, 
+                                 TTLmsg.state);
+    addEvent(event, 0);
+    
+}
+
 bool PythonProcessor::startAcquisition() 
 {
     if (moduleReady)
@@ -346,13 +409,20 @@ bool PythonProcessor::initInterpreter(String pythonHome)
             py::gil_scoped_acquire acquire;
 
             if(Py_IsInitialized() > 0)
+            {
                 LOGC("Python Interpreter initialized successfully! Python Home: ", String(Py_GetPythonHome()));
+
+                #if JUCE_WINDOWS
+                    py::module_ os = py::module_::import("os");
+                    os.attr("add_dll_directory")
+                        (targetFolder.getChildFile("Library\\bin").getFullPathName().toWideCharPointer());
+                #endif
+            }
 
             py::module sys = py::module::import("sys");
             py::list path = sys.attr("path");
 
             LOGD("Python sys paths:")
-            // Check if the path was added successfully
             for (auto p : path) {
                 LOGD(p.cast<std::string>());
             }
@@ -472,7 +542,7 @@ void PythonProcessor::initModule()
         }
 
         try {
-            pyObject = new py::object(pyModule->attr("PyProcessor")(numChans, sampleRate));
+            pyObject = new py::object(pyModule->attr("PyProcessor")(this, numChans, sampleRate));
         }
 
         catch (std::exception& exc)

Source/PythonProcessor.h

@@ -24,9 +24,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #define PYTHONPROCESSOR_H_DEFINED
 
 #include <ProcessorHeaders.h>
+#include <pybind11/pybind11.h>
 #include <pybind11/embed.h>
 #include <pybind11/numpy.h>
 
+#include <queue>
+
 #include "PythonProcessorEditor.h"
 
 namespace py = pybind11;
@@ -60,6 +63,17 @@ class PythonProcessor : public GenericProcessor
 	/** Stream to process*/
 	uint16 currentStream;
 
+	std::map<uint16, EventChannel*> localEventChannels;
+
+	struct StringTTL
+    {
+        int eventLine;
+		bool state;
+    };
+
+	std::queue<StringTTL> TTLQueue;
+	CriticalSection TTLqueueLock;
+
 	/**Check whether data stream exists */
 	bool streamExists(uint16 streamId);
 
@@ -101,6 +115,10 @@ class PythonProcessor : public GenericProcessor
 	// 	Called automatically whenever a broadcast message is sent through the signal chain */
 	// void handleBroadcastMessage(String message) override;
 
+	void addPythonEvent(int line, bool state);
+
+	void triggerTTLEvent(StringTTL TTLmsg, juce::int64 sampleNum);
+
 	/** Called at the start of acquisition.*/
 	bool startAcquisition() override;