Compatibility updates for API9

Author: anjaldoshi

CMakeLists.txt

@@ -10,7 +10,7 @@ endif()
 get_filename_component(PROJECT_FOLDER ${CMAKE_CURRENT_SOURCE_DIR} ABSOLUTE)
 get_filename_component(PLUGIN_NAME ${PROJECT_FOLDER} NAME)
 
-set(CMAKE_OSX_ARCHITECTURES "x86_64" CACHE STRING "Build architecture for Mac OS X" FORCE)
+set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64" CACHE STRING "Build architecture for Mac OS X" FORCE)
 
 project(OE_PLUGIN_${PLUGIN_NAME})
 set(CMAKE_SHARED_LIBRARY_PREFIX "")
@@ -70,21 +70,21 @@ if(MSVC)
 elseif(LINUX)
 	target_link_libraries(${PLUGIN_NAME} PRIVATE GL X11 Xext Xinerama asound dl freetype pthread rt)
 	set_property(TARGET ${PLUGIN_NAME} APPEND_STRING PROPERTY LINK_FLAGS
-		"-fvisibility=hidden -fPIC -rdynamic -Wl,-rpath='$ORIGIN/../shared' -Wl,-rpath='$ORIGIN/../shared-api8'")
+		"-fvisibility=hidden -fPIC -rdynamic -Wl,-rpath='$ORIGIN/../shared' -Wl,-rpath='$ORIGIN/../shared-api9'")
 	target_compile_options(${PLUGIN_NAME} PRIVATE -fPIC -rdynamic)
 	target_compile_options(${PLUGIN_NAME} PRIVATE -O3) #enable optimization for linux debug
 
 	install(TARGETS ${PLUGIN_NAME} LIBRARY DESTINATION ${GUI_BIN_DIR}/plugins)
 elseif(APPLE)
 	set_target_properties(${PLUGIN_NAME} PROPERTIES BUNDLE TRUE)
 	set_property(TARGET ${PLUGIN_NAME} APPEND_STRING PROPERTY LINK_FLAGS
-	"-undefined dynamic_lookup -rpath @loader_path/../../../../shared-api8")
+	"-undefined dynamic_lookup -rpath @loader_path/../../../../shared-api9")
 	set_target_properties(${PLUGIN_NAME} PROPERTIES
 		XCODE_ATTRIBUTE_CODE_SIGN_IDENTITY ""
 		XCODE_ATTRIBUTE_CODE_SIGNING_REQUIRED NO
 		)
 
-	install(TARGETS ${PLUGIN_NAME} DESTINATION $ENV{HOME}/Library/Application\ Support/open-ephys/plugins-api8)
+	install(TARGETS ${PLUGIN_NAME} DESTINATION $ENV{HOME}/Library/Application\ Support/open-ephys/plugins-api9)
 endif()
 
 #create filters for vs and xcode
@@ -99,7 +99,7 @@ endforeach()
 option(COPY_PYTHON_DL "Creates a directory and copies the python dynamic library for packaging" OFF)
 
 # Find and link python and pybind11
-find_package(Python 3.8 REQUIRED COMPONENTS Interpreter Development)
+find_package(Python 3.8 COMPONENTS Interpreter Development REQUIRED)
 add_subdirectory(extern/pybind11)
 target_link_libraries(${PLUGIN_NAME} PRIVATE pybind11::embed)
 
@@ -145,6 +145,6 @@ elseif(APPLE)
 						${CMAKE_COMMAND} -E copy ${_pythondylib} $<TARGET_BUNDLE_DIR:${PLUGIN_NAME}>/../shared)
 	else()
 		add_custom_command(TARGET ${PLUGIN_NAME} POST_BUILD COMMAND 
-					${CMAKE_COMMAND} -E copy ${_pythondylib} $ENV{HOME}/Library/Application\ Support/open-ephys/shared-api8)
+					${CMAKE_COMMAND} -E copy ${_pythondylib} $ENV{HOME}/Library/Application\ Support/open-ephys/shared-api9)
 	endif()
 endif()

Modules/examples/bandpass_filter.py

