ShuriZma
/
BizHawk
mirror of https://github.com/TASEmulators/BizHawk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

nyma - rework settings architecture a bit 

This gives us flexibility to define more featureful overrides
This commit is contained in:
nattthebear 2020-06-14 14:17:46 -04:00
parent e41659e237
commit 2707d1cd92
10 changed files with 210 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/BizHawk.Client.EmuHawk/config/GenericCoreConfig.cs
View File

@ -116,7 +116,7 @@ namespace BizHawk.Client.EmuHawk
// OH GOD THE HACKS WHY
TypeDescriptor.AddProvider(desc, typeof(Emulation.Cores.Waterbox.NymaCore.NymaSettings));
TypeDescriptor.AddProvider(desc, typeof(Emulation.Cores.Waterbox.NymaCore.NymaSyncSettings));
DoDialog(owner, "Nyma Core", !core.HasSettings, !core.HasSyncSettings);
DoDialog(owner, "Nyma Core", !core.SettingsInfo.HasSettings, !core.SettingsInfo.HasSyncSettings);
}
finally
{

18
src/BizHawk.Emulation.Cores/Consoles/NEC/PCE/HyperNyma.cs
View File

@ -37,17 +37,15 @@ namespace BizHawk.Emulation.Cores.Consoles.NEC.PCE
public override string SystemId => IsSgx ? "SGX" : "PCE";
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
{ "pce_fast.mouse_sensitivity", null },
{ "pce_fast.disable_softreset", null },
{ "pce_fast.cdbios", null },
{ "nyma.rtcinitialtime", null },
{ "nyma.rtcrealtime", null },
};
protected override ISet<string> NonSyncSettingNames { get; } = new HashSet<string>
{
"pce_fast.slstart", "pce_fast.slend",
{ "pce_fast.mouse_sensitivity", new SettingOverride { Hide = true } },
{ "pce_fast.disable_softreset", new SettingOverride { Hide = true } },
{ "pce_fast.cdbios", new SettingOverride { Hide = true } },
{ "nyma.rtcinitialtime", new SettingOverride { Hide = true } },
{ "nyma.rtcrealtime", new SettingOverride { Hide = true } },
{ "pce_fast.slstart", new SettingOverride { NonSync = true, NoRestart = true } },
{ "pce_fast.slend", new SettingOverride { NonSync = true, NoRestart = true } },
};
// pce always has two layers, sgx always has 4, and mednafen knows this

25
src/BizHawk.Emulation.Cores/Consoles/NEC/PCE/TurboNyma.cs
View File

@ -22,7 +22,7 @@ namespace BizHawk.Emulation.Cores.Consoles.NEC.PCE
: base(comm, "PCE", "PC Engine Controller", settings, syncSettings)
{
if (game["BRAM"])
SettingsOverrides["pce.disable_bram_hucard"] = "0";
SettingOverrides["pce.disable_bram_hucard"].Default = "0";
_terboGrafix = DoInit<LibTurboNyma>(game, rom, null, "pce.wbx", extension, deterministic);
}
public TurboNyma(GameInfo game, Disc[] discs, CoreComm comm,
@ -39,24 +39,23 @@ namespace BizHawk.Emulation.Cores.Consoles.NEC.PCE
public override string SystemId => IsSgx ? "SGX" : "PCE";
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
// handled by hawk
{ "pce.cdbios", null },
{ "pce.gecdbios", null },
{ "pce.cdbios", new SettingOverride { Hide = true } },
{ "pce.gecdbios", new SettingOverride { Hide = true } },
// so fringe i don't want people bothering me about it
{ "pce.resamp_rate_error", null },
{ "pce.vramsize", null },
{ "pce.resamp_rate_error", new SettingOverride { Hide = true } },
{ "pce.vramsize", new SettingOverride { Hide = true } },
// match hawk behavior on BRAM, instead of giving every game BRAM
{ "pce.disable_bram_hucard", "1" },
{ "pce.disable_bram_hucard", new SettingOverride { Hide = true, Default = "1" } },
// nyma settings that don't apply here
// TODO: not quite happy with how this works out
{ "nyma.rtcinitialtime", null },
{ "nyma.rtcrealtime", null },
};
protected override ISet<string> NonSyncSettingNames { get; } = new HashSet<string>
{
"pce.slstart", "pce.slend",
{ "nyma.rtcinitialtime", new SettingOverride { Hide = true } },
{ "nyma.rtcrealtime", new SettingOverride { Hide = true } },
// these can be changed dynamically
{ "pce.slstart", new SettingOverride { NonSync = true, NoRestart = true } },
{ "pce.slend", new SettingOverride { NonSync = true, NoRestart = true } },
};
protected override HashSet<string> ComputeHiddenPorts()

