Merge pull request #8867 from iwubcode/freelook_controller

Make Free Look a proper controller, move to separate UI

Source/Core/Common/CommonPaths.h

@@ -87,6 +87,7 @@
 #define DEBUGGER_CONFIG "Debugger.ini"
 #define LOGGER_CONFIG "Logger.ini"
 #define DUALSHOCKUDPCLIENT_CONFIG "DSUClient.ini"
+#define FREELOOK_CONFIG "FreeLook.ini"
 
 // Files in the directory returned by GetUserPath(D_LOGS_IDX)
 #define MAIN_LOG "dolphin.log"

Source/Core/Common/Config/Enums.h

@@ -31,6 +31,7 @@ enum class System
   Logger,
   Debugger,
   DualShockUDPClient,
+  FreeLook,
 };
 
 constexpr std::array<LayerType, 7> SEARCH_ORDER{{

Source/Core/Common/FileUtil.cpp

@@ -866,6 +866,7 @@ static void RebuildUserDirectories(unsigned int dir_index)
     s_user_paths[F_LOGGERCONFIG_IDX] = s_user_paths[D_CONFIG_IDX] + LOGGER_CONFIG;
     s_user_paths[F_DUALSHOCKUDPCLIENTCONFIG_IDX] =
         s_user_paths[D_CONFIG_IDX] + DUALSHOCKUDPCLIENT_CONFIG;
+    s_user_paths[F_FREELOOKCONFIG_IDX] = s_user_paths[D_CONFIG_IDX] + FREELOOK_CONFIG;
     s_user_paths[F_MAINLOG_IDX] = s_user_paths[D_LOGS_IDX] + MAIN_LOG;
     s_user_paths[F_MEM1DUMP_IDX] = s_user_paths[D_DUMP_IDX] + MEM1_DUMP;
     s_user_paths[F_MEM2DUMP_IDX] = s_user_paths[D_DUMP_IDX] + MEM2_DUMP;

Source/Core/Common/FileUtil.h

@@ -72,6 +72,7 @@ enum
   F_MEMORYWATCHERSOCKET_IDX,
   F_WIISDCARD_IDX,
   F_DUALSHOCKUDPCLIENTCONFIG_IDX,
+  F_FREELOOKCONFIG_IDX,
   NUM_PATH_INDICES
 };
 

Source/Core/Core/CMakeLists.txt

@@ -17,6 +17,10 @@ add_library(core
   CoreTiming.h
   DSPEmulator.cpp
   DSPEmulator.h
+  FreeLookConfig.cpp
+  FreeLookConfig.h
+  FreeLookManager.cpp
+  FreeLookManager.h
   GeckoCodeConfig.cpp
   GeckoCodeConfig.h
   GeckoCode.cpp
@@ -58,6 +62,8 @@ add_library(core
   Boot/ElfReader.cpp
   Boot/ElfReader.h
   Boot/ElfTypes.h
+  Config/FreeLookSettings.cpp
+  Config/FreeLookSettings.h
   Config/GraphicsSettings.cpp
   Config/GraphicsSettings.h
   Config/MainSettings.cpp

Source/Core/Core/Config/FreeLookSettings.cpp

@@ -0,0 +1,21 @@
+// Copyright 2020 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#include "Core/Config/FreeLookSettings.h"
+#include "Core/FreeLookConfig.h"
+
+#include <string>
+
+#include "Common/Config/Config.h"
+
+namespace Config
+{
+// Configuration Information
+const Info<bool> FREE_LOOK_ENABLED{{System::FreeLook, "General", "Enabled"}, false};
+
+// FreeLook.Controller1
+const Info<FreeLook::ControlType> FL1_CONTROL_TYPE{{System::FreeLook, "Camera1", "ControlType"},
+                                                   FreeLook::ControlType::SixAxis};
+
+}  // namespace Config

Source/Core/Core/Config/FreeLookSettings.h

@@ -0,0 +1,23 @@
+// Copyright 2020 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#pragma once
+
+#include "Common/Config/Config.h"
+
+namespace FreeLook
+{
+enum class ControlType : int;
+}
+
+namespace Config
+{
+// Configuration Information
+
+extern const Info<bool> FREE_LOOK_ENABLED;
+
+// FreeLook.Controller1
+extern const Info<FreeLook::ControlType> FL1_CONTROL_TYPE;
+
+}  // namespace Config

Source/Core/Core/Config/GraphicsSettings.cpp

@@ -42,9 +42,6 @@ const Info<bool> GFX_CACHE_HIRES_TEXTURES{{System::GFX, "Settings", "CacheHiresT
 const Info<bool> GFX_DUMP_EFB_TARGET{{System::GFX, "Settings", "DumpEFBTarget"}, false};
 const Info<bool> GFX_DUMP_XFB_TARGET{{System::GFX, "Settings", "DumpXFBTarget"}, false};
 const Info<bool> GFX_DUMP_FRAMES_AS_IMAGES{{System::GFX, "Settings", "DumpFramesAsImages"}, false};
-const Info<bool> GFX_FREE_LOOK{{System::GFX, "Settings", "FreeLook"}, false};
-const Info<FreelookControlType> GFX_FREE_LOOK_CONTROL_TYPE{
-    {System::GFX, "Settings", "FreeLookControlType"}, FreelookControlType::SixAxis};
 const Info<bool> GFX_USE_FFV1{{System::GFX, "Settings", "UseFFV1"}, false};
 const Info<std::string> GFX_DUMP_FORMAT{{System::GFX, "Settings", "DumpFormat"}, "avi"};
 const Info<std::string> GFX_DUMP_CODEC{{System::GFX, "Settings", "DumpCodec"}, ""};

Source/Core/Core/Config/GraphicsSettings.h

@@ -43,8 +43,6 @@ extern const Info<bool> GFX_CACHE_HIRES_TEXTURES;
 extern const Info<bool> GFX_DUMP_EFB_TARGET;
 extern const Info<bool> GFX_DUMP_XFB_TARGET;
 extern const Info<bool> GFX_DUMP_FRAMES_AS_IMAGES;
-extern const Info<bool> GFX_FREE_LOOK;
-extern const Info<FreelookControlType> GFX_FREE_LOOK_CONTROL_TYPE;
 extern const Info<bool> GFX_USE_FFV1;
 extern const Info<std::string> GFX_DUMP_FORMAT;
 extern const Info<std::string> GFX_DUMP_CODEC;

Source/Core/Core/ConfigLoaders/BaseConfigLoader.cpp

@@ -90,6 +90,7 @@ const std::map<Config::System, int> system_to_ini = {
     {Config::System::Logger, F_LOGGERCONFIG_IDX},
     {Config::System::Debugger, F_DEBUGGERCONFIG_IDX},
     {Config::System::DualShockUDPClient, F_DUALSHOCKUDPCLIENTCONFIG_IDX},
+    {Config::System::FreeLook, F_FREELOOKCONFIG_IDX},
 };
 
 // INI layer configuration loader

Source/Core/Core/ConfigLoaders/IsSettingSaveable.cpp

@@ -16,8 +16,9 @@ namespace ConfigLoaders
 {
 bool IsSettingSaveable(const Config::Location& config_location)
 {
-  for (Config::System system : {Config::System::SYSCONF, Config::System::GFX,
-                                Config::System::DualShockUDPClient, Config::System::Logger})
+  for (Config::System system :
+       {Config::System::SYSCONF, Config::System::GFX, Config::System::DualShockUDPClient,
+        Config::System::Logger, Config::System::FreeLook})
   {
     if (config_location.system == system)
       return true;

Source/Core/Core/Core.cpp

@@ -43,6 +43,7 @@
 #include "Core/CoreTiming.h"
 #include "Core/DSPEmulator.h"
 #include "Core/FifoPlayer/FifoPlayer.h"
+#include "Core/FreeLookManager.h"
 #include "Core/HLE/HLE.h"
 #include "Core/HW/CPU.h"
 #include "Core/HW/DSP.h"
@@ -83,7 +84,6 @@
 #include "VideoCommon/OnScreenDisplay.h"
 #include "VideoCommon/RenderBase.h"
 #include "VideoCommon/VideoBackendBase.h"
-#include "VideoCommon/VideoConfig.h"
 
 #ifdef ANDROID
 #include "jni/AndroidCommon/IDCache.h"
@@ -485,6 +485,15 @@ static void EmuThread(std::unique_ptr<BootParameters> boot, WindowSystemInfo wsi
       NetPlay::SetupWiimotes();
   }
 
+  if (init_controllers)
+  {
+    FreeLook::Initialize();
+  }
+  else
+  {
+    FreeLook::LoadInputConfig();
+  }
+
   Common::ScopeGuard controller_guard{[init_controllers, init_wiimotes] {
     if (!init_controllers)
       return;
@@ -495,6 +504,8 @@ static void EmuThread(std::unique_ptr<BootParameters> boot, WindowSystemInfo wsi
       Wiimote::Shutdown();
     }
 
+    FreeLook::Shutdown();
+
     ResetRumble();
 
     Keyboard::Shutdown();

Source/Core/Core/Core.vcxproj

@@ -25,6 +25,7 @@
     <ClCompile Include="Boot\Boot_WiiWAD.cpp" />
     <ClCompile Include="Boot\DolReader.cpp" />
     <ClCompile Include="Boot\ElfReader.cpp" />
+    <ClCompile Include="Config\FreeLookSettings.cpp" />
     <ClCompile Include="Config\GraphicsSettings.cpp" />
     <ClCompile Include="Config\MainSettings.cpp" />
     <ClCompile Include="Config\NetplaySettings.cpp" />
@@ -83,6 +84,8 @@
     <ClCompile Include="FifoPlayer\FifoPlayer.cpp" />
     <ClCompile Include="FifoPlayer\FifoRecordAnalyzer.cpp" />
     <ClCompile Include="FifoPlayer\FifoRecorder.cpp" />
+    <ClCompile Include="FreeLookConfig.cpp" />
+    <ClCompile Include="FreeLookManager.cpp" />
     <ClCompile Include="GeckoCode.cpp" />
     <ClCompile Include="GeckoCodeConfig.cpp" />
     <ClCompile Include="HLE\HLE.cpp" />
@@ -386,6 +389,7 @@
     <ClInclude Include="Boot\ElfReader.h" />
     <ClInclude Include="Boot\ElfTypes.h" />
     <ClInclude Include="CheatCodes.h" />
+    <ClInclude Include="Config\FreeLookSettings.h" />
     <ClInclude Include="Config\GraphicsSettings.h" />
     <ClInclude Include="Config\MainSettings.h" />
     <ClInclude Include="Config\NetplaySettings.h" />
@@ -436,6 +440,8 @@
     <ClInclude Include="FifoPlayer\FifoPlayer.h" />
     <ClInclude Include="FifoPlayer\FifoRecordAnalyzer.h" />
     <ClInclude Include="FifoPlayer\FifoRecorder.h" />
+    <ClInclude Include="FreeLookConfig.h" />
+    <ClInclude Include="FreeLookManager.h" />
     <ClInclude Include="GeckoCode.h" />
     <ClInclude Include="GeckoCodeConfig.h" />
     <ClInclude Include="HLE\HLE.h" />

Source/Core/Core/FreeLookConfig.cpp

@@ -0,0 +1,48 @@
+// Copyright 2020 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+#include "Core/FreeLookConfig.h"
+#include "Core/Config/FreeLookSettings.h"
+#include "Core/ConfigManager.h"
+#include "Core/Core.h"
+
+namespace FreeLook
+{
+static Config s_config;
+static Config s_active_config;
+static bool s_has_registered_callback = false;
+
+Config& GetConfig()
+{
+  return s_config;
+}
+
+const Config& GetActiveConfig()
+{
+  return s_active_config;
+}
+
+void UpdateActiveConfig()
+{
+  s_active_config = s_config;
+}
+
+Config::Config()
+{
+  camera_config.control_type = ControlType::SixAxis;
+  enabled = false;
+}
+
+void Config::Refresh()
+{
+  if (!s_has_registered_callback)
+  {
+    ::Config::AddConfigChangedCallback([] { Core::RunAsCPUThread([] { s_config.Refresh(); }); });
+    s_has_registered_callback = true;
+  }
+
+  camera_config.control_type = ::Config::Get(::Config::FL1_CONTROL_TYPE);
+  enabled = ::Config::Get(::Config::FREE_LOOK_ENABLED);
+}
+}  // namespace FreeLook

Source/Core/Core/FreeLookConfig.h

@@ -0,0 +1,41 @@
+// Copyright 2020 Dolphin Emulator Project
+// Licensed under GPLv2+
+// Refer to the license.txt file included.
+
+// IMPORTANT: UI etc should modify the value returned by FreeLook::GetConfig().
+// Free Look code should read from the value returned by FreeLook::GetActiveConfig().
+// The reason for this is to get rid of race conditions etc when the
+// configuration changes in the middle of a frame.
+
+#pragma once
+
+namespace FreeLook
+{
+enum class ControlType : int
+{
+  SixAxis,
+  FPS,
+  Orbital
+};
+
+struct CameraConfig
+{
+  ControlType control_type;
+};
+
+// NEVER inherit from this class.
+struct Config final
+{
+  Config();
+  void Refresh();
+
+  CameraConfig camera_config;
+  bool enabled;
+};
+
+Config& GetConfig();
+const Config& GetActiveConfig();
+
+// Called every frame.
+void UpdateActiveConfig();
+}  // namespace FreeLook