@@ -55,11 +55,8 @@ def process(self, data):
         Parameters:
         data - numpy array.
         """
-        try:
-            for i in range(self.num_chans):
-                data[i] = butter_bandpass_filter(self.sos[i], data[i])
-        except:
-            pass
+        for i in range(self.num_chans):
+            data[i] = butter_bandpass_filter(self.sos[i], data[i])
 
     def start_acquisition(self):
         """ Called at start of acquisition """

Source/PythonProcessor.cpp

@@ -44,12 +44,6 @@ PythonProcessor::PythonProcessor()
     moduleName = "";
     editorPtr = NULL;
     currentStream = 0;
-
-    addStringParameter(Parameter::GLOBAL_SCOPE, "python_home", "Path to python home", String());
-    addStringParameter(Parameter::GLOBAL_SCOPE, "script_path", "Path to python script", String(), true);
-    addIntParameter(Parameter::GLOBAL_SCOPE,
-        "current_stream", "Currently selected stream",
-        0, 0, 200000);
 }
 
 PythonProcessor::~PythonProcessor()
@@ -65,6 +59,12 @@ PythonProcessor::~PythonProcessor()
     }
 }
 
+void PythonProcessor::registerParameters()
+{
+    addStringParameter(Parameter::PROCESSOR_SCOPE, "python_home", "Python Home", "Path to python home", String());
+    addStringParameter(Parameter::PROCESSOR_SCOPE, "script_path", "Script Path", "Path to python script", String(), true);
+    addSelectedStreamParameter(Parameter::PROCESSOR_SCOPE, "current_stream", "Stream", "Currently selected stream", {}, 0, true, true);
+}
 
 AudioProcessorEditor* PythonProcessor::createEditor()
 {
@@ -96,7 +96,7 @@ void PythonProcessor::updateSettings()
         };
 
         ttlChan = new EventChannel(ttlChannelSettings);
-        ttlChan->addProcessor(processorInfo.get());
+        ttlChan->addProcessor(this);
         eventChannels.add(ttlChan);
 
         localEventChannels[streamId] = eventChannels.getLast();
@@ -363,7 +363,8 @@ void PythonProcessor::parameterValueChanged(Parameter* param)
     }
     else if (param->getName().equalsIgnoreCase("current_stream"))
     {
-        uint16 candidateStream = (uint16) (int) param->getValue();
+        String streamKey = param->getValueAsString();
+        uint16 candidateStream = getDataStream(streamKey)->getStreamId();
 
         if(streamExists(candidateStream)
            && currentStream != candidateStream)
@@ -392,7 +393,7 @@ bool PythonProcessor::initInterpreter(String pythonHome)
         AlertWindow::showMessageBox (AlertWindow::InfoIcon,
                                     "Select Python Home path",
                                     "To use the plugin you need provide the path to your preferred Python installation. "
-                                    "Please select the folder where your python is located in the next step.");
+                                    "Please select the folder where your python environment is located in the next step.");
 
         FileChooser chooser ("Please select the path to your preferred Python installation",
                             { File::getSpecialLocation(File::userHomeDirectory) });
@@ -594,7 +595,7 @@ void PythonProcessor::handlePythonException(const String& title, const String& m
     TextEditor* customMsgBox = new TextEditor();
     customMsgBox->setReadOnly(true);
     customMsgBox->setMultiLine(true);
-    customMsgBox->setFont(Font("Fira Code", "Regular", 14.0f));
+    customMsgBox->setFont(FontOptions(14.0f));
     customMsgBox->setSize(400, 300);
     customMsgBox->setText(String(e.what()));
 

Source/PythonProcessor.h

@@ -84,6 +84,9 @@ class PythonProcessor : public GenericProcessor
 	/** The class destructor, used to deallocate memory */
 	~PythonProcessor();
 
+	/** Registers the parameters of the processor */
+	void registerParameters() override;
+
 	/** If the processor has a custom editor, this method must be defined to instantiate it. */
 	AudioProcessorEditor* createEditor() override;
 

Source/PythonProcessorEditor.cpp

@@ -25,7 +25,8 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 ScriptPathButton::ScriptPathButton(Parameter* param) : ParameterEditor(param)
 {
-	utilButton = std::make_unique<UtilityButton>("...", Font(12));
+	utilButton = std::make_unique<UtilityButton>("...");
+	utilButton->setFont (FontOptions (12.0f));
 	utilButton->addListener(this);
 	addAndMakeVisible(utilButton.get());
 
@@ -35,7 +36,7 @@ ScriptPathButton::ScriptPathButton(Parameter* param) : ParameterEditor(param)
 
 void ScriptPathButton::buttonClicked(Button* label)
 {
-	FileChooser chooseScriptDirectory("Please select a python script...", File(CoreServices::getDefaultUserSaveDirectory()), "*.py");
+	FileChooser chooseScriptDirectory("Please select a python script...", File(), "*.py");
 
 	if (chooseScriptDirectory.browseForFileToOpen())
 	{
@@ -59,69 +60,39 @@ PythonProcessorEditor::PythonProcessorEditor(PythonProcessor* parentNode)
 
     desiredWidth = 190;
 
-	streamSelection = std::make_unique<ComboBox>("Stream Selector");
-    streamSelection->setBounds(20, 32, 155, 20);
-    streamSelection->addListener(this);
-    addAndMakeVisible(streamSelection.get());
+	addSelectedStreamParameterEditor(Parameter::PROCESSOR_SCOPE, "current_stream", 20, 34);
+	getParameterEditor("current_stream")->setLayout(ParameterEditor::Layout::nameHidden);
+	getParameterEditor("current_stream")->setSize(150, 20);
 
-	scriptPathLabel = std::make_unique<Label>("Script Path Label", "No Module Loaded");
+
+	scriptPathLabel = std::make_unique<TextEditor>("Script Path Label");
+	scriptPathLabel->setText("No Module Loaded", false);
 	scriptPathLabel->setTooltip(scriptPathLabel->getText());
-	scriptPathLabel->setMinimumHorizontalScale(0.7f);
-	scriptPathLabel->setBounds(20, 65, 135, 20);
-	scriptPathLabel->setColour(Label::backgroundColourId, Colours::grey);
-	scriptPathLabel->setColour(Label::backgroundWhenEditingColourId, Colours::white);
-	scriptPathLabel->setJustificationType(Justification::centredLeft);
+	scriptPathLabel->setMultiLine(false);
+	scriptPathLabel->setReadOnly(true);
+	scriptPathLabel->setCaretVisible(false);
+	scriptPathLabel->setBounds(20, 65, 125, 20);
+	scriptPathLabel->setJustification(Justification::centredLeft);
 	addAndMakeVisible(scriptPathLabel.get());
 
 	Parameter* scriptPathPtr = getProcessor()->getParameter("script_path");
-	addCustomParameterEditor(new ScriptPathButton(scriptPathPtr), 160, 65);
+	addCustomParameterEditor(new ScriptPathButton(scriptPathPtr), 150, 65);
 
-	reloadButton = std::make_unique<UtilityButton>("Reload", Font(12));
-	reloadButton->setBounds(60, 95, 80, 25);
+	reloadButton = std::make_unique<UtilityButton>("Reload");
+	reloadButton->setFont (FontOptions (13.0f));
+	reloadButton->setBounds(60, 95, 70, 25);
 	reloadButton->addListener(this);
 	addAndMakeVisible(reloadButton.get());
 
 }
 
-void PythonProcessorEditor::updateSettings()
-{
- 
-    currentStream = (uint16) (int)getProcessor()->getParameter("current_stream")->getValue();
-	streamSelection->clear();
-
-	for (auto stream : getProcessor()->getDataStreams())
-	{
-        if (currentStream == 0)
-            currentStream = stream->getStreamId();
-        
-		streamSelection->addItem(stream->getName(), stream->getStreamId());
-	}
-
-    if (streamSelection->indexOfItemId(currentStream) == -1)
-    {
-        if (streamSelection->getNumItems() > 0)
-            currentStream = streamSelection->getItemId(0);
-        else
-            currentStream = 0;
-    }
-		
-    if (currentStream > 0)
-    {
-        streamSelection->setSelectedId(currentStream, sendNotification);
-    }
-        
-    
-}
-
 void PythonProcessorEditor::startAcquisition()
 {
-	streamSelection->setEnabled(false);
 	reloadButton->setEnabled(false);
 }
 
 void PythonProcessorEditor::stopAcquisition()
 {
-	streamSelection->setEnabled(true);
 	reloadButton->setEnabled(true);
 }
 
@@ -135,23 +106,11 @@ void PythonProcessorEditor::buttonClicked(Button* button)
 
 }
 
-void PythonProcessorEditor::comboBoxChanged(ComboBox* cb)
-{
-    if (cb == streamSelection.get())
-    {
-		currentStream = cb->getSelectedId();
-        
-        if (currentStream > 0)
-        	getProcessor()->getParameter("current_stream")->setNextValue(currentStream);
-    }
-
-}
-
-
 void PythonProcessorEditor::setPathLabelText(String text, String tooltip)
 {
-	scriptPathLabel->setText(text, dontSendNotification);
+	scriptPathLabel->setText(text, false);
 	scriptPathLabel->setTooltip(tooltip);
+	scriptPathLabel->setCaretPosition(0);
 }
 
 

Source/PythonProcessorEditor.h

@@ -56,8 +56,7 @@ class ScriptPathButton : public ParameterEditor,
 
 class PythonProcessorEditor :
 	public GenericEditor,
-	public Button::Listener,
-	public ComboBox::Listener
+	public Button::Listener
 {
 public:
 
@@ -67,9 +66,6 @@ class PythonProcessorEditor :
 	/** Destructor */
 	~PythonProcessorEditor() { }
 
-	/** Called when underlying settings are updated */
-	void updateSettings() override;
-
 	/** Called just prior to the start of acquisition, to allow custom commands. */
 	void startAcquisition() override;
 
@@ -79,20 +75,16 @@ class PythonProcessorEditor :
 	/** Respond to button clicks*/
 	void buttonClicked(Button* button) override;
 
-	/** Called when a ComboBox changes*/
-	void comboBoxChanged(ComboBox* comboBox) override;
-
 	/** Sets the text & tooltip of the path label */
 	void setPathLabelText(String text, String tooltip);
 
 private:
 
 	PythonProcessor* pythonProcessor;
 
-	std::unique_ptr<Label> scriptPathLabel;
+	std::unique_ptr<TextEditor> scriptPathLabel;
 	std::unique_ptr<Button> scriptPathButton;
-	std::unique_ptr<Button> reloadButton;
-	std::unique_ptr<ComboBox> streamSelection;
+	std::unique_ptr<UtilityButton> reloadButton;
 
 	uint16 currentStream = 0;