Merge branch 'main' into issue-108

Author: bparks13

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "liboni"]
+	path = liboni
+	url = https://github.com/open-ephys/liboni

CMakeLists.txt

@@ -1,4 +1,5 @@
 cmake_minimum_required(VERSION 3.5.0)
+
 if (NOT DEFINED GUI_BASE_DIR)
 	if (DEFINED ENV{GUI_BASE_DIR})
 		set(GUI_BASE_DIR $ENV{GUI_BASE_DIR})
@@ -12,12 +13,6 @@ get_filename_component(PLUGIN_NAME ${PROJECT_FOLDER} NAME)
 
 project(OE_PLUGIN_${PLUGIN_NAME})
 set(CMAKE_SHARED_LIBRARY_PREFIX "")
-if(${CMAKE_SYSTEM_NAME} STREQUAL "Linux")
-	set(LINUX 1)
-	if(NOT CMAKE_BUILD_TYPE)
-		set(CMAKE_BUILD_TYPE Debug)
-	endif()
-endif()
 
 set_property(DIRECTORY APPEND PROPERTY COMPILE_DEFINITIONS
 	OEPLUGIN
@@ -29,7 +24,6 @@ set_property(DIRECTORY APPEND PROPERTY COMPILE_DEFINITIONS
 	$<$<CONFIG:Release>:NDEBUG=1>
 	)
 
-
 set(SOURCE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/Source)
 file(GLOB_RECURSE SRC_FILES LIST_DIRECTORIES false "${SOURCE_PATH}/*.cpp" "${SOURCE_PATH}/*.h")
 set(GUI_COMMONLIB_DIR ${GUI_BASE_DIR}/installed_libs)
@@ -38,11 +32,7 @@ set(CONFIGURATION_FOLDER $<$<CONFIG:Debug>:Debug>$<$<NOT:$<CONFIG:Debug>>:Releas
 
 list(APPEND CMAKE_PREFIX_PATH ${GUI_COMMONLIB_DIR} ${GUI_COMMONLIB_DIR}/${CONFIGURATION_FOLDER})
 
-if (APPLE)
-	add_library(${PLUGIN_NAME} MODULE ${SRC_FILES})
-else()
-	add_library(${PLUGIN_NAME} SHARED ${SRC_FILES})
-endif()
+add_library(${PLUGIN_NAME} SHARED ${SRC_FILES})
 
 target_compile_features(${PLUGIN_NAME} PUBLIC cxx_auto_type cxx_generalized_initializers)
 target_include_directories(${PLUGIN_NAME} PUBLIC ${GUI_BASE_DIR}/JuceLibraryCode ${GUI_BASE_DIR}/JuceLibraryCode/modules ${GUI_BASE_DIR}/Plugins/Headers ${GUI_COMMONLIB_DIR}/include)
@@ -60,30 +50,13 @@ if (NOT CMAKE_LIBRARY_ARCHITECTURE)
 endif()
 
 #Libraries and compiler options
-if(MSVC)
-	target_link_libraries(${PLUGIN_NAME} ${GUI_BIN_DIR}/open-ephys.lib)
-	target_compile_options(${PLUGIN_NAME} PRIVATE /sdl- /W0)
-	
-	install(TARGETS ${PLUGIN_NAME} RUNTIME DESTINATION ${GUI_BIN_DIR}/plugins  CONFIGURATIONS ${CMAKE_CONFIGURATION_TYPES})
-	install(FILES $<TARGET_PDB_FILE:${PLUGIN_NAME}> DESTINATION  ${GUI_BIN_DIR}/plugins OPTIONAL)
-
-	set(CMAKE_PREFIX_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../libs)
-elseif(LINUX)
-	target_link_libraries(${PLUGIN_NAME} 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'")
-	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")
-
-	install(TARGETS ${PLUGIN_NAME} DESTINATION $ENV{HOME}/Library/Application\ Support/open-ephys/plugins-api8)
-	set(CMAKE_PREFIX_PATH /opt/local)
-endif()
+target_link_libraries(${PLUGIN_NAME} ${GUI_BIN_DIR}/open-ephys.lib)
+target_compile_options(${PLUGIN_NAME} PRIVATE /sdl- /W0 /MP)
+
+install(TARGETS ${PLUGIN_NAME} RUNTIME DESTINATION ${GUI_BIN_DIR}/plugins  CONFIGURATIONS ${CMAKE_CONFIGURATION_TYPES})
+install(FILES $<TARGET_PDB_FILE:${PLUGIN_NAME}> DESTINATION  ${GUI_BIN_DIR}/plugins OPTIONAL)
+
+set(CMAKE_PREFIX_PATH ${CMAKE_CURRENT_SOURCE_DIR}/../libs)
 
 #create filters for vs and xcode
 
@@ -94,22 +67,71 @@ foreach( src_file IN ITEMS ${SRC_FILES})
 	source_group("${group_name}" FILES "${src_file}")
 endforeach()
 
-#additional libraries, if needed
-set(LIBONI_DIR ${CMAKE_CURRENT_SOURCE_DIR}/libONI)
-target_include_directories(${PLUGIN_NAME} PRIVATE ${LIBONI_DIR}/include)
-
-if (MSVC)
-  set(LIBONI_LIB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/libONI/win64)
-	target_link_libraries(${PLUGIN_NAME} "${LIBONI_LIB_DIR}/liboni.lib")
-	target_link_libraries(${PLUGIN_NAME} "${LIBONI_LIB_DIR}/riffa.lib")
-	target_link_libraries(${PLUGIN_NAME} "${LIBONI_LIB_DIR}/onidriver_riffa.lib")
-	install(DIRECTORY ${LIBONI_LIB_DIR}/ DESTINATION ${GUI_BIN_DIR}/shared FILES_MATCHING PATTERN "*.dll")
-elseif(LINUX)
-  find_library(LIBONI_LIBRARIES oni liboni PATHS ${CMAKE_CURRENT_SOURCE_DIR}/libONI/linux)
-	target_link_libraries(${PLUGIN_NAME} ${LIBONI_LIBRARIES})
-  install(DIRECTORY ${LIBONI_DIR}/linux/ DESTINATION ${GUI_BIN_DIR}/shared FILES_MATCHING PATTERN "*.so")
-elseif(APPLE)
-  set(LIBONI_LIB_DIR ${CMAKE_CURRENT_SOURCE_DIR}/libONI/osx)
-  target_link_libraries(${PLUGIN_NAME} "${LIBONI_LIB_DIR}/liboni.dylib")
-  install(FILES ${LIBONI_LIB_DIR}/liboni.dylib DESTINATION $ENV{HOME}/Library/Application\ Support/open-ephys/shared-api8)
-endif()
+
+function(vs_set_all_configurations target_name target_config_name)
+    foreach(config ${CMAKE_CONFIGURATION_TYPES})
+        string(TOUPPER ${config} config_upper)
+        set_property(
+            TARGET ${target_name}
+            APPEND PROPERTY MAP_IMPORTED_CONFIG_${config_upper} "${target_config_name}"
+        )
+    endforeach()
+endfunction()
+
+
+# add liboni project
+
+set(LIBONI_DIR "${CMAKE_CURRENT_SOURCE_DIR}/liboni/api/liboni")
+set(LIBONI_NAME liboni)
+set(LIBONI_PNAME "submodule_${LIBONI_NAME}")
+
+include_external_msproject (
+    ${LIBONI_PNAME}
+    "${LIBONI_DIR}/liboni.vcxproj"
+    PLATFORM  ${CMAKE_LIBRARY_ARCHITECTURE}
+)
+
+vs_set_all_configurations(${LIBONI_PNAME} "ReleaseStatic")
+
+add_library("${LIBONI_NAME}" STATIC IMPORTED)
+set_target_properties("${LIBONI_NAME}" PROPERTIES
+  IMPORTED_LOCATION "${LIBONI_DIR}/${CMAKE_LIBRARY_ARCHITECTURE}/ReleaseStatic/liboni.lib"
+  INTERFACE_INCLUDE_DIRECTORIES "${LIBONI_DIR}")
+
+add_dependencies(${LIBONI_NAME} ${LIBONI_PNAME})
+target_link_libraries(${PLUGIN_NAME} "${LIBONI_NAME}")
+
+# add riffa project
+
+set(RIFFA_DIR "${CMAKE_CURRENT_SOURCE_DIR}/liboni/drivers/riffa/windows/lib")
+set(RIFFA_NAME riffa)
+set(RIFFA_PNAME "submodule_${RIFFA_NAME}")
+
+include_external_msproject (
+    ${RIFFA_PNAME}
+    "${RIFFA_DIR}/riffa.vcxproj"
+    PLATFORM  ${CMAKE_LIBRARY_ARCHITECTURE}
+)
+
+vs_set_all_configurations(${RIFFA_PNAME} "Release")
+
+# add onidriver_riffa project
+
+set(ONIDRIVER_RIFFA_DIR "${LIBONI_DIR}/drivers/riffa")
+set(ONIDRIVER_RIFFA_NAME libonidriver_riffa)
+set(ONIDRIVER_RIFFA_PNAME "submodule_${ONIDRIVER_RIFFA_NAME}")
+
+include_external_msproject (
+    ${ONIDRIVER_RIFFA_PNAME}
+    "${ONIDRIVER_RIFFA_DIR}/onidriver_riffa.vcxproj"
+    PLATFORM  ${CMAKE_LIBRARY_ARCHITECTURE}
+)
+
+vs_set_all_configurations(${ONIDRIVER_RIFFA_PNAME} "Release")
+
+
+add_dependencies(${ONIDRIVER_RIFFA_PNAME} ${RIFFA_PNAME}) 
+
+# Ensure needed DLLs are installed to the shared folder
+
+install(FILES "${CMAKE_BINARY_DIR}/${CMAKE_LIBRARY_ARCHITECTURE}/$<CONFIG>/riffa.dll" "${CMAKE_BINARY_DIR}/${CMAKE_LIBRARY_ARCHITECTURE}/$<CONFIG>/${ONIDRIVER_RIFFA_NAME}.dll" DESTINATION ${GUI_BIN_DIR}/shared)

README.md

@@ -29,10 +29,16 @@ Code
 │       └── ...
 ```
 
+To get a fresh install of the repository, use `git clone --recurse-submodules` to fetch the submodule as well.
+
+For existing clones of the repo, run `git submodule update --init --recursive` to initialize the submodule and update it simultaneously.
+
 ### Windows
 
 **Requirements:** [Visual Studio](https://visualstudio.microsoft.com/) and [CMake](https://cmake.org/install/)
 
+#### Create OnixSource project using CMAKE
+
 From the `Build` directory, enter:
 
 ```bash
@@ -42,38 +48,4 @@ cmake -G "Visual Studio 17 2022" -A x64 ..
 Next, launch Visual Studio and open the `OE_PLUGIN_onix-source.sln` file that was just created. Select the appropriate configuration (Debug/Release) and build the solution.
 
 Selecting the `INSTALL` project and manually building it will copy the `.dll` and any other required files into the GUI's `plugins` directory. The next time you launch the GUI from Visual Studio, the ONIX Source plugin should be available.
-
-
-### Linux
-
-**Requirements:** [CMake](https://cmake.org/install/)
-
-From the `Build` directory, enter:
-
-```bash
-cmake -G "Unix Makefiles" ..
-cd Debug
-make -j
-make install
-```
-
-This will build the plugin and copy the `.so` file into the GUI's `plugins` directory. The next time you launch the compiled version of the GUI, the ONIX Source plugin should be available.
-
-
-### macOS
-
-**Requirements:** [Xcode](https://developer.apple.com/xcode/) and [CMake](https://cmake.org/install/)
-
-From the `Build` directory, enter:
-
-```bash
-cmake -G "Xcode" ..
-```
-
-Next, launch Xcode and open the `onix-source.xcodeproj` file that now lives in the “Build” directory.
-
-Running the `ALL_BUILD` scheme will compile the plugin; running the `INSTALL` scheme will install the `.bundle` file to `/Users/<username>/Library/Application Support/open-ephys/plugins-api8`. the ONIX Source plugin should be available the next time you launch the GUI from Xcode.
-
-
-
 

Source/Devices/AnalogIO.cpp

@@ -195,22 +195,9 @@ void AnalogIO::startAcquisition()
 	analogInputSamples.fill(0);
 }
 
-void AnalogIO::stopAcquisition()
-{
-	while (!frameArray.isEmpty())
-	{
-		oni_destroy_frame(frameArray.removeAndReturn(0));
-	}
-}
-
-void AnalogIO::addFrame(oni_frame_t* frame)
-{
-	frameArray.add(frame);
-}
-
 int AnalogIO::getNumberOfFrames()
 {
-	return frameArray.size();
+	return frameQueue.size_approx();
 }
 
 void AnalogIO::addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers)
@@ -221,7 +208,10 @@ void AnalogIO::addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers)
 
 void AnalogIO::processFrame(uint64_t eventWord)
 {
-	oni_frame_t* frame = frameArray.removeAndReturn(0);
+	oni_frame_t* frame;
+	if (!frameQueue.try_dequeue(frame)) { //NB: This method should never be called unless a frame is sure to be there
+		jassertfalse;
+	}
 
 	int16_t* dataPtr = (int16_t*)frame->data;
 
@@ -272,7 +262,7 @@ void AnalogIO::processFrame(uint64_t eventWord)
 
 void AnalogIO::processFrames()
 {
-	while (!frameArray.isEmpty())
+	while (frameQueue.peek() != nullptr )
 	{
 		processFrame();
 	}

Source/Devices/AnalogIO.h

@@ -74,9 +74,7 @@ namespace OnixSourcePlugin
 		int configureDevice() override;
 		bool updateSettings() override;
 		void startAcquisition() override;
-		void stopAcquisition() override;
 		void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) override;
-		void addFrame(oni_frame_t*) override;
 		void processFrames() override;
 
 		void processFrame(uint64_t eventWord = 0);
@@ -117,8 +115,6 @@ namespace OnixSourcePlugin
 
 		AnalogIODataType dataType = AnalogIODataType::Volts;
 
-		Array<oni_frame_t*, CriticalSection, numFrames> frameArray;
-
 		unsigned short currentFrame = 0;
 		unsigned short currentAverageFrame = 0;
 		int sampleNumber = 0;

Source/Devices/AuxiliaryIO.cpp

@@ -56,29 +56,9 @@ bool AuxiliaryIO::isEnabled() const
 
 void AuxiliaryIO::processFrames()
 {
-	if (!digitalIO->isEnabled() && !analogIO->isEnabled())
-	{
-		return;
-	}
-	else if (!digitalIO->isEnabled())
-	{
-		analogIO->processFrames();
-		return;
-	}
-	else if (!analogIO->isEnabled())
-	{
-		digitalIO->processFrames();
-		while (digitalIO->hasEventWord())
-		{
-			digitalIO->getEventWord();
-		}
-
-		return;
-	}
-
 	digitalIO->processFrames();
 
-	while (analogIO->getNumberOfFrames() >= AnalogIO::framesToAverage && digitalIO->getNumberOfWords() >= 1)
+	while (digitalIO->hasEventWord() && analogIO->getNumberOfFrames() >= AnalogIO::framesToAverage)
 	{
 		auto eventWord = digitalIO->getEventWord();
 

Source/Devices/Bno055.cpp

@@ -153,22 +153,6 @@ void Bno055::startAcquisition()
 	sampleNumber = 0;
 }
 
-void Bno055::stopAcquisition()
-{
-	while (!frameArray.isEmpty())
-	{
-		oni_destroy_frame(frameArray.removeAndReturn(0));
-	}
-
-	currentFrame = 0;
-	sampleNumber = 0;
-}
-
-void Bno055::addFrame(oni_frame_t* frame)
-{
-	frameArray.add(frame);
-}
-
 void Bno055::addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers)
 {
 	sourceBuffers.add(new DataBuffer(numberOfChannels, (int)sampleRate * bufferSizeInSeconds));
@@ -177,10 +161,9 @@ void Bno055::addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers)
 
 void Bno055::processFrames()
 {
-	while (!frameArray.isEmpty())
+	oni_frame_t* frame;
+	while (frameQueue.try_dequeue(frame))
 	{
-		oni_frame_t* frame = frameArray.removeAndReturn(0);
-
 		int16_t* dataPtr = ((int16_t*)frame->data) + 4;
 
 		bnoTimestamps[currentFrame] = deviceContext->convertTimestampToSeconds(frame->time);

Source/Devices/Bno055.h

@@ -42,20 +42,9 @@ namespace OnixSourcePlugin
 		Bno055(std::string name, std::string hubName, const oni_dev_idx_t, std::shared_ptr<Onix1> ctx);
 
 		int configureDevice() override;
-
-		/** Update the settings of the device */
 		bool updateSettings() override;
-
-		/** Starts probe data streaming */
 		void startAcquisition() override;
-
-		/** Stops probe data streaming*/
-		void stopAcquisition() override;
-
-		void addFrame(oni_frame_t*) override;
-
 		void processFrames() override;
-
 		void addSourceBuffers(OwnedArray<DataBuffer>& sourceBuffers) override;
 
 		static OnixDeviceType getDeviceType();
@@ -70,8 +59,6 @@ namespace OnixSourcePlugin
 
 		static const int numFrames = 2;
 
-		Array<oni_frame_t*, CriticalSection, numFrames> frameArray;
-
 		bool shouldAddToBuffer = false;
 
 		static const int numberOfChannels = 3 + 3 + 4 + 3 + 1 + 4;