Skip to content

Keep PinMAME playback preferences owned by the player #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
freezy merged 2 commits into from
Oct 25, 2026
Merged

Keep PinMAME playback preferences owned by the player #48

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3853cc5
audio: preserve integration gain during PCM takeover
freezy Oct 23, 2026
f487bab
pinmame: exclude authoring audio preferences from table packages
freezy Oct 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 28 additions & 10 deletions VisualPinball.Engine.PinMAME.Unity/Runtime/PinMameGamelogicEngine.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,19 @@ public class PinMameGamelogicEngine : MonoBehaviour, IGamelogicEngine, IDisplayF
DisplayEncoding IDisplayResourceMetadata.DisplayFormats => DisplayEncoding.Gray2 | DisplayEncoding.Gray4 | DisplayEncoding.Luminance8;
DisplayEncoding IDisplayResourceMetadata.DefaultDisplayFormat => DisplayEncoding.Luminance8;
bool IDisplayResourceMetadata.FormatAppliesToAllDisplays => true;
IPluginAudioSource IGamelogicAudioResourceProvider.AudioSource => _pluginAudio;
IPluginAudioSource IGamelogicAudioResourceProvider.AudioSource => _playbackAudio ??= new PlaybackAudioSource(this);
private PlaybackAudioSource _playbackAudio;

// The raw stream is shared; output mute/gain belongs only to its playback owner.
private sealed class PlaybackAudioSource : IPluginAudioSource, IPluginAudioPlaybackControl, IPluginAudioPlaybackGainSource
{
private readonly PinMameGamelogicEngine _engine;
public ResourceKind Kind => ResourceKind.Audio;
public float PlaybackGain => Volatile.Read(ref _engine.DisableAudio) ? 0 : _engine.OutputGain;
internal PlaybackAudioSource(PinMameGamelogicEngine engine) { _engine = engine; }
public IDisposable Subscribe(Action<PluginPcmFrame> receive) => _engine._pluginAudio.Subscribe(receive);
public IDisposable AcquirePlayback(string pluginId) => _engine._pluginAudio.AcquirePlayback(pluginId);
}

[Tooltip("Disable built-in mechs")]
public bool DisableMechs = true;
Expand All @@ -97,7 +109,7 @@ public class PinMameGamelogicEngine : MonoBehaviour, IGamelogicEngine, IDisplayF
[Tooltip("Delay after startup to listen for solenoid events.")]
public float SolenoidDelay;

[Tooltip("Disable audio")]
[Tooltip("Disable audio for direct play in Unity. Not exported to .vpe tables; playback settings belong to the player.")]
public bool DisableAudio;

#endregion
Expand All @@ -111,8 +123,7 @@ public byte[] Pack()
GameId = _legacyGameId,
RomId = romId,
DisableMechs = DisableMechs,
SolenoidDelay = SolenoidDelay,
DisableAudio = DisableAudio
SolenoidDelay = SolenoidDelay
};
return PackageApi.Packer.Pack(data);
}
Expand All @@ -127,7 +138,7 @@ public void Unpack(byte[] bytes)
romId = data.RomId;
DisableMechs = data.DisableMechs;
SolenoidDelay = data.SolenoidDelay;
DisableAudio = data.DisableAudio;
// Playback preferences belong to the player; ignore legacy package mute settings.
#if UNITY_EDITOR
ClearAvailableHardware();
UpdateCaches(false);
Expand Down Expand Up @@ -457,11 +468,13 @@ public float OutputGain {
set {
if (float.IsNaN(value) || float.IsInfinity(value) || value < 0 || value > 1) throw new ArgumentOutOfRangeException(nameof(value));
Volatile.Write(ref _outputGain, value);
_pluginAudio.PlaybackGain = value;
}
}
private readonly AudioResourceSource _pluginAudio = new(error => Logger.Warn(error, "[PinMAME] Plugin audio subscriber failed."));
private readonly GainControlledAudioResourceSource _pluginAudio = new(error => Logger.Warn(error, "[PinMAME] Plugin audio subscriber failed."));
private byte[] _pluginAudioBuffer = Array.Empty<byte>();
private long _pluginAudioSequence;
private bool _audioPlaybackWasReplaced; // Producer thread only.
private readonly HashSet<string> _loggedUnresolvedMappingIds = new(StringComparer.Ordinal);

private int _audioFilterChannels;
Expand Down Expand Up @@ -1657,13 +1670,19 @@ private int HandleAudioAvailable(PinMameAudioInfo audioInfo)

private int HandleAudioUpdated(IntPtr framePtr, int frameSize)
{
bool playbackReplaced = _pluginAudio.PlaybackReplaced;
if (_pluginAudio.HasSubscribers && framePtr != IntPtr.Zero && frameSize > 0) {
int length = checked(frameSize * _audioInfo.Channels * sizeof(float));
if (_pluginAudioBuffer.Length < length) _pluginAudioBuffer = new byte[length];
Marshal.Copy(framePtr, _pluginAudioBuffer, 0, length);
_pluginAudio.Publish(new PluginPcmFrame(_pluginAudioBuffer.AsMemory(0, length), PcmEncoding.Float32, (int)_audioInfo.SampleRate, _audioInfo.Channels, frameSize, ++_pluginAudioSequence));
}
if (_pluginAudio.PlaybackReplaced || DisableAudio) return _audioInfo.SamplesPerFrame;
playbackReplaced = _pluginAudio.PublishForPlayback(new PluginPcmFrame(_pluginAudioBuffer.AsMemory(0, length), PcmEncoding.Float32, (int)_audioInfo.SampleRate, _audioInfo.Channels, frameSize, ++_pluginAudioSequence));
}
bool returningToLocalPlayback = _audioPlaybackWasReplaced && !playbackReplaced;
_audioPlaybackWasReplaced = playbackReplaced;
// The local ramp was suspended during takeover. Resume at the current gain,
// otherwise a saved/live mute can briefly ramp down from a stale audible level.
if (playbackReplaced || returningToLocalPlayback) _queuedGain = OutputGain;
if (playbackReplaced || DisableAudio) return _audioInfo.SamplesPerFrame;
if (_audioFilterChannels == 0) {
// don't know how many channels yet
return _audioInfo.SamplesPerFrame;
Expand Down Expand Up @@ -2362,7 +2381,6 @@ public struct PinMameGamelogicEnginePackable
public string RomId;
public bool DisableMechs;
public float SolenoidDelay;
public bool DisableAudio;
}

#if UNITY_EDITOR
Expand Down
Loading