Autodownload liblsl release. On Windows, also extract.

Author: cboulay

.gitignore

@@ -1,4 +1,5 @@
 /bin/
 .idea
 .venv
-*.m~
+*.m~
+*.asv

README.md

@@ -6,9 +6,9 @@ This is the MATLAB interface for liblsl.
     * Using the MATLAB GUI, use File/Set Path...
     * Alternatively, in a script, use `addpath(genpath('path/to/liblsl-Matlab'));`
 * The `bin/` directory needs to contain an up-to-date build of the library file for your MATLAB version.
-    * see [here](https://github.com/sccn/labstreaminglayer/blob/master/doc/BUILD.md#note-about-architectures--binaries) for more information which library you need
+    * see [here](https://github.com/sccn/labstreaminglayer/blob/master/doc/BUILD.md#note-about-architectures--binaries) for more information about which library you need
     * download precompiled libraries from the [liblsl release page](https://github.com/sccn/liblsl/releases)
-    * e.g. `liblsl64.dll` for 64-bit MATLAB on Windows.
+    * e.g. `liblsl64.dll` for 64-bit MATLAB on Windows. (Note: Next LSL releases will change these to `lsl.dll`)
     * e.g. `liblsl64.dylib` and `liblsl64.1.4.0.dylib` for 64-bit MATLAB on MacOS.
     * e.g. `liblsl64.so` and `liblsl64.so.1.4.0` for 64-bit MATLAB in Linux
 * Once this taken care of, see the example files in the examples/ directory for how to use this interface in a MATLAB program.
@@ -22,4 +22,6 @@ This is the MATLAB interface for liblsl.
 If you get an error similar to `lsl_loadlib_ undefined`, then you may need to run the `build_mex.m` script from within the liblsl-Matlab directory.
 (From the command line: `matlab -nodesktop -nosplash -r 'build_mex'`)
 
+If `build_mex` seems to have completed successfully but the error persists, please make sure the liblsl-Matlab/bin folder is on the path.
+
 On MacOS, you may still get an error similar to `Invalid MEX-file [...] lsl_loadlib_.mexmaci64; Reason: image not found.`. To fix this run the following command in a Terminal window from within the liblsl-Matlab directory: `install_name_tool -add_rpath "@loader_path/" bin/lsl_loadlib_.mexmaci64`

build_mex.m

@@ -2,21 +2,28 @@
 % For Octave on Linux, you need the package liboctave-dev installed
 % You also need the liblsl64 binary in the bin folder and a configured
 % C compiler (mex -setup)
-
-libs = {'-llsl64'};
-if isunix
+binarypath = fullfile(fileparts(mfilename('fullpath')), 'bin');
+if ispc
+    if exist(fullfile(binarypath, 'liblsl64.lib'), 'file')
+        libs = {'-llsl64'};
+    elseif exist(fullfile(binarypath, 'lsl.lib'), 'file')
+        libs = {'-llsl'};
+    else
+        error('Neither liblsl64.lib nor lsl.lib found in bin/');
+    end
+elseif isunix
 	libs = {'-llsl64','-ldl'};
-end
-
-
-if ispc && isempty(dir('bin/liblsl64.lib'))
-	error('liblsl64.lib not found in bin/');
+else
+    libs = {'-llsl64'};
 end
 
 ext = ['.' mexext];
 
 files = dir('mex/*.c');
-cd('bin');
+
+orig_path = pwd();
+disp('Building mex files. This may take a few minutes.');
+cd(binarypath);
 for i = 1:length(files)
     f = files(i);
 	[~, base, ~] = fileparts(f.name);
@@ -30,4 +37,4 @@
 if ismac
     system('install_name_tool -add_rpath "@loader_path/" lsl_loadlib_.mexmaci64')
 end
-cd('..');
+cd(orig_path);

lsl_get_dll.m

@@ -12,7 +12,7 @@
 %   lsl_fname : the filename of the library
 
 if ~exist('binarypath','var') || isempty(binarypath)
-    binarypath = [fileparts(mfilename('fullpath')) filesep 'bin'];
+    binarypath = fullfile(fileparts(mfilename('fullpath')), 'bin');
 end
 if ~exist('debugging','var') || isempty(debugging)
     debugging = false;
@@ -28,7 +28,7 @@
     error('Your operating system is not supported by this version of the lab streaming layer API.');
 end
 
-if strfind(computer,'64')
+if contains(computer,'64')
     bitness = '64';
 else
     bitness = '32';
@@ -40,18 +40,56 @@
     debug = '';
 end
 
-dll_fname = sprintf('liblsl%s%s%s', bitness, debug, ext);
-lsl_fname = fullfile(binarypath, dll_fname);
+so_fname = sprintf('liblsl%s%s%s', bitness, debug, ext);
+lsl_fname = fullfile(binarypath, so_fname);
 
-if ~exist(lsl_fname, 'file') && ~ispc
-    new_dllpath = fullfile('/usr/lib/', dll_fname);
-    if exist(new_dllpath, 'file')
-        lsl_fname = new_dllpath;
+if ~exist(lsl_fname, 'file')
+    if ispc
+        % On Windows, also try simply 'lsl.dll'
+        new_sopath = fullfile(binarypath, 'lsl.dll');
+    else
+        new_sopath = fullfile('/usr/lib/', so_fname);
+    end
+    if exist(new_sopath, 'file')
+        lsl_fname = new_sopath;
     end %if
 end %if
 
 if ~exist(lsl_fname,'file')
-    error(['Apparently the file "' dllpath '" is missing on your computer. Cannot load the lab streaming layer.']);
+    disp(['Could not locate the file "' so_fname '" on your computer. Attempting to download...']);
+    LIBLSL_TAG = 'v1.14.0b1';
+    LIBLSL_VER = '1.14.0';
+    liblsl_url = ['https://github.com/sccn/liblsl/releases/download/' LIBLSL_TAG '/'];
+    if ispc
+        liblsl_url_fname = ['liblsl-' LIBLSL_VER '-Win' bitness '.zip'];
+    elseif ismac
+        liblsl_url_fname = ['liblsl-' LIBLSL_VER '-OSX64.tar.bz2'];
+        
+    elseif isunix
+        liblsl_url_fname = ['liblsl-' LIBLSL_VER '-Linux64-bionic.deb'];
+    end
+    try
+        websave(fullfile(binarypath, liblsl_url_fname),...
+            [liblsl_url liblsl_url_fname]);
+    catch ME
+        disp(['Unable to download ' liblsl_url]);
+        rethrow(ME);
+    end
+    if ispc
+        unzip(fullfile(binarypath, liblsl_url_fname),...
+            fullfile(binarypath, 'liblsl_archive'));
+        lsl_fname = fullfile(binarypath, 'lsl.dll');
+        copyfile(fullfile(binarypath, 'liblsl_archive', 'bin', 'lsl.dll'), lsl_fname);
+        copyfile(fullfile(binarypath, 'liblsl_archive', 'lib', 'lsl.lib'),...
+            fullfile(binarypath, 'lsl.lib'));
+    elseif ismac
+        untar(fullfile(binarypath, liblsl_url_fname),...
+            fullfile(binarypath, 'liblsl_archive'));
+        error('TODO: copyfile from liblsl_archive to lsl_fname on mac.');
+    elseif isunix
+        error(['Automatic extraction of debian package not yet supported.', ...
+            ' Please install manually: ' fullfile(binarypath, liblsl_url_fname)]);
+    end
 end
 
 end

lsl_loadlib.m

@@ -43,7 +43,9 @@
     try
         hlib = lsl_loadlib_(dllpath);
     catch e
-	disp('See https://github.com/labstreaminglayer/liblsl-Matlab/#troubleshooting for troubleshooting tips');
+        disp('This error is probably because lsl_loadlib_ mex file is not on the path.');
+        disp('Try running build_mex.m. If that was successful, make sure the liblsl-Matlab/bin folder is added to the path.');
+        disp('See https://github.com/labstreaminglayer/liblsl-Matlab/#troubleshooting for further troubleshooting tips');
         error(['Error loading the liblsl library: ', e.message]);
     end