Publish initial version

Author: florin-pop

.gitignore

@@ -13,3 +13,11 @@
 
 # IDEs
 .idea/
+.vscode/
+.vs/
+
+# Dependencies
+liblsl/
+
+# OS specific
+.DS_Store

CMakeLists.txt

@@ -1,4 +1,7 @@
 cmake_minimum_required(VERSION 3.5.0)
+
+set(CMAKE_OSX_ARCHITECTURES "x86_64") # force x86 archictecture on mac as Open Ephys still runs under Rosetta
+
 if (NOT DEFINED GUI_BASE_DIR)
 	if (DEFINED ENV{GUI_BASE_DIR})
 		set(GUI_BASE_DIR $ENV{GUI_BASE_DIR})
@@ -27,7 +30,7 @@ set_property(DIRECTORY APPEND PROPERTY COMPILE_DEFINITIONS
 	$<$<CONFIG:Debug>:DEBUG=1>
 	$<$<CONFIG:Debug>:_DEBUG=1>
 	$<$<CONFIG:Release>:NDEBUG=1>
-)
+	)
 
 
 set(SOURCE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/Source)
@@ -57,9 +60,12 @@ if (NOT CMAKE_LIBRARY_ARCHITECTURE)
 	endif()
 endif()
 
+find_package(LSL REQUIRED
+HINTS "${PROJECT_FOLDER}/liblsl")
+
 #Libraries and compiler options
 if(MSVC)
-	target_link_libraries(${PLUGIN_NAME} ${GUI_BIN_DIR}/open-ephys.lib)
+	target_link_libraries(${PLUGIN_NAME} PRIVATE ${GUI_BIN_DIR}/open-ephys.lib LSL::lsl)
 	target_compile_options(${PLUGIN_NAME} PRIVATE /sdl- /W0)
 
 	install(TARGETS ${PLUGIN_NAME} RUNTIME DESTINATION ${GUI_BIN_DIR}/plugins  CONFIGURATIONS ${CMAKE_CONFIGURATION_TYPES})
@@ -78,8 +84,13 @@ elseif(APPLE)
 	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)
+	install(TARGETS ${PLUGIN_NAME} DESTINATION $ENV{HOME}/Library/Application\ Support/open-ephys/plugins-api8)
 	set(CMAKE_PREFIX_PATH /opt/local)
+
+	target_link_libraries(${PLUGIN_NAME}
+		PRIVATE
+		LSL::lsl
+	)
 endif()
 
 #create filters for vs and xcode
@@ -91,17 +102,4 @@ foreach( src_file IN ITEMS ${SRC_FILES})
 	source_group("${group_name}" FILES "${src_file}")
 endforeach()
 
-#additional libraries, if needed
-find_package(LSL REQUIRED
-	HINTS ${LSL_INSTALL_ROOT}
-	PATH_SUFFIXES share/LSL
-)
-target_link_libraries(${PLUGIN_NAME} LSL::lsl)
-
-# Copy lsl.dll into the build folder for easier debugging.
-if (WIN32)
-	add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
-			COMMAND ${CMAKE_COMMAND} -E copy_if_different
-			$<TARGET_FILE:LSL::lsl>
-			$<TARGET_FILE_DIR:${PLUGIN_NAME}>)
-endif()
+

README.md

@@ -1,78 +1,89 @@
-# LabStreamingLayer OpenEphys Data Thread Plugin
+# Introduction
 
