Merge branch 'master' into tstenner/outlet_sync

Author: cboulay

.clang-tidy

@@ -12,6 +12,7 @@ Checks: |
         -readability-isolate-declaration,
         -readability-function-cognitive-complexity,
     bugprone-*,
-    concurrency-*
+        -bugprone-easily-swappable-parameters,
+    concurrency-*,
     portability-*
 ...

.editorconfig

@@ -6,3 +6,7 @@ insert_final_newline = true
 charset = utf-8
 indent_style = tab
 
+[*.yaml]
+indent_style = space
+indent_size = 2
+

.github/workflows/cppcmake.yml

@@ -3,8 +3,12 @@ name: C/C++ CI
 on:
   push:
     branches: ['*']
-    tags: 
-    paths_ignore: ['docs/**', '.travis.yml']
+    tags: ['*']
+    paths:
+      - '**'
+      - '!docs/**'
+      - '!.github/**'
+      - '.github/workflows/cppcmake.yml'
   pull_request:
   release:
     types: ['created']
@@ -30,8 +34,8 @@ jobs:
         config:
         - {name: "ubuntu-20.04", os: "ubuntu-20.04",   cmake_extra: "-DLSL_BUNDLED_PUGIXML=OFF"}
         - {name: "ubuntu-18.04", os: "ubuntu-latest",  docker: "ubuntu:18.04" }
-        - {name: "windows-x64",  os: "windows-latest", cmake_extra: "-T v140,host=x86"}
-        - {name: "windows-32",   os: "windows-latest", cmake_extra: "-T v140,host=x86 -A Win32"}
+        - {name: "windows-x64",  os: "windows-2019", cmake_extra: "-T v140,host=x86"}
+        - {name: "windows-32",   os: "windows-2019", cmake_extra: "-T v140,host=x86 -A Win32"}
         - {name: "macOS-latest", os: "macOS-latest"}
 
     # runs all steps in the container configured in config.docker or as subprocesses when empty
@@ -60,7 +64,8 @@ jobs:
                 -DCPACK_PACKAGE_DIRECTORY=${PWD}/package \
                 -Dlslgitrevision=${{ github.sha }} \
                 -Dlslgitbranch=${{ github.ref }} \
-                ${{ matrix.config.cmake_extra }} 
+                ${{ matrix.config.cmake_extra }} \
+                ${{ github.event.inputs.cmakeextra }}
             echo ${PWD}
     - name: make
       run: cmake --build build --target install --config Release -j
@@ -82,6 +87,7 @@ jobs:
               dpkg -I package/liblsl*.deb
            fi
            cmake -E remove_directory package/_CPack_Packages
+           cp testing/lslcfgs/default.cfg .
     - name: upload install dir
       uses: actions/upload-artifact@master
       with:

.github/workflows/mingw_static.yml

@@ -3,14 +3,17 @@ name: MinGW Windows static test
 on:
   push:
     branches: ['*']
-    tags: 
-    paths_ignore: ['docs/**', '.travis.yml']
+    paths:
+      - '**'
+      - '!docs/**'
+      - '!.github/**'
+      - '.github/workflows/mingw_static.yml'
   pull_request:
 
 jobs:
   build:
     name: MinGW batteries-included
-    runs-on: windows-latest
+    runs-on: windows-2019
 
     defaults:
       run:

.github/workflows/sanitize.yml

