move soundfont to shared + always install

This simplifies things a bit at the expense that the soundfont is always
included/installed (91 kB).

Added get_data_path() function for generic handling the path to common
data (eg. /usr/local/share/ultragrid if installed). The idea is to catch
all cases - installed (run with absolute or relative path) or run from
inside the source directory in one place.

Author: MartinPulec

.github/scripts/Windows/prepare_msys.sh

@@ -99,17 +99,10 @@ https://github.com/CESNET/GPUJPEG/releases/download/continuous/"$fname"
         cp -r GPUJPEG/* /usr/local/
 )}
 
-install_soundfont() {
-        sf_dir="$GITHUB_WORKSPACE/data/Windows/share/soundfonts"
-        mkdir -p "$sf_dir"
-        cp "$GITHUB_WORKSPACE/data/default.sf3" "$sf_dir"
-}
-
 # Install cross-platform deps
 "$GITHUB_WORKSPACE/.github/scripts/install-common-deps.sh"
 
 build_aja_wrapper
 install_deltacast
 install_gpujpeg
-install_soundfont
 

.github/scripts/macOS/install_others.sh

@@ -71,12 +71,6 @@ install_ndi() {(
         printf '%b' "CPATH=$CPATH\n" >> "$GITHUB_ENV"
 }
 
-install_soundfont() {(
-        sf_dir="$srcroot/data/template/macOS-bundle/Contents/share/soundfonts"
-        mkdir -p "$sf_dir"
-        cp "$GITHUB_WORKSPACE/data/default.sf3" "$sf_dir"
-)}
-
 install_syphon() {
         syphon_dst=/Library/Frameworks
 (
@@ -98,7 +92,7 @@ if [ $# -eq 1 ] && { [ "$1" = -h ] || [ "$1" = --help ] || [ "$1" = help ]; }; t
 fi
 
 if [ $# -eq 0 ] || [ $show_help ]; then
-        set -- deltacast glfw libbacktrace ndi soundfont syphon ximea
+        set -- deltacast glfw libbacktrace ndi syphon ximea
 fi
 
 if [ $show_help ]; then

Makefile.in

@@ -694,6 +694,7 @@ install: all
 	$(INSTALL) -d -m 755 $(DESTDIR)$(man1dir)
 	if [ -n '@MANPAGES@' ]; then $(INSTALL) -m 644 @MANPAGES@ $(DESTDIR)$(man1dir); fi
 	if [ -n '@DLL_LIBS@' ]; then  $(INSTALL) -m 644 @DLL_LIBS@ $(DESTDIR)$(bindir); fi
+	$(INSTALL) -D -m 644 "$(srcdir)"/share/ultragrid/default.sf3 -t "$(DESTDIR)$(datarootdir)/ultragrid"
 	if [ -n "@VULKAN@" ]; then\
 		$(INSTALL) -D -m 644 "$(srcdir)/share/ultragrid/vulkan_shaders/"* -t "$(DESTDIR)$(datadir)/ultragrid/vulkan_shaders"; \
 	fi
@@ -716,6 +717,7 @@ uninstall:
 		$(RM) $(DESTDIR)$(datadir)/metainfo/cz.cesnet.ultragrid.appdata.xml;\
 		$(RM) $(DESTDIR)$(datadir)/pixmaps/ultragrid.png;\
 	fi
+	$(RM) $(DESTDIR)$(datarootdir)/ultragrid/default.sf3
 	if [ -n "@VULKAN@" ]; then\
 		$(RM) "$(DESTDIR)$(datadir)/ultragrid/vulkan_shaders/"*;\
 		rmdir $(DESTDIR)$(datadir)/ultragrid/vulkan_shaders;\

data/scripts/Linux-AppImage/create-appimage.sh

@@ -92,11 +92,6 @@ add_fonts() { # for GUI+testcard2
                         cp "$FONT_PATH" $APPPREFIX/share/fonts
                 done
         done
-        if ls $APPPREFIX/lib/*mixer* >/dev/null 2>&1 ||
-           ls $APPPREFIX/lib/ultragrid/*fluidsynth* >/dev/null 2>&1; then
-                mkdir -p $APPPREFIX/share/soundfonts
-                cp "$srcdir/data/default.sf3" $APPPREFIX/share/soundfonts/
-        fi
 }
 
 # copy dependencies

data/default.sf3 share/ultragrid/default.sf3data/default.sf3 renamed to share/ultragrid/default.sf3

@@ -56,7 +56,7 @@
 #include "types.h"                // for device_info
 #include "utils/color_out.h"      // for color_printf, TBOLD, TRED
 #include "utils/fs.h"             // for get_install_root, get_temp_file
-#include "utils/macros.h"         // for IS_KEY_PREFIX
+#include "utils/macros.h"         // for ARR_COUNT, IS_KEY_PREFIX
 
 struct module;
 
@@ -183,40 +183,35 @@ get_soundfont()
         if (env_fs != NULL) {
                 return strdup(env_fs);
         }
-        const bool force_bundled_sf =
-            getenv("ULTRAGRID_BUNDLED_SF") != NULL &&
-            strcmp(getenv("ULTRAGRID_BUNDLED_SF"), "1") == 0;
-        const char *roots[2] = { "/usr", get_install_root() };
-        if (force_bundled_sf) {
-                roots[0] = get_install_root();
-                roots[1] = "/usr";
-        }
+        char bundled[MAX_PATH_SIZE];
+        snprintf_ch(bundled, "%s/%s", get_data_path(), "default.sf3");
         const char *sf_candidates[] = {
-                // without install prefix
-                "/share/soundfonts/default.sf2",
-                "/share/soundfonts/default.sf3",
-                "/share/sounds/sf2/default-GM.sf2",
-                "/share/sounds/sf3/default-GM.sf3", // Ubuntu
+                "/usr/share/soundfonts/default.sf2",
+                "/usr/share/soundfonts/default.sf3",
+                "/usr/share/sounds/sf2/default-GM.sf2",
+                "/usr/share/sounds/sf3/default-GM.sf3", // Ubuntu
+                bundled,
         };
-        for (size_t i = 0; i < sizeof roots / sizeof roots[0]; ++i) {
-                for (size_t j = 0;
-                     j < sizeof sf_candidates / sizeof sf_candidates[0]; ++j) {
-                        const char  *root = roots[i];
-                        const size_t len =
-                            strlen(root) + strlen(sf_candidates[j]) + 1;
-                        char path[len];
-                        strncpy(path, root, len - 1);
-                        strncat(path, sf_candidates[j], len - strlen(path) - 1);
-                        FILE *f = fopen(path, "rb");
-                        debug_msg(MOD_NAME
-                                  "Trying to open sound font '%s': %s\n",
-                                  path, f ? "success, setting" : "failed");
-                        if (!f) {
-                                continue;
-                        }
-                        fclose(f);
-                        return strdup(path);
+
+        const char *force_bundled_sf = getenv("ULTRAGRID_BUNDLED_SF");
+        if (force_bundled_sf != NULL && strcmp(force_bundled_sf, "1") == 0) {
+                for (size_t i = ARR_COUNT(sf_candidates) - 1; i > 0; --i) {
+                        sf_candidates[i] = sf_candidates[i - 1];
+                }
+                sf_candidates[0] = bundled;
+        }
+
+        for (size_t i = 0; i < ARR_COUNT(sf_candidates); ++i) {
+                const char *path = sf_candidates[i];
+                FILE *f = fopen(path, "rb");
+                debug_msg(MOD_NAME
+                          "Trying to open sound font '%s': %s\n",
+                          path, f ? "success, setting" : "failed");
+                if (!f) {
+                        continue;
                 }
+                fclose(f);
+                return strdup(path);
         }
         MSG(ERROR, "Cannot find any suitable sound font!\n");
         return NULL;

src/audio/capture/fluidsynth.c

@@ -40,14 +40,19 @@
 #include "config.h"
 #include "config_unix.h"
 #include "config_win32.h"
+#else
+#define SRCDIR ".."
 #endif
 
 #include <stdbool.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <sys/stat.h>
 
+#include "debug.h"
 #include "utils/fs.h"
+#include "utils/macros.h"
 #include "utils/string.h"
 
 // for get_exec_path
@@ -63,6 +68,7 @@
 #include "host.h"       // for uv_argv
 #endif
 
+#define MOD_NAME "[fs] "
 
 /**
  * Returns temporary path ending with path delimiter ('/' or '\' in Windows)
@@ -165,8 +171,9 @@ get_exec_path(char *path)
  *           Linux - default "/usr/local", Windows - top-level directory extracted
  *           UltraGrid directory
  */
