Use Wine directly instead of wrappers on Mac and Linux (#1571)

* Add Unix executable file type.

* Use Wine directly instead of wrappers

* Exe installer do not create wrappers

* Tell user to set wine path in exe setup message

* Fix non-exe tools showing on windows

Author: atouu

OpenUtau.Core/Classic/ExeInstaller.cs

@@ -15,16 +15,6 @@ public static void Install(string filePath, ExeType exeType) {
                 : PathManager.Inst.ResamplersPath;
             string destName = Path.Combine(destPath, fileName);
             File.Copy(filePath, destName, true);
-            
-            if (OS.IsMacOS()) {
-                //reference: https://github.com/stakira/OpenUtau/wiki/Resamplers-and-Wavtools#macos
-                string MacWrapper = $"#!/bin/sh\r\nRELPATH=\"{fileName}\"\r\n\r\nABSPATH=$(cd \"$(dirname \"$0\")\"; pwd -P)\r\nABSPATH=\"$ABSPATH/$RELPATH\"\r\nif [[ ! -x \"$ABSPATH\" ]]\r\nthen\r\n    chmod +x \"$ABSPATH\"\r\nfi\r\nexec /usr/local/bin/wine32on64 \"$ABSPATH\" \"$@\"";
-                File.WriteAllText(Path.ChangeExtension(destName, ".sh"), MacWrapper, new UTF8Encoding(false));
-            } else if (OS.IsLinux()) {
-                //reference: https://github.com/stakira/OpenUtau/wiki/Resamplers-and-Wavtools#linux
-                string LinuxWrapper = $"#!/bin/bash\r\nLANG=\"ja_JP.UTF8\" wine \"{destName}\" \"${{@,-1}}\"";
-                File.WriteAllText(Path.ChangeExtension(destName, null), LinuxWrapper, new UTF8Encoding(false));
-            }
 
             new Task(() => {
                 DocManager.Inst.ExecuteCmd(new SingersChangedNotification());

OpenUtau.Core/Classic/ExeResampler.cs

@@ -20,6 +20,8 @@ internal class ExeResampler : IResampler {
         public ResamplerManifest Manifest { get; private set; }
         readonly string _name;
         readonly bool _isLegalPlugin = false;
+        readonly string winePath;
+        readonly bool useWine;
 
 
         public ResamplerManifest LoadManifest() {
@@ -63,6 +65,10 @@ public ExeResampler(string filePath, string basePath) {
                 _name = Path.GetRelativePath(basePath, filePath);
                 _isLegalPlugin = true;
             }
+            //Check if should use wine
+            string ext = Path.GetExtension(filePath).ToLower();
+            winePath = Preferences.Default.WinePath;
+            useWine = !OS.IsWindows() && !string.IsNullOrEmpty(winePath) && (ext == ".exe" || ext == ".bat");
             //Load Resampler Manifest
             Manifest = LoadManifest();
             //Make moresampler happy
@@ -96,7 +102,11 @@ public string DoResamplerReturnsFile(ResamplerItem args, ILogger logger) {
             string ArgParam = FormattableString.Invariant(
                 $"\"{args.inputTemp}\" \"{tmpFile}\" {MusicMath.GetToneName(args.tone)} {args.velocity} \"{args.GetFlagsString()}\" {args.offset} {args.durRequired} {args.consonant} {args.cutoff} {args.volume} {args.modulation} !{args.tempo} {Base64.Base64EncodeInt12(args.pitches)}");
             logger.Information($" > [thread-{threadId}] {FilePath} {ArgParam}");
-            ProcessRunner.Run(FilePath, ArgParam, logger);
+            if (useWine) {
+                ProcessRunner.Run(winePath, $"{FilePath} {ArgParam}", logger);
+            } else {
+                ProcessRunner.Run(FilePath, ArgParam, logger);
+            }
             return tmpFile;
         }
 

OpenUtau.Core/Classic/ExeWavtool.cs

@@ -14,17 +14,21 @@
 namespace OpenUtau.Classic {
     class ExeWavtool : IWavtool {
         static object tempBatLock = new object();
-        static object tempShLock = new object();
 
         readonly StringBuilder sb = new StringBuilder();
         readonly string filePath;
         readonly string name;
+        readonly string winePath;
+        readonly bool useWine;
         private Encoding osEncoding;
 
         public ExeWavtool(string filePath, string basePath) {
             this.filePath = filePath;
             name = Path.GetRelativePath(basePath, filePath);
             osEncoding = OS.IsWindows() ? Encoding.GetEncoding(0) : Encoding.UTF8;
+            string ext = Path.GetExtension(filePath).ToLower();
+            winePath = Preferences.Default.WinePath;
+            useWine = !OS.IsWindows() && !string.IsNullOrEmpty(winePath) && (ext == ".exe" || ext == ".bat");
         }
 
         public float[] Concatenate(List<ResamplerItem> resamplerItems, string tempPath, CancellationTokenSource cancellation) {
@@ -45,7 +49,7 @@ public float[] Concatenate(List<ResamplerItem> resamplerItems, string tempPath,
             lock (tempBatLock) {
                 using (var stream = File.Open(batPath, FileMode.Create)) {
                     UTF8Encoding noBomEncoding = new UTF8Encoding(false);
-                    using (var writer = new StreamWriter(stream, OS.IsLinux() ? noBomEncoding : osEncoding)) {
+                    using (var writer = new StreamWriter(stream, OS.IsWindows() ? osEncoding : noBomEncoding)) {
                         WriteSetUp(writer, resamplerItems, tempPath);
                         for (var i = 0; i < resamplerItems.Count; i++) {
                             WriteItem(writer, resamplerItems[i], i, resamplerItems.Count);
@@ -54,14 +58,12 @@ public float[] Concatenate(List<ResamplerItem> resamplerItems, string tempPath,
                     }
                 }
 
-                if (OS.IsLinux()) {
-                    //Because you can't run .bat files directly on linux, we have to create a shell script wrapper
-                    string shPath = PrepareSh();
-                    ProcessRunner.Run(shPath, "", Log.Logger, workDir: PathManager.Inst.CachePath, timeoutMs: 5 * 60 * 1000);
-                }
-                else {
+                if (useWine) {
+                    ProcessRunner.Run(winePath, batPath, Log.Logger, workDir: PathManager.Inst.CachePath, timeoutMs: 5 * 60 * 1000);
+                } else {
                     ProcessRunner.Run(batPath, "", Log.Logger, workDir: PathManager.Inst.CachePath, timeoutMs: 5 * 60 * 1000);
                 }
+
             }
             if (string.IsNullOrEmpty(tempPath) || File.Exists(tempPath)) {
                 using (var wavStream = Core.Format.Wave.OpenFile(tempPath)) {
@@ -71,39 +73,14 @@ public float[] Concatenate(List<ResamplerItem> resamplerItems, string tempPath,
             return new float[0];
         }
 
-        string PrepareSh () {
-            string shPath = Path.Join(PathManager.Inst.CachePath, "temp.sh");
-            lock(tempShLock) {
-                if (!File.Exists(shPath)) {
-                    using (FileStream stream = File.Open(shPath, FileMode.Create)) {
-                        //Making a new encoding here that does not have a byte order mark
-                        //The byte order mark at the front of an shell script causes an exec format error
-                        UTF8Encoding noBomEncoding = new UTF8Encoding(false);
-                        using (StreamWriter writer = new StreamWriter(stream, noBomEncoding)) {
-                            WriteSh(writer);
-                        }
-                    }
-                    int mode = (7 << 6) | (5 << 3) | 5;
-                    chmod(shPath, mode);
-                }
-            }
-            return shPath;
-        }
-
-        void WriteSh (StreamWriter writer) {
-            string batPath = Path.Combine(PathManager.Inst.CachePath, "temp.bat");
-            writer.WriteLine("#!/bin/bash");
-            writer.WriteLine("LANG=\"ja_JP.UTF8\" wine \"" + batPath + "\" \"${@,-1}\"");
-        }
-
         void PrepareHelper() {
             string tempHelper = Path.Join(PathManager.Inst.CachePath, "temp_helper.bat");
             lock (Renderers.GetCacheLock(tempHelper)) {
                 if (!File.Exists(tempHelper)) {
                     using (var stream = File.Open(tempHelper, FileMode.Create)) {
                         //BOM also causes problems when running .bat files through wine
                         UTF8Encoding noBomEncoding = new UTF8Encoding(false);
-                        using (var writer = new StreamWriter(stream, OS.IsLinux() ? noBomEncoding : osEncoding)) {
+                        using (var writer = new StreamWriter(stream, OS.IsWindows() ? osEncoding : noBomEncoding)) {
                             WriteHelper(writer);
                         }
                     }
@@ -127,8 +104,7 @@ void WriteSetUp(StreamWriter writer, List<ResamplerItem> resamplerItems, string
             writer.WriteLine($"@set tempo={resamplerItems[0].tempo}");
             writer.WriteLine($"@set samples={44100}");
             writer.WriteLine($"@set oto={ConvertIfNeeded(PathManager.Inst.CachePath)}");
-            string toolPath = OS.IsLinux() ? ResolveResamplerExePathLinux(filePath) : filePath;
-            writer.WriteLine($"@set tool={ConvertIfNeeded(toolPath)}");
+            writer.WriteLine($"@set tool={ConvertIfNeeded(filePath)}");
             string tempFile = Path.GetRelativePath(PathManager.Inst.CachePath, tempPath);
             writer.WriteLine($"@set output={ConvertIfNeeded(tempFile)}");
             writer.WriteLine("@set helper=temp_helper.bat");
@@ -143,8 +119,7 @@ void WriteSetUp(StreamWriter writer, List<ResamplerItem> resamplerItems, string
         }
 
         void WriteItem(StreamWriter writer, ResamplerItem item, int index, int total) {
-            string resampPath = OS.IsLinux() ? ResolveResamplerExePathLinux(item.resampler.FilePath) : item.resampler.FilePath;
-            writer.WriteLine($"@set resamp={ConvertIfNeeded(resampPath)}");
+            writer.WriteLine($"@set resamp={ConvertIfNeeded(item.resampler.FilePath)}");
             writer.WriteLine($"@set params={item.volume} {item.modulation} !{item.tempo:G999} {Base64.Base64EncodeInt12(item.pitches)}");
             // fixed the commandline vulnerabilities that also exists in og utau
             writer.WriteLine($"@set flag=\"{EscapeFlags(item.GetFlagsString())}\"");
@@ -221,7 +196,7 @@ void WriteTearDown(StreamWriter writer) {
         }
 
         string ConvertIfNeeded(string path) {
-            if (OS.IsLinux()) return ConvertToWindowsPath(path);
+            if (!OS.IsWindows()) return ConvertToWindowsPath(path);
             else return path;
         } 
 
@@ -243,46 +218,6 @@ string ConvertToWindowsPath (string linuxPath) {
             return windowsPath;
         }
 
-        //Parse the wrapper shell script created by the user during the resampler install process on linux for the path
-        //to the resampler's exe file. Should work for most paths and files that people would make, but there may be edge cases.
-        //Intended only for use on linux
-        string ResolveResamplerExePathLinux (string wrapperPath) {
-            using (FileStream stream = File.Open(wrapperPath, FileMode.Open)) {
-                using (StreamReader reader = new StreamReader(stream)) {
-                    string line;
-                    int start = -1;
-                    int end = -1;
-                    for (line = reader.ReadLine(); line != null; line = reader.ReadLine()) {
-                        if (line[0] == '#') continue; //ignore comments in the file
-                        start = line.IndexOf("wine ") + 5;
-                        if (start == -1) continue;
-
-                        end = -1;
-                        if (line[start] == '"') { //if path is enclosed by quotation marks
-                            start++;
-                            end = line.IndexOf('"', start + 1);
-                        }
-                        else { //if path is not enclosed by quotation marks (potential for "\ " in string)
-                            int lastChecked = start;
-                            do {
-                                end = line.IndexOf(' ', lastChecked);
-                                if (line[end - 1] != '\\') break;
-
-                                lastChecked = end + 1;
-                            } while (end != -1);
-                        }
-                        if (end != -1) break;
-                    }
-                    if (line == null) 
-                        throw new InvalidDataException("Shell script wrapper for exe resampler is empty");
-                    else if (start == -1 || end == -1) 
-                        throw new InvalidDataException("Could not find path to .exe resampler in shell script wrapper");
-                    else
-                        return line.Substring(start, end - start);
-                }
-            }
-        }
-
         [DllImport("libc", SetLastError = true)]
         private static extern int chmod(string pathname, int mode);
 

OpenUtau.Core/Classic/Plugin.cs

@@ -1,5 +1,6 @@
 using System.Diagnostics;
 using System.IO;
+using OpenUtau.Core.Util;
 
 namespace OpenUtau.Classic {
     public class Plugin : IPlugin {
@@ -16,9 +17,12 @@ public void Run(string tempFile) {
             if (!File.Exists(Executable)) {
                 throw new FileNotFoundException($"Executable {Executable} not found.");
             }
+            string winePath = Preferences.Default.WinePath;
+            bool useWine = !OS.IsWindows() && !string.IsNullOrEmpty(winePath);
             var startInfo = new ProcessStartInfo() {
-                FileName = Executable,
-                Arguments = $"\"{tempFile}\"",
+                FileName = useWine ? winePath : Executable,
+                Arguments = useWine ? $"\"{Executable}\" \"{tempFile}\"" : $"\"{tempFile}\"",
+                Environment = {{"LANG", "ja_JP.utf8"}},
                 WorkingDirectory = Path.GetDirectoryName(Executable),
                 UseShellExecute = UseShell,
             };

OpenUtau.Core/Classic/ToolsManager.cs

@@ -38,14 +38,11 @@ IResampler LoadResampler(string filePath, string basePath) {
                 return null;
             }
             string ext = Path.GetExtension(filePath).ToLower();
-            if (OS.IsWindows()) {
-                if (ext == ".exe" || ext == ".bat") {
-                    return new ExeResampler(filePath, basePath);
-                }
-            } else {
-                if (ext == ".sh" || string.IsNullOrEmpty(ext)) {
-                    return new ExeResampler(filePath, basePath);
-                }
+            if ((OS.IsWindows() || !string.IsNullOrEmpty(Preferences.Default.WinePath)) && (ext == ".exe" || ext == ".bat")) {
+                return new ExeResampler(filePath, basePath);
+            } 
+            if (!OS.IsWindows() && (ext == ".sh" || string.IsNullOrEmpty(ext))) {
+                return new ExeResampler(filePath, basePath);
             }
             return null;
         }
@@ -55,14 +52,11 @@ IWavtool LoadWavtool(string filePath, string basePath) {
                 return null;
             }
             string ext = Path.GetExtension(filePath).ToLower();
-            if (OS.IsWindows()) {
-                if (ext == ".exe" || ext == ".bat") {
-                    return new ExeWavtool(filePath, basePath);
-                }
-            } else {
-                if (ext == ".sh" || string.IsNullOrEmpty(ext)) {
-                    return new ExeWavtool(filePath, basePath);
-                }
+            if ((OS.IsWindows() || !string.IsNullOrEmpty(Preferences.Default.WinePath)) && (ext == ".exe" || ext == ".bat")) {
+                return new ExeWavtool(filePath, basePath);
+            } 
+            if (!OS.IsWindows() && (ext == ".sh" || string.IsNullOrEmpty(ext))) {
+                return new ExeWavtool(filePath, basePath);
             }
             return null;
         }

OpenUtau.Core/Util/Preferences.cs

@@ -188,6 +188,7 @@ public class SerializablePreferences {
             public bool RememberMid = false;
             public bool RememberUst = true;
             public bool RememberVsqx = true;
+            public string WinePath = string.Empty;
             public string PhoneticAssistant = string.Empty;
             public string RecentOpenSingerDirectory = string.Empty;
             public string RecentOpenProjectDirectory = string.Empty;

OpenUtau.Core/Util/ProcessRunner.cs

@@ -14,6 +14,7 @@ public static void Run(string file, string args, ILogger logger, string workDir
             var threadId = Thread.CurrentThread.ManagedThreadId;
             using (var proc = new Process()) {
                 proc.StartInfo = new ProcessStartInfo(file, args) {
+                    Environment = {{"LANG", "ja_JP.utf8"}},
                     UseShellExecute = false,
                     RedirectStandardOutput = DebugSwitch,
                     RedirectStandardError = true,

OpenUtau/FilePicker.cs

@@ -56,6 +56,10 @@ internal class FilePicker {
         public static FilePickerFileType OUDEP { get; } = new("OpenUtau dependency") {
             Patterns = new[] { "*.oudep" },
         };
+        public static FilePickerFileType UnixExecutable { get; } = new("Executable") {
+            MimeTypes = new[] { "application/x-executable" },
+            AppleUniformTypeIdentifiers = new[] { "public.unix-executable" },
+        };
 
         public async static Task<string?> OpenFile(
             Window window, string titleKey, params FilePickerFileType[] types) {

OpenUtau/Strings/Strings.axaml

@@ -379,6 +379,7 @@ Warning: this option removes custom presets.</system:String>
   <system:String x:Key="prefs.advanced.resamplerlogging.warn">Stores resampler output in log files. This option slows down UI and rendering.</system:String>
   <system:String x:Key="prefs.advanced.stable">Stable</system:String>
   <system:String x:Key="prefs.advanced.vlabelerpath">vLabeler Path</system:String>
+  <system:String x:Key="prefs.advanced.winepath">Wine Path (set to enable wine for compatibility)</system:String>
   <system:String x:Key="prefs.appearance">Appearance</system:String>
   <system:String x:Key="prefs.appearance.degree">Scale degree display style</system:String>
   <system:String x:Key="prefs.appearance.degree.numbered">Numbered (1 2 3 4 5 6 7)</system:String>
@@ -412,6 +413,7 @@ Warning: this option removes custom presets.</system:String>
   <system:String x:Key="prefs.paths.loaddeepfolders">Load all depth folders</system:String>
   <system:String x:Key="prefs.paths.reset">Reset</system:String>
   <system:String x:Key="prefs.paths.select">Select</system:String>
+  <system:String x:Key="prefs.paths.detect">Detect</system:String>
   <system:String x:Key="prefs.penplus">Set Pen Plus Tool as Default</system:String>
   <system:String x:Key="prefs.playback">Playback</system:String>
   <system:String x:Key="prefs.playback.autoscroll">Auto-Scroll</system:String>

OpenUtau/ViewModels/ExeSetupViewModel.cs

@@ -6,13 +6,17 @@ public class ExeSetupViewModel : ViewModelBase {
         [Reactive] public string message { get; set; }
         public ExeSetupViewModel(string filePath) {
             this.filePath = filePath;
-            message = "installing " + filePath;
+            message = $"Installing {filePath}...\n\n";
             if (OS.IsMacOS()) {
-                message += "To use exe resamplers or wavtools on MacOS, please install wine32on64 using following commands:\n"
-                    + "brew tap gcenx/wine\n"
-                    + "brew install --cask --no-quarantine wine-crossover";
-            }else if(OS.IsLinux()) {
-                message += "To use exe resamplers or wavtools on Linux, please install wine from https://www.winehq.org/";
+                message += "To use exe resamplers or wavtools on MacOS:\n"
+                    + "1. Install wine using following commands:\n"
+                    + "      % brew tap gcenx/wine\n"
+                    + "      % brew install --cask --no-quarantine wine-crossover\n"
+                    + "2. Set wine path in Preferences > Advanced > Wine Path";
+            } else if(OS.IsLinux()) {
+                message += "To use exe resamplers or wavtools on Linux:\n"
+                    + "1. Install wine from https://www.winehq.org/\n" 
+                    + "2. Set wine path in Preferences > Advanced > Wine Path";
             }
         }
     }