cmake_minimum_required(VERSION 3.28)

if(POLICY CMP0177)

cmake_policy(SET CMP0177 NEW)

endif()

include(cmake/ProjectVersion.cmake)

labrecorder_version_from_git(LABRECORDER_VERSION LABRECORDER_VERSION_FULL FALLBACK "1.18.0")

project(LabRecorder

VERSION ${LABRECORDER_VERSION}

DESCRIPTION "Record and write LabStreamingLayer streams to an XDF file"

HOMEPAGE_URL "https://github.com/labstreaminglayer/App-LabRecorder/"

LANGUAGES C CXX

)

set(CMAKE_CXX_STANDARD 20)

set(CMAKE_CXX_STANDARD_REQUIRED ON)

set(CMAKE_EXPORT_COMPILE_COMMANDS ON)

option(LABRECORDER_BUILD_GUI "Build the GUI application (requires Qt6)" ON)

set(LSL_SOURCE_DIR "" CACHE PATH "Path to liblsl source directory")

set(LSL_INSTALL_ROOT "" CACHE PATH "Path to installed liblsl")

option(LSL_FETCH_IF_MISSING "Fetch liblsl from GitHub if not found locally" ON)

set(LSL_FETCH_REF "v1.18.0.b6" CACHE STRING "liblsl git ref to fetch (tag, branch, or commit)")

if(LSL_SOURCE_DIR)

# Priority 1: Build from local source (parallel development)

if(NOT EXISTS "${LSL_SOURCE_DIR}/CMakeLists.txt")

message(FATAL_ERROR "LSL_SOURCE_DIR set to '${LSL_SOURCE_DIR}' but no CMakeLists.txt found there")

endif()

message(STATUS "Using local liblsl source: ${LSL_SOURCE_DIR}")

add_subdirectory("${LSL_SOURCE_DIR}" liblsl_bin EXCLUDE_FROM_ALL)

if(NOT TARGET LSL::lsl)

add_library(LSL::lsl ALIAS lsl)

endif()

set(LSL_FOUND TRUE)

include("${LSL_SOURCE_DIR}/cmake/LSLCMake.cmake")

else()

# Priority 2 & 3: Try to find installed liblsl

set(_lsl_hints)

if(LSL_INSTALL_ROOT)

list(APPEND _lsl_hints "${LSL_INSTALL_ROOT}")

endif()

# Common development layout hints (including CLion cmake-build-* directories)

string(TOLOWER "${CMAKE_BUILD_TYPE}" _build_type_lower)

if(NOT _build_type_lower)

set(_build_type_lower "release")

endif()

if(MSVC)

set(_clion_build_dir "cmake-build-${_build_type_lower}-visual-studio")

else()

set(_clion_build_dir "cmake-build-${_build_type_lower}")

endif()

foreach(_root IN ITEMS "../liblsl" "../../LSL/liblsl")

foreach(_build IN ITEMS "build" "${_clion_build_dir}")

list(APPEND _lsl_hints "${CMAKE_CURRENT_LIST_DIR}/${_root}/${_build}/install")

endforeach()

endforeach()

set(_lsl_suffixes

share/LSL

lib/cmake/LSL

cmake

Frameworks/lsl.framework/Resources/CMake # macOS framework layout

)

# First try: Search only in hints (prefer local builds over system)

find_package(LSL QUIET

HINTS ${_lsl_hints}

PATH_SUFFIXES ${_lsl_suffixes}

NO_DEFAULT_PATH

)

# Second try: Search system paths if not found in hints

if(NOT LSL_FOUND)

find_package(LSL QUIET

PATH_SUFFIXES ${_lsl_suffixes}

)

endif()

if(LSL_FOUND)

message(STATUS "Found installed liblsl: ${LSL_DIR}")

include("${LSL_DIR}/LSLCMake.cmake")

elseif(LSL_FETCH_IF_MISSING)

# Priority 4: Fetch from GitHub

message(STATUS "liblsl not found locally, fetching ${LSL_FETCH_REF} from GitHub...")

include(FetchContent)

# Disable liblsl extras we don't need

set(LSL_BUILD_EXAMPLES OFF CACHE BOOL "" FORCE)

set(LSL_BUILD_TESTING OFF CACHE BOOL "" FORCE)

# EXCLUDE_FROM_ALL prevents liblsl's install rules from running

FetchContent_Declare(liblsl

GIT_REPOSITORY https://github.com/sccn/liblsl.git

GIT_TAG ${LSL_FETCH_REF}

GIT_SHALLOW ON

EXCLUDE_FROM_ALL

)

