[Release] 1.0.0-beta7

.github/workflows/flucoma-core-ci.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-18.04, windows-latest, macOS-latest]
+        os: [ubuntu-18.04, windows-2019, macOS-latest]
       fail-fast: false 
 
     steps:  
@@ -36,5 +36,5 @@ jobs:
     - name: Test
       working-directory: ${{github.workspace}}/build
 
-      run: ctest -C ${{env.BUILD_TYPE}} -j3 --output-on-failure
-
+      run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure
+

CMakeLists.txt

@@ -6,13 +6,20 @@
 # under the European Union’s Horizon 2020 research and innovation programme
 # (grant agreement No 725899).
 
-cmake_minimum_required (VERSION 3.11)
+cmake_minimum_required (VERSION 3.18)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
 
-get_directory_property(hasParent PARENT_DIRECTORY)
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/script")
 
 #set module path at top level so wrapper projects can easily include fluid_version script
-if(hasParent)
-  set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${CMAKE_CURRENT_SOURCE_DIR}/script PARENT_SCOPE)
+get_directory_property(hasParent PARENT_DIRECTORY)
+if(hasParent)  
+  set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_CURRENT_LIST_DIR}/script"
+  PARENT_SCOPE)
 endif()
 
 if(APPLE)
@@ -23,8 +30,9 @@ endif()
 
 project (flucoma-core LANGUAGES CXX)
 
-include("${CMAKE_CURRENT_SOURCE_DIR}/script/flucoma-buildtype.cmake")
-include("${CMAKE_CURRENT_SOURCE_DIR}/FlucomaVersion.cmake")
+include(flucoma-buildtype)
+include(FlucomaVersion.cmake)
+include(FlucomaClients.cmake)
 
 include(FetchContent)
 set(HISS_PATH "" CACHE PATH "The path to a HISSTools_Library folder. Will pull from github if not set")
