#if UNITY_STANDALONE || UNITY_EDITOR
using UnityEngine;
using System.Collections;
using System.Linq;
namespace Crosstales.RTVoice.Provider
{
///
/// Linux voice provider.
/// NOTE: needs eSpeak to work: http://espeak.sourceforge.net/
///
public class VoiceProviderLinux : BaseVoiceProvider
{
#region Variables
//private static VoiceProviderLinux instance;
private const int defaultRate = 160;
private const int defaultVolume = 100;
private const int defaultPitch = 50;
private readonly System.Collections.Generic.List voices = new System.Collections.Generic.List(100);
#if ENABLE_IL2CPP
private System.Collections.Generic.Dictionary processCreators = new System.Collections.Generic.Dictionary();
#endif
private bool isLoading;
#endregion
#region Properties
/*
/// Returns the singleton instance of this class.
/// Singleton instance of this class.
public static VoiceProviderLinux Instance => instance ?? (instance = new VoiceProviderLinux());
*/
public override string AudioFileExtension => ".wav";
public override AudioType AudioFileType => AudioType.WAV;
public override string DefaultVoiceName => "en";
public override bool isWorkingInEditor => true;
public override bool isWorkingInPlaymode => true;
public override int MaxTextLength => 32000;
public override bool isSpeakNativeSupported => true;
public override bool isSpeakSupported => true;
public override bool isPlatformSupported => isSupported;
public static bool isSupported => Util.Helper.isWindowsPlatform || Util.Helper.isMacOSPlatform || Util.Helper.isLinuxPlatform;
public override bool isSSMLSupported => true;
public override bool isOnlineService => false;
public override bool hasCoRoutines => true;
public override bool isIL2CPPSupported => true;
public override bool hasVoicesInEditor => true;
#endregion
#region Implemented methods
public override void Load(bool forceReload = false)
{
if (cachedVoices?.Count == 0 || forceReload)
{
if (Util.Helper.isEditorMode)
{
#if UNITY_EDITOR
getVoicesInEditor();
#endif
}
else
{
if (!isLoading)
{
isLoading = true;
Speaker.Instance.StartCoroutine(getVoices());
}
}
}
else
{
onVoicesReady();
}
}
public override IEnumerator SpeakNative(Model.Wrapper wrapper)
{
if (wrapper == null)
{
Debug.LogWarning("'wrapper' is null!");
}
else
{
if (string.IsNullOrEmpty(wrapper.Text))
{
Debug.LogWarning("'wrapper.Text' is null or empty: " + wrapper);
}
else
{
yield return null; //return to the main process (uid)
string voiceName = getVoiceName(wrapper);
int calculatedRate = calculateRate(wrapper.Rate);
int calculatedVolume = calculateVolume(wrapper.Volume);
int calculatedPitch = calculatePitch(wrapper.Pitch);
string args = (string.IsNullOrEmpty(voiceName) ? string.Empty : "-v \"" + voiceName.Replace('"', '\'') + '"') +
(calculatedRate != defaultRate ? " -s " + calculatedRate + " " : string.Empty) +
(calculatedVolume != defaultVolume ? " -a " + calculatedVolume + " " : string.Empty) +
(calculatedPitch != defaultPitch ? " -p " + calculatedPitch + " " : string.Empty) +
" -z " +
" -m \"" + wrapper.Text.Replace('"', '\'') + '"' +
(string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
if (Util.Config.DEBUG)
Debug.Log("Process arguments: " + args);
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, 0, false, false, false)) {Name = wrapper.Uid};
worker.Start();
silence = false;
#if ENABLE_IL2CPP
processCreators.Add(wrapper.Uid, process);
#else
processes.Add(wrapper.Uid, process);
#endif
onSpeakStart(wrapper);
do
{
yield return null;
} while (worker.IsAlive || !process.HasExited);
#if ENABLE_IL2CPP
if (process.ExitCode == 0 || process.ExitCode == 123456) //123456 = Killed
#else
if (process.ExitCode == 0 || process.ExitCode == -1) //-1 = Killed
#endif
{
if (Util.Config.DEBUG)
Debug.Log("Text spoken: " + wrapper.Text);
onSpeakComplete(wrapper);
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not speak the text: " + wrapper + System.Environment.NewLine +
"Exit code: " + process.ExitCode + System.Environment.NewLine +
sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(wrapper, errorMessage);
}
}
#if ENABLE_IL2CPP
processCreators.Remove(wrapper.Uid);
#else
processes.Remove(wrapper.Uid);
#endif
}
}
}
}
public override IEnumerator Speak(Model.Wrapper wrapper)
{
if (wrapper == null)
{
Debug.LogWarning("'wrapper' is null!");
}
else
{
if (string.IsNullOrEmpty(wrapper.Text))
{
Debug.LogWarning("'wrapper.Text' is null or empty: " + wrapper);
}
else
{
if (wrapper.Source == null)
{
Debug.LogWarning("'wrapper.Source' is null: " + wrapper);
}
else
{
yield return null; //return to the main process (uid)
string voiceName = getVoiceName(wrapper);
int calculatedRate = calculateRate(wrapper.Rate);
int calculatedVolume = calculateVolume(wrapper.Volume);
int calculatedPitch = calculatePitch(wrapper.Pitch);
string outputFile = getOutputFile(wrapper.Uid);
string args = (string.IsNullOrEmpty(voiceName) ? string.Empty : "-v \"" + voiceName.Replace('"', '\'') + '"') +
(calculatedRate != defaultRate ? " -s " + calculatedRate + " " : string.Empty) +
(calculatedVolume != defaultVolume ? " -a " + calculatedVolume + " " : string.Empty) +
(calculatedPitch != defaultPitch ? " -p " + calculatedPitch + " " : string.Empty) +
" -w \"" + outputFile.Replace('"', '\'') + '"' +
" -z " +
" -m \"" + wrapper.Text.Replace('"', '\'') + '"' +
(string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
if (Util.Config.DEBUG)
Debug.Log("Process arguments: " + args);
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, 0, false, false, false)) {Name = wrapper.Uid};
worker.Start();
silence = false;
#if ENABLE_IL2CPP
processCreators.Add(wrapper.Uid, process);
#else
processes.Add(wrapper.Uid, process);
#endif
onSpeakAudioGenerationStart(wrapper);
do
{
yield return null;
} while (worker.IsAlive || !process.HasExited);
if (process.ExitCode == 0)
{
yield return playAudioFile(wrapper, Util.Helper.ValidURLFromFilePath(outputFile), outputFile);
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not speak the text: " + wrapper +
System.Environment.NewLine + "Exit code: " + process.ExitCode +
System.Environment.NewLine + sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(wrapper, errorMessage);
}
}
#if ENABLE_IL2CPP
processCreators.Remove(wrapper.Uid);
#else
processes.Remove(wrapper.Uid);
#endif
}
}
}
}
}
public override IEnumerator Generate(Model.Wrapper wrapper)
{
if (wrapper == null)
{
Debug.LogWarning("'wrapper' is null!");
}
else
{
if (string.IsNullOrEmpty(wrapper.Text))
{
Debug.LogWarning("'wrapper.Text' is null or empty: " + wrapper);
}
else
{
yield return null; //return to the main process (uid)
string voiceName = getVoiceName(wrapper);
int calculatedRate = calculateRate(wrapper.Rate);
int calculatedVolume = calculateVolume(wrapper.Volume);
int calculatedPitch = calculatePitch(wrapper.Pitch);
string outputFile = getOutputFile(wrapper.Uid);
string args = (string.IsNullOrEmpty(voiceName) ? string.Empty : "-v \"" + voiceName.Replace('"', '\'') + '"') +
(calculatedRate != defaultRate ? " -s " + calculatedRate + " " : string.Empty) +
(calculatedVolume != defaultVolume ? " -a " + calculatedVolume + " " : string.Empty) +
(calculatedPitch != defaultPitch ? " -p " + calculatedPitch + " " : string.Empty) +
" -w \"" + outputFile.Replace('"', '\'') + '"' +
" -z " +
" -m \"" + wrapper.Text.Replace('"', '\'') + '"' +
(string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
if (Util.Config.DEBUG)
Debug.Log("Process arguments: " + args);
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, 0, false, false, false)) {Name = wrapper.Uid};
worker.Start();
silence = false;
#if ENABLE_IL2CPP
processCreators.Add(wrapper.Uid, process);
#else
processes.Add(wrapper.Uid, process);
#endif
onSpeakAudioGenerationStart(wrapper);
do
{
yield return null;
} while (worker.IsAlive || !process.HasExited);
if (process.ExitCode == 0)
{
processAudioFile(wrapper, outputFile);
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not generate the text: " + wrapper +
System.Environment.NewLine + "Exit code: " + process.ExitCode +
System.Environment.NewLine + sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(wrapper, errorMessage);
}
}
#if ENABLE_IL2CPP
processCreators.Remove(wrapper.Uid);
#else
processes.Remove(wrapper.Uid);
#endif
}
}
}
}
public override void Silence()
{
base.Silence();
#if ENABLE_IL2CPP
foreach (System.Collections.Generic.KeyValuePair kvp in processCreators)
{
if (kvp.Value.isBusy)
kvp.Value.Kill();
}
processCreators.Clear();
#endif
}
public override void Silence(string uid)
{
base.Silence(uid);
#if ENABLE_IL2CPP
if (!string.IsNullOrEmpty(uid))
{
if (processCreators.ContainsKey(uid))
{
if (processCreators[uid].isBusy)
processCreators[uid].Kill();
processCreators.Remove(uid);
}
}
#endif
}
#endregion
#region Private methods
protected override string getVoiceName(Model.Wrapper wrapper)
{
if (wrapper != null && string.IsNullOrEmpty(wrapper.Voice?.Name))
{
if (Util.Config.DEBUG)
Debug.LogWarning("'wrapper.Voice' or 'wrapper.Voice.Name' is null! Using the OS 'default' voice.");
return DefaultVoiceName;
}
if (wrapper == null)
return DefaultVoiceName;
if (Speaker.Instance.ESpeakModifier == Model.Enum.ESpeakModifiers.none)
{
if (wrapper.Voice.Gender == Model.Enum.Gender.FEMALE)
{
return wrapper.Voice?.Name + Util.Constants.ESPEAK_FEMALE_MODIFIER;
}
return wrapper.Voice?.Name;
}
return wrapper.Voice?.Name + "+" + Speaker.Instance.ESpeakModifier;
}
private IEnumerator getVoices()
{
voices.Clear();
string args = "--voices" + (string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
process.OutputDataReceived += process_OutputDataReceived;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, Util.Constants.DEFAULT_TTS_KILL_TIME, true));
worker.Start();
do
{
yield return null;
} while (worker.IsAlive || !process.HasExited);
if (process.ExitCode == 0)
{
//do nothing
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not get any voices: " + process.ExitCode + System.Environment.NewLine +
sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(null, errorMessage);
}
}
}
cachedVoices = voices.OrderBy(s => s.Name).ToList();
if (Util.Constants.DEV_DEBUG)
Debug.Log("Voices read: " + cachedVoices.CTDump());
isLoading = false;
onVoicesReady();
}
private void process_OutputDataReceived(object sender, System.Diagnostics.DataReceivedEventArgs e)
{
//Debug.Log(e.Data);
string reply = e.Data;
if (!string.IsNullOrEmpty(reply))
{
if (!reply.CTStartsWith("Pty")) //ignore header
{
voices.Add(Speaker.Instance.ESpeakApplication.CTContains("espeak-ng")
? new Model.Voice(reply.Substring(30, 19).Trim().Replace("_", " "), reply.Substring(50).Trim(),
Util.Helper.StringToGender(reply.Substring(23, 1)), "unknown",
reply.Substring(4, 15).Trim(), "", "espeak-ng")
: new Model.Voice(reply.Substring(22, 20).Trim(), reply.Substring(43).Trim(),
Util.Helper.StringToGender(reply.Substring(19, 1)), "unknown",
reply.Substring(4, 15).Trim(), "", "espeak"));
}
}
}
private static int calculateRate(float rate)
{
int result =
Mathf.Clamp(
Mathf.Abs(rate - 1f) > Common.Util.BaseConstants.FLOAT_TOLERANCE
? (int)(defaultRate * rate)
: defaultRate, 1, 3 * defaultRate);
if (Util.Constants.DEV_DEBUG)
Debug.Log("calculateRate: " + result + " - " + rate);
return result;
}
private static int calculateVolume(float volume)
{
return Mathf.Clamp((int)(defaultVolume * volume), 0, 200);
}
private static int calculatePitch(float pitch)
{
return Mathf.Clamp((int)(defaultPitch * pitch), 0, 99);
}
#endregion
#region Editor-only methods
#if UNITY_EDITOR
public override void GenerateInEditor(Model.Wrapper wrapper)
{
if (wrapper == null)
{
Debug.LogWarning("'wrapper' is null!");
}
else
{
if (string.IsNullOrEmpty(wrapper.Text))
{
Debug.LogWarning("'wrapper.Text' is null or empty: " + wrapper);
}
else
{
string voiceName = getVoiceName(wrapper);
int calculatedRate = calculateRate(wrapper.Rate);
int calculatedVolume = calculateVolume(wrapper.Volume);
int calculatedPitch = calculatePitch(wrapper.Pitch);
string outputFile = getOutputFile(wrapper.Uid);
string args = (string.IsNullOrEmpty(voiceName) ? string.Empty : "-v \"" + voiceName.Replace('"', '\'') + '"') +
(calculatedRate != defaultRate ? " -s " + calculatedRate + " " : string.Empty) +
(calculatedVolume != defaultVolume ? " -a " + calculatedVolume + " " : string.Empty) +
(calculatedPitch != defaultPitch ? " -p " + calculatedPitch + " " : string.Empty) +
" -w \"" + outputFile.Replace('"', '\'') + '"' +
" -z " +
" -m \"" + wrapper.Text.Replace('"', '\'') + '"' +
(string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
if (Util.Config.DEBUG)
Debug.Log("Process arguments: " + args);
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, 0, false, false, false)) {Name = wrapper.Uid};
worker.Start();
silence = false;
onSpeakAudioGenerationStart(wrapper);
do
{
System.Threading.Thread.Sleep(50);
} while (worker.IsAlive || !process.HasExited);
if (process.ExitCode == 0)
{
processAudioFile(wrapper, outputFile);
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not generate the text: " + wrapper +
System.Environment.NewLine + "Exit code: " + process.ExitCode +
System.Environment.NewLine + sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(wrapper, errorMessage);
}
}
onSpeakAudioGenerationComplete(wrapper);
}
}
}
}
public override void SpeakNativeInEditor(Model.Wrapper wrapper)
{
if (wrapper == null)
{
Debug.LogWarning("'wrapper' is null!");
}
else
{
if (string.IsNullOrEmpty(wrapper.Text))
{
Debug.LogWarning("'wrapper.Text' is null or empty: " + wrapper);
}
else
{
string voiceName = getVoiceName(wrapper);
int calculatedRate = calculateRate(wrapper.Rate);
int calculatedVolume = calculateVolume(wrapper.Volume);
int calculatedPitch = calculatePitch(wrapper.Pitch);
string args = (string.IsNullOrEmpty(voiceName) ? string.Empty : "-v \"" + voiceName.Replace('"', '\'') + '"') +
(calculatedRate != defaultRate ? " -s " + calculatedRate + " " : string.Empty) +
(calculatedVolume != defaultVolume ? " -a " + calculatedVolume + " " : string.Empty) +
(calculatedPitch != defaultPitch ? " -p " + calculatedPitch + " " : string.Empty) +
" -z " +
" -m \"" + wrapper.Text.Replace('"', '\'') + '"' +
(string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
if (Util.Config.DEBUG)
Debug.Log("Process arguments: " + args);
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
System.Threading.Thread worker = new System.Threading.Thread(() => startProcess(process, 0, false, false, false)) {Name = wrapper.Uid};
worker.Start();
silence = false;
onSpeakStart(wrapper);
do
{
System.Threading.Thread.Sleep(50);
if (silence && !process.HasExited)
{
process.Kill();
}
} while (worker.IsAlive || !process.HasExited);
#if ENABLE_IL2CPP
if (process.ExitCode == 0 || process.ExitCode == 123456) //123456 = Killed
#else
if (process.ExitCode == 0 || process.ExitCode == -1) //-1 = Killed
#endif
{
if (Util.Config.DEBUG)
Debug.Log("Text spoken: " + wrapper.Text);
onSpeakComplete(wrapper);
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not speak the text: " + wrapper + System.Environment.NewLine +
"Exit code: " + process.ExitCode + System.Environment.NewLine +
sr.ReadToEnd();
Debug.LogError(errorMessage);
onErrorInfo(wrapper, errorMessage);
}
}
}
}
}
}
private void getVoicesInEditor()
{
cachedVoices.Clear();
string args = "--voices" + (string.IsNullOrEmpty(Speaker.Instance.ESpeakDataPath) ? string.Empty : " --path=\"" + Speaker.Instance.ESpeakDataPath + '"');
#if ENABLE_IL2CPP
using (Common.Util.CTProcess process = new Common.Util.CTProcess())
#else
using (System.Diagnostics.Process process = new System.Diagnostics.Process())
#endif
{
process.StartInfo.FileName = Speaker.Instance.ESpeakApplication;
process.StartInfo.Arguments = args;
process.OutputDataReceived += process_OutputDataReceived;
try
{
System.Threading.Thread voiceWorker = new System.Threading.Thread(() => startProcess(process, Util.Constants.DEFAULT_TTS_KILL_TIME, true));
voiceWorker.Start();
do
{
System.Threading.Thread.Sleep(50);
} while (voiceWorker.IsAlive || !process.HasExited);
if (Util.Constants.DEV_DEBUG)
Debug.Log("Finished after: " + (process.ExitTime - process.StartTime).Seconds);
if (process.ExitCode == 0)
{
//do nothing
}
else
{
using (System.IO.StreamReader sr = process.StandardError)
{
string errorMessage = "Could not get any voices: " + process.ExitCode +
System.Environment.NewLine + sr.ReadToEnd();
Debug.LogError(errorMessage);
}
}
}
catch (System.Exception ex)
{
string errorMessage = "Could not get any voices!" + System.Environment.NewLine + ex;
Debug.LogError(errorMessage);
}
}
cachedVoices = voices.OrderBy(s => s.Name).ToList();
if (Util.Constants.DEV_DEBUG)
Debug.Log("Voices read: " + cachedVoices.CTDump());
onVoicesReady();
}
#endif
#endregion
}
}
#endif
// © 2018-2020 crosstales LLC (https://www.crosstales.com)