FetchContent_MakeAvailable(liblsl)

if(NOT TARGET LSL::lsl)

add_library(LSL::lsl ALIAS lsl)

endif()

set(LSL_FOUND TRUE)

include("${liblsl_SOURCE_DIR}/cmake/LSLCMake.cmake")

message(STATUS "liblsl fetched and configured")

else()

message(FATAL_ERROR

"liblsl not found. Options:\n"

" 1. Set LSL_SOURCE_DIR to liblsl source directory\n"

" 2. Set LSL_INSTALL_ROOT to installed liblsl location\n"

" 3. Install liblsl system-wide\n"

" 4. Enable LSL_FETCH_IF_MISSING=ON to auto-fetch from GitHub"

)

endif()

endif()

if(LABRECORDER_BUILD_GUI)

set(CMAKE_AUTOMOC ON)

set(CMAKE_AUTORCC ON)

set(CMAKE_AUTOUIC ON)

find_package(Qt6 REQUIRED COMPONENTS Core Widgets Network)

# macOS: Work around deprecated AGL framework issue in some Qt6 builds

if(APPLE AND TARGET WrapOpenGL::WrapOpenGL)

get_target_property(_wrap_gl_libs WrapOpenGL::WrapOpenGL INTERFACE_LINK_LIBRARIES)

if(_wrap_gl_libs)

list(FILTER _wrap_gl_libs EXCLUDE REGEX ".*AGL.*")

set_target_properties(WrapOpenGL::WrapOpenGL PROPERTIES INTERFACE_LINK_LIBRARIES "${_wrap_gl_libs}")

endif()

endif()

endif()

find_package(Threads REQUIRED)

LSL_configure_rpath()

add_subdirectory(xdfwriter)

if(LABRECORDER_BUILD_GUI)

qt_add_executable(${PROJECT_NAME} MACOSX_BUNDLE WIN32

src/main.cpp

src/mainwindow.cpp

src/mainwindow.h

src/mainwindow.ui

src/recording.h

src/recording.cpp

src/tcpinterface.h

src/tcpinterface.cpp

)

target_link_libraries(${PROJECT_NAME} PRIVATE

xdfwriter

Qt6::Core

Qt6::Widgets

Qt6::Network

Threads::Threads

LSL::lsl

)

# macOS bundle configuration

if(APPLE)

set(MACOSX_BUNDLE_GUI_IDENTIFIER "com.labstreaminglayer.${PROJECT_NAME}")

set(MACOSX_BUNDLE_BUNDLE_VERSION "${PROJECT_VERSION}")

set(MACOSX_BUNDLE_SHORT_VERSION_STRING "${PROJECT_VERSION}")

endif()

endif()

add_executable(${PROJECT_NAME}CLI

src/clirecorder.cpp

src/recording.h

src/recording.cpp

)

target_link_libraries(${PROJECT_NAME}CLI PRIVATE

xdfwriter

Threads::Threads

LSL::lsl

)

if(LABRECORDER_BUILD_GUI)

add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD

COMMAND ${CMAKE_COMMAND} -E copy_if_different

"${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_NAME}.cfg"

"$<TARGET_FILE_DIR:${PROJECT_NAME}>"

)

endif()

add_custom_command(TARGET ${PROJECT_NAME}CLI POST_BUILD

COMMAND ${CMAKE_COMMAND} -E copy_if_different

"${CMAKE_CURRENT_SOURCE_DIR}/${PROJECT_NAME}.cfg"

"$<TARGET_FILE_DIR:${PROJECT_NAME}CLI>"

)

include(GNUInstallDirs)

if(WIN32)

set(INSTALL_BINDIR ".")

set(INSTALL_LIBDIR ".")

set(INSTALL_DATADIR ".")

elseif(APPLE)

set(INSTALL_BINDIR ".")

set(INSTALL_LIBDIR ".")

set(INSTALL_DATADIR ".")

else()

# Linux: use standard FHS layout

set(INSTALL_BINDIR "${CMAKE_INSTALL_BINDIR}")

set(INSTALL_LIBDIR "${CMAKE_INSTALL_LIBDIR}")

set(INSTALL_DATADIR "${CMAKE_INSTALL_DATADIR}/${PROJECT_NAME}")

endif()

install(TARGETS xdfwriter

RUNTIME DESTINATION "${INSTALL_BINDIR}"

LIBRARY DESTINATION "${INSTALL_LIBDIR}"

ARCHIVE DESTINATION "${INSTALL_LIBDIR}"

)

