Implement a "Pause Emulation" option & hotkey (#2428)

* Add a "Pause Emulation" option and hotkey

Closes Ryujinx#1604

* Refactoring how pause is handled

* Applied suggested changes from review

* Applied suggested fixes

* Pass correct suspend type to threads for suspend/resume

* Fix NRE after stoping emulation

* Removing SimulateWakeUpMessage call after resuming emulation

* Skip suspending non game process

* Pause the tickCounter in the ExecutionContext

* Refactoring tickCounter pause/resume as suggested

* Fix Config migration to add pause hotkey

* Fixed pausing only application threads

* Fix exiting emulator while paused

* Avoid pause/resume while already paused/resumed

* Cleanup unused code

* Avoid restarting audio if stopping emulation while in pause.

* Added suggested changes

* Fix ConfigurationState
This commit is contained in:
mpnico 2021-09-11 22:08:25 +02:00 committed by GitHub
parent b0e410a828
commit 117e32a6ff
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
21 changed files with 311 additions and 54 deletions

View file

@ -60,7 +60,8 @@
"hotkeys": {
"toggle_vsync": "Tab",
"screenshot": "F8",
"show_ui": "F4"
"show_ui": "F4",
"pause": "F5"
},
"keyboard_config": [],
"controller_config": [],

View file

@ -14,7 +14,7 @@ namespace Ryujinx.Configuration
/// <summary>
/// The current version of the file format
/// </summary>
public const int CurrentVersion = 31;
public const int CurrentVersion = 32;
public int Version { get; set; }

View file

@ -554,7 +554,8 @@ namespace Ryujinx.Configuration
{
ToggleVsync = Key.Tab,
Screenshot = Key.F8,
ShowUi = Key.F4
ShowUi = Key.F4,
Pause = Key.F5
};
Hid.InputConfig.Value = new List<InputConfig>
{
@ -913,6 +914,21 @@ namespace Ryujinx.Configuration
configurationFileUpdated = true;
}
if (configurationFileFormat.Version < 32)
{
Common.Logging.Logger.Warning?.Print(LogClass.Application, $"Outdated configuration version {configurationFileFormat.Version}, migrating to version 32.");
configurationFileFormat.Hotkeys = new KeyboardHotkeys
{
ToggleVsync = configurationFileFormat.Hotkeys.ToggleVsync,
Screenshot = configurationFileFormat.Hotkeys.Screenshot,
ShowUi = configurationFileFormat.Hotkeys.ShowUi,
Pause = Key.F5
};
configurationFileUpdated = true;
}
Logger.EnableFileLog.Value = configurationFileFormat.EnableFileLog;
Graphics.BackendThreading.Value = configurationFileFormat.BackendThreading;
Graphics.ResScale.Value = configurationFileFormat.ResScale;

View file

@ -99,6 +99,8 @@ namespace Ryujinx.Ui
[GUI] MenuItem _loadApplicationFolder;
[GUI] MenuItem _appletMenu;
[GUI] MenuItem _actionMenu;
[GUI] MenuItem _pauseEmulation;
[GUI] MenuItem _resumeEmulation;
[GUI] MenuItem _stopEmulation;
[GUI] MenuItem _simulateWakeUpMessage;
[GUI] MenuItem _scanAmiibo;
@ -211,6 +213,7 @@ namespace Ryujinx.Ui
}
_actionMenu.Sensitive = false;
_pauseEmulation.Sensitive = false;
if (ConfigurationState.Instance.Ui.GuiColumns.FavColumn) _favToggle.Active = true;
if (ConfigurationState.Instance.Ui.GuiColumns.IconColumn) _iconToggle.Active = true;
@ -1281,9 +1284,38 @@ namespace Ryujinx.Ui
UpdateGameMetadata(_emulationContext.Application.TitleIdText);
}
_pauseEmulation.Visible = true;
_pauseEmulation.Sensitive = false;
_resumeEmulation.Visible = false;
RendererWidget?.Exit();
}
private void PauseEmulation_Pressed(object sender, EventArgs args)
{
_pauseEmulation.Visible = false;
_resumeEmulation.Visible = true;
_emulationContext.System.TogglePauseEmulation(true);
}
private void ResumeEmulation_Pressed(object sender, EventArgs args)
{
_pauseEmulation.Visible = true;
_resumeEmulation.Visible = false;
_emulationContext.System.TogglePauseEmulation(false);
}
public void ActivatePauseMenu()
{
_pauseEmulation.Sensitive = true;
}
public void TogglePause()
{
_pauseEmulation.Visible ^= true;
_resumeEmulation.Visible ^= true;
_emulationContext.System.TogglePauseEmulation(_resumeEmulation.Visible);
}
private void Installer_File_Pressed(object o, EventArgs args)
{
FileChooserDialog fileChooser = new FileChooserDialog("Choose the firmware file to open", this, FileChooserAction.Open, "Cancel", ResponseType.Cancel, "Open", ResponseType.Accept);

View file

@ -294,15 +294,35 @@
<property name="visible">True</property>
<property name="can_focus">False</property>
<child>
<object class="GtkMenuItem" id="_stopEmulation">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="tooltip_text" translatable="yes">Stop emulation of the current game and return to game selection</property>
<property name="label" translatable="yes">Stop Emulation</property>
<property name="use_underline">True</property>
<signal name="activate" handler="StopEmulation_Pressed" swapped="no"/>
</object>
</child>
<object class="GtkMenuItem" id="_pauseEmulation">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="tooltip_text" translatable="yes">Pause emulation</property>
<property name="label" translatable="yes">Pause Emulation</property>
<property name="use_underline">True</property>
<signal name="activate" handler="PauseEmulation_Pressed" swapped="no"/>
</object>
</child>
<child>
<object class="GtkMenuItem" id="_resumeEmulation">
<property name="visible">False</property>
<property name="can_focus">False</property>
<property name="tooltip_text" translatable="yes">Resume emulation</property>
<property name="label" translatable="yes">Resume Emulation</property>
<property name="use_underline">True</property>
<signal name="activate" handler="ResumeEmulation_Pressed" swapped="no"/>
</object>
</child>
<child>
<object class="GtkMenuItem" id="_stopEmulation">
<property name="visible">True</property>
<property name="can_focus">False</property>
<property name="tooltip_text" translatable="yes">Stop emulation of the current game and return to game selection</property>
<property name="label" translatable="yes">Stop Emulation</property>
<property name="use_underline">True</property>
<signal name="activate" handler="StopEmulation_Pressed" swapped="no"/>
</object>
</child>
<child>
<object class="GtkSeparatorMenuItem">
<property name="visible">True</property>

View file

@ -389,6 +389,8 @@ namespace Ryujinx.Ui
Device.Gpu.InitializeShaderCache();
Translator.IsReadyForTranslation.Set();
(Toplevel as MainWindow)?.ActivatePauseMenu();
while (_isActive)
{
if (_isStopped)
@ -590,6 +592,12 @@ namespace Ryujinx.Ui
(Toplevel as MainWindow).ToggleExtraWidgets(true);
}
if (currentHotkeyState.HasFlag(KeyboardHotkeyState.Pause) &&
!_prevHotkeyState.HasFlag(KeyboardHotkeyState.Pause))
{
(Toplevel as MainWindow)?.TogglePause();
}
_prevHotkeyState = currentHotkeyState;
}
@ -618,7 +626,8 @@ namespace Ryujinx.Ui
None = 0,
ToggleVSync = 1 << 0,
Screenshot = 1 << 1,
ShowUi = 1 << 2
ShowUi = 1 << 2,
Pause = 1 << 3
}
private KeyboardHotkeyState GetHotkeyState()
@ -640,6 +649,11 @@ namespace Ryujinx.Ui
state |= KeyboardHotkeyState.ShowUi;
}
if (_keyboardInterface.IsPressed((Key)ConfigurationState.Instance.Hid.Hotkeys.Value.Pause))
{
state |= KeyboardHotkeyState.Pause;
}
return state;
}
}

View file

@ -908,18 +908,6 @@
}
},
"properties": {
"backend_threading": {
"$id": "#/properties/backend_threading",
"type": "string",
"title": "Backend Threading",
"description": "Whether backend threading is enabled or not. 'Auto' selects the most appropriate option for the current OS, vendor and backend.",
"default": "Auto",
"examples": [
"Auto",
"Off",
"On"
]
},
"res_scale": {
"$id": "#/properties/res_scale",
"type": "integer",
@ -1468,7 +1456,8 @@
"title": "Hotkey Controls",
"required": [
"toggle_vsync",
"screenshot"
"screenshot",
"pause"
],
"properties": {
"toggle_vsync": {
@ -1482,6 +1471,12 @@
"$ref": "#/definitions/key",
"title": "Screenshot",
"default": "F8"
},
"pause": {
"$id": "#/properties/hotkeys/properties/pause",
"$ref": "#/definitions/key",
"title": "Toggle Pause",
"default": "F5"
}
}
},