21
src/BizHawk.Emulation.Cores/Consoles/NEC/PCFX/Tst.cs
View File

@ -36,18 +36,17 @@ namespace BizHawk.Emulation.Cores.Consoles.NEC.PCFX
DoInit<LibNymaCore>(game, null, disks.ToArray(), "pcfx.wbx", null, deterministic, firmwares);
}
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
{ "pcfx.input.port1.multitap", null },
{ "pcfx.input.port2.multitap", null },
{ "pcfx.bios", null },
{ "pcfx.fxscsi", null },
{ "nyma.rtcinitialtime", null },
{ "nyma.rtcrealtime", null },
};
protected override ISet<string> NonSyncSettingNames { get; } = new HashSet<string>
{
"pcfx.slstart", "pcfx.slend",
{ "pcfx.input.port1.multitap", new SettingOverride { Hide = true } },
{ "pcfx.input.port2.multitap", new SettingOverride { Hide = true } },
{ "pcfx.bios", new SettingOverride { Hide = true } },
{ "pcfx.fxscsi", new SettingOverride { Hide = true } },
{ "nyma.rtcinitialtime", new SettingOverride { Hide = true } },
{ "nyma.rtcrealtime", new SettingOverride { Hide = true } },
{ "pcfx.slstart", new SettingOverride { NonSync = true, NoRestart = true } },
{ "pcfx.slend", new SettingOverride { NonSync = true, NoRestart = true } },
};
protected override HashSet<string> ComputeHiddenPorts()

23
src/BizHawk.Emulation.Cores/Consoles/Nintendo/Faust/Faust.cs
View File

@ -14,7 +14,7 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.Faust
{
if (deterministic)
// force ST renderer
SettingsOverrides.Add("snes_faust.renderer", "0");
SettingOverrides.Add("snes_faust.renderer", new SettingOverride { Hide = true, Default = "0" });
DoInit<LibNymaCore>(game, rom, null, "faust.wbx", extension, deterministic);
}
@ -35,18 +35,17 @@ namespace BizHawk.Emulation.Cores.Consoles.Nintendo.Faust
return ret;
}
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
// { "snes_faust.renderer", null },
{ "snes_faust.affinity.ppu", null },
{ "snes_faust.affinity.msu1.audio", null },
{ "snes_faust.affinity.msu1.data", null },
{ "snes_faust.frame_begin_vblank", null },
{ "snes_faust.msu1.resamp_quality", null },
{ "snes_faust.spex", null },
{ "snes_faust.spex.sound", null },
{ "nyma.rtcinitialtime", null },
{ "nyma.rtcrealtime", null },
{ "snes_faust.affinity.ppu", new SettingOverride { Hide = true } },
{ "snes_faust.affinity.msu1.audio", new SettingOverride { Hide = true } },
{ "snes_faust.affinity.msu1.data", new SettingOverride { Hide = true } },
{ "snes_faust.frame_begin_vblank", new SettingOverride { Hide = true } },
{ "snes_faust.msu1.resamp_quality", new SettingOverride { Hide = true } },
{ "snes_faust.spex", new SettingOverride { Hide = true } },
{ "snes_faust.spex.sound", new SettingOverride { Hide = true } },
{ "nyma.rtcinitialtime", new SettingOverride { Hide = true } },
{ "nyma.rtcrealtime", new SettingOverride { Hide = true } },
};
}
}

