Automatically save ProbeInterface JSON files when recording starts

Author: bparks13

Source/OnixSource.cpp

@@ -1193,6 +1193,90 @@ bool OnixSource::stopAcquisition()
 	return true;
 }
 
+bool OnixSource::dataStreamExists(std::string streamName, Array<const DataStream*> dataStreams)
+{
+	for (const auto& stream : dataStreams)
+	{
+		if (stream->getName().contains(streamName))
+		{
+			return true;
+		}
+	}
+
+	return false;
+}
+
+void OnixSource::startRecording()
+{
+	OnixDeviceVector devicesWithProbeInterface;
+
+	for (const auto& device : getEnabledDataSources())
+	{
+		if (device->getDeviceType() == OnixDeviceType::NEUROPIXELSV1E
+			|| device->getDeviceType() == OnixDeviceType::NEUROPIXELSV1F
+			|| device->getDeviceType() == OnixDeviceType::NEUROPIXELSV2E)
+		{
+			devicesWithProbeInterface.emplace_back(device);
+		}
+	}
+
+	if (devicesWithProbeInterface.empty())
+		return;
+
+	File recPath = CoreServices::getRecordingParentDirectory();
+
+	int recordNodeId = CoreServices::getAvailableRecordNodeIds().getFirst();
+	int experimentNumber = CoreServices::RecordNode::getExperimentNumber(recordNodeId);
+
+	auto dir = File(
+		recPath.getFullPathName() + File::getSeparatorString() +
+		CoreServices::getRecordingDirectoryName() + File::getSeparatorString() +
+		PLUGIN_NAME + " " + String(sn->getNodeId()) + File::getSeparatorString() +
+		"experiment" + String(experimentNumber));
+
+	if (!dir.exists())
+	{
+		auto result = dir.createDirectory();
+
+		if (result.failed())
+		{
+			Onix1::showWarningMessageBoxAsync("Unable to Create ONIX Source Folder",
+				"The plugin was unable to create a recording directory at '" + dir.getFullPathName().toStdString() + "'. No Probe Interface files will be saved for this recording, please stop recording and determine why the directory could not be created.");
+			return;
+		}
+	}
+
+	for (const auto& device : devicesWithProbeInterface)
+	{
+		if (device->getDeviceType() == OnixDeviceType::NEUROPIXELSV1E || device->getDeviceType() == OnixDeviceType::NEUROPIXELSV1F)
+		{
+			auto npx = std::static_pointer_cast<Neuropixels1>(device);
+			auto streamName = npx->createStreamName(); // NB: Create the automatic stream name, without any suffixes and including the port name
+
+			auto streamExists = dataStreamExists(streamName, sn->getDataStreams());
+
+			if (!streamExists)
+				return;
+
+			if (!npx->saveProbeInterfaceFile(dir, streamName))
+				return;
+		}
+		else if (device->getDeviceType() == OnixDeviceType::NEUROPIXELSV2E)
+		{
+			auto npx = std::static_pointer_cast<Neuropixels2e>(device);
+			auto streamName = npx->createStreamName(); // NB: Create the automatic stream name, without any suffixes and including the port name
+
+			auto streamExists = dataStreamExists(streamName, sn->getDataStreams());
+
+			if (!streamExists)
+				return;
+
+			if (!npx->saveProbeInterfaceFile(dir, streamName))
+				return;
+		}
+	}
+}
+
 bool OnixSource::updateBuffer()
 {
 	for (const auto& source : enabledSources)

Source/OnixSource.h

@@ -29,6 +29,9 @@
 #include "OnixSourceEditor.h"
 #include "FrameReader.h"
 #include "Devices/PortController.h"
+#include "Formats/ProbeInterface.h"
+
+#define PLUGIN_NAME "ONIX Source"
 
 namespace OnixSourcePlugin
 {
@@ -73,6 +76,8 @@ namespace OnixSourcePlugin
 		/** Stops data transfer.*/
 		bool stopAcquisition() override;
 
+		void startRecording();
+
 		void updateDiscoveryParameters(PortName port, DiscoveryParameters parameters);
 
 		/** Takes a string from the editor. Can be an empty string to allow for automated discovery */
@@ -177,6 +182,8 @@ namespace OnixSourcePlugin
 		/** This method is expected to be called in a separate thread, and waits for acquisition to stop before gracefully disconnecting all devices */
 		static void disconnectDevicesAfterAcquisition(OnixSourceEditor* editor);
 
+		static bool dataStreamExists(std::string streamName, Array<const DataStream*> dataStreams);
+
 		JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR(OnixSource);
 	};
 }

Source/OnixSourceEditor.cpp

@@ -540,6 +540,11 @@ void OnixSourceEditor::stopAcquisition()
 		canvas->stopAcquisition();
 }
 
+void OnixSourceEditor::startRecording()
+{
+	source->startRecording();
+}
+
 Visualizer* OnixSourceEditor::createNewCanvas(void)
 {
 	GenericProcessor* processor = (GenericProcessor*)getProcessor();

Source/OnixSourceEditor.h

@@ -63,6 +63,8 @@ namespace OnixSourcePlugin
 
 		void stopAcquisition() override;
 
+		void startRecording() override;
+
 		Visualizer* createNewCanvas(void) override;
 
 		void saveVisualizerEditorParameters(XmlElement* xml) override;

Source/OpenEphysLib.cpp

@@ -44,7 +44,7 @@ extern "C" EXPORT void getLibInfo(Plugin::LibraryInfo* info)
 	info->apiVersion = PLUGIN_API_VER;
 
 	//Name of the Library, used only for information
-	info->name = "ONIX Source";
+	info->name = PLUGIN_NAME;
 
 	//Version of the library, used only for information
 	info->libVersion = "0.2.0";