Merge pull request #419 from stoermelder/v2-dev

v2.3.0

Author: stoermelder

.github/workflows/build-plugin.yml

@@ -52,6 +52,7 @@ jobs:
         run: |
           export PLUGIN_DIR=$GITHUB_WORKSPACE
           pushd ${{ env.rack-plugin-toolchain-dir }}
+          git config --global --add safe.directory "$GITHUB_WORKSPACE"
           make plugin-build-${{ matrix.platform }}
       - name: Upload artifact
         uses: actions/upload-artifact@v4

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "dep/orca-c"]
+	path = dep/orca-c
+	url = https://github.com/hundredrabbits/Orca-c.git
+	commit = 9df9786e2ad3c01955cdf4cdd5ae1fffad8fa5cc

CHANGELOG.md

@@ -1,3 +1,34 @@
+## 2.3.0
+
+### New modules
+
+- Module [AHAB](./docs/ahab/Ahab.md)
+    - A live programming environment for ORCA, an esoteric programming language designed to quickly create procedural sequencers
+
+### Changes and Fixes
+
+- Module [8FACE mk2](./docs/eightface/EightFaceMk2.md)
+    - Added performance warning for large module presets (#396)
+    - Fixed broken unbinding of modules (memory leak) (#396)
+- Module [GLUE](./docs/glue/Glue.md)
+    - Added option to add labels to cables (#247)
+- Module [MIDI-CAT](./docs/midicat/MidiCat.md)
+    - Added hotkey Ctrl/Cmd+Shift+R for resetting input-mode _Pickup (snap)_
+    - Added hotkey Ctrl/Cmd+Shift+I for temporarily activating input-mode _Direct_ while held
+    - Added hotkey Ctrl/Cmd+Shift+F for re-sending MIDI feedback
+- Module [MIDI-KEY](./docs/midi/MidiKey.md)
+    - Fixed occasional crash in browser preview
+- Module [SAIL](./docs/sail/Sail.md)
+    - Fixed occasional crash (#358)
+- Module [STROKE](./docs/stroke/Stroke.md)
+    - Fixed broken _Zoom out_ command
+    - Fixed broken Toggle-commands on different UI Scale (#415)
+- Module [TRANSIT](./docs/transit/Transit.md)
+    - Added alternative parameter binding by selection box
+    - Added custom color LED setting per slot
+    - Added option to set the first usable snapshot (instead of starting at 1) (#265)
+    - Added option to disable fade CV input clamping, allowing for more extreme fade times
+
 ## 2.2.0
 
 Modules [8FACE, 8FACEx2](./docs/eightface/EightFace.md) and [8FACE mk2](./docs/eightface/EightFaceMk2.md) are now considered stable again. A new _Safe-mode_ has been added, which loads presets into modules according to the supported way. This provides maximum stability. However, it may lock up the audio processing and cause stutters, pops, or other audible artifacts. This behavior is not caused by CPU overload but by fundamental design constraints in VCV Rack.  
@@ -30,7 +61,7 @@ The old behavior can be restored using _Unsafe fast_-mode, which will load prese
     - Added new defects _Pitch_, _Crush_ and _Dropout_
 - Module [GOTO](./docs/goto/Goto.md)
      - Jump-points can be multiple modules/a selection instead of a single module
-- Nodule [MIDI-CAT](./docs/midicat/MidiCat.md)
+- Module [MIDI-CAT](./docs/midicat/MidiCat.md)
     - Added input-modes _Snapped_ and _Snapped (short/long)_ for CC and Notes for use with snapped parameters (e.g. "Steps" on VCV SEQ3)
     - Added handling for MIDI System Reset message for resetting input-mode _Pickup (snap)_
     - Added color setting for mapping indicators

LICENSE-dist.md

@@ -0,0 +1,56 @@
+## FUNDAMENTAL
+
+https://github.com/VCVRack/Fundamental
+
+All **source code** is copyright © 2016-2023 VCV.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html) as published by the [Free Software Foundation](https://www.fsf.org/), either version 3 of the License, or (at your option) any later version.
+
+The **VCV logo and icon** are copyright © 2017 VCV and may not be used in derivative works.
+
+The **"VCV" name** is trademarked and may not be used for unofficial products.
+
+The **visual design of the Fundamental modules** is copyright © 2019-2023 [VCV](https://vcvrack.com/) and licensed under [CC BY-NC-ND 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/).
+Commercial use and derivative works are not allowed.
+
+
+## AUDIBLE INSTRUMENTS
+
+https://github.com/VCVRack/AudibleInstruments
+
+All **source code** in the `src/` folder is copyright © 2016-2020 Andrew Belt and Audible Instruments contributers.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html) as published by the [Free Software Foundation](https://www.fsf.org/), either version 3 of the License, or (at your option) any later version.
+
+The **panel graphics** in the `res/` folder are copyright © Emilie Gillet and are used and distributed with permission.
+
+**Dependencies** included in the binary distributable may have other licenses.
+See [LICENSE-dist.txt](LICENSE-dist.txt) for a full list.
+
+
+## CORE and VCV RACK
+
+https://github.com/VCVRack/Rack
+
+VCV Rack Free **source code and binaries** are copyright © 2016-2023 VCV.
+
+This program is free software: you can redistribute it and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl-3.0.en.html) as published by the [Free Software Foundation](https://www.fsf.org/), either version 3 of the License, or (at your option) any later version.
+In addition, you are granted the "VCV Rack Non-Commercial Plugin License Exception", allowed under section 7 of GPLv3, and a commercial licensing option.
+
+>#### VCV Rack Non-Commercial Plugin License Exception
+>
+>A Plugin is defined as a software library intended to be linked and executed by this software.
+>
+>You are granted the permission to use this software's Application Programming Interface (API) in your Plugin in source and binary forms, as well as link to this software with the Plugin, regardless of the Plugin's license terms even if it would otherwise violate the terms of this software's GPLv3, provided that the Plugin is distributed free of charge.
+>
+>Derived works of this software may keep or omit this Exception.
+
+This means that non-commercial plugins do not need to be licensed under the GPLv3 and can be released under any license of your choice (e.g. open-source or proprietary freeware). However, plugins that copy a significant portion of non-API source code from Rack must be licensed under GPLv3.
+
+
+## BACONMUSIC
+
+https://github.com/baconpaul/BaconPlugs/
+
+Copyright © 2017-2019 Paul Walker
+Licensed under the Gnu Public License, version 3. https://www.gnu.org/licenses/gpl-3.0.en.html

LICENSE-dist.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Hundredrabbits
+
+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.

LICENSE-orca.md

@@ -1,27 +1,74 @@
 RACK_DIR ?= ../..
 
+# Orca-c dependency
+ORCA_SOURCES = \
+	dep/orca-c/field.c \
+	dep/orca-c/gbuffer.c \
+	dep/orca-c/osc_out.c \
+	dep/orca-c/sim.c \
+	dep/orca-c/sysmisc.c \
+	dep/orca-c/vmio.c \
+	dep/orca-c/thirdparty/oso.c
+
+ORCA_GENERATED_HEADER := src/modules/ahab/orca_examples.hpp
+
 # Add .cpp files to the build
 SOURCES += $(wildcard src/*.cpp src/**/**/*.cpp)
+# Exclude test files from the main build
 SOURCES := $(filter-out src/test/%.cpp,$(SOURCES))
+SOURCES := $(filter-out %.test.cpp,$(SOURCES))
+SOURCES += $(ORCA_SOURCES)
+
+
+orca-c:
+	mkdir -p dep/orca-c
+	git submodule update --init --recursive dep/orca-c
+	cd dep/orca-c && git apply ../../orca-c.diff
+
+# Creates a generated header embedding the ORCA example
+# files in `dep/orca-c/examples`. The header is regenerated when any example
+# file changes.
+orca-examples: $(ORCA_GENERATED_HEADER)
+
+$(ORCA_GENERATED_HEADER): src/modules/ahab/orca_examples.py $(shell find dep/orca-c/examples -type f -name '*.orca')
+	python3 src/modules/ahab/orca_examples.py dep/orca-c/examples > $@
+
+include $(RACK_DIR)/arch.mk
+
+# Link Winsock for Windows
+ifdef ARCH_WIN
+	LDFLAGS += -lws2_32
+endif
+
+# Ensure headers from the orca-c tree (and its thirdparty) are found
+INCLUDES += -Idep/orca-c -Idep/orca-c/thirdparty
+
 
 # Add files to the ZIP package when running `make dist`
 # The compiled plugin and "plugin.json" are automatically added.
 DISTRIBUTABLES += res
 DISTRIBUTABLES += $(wildcard LICENSE*)
 DISTRIBUTABLES += $(wildcard presets)
 
+# Dependencies
+DEP_LOCAL := dep
+DEPS += orca-c
+
+
 include $(RACK_DIR)/plugin.mk
 
 ifdef DEBUG
 	CXXFLAGS := $(filter-out -fno-omit-frame-pointer,$(CXXFLAGS))
 	CXXFLAGS := $(filter-out -funsafe-math-optimizations,$(CXXFLAGS))
 	CXXFLAGS := $(filter-out -O3,$(CXXFLAGS))
 	CXXFLAGS += -O0 -g
+	CFLAGS := $(filter-out -O3,$(CFLAGS))
 	CFLAGS += -O0 -g
 endif
 
 
-# Unit test build rules
+
+# Test build rules
 # Use "make test" to build tests
 # Use "make testrun" to build and run tests
 # Use "make testrun SUCCESS=1" to print test success messages
@@ -30,20 +77,24 @@ ifdef SUCCESS
   	TEST_SUCCESS_FLAG = --success
 endif
 
-TEST_SOURCES += $(wildcard src/test/*.test.cpp)
-TEST_ADD_SOURCES := $(CURDIR)/src/test/catch2/catch_amalgamated.cpp
+TEST_SOURCES += $(wildcard src/**/*.test.cpp src/**/**/*.test.cpp)
+TEST_ADD_SOURCES := $(CURDIR)/src/test/catch_amalgamated.cpp
+
+# Build each test source into its own executable under build/test/ using basenames
+TEST_NAMES := $(patsubst %.cpp,%,$(notdir $(TEST_SOURCES)))
+TEST_BINARIES := $(patsubst %,build/test/%,$(TEST_NAMES))
 
-# Build each test source into its own executable under build/test/
-TEST_BINARIES := $(patsubst src/test/%.cpp,build/test/%,$(TEST_SOURCES))
+# Allow pattern rule to locate test source files by searching these directories
+VPATH := $(sort $(dir $(TEST_SOURCES)))
 
 # Pattern rule to build an individual test executable
-build/test/%: src/test/%.cpp $(CURDIR)/src/test/catch2/catch_amalgamated.cpp $(CURDIR)/src/test/test_context.hpp
+build/test/%: %.cpp $(CURDIR)/src/test/test_context.hpp
 	@mkdir -p $(dir $@)
-	@echo "Building test $@..."
+	@echo "Building $@..."
 	@$(CXX) -std=c++14 \
-		-I$(CURDIR)/src/test -I$(CURDIR)/src/test/catch2 $(FLAGS) -O0 \
+		-I$(CURDIR)/src/test -I$(CURDIR)/src/test $(FLAGS) -O0 \
 		-L$(RACK_DIR) -lRack \
-		-o $@ $(TEST_ADD_SOURCES) $(CURDIR)/$(TARGET) $< 
+		-o $@ $(TEST_ADD_SOURCES) $(CURDIR)/$(TARGET) $<
 
 # Build all test binaries
 # Also copy the Rack shared library to build/test/ to avoid runtime linking issues
@@ -62,6 +113,6 @@ test: $(TEST_BINARIES) $(TARGET)
 testrun: test
 	echo "Running tests..."
 	@set -e; for t in $(TEST_BINARIES); do \
-		echo "Running test $$t..."; \
-		DYLD_LIBRARY_PATH=$(RACK_DIR) ./$$t --order decl $(TEST_SUCCESS_FLAG); \
+		echo "Running $$t..."; \
+		DYLD_LIBRARY_PATH=$(RACK_DIR) ./$$t $(TEST_SUCCESS_FLAG); \
 	done