Merge pull request #10355 from Pokechu22/fifo-player-config

FifoPlayer: Store early memory updates option in the config and allow changing loop option at runtime

Source/Core/Core/Config/MainSettings.cpp

@@ -375,6 +375,8 @@ const Info<bool> MAIN_GAMELIST_COLUMN_TAGS{{System::Main, "GameList", "ColumnTag
 // Main.FifoPlayer
 
 const Info<bool> MAIN_FIFOPLAYER_LOOP_REPLAY{{System::Main, "FifoPlayer", "LoopReplay"}, true};
+const Info<bool> MAIN_FIFOPLAYER_EARLY_MEMORY_UPDATES{
+    {System::Main, "FifoPlayer", "EarlyMemoryUpdates"}, false};
 
 // Main.AutoUpdate
 

Source/Core/Core/Config/MainSettings.h

@@ -265,6 +265,7 @@ extern const Info<bool> MAIN_GAMELIST_COLUMN_TAGS;
 // Main.FifoPlayer
 
 extern const Info<bool> MAIN_FIFOPLAYER_LOOP_REPLAY;
+extern const Info<bool> MAIN_FIFOPLAYER_EARLY_MEMORY_UPDATES;
 
 // Main.AutoUpdate
 

Source/Core/Core/FifoPlayer/FifoPlayer.cpp

@@ -163,12 +163,15 @@ void FifoPlaybackAnalyzer::OnCommand(const u8* data, u32 size)
 
 bool IsPlayingBackFifologWithBrokenEFBCopies = false;
 
-FifoPlayer::FifoPlayer() : m_Loop{Config::Get(Config::MAIN_FIFOPLAYER_LOOP_REPLAY)}
+FifoPlayer::FifoPlayer()
 {
+  m_config_changed_callback_id = Config::AddConfigChangedCallback([this] { RefreshConfig(); });
+  RefreshConfig();
 }
 
 FifoPlayer::~FifoPlayer()
 {
+  Config::RemoveConfigChangedCallback(m_config_changed_callback_id);
 }
 
 bool FifoPlayer::Open(const std::string& filename)
@@ -298,6 +301,12 @@ std::unique_ptr<CPUCoreBase> FifoPlayer::GetCPUCore()
   return std::make_unique<CPUCore>(this);
 }
 
+void FifoPlayer::RefreshConfig()
+{
+  m_Loop = Config::Get(Config::MAIN_FIFOPLAYER_LOOP_REPLAY);
+  m_EarlyMemoryUpdates = Config::Get(Config::MAIN_FIFOPLAYER_EARLY_MEMORY_UPDATES);
+}
+
 void FifoPlayer::SetFileLoadedCallback(CallbackFunc callback)
 {
   m_FileLoadedCb = std::move(callback);

Source/Core/Core/FifoPlayer/FifoPlayer.h

@@ -122,9 +122,7 @@ public:
   void SetObjectRangeStart(u32 start) { m_ObjectRangeStart = start; }
   u32 GetObjectRangeEnd() const { return m_ObjectRangeEnd; }
   void SetObjectRangeEnd(u32 end) { m_ObjectRangeEnd = end; }
-  // If enabled then all memory updates happen at once before the first frame
-  // Default is disabled
-  void SetEarlyMemoryUpdates(bool enabled) { m_EarlyMemoryUpdates = enabled; }
+
   // Callbacks
   void SetFileLoadedCallback(CallbackFunc callback);
   void SetFrameWrittenCallback(CallbackFunc callback) { m_FrameWrittenCb = std::move(callback); }
@@ -172,7 +170,11 @@ private:
   static bool IsIdleSet();
   static bool IsHighWatermarkSet();
 
-  bool m_Loop;
+  void RefreshConfig();
+
+  bool m_Loop = true;
+  // If enabled then all memory updates happen at once before the first frame
+  bool m_EarlyMemoryUpdates = false;
 
   u32 m_CurrentFrame = 0;
   u32 m_FrameRangeStart = 0;
@@ -181,14 +183,13 @@ private:
   u32 m_ObjectRangeStart = 0;
   u32 m_ObjectRangeEnd = 10000;
 
-  bool m_EarlyMemoryUpdates = false;
-
   u64 m_CyclesPerFrame = 0;
   u32 m_ElapsedCycles = 0;
   u32 m_FrameFifoSize = 0;
 
   CallbackFunc m_FileLoadedCb = nullptr;
   CallbackFunc m_FrameWrittenCb = nullptr;
+  size_t m_config_changed_callback_id;
 
   std::unique_ptr<FifoDataFile> m_File;
 

Source/Core/DolphinQt/FIFO/FIFOPlayerWindow.cpp

@@ -24,6 +24,7 @@
 #include "Core/FifoPlayer/FifoPlayer.h"
 #include "Core/FifoPlayer/FifoRecorder.h"
 
+#include "DolphinQt/Config/ToolTipControls/ToolTipCheckBox.h"
 #include "DolphinQt/FIFO/FIFOAnalyzer.h"
 #include "DolphinQt/QtUtils/DolphinFileDialog.h"
 #include "DolphinQt/QtUtils/ModalMessageBox.h"
@@ -38,6 +39,7 @@ FIFOPlayerWindow::FIFOPlayerWindow(QWidget* parent) : QWidget(parent)
 
   CreateWidgets();
   ConnectWidgets();
+  AddDescriptions();
 
   UpdateInfo();
 
@@ -116,11 +118,13 @@ void FIFOPlayerWindow::CreateWidgets()
   // Playback Options
   auto* playback_group = new QGroupBox(tr("Playback Options"));
   auto* playback_layout = new QGridLayout;
-  m_early_memory_updates = new QCheckBox(tr("Early Memory Updates"));
+  m_early_memory_updates = new ToolTipCheckBox(tr("Early Memory Updates"));
+  m_loop = new ToolTipCheckBox(tr("Loop"));
 
   playback_layout->addWidget(object_range_group, 0, 0);
   playback_layout->addWidget(frame_range_group, 0, 1);
-  playback_layout->addWidget(m_early_memory_updates, 1, 0, 1, -1);
+  playback_layout->addWidget(m_early_memory_updates, 1, 0);
+  playback_layout->addWidget(m_loop, 1, 1);
   playback_group->setLayout(playback_layout);
 
   // Recording Options
@@ -166,6 +170,12 @@ void FIFOPlayerWindow::CreateWidgets()
   setLayout(tab_layout);
 }
 
+void FIFOPlayerWindow::LoadSettings()
+{
+  m_early_memory_updates->setChecked(Config::Get(Config::MAIN_FIFOPLAYER_EARLY_MEMORY_UPDATES));
+  m_loop->setChecked(Config::Get(Config::MAIN_FIFOPLAYER_LOOP_REPLAY));
+}
+
 void FIFOPlayerWindow::ConnectWidgets()
 {
   connect(m_load, &QPushButton::clicked, this, &FIFOPlayerWindow::LoadRecording);
@@ -173,8 +183,9 @@ void FIFOPlayerWindow::ConnectWidgets()
   connect(m_record, &QPushButton::clicked, this, &FIFOPlayerWindow::StartRecording);
   connect(m_stop, &QPushButton::clicked, this, &FIFOPlayerWindow::StopRecording);
   connect(m_button_box, &QDialogButtonBox::rejected, this, &FIFOPlayerWindow::hide);
-  connect(m_early_memory_updates, &QCheckBox::toggled, this,
-          &FIFOPlayerWindow::OnEarlyMemoryUpdatesChanged);
+  connect(m_early_memory_updates, &QCheckBox::toggled, this, &FIFOPlayerWindow::OnConfigChanged);
+  connect(m_loop, &QCheckBox::toggled, this, &FIFOPlayerWindow::OnConfigChanged);
+
   connect(m_frame_range_from, qOverload<int>(&QSpinBox::valueChanged), this,
           &FIFOPlayerWindow::OnLimitsChanged);
   connect(m_frame_range_to, qOverload<int>(&QSpinBox::valueChanged), this,
@@ -186,6 +197,21 @@ void FIFOPlayerWindow::ConnectWidgets()
           &FIFOPlayerWindow::OnLimitsChanged);
 }
 
+void FIFOPlayerWindow::AddDescriptions()
+{
+  static const char TR_MEMORY_UPDATES_DESCRIPTION[] = QT_TR_NOOP(
+      "If enabled, then all memory updates happen at once before the first frame.<br><br>"
+      "Causes issues with many fifologs, but can be useful for testing.<br><br>"
+      "<dolphin_emphasis>If unsure, leave this unchecked.</dolphin_emphasis>");
+  static const char TR_LOOP_DESCRIPTION[] =
+      QT_TR_NOOP("If unchecked, then playback of the fifolog stops after the final frame.<br><br>"
+                 "This is generally only useful when a frame-dumping option is enabled.<br><br>"
+                 "<dolphin_emphasis>If unsure, leave this checked.</dolphin_emphasis>");
+
+  m_early_memory_updates->SetDescription(tr(TR_MEMORY_UPDATES_DESCRIPTION));
+  m_loop->SetDescription(tr(TR_LOOP_DESCRIPTION));
+}
+
 void FIFOPlayerWindow::LoadRecording()
 {
   QString path = DolphinFileDialog::getOpenFileName(this, tr("Open FIFO log"), QString(),
@@ -324,9 +350,11 @@ void FIFOPlayerWindow::OnFIFOLoaded()
   m_analyzer->Update();
 }
 
-void FIFOPlayerWindow::OnEarlyMemoryUpdatesChanged(bool enabled)
+void FIFOPlayerWindow::OnConfigChanged()
 {
-  FifoPlayer::GetInstance().SetEarlyMemoryUpdates(enabled);
+  Config::SetBase(Config::MAIN_FIFOPLAYER_EARLY_MEMORY_UPDATES,
+                  m_early_memory_updates->isChecked());
+  Config::SetBase(Config::MAIN_FIFOPLAYER_LOOP_REPLAY, m_loop->isChecked());
 }
 
 void FIFOPlayerWindow::OnLimitsChanged()
@@ -363,8 +391,6 @@ void FIFOPlayerWindow::UpdateControls()
   m_object_range_to->setEnabled(is_playing);
   m_object_range_to_label->setEnabled(is_playing);
 
-  m_early_memory_updates->setEnabled(is_playing);
-
   bool enable_frame_record_count = !is_playing && !is_recording;
 
   m_frame_record_count_label->setEnabled(enable_frame_record_count);

Source/Core/DolphinQt/FIFO/FIFOPlayerWindow.h

@@ -7,12 +7,12 @@
 
 #include "Core/Core.h"
 
-class QCheckBox;
 class QDialogButtonBox;
 class QLabel;
 class QPushButton;
 class QSpinBox;
 class QTabWidget;
+class ToolTipCheckBox;
 class FIFOAnalyzer;
 
 class FIFOPlayerWindow : public QWidget
@@ -27,7 +27,9 @@ signals:
 
 private:
   void CreateWidgets();
+  void LoadSettings();
   void ConnectWidgets();
+  void AddDescriptions();
 
   void LoadRecording();
   void SaveRecording();
@@ -37,9 +39,9 @@ private:
   void OnEmulationStarted();
   void OnEmulationStopped();
   void OnLimitsChanged();
-  void OnEarlyMemoryUpdatesChanged(bool enabled);
   void OnRecordingDone();
   void OnFIFOLoaded();
+  void OnConfigChanged();
 
   void UpdateControls();
   void UpdateInfo();
@@ -62,7 +64,8 @@ private:
   QLabel* m_object_range_from_label;
   QSpinBox* m_object_range_to;
   QLabel* m_object_range_to_label;
-  QCheckBox* m_early_memory_updates;
+  ToolTipCheckBox* m_early_memory_updates;
+  ToolTipCheckBox* m_loop;
   QDialogButtonBox* m_button_box;
 
   QWidget* m_main_widget;