Add warning to Kwik File Source when using KWIK record format

Author: aacuevas

Source/Plugins/KWIKFormat/FileSource/KwikFileSource.cpp

@@ -22,14 +22,14 @@
 */
 #include <H5Cpp.h>
 #include "KwikFileSource.h"
-
+#include <CoreServicesHeader.h>
 
 
 using namespace H5;
 
 #define PROCESS_ERROR std::cerr << "KwikFilesource exception: " << error.getCDetailMsg() << std::endl
 
-KWIKFileSource::KWIKFileSource() : samplePos(0)
+KWIKFileSource::KWIKFileSource() : samplePos(0), skipRecordEngineCheck(false)
 {
 }
 
@@ -247,4 +247,32 @@ void KWIKFileSource::processChannelData(int16* inBuffer, float* outBuffer, int c
         *(outBuffer+i) = *(inBuffer+(n*i)+channel) * bitVolts;
     }
 
+}
+
+bool KWIKFileSource::isReady()
+{
+	//HDF5 is by default not thread-safe, so we must warn the user.
+	if ((!skipRecordEngineCheck) && (CoreServices::getSelectedRecordEngineId() == "KWIK"))
+	{
+		int res = AlertWindow::showYesNoCancelBox(AlertWindow::WarningIcon, "Record format conflict",
+			"Both the selected input file for the File Reader and the output file format for recording use the HDF5 library.\n"
+			"This library is, by default, not thread safe, so running both at the same time might cause unexpected crashes (chances increase with signal complexity and number of recorded channels).\n\n"
+			"If you have a custom-built hdf5 library with the thread safe features turned on, you can safely continue, but performance will be reduced.\n"
+			"More information on:\n"
+			"https://www.hdfgroup.org/HDF5/doc/TechNotes/ThreadSafeLibrary.html\n"
+			"https://www.hdfgroup.org/hdf5-quest.html\n\n"
+			"Do you want to continue acquisition?", "Yes", "Yes and don't ask again", "No");
+		switch (res)
+		{
+		case 2:
+			skipRecordEngineCheck = true;
+		case 1:
+			return true;
+			break;
+		default:
+			return false;
+		}
+	}
+	else
+		return true;
 }

Source/Plugins/KWIKFormat/FileSource/KwikFileSource.h

@@ -43,20 +43,23 @@ class KWIKFileSource : public FileSource
     KWIKFileSource();
     ~KWIKFileSource();
 
-    int readData(int16* buffer, int nSamples);
+    int readData(int16* buffer, int nSamples) override;
 
-    void seekTo(int64 sample);
+    void seekTo(int64 sample) override;
 
-    void processChannelData(int16* inBuffer, float* outBuffer, int channel, int64 numSamples);
+    void processChannelData(int16* inBuffer, float* outBuffer, int channel, int64 numSamples) override;
+
+	bool isReady() override;
 
 private:
     ScopedPointer<H5::H5File> sourceFile;
     ScopedPointer<H5::DataSet> dataSet;
-    bool Open(File file);
-    void fillRecordInfo();
-    void updateActiveRecord();
+    bool Open(File file) override;
+    void fillRecordInfo() override;
+    void updateActiveRecord() override;
     int64 samplePos;
     Array<int> availableDataSets;
+	bool skipRecordEngineCheck;
 };
 
 

Source/Processors/FileReader/FileSource.cpp

@@ -141,7 +141,7 @@ bool FileSource::OpenFile (File file)
     return fileOpened;
 }
 
-bool FileSource::isReady() const
+bool FileSource::isReady()
 {
 	return true;
 }

Source/Processors/FileReader/FileSource.h

@@ -67,7 +67,7 @@ class PLUGIN_API FileSource
     virtual void processChannelData (int16* inBuffer, float* outBuffer, int channel, int64 numSamples) = 0;
     virtual void seekTo (int64 sample) = 0;
 
-	virtual bool isReady() const;
+	virtual bool isReady();
 
 protected:
     struct RecordInfo