Merge pull request #2824 from sonic-pi-net/link

Add support for Ableton Link

Author: samaaron

.gitignore

@@ -145,3 +145,7 @@ etc/synthdefs/designs/overtone/sonic-pi/native
 
 # Visual Studio settings folder.
 .vs
+
+
+# Erlang priv dir (for dlls)
+app/server/erlang/tau/priv/*

BUILD-MAC.md

@@ -39,7 +39,7 @@ few dependencies:
 
 1. Xcode (12.1+) and command line tools
 2. Homebrew
-3. All other dependencies - Qt (5.15+), CMake (3.18+)
+3. All other dependencies - Qt5 (5.15+), CMake (3.18+)
 
 ### 1.1 Install Xcode
 
@@ -68,7 +68,7 @@ Once you have Homebrew installed, pulling in the rest of the
 dependencies is a couple of lines to execute within a terminal:
 
 ```
-brew install qt cmake
+brew install qt@5 cmake
 
 ```
 

app/CMakeLists.txt

@@ -14,7 +14,7 @@ set(CMAKE_POSITION_INDEPENDENT_CODE ON)
 set_property(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR} PROPERTY VS_STARTUP_PROJECT ${PROJECT_NAME})
 
 if(APPLE)
-  set(CMAKE_OSX_DEPLOYMENT_TARGET '10.13')
+  set(CMAKE_OSX_DEPLOYMENT_TARGET '10.14')
 endif()
 
 set(APP_ROOT ${CMAKE_CURRENT_LIST_DIR})

app/external/CMakeLists.txt

@@ -1,5 +1,5 @@
 # This CMakeLists builds all the external libraries required for a Sonic Pi
-cmake_minimum_required(VERSION 3.12)
+cmake_minimum_required(VERSION 3.13)
 
 message(STATUS " Aubio Builder")
 
@@ -11,7 +11,7 @@ project(AubioBuilder
 
   include(ExternalProject)
 
-  set(CMAKE_OSX_DEPLOYMENT_TARGET '10.13')
+  set(CMAKE_OSX_DEPLOYMENT_TARGET '10.14')
 
   # sp_midi
 ExternalProject_Add(sp_midi
@@ -24,6 +24,16 @@ ExternalProject_Add(sp_midi
     BUILD_COMMAND ${CMAKE_COMMAND} --build . --config Release
     )
 
+ExternalProject_Add(sp_link
+    PREFIX sp_link-prefix
+    SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/sp_link
+    INSTALL_COMMAND ""
+    CMAKE_ARGS
+        -DERLANG_INCLUDE_PATH=${ERLANG_INCLUDE_PATH}
+        -DCMAKE_OSX_DEPLOYMENT_TARGET=${CMAKE_OSX_DEPLOYMENT_TARGET}
+    BUILD_COMMAND ${CMAKE_COMMAND} --build . --config Release
+    )
+
 ExternalProject_Add(ogg
     PREFIX ogg-prefix
     SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/ogg-1.3.4

app/external/linux_build_externals.sh

@@ -10,8 +10,7 @@ ERLANG_INCLUDE_PATH=`erl -noinput -eval 'io:format("~s~n", [filename:join([lists
 
 cmake -DERLANG_INCLUDE_PATH=${ERLANG_INCLUDE_PATH} -G "Unix Makefiles" ..
 
-echo "Building sp_midi..."
-cmake --build . --target sp_midi
-cmake --build . --target aubio
+echo "Building external deps..."
+cmake --build . --config Release
 
 cd "${SCRIPT_DIR}"

app/external/mac_build_externals.sh

@@ -9,9 +9,7 @@ cd "${SCRIPT_DIR}/build"
 echo "Running cmake with: ERLANG_INCLUDE_PATH=\"${SCRIPT_DIR}/../../prebuilt/macos/headers/erlang/\""
 cmake -G "Unix Makefiles" -D ERLANG_INCLUDE_PATH="${SCRIPT_DIR}/../../prebuilt/macos/headers/erlang/" ..
 
-echo "Building sp_midi..."
-cmake  --build . --target sp_midi
-echo "Building aubio onset..."
-cmake --build . --target aubio
+echo "Building external deps..."
+cmake --build . --config Release
 
 cd "${SCRIPT_DIR}"

app/external/sp_link/.github/workflows/cmake.yml

@@ -0,0 +1,67 @@
+name: CMake
+
+on: [push, pull_request, workflow_dispatch]
+
+env:
+  # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
+  BUILD_TYPE: Release
+
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+
+    # The CMake configure and build commands are platform agnostic and should work equally
+    # well on Windows or Mac.  You can convert this to a matrix build if you need
+    # cross-platform coverage.
+    # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
+
+    steps:
+    - uses: actions/checkout@v2
+    
+    - name: Fetch packages (Linux)
+      if: runner.os == 'Linux'
+      run: |
+        sudo apt-get update
+        sudo apt-get install erlang-dev
+
+    - name: Fetch packages (Mac)
+      continue-on-error: true
+      if: runner.os == 'macOS'
+      run: |
+        export HOMEBREW_NO_INSTALL_CLEANUP=1
+        brew update
+        brew install erlang     
+
+    - name: Fetch packages (Windows)
+      if: runner.os == 'Windows'
+      run: choco install erlang 
+
+#    - name: Setup tmate session
+#      if: runner.os == 'Windows'
+#      uses: mxschmitt/action-tmate@v3
+#      timeout-minutes: 15
+
+    - name: Create Build Environment
+      # Some projects don't allow in-source building, so create a separate build directory
+      # We'll use this as our working directory for all subsequent commands
+      run: cmake -E make_directory ${{github.workspace}}/build
+
+    - name: Configure CMake
+      # Use a bash shell so we can use the same syntax for environment variable
+      # access regardless of the host operating system
+      shell: bash
+      working-directory: ${{github.workspace}}/build
+      # Note the current convention is to use the -S and -B options here to specify source 
+      # and build directories, but this is only available with CMake 3.13 and higher.  
+      # The CMake binaries on the Github Actions machines are (as of this writing) 3.12
+      run: cmake $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=$BUILD_TYPE
+
+    - name: Build
+      working-directory: ${{github.workspace}}/build
+      shell: bash
+      # Execute the build.  You can specify a specific target with "--target <NAME>"
+      run: cmake --build . --config $BUILD_TYPE

app/external/sp_link/.gitignore

@@ -0,0 +1,8 @@
+*.o
+*~
+build/
+.vscode/
+*.beam
+.vs/
+*.bak
+.#*

app/external/sp_link/CMakeLists.txt

@@ -0,0 +1,77 @@
+project (sp_link)
+cmake_minimum_required (VERSION 3.0)
+
+set(CMAKE_VERBOSE_MAKEFILE ON)
+
+if(NOT MSVC)
+    if(APPLE)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14 -stdlib=libc++")
+    else(APPLE)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++14")
+    endif(APPLE)
+endif(NOT MSVC)
+
+
+# If we need to change something based on this running on CI, we can use if(DEFINED ENV{GITHUB_ACTION})
+if(APPLE)
+    set(ERLANG_INCLUDE_PATH "/usr/local/lib/erlang/usr/include" CACHE PATH "Path to erlang includes")
+elseif(UNIX)
+    set(ERLANG_INCLUDE_PATH "/usr/lib/erlang/usr/include" CACHE PATH "Path to erlang includes")
+elseif(MSVC)
+    if(DEFINED ENV{GITHUB_ACTION})
+        set(ERLANG_INCLUDE_PATH "C:/Program Files/erl10.7/usr/include" CACHE PATH "Path to erlang includes")
+    else()
+        set(ERLANG_INCLUDE_PATH "C:/Program Files/erl-24.0/usr/include" CACHE PATH "Path to erlang includes")
+    endif()
+endif(APPLE)
+
+
+# For Link
+include(${PROJECT_SOURCE_DIR}/external_libs/link/AbletonLinkConfig.cmake)
+#target_link_libraries(libsp_link Ableton::Link)
+
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+if(WIN32)
+ include_directories(${PROJECT_SOURCE_DIR}/external_libs/spdlog-1.8.2/include)
+elseif(APPLE)
+ include_directories(${PROJECT_SOURCE_DIR}/external_libs/spdlog-1.8.2/include)
+else()
+ include_directories(${PROJECT_SOURCE_DIR}/external_libs/spdlog-1.8.2/include)
+endif()
+
+set(sp_link_sources
+    src/sp_link.cpp
+    src/sp_link_nifs.cpp
+    src/sp_link_nif_callbacks.cpp
+)
+
+# sp_link_sources
+add_library(libsp_link SHARED ${sp_link_sources})
+SET_TARGET_PROPERTIES(libsp_link PROPERTIES PREFIX "")
+
+#check if armv7l architecture (Raspberry Pi OS 32bit) and add atomic linking if so
+#if (${CMAKE_HOST_SYSTEM_PROCESSOR} MATCHES "armv7l")
+#    message(STATUS("linking atomic for armv7l architecture"))
+#    target_link_libraries(libsp_link atomic)
+#endif()
+
+if(MSVC)
+    add_definitions(-D_WIN32_WINNT=0x0600)
+    include_directories(${ERLANG_INCLUDE_PATH})
+    target_link_libraries(libsp_link Ableton::Link)
+    # example test exe. Only under Windows, because on the others, the NIF functions are resolved when linked to the erlang VM, not on the library
+    add_executable(sp_link_test src/sp_link_test.c)
+    target_link_libraries(sp_link_test libsp_link)
+elseif(APPLE)
+    add_definitions(-DNDEBUG=1)
+    include_directories(${ERLANG_INCLUDE_PATH})
+    set(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -undefined suppress -flat_namespace")
+    set_target_properties(libsp_link PROPERTIES XCODE_ATTRIBUTE_CLANG_LINK_OBJC_RUNTIME "NO")
+#    set(CMAKE_EXE_LINKER_FLAGS "-framework CoreMIDI -framework CoreAudio -framework CoreFoundation -framework Accelerate -framework QuartzCore -framework AudioToolbox -framework IOKit -framework DiscRecording -framework Cocoa")
+    target_link_libraries(libsp_link Ableton::Link "-framework CoreMIDI -framework CoreAudio -framework CoreFoundation -framework Accelerate -framework QuartzCore -framework AudioToolbox -framework IOKit -framework DiscRecording -framework Cocoa")
+elseif(UNIX)
+    add_definitions(-DLINUX=1 -DNDEBUG=1)
+    include_directories(${ERLANG_INCLUDE_PATH})
+    target_link_libraries(libsp_link Ableton::Link)
+endif(MSVC)

app/external/sp_link/LICENSE.md

@@ -0,0 +1,24 @@
+sp_link uses link and spdlog. Please see the licenses in the respective "external_libs" directories
+
+-------------------------------------------------------------------------------
+For sp_link itself:
+
+MIT License
+
+Copyright (c) 2021 Luis Lloret
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.