Prevent binary data regeneration at compile time for faster builds

Author: timothyschoen

CMakeLists.txt

@@ -158,9 +158,6 @@ file(GLOB StandaloneBinarySources
     ${CMAKE_CURRENT_SOURCE_DIR}/Resources/Extra/GeneralUser_GS.sf3
     )
 
-juce_add_binary_data(PlugDataBinaryData SOURCES ${plugdata_resources})
-set_target_properties(PlugDataBinaryData PROPERTIES POSITION_INDEPENDENT_CODE ON)
-
 file(GLOB plugdata_global_sources
     ${CMAKE_CACHEFILE_DIR}/plugdata_artefacts/JuceLibraryCode/JuceHeader.h)
 
@@ -298,9 +295,13 @@ else()
 add_compile_definitions(NANOVG_GL3_IMPLEMENTATION=1)
 endif()
 
+file(GLOB BINARY_DATA_FILES ${CMAKE_CURRENT_BINARY_DIR}/BinaryData/*.cpp)
+add_library(BinaryData STATIC ${BINARY_DATA_FILES})
+target_include_directories(BinaryData INTERFACE ${CMAKE_CURRENT_BINARY_DIR}/BinaryData)
+
 set(libs
   juce
-  PlugDataBinaryData
+  BinaryData
   nanovg
 )
 
@@ -592,10 +593,10 @@ elseif(APPLE)
   if(NOT "${CMAKE_SYSTEM_NAME}" MATCHES "iOS")
     set(LINK_CARBON "-framework Carbon")
   endif()
-  target_link_libraries(plugdata_standalone PRIVATE plugdata_core pd-src externals ${LINK_CARBON} ${MACOS_COMPAT_LINKER_FLAGS})
-  target_link_libraries(plugdata_midi PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} ${MACOS_COMPAT_LINKER_FLAGS})
-  target_link_libraries(plugdata PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} ${MACOS_COMPAT_LINKER_FLAGS})
-  target_link_libraries(plugdata_fx PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} ${MACOS_COMPAT_LINKER_FLAGS})
+  target_link_libraries(plugdata_standalone PRIVATE plugdata_core pd-src externals ${LINK_CARBON} $<$<NOT:$<CONFIG:Debug>>:${MACOS_COMPAT_LINKER_FLAGS}>)
+  target_link_libraries(plugdata_midi PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} $<$<NOT:$<CONFIG:Debug>>:${MACOS_COMPAT_LINKER_FLAGS}>)
+  target_link_libraries(plugdata PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} $<$<NOT:$<CONFIG:Debug>>:${MACOS_COMPAT_LINKER_FLAGS}>)
+  target_link_libraries(plugdata_fx PRIVATE plugdata_core pd-src-multi externals-multi ${LINK_CARBON} $<$<NOT:$<CONFIG:Debug>>:${MACOS_COMPAT_LINKER_FLAGS}>)
 else()
   target_link_libraries(plugdata PRIVATE plugdata_core pd-multi)
   target_link_libraries(plugdata_fx PRIVATE plugdata_core pd-multi)

Resources/Fonts/IBMPlexMono.ttf

@@ -5,6 +5,7 @@
 import sys
 import platform
 import zipfile
+import binascii
 
 #Parse arguments
 value_mappings = {
@@ -93,6 +94,101 @@ def replaceTextInFolder(folder_path, old_string, new_string):
         for dir_name in dirs:
             replaceTextInFolder(os.path.join(root, dir_name), old_string, new_string)
 
+def expand_glob_list(file_patterns):
+    expanded_files = []
+    for pattern in file_patterns:
+        expanded_files.extend(glob.glob(pattern))
+    return expanded_files
+
+def hash_resource_name(resource_name):
+    # Hashes a resource name using the same algorithm as in the C++ code.
+    hash_val = 0
+    for char in resource_name:
+        hash_val = 31 * hash_val + ord(char)
+    return hash_val & 0xFFFFFFFF  # Limit to 32-bit hash
+
+def generate_binary_data(output_dir, file_list):
+    os.makedirs(output_dir, exist_ok=True)  # Ensure output directory exists
+    file_data = []  # To store metadata for each file
+
+    # Gather file information and binary content
+    for index, filepath in enumerate(file_list):
+        filename = os.path.basename(filepath)
+        if os.path.isfile(filepath):
+            with open(filepath, "rb") as file:
+                binary_content = file.read()
+
+            var_name = filename.replace('.', '_').replace('-', '_')
+            temp_name = f"temp_binary_data_{index}"
+            data = {
+                "filename": filename,
+                "var_name": var_name,
+                "temp_name": temp_name,
+                "size": len(binary_content),
+                "binary": list(binary_content),
+                "index": str(index),
+                "hash": hash_resource_name(var_name)
+            }
+            file_data.append(data)
+
+    # Generate header file
+    with open(output_dir + "/BinaryData.h", "w") as header:
+        header.write("namespace BinaryData\n{\n")
+        for data in file_data:
+            header.write(f"    extern const char* {data['var_name']};\n")
+            header.write(f"    const int {data['var_name']}Size = {data['size']};\n")
+
+        header.write("\n    const int namedResourceListSize = {};\n".format(len(file_data)))
+        header.write("    extern const char* namedResourceList[];\n")
+        header.write("    extern const char* originalFilenames[];\n")
+        header.write("    const char* getNamedResource (const char* resourceNameUTF8, int& dataSizeInBytes);\n")
+        header.write("}\n")
+
+    with open(output_dir + "/BinaryData.cpp", "w") as source:
+        source.write("#include \"BinaryData.h\"\n\n")
+        source.write("namespace BinaryData\n{\n\n")
+
+        source.write("\n    const char* namedResourceList[] = {\n")
+        for data in file_data:
+            source.write(f"        \"{data['var_name']}\",\n")
+        source.write("    };\n\n")
+
+        source.write("const char* getNamedResource (const char* resourceNameUTF8, int& numBytes)\n")
+        source.write("{\n")
+        source.write("    unsigned int hash = 0;\n")
+        source.write("    if (resourceNameUTF8 != nullptr)\n")
+        source.write("        while (*resourceNameUTF8 != 0)\n")
+        source.write("            hash = 31 * hash + (unsigned int) *resourceNameUTF8++;\n\n")
+
+        source.write("    switch (hash)\n    {\n")
+        for data in file_data:
+            source.write(f"        case 0x{data['hash']:08x}:  numBytes = {data['size']}; return {data['var_name']};\n")
+        source.write("        default: break;\n")
+        source.write("    }\n\n")
+
+        source.write("    numBytes = 0;\n")
+        source.write("    return nullptr;\n")
+        source.write("}\n")
+        source.write("}\n")
+
+    # Generate .cpp files for each binary resource
+    for data in file_data:
+        cpp_filename = output_dir + "/BinaryData_" + data["index"] + ".cpp"
+        with open(cpp_filename, "w") as cpp_file:
+            cpp_file.write("namespace BinaryData\n{\n")
+            cpp_file.write(f"//================== {data['filename']} ==================\n")
+            cpp_file.write(f"static const unsigned char {data['temp_name']}[] =\n{{\n")
+
+            # Write binary data in readable hex format
+            binary_chunks = [data['binary'][i:i+12] for i in range(0, len(data['binary']), 12)]
+            for chunk in binary_chunks:
+                hex_values = ', '.join(f"0x{binascii.hexlify(byte.to_bytes(1, 'big')).decode('utf-8').upper()}" for byte in chunk)
+                cpp_file.write(f"    {hex_values},\n")
+
+            cpp_file.write("};\n\n")
+            cpp_file.write(f"const char* {data['var_name']} = (const char*) {data['temp_name']};\n")
+            cpp_file.write("}\n")
+
 
 if existsAsFile("../Filesystem.zip"):
     removeFile("../Filesystem.zip")
@@ -204,3 +300,19 @@ def replaceTextInFolder(folder_path, old_string, new_string):
 
 splitFile("./Filesystem.zip", output_dir + "/Filesystem_%i.zip", 12)
 removeFile("./Filesystem.zip")
+
+generate_binary_data("../BinaryData", expand_glob_list({
+    project_root + "/Resources/Fonts/IconFont.ttf",
+    project_root + "/Resources/Fonts/InterTabular.ttf",
+    project_root + "/Resources/Fonts/InterBold.ttf",
+    project_root + "/Resources/Fonts/InterSemiBold.ttf",
+    project_root + "/Resources/Fonts/InterThin.ttf",
+    project_root + "/Resources/Fonts/InterVariable.ttf",
+    project_root + "/Resources/Fonts/InterRegular.ttf",
+    project_root + "/Resources/Fonts/RobotoMono-Regular.ttf",
+    project_root + "/Resources/Icons/plugdata_large_logo.png",
+    project_root + "/Resources/Icons/plugdata_logo.png",
+    "Documentation.bin",
+    "InterUnicode_*.ttf",
+    "Filesystem_*.zip"
+}))

Resources/Scripts/package_resources.py

@@ -44,7 +44,7 @@ struct Fonts {
         boldTypeface = Typeface::createSystemTypefaceFor(BinaryData::InterBold_ttf, BinaryData::InterBold_ttfSize);
         semiBoldTypeface = Typeface::createSystemTypefaceFor(BinaryData::InterSemiBold_ttf, BinaryData::InterSemiBold_ttfSize);
         iconTypeface = Typeface::createSystemTypefaceFor(BinaryData::IconFont_ttf, BinaryData::IconFont_ttfSize);
-        monoTypeface = Typeface::createSystemTypefaceFor(BinaryData::RobotoMonoRegular_ttf, BinaryData::RobotoMonoRegular_ttfSize);
+        monoTypeface = Typeface::createSystemTypefaceFor(BinaryData::RobotoMono_Regular_ttf, BinaryData::RobotoMono_Regular_ttfSize);
         variableTypeface = Typeface::createSystemTypefaceFor(BinaryData::InterVariable_ttf, BinaryData::InterVariable_ttfSize);
         tabularTypeface = Typeface::createSystemTypefaceFor(BinaryData::InterTabular_ttf, BinaryData::InterTabular_ttfSize);
 

Source/Utility/Fonts.h

@@ -14,29 +14,14 @@
 #    include <raw_keyboard_input/raw_keyboard_input.cpp>
 #endif
 
-#if defined(__APPLE__)
-#    define HAS_STD_FILESYSTEM 0
-#elif defined(__unix__)
-#    if defined(__cpp_lib_filesystem) || defined(__cpp_lib_experimental_filesystem)
-#        define HAS_STD_FILESYSTEM 1
-#    else
-#        define HAS_STD_FILESYSTEM 0
-#    endif
-#elif defined(_WIN32) || defined(_WIN64)
-#    define HAS_STD_FILESYSTEM 1
-#endif
-
-#if HAS_STD_FILESYSTEM
-#    if defined(__cpp_lib_filesystem)
-#        include <filesystem>
+#if defined(__cpp_lib_filesystem)
+#include <filesystem>
 namespace fs = std::filesystem;
-#    elif defined(__cpp_lib_experimental_filesystem)
-#        include <experimental/filesystem>
+#elif defined(__cpp_lib_experimental_filesystem)
+#include <experimental/filesystem>
 namespace fs = std::experimental::filesystem;
-#    endif
 #else
-
-#    include <ghc_filesystem/include/ghc/filesystem.hpp>
+#include <ghc_filesystem/include/ghc/filesystem.hpp>
 namespace fs = ghc::filesystem;
 #endif