add else_subset abstractions; improve path handling when opening patches

Author: evgenykochetkov

.gitignore

@@ -16,3 +16,5 @@ compile_commands.json
 
 src/gen/
 build/
+
+demo/addons/godot-pd/else_subset

CMakeLists.txt

@@ -101,3 +101,40 @@ set_target_properties(
 )
 
 install(TARGETS godot-pd DESTINATION .)
+
+
+
+set(ELSE_SUBSET_ABSTRACTIONS_INSTALL_DESTINATION "${CMAKE_CURRENT_SOURCE_DIR}/demo/addons/godot-pd/else_subset")
+
+file(REMOVE_RECURSE ${ELSE_SUBSET_ABSTRACTIONS_INSTALL_DESTINATION})
+
+file(GLOB PD_ELSE_ABSTRACTIONS_AUDIO "${CMAKE_CURRENT_SOURCE_DIR}/pd-else/Abstractions/Audio/*")
+file(GLOB PD_ELSE_ABSTRACTIONS_CONTROL "${CMAKE_CURRENT_SOURCE_DIR}/pd-else/Abstractions/Control/*")
+file(GLOB PD_ELSE_ABSTRACTIONS_EXTRA "${CMAKE_CURRENT_SOURCE_DIR}/pd-else/Abstractions/Extra/*")
+
+file(COPY
+  ${PD_ELSE_ABSTRACTIONS_AUDIO}
+  ${PD_ELSE_ABSTRACTIONS_CONTROL}
+  ${PD_ELSE_ABSTRACTIONS_EXTRA}
+  DESTINATION ${ELSE_SUBSET_ABSTRACTIONS_INSTALL_DESTINATION}
+)
+
+# these depend on [sfload] and [sfinfo], which are removed from else_subset
+set(EXCLUDED_ABSTRACTIONS
+  "sample~.pd"
+  "player~.pd"
+  "pvoc.player~.pd"
+  "pvoc~.pd" 
+  "gran.player~.pd"
+)
+list(TRANSFORM EXCLUDED_ABSTRACTIONS PREPEND "${ELSE_SUBSET_ABSTRACTIONS_INSTALL_DESTINATION}/")
+file(REMOVE ${EXCLUDED_ABSTRACTIONS})
+
+file(GLOB_RECURSE ELSE_SUBSET_ABSTRACTIONS "${ELSE_SUBSET_ABSTRACTIONS_INSTALL_DESTINATION}/*")
+foreach(FILE_PATH ${ELSE_SUBSET_ABSTRACTIONS})
+    if(NOT IS_DIRECTORY ${FILE_PATH})
+        file(READ ${FILE_PATH} FILE_CONTENTS)
+        string(REPLACE "else/" "" FILE_CONTENTS "${FILE_CONTENTS}")
+        file(WRITE ${FILE_PATH} "${FILE_CONTENTS}")
+    endif()
+endforeach()

src/audio_stream_pd.cpp

@@ -3,6 +3,8 @@
 #include <algorithm>
 #include <filesystem>
 #include <godot_cpp/classes/engine.hpp>
+#include <godot_cpp/classes/os.hpp>
+#include <godot_cpp/classes/project_settings.hpp>
 #include <godot_cpp/core/class_db.hpp>
 #include <godot_cpp/core/error_macros.hpp>
 