@@ -0,0 +1,64 @@
+name: Clang Sanitizer
+
+on:
+  workflow_dispatch:
+    inputs:
+      cmakeextra:
+        description: "Extra CMake options"
+        required: false
+        default: ""
+      sanitizer:
+        description: 'Sanitizer to run'
+        required: true
+        default: 'address'
+        options: ['address', 'thread', 'memory', 'undefined']
+        type: choice
+
+defaults:
+  run:
+    shell: bash
+
+jobs:
+  build:
+    name: "${{ github.event.inputs.sanitizer }}"
+    runs-on: 'ubuntu-latest'
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install build toolchain
+        run: |
+          wget https://apt.llvm.org/llvm-snapshot.gpg.key
+          echo "deb [signed-by=$PWD/llvm-snapshot.gpg.key] http://apt.llvm.org/focal/ llvm-toolchain-focal-13 main" | sudo tee /etc/apt/sources.list.d/llvm.list
+          sudo apt update
+          sudo apt install -y libpugixml-dev clang-13 gdb
+      - name: Configure CMake
+        run: |
+          # linking a C++ library to a C program fails with ubsan enabled; disable lslver for this run
+          sed -i -e'/lslver/d' CMakeLists.txt
+          cmake --version
+          cmake -S . -B build \
+               -DCMAKE_BUILD_TYPE=RelWithDebInfo \
+               -DCMAKE_C_COMPILER=clang-13 \
+               -DCMAKE_{CXX_COMPILER,LINKER}=clang++-13 \
+               -DCMAKE_{C,CXX,EXE_LINKER,SHARED_LINKER}_FLAGS="-fsanitize=${{ github.event.inputs.sanitizer }}" \
+               -DLSL_COMFY_DEFAULTS=ON \
+               -DLSL_UNITTESTS=ON \
+               -DLSL_BENCHMARKS=ON \
+               -DLSL_BUILD_EXAMPLES=OFF \
+               -DLSL_BUNDLED_PUGIXML=OFF \
+               -DLSL_SLIMARCHIVE=ON \
+               -DLSL_OPTIMIZATIONS=ON \
+               -Dlslgitrevision=${{ github.sha }} \
+               -Dlslgitbranch=${{ github.ref }} \
+               ${{ github.event.inputs.cmakeextra }}
+           echo ${PWD}
+
+      - name: make
+        run: cmake --build build --config RelWithDebInfo -j
+
+      - name: run unit tests
+        run: |
+          # alias gdbwrap="gdb --batch -ex 'run --order rand --wait-for-keypress never --durations yes' -ex 'thread apply all bt' -return-child-result"
+          gdb --batch -ex 'run --order rand --wait-for-keypress never --durations yes' -ex 'thread apply all bt' -return-child-result build/testing/lsl_test_internal
+          gdb --batch -ex 'run --order rand --wait-for-keypress never --durations yes' -ex 'thread apply all bt' -return-child-result build/testing/lsl_test_exported
+        timeout-minutes: 15

.gitignore

@@ -1,4 +1,6 @@
 /build*/
+/install/
+/package/
 /CMakeLists.txt.user
 /CMakeLists.json
 /CMakeSettings.json

CHANGELOG.md

@@ -1,3 +1,18 @@
+# Changes for liblsl 1.16
+
+* add: optional, minimal header-only replacement for Boost.Serialization (Tristan Stenner)
+* add: extensible `lsl_create_inlet_ex()` for high-precision buffer lengths (Chadwick Boulay)
+* change: replace Boost.Uuid, Boost.Random and Boost.Thread with built-in functions (Tristan Stenner)
+* change: replace Boost.Asio with upstream Asio (Tristan Stenner)
+* change: update bundled Boost to 1.78 (Tristan Stenner)
+* change: allow building against system Boost again (@chausner)
+* change: speed up resolving a fixed number of streams (Tristan Stenner)
+* change: reduce Asio operation overhead (Tristan Stenner)
+* change: IPv6 is enabled by default on macOS (Tristan Stenner)
+* change: share io contexts for IPv4+IPv6 services (Tristan Stenner)
+* **change**: send resolve requests from all local network interfaces (Tristan Stenner)
+* fix: fix a minor memory leak when closing streams (Tristan Stenner)
+
 # Changes for liblsl 1.15.2
 
 * fix: bump artifact / soname version

CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_minimum_required (VERSION 3.12)
 project (liblsl
-	VERSION 1.15.2
+	VERSION 1.16.0
 	LANGUAGES C CXX
 	DESCRIPTION "Labstreaminglayer C/C++ library"
 	HOMEPAGE_URL "https://github.com/sccn/liblsl"

README.md

@@ -20,9 +20,15 @@ The most up-to-date instructions are in the
 Precompiled packages are uploaded
 
 - to the [Release page](https://github.com/sccn/liblsl/releases)
-- the [Anaconda cloud](https://anaconda.org/conda-force/liblsl), install with `conda install -c conda-forge liblsl`
+- the [Anaconda cloud](https://anaconda.org/conda-forge/liblsl), install with `conda install -c conda-forge liblsl`
 
-To compile the library yourself from source please follow the [online documentation](https://labstreaminglayer.readthedocs.io/dev/lib_dev.html).
+liblsl is also available via the following package managers:
+
+- [vcpkg](https://vcpkg.io)
+- [Conan](https://conan.io/center/liblsl)
+
+To compile the library yourself from source,
+please follow the [online documentation](https://labstreaminglayer.readthedocs.io/dev/lib_dev.html).
 
 For single board computers running linux, you can also try
 `standalone_compilation_linux.sh`.

examples/SendDataInChunks.cpp

@@ -25,14 +25,14 @@ struct fake_device {
 	*/
 	std::size_t n_channels;
 	double srate;
-	int64_t pattern_samples;
-	int64_t head;
+	std::size_t pattern_samples;
+	std::size_t head;
 	std::vector<int16_t> pattern;
 	std::chrono::steady_clock::time_point last_time;
 
 	fake_device(const int16_t n_channels, const float srate)
 		: n_channels(n_channels), srate(srate), head(0) {
-		pattern_samples = (int64_t)(srate - 0.5) + 1;  // truncate OK.
+		pattern_samples = (std::size_t)(srate - 0.5) + 1;  // truncate OK.
 
 		// Pre-allocate entire test pattern. The data _could_ be generated on the fly
 		//  for a much smaller memory hit, but we also use this example application
@@ -47,8 +47,9 @@ struct fake_device {
 				// sin(2*pi*f*t), where f cycles from 1 Hz to Nyquist: srate / 2
 				double f = (chan_ix + 1) % (int)(srate / 2);
 				pattern.emplace_back(
-					offset_0 + chan_ix * offset_step +
-					magnitude * static_cast<int16_t>(sin(2 * M_PI * f * sample_ix / srate)));
+					static_cast<int16_t>(
+						offset_0 + chan_ix * offset_step +
+						magnitude * sin(2 * M_PI * f * sample_ix / srate)));
 			}
 		}
 		last_time = std::chrono::steady_clock::now();
@@ -70,8 +71,8 @@ struct fake_device {
 		auto now = std::chrono::steady_clock::now();
 		auto elapsed_nano =
 			std::chrono::duration_cast<std::chrono::nanoseconds>(now - last_time).count();
-		int64_t elapsed_samples = std::size_t(elapsed_nano * srate * 1e-9); // truncate OK.
-		elapsed_samples = std::min(elapsed_samples, (int64_t)(buffer.size() / n_channels));
+		std::size_t elapsed_samples = std::size_t(elapsed_nano * srate * 1e-9); // truncate OK.
+		elapsed_samples = std::min(elapsed_samples, (std::size_t)(buffer.size() / n_channels));
 		if (nodata) {
 			// The fastest but no patterns.
 			// memset(&buffer[0], 23, buffer.size() * sizeof buffer[0]);
@@ -126,7 +127,7 @@ int main(int argc, char **argv) {
 			chn.append_child_value("unit", "microvolts");
 			chn.append_child_value("type", type);
 		}
-		int32_t buf_samples = max_buffered * samplingrate;
+		int32_t buf_samples = (int32_t)(max_buffered * samplingrate);
 		auto flags = static_cast<lsl_transport_options_t>(
 			(do_sync ? transp_sync_blocking : transp_default) | transp_bufsize_samples);
 		lsl::stream_outlet outlet(info, chunk_samples, buf_samples, flags);