-const char *get_install_root(void) {
-        static __thread char exec_path[MAX_PATH_SIZE];
+static bool
+get_install_root(char exec_path[static MAX_PATH_SIZE])
+{
         if (!get_exec_path(exec_path)) {
                 return NULL;
         }
@@ -177,12 +184,61 @@ const char *get_install_root(void) {
         *last_path_delim = '\0'; // cut off executable name
         last_path_delim = strrpbrk(exec_path, "/\\");
         if (!last_path_delim) {
-                return exec_path;
+                return true;
         }
         if (strcmp(last_path_delim + 1, "bin") == 0 || strcmp(last_path_delim + 1, "MacOS") == 0) {
                 *last_path_delim = '\0'; // remove "bin" suffix if there is one (not in Windows builds) or MacOS in a bundle
         }
-        return exec_path;
+        return true;
+}
+
+static bool
+dir_exists(const char *path)
+{
+        struct stat sb;
+        if (stat(path, &sb) == -1) {
+                return false;
+        }
+        return S_ISDIR(sb.st_mode);
+}
+
+/**
+ * returns path with UltraGrid data (path to `share/ultragrid` if run from
+ * source, otherwise the corresponding path in system if installed or in
+ * bundle/appimage/extracted dir)
+ * @retval the path; NULL if not found
+ */
+const char *
+get_data_path()
+{
+        static __thread char path[MAX_PATH_SIZE];
+        if (strlen(path) > 0) { // already set
+                return path;
+        }
+
+        const char suffix[] = "/share/ultragrid";
+
+        if (get_install_root(path)) {
+                size_t len = sizeof path - strlen(path);
+                if ((size_t) snprintf(path + strlen(path), len,
+                                      suffix) >= len) {
+                        abort(); // path truncated
+                }
+                if (dir_exists(path)) {
+                        MSG(VERBOSE, "Using data path %s\n", path);
+                        return path;
+                }
+        }
+
+        snprintf_ch(path, SRCDIR "%s", suffix);
+        if (dir_exists(path)) {
+                MSG(VERBOSE, "Using data path %s\n", path);
+                return path;
+        }
+
+        MSG(WARNING, "No data path could have been found!\n");
+        path[0] = '\0'; // avoid quick cached return at start
+        return NULL;
 }
 
 /**

src/utils/fs.c

@@ -4,7 +4,7 @@
  * @author Martin Bela      <[email protected]>
  */
 /*
- * Copyright (c) 2018-2023 CESNET, z. s. p. o.
+ * Copyright (c) 2018-2025 CESNET, zájmové sdružení právnických osob
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -61,8 +61,8 @@ extern "C" {
 
 const char *get_temp_dir(void);
 FILE *get_temp_file(const char **filename);
-const char *get_install_root(void);
- char *strdup_path_with_expansion(const char *orig_path);
+const char *get_data_path(void);
+char *strdup_path_with_expansion(const char *orig_path);
 
 #ifdef __cplusplus
 } // extern "C"

src/utils/fs.h

@@ -51,12 +51,6 @@
 #include "debug.h"
 #include "utils/fs.h"
 
-#ifdef HAVE_CONFIG_H
-#include "config.h" // for SRCDIR
-#else
-#define SRCDIR ".."
-#endif // HAVE_CONFIG_H
-
 #define MOD_NAME "[vulkan] "
 
 using namespace vulkan_display_detail;
@@ -663,19 +657,19 @@ void VulkanDisplay::window_parameters_changed(WindowParameters new_parameters) {
 std::string
 get_shader_path()
 {
-        constexpr char suffix[] = "/share/ultragrid/vulkan_shaders";
+        constexpr char suffix[] = "/vulkan_shaders";
         // note that get_install_root returns bin/.. if run from build,
         // which will not contain the shaders for out-of-tree builds
-        const char *path = get_install_root();
-        if (path != nullptr) {
-                std::string path_to_shaders = std::string(path) + suffix;
+        const char *data_path = get_data_path();
+        if (data_path != nullptr) {
+                std::string path_to_shaders = std::string(data_path) + suffix;
                 std::filesystem::directory_entry dir{ std::filesystem::path(
                     path_to_shaders) };
                 if (dir.exists()) {
                         return path_to_shaders;
                 }
         }
-        return std::string(SRCDIR) + suffix;
+        return {};
 }
 
 } //namespace vulkan_display