4
src/BizHawk.Emulation.Cores/Consoles/SNK/NeoGeoPort.cs
View File

@ -52,9 +52,9 @@ namespace BizHawk.Emulation.Cores.Consoles.SNK
_exe.RemoveTransientFile("SAV:flash");
}
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
{ "nyma.constantfb", null }, // TODO: Couldn't we just autodetect this whenever lcm == max == nominal?
{ "nyma.constantfb", new SettingOverride { Hide = true } }, // TODO: Couldn't we just autodetect this whenever lcm == max == nominal?
};
}
}

23
src/BizHawk.Emulation.Cores/Consoles/Sega/Saturn/Saturnus.cs
View File

@ -42,20 +42,17 @@ namespace BizHawk.Emulation.Cores.Consoles.Sega.Saturn
DoInit<LibNymaCore>(game, null, disks.ToArray(), "ss.wbx", null, deterministic, firmwares);
}
protected override IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>
{
{ "ss.bios_jp", "$J" }, // FIRMWARE:
{ "ss.bios_na_eu", "$U" }, // FIRMWARE:
{ "ss.cart.kof95_path", "$KOF" }, // FIRMWARE:
{ "ss.cart.ultraman_path", "$ULTRA" }, // FIRMWARE:
{ "ss.cart.satar4mp_path", "$SATAR" }, // FIRMWARE:
{ "ss.affinity.vdp2", null },
{ "ss.dbg_exe_cdpath", null },
{ "ss.dbg_exe_cem", null },
{ "ss.dbg_exe_hh", null },
};
protected override ISet<string> NonSyncSettingNames { get; } = new HashSet<string>
protected override IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>
{
{ "ss.bios_jp", new SettingOverride { Hide = true , Default = "$J" } }, // FIRMWARE:
{ "ss.bios_na_eu", new SettingOverride { Hide = true , Default = "$U" } }, // FIRMWARE:
{ "ss.cart.kof95_path", new SettingOverride { Hide = true , Default = "$KOF" } }, // FIRMWARE:
{ "ss.cart.ultraman_path", new SettingOverride { Hide = true , Default = "$ULTRA" } }, // FIRMWARE:
{ "ss.cart.satar4mp_path", new SettingOverride { Hide = true , Default = "$SATAR" } }, // FIRMWARE:
{ "ss.affinity.vdp2", new SettingOverride { Hide = true } },
{ "ss.dbg_exe_cdpath", new SettingOverride { Hide = true } },
{ "ss.dbg_exe_cem", new SettingOverride { Hide = true } },
{ "ss.dbg_exe_hh", new SettingOverride { Hide = true } },
};
protected override HashSet<string> ComputeHiddenPorts()

6
src/BizHawk.Emulation.Cores/Waterbox/NymaCore.Settings.ComponentModel.cs
View File

@ -47,7 +47,8 @@ namespace BizHawk.Emulation.Cores.Waterbox
var s1 = SettingsInfo.Ports
.Select((p, i) => new PortPropertyDescriptor(p, i))
.Cast<PropertyDescriptor>();
var s2 = SettingsInfo.SyncSettings
var s2 = SettingsInfo.AllSettings
.Where(s => { var o = SettingsInfo.AllOverrides[s.SettingsKey]; return !o.Hide && !o.NonSync; })
.Select(m => MednaPropertyDescriptor.Create(m, true));
return new PropertyDescriptorCollection(s1.Concat(s2).ToArray());
}
@ -68,7 +69,8 @@ namespace BizHawk.Emulation.Cores.Waterbox
{
var s1 = SettingsInfo.LayerNames.Select(l => new LayerPropertyDescriptor(l))
.Cast<PropertyDescriptor>();
var s2 = SettingsInfo.Settings
var s2 = SettingsInfo.AllSettings
.Where(s => { var o = SettingsInfo.AllOverrides[s.SettingsKey]; return !o.Hide && o.NonSync; })
.Select(m => MednaPropertyDescriptor.Create(m, true));
return new PropertyDescriptorCollection(s1.Concat(s2).ToArray());
}

210
src/BizHawk.Emulation.Cores/Waterbox/NymaCore.Settings.cs
View File

@ -13,15 +13,6 @@ namespace BizHawk.Emulation.Cores.Waterbox
{
unsafe partial class NymaCore : ISettable<NymaCore.NymaSettings, NymaCore.NymaSyncSettings>
{
/// <summary>
/// Settings that we shouldn't show the user.
/// If the value is null, use the default value, otherwise override it.
/// </summary>
protected virtual IDictionary<string, string> SettingsOverrides { get; } = new Dictionary<string, string>();
/// <summary>
/// Add any settings here that your core is not sync sensitive to. Don't screw up and cause nondeterminism!
/// </summary>
protected virtual ISet<string> NonSyncSettingNames { get; } = new HashSet<string>();
public NymaSettingsInfo SettingsInfo { get; private set; }
private NymaSettings _settings;
private NymaSyncSettings _syncSettings;
@ -42,7 +33,11 @@ namespace BizHawk.Emulation.Cores.Waterbox
public PutSettingsDirtyBits PutSettings(NymaSettings o)
{
_settings = o.Clone();
var n = o.Clone();
n.Normalize(SettingsInfo);
var ret = NymaSettings.Reboot(_settings, n, SettingsInfo);
_settings = n;
if (SettingsInfo.LayerNames.Count > 0)
{
ulong layers = ~0ul;
@ -53,15 +48,17 @@ namespace BizHawk.Emulation.Cores.Waterbox
}
_nyma.SetLayers(layers);
}
return PutSettingsDirtyBits.None;
return ret;
}
public PutSettingsDirtyBits PutSyncSettings(NymaSyncSettings o)
{
_syncSettings = o.Clone();
return _syncSettings.Equals(_syncSettingsActual)
? PutSettingsDirtyBits.None
: PutSettingsDirtyBits.RebootCore;
var n = o.Clone();
n.Normalize(SettingsInfo);
var ret = NymaSyncSettings.Reboot(_syncSettingsActual, n, SettingsInfo);
_syncSettings = n;
return ret;
}
public interface INymaDictionarySettings
@ -81,6 +78,45 @@ namespace BizHawk.Emulation.Cores.Waterbox
DisabledLayers = new HashSet<string>(DisabledLayers),
};
}
/// <summary>
/// remove things that aren't used by the core
/// Normally won't do anything, but can be useful in case settings change
/// </summary>
public void Normalize(NymaSettingsInfo info)
{
var toRemove = new List<string>();
foreach (var kvp in MednafenValues)
{
if (!info.AllSettingsByKey.ContainsKey(kvp.Key))
{
toRemove.Add(kvp.Key);
}
else
{
var ovr = info.AllOverrides[kvp.Key];
if (ovr.Hide || !ovr.NonSync)
toRemove.Add(kvp.Key);
}
}
foreach (var key in toRemove)
{
MednafenValues.Remove(key);
}
DisabledLayers = new HashSet<string>(DisabledLayers.Where(l => info.LayerNames.Contains(l)));
}
public static PutSettingsDirtyBits Reboot(NymaSettings x, NymaSettings y, NymaSettingsInfo info)
{
var restarters = info.AllOverrides.Where(kvp => kvp.Value.NonSync && !kvp.Value.NoRestart).Select(kvp => kvp.Key);
foreach (var key in restarters)
{
x.MednafenValues.TryGetValue(key, out var xx);
y.MednafenValues.TryGetValue(key, out var yy);
if (xx != yy)
return PutSettingsDirtyBits.RebootCore;
}
return PutSettingsDirtyBits.None;
}
}
public class NymaSyncSettings : INymaDictionarySettings
@ -95,44 +131,73 @@ namespace BizHawk.Emulation.Cores.Waterbox
PortDevices = new Dictionary<int, string>(PortDevices),
};
}
public override bool Equals(object obj)
/// <summary>
/// remove things that aren't used by the core
/// Normally won't do anything, but can be useful in case settings change
/// </summary>
public void Normalize(NymaSettingsInfo info)
{
if (!(obj is NymaSyncSettings x))
return false;
return new HashSet<KeyValuePair<int, string>>(PortDevices).SetEquals(x.PortDevices)
&& new HashSet<KeyValuePair<string, string>>(MednafenValues).SetEquals(x.MednafenValues);
var toRemove = new List<string>();
foreach (var kvp in MednafenValues)
{
if (!info.AllSettingsByKey.ContainsKey(kvp.Key))
{
toRemove.Add(kvp.Key);
}
else
{
var ovr = info.AllOverrides[kvp.Key];
if (ovr.Hide || ovr.NonSync)
toRemove.Add(kvp.Key);
}
}
foreach (var key in toRemove)
{
MednafenValues.Remove(key);
}
var toRemovePort = new List<int>();
foreach (var kvp in PortDevices)
{
if (info.Ports.Count <= kvp.Key || info.Ports[kvp.Key].DefaultSettingsValue == kvp.Value)
toRemovePort.Add(kvp.Key);
}
foreach (var key in toRemovePort)
{
PortDevices.Remove(key);
}
}
public override int GetHashCode()
public static PutSettingsDirtyBits Reboot(NymaSyncSettings x, NymaSyncSettings y, NymaSettingsInfo info)
{
return 0; // some other time, maybe
var restarters = info.AllOverrides.Where(kvp => !kvp.Value.NonSync && !kvp.Value.NoRestart).Select(kvp => kvp.Key);
foreach (var key in restarters)
{
x.MednafenValues.TryGetValue(key, out var xx);
y.MednafenValues.TryGetValue(key, out var yy);
if (xx != yy)
return PutSettingsDirtyBits.RebootCore;
}
if (!new HashSet<KeyValuePair<int, string>>(x.PortDevices).SetEquals(y.PortDevices))
return PutSettingsDirtyBits.RebootCore;
return PutSettingsDirtyBits.None;
}
}
protected string SettingsQuery(string name)
{
if (SettingsOverrides.TryGetValue(name, out var val))
{
// use override
}
else
if (!SettingsInfo.AllOverrides.TryGetValue(name, out var ovr))
throw new InvalidOperationException($"Core asked for setting {name} which was not found in the defaults");
string val = null;
if (!ovr.Hide)
{
// try to get actual value from settings
if (/* TODO: unhack */name == "nyma.constantfb" || NonSyncSettingNames.Contains(name))
_settings.MednafenValues.TryGetValue(name, out val);
else
_syncSettings.MednafenValues.TryGetValue(name, out val);
}
// in either case, might need defaults
if (val == null)
{
SettingsInfo.AllSettingsByKey.TryGetValue(name, out var info);
val = info?.DefaultValue;
var dict = ovr.NonSync ? _settings.MednafenValues : _syncSettingsActual.MednafenValues;
dict.TryGetValue(name, out val);
}
if (val == null)
{
throw new InvalidOperationException($"Core asked for setting {name} which was not found in the defaults");
// get default
val = ovr.Default ?? SettingsInfo.AllSettingsByKey[name].DefaultValue;
}
return val;
}
@ -149,15 +214,6 @@ namespace BizHawk.Emulation.Cores.Waterbox
private LibNymaCore.FrontendSettingQuery _settingsQueryDelegate;
/// <summary>
/// If true, the settings object has at least one settable value in it
/// </summary>
public bool HasSettings => SettingsInfo.LayerNames.Count > 0|| SettingsInfo.Settings.Count > 0;
/// <summary>
/// If true, the syncSettings object has at least one settable value in it
/// </summary>
public bool HasSyncSettings => SettingsInfo.Ports.Count > 0 || SettingsInfo.SyncSettings.Count > 0;
public class NymaSettingsInfo
{
/// <summary>
@ -180,11 +236,21 @@ namespace BizHawk.Emulation.Cores.Waterbox
/// What devices can be plugged into each port
/// </summary>
public List<Port> Ports { get; set; } = new List<Port>();
public List<SettingT> Settings { get; set; } = new List<SettingT>();
public List<SettingT> SyncSettings { get; set; } = new List<SettingT>();
public List<SettingT> AllSettings { get; set; } = new List<SettingT>();
public Dictionary<string, SettingT> AllSettingsByKey { get; set; } = new Dictionary<string, SettingT>();
public Dictionary<string, SettingOverride> AllOverrides { get; set; } = new Dictionary<string, SettingOverride>();
/// <summary>
/// If true, the settings object has at least one settable value in it
/// </summary>
public bool HasSettings => LayerNames.Count > 0
|| AllSettings.Select(s => AllOverrides[s.SettingsKey]).Any(o => !o.Hide && o.NonSync);
/// <summary>
/// If true, the syncSettings object has at least one settable value in it
/// </summary>
public bool HasSyncSettings => Ports.Count > 0
|| AllSettings.Select(s => AllOverrides[s.SettingsKey]).Any(o => !o.Hide && !o.NonSync);
}
private void InitSyncSettingsInfo(List<NPortInfoT> allPorts)
private void InitAllSettingsInfo(List<NPortInfoT> allPorts)
{
var s = new NymaSettingsInfo();
@ -203,24 +269,22 @@ namespace BizHawk.Emulation.Cores.Waterbox
});
}
s.AllOverrides = SettingOverrides.Concat(ExtraOverrides).ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
foreach (var setting in GetSettingsData().Concat(ExtraSettings))
{
s.AllSettingsByKey.Add(setting.SettingsKey, setting);
if (!SettingsOverrides.ContainsKey(setting.SettingsKey))
{
if (/* TODO: unhack */setting.SettingsKey == "nyma.constantfb" || NonSyncSettingNames.Contains(setting.SettingsKey))
{
s.Settings.Add(setting);
}
else
{
s.SyncSettings.Add(setting);
}
}
s.AllSettings.Add(setting);
if (!s.AllOverrides.ContainsKey(setting.SettingsKey))
s.AllOverrides.Add(setting.SettingsKey, new SettingOverride());
}
SettingsInfo = s;
}
private static IReadOnlyDictionary<string, SettingOverride> ExtraOverrides = new Dictionary<string, SettingOverride>
{
{ "nyma.constantfb", new SettingOverride { NonSync = true, NoRestart = true } },
};
private static IReadOnlyCollection<SettingT> ExtraSettings = new List<SettingT>
{
new SettingT
@ -251,5 +315,27 @@ namespace BizHawk.Emulation.Cores.Waterbox
Type = SettingType.Bool
},
};
public class SettingOverride
{
/// <summary>
/// If true, hide from user. Will always be set to its default value in those cases.
/// </summary>
public bool Hide { get; set; }
/// <summary>
/// If non-null, replace the original default value with this default value.
/// </summary>
public string Default { get; set; }
/// <summary>
/// If true, put the setting in Settings and not SyncSettings
/// </summary>
public bool NonSync { get; set; }
/// <summary>
/// If true, no restart is required to apply the setting. Only allowed when NonSync == true
/// DON'T STEAL THIS FROM MEDNAFLAGS, IT'S NOT SET PROPERLY THERE
/// </summary>
public bool NoRestart { get; set; } // if true, restart is not required
}
protected virtual IDictionary<string, SettingOverride> SettingOverrides { get; } = new Dictionary<string, SettingOverride>();
}
}

5
src/BizHawk.Emulation.Cores/Waterbox/NymaCore.cs
View File

@ -51,8 +51,11 @@ namespace BizHawk.Emulation.Cores.Waterbox
{
_nyma.PreInit();
var portData = GetInputPortsData();
InitSyncSettingsInfo(portData);
InitAllSettingsInfo(portData);
_nyma.SetFrontendSettingQuery(_settingsQueryDelegate);
_settings.Normalize(SettingsInfo);
_syncSettings.Normalize(SettingsInfo);
var filesToRemove = new List<string>();
if (firmwares != null)
{