Merge pull request stakira#1006 from oxygen-dioxide/diffsinger-dict

DiffSinger: support different dictionaries for Chinese, Japanese and Cantonese

OpenUtau.Core/DiffSinger/DiffSingerBasePhonemizer.cs

@@ -24,6 +24,7 @@ public abstract class DiffSingerBasePhonemizer : MachineLearningPhonemizer
         DiffSingerSpeakerEmbedManager speakerEmbedManager;
 
         string defaultPause = "SP";
+        protected virtual string GetDictionaryName()=>"dsdict.yaml";
 
         public override void SetSinger(USinger singer) {
             this.singer = singer;
@@ -66,13 +67,17 @@ public override void SetSinger(USinger singer) {
 
         protected virtual IG2p LoadG2p(string rootPath) {
             var g2ps = new List<IG2p>();
+            var dictionaryNames = new string[] {GetDictionaryName(), "dsdict.yaml"};
             // Load dictionary from singer folder.
-            string file = Path.Combine(rootPath, "dsdict.yaml");
-            if (File.Exists(file)) {
-                try {
-                    g2ps.Add(G2pDictionary.NewBuilder().Load(File.ReadAllText(file)).Build());
-                } catch (Exception e) {
-                    Log.Error(e, $"Failed to load {file}");
+            foreach(var dictionaryName in dictionaryNames){
+                string dictionaryPath = Path.Combine(rootPath, dictionaryName);
+                if (File.Exists(dictionaryPath)) {
+                    try {
+                        g2ps.Add(G2pDictionary.NewBuilder().Load(File.ReadAllText(dictionaryPath)).Build());
+                    } catch (Exception e) {
+                        Log.Error(e, $"Failed to load {dictionaryPath}");
+                    }
+                    break;
                 }
             }
             return new G2pFallbacks(g2ps.ToArray());

OpenUtau.Core/DiffSinger/DiffSingerChinesePhonemizer.cs → OpenUtau.Core/DiffSinger/Phonemizers/DiffSingerChinesePhonemizer.cs

@@ -2,11 +2,10 @@
 
 using OpenUtau.Api;
 
-namespace OpenUtau.Core.DiffSinger
-{
+namespace OpenUtau.Core.DiffSinger {
     [Phonemizer("DiffSinger Chinese Phonemizer", "DIFFS ZH", language: "ZH")]
-    public class DiffSingerChinesePhonemizer : DiffSingerBasePhonemizer
-    {
+    public class DiffSingerChinesePhonemizer : DiffSingerBasePhonemizer {
+        protected override string GetDictionaryName()=>"dsdict-zh.yaml";
         protected override string[] Romanize(IEnumerable<string> lyrics) {
             return BaseChinesePhonemizer.Romanize(lyrics);
         }

OpenUtau.Core/DiffSinger/DiffSingerG2pPhonemizer.cs → OpenUtau.Core/DiffSinger/Phonemizers/DiffSingerG2pPhonemizer.cs

@@ -29,37 +29,35 @@ public Dictionary<string, string> toDict(){
         }
     }
 
+    /// <summary>
+    /// Base class for DiffSinger phonemizers based on OpenUtau's builtin G2p.
+    /// </summary>
     public abstract class DiffSingerG2pPhonemizer : DiffSingerBasePhonemizer
     {
-        protected virtual string GetDictionaryName()=>"dsdict.yaml";
-
         protected virtual IG2p LoadBaseG2p()=>null;
         //vowels and consonants of BaseG2p
         protected virtual string[] GetBaseG2pVowels()=>new string[]{};
         protected virtual string[] GetBaseG2pConsonants()=>new string[]{};
 
         protected override IG2p LoadG2p(string rootPath) {
-            var dictionaryName = GetDictionaryName();
+            //Each phonemizer has a delicated dictionary name, such as dsdict-en.yaml, dsdict-ru.yaml.
+            //If this dictionary exists, load it.
+            //If not, load dsdict.yaml.
+            var dictionaryNames = new string[] {GetDictionaryName(), "dsdict.yaml"};
             var g2ps = new List<IG2p>();
-            // Load dictionary from plugin folder.
-            string path = Path.Combine(PluginDir, dictionaryName);
-            if (File.Exists(path)) {
-                try {
-                    g2ps.Add(G2pDictionary.NewBuilder().Load(File.ReadAllText(path)).Build());
-                } catch (Exception e) {
-                    Log.Error(e, $"Failed to load {path}");
-                }
-            }
 
             // Load dictionary from singer folder.
             var replacements = new Dictionary<string,string>();
-            string file = Path.Combine(rootPath, dictionaryName);
-            if (File.Exists(file)) {
-                try {
-                    g2ps.Add(G2pDictionary.NewBuilder().Load(File.ReadAllText(file)).Build());
-                    replacements = G2pReplacementsData.Load(File.ReadAllText(file)).toDict();
-                } catch (Exception e) {
-                    Log.Error(e, $"Failed to load {file}");
+            foreach(var dictionaryName in dictionaryNames){
+                string dictionaryPath = Path.Combine(rootPath, dictionaryName);
+                if (File.Exists(dictionaryPath)) {
+                    try {
+                        g2ps.Add(G2pDictionary.NewBuilder().Load(File.ReadAllText(dictionaryPath)).Build());
+                        replacements = G2pReplacementsData.Load(File.ReadAllText(dictionaryPath)).toDict();
+                    } catch (Exception e) {
+                        Log.Error(e, $"Failed to load {dictionaryPath}");
+                    }
+                    break;
                 }
             }
 

OpenUtau.Core/DiffSinger/DiffSingerItalianPhonemizer.cs → OpenUtau.Core/DiffSinger/Phonemizers/DiffSingerItalianPhonemizer.cs

@@ -1,18 +1,18 @@
-using OpenUtau.Api;
-using OpenUtau.Core.G2p;
-
-namespace OpenUtau.Core.DiffSinger {
-    [Phonemizer("DiffSinger Italian Phonemizer", "DIFFS IT", language: "IT")]
-    public class DiffSingerItalianPhonemizer : DiffSingerG2pPhonemizer {
-        protected override string GetDictionaryName() => "dsdict-it.yaml";
-        protected override IG2p LoadBaseG2p() => new ItalianG2p();
-        protected override string[] GetBaseG2pVowels() => new string[] {
-            "a", "a1", "e", "e1", "EE", "i", "i1", "o", "o1", "OO", "u", "u1"
-        };
-
-        protected override string[] GetBaseG2pConsonants() => new string[] {
-            "b", "d", "dz", "dZZ", "f", "g", "JJ", "k", "l", "LL", "m", "n",
-            "nf", "ng", "p", "r", "rr", "s", "SS", "t", "ts", "tSS", "v", "w", "y", "z"
-        };
-    }
-}
+using OpenUtau.Api;
+using OpenUtau.Core.G2p;
+
+namespace OpenUtau.Core.DiffSinger {
+    [Phonemizer("DiffSinger Italian Phonemizer", "DIFFS IT", language: "IT")]
+    public class DiffSingerItalianPhonemizer : DiffSingerG2pPhonemizer {
+        protected override string GetDictionaryName() => "dsdict-it.yaml";
+        protected override IG2p LoadBaseG2p() => new ItalianG2p();
+        protected override string[] GetBaseG2pVowels() => new string[] {
+            "a", "a1", "e", "e1", "EE", "i", "i1", "o", "o1", "OO", "u", "u1"
+        };
+
+        protected override string[] GetBaseG2pConsonants() => new string[] {
+            "b", "d", "dz", "dZZ", "f", "g", "JJ", "k", "l", "LL", "m", "n",
+            "nf", "ng", "p", "r", "rr", "s", "SS", "t", "ts", "tSS", "v", "w", "y", "z"
+        };
+    }
+}

OpenUtau.Core/DiffSinger/Phonemizers/DiffSingerJapanesePhonemizer.cs

@@ -0,0 +1,10 @@
+using System.Collections.Generic;
+
+using OpenUtau.Api;
+
+namespace OpenUtau.Core.DiffSinger {
+    [Phonemizer("DiffSinger Japanese Phonemizer", "DIFFS JA", language: "JA")]
+    public class DiffSingerJapanesePhonemizer : DiffSingerBasePhonemizer {
+        protected override string GetDictionaryName()=>"dsdict-ja.yaml";
+    }
+}

OpenUtau.Core/DiffSinger/DiffSingerJyutpingPhonemizer.cs → OpenUtau.Core/DiffSinger/Phonemizers/DiffSingerJyutpingPhonemizer.cs

@@ -6,6 +6,7 @@
 namespace OpenUtau.Core.DiffSinger {
     [Phonemizer("DiffSinger Jyutping Phonemizer", "DIFFS ZH-YUE", language: "ZH-YUE")]
     public class DiffSingerJyutpingPhonemizer : DiffSingerBasePhonemizer {
+        protected override string GetDictionaryName() => "dsdict-zh-yue.yaml";
         protected override string[] Romanize(IEnumerable<string> lyrics) {
             return ZhG2p.CantoneseInstance.Convert(lyrics.ToList(), false, true).Split(" ");
         }