-This repository contains a [LabStreamingLayer](http://labstreaminglayer.readthedocs.io/) **Data Thread** plugin for the [Open Ephys GUI](https://github.com/open-ephys/plugin-GUI).
+This is an [Open Ephys GUI](https://github.com/open-ephys/plugin-GUI) data thread plugin for [LSL](https://labstreaminglayer.readthedocs.io/index.html) streams.
+Please read the guide regarding compiling plugins from [open-ephys](https://open-ephys.github.io/gui-docs/Developer-Guide/Compiling-plugins.html) and install cmake.
 
-## Releases
+## How to build
 
-TODO: These don't exist yet...
+The plugin repo needs to be cloned inside a directory (e.g. MyPlugins) that is at the same level as [plugin-GUI](https://github.com/open-ephys/plugin-GUI/), for example:
 
-Check the repository's [releases](https://github.com/labstreaminglayer/OpenEphysLSL-Inlet/releases) page for a downloadable plugin.
-
-## Building
-
-### Prerequisite: liblsl
-
-You will need `liblsl` on your local disk in a location that CMake can find. This is platform-dependent.
-
-#### MacOS
-
-The easiest way is to use homebrew:
-
-`brew install labstreaminglayer/tap/lsl`
+```
+/Users/foo/plugin-GUI
+/Users/foo/plugin-GUI/MyPlugins/lsl-inlet
+```
 
-Otherwise, see the [Miscellaneous Platforms](#miscellaneous-platforms) section.
+### macOS
 
-#### Windows
+A debug version of the plugin will not work with a release version of `Open Ephys GUI` and a release version of the plugin will not work with a debug version of `Open Ephys GUI`. Keep this in mind when deciding how to generate the makefiles.
 
-Download `liblsl-x.xx.x-Win_amd64.zip` (where x.xx.x is the latest version number) from the [liblsl Releases page](https://github.com/sccn/liblsl/releases).
-Extract that archive somewhere convenient.
-Pass the path to the extracted folder as a CMake argument (`-DLSL_INSTALL_ROOT=path/to/extracted/liblsl`).
+Download liblsl:
 
-#### Ubuntu Linux
+```
+mkdir liblsl
+cd liblsl
+curl -OL https://github.com/sccn/liblsl/releases/download/v1.16.0/liblsl-1.16.0-OSX_amd64.tar.bz2
+tar xvf liblsl-1.16.0-OSX_amd64.tar.bz2
+```
 
-Download `liblsl-x.xx.x-yyy_amd64.deb` (where x.xx.x is the latest version number and yyy is the name of your Ubuntu distribution) from the [liblsl Releases page](https://github.com/sccn/liblsl/releases). Use your Ubuntu package manager to install it.
+On macOS either "Xcode" or "Unix Makefiles" can be generated and used to successfully build the plugin.
+If you prefer to work with VSCode then "Unix Makefiles" should be used.
+Generate the Makefile using:
 
-#### Miscellaneous Platforms
+```
+cd Build
+cmake -DCMAKE_OSX_ARCHITECTURES="x86_64" -G "Unix Makefiles" ..
+```
 
-See the [liblsl README](https://github.com/sccn/liblsl#building-liblsl) for more options.
+For a release build run:
 
-### Prerequisite: OpenEphys Plugin-GUI
+```
+cd Build
+cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_OSX_ARCHITECTURES="x86_64" -G "Unix Makefiles" ..
+```
 
-You also need the OpenEphys Plugin GUI Source code.
+Build a binary:
 
-Download or clone from its repo [here](https://github.com/open-ephys/plugin-GUI).
+```
+cd Build
+make
+```
 
-Your folder structure should look like the following
+Install the plugin:
 
 ```
-shared_root/
-    - plugin-GUI
-    - OEPlugins/
-        OpenEphysLSL-Inlet (this repo)
+cd Build
+make install
 ```
 
-### Repository structure
+This will copy the plugin (`OpenEphysLSL-Inlet.bundle`) to the `$HOME/Application Support/open-ephys/plugins-api8/` folder
+and will available the next time `Open Ephys GUI` is launched.
 
-This repository contains 3 top-level directories:
+### Windows
 
-- `Build` - Plugin build files will be auto-generated here. These files will be ignored in all `git` commits.
-- `Source` - All plugin source files (`.h` and `.cpp`) should live here. There can be as many source code sub-directories as needed.
-- `Resources` - This is where you should store any non-source-code files, such as library files or scripts.
+The build was tested using Visual Studio 2022 Community Edition.
+First, download liblsl from [GitHub](https://github.com/sccn/liblsl/releases/download/v1.16.0/liblsl-1.16.0-Win_amd64.zip) and extract it inside the plugin directory.
+The folder structure can be:
 
-### Providing libraries for Windows
+```
+OpenEphysLSL-Inlet
+|
+|--liblsl
+	|
+	|-- bin
+	|-- include
+	|-- lib
+```
 
-Since Windows does not have standardized paths for libraries, as Linux and macOS do, it is sometimes useful to pack the appropriate Windows version of the required libraries alongside the plugin.
-To do so, a _libs_ directory has to be created **at the top level** of the repository, alongside this README file, and files from all required libraries placed there. The required folder structure is:
+Open `Developer Command Prompt for VS 2022` and generate the Makefile using cmake:
 
 ```
-    libs
-    ├─ include           #library headers
-    ├─ lib
-        ├─ x64           #64-bit compile-time (.lib) files
-        └─ x86           #32-bit compile time (.lib) files, if needed
-    └─ bin
-        ├─ x64           #64-bit runtime (.dll) files
-        └─ x86           #32-bit runtime (.dll) files, if needed
+cd Build
+cmake -G "Visual Studio 17 2022" -A x64 ..
 ```
 
-DLLs in the bin directories will be copied to the open-ephys GUI _shared_ folder when installing.
+You can now open the `ALL_BUILD.vcxproj` file from the Build folder with Visual Studio and build a binary. 
+
+To install the plugin copy the file `OpenEphysLSL-Inlet.dll` to the `C:\ProgramData\Open Ephys\plugins-api8` folder and copy
+the file `lsl.dll` to the `C:\ProgramData\Open Ephys\shared-api8` folder.
+
+The plugin will load the next time `Open Ephys GUI` is launched.