@@ -40,8 +48,6 @@ ENDIF (APPLE)
 # Grab the Fluid Decpomposition header files so they can be added to IDE builds
 file(GLOB_RECURSE HEADERS CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/include/**/*.hpp")
 
-set(FETCHCONTENT_QUIET FALSE)
-
 # Either download or point to dependencies
 FetchContent_Declare(
   HISSTools
@@ -53,7 +59,7 @@ FetchContent_Declare(
 FetchContent_Declare(
   Eigen
   GIT_SHALLOW TRUE
-  GIT_REPOSITORY https://gitlab.com/libeigen/eigen
+  GIT_REPOSITORY https://gitlab.com/libeigen/eigen.git
   GIT_PROGRESS TRUE
   GIT_BRANCH "3.4"
   GIT_TAG "3.4.0"
@@ -67,6 +73,24 @@ FetchContent_Declare(
   GIT_TAG "v0.9.0"
 )
 
+FetchContent_Declare(
+  tl_optional 
+  GIT_SHALLOW TRUE
+  GIT_REPOSITORY https://github.com/TartanLlama/optional.git  
+  GIT_PROGRESS TRUE
+)
+
+FetchContent_Declare(
+  json 
+  GIT_SHALLOW TRUE
+  # GIT_REPOSITORY https://github.com/nlohmann/json.git
+  # advice on nlohmann repo is to use this mirror unless we really want ~150 meg of test data as well as headers:
+  GIT_REPOSITORY https://github.com/ArthurSonzogni/nlohmann_json_cmake_fetchcontent
+  GIT_PROGRESS TRUE
+  GIT_TAG v3.10.5
+)
+set(JSON_SystemInclude ON CACHE BOOL "")
+
 if(HISS_PATH) #if hiss path is set, this will stop it downloading
   get_filename_component(FETCHCONTENT_SOURCE_DIR_HISSTOOLS ${HISS_PATH} ABSOLUTE)
 endif()
@@ -79,6 +103,9 @@ if(SPECTRA_PATH) #if spectra path is set, this will stop it downloading
   get_filename_component(FETCHCONTENT_SOURCE_DIR_SPECTRA ${SPECTRA_PATH} ABSOLUTE)
 endif()
 
+if(JSON_PATH)
+  get_filename_component(FETCHCONTENT_SOURCE_DIR_JSON ${JSON_PATH} ABSOLUTE)  
+endif()
 
 FetchContent_GetProperties(HISSTools)
 if(NOT hisstools_POPULATED)
@@ -95,6 +122,21 @@ if(NOT spectra_POPULATED)
   FetchContent_Populate(Spectra)
 endif()
 
+set(OPTIONAL_BUILD_PACKAGE OFF CACHE BOOL "" FORCE)
+set(OPTIONAL_BUILD_TESTS OFF CACHE BOOL "" FORCE)
+FetchContent_GetProperties(tl_optional)
+if(NOT tl_optional_POPULATED)
+  FetchContent_Populate(tl_optional)
+endif()
+
+add_subdirectory(${tl_optional_SOURCE_DIR} ${tl_optional_BINARY_DIR} EXCLUDE_FROM_ALL)
+
+FetchContent_GetProperties(json)
+if(NOT json_POPULATED)
+  FetchContent_Populate(json)  
+endif()
+
+add_subdirectory(${json_SOURCE_DIR} ${json_BINARY_DIR} EXCLUDE_FROM_ALL)
 
 # HISSTools FFT target
 add_library(
@@ -108,9 +150,6 @@ target_link_libraries(
 target_include_directories(HISSTools_FFT PUBLIC "${hisstools_SOURCE_DIR}")
 
 set_target_properties(HISSTools_FFT PROPERTIES
-    CXX_STANDARD 14
-    CXX_STANDARD_REQUIRED ON
-    CXX_EXTENSIONS OFF
     POSITION_INDEPENDENT_CODE ON
 )
 
@@ -133,17 +172,11 @@ add_library(
   "${hisstools_SOURCE_DIR}/AudioFile/OAudioFile.cpp"
 )
 
-set_target_properties(HISSTools_AudioFile PROPERTIES
-    CXX_STANDARD 14
-    CXX_STANDARD_REQUIRED ON
-    CXX_EXTENSIONS OFF
-)
-
 #Fluid Decomposition header-only target
 add_library(FLUID_DECOMPOSITION INTERFACE)
 
 target_include_directories(
-  FLUID_DECOMPOSITION INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include" "${CMAKE_CURRENT_SOURCE_DIR}/thirdparty"
+  FLUID_DECOMPOSITION INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}/include" 
 )
 target_include_directories(
   FLUID_DECOMPOSITION SYSTEM INTERFACE #we don't want warnings from Eigen or HissTools
@@ -152,7 +185,11 @@ target_include_directories(
   "${hisstools_SOURCE_DIR}"
 )
 target_link_libraries(
-  FLUID_DECOMPOSITION INTERFACE HISSTools_FFT flucoma_VERSION_LIB
+  FLUID_DECOMPOSITION INTERFACE 
+  HISSTools_FFT 
+  flucoma_VERSION_LIB 
+  tl::optional
+  nlohmann_json::nlohmann_json
 )
 target_sources(
   FLUID_DECOMPOSITION INTERFACE ${HEADERS}
@@ -177,8 +214,6 @@ if(APPLE)
   target_compile_options(HISSTools_AudioFile PUBLIC -stdlib=libc++)
   target_compile_options(FLUID_DECOMPOSITION INTERFACE -stdlib=libc++)
   target_link_libraries(FLUID_DECOMPOSITION INTERFACE -stdlib=libc++)
-
-
 endif()
 
 #Apply any vector instruction flags

FlucomaClients.cmake

@@ -0,0 +1,158 @@
+# Part of the Fluid Corpus Manipulation Project (http://www.flucoma.org/)
+# Copyright 2017-2019 University of Huddersfield.
+# Licensed under the BSD-3 License.
+# See license.md file in the project root for full license information.
+# This project has received funding from the European Research Council (ERC)
+# under the European Union’s Horizon 2020 research and innovation programme
+# (grant agreement No 725899).
+
+cmake_minimum_required (VERSION 3.11)
+
+function(add_client) 
+  # Define the supported set of keywords
+  set(noValues NOINSTALL)
+  set(singleValues CLASS)
+  set(multiValues GROUP TAGS)
+  # Process the arguments passed in
+  include(CMakeParseArguments)
+  cmake_parse_arguments(ARG
+  "${noValues}"
+  "${singleValues}"
+  "${multiValues}"
+  ${ARGN})  
+
+list(LENGTH ARG_UNPARSED_ARGUMENTS NUM_PLAIN_ARGS)
+
+if(NUM_PLAIN_ARGS LESS 2)
+  message(FATAL_ERROR "add_client called without arguments for object name and header file")
+endif() 
+
+if(NOT ARG_CLASS)
+  message(FATAL_ERROR "add_client: missing CLASS keyword argument")
+endif() 
+
+list(GET ARG_UNPARSED_ARGUMENTS 0 name)  
+list(GET ARG_UNPARSED_ARGUMENTS 1 header)  
+
+if(ARG_NOINSTALL)
+  set(install true)
+else()
+  set(install false)
+endif()
+
+if(ARG_GROUP)
+  set(group ${ARG_GROUP})
+else ()
+  set(group NONE)  
+endif() 
+
+if(ARG_TAGS)
+  foreach(tag ${ARG_TAGS})
+    set_property(GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_${tag} ON)
+  endforeach()
+endif() 
+
+set_property(GLOBAL APPEND PROPERTY FLUID_CORE_CLIENTS ${name})
+set_property(GLOBAL APPEND PROPERTY FLUID_CORE_CLIENTS_${group} ${name})
+set_property(GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_HEADER ${header})
+set_property(GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_CLASS ${ARG_CLASS})
+set_property(GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_INSTALL ${install})    
+endfunction() 
+
+function (add_kr_in_client) 
+  add_client(${ARGN} TAGS KR_IN)  
+endfunction() 
+
+function(get_client_group group var)
+  get_property(clients GLOBAL PROPERTY FLUID_CORE_CLIENTS_${group})
+  set(${var} ${clients} PARENT_SCOPE)
+endfunction()
+
+function(get_core_clients var)
+  get_property(clients GLOBAL PROPERTY FLUID_CORE_CLIENTS)
+  set(${var} ${clients} PARENT_SCOPE)
+endfunction()
+
+function(get_core_client_header name var)
+  get_property(client_info GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_HEADER)
+  set(${var} ${client_info} PARENT_SCOPE)
+endfunction()
+
+function(get_core_client_class name var)
+  get_property(client_info GLOBAL PROPERTY FLUID_CORE_CLIENTS_${name}_CLASS)
+  set(${var} ${client_info} PARENT_SCOPE)
+endfunction()
+# 
+add_client(AmpFeature clients/rt/AmpFeatureClient.hpp CLASS RTAmpFeatureClient )
+add_client(AmpGate clients/rt/AmpGateClient.hpp CLASS RTAmpGateClient )
+add_client(AmpSlice clients/rt/AmpSliceClient.hpp CLASS RTAmpSliceClient )
+add_client(AudioTransport clients/rt/AudioTransportClient.hpp CLASS RTAudioTransportClient )
+add_client(BufAmpFeature clients/rt/AmpFeatureClient.hpp CLASS NRTThreadedAmpFeatureClient )
+add_client(BufAmpGate clients/rt/AmpGateClient.hpp CLASS NRTThreadedAmpGateClient )
+add_client(BufAmpSlice clients/rt/AmpSliceClient.hpp CLASS NRTThreadedAmpSliceClient )
+add_client(BufAudioTransport clients/rt/AudioTransportClient.hpp CLASS NRTThreadedAudioTransportClient )
+add_client(BufChroma clients/rt/ChromaClient.hpp CLASS NRTThreadedChromaClient )
+add_client(BufCompose clients/nrt/BufComposeClient.hpp CLASS NRTThreadedBufComposeClient )
+add_client(BufFlatten clients/nrt/BufFlattenClient.hpp CLASS NRTThreadedBufFlattenClient )
+add_client(BufHPSS clients/rt/HPSSClient.hpp CLASS NRTThreadedHPSSClient )
+add_client(BufLoudness clients/rt/LoudnessClient.hpp CLASS NRTThreadedLoudnessClient )
+add_client(BufMFCC clients/rt/MFCCClient.hpp CLASS NRTThreadedMFCCClient )
+add_client(BufMelBands clients/rt/MelBandsClient.hpp CLASS NRTThreadedMelBandsClient )
+add_client(BufNMF clients/nrt/NMFClient.hpp CLASS NRTThreadedNMFClient )
+add_client(BufNMFCross clients/nrt/NMFCrossClient.hpp CLASS NRTNMFCrossClient )
+add_client(BufNMFSeed clients/nrt/NMFSeedClient.hpp CLASS NRTThreadedNMFSeedClient )
+add_client(BufNoveltyFeature clients/rt/NoveltyFeatureClient.hpp CLASS NRTThreadedNoveltyFeatureClient )
+add_client(BufNoveltySlice clients/rt/NoveltySliceClient.hpp CLASS NRTThreadingNoveltySliceClient )
+add_client(BufOnsetFeature clients/rt/OnsetFeatureClient.hpp CLASS NRTThreadedOnsetFeatureClient )
+add_client(BufOnsetSlice clients/rt/OnsetSliceClient.hpp CLASS NRTThreadingOnsetSliceClient )
+add_client(BufPitch clients/rt/PitchClient.hpp CLASS NRTThreadedPitchClient )
+add_client(BufSTFT clients/nrt/BufSTFTClient.hpp CLASS NRTThreadedBufferSTFTClient )
+add_client(BufScale clients/nrt/BufScaleClient.hpp CLASS NRTThreadedBufferScaleClient )
+add_client(BufSelect clients/nrt/BufSelectClient.hpp CLASS NRTThreadingSelectClient )
+add_client(BufSelectEvery clients/nrt/BufSelectEveryClient.hpp CLASS NRTThreadingSelectEveryClient )
+add_client(BufSines clients/rt/SinesClient.hpp CLASS NRTThreadedSinesClient )
+add_client(BufSpectralShape clients/rt/SpectralShapeClient.hpp CLASS NRTThreadedSpectralShapeClient )
+add_client(BufStats clients/nrt/BufStatsClient.hpp CLASS NRTThreadedBufferStatsClient )
+add_client(BufThreadDemo clients/nrt/FluidThreadTestClient.hpp CLASS NRTThreadedThreadTestClient )
+add_client(BufThresh clients/nrt/BufThreshClient.hpp CLASS NRTThreadedBufferThreshClient )
+add_client(BufTransientSlice clients/rt/TransientSliceClient.hpp CLASS NRTThreadedTransientSliceClient )
+add_client(BufTransients clients/rt/TransientClient.hpp CLASS NRTThreadedTransientsClient )
+add_client(Chroma clients/rt/ChromaClient.hpp CLASS RTChromaClient )
+add_client(Gain clients/rt/GainClient.hpp CLASS RTGainClient NOINSTALL)
+add_client(HPSS clients/rt/HPSSClient.hpp CLASS RTHPSSClient )
+add_client(Loudness clients/rt/LoudnessClient.hpp CLASS RTLoudnessClient )
+add_client(MFCC clients/rt/MFCCClient.hpp CLASS RTMFCCClient )
+add_client(MelBands clients/rt/MelBandsClient.hpp CLASS RTMelBandsClient )
+add_client(NMFFilter clients/rt/NMFFilterClient.hpp CLASS RTNMFFilterClient )
+add_client(NMFMatch clients/rt/NMFMatchClient.hpp CLASS RTNMFMatchClient )
+add_client(NMFMorph clients/rt/NMFMorphClient.hpp CLASS RTNMFMorphClient )
+add_client(NoveltyFeature clients/rt/NoveltyFeatureClient.hpp CLASS RTNoveltyFeatureClient )
+add_client(NoveltySlice clients/rt/NoveltySliceClient.hpp CLASS RTNoveltySliceClient )
+add_client(OnsetFeature clients/rt/OnsetFeatureClient.hpp CLASS RTOnsetFeatureClient )
+add_client(OnsetSlice clients/rt/OnsetSliceClient.hpp CLASS RTOnsetSliceClient )
+add_client(Pitch clients/rt/PitchClient.hpp CLASS RTPitchClient )
+add_client(STFTPass clients/rt/BaseSTFTClient.hpp CLASS RTSTFTPassClient NOINSTALL)
+add_client(Sines clients/rt/SinesClient.hpp CLASS RTSinesClient )
+add_client(SpectralShape clients/rt/SpectralShapeClient.hpp CLASS RTSpectralShapeClient )
+add_kr_in_client(Stats clients/rt/RunningStatsClient.hpp CLASS RunningStatsClient )
+add_client(TransientSlice clients/rt/TransientSliceClient.hpp CLASS RTTransientSliceClient )
+add_client(Transients clients/rt/TransientClient.hpp CLASS RTTransientClient )
+
+#lib manipulation client group 
+add_client(DataSet clients/nrt/DataSetClient.hpp CLASS NRTThreadedDataSetClient GROUP MANIPULATION)
+add_client(DataSetQuery clients/nrt/DataSetQueryClient.hpp CLASS NRTThreadedDataSetQueryClient GROUP MANIPULATION)
+add_client(LabelSet clients/nrt/LabelSetClient.hpp CLASS NRTThreadedLabelSetClient GROUP MANIPULATION)
+add_client(KDTree clients/nrt/KDTreeClient.hpp CLASS NRTThreadedKDTreeClient GROUP MANIPULATION)
+add_client(KMeans clients/nrt/KMeansClient.hpp CLASS NRTThreadedKMeansClient GROUP MANIPULATION)
+add_client(SKMeans clients/nrt/SKMeansClient.hpp CLASS NRTThreadedSKMeansClient GROUP MANIPULATION)
+add_client(KNNClassifier clients/nrt/KNNClassifierClient.hpp CLASS NRTThreadedKNNClassifierClient GROUP MANIPULATION)
+add_client(KNNRegressor clients/nrt/KNNRegressorClient.hpp CLASS NRTThreadedKNNRegressorClient GROUP MANIPULATION)
+add_client(Normalize clients/nrt/NormalizeClient.hpp CLASS NRTThreadedNormalizeClient GROUP MANIPULATION)
+add_client(RobustScale clients/nrt/RobustScaleClient.hpp CLASS NRTThreadedRobustScaleClient GROUP MANIPULATION)
+add_client(Standardize clients/nrt/StandardizeClient.hpp CLASS NRTThreadedStandardizeClient GROUP MANIPULATION)
+add_client(PCA clients/nrt/PCAClient.hpp CLASS NRTThreadedPCAClient GROUP MANIPULATION)
+add_client(MDS clients/nrt/MDSClient.hpp CLASS NRTThreadedMDSClient GROUP MANIPULATION)
+add_client(UMAP clients/nrt/UMAPClient.hpp CLASS NRTThreadedUMAPClient GROUP MANIPULATION)
+add_client(MLPRegressor clients/nrt/MLPRegressorClient.hpp CLASS NRTThreadedMLPRegressorClient GROUP MANIPULATION)
+add_client(MLPClassifier clients/nrt/MLPClassifierClient.hpp CLASS NRTThreadedMLPClassifierClient GROUP MANIPULATION)
+add_client(Grid clients/nrt/GridClient.hpp CLASS NRTThreadedGridClient GROUP MANIPULATION)

FlucomaVersion.cmake

@@ -6,19 +6,20 @@
 # under the European Union’s Horizon 2020 research and innovation programme
 # (grant agreement No 725899).
 
+include_guard() 
+
 cmake_minimum_required (VERSION 3.11)
 
 find_package(Git REQUIRED)
 
 set(flucoma_VERSION_MAJOR 1)
 set(flucoma_VERSION_MINOR 0)
 set(flucoma_VERSION_PATCH 0)
-set(flucoma_VERSION_SUFFIX TB2.beta6)
+set(flucoma_VERSION_SUFFIX TB2.beta7)
 
 function(make_flucoma_version_string output_variable)
-  set(${output_variable}    
-      "${flucoma_VERSION_MAJOR}.${flucoma_VERSION_MINOR}.${flucoma_VERSION_PATCH}-${flucoma_VERSION_SUFFIX}"
-  PARENT_SCOPE)    
+  set(result "${flucoma_VERSION_MAJOR}.${flucoma_VERSION_MINOR}.${flucoma_VERSION_PATCH}-${flucoma_VERSION_SUFFIX}")
+  set(${output_variable} ${result} PARENT_SCOPE)    
 endfunction()
 
 function(make_flucoma_version_string_with_sha output_variable)
@@ -65,3 +66,15 @@ add_library(flucoma_VERSION_LIB STATIC
 target_include_directories(flucoma_VERSION_LIB PRIVATE  
   "${CMAKE_CURRENT_LIST_DIR}/include"
 )
+
+set_target_properties(flucoma_VERSION_LIB PROPERTIES
+    POSITION_INDEPENDENT_CODE ON
+)
+
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION ${flucoma_VERSION_STRING})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_TERSE ${flucoma_VERSION_MAJOR}.${flucoma_VERSION_MINOR}.${flucoma_VERSION_PATCH})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_SHA ${flucoma_VERSION_STRING_SHA})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_MAJOR ${flucoma_VERSION_MAJOR})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_MINOR ${flucoma_VERSION_MINOR})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_PATCH ${flucoma_VERSION_PATCH})
+set_property(GLOBAL PROPERTY FLUCOMA_VERSION_SUFFIX ${flucoma_VERSION_SUFFIX})