Make xz mandatory

Author: timothyschoen

CMakeLists.txt

@@ -17,7 +17,6 @@ option(ENABLE_FFMPEG "Enable ffmpeg support for ELSE and Gem audio/video objects
 option(ENABLE_GEM "Enable Gem support" ON)
 option(ENABLE_ASAN "Enable AddressSanitizer" OFF)
 option(ENABLE_PERFETTO "Enable Perfetto profiling (advanced)" OFF)
-option(ENABLE_XZ "Enable xz compression (smaller binary, long configure time)" ON)
 option(MACOS_LEGACY "Enable support for old macOS versions (lowers OSX_DEPLOYMENT TARGET and disables Metal" OFF)
 option(VERBOSE "" OFF)
 
@@ -73,7 +72,6 @@ if(QUICK_BUILD)
     set(ENABLE_SFIZZ OFF)
     set(ENABLE_GEM OFF)
     set(ENABLE_FFMPEG OFF)
-    set(ENABLE_XZ OFF)
 endif()
 
 if(BSD)
@@ -135,7 +133,7 @@ if(NOT PREPARE_DOCUMENTATION_RESULT EQUAL 0)
 endif()
 
 message(STATUS "Packaging resources")
-execute_process(COMMAND ${Python3_EXECUTABLE} package_resources.py ${ENABLE_GEM} ${ENABLE_XZ} ${CMAKE_CURRENT_BINARY_DIR}/Resources WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/Resources/Scripts RESULT_VARIABLE PACKAGE_RESOURCES_RESULT)
+execute_process(COMMAND ${Python3_EXECUTABLE} package_resources.py ${ENABLE_GEM} ${CMAKE_CURRENT_BINARY_DIR}/Resources WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/Resources/Scripts RESULT_VARIABLE PACKAGE_RESOURCES_RESULT)
 
 if(NOT PACKAGE_RESOURCES_RESULT EQUAL 0)
     message(FATAL_ERROR "Resource packaging failed with error code ${PACKAGE_RESOURCES_RESULT}")
@@ -271,9 +269,7 @@ set(PLUGDATA_COMPILE_DEFINITIONS
 if(ENABLE_SFIZZ)
   list(APPEND PLUGDATA_COMPILE_DEFINITIONS ENABLE_SFIZZ=1)
 endif()
-if(ENABLE_XZ)
-  list(APPEND PLUGDATA_COMPILE_DEFINITIONS ENABLE_XZ=1)
-endif()
+
 if(ENABLE_FFMPEG)
   list(APPEND PLUGDATA_COMPILE_DEFINITIONS ENABLE_FFMPEG=1)
 endif()
@@ -332,12 +328,9 @@ set(libs
   BinaryData
   nanovg
   webpdecoder
+  liblzma
 )
 
-if(ENABLE_XZ)
-    list(APPEND libs liblzma)
-endif()
-
 if(UNIX AND NOT APPLE)
     list(APPEND libs curl X11)
     if(LINUX)

Libraries/CMakeLists.txt

@@ -28,15 +28,12 @@ if(MSVC)
     target_compile_options(webpdecoder PUBLIC "/MT$<$<STREQUAL:$<CONFIGURATION>,Debug>:d>")
     set_target_properties(webpdecoder PROPERTIES CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>$" )
 endif()
-if(ENABLE_XZ)
-    _message(STATUS "Configuring liblzma")
-    set(XZ_TOOL_XZDEC OFF CACHE BOOL "")
-    set(XZ_TOOL_LZMADEC OFF CACHE BOOL "")
-    set(XZ_TOOL_XZ OFF CACHE BOOL "")
-    set(XZ_ENCODERS "" CACHE STRING "")
-    set(XZ_DECODERS "lzma2" CACHE STRING "")
-    add_subdirectory(xz) # for decompressing .tar.xz
-endif()
+_message(STATUS "Configuring liblzma")
+set(XZ_TOOL_XZDEC OFF CACHE BOOL "")
+set(XZ_TOOL_LZMADEC OFF CACHE BOOL "")
+set(XZ_TOOL_XZ OFF CACHE BOOL "")
+set(XZ_ENCODERS "" CACHE STRING "")
+add_subdirectory(xz) # for decompressing .tar.xz
 set(MESSAGE_QUIET OFF)
 
 

Resources/Scripts/package_resources.py

@@ -20,7 +20,6 @@
 }
 
 package_gem = value_mappings[sys.argv[1].upper()]
-use_xz = value_mappings[sys.argv[2].upper()]
 output_dir = sys.argv[3]
 
 # Utility filesystem functions
@@ -76,16 +75,12 @@ def existsAsDir(path):
     return os.path.isdir(path)
 
 def makeArchive(name, root_dir, base_dir):
-    if use_xz:
-        archive_path = os.path.abspath(name)
-        preset = 9 | lzma.PRESET_EXTREME  # max compression
-        with lzma.open(archive_path, "wb", preset=preset) as xz_out:
-            with tarfile.open(fileobj=xz_out, mode="w|") as tar:
-                full_path = os.path.join(root_dir, base_dir)
-                tar.add(full_path, arcname=base_dir)
-    else:
-        shutil.make_archive(name, "zip", root_dir, base_dir)
-        moveFile("./Filesystem.zip", "./Filesystem")
+    archive_path = os.path.abspath(name)
+    preset = 9 | lzma.PRESET_EXTREME  # max compression
+    with lzma.open(archive_path, "wb", preset=preset) as xz_out:
+        with tarfile.open(fileobj=xz_out, mode="w|") as tar:
+            full_path = os.path.join(root_dir, base_dir)
+            tar.add(full_path, arcname=base_dir)
 
 def split(a, n):
     k, m = divmod(len(a), n)
@@ -328,7 +323,7 @@ def generate_binary_data(output_dir, file_list):
 
 makeArchive("Filesystem", "./", "./plugdata_version")
 with open(project_root + "/Resources/Fonts/InterUnicode.ttf", 'rb') as f_in:
-    with lzma.open(output_dir + "/InterUnicode.ttf.xz", 'wb') as f_out:
+    with lzma.open(output_dir + "/InterUnicode.ttf.xz", 'wb', preset=5) as f_out:
         shutil.copyfileobj(f_in, f_out)
 removeDir(output_dir + "/plugdata_version")
 

Source/PluginProcessor.cpp

@@ -7,10 +7,7 @@
 #include <memory>
 #include <fstream>
 
-#if ENABLE_XZ
 #include <xz/src/liblzma/api/lzma.h>
-#endif
-
 #include <juce_gui_basics/juce_gui_basics.h>
 #include <juce_audio_basics/juce_audio_basics.h>
 #include <juce_dsp/juce_dsp.h>
@@ -264,7 +261,6 @@ void PluginProcessor::initialiseFilesystem()
         versionDataDir.getParentDirectory().createDirectory();
         auto const tempVersionDataDir = versionDataDir.getParentDirectory().getChildFile("plugdata_version");
 
-#if ENABLE_XZ
         // Decompress .xz data using liblzma
         HeapArray<uint8_t> decompressedData;
         decompressedData.reserve(40 * 1024 * 1024);
@@ -335,11 +331,6 @@ void PluginProcessor::initialiseFilesystem()
             DBG("Failed to extract tar archive");
             return;
         }
-#else
-        MemoryInputStream memstream(allData.data(), allData.size(), false);
-        auto file = ZipFile(memstream);
-        file.uncompressTo(tempVersionDataDir.getParentDirectory());
-#endif
         // Create filesystem for this specific version
         tempVersionDataDir.moveFileTo(versionDataDir);
     }

Source/Utility/Fonts.h

@@ -2,11 +2,9 @@
 #include <BinaryData.h>
 #include <juce_gui_basics/juce_gui_basics.h>
 #include <juce_gui_extra/juce_gui_extra.h>
-#include "Utility/Config.h"
-
-#if ENABLE_XZ
 #include <xz/src/liblzma/api/lzma.h>
-#endif
+
+#include "Utility/Config.h"
 
 enum FontStyle {
     Regular,