install(TARGETS ${PROJECT_NAME}CLI

RUNTIME DESTINATION "${INSTALL_BINDIR}"

)

if(LABRECORDER_BUILD_GUI)

install(TARGETS ${PROJECT_NAME}

RUNTIME DESTINATION "${INSTALL_BINDIR}"

BUNDLE DESTINATION "${INSTALL_BINDIR}"

)

endif()

set(_config_dest "${INSTALL_DATADIR}")

if(APPLE AND LABRECORDER_BUILD_GUI)

set(_config_dest "${INSTALL_BINDIR}/${PROJECT_NAME}.app/Contents/MacOS")

endif()

install(FILES

${PROJECT_NAME}.cfg

LICENSE

README.md

DESTINATION "${_config_dest}"

)

if(APPLE)

# macOS: Install framework to GUI bundle and CLI Frameworks directory

if(LABRECORDER_BUILD_GUI)

LSL_install_liblsl(

FRAMEWORK_DESTINATION "${INSTALL_BINDIR}/${PROJECT_NAME}.app/Contents/Frameworks"

)

endif()

LSL_install_liblsl(FRAMEWORK_DESTINATION "Frameworks")

else()

# Windows/Linux: Single install location for all targets

LSL_install_liblsl(DESTINATION "${INSTALL_LIBDIR}")

endif()

if(LABRECORDER_BUILD_GUI)

LSL_deploy_qt(TARGET "${PROJECT_NAME}" DESTINATION "${INSTALL_BINDIR}")

endif()

LSL_install_mingw_runtime(DESTINATION "${INSTALL_BINDIR}")

if(APPLE)

if(LABRECORDER_BUILD_GUI)

LSL_codesign(

TARGET "${PROJECT_NAME}"

DESTINATION "${INSTALL_BINDIR}"

ENTITLEMENTS "${CMAKE_CURRENT_SOURCE_DIR}/app.entitlements"

BUNDLE

)

endif()

LSL_codesign(

TARGET "${PROJECT_NAME}CLI"

DESTINATION "${INSTALL_BINDIR}"

ENTITLEMENTS "${CMAKE_CURRENT_SOURCE_DIR}/app.entitlements"

FRAMEWORK "Frameworks/lsl.framework"

)

endif()

LSL_get_target_arch()

LSL_get_os_name()

set(CPACK_PACKAGE_NAME "${PROJECT_NAME}")

set(CPACK_PACKAGE_VERSION "${LABRECORDER_VERSION_FULL}")

set(CPACK_PACKAGE_VENDOR "Labstreaminglayer")

set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "${PROJECT_DESCRIPTION}")

set(CPACK_PACKAGE_HOMEPAGE_URL "${PROJECT_HOMEPAGE_URL}")

set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")

set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")

set(CPACK_PACKAGE_FILE_NAME "${PROJECT_NAME}-${LABRECORDER_VERSION_FULL}-${LSL_OS}_${LSL_ARCH}")

set(CPACK_STRIP_FILES ON)

if(WIN32)

set(CPACK_GENERATOR ZIP)

set(CPACK_WIX_UPGRADE_GUID "ee28a351-3b27-4c2b-8b48-259c87d1b1b4")

elseif(APPLE)

set(CPACK_GENERATOR TGZ)

set(CPACK_DMG_VOLUME_NAME "${PROJECT_NAME}")

else()

set(CPACK_GENERATOR DEB TGZ)

# Debian prereleases must sort before the corresponding stable release.

string(REGEX REPLACE

"^([0-9]+\\.[0-9]+\\.[0-9]+)[.-]?((alpha|beta|rc|a|b)[0-9]+)$"

"\\1~\\2" CPACK_DEBIAN_PACKAGE_VERSION "${LABRECORDER_VERSION_FULL}")

set(CPACK_DEBIAN_PACKAGE_MAINTAINER "LabStreamingLayer Developers")

set(CPACK_DEBIAN_PACKAGE_SECTION "science")

set(CPACK_DEBIAN_PACKAGE_PRIORITY "optional")

set(CPACK_DEBIAN_FILE_NAME "${CPACK_PACKAGE_FILE_NAME}.deb")

set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS OFF)

if(LABRECORDER_BUILD_GUI)

set(CPACK_DEBIAN_PACKAGE_DEPENDS "libqt6widgets6, libqt6network6")

endif()

endif()

include(CPack)