@@ -42,8 +44,8 @@ int AudioStreamPD::get_mix_rate() const {
 //////////////
 
 void AudioStreamPlaybackPD::_bind_methods() {
-	ClassDB::bind_method(D_METHOD("open_patch", "path"), &AudioStreamPlaybackPD::open_patch);
-	ClassDB::bind_method(D_METHOD("close_patch", "path"), &AudioStreamPlaybackPD::close_patch);
+	ClassDB::bind_method(D_METHOD("open_patch", "relative_path"), &AudioStreamPlaybackPD::open_patch);
+	ClassDB::bind_method(D_METHOD("close_patch", "relative_path"), &AudioStreamPlaybackPD::close_patch);
 	ClassDB::bind_method(D_METHOD("close_patch_id", "dollar_zero"), &AudioStreamPlaybackPD::close_patch_id);
 	ClassDB::bind_method(D_METHOD("send_bang", "dest"), &AudioStreamPlaybackPD::send_bang);
 	ClassDB::bind_method(D_METHOD("send_float", "dest", "value"), &AudioStreamPlaybackPD::send_float);
@@ -100,13 +102,49 @@ pd::List AudioStreamPlaybackPD::_pd_list_from(const Array &p_arr) {
 	return list;
 }
 
+String AudioStreamPlaybackPD::get_absolute_patch_path(String p_relative_path) {
+	if (OS::get_singleton()->has_feature("editor")) {
+		// Running from an editor binary.
+		return ProjectSettings::get_singleton()->globalize_path("res://")
+												.path_join(p_relative_path)
+												.simplify_path();
+	} else {
+		// Running from an exported project.
+		//
+		// This is NOT identical to using `ProjectSettings.globalize_path()` with a `res://` path,
+		// but is close enough in spirit.
+		// On macOS, this would be `YourGameName.app/Contents/MacOS`
+		// see https://apple.stackexchange.com/questions/228116/add-delete-modify-files-within-a-disk-image-dmg//403082
+		// and https://github.com/godotengine/godot/issues/22950
+		//
+		// Note that you will have to MANUALLY copy the `pd` directory there.
+		// Setting "filter to exporting non-resource files" will pack it
+		// into .pck file that is not accessable by libpd
+		return OS::get_singleton()->get_executable_path()
+								   .get_base_dir()
+								   .path_join(p_relative_path)
+								   .simplify_path();
+	}
+}
+
 AudioStreamPlaybackPD::AudioStreamPlaybackPD() {
 	active = false;
 	stream = nullptr;
 	receiver.set_signaller(this);
 	pd.setReceiver(&receiver);
 	pd.setMidiReceiver(&receiver);
 
+	std::string path_to_else_subset_abstractions = std_string_from(
+		OS::get_singleton()->has_feature("editor")
+			? ProjectSettings::get_singleton()->globalize_path("res://addons/godot-pd/else_subset")
+			: OS::get_singleton()->get_executable_path().get_base_dir().path_join("else_subset")
+	);
+	ERR_FAIL_COND_MSG(
+		!fs::is_directory(fs::path(path_to_else_subset_abstractions)),
+		"Trying to add " + godot_string_from(path_to_else_subset_abstractions) + " to libpd search path, but it does not exist"
+	);
+	pd.addToSearchPath(path_to_else_subset_abstractions);
+
 	// setup external libs
 	else_subset_setup();
 }
@@ -159,12 +197,13 @@ void AudioStreamPlaybackPD::_start(double p_from_pos) {
 	begin_resample();
 }
 
-int AudioStreamPlaybackPD::open_patch(String p_path) {
-	fs::path path = fs::path(std_string_from(p_path)).lexically_normal();
+int AudioStreamPlaybackPD::open_patch(String p_relative_path) {
+	String abs_path = get_absolute_patch_path(p_relative_path);
+	fs::path path = fs::path(std_string_from(abs_path)).lexically_normal();
 	auto filename = path.filename().string();
 	auto dir = path.parent_path().string();
 
-	ERR_FAIL_COND_V_MSG(filename.empty(), -1, "No filename included in path" + p_path);
+	ERR_FAIL_COND_V_MSG(filename.empty(), -1, "No filename included in path" + abs_path);
 
 	if (dir.empty()) {
 		dir = ".";
@@ -178,12 +217,13 @@ int AudioStreamPlaybackPD::open_patch(String p_path) {
 	return patch.dollarZero();
 }
 
-void AudioStreamPlaybackPD::close_patch(String p_path) {
-	fs::path path = fs::path(std_string_from(p_path)).lexically_normal();
+void AudioStreamPlaybackPD::close_patch(String p_relative_path) {
+	String abs_path = get_absolute_patch_path(p_relative_path);
+	fs::path path = fs::path(std_string_from(abs_path)).lexically_normal();
 	auto filename = path.filename().string();
 	auto dir = path.parent_path().string();
 
-	ERR_FAIL_COND_MSG(filename.empty(), "No filename included in path" + p_path);
+	ERR_FAIL_COND_MSG(filename.empty(), "No filename included in path" + abs_path);
 
 	if (dir.empty()) {
 		dir = ".";

src/audio_stream_pd.h

@@ -46,13 +46,14 @@ class AudioStreamPlaybackPD : public AudioStreamPlaybackResampled {
 protected:
 	static void _bind_methods();
 	static pd::List _pd_list_from(const Array &p_arr);
+	static String get_absolute_patch_path(String p_relative_path);
 
 public:
 	int32_t _mix_resampled(AudioFrame *p_dst_buffer, int32_t p_frame_count) override;
 	float _get_stream_sampling_rate() const override;
 	void _start(double p_from_pos) override;
-	int open_patch(String p_path);
-	void close_patch(String p_path);
+	int open_patch(String p_relative_path);
+	void close_patch(String p_relative_path);
 	void close_patch_id(int p_dollar_zero);
 	void send_bang(String p_dest);
 	void send_float(String p